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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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