Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/InterruptIn.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vipinranka 12:9a20164dcc47 1 /* mbed Microcontroller Library
vipinranka 12:9a20164dcc47 2 * Copyright (c) 2006-2013 ARM Limited
vipinranka 12:9a20164dcc47 3 *
vipinranka 12:9a20164dcc47 4 * Licensed under the Apache License, Version 2.0 (the "License");
vipinranka 12:9a20164dcc47 5 * you may not use this file except in compliance with the License.
vipinranka 12:9a20164dcc47 6 * You may obtain a copy of the License at
vipinranka 12:9a20164dcc47 7 *
vipinranka 12:9a20164dcc47 8 * http://www.apache.org/licenses/LICENSE-2.0
vipinranka 12:9a20164dcc47 9 *
vipinranka 12:9a20164dcc47 10 * Unless required by applicable law or agreed to in writing, software
vipinranka 12:9a20164dcc47 11 * distributed under the License is distributed on an "AS IS" BASIS,
vipinranka 12:9a20164dcc47 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vipinranka 12:9a20164dcc47 13 * See the License for the specific language governing permissions and
vipinranka 12:9a20164dcc47 14 * limitations under the License.
vipinranka 12:9a20164dcc47 15 */
vipinranka 12:9a20164dcc47 16 #ifndef MBED_INTERRUPTIN_H
vipinranka 12:9a20164dcc47 17 #define MBED_INTERRUPTIN_H
vipinranka 12:9a20164dcc47 18
vipinranka 12:9a20164dcc47 19 #include "platform/platform.h"
vipinranka 12:9a20164dcc47 20
vipinranka 12:9a20164dcc47 21 #if DEVICE_INTERRUPTIN
vipinranka 12:9a20164dcc47 22
vipinranka 12:9a20164dcc47 23 #include "hal/gpio_api.h"
vipinranka 12:9a20164dcc47 24 #include "hal/gpio_irq_api.h"
vipinranka 12:9a20164dcc47 25 #include "platform/Callback.h"
vipinranka 12:9a20164dcc47 26 #include "platform/critical.h"
vipinranka 12:9a20164dcc47 27 #include "platform/toolchain.h"
vipinranka 12:9a20164dcc47 28
vipinranka 12:9a20164dcc47 29 namespace mbed {
vipinranka 12:9a20164dcc47 30 /** \addtogroup drivers */
vipinranka 12:9a20164dcc47 31 /** @{*/
vipinranka 12:9a20164dcc47 32
vipinranka 12:9a20164dcc47 33 /** A digital interrupt input, used to call a function on a rising or falling edge
vipinranka 12:9a20164dcc47 34 *
vipinranka 12:9a20164dcc47 35 * @Note Synchronization level: Interrupt safe
vipinranka 12:9a20164dcc47 36 *
vipinranka 12:9a20164dcc47 37 * Example:
vipinranka 12:9a20164dcc47 38 * @code
vipinranka 12:9a20164dcc47 39 * // Flash an LED while waiting for events
vipinranka 12:9a20164dcc47 40 *
vipinranka 12:9a20164dcc47 41 * #include "mbed.h"
vipinranka 12:9a20164dcc47 42 *
vipinranka 12:9a20164dcc47 43 * InterruptIn event(p16);
vipinranka 12:9a20164dcc47 44 * DigitalOut led(LED1);
vipinranka 12:9a20164dcc47 45 *
vipinranka 12:9a20164dcc47 46 * void trigger() {
vipinranka 12:9a20164dcc47 47 * printf("triggered!\n");
vipinranka 12:9a20164dcc47 48 * }
vipinranka 12:9a20164dcc47 49 *
vipinranka 12:9a20164dcc47 50 * int main() {
vipinranka 12:9a20164dcc47 51 * event.rise(&trigger);
vipinranka 12:9a20164dcc47 52 * while(1) {
vipinranka 12:9a20164dcc47 53 * led = !led;
vipinranka 12:9a20164dcc47 54 * wait(0.25);
vipinranka 12:9a20164dcc47 55 * }
vipinranka 12:9a20164dcc47 56 * }
vipinranka 12:9a20164dcc47 57 * @endcode
vipinranka 12:9a20164dcc47 58 */
vipinranka 12:9a20164dcc47 59 class InterruptIn {
vipinranka 12:9a20164dcc47 60
vipinranka 12:9a20164dcc47 61 public:
vipinranka 12:9a20164dcc47 62
vipinranka 12:9a20164dcc47 63 /** Create an InterruptIn connected to the specified pin
vipinranka 12:9a20164dcc47 64 *
vipinranka 12:9a20164dcc47 65 * @param pin InterruptIn pin to connect to
vipinranka 12:9a20164dcc47 66 * @param name (optional) A string to identify the object
vipinranka 12:9a20164dcc47 67 */
vipinranka 12:9a20164dcc47 68 InterruptIn(PinName pin);
vipinranka 12:9a20164dcc47 69 virtual ~InterruptIn();
vipinranka 12:9a20164dcc47 70
vipinranka 12:9a20164dcc47 71 /** Read the input, represented as 0 or 1 (int)
vipinranka 12:9a20164dcc47 72 *
vipinranka 12:9a20164dcc47 73 * @returns
vipinranka 12:9a20164dcc47 74 * An integer representing the state of the input pin,
vipinranka 12:9a20164dcc47 75 * 0 for logical 0, 1 for logical 1
vipinranka 12:9a20164dcc47 76 */
vipinranka 12:9a20164dcc47 77 int read();
vipinranka 12:9a20164dcc47 78
vipinranka 12:9a20164dcc47 79 /** An operator shorthand for read()
vipinranka 12:9a20164dcc47 80 */
vipinranka 12:9a20164dcc47 81 operator int();
vipinranka 12:9a20164dcc47 82
vipinranka 12:9a20164dcc47 83
vipinranka 12:9a20164dcc47 84 /** Attach a function to call when a rising edge occurs on the input
vipinranka 12:9a20164dcc47 85 *
vipinranka 12:9a20164dcc47 86 * @param func A pointer to a void function, or 0 to set as none
vipinranka 12:9a20164dcc47 87 */
vipinranka 12:9a20164dcc47 88 void rise(Callback<void()> func);
vipinranka 12:9a20164dcc47 89
vipinranka 12:9a20164dcc47 90 /** Attach a member function to call when a rising edge occurs on the input
vipinranka 12:9a20164dcc47 91 *
vipinranka 12:9a20164dcc47 92 * @param obj pointer to the object to call the member function on
vipinranka 12:9a20164dcc47 93 * @param method pointer to the member function to be called
vipinranka 12:9a20164dcc47 94 * @deprecated
vipinranka 12:9a20164dcc47 95 * The rise function does not support cv-qualifiers. Replaced by
vipinranka 12:9a20164dcc47 96 * rise(callback(obj, method)).
vipinranka 12:9a20164dcc47 97 */
vipinranka 12:9a20164dcc47 98 template<typename T, typename M>
vipinranka 12:9a20164dcc47 99 MBED_DEPRECATED_SINCE("mbed-os-5.1",
vipinranka 12:9a20164dcc47 100 "The rise function does not support cv-qualifiers. Replaced by "
vipinranka 12:9a20164dcc47 101 "rise(callback(obj, method)).")
vipinranka 12:9a20164dcc47 102 void rise(T *obj, M method) {
vipinranka 12:9a20164dcc47 103 core_util_critical_section_enter();
vipinranka 12:9a20164dcc47 104 rise(callback(obj, method));
vipinranka 12:9a20164dcc47 105 core_util_critical_section_exit();
vipinranka 12:9a20164dcc47 106 }
vipinranka 12:9a20164dcc47 107
vipinranka 12:9a20164dcc47 108 /** Attach a function to call when a falling edge occurs on the input
vipinranka 12:9a20164dcc47 109 *
vipinranka 12:9a20164dcc47 110 * @param func A pointer to a void function, or 0 to set as none
vipinranka 12:9a20164dcc47 111 */
vipinranka 12:9a20164dcc47 112 void fall(Callback<void()> func);
vipinranka 12:9a20164dcc47 113
vipinranka 12:9a20164dcc47 114 /** Attach a member function to call when a falling edge occurs on the input
vipinranka 12:9a20164dcc47 115 *
vipinranka 12:9a20164dcc47 116 * @param obj pointer to the object to call the member function on
vipinranka 12:9a20164dcc47 117 * @param method pointer to the member function to be called
vipinranka 12:9a20164dcc47 118 * @deprecated
vipinranka 12:9a20164dcc47 119 * The rise function does not support cv-qualifiers. Replaced by
vipinranka 12:9a20164dcc47 120 * rise(callback(obj, method)).
vipinranka 12:9a20164dcc47 121 */
vipinranka 12:9a20164dcc47 122 template<typename T, typename M>
vipinranka 12:9a20164dcc47 123 MBED_DEPRECATED_SINCE("mbed-os-5.1",
vipinranka 12:9a20164dcc47 124 "The fall function does not support cv-qualifiers. Replaced by "
vipinranka 12:9a20164dcc47 125 "fall(callback(obj, method)).")
vipinranka 12:9a20164dcc47 126 void fall(T *obj, M method) {
vipinranka 12:9a20164dcc47 127 core_util_critical_section_enter();
vipinranka 12:9a20164dcc47 128 fall(callback(obj, method));
vipinranka 12:9a20164dcc47 129 core_util_critical_section_exit();
vipinranka 12:9a20164dcc47 130 }
vipinranka 12:9a20164dcc47 131
vipinranka 12:9a20164dcc47 132 /** Set the input pin mode
vipinranka 12:9a20164dcc47 133 *
vipinranka 12:9a20164dcc47 134 * @param mode PullUp, PullDown, PullNone
vipinranka 12:9a20164dcc47 135 */
vipinranka 12:9a20164dcc47 136 void mode(PinMode pull);
vipinranka 12:9a20164dcc47 137
vipinranka 12:9a20164dcc47 138 /** Enable IRQ. This method depends on hw implementation, might enable one
vipinranka 12:9a20164dcc47 139 * port interrupts. For further information, check gpio_irq_enable().
vipinranka 12:9a20164dcc47 140 */
vipinranka 12:9a20164dcc47 141 void enable_irq();
vipinranka 12:9a20164dcc47 142
vipinranka 12:9a20164dcc47 143 /** Disable IRQ. This method depends on hw implementation, might disable one
vipinranka 12:9a20164dcc47 144 * port interrupts. For further information, check gpio_irq_disable().
vipinranka 12:9a20164dcc47 145 */
vipinranka 12:9a20164dcc47 146 void disable_irq();
vipinranka 12:9a20164dcc47 147
vipinranka 12:9a20164dcc47 148 static void _irq_handler(uint32_t id, gpio_irq_event event);
vipinranka 12:9a20164dcc47 149
vipinranka 12:9a20164dcc47 150 protected:
vipinranka 12:9a20164dcc47 151 gpio_t gpio;
vipinranka 12:9a20164dcc47 152 gpio_irq_t gpio_irq;
vipinranka 12:9a20164dcc47 153
vipinranka 12:9a20164dcc47 154 Callback<void()> _rise;
vipinranka 12:9a20164dcc47 155 Callback<void()> _fall;
vipinranka 12:9a20164dcc47 156 };
vipinranka 12:9a20164dcc47 157
vipinranka 12:9a20164dcc47 158 } // namespace mbed
vipinranka 12:9a20164dcc47 159
vipinranka 12:9a20164dcc47 160 #endif
vipinranka 12:9a20164dcc47 161
vipinranka 12:9a20164dcc47 162 #endif
vipinranka 12:9a20164dcc47 163
vipinranka 12:9a20164dcc47 164 /** @}*/