mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/InterruptIn.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
156:ff21514d8981
Child:
170:e95d10626187
mbed library. Release version 162

Who changed what in which revision?

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