Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

InterruptIn.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
76:824293ae5e43 
dgdgr

Who changed what in which revision?

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