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@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

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