Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/InterruptIn.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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