Egor Rumjantsev / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

InterruptIn.h@44:24d45a770a51, 2012-11-21 (annotated)

Committer:
emilmont
Date:
Wed Nov 21 10:49:56 2012 +0000
Revision:
44:24d45a770a51
Parent:
43:e2ed12d17f06
Child:
54:71b101360fb9
Complete refactoring of the mbed library to move the target dependent code to a thin well defined layer, defining a proper object oriented C API to be implemented by the different silicon vendors.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 44:24d45a770a51 2 * Copyright (c) 2006-2012 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
rolf.meyer@arm.com 11:1c1ebd0324fa 22 #ifndef MBED_INTERRUPTIN_H
rolf.meyer@arm.com 11:1c1ebd0324fa 23 #define MBED_INTERRUPTIN_H
rolf.meyer@arm.com 11:1c1ebd0324fa 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 27:7110ebee3484 26
emilmont 27:7110ebee3484 27 #if DEVICE_INTERRUPTIN
emilmont 27:7110ebee3484 28
emilmont 44:24d45a770a51 29 #include "gpio_api.h"
emilmont 44:24d45a770a51 30 #include "gpio_irq_api.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 31
emilmont 44:24d45a770a51 32 #include "FunctionPointer.h"
emilmont 27:7110ebee3484 33
rolf.meyer@arm.com 11:1c1ebd0324fa 34 namespace mbed {
rolf.meyer@arm.com 11:1c1ebd0324fa 35
emilmont 43:e2ed12d17f06 36 /** A digital interrupt input, used to call a function on a rising or falling edge
rolf.meyer@arm.com 11:1c1ebd0324fa 37 *
rolf.meyer@arm.com 11:1c1ebd0324fa 38 * Example:
emilmont 43:e2ed12d17f06 39 * @code
emilmont 43:e2ed12d17f06 40 * // Flash an LED while waiting for events
emilmont 43:e2ed12d17f06 41 *
emilmont 43:e2ed12d17f06 42 * #include "mbed.h"
emilmont 43:e2ed12d17f06 43 *
emilmont 43:e2ed12d17f06 44 * InterruptIn event(p16);
emilmont 43:e2ed12d17f06 45 * DigitalOut led(LED1);
emilmont 43:e2ed12d17f06 46 *
emilmont 43:e2ed12d17f06 47 * void trigger() {
emilmont 43:e2ed12d17f06 48 * printf("triggered!\n");
emilmont 43:e2ed12d17f06 49 * }
emilmont 43:e2ed12d17f06 50 *
emilmont 43:e2ed12d17f06 51 * int main() {
emilmont 43:e2ed12d17f06 52 * event.rise(&trigger);
emilmont 43:e2ed12d17f06 53 * while(1) {
emilmont 43:e2ed12d17f06 54 * led = !led;
emilmont 43:e2ed12d17f06 55 * wait(0.25);
emilmont 43:e2ed12d17f06 56 * }
emilmont 43:e2ed12d17f06 57 * }
emilmont 43:e2ed12d17f06 58 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 59 */
emilmont 44:24d45a770a51 60 class InterruptIn {
rolf.meyer@arm.com 11:1c1ebd0324fa 61
rolf.meyer@arm.com 11:1c1ebd0324fa 62 public:
rolf.meyer@arm.com 11:1c1ebd0324fa 63
emilmont 43:e2ed12d17f06 64 /** Create an InterruptIn connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 65 *
emilmont 43:e2ed12d17f06 66 * @param pin InterruptIn pin to connect to
emilmont 43:e2ed12d17f06 67 * @param name (optional) A string to identify the object
rolf.meyer@arm.com 11:1c1ebd0324fa 68 */
emilmont 44:24d45a770a51 69 InterruptIn(PinName pin);
emilmont 27:7110ebee3484 70 virtual ~InterruptIn();
emilmont 44:24d45a770a51 71
rolf.meyer@arm.com 11:1c1ebd0324fa 72 int read();
rolf.meyer@arm.com 11:1c1ebd0324fa 73 #ifdef MBED_OPERATORS
rolf.meyer@arm.com 11:1c1ebd0324fa 74 operator int();
rolf.meyer@arm.com 11:1c1ebd0324fa 75
rolf.meyer@arm.com 11:1c1ebd0324fa 76 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 77
emilmont 43:e2ed12d17f06 78 /** Attach a function to call when a rising edge occurs on the input
rolf.meyer@arm.com 11:1c1ebd0324fa 79 *
emilmont 43:e2ed12d17f06 80 * @param fptr A pointer to a void function, or 0 to set as none
rolf.meyer@arm.com 11:1c1ebd0324fa 81 */
rolf.meyer@arm.com 11:1c1ebd0324fa 82 void rise(void (*fptr)(void));
rolf.meyer@arm.com 11:1c1ebd0324fa 83
emilmont 43:e2ed12d17f06 84 /** Attach a member function to call when a rising edge occurs on the input
rolf.meyer@arm.com 11:1c1ebd0324fa 85 *
emilmont 43:e2ed12d17f06 86 * @param tptr pointer to the object to call the member function on
emilmont 43:e2ed12d17f06 87 * @param mptr pointer to the member function to be called
rolf.meyer@arm.com 11:1c1ebd0324fa 88 */
rolf.meyer@arm.com 11:1c1ebd0324fa 89 template<typename T>
rolf.meyer@arm.com 11:1c1ebd0324fa 90 void rise(T* tptr, void (T::*mptr)(void)) {
rolf.meyer@arm.com 11:1c1ebd0324fa 91 _rise.attach(tptr, mptr);
emilmont 44:24d45a770a51 92 gpio_irq_set(&gpio_irq, IRQ_RISE, 1);
rolf.meyer@arm.com 11:1c1ebd0324fa 93 }
rolf.meyer@arm.com 11:1c1ebd0324fa 94
emilmont 43:e2ed12d17f06 95 /** Attach a function to call when a falling edge occurs on the input
rolf.meyer@arm.com 11:1c1ebd0324fa 96 *
emilmont 43:e2ed12d17f06 97 * @param fptr A pointer to a void function, or 0 to set as none
rolf.meyer@arm.com 11:1c1ebd0324fa 98 */
rolf.meyer@arm.com 11:1c1ebd0324fa 99 void fall(void (*fptr)(void));
rolf.meyer@arm.com 11:1c1ebd0324fa 100
emilmont 43:e2ed12d17f06 101 /** Attach a member function to call when a falling edge occurs on the input
rolf.meyer@arm.com 11:1c1ebd0324fa 102 *
emilmont 43:e2ed12d17f06 103 * @param tptr pointer to the object to call the member function on
emilmont 43:e2ed12d17f06 104 * @param mptr pointer to the member function to be called
rolf.meyer@arm.com 11:1c1ebd0324fa 105 */
rolf.meyer@arm.com 11:1c1ebd0324fa 106 template<typename T>
rolf.meyer@arm.com 11:1c1ebd0324fa 107 void fall(T* tptr, void (T::*mptr)(void)) {
rolf.meyer@arm.com 11:1c1ebd0324fa 108 _fall.attach(tptr, mptr);
emilmont 44:24d45a770a51 109 gpio_irq_set(&gpio_irq, IRQ_FALL, 1);
rolf.meyer@arm.com 11:1c1ebd0324fa 110 }
rolf.meyer@arm.com 11:1c1ebd0324fa 111
emilmont 43:e2ed12d17f06 112 /** Set the input pin mode
rolf.meyer@arm.com 11:1c1ebd0324fa 113 *
emilmont 43:e2ed12d17f06 114 * @param mode PullUp, PullDown, PullNone
rolf.meyer@arm.com 11:1c1ebd0324fa 115 */
rolf.meyer@arm.com 11:1c1ebd0324fa 116 void mode(PinMode pull);
rolf.meyer@arm.com 11:1c1ebd0324fa 117
emilmont 44:24d45a770a51 118 static void _irq_handler(uint32_t id, gpio_irq_event event);
emilmont 27:7110ebee3484 119
rolf.meyer@arm.com 11:1c1ebd0324fa 120 protected:
emilmont 44:24d45a770a51 121 gpio_t gpio;
emilmont 44:24d45a770a51 122 gpio_irq_t gpio_irq;
emilmont 44:24d45a770a51 123
rolf.meyer@arm.com 11:1c1ebd0324fa 124 FunctionPointer _rise;
rolf.meyer@arm.com 11:1c1ebd0324fa 125 FunctionPointer _fall;
rolf.meyer@arm.com 11:1c1ebd0324fa 126 };
rolf.meyer@arm.com 11:1c1ebd0324fa 127
rolf.meyer@arm.com 11:1c1ebd0324fa 128 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 129
rolf.meyer@arm.com 11:1c1ebd0324fa 130 #endif
emilmont 27:7110ebee3484 131
emilmont 27:7110ebee3484 132 #endif