Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/InterruptIn.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

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