Aditya Mehrotra / mbed-dev

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:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

drivers/InterruptIn.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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