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@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

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 171:3a7713b1edbc 51 * // register trigger() to be called upon the rising edge of event
AnnaBridge 156:ff21514d8981 52 * event.rise(&trigger);
AnnaBridge 156:ff21514d8981 53 * while(1) {
AnnaBridge 156:ff21514d8981 54 * led = !led;
AnnaBridge 156:ff21514d8981 55 * wait(0.25);
AnnaBridge 156:ff21514d8981 56 * }
AnnaBridge 156:ff21514d8981 57 * }
AnnaBridge 156:ff21514d8981 58 * @endcode
AnnaBridge 156:ff21514d8981 59 * @ingroup drivers
AnnaBridge 156:ff21514d8981 60 */
AnnaBridge 156:ff21514d8981 61 class InterruptIn : private NonCopyable<InterruptIn> {
AnnaBridge 156:ff21514d8981 62
AnnaBridge 156:ff21514d8981 63 public:
AnnaBridge 156:ff21514d8981 64
AnnaBridge 156:ff21514d8981 65 /** Create an InterruptIn connected to the specified pin
AnnaBridge 156:ff21514d8981 66 *
AnnaBridge 156:ff21514d8981 67 * @param pin InterruptIn pin to connect to
AnnaBridge 156:ff21514d8981 68 */
AnnaBridge 156:ff21514d8981 69 InterruptIn(PinName pin);
Anna Bridge 169:a7c7b631e539 70
Anna Bridge 169:a7c7b631e539 71 /** Create an InterruptIn connected to the specified pin,
Anna Bridge 169:a7c7b631e539 72 * and the pin configured to the specified mode.
Anna Bridge 169:a7c7b631e539 73 *
Anna Bridge 169:a7c7b631e539 74 * @param pin InterruptIn pin to connect to
AnnaBridge 171:3a7713b1edbc 75 * @param mode Desired Pin mode configuration.
AnnaBridge 171:3a7713b1edbc 76 * (Valid values could be PullNone, PullDown, PullUp and PullDefault.
AnnaBridge 171:3a7713b1edbc 77 * See PinNames.h for your target for definitions)
AnnaBridge 171:3a7713b1edbc 78 *
Anna Bridge 169:a7c7b631e539 79 */
Anna Bridge 169:a7c7b631e539 80 InterruptIn(PinName pin, PinMode mode);
Anna Bridge 169:a7c7b631e539 81
AnnaBridge 156:ff21514d8981 82 virtual ~InterruptIn();
AnnaBridge 156:ff21514d8981 83
AnnaBridge 156:ff21514d8981 84 /** Read the input, represented as 0 or 1 (int)
AnnaBridge 156:ff21514d8981 85 *
AnnaBridge 156:ff21514d8981 86 * @returns
AnnaBridge 156:ff21514d8981 87 * An integer representing the state of the input pin,
AnnaBridge 156:ff21514d8981 88 * 0 for logical 0, 1 for logical 1
AnnaBridge 156:ff21514d8981 89 */
AnnaBridge 156:ff21514d8981 90 int read();
AnnaBridge 156:ff21514d8981 91
AnnaBridge 156:ff21514d8981 92 /** An operator shorthand for read()
AnnaBridge 156:ff21514d8981 93 */
AnnaBridge 156:ff21514d8981 94 operator int();
AnnaBridge 156:ff21514d8981 95
AnnaBridge 156:ff21514d8981 96
AnnaBridge 156:ff21514d8981 97 /** Attach a function to call when a rising edge occurs on the input
AnnaBridge 156:ff21514d8981 98 *
AnnaBridge 156:ff21514d8981 99 * @param func A pointer to a void function, or 0 to set as none
AnnaBridge 156:ff21514d8981 100 */
AnnaBridge 156:ff21514d8981 101 void rise(Callback<void()> func);
AnnaBridge 156:ff21514d8981 102
AnnaBridge 156:ff21514d8981 103 /** Attach a member function to call when a rising edge occurs on the input
AnnaBridge 156:ff21514d8981 104 *
AnnaBridge 156:ff21514d8981 105 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 106 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 107 * @deprecated
AnnaBridge 156:ff21514d8981 108 * The rise function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 109 * rise(callback(obj, method)).
AnnaBridge 156:ff21514d8981 110 */
AnnaBridge 156:ff21514d8981 111 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 112 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 170:e95d10626187 113 "The rise function does not support cv-qualifiers. Replaced by "
AnnaBridge 170:e95d10626187 114 "rise(callback(obj, method)).")
AnnaBridge 170:e95d10626187 115 void rise(T *obj, M method)
AnnaBridge 170:e95d10626187 116 {
AnnaBridge 156:ff21514d8981 117 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 118 rise(callback(obj, method));
AnnaBridge 156:ff21514d8981 119 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 120 }
AnnaBridge 156:ff21514d8981 121
AnnaBridge 156:ff21514d8981 122 /** Attach a function to call when a falling edge occurs on the input
AnnaBridge 156:ff21514d8981 123 *
AnnaBridge 156:ff21514d8981 124 * @param func A pointer to a void function, or 0 to set as none
AnnaBridge 156:ff21514d8981 125 */
AnnaBridge 156:ff21514d8981 126 void fall(Callback<void()> func);
AnnaBridge 156:ff21514d8981 127
AnnaBridge 156:ff21514d8981 128 /** Attach a member function to call when a falling edge occurs on the input
AnnaBridge 156:ff21514d8981 129 *
AnnaBridge 156:ff21514d8981 130 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 131 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 132 * @deprecated
AnnaBridge 156:ff21514d8981 133 * The rise function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 134 * rise(callback(obj, method)).
AnnaBridge 156:ff21514d8981 135 */
AnnaBridge 156:ff21514d8981 136 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 137 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 170:e95d10626187 138 "The fall function does not support cv-qualifiers. Replaced by "
AnnaBridge 170:e95d10626187 139 "fall(callback(obj, method)).")
AnnaBridge 170:e95d10626187 140 void fall(T *obj, M method)
AnnaBridge 170:e95d10626187 141 {
AnnaBridge 156:ff21514d8981 142 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 143 fall(callback(obj, method));
AnnaBridge 156:ff21514d8981 144 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 145 }
AnnaBridge 156:ff21514d8981 146
AnnaBridge 156:ff21514d8981 147 /** Set the input pin mode
AnnaBridge 156:ff21514d8981 148 *
AnnaBridge 171:3a7713b1edbc 149 * @param pull PullUp, PullDown, PullNone, PullDefault
AnnaBridge 171:3a7713b1edbc 150 * See PinNames.h for your target for definitions)
AnnaBridge 156:ff21514d8981 151 */
AnnaBridge 156:ff21514d8981 152 void mode(PinMode pull);
AnnaBridge 156:ff21514d8981 153
AnnaBridge 171:3a7713b1edbc 154 /** Enable IRQ. This method depends on hardware implementation, might enable one
AnnaBridge 156:ff21514d8981 155 * port interrupts. For further information, check gpio_irq_enable().
AnnaBridge 156:ff21514d8981 156 */
AnnaBridge 156:ff21514d8981 157 void enable_irq();
AnnaBridge 156:ff21514d8981 158
AnnaBridge 171:3a7713b1edbc 159 /** Disable IRQ. This method depends on hardware implementation, might disable one
AnnaBridge 156:ff21514d8981 160 * port interrupts. For further information, check gpio_irq_disable().
AnnaBridge 156:ff21514d8981 161 */
AnnaBridge 156:ff21514d8981 162 void disable_irq();
AnnaBridge 156:ff21514d8981 163
AnnaBridge 156:ff21514d8981 164 static void _irq_handler(uint32_t id, gpio_irq_event event);
AnnaBridge 171:3a7713b1edbc 165 #if !defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 166 protected:
AnnaBridge 156:ff21514d8981 167 gpio_t gpio;
AnnaBridge 156:ff21514d8981 168 gpio_irq_t gpio_irq;
AnnaBridge 156:ff21514d8981 169
AnnaBridge 156:ff21514d8981 170 Callback<void()> _rise;
AnnaBridge 156:ff21514d8981 171 Callback<void()> _fall;
Anna Bridge 169:a7c7b631e539 172
Anna Bridge 169:a7c7b631e539 173 void irq_init(PinName pin);
AnnaBridge 171:3a7713b1edbc 174 #endif
AnnaBridge 156:ff21514d8981 175 };
AnnaBridge 156:ff21514d8981 176
AnnaBridge 156:ff21514d8981 177 } // namespace mbed
AnnaBridge 156:ff21514d8981 178
AnnaBridge 156:ff21514d8981 179 #endif
AnnaBridge 156:ff21514d8981 180
AnnaBridge 156:ff21514d8981 181 #endif