Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/InterruptIn.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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