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