Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

InterruptIn.h@11:1c1ebd0324fa, 2009-08-28 (annotated)

Committer:
rolf.meyer@arm.com
Date:
Fri Aug 28 12:10:11 2009 +0000
Revision:
11:1c1ebd0324fa
Child:
27:7110ebee3484
A shiny new version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rolf.meyer@arm.com 11:1c1ebd0324fa 1 /* mbed Microcontroller Library - InterruptIn
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2006-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 * sford
rolf.meyer@arm.com 11:1c1ebd0324fa 4 */
rolf.meyer@arm.com 11:1c1ebd0324fa 5
rolf.meyer@arm.com 11:1c1ebd0324fa 6 #ifndef MBED_INTERRUPTIN_H
rolf.meyer@arm.com 11:1c1ebd0324fa 7 #define MBED_INTERRUPTIN_H
rolf.meyer@arm.com 11:1c1ebd0324fa 8
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 11 #include "PeripheralNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 12 #include "Base.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 13 #include "FunctionPointer.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 14
rolf.meyer@arm.com 11:1c1ebd0324fa 15 namespace mbed {
rolf.meyer@arm.com 11:1c1ebd0324fa 16
rolf.meyer@arm.com 11:1c1ebd0324fa 17 /* Class: InterruptIn
rolf.meyer@arm.com 11:1c1ebd0324fa 18 * A digital interrupt input, used to call a function on a rising or falling edge
rolf.meyer@arm.com 11:1c1ebd0324fa 19 *
rolf.meyer@arm.com 11:1c1ebd0324fa 20 * Example:
rolf.meyer@arm.com 11:1c1ebd0324fa 21 * > // Flash an LED while waiting for events
rolf.meyer@arm.com 11:1c1ebd0324fa 22 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 23 * > #include "mbed.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * > InterruptIn event(p16);
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * > DigitalOut led(LED1);
rolf.meyer@arm.com 11:1c1ebd0324fa 27 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * > void trigger() {
rolf.meyer@arm.com 11:1c1ebd0324fa 29 * > printf("triggered!\n");
rolf.meyer@arm.com 11:1c1ebd0324fa 30 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 31 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 32 * > int main() {
rolf.meyer@arm.com 11:1c1ebd0324fa 33 * > event.rise(&trigger);
rolf.meyer@arm.com 11:1c1ebd0324fa 34 * > while(1) {
rolf.meyer@arm.com 11:1c1ebd0324fa 35 * > led = !led;
rolf.meyer@arm.com 11:1c1ebd0324fa 36 * > wait(0.25);
rolf.meyer@arm.com 11:1c1ebd0324fa 37 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 38 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 39 */
rolf.meyer@arm.com 11:1c1ebd0324fa 40 class InterruptIn : public Base {
rolf.meyer@arm.com 11:1c1ebd0324fa 41
rolf.meyer@arm.com 11:1c1ebd0324fa 42 public:
rolf.meyer@arm.com 11:1c1ebd0324fa 43
rolf.meyer@arm.com 11:1c1ebd0324fa 44 /* Constructor: InterruptIn
rolf.meyer@arm.com 11:1c1ebd0324fa 45 * Create an InterruptIn connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 46 *
rolf.meyer@arm.com 11:1c1ebd0324fa 47 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 48 * pin - InterruptIn pin to connect to
rolf.meyer@arm.com 11:1c1ebd0324fa 49 * name - (optional) A string to identify the object
rolf.meyer@arm.com 11:1c1ebd0324fa 50 */
rolf.meyer@arm.com 11:1c1ebd0324fa 51 InterruptIn(PinName pin, const char *name = NULL);
rolf.meyer@arm.com 11:1c1ebd0324fa 52
rolf.meyer@arm.com 11:1c1ebd0324fa 53 int read();
rolf.meyer@arm.com 11:1c1ebd0324fa 54 #ifdef MBED_OPERATORS
rolf.meyer@arm.com 11:1c1ebd0324fa 55 operator int();
rolf.meyer@arm.com 11:1c1ebd0324fa 56
rolf.meyer@arm.com 11:1c1ebd0324fa 57 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 58
rolf.meyer@arm.com 11:1c1ebd0324fa 59 /* Function: rise
rolf.meyer@arm.com 11:1c1ebd0324fa 60 * Attach a function to call when a rising edge occurs on the input
rolf.meyer@arm.com 11:1c1ebd0324fa 61 *
rolf.meyer@arm.com 11:1c1ebd0324fa 62 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 63 * fptr - A pointer to a void function, or 0 to set as none
rolf.meyer@arm.com 11:1c1ebd0324fa 64 */
rolf.meyer@arm.com 11:1c1ebd0324fa 65 void rise(void (*fptr)(void));
rolf.meyer@arm.com 11:1c1ebd0324fa 66
rolf.meyer@arm.com 11:1c1ebd0324fa 67 /* Function: rise
rolf.meyer@arm.com 11:1c1ebd0324fa 68 * Attach a member function to call when a rising edge occurs on the input
rolf.meyer@arm.com 11:1c1ebd0324fa 69 *
rolf.meyer@arm.com 11:1c1ebd0324fa 70 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 71 * tptr - pointer to the object to call the member function on
rolf.meyer@arm.com 11:1c1ebd0324fa 72 * mptr - pointer to the member function to be called
rolf.meyer@arm.com 11:1c1ebd0324fa 73 */
rolf.meyer@arm.com 11:1c1ebd0324fa 74 template<typename T>
rolf.meyer@arm.com 11:1c1ebd0324fa 75 void rise(T* tptr, void (T::*mptr)(void)) {
rolf.meyer@arm.com 11:1c1ebd0324fa 76 _rise.attach(tptr, mptr);
rolf.meyer@arm.com 11:1c1ebd0324fa 77 setup_interrupt(1, 1);
rolf.meyer@arm.com 11:1c1ebd0324fa 78 }
rolf.meyer@arm.com 11:1c1ebd0324fa 79
rolf.meyer@arm.com 11:1c1ebd0324fa 80 /* Function: fall
rolf.meyer@arm.com 11:1c1ebd0324fa 81 * Attach a function to call when a falling edge occurs on the input
rolf.meyer@arm.com 11:1c1ebd0324fa 82 *
rolf.meyer@arm.com 11:1c1ebd0324fa 83 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 84 * fptr - A pointer to a void function, or 0 to set as none
rolf.meyer@arm.com 11:1c1ebd0324fa 85 */
rolf.meyer@arm.com 11:1c1ebd0324fa 86 void fall(void (*fptr)(void));
rolf.meyer@arm.com 11:1c1ebd0324fa 87
rolf.meyer@arm.com 11:1c1ebd0324fa 88 /* Function: fall
rolf.meyer@arm.com 11:1c1ebd0324fa 89 * Attach a member function to call when a falling edge occurs on the input
rolf.meyer@arm.com 11:1c1ebd0324fa 90 *
rolf.meyer@arm.com 11:1c1ebd0324fa 91 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 92 * tptr - pointer to the object to call the member function on
rolf.meyer@arm.com 11:1c1ebd0324fa 93 * mptr - pointer to the member function to be called
rolf.meyer@arm.com 11:1c1ebd0324fa 94 */
rolf.meyer@arm.com 11:1c1ebd0324fa 95 template<typename T>
rolf.meyer@arm.com 11:1c1ebd0324fa 96 void fall(T* tptr, void (T::*mptr)(void)) {
rolf.meyer@arm.com 11:1c1ebd0324fa 97 _fall.attach(tptr, mptr);
rolf.meyer@arm.com 11:1c1ebd0324fa 98 setup_interrupt(0, 1);
rolf.meyer@arm.com 11:1c1ebd0324fa 99 }
rolf.meyer@arm.com 11:1c1ebd0324fa 100
rolf.meyer@arm.com 11:1c1ebd0324fa 101 /* Function: mode
rolf.meyer@arm.com 11:1c1ebd0324fa 102 * Set the input pin mode
rolf.meyer@arm.com 11:1c1ebd0324fa 103 *
rolf.meyer@arm.com 11:1c1ebd0324fa 104 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 105 * mode - PullUp, PullDown, PullNone
rolf.meyer@arm.com 11:1c1ebd0324fa 106 */
rolf.meyer@arm.com 11:1c1ebd0324fa 107 void mode(PinMode pull);
rolf.meyer@arm.com 11:1c1ebd0324fa 108
rolf.meyer@arm.com 11:1c1ebd0324fa 109
rolf.meyer@arm.com 11:1c1ebd0324fa 110 static void _irq();
rolf.meyer@arm.com 11:1c1ebd0324fa 111 static InterruptIn *_irq_objects[48];
rolf.meyer@arm.com 11:1c1ebd0324fa 112
rolf.meyer@arm.com 11:1c1ebd0324fa 113 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 114
rolf.meyer@arm.com 11:1c1ebd0324fa 115 PinName _pin;
rolf.meyer@arm.com 11:1c1ebd0324fa 116 FunctionPointer _rise;
rolf.meyer@arm.com 11:1c1ebd0324fa 117 FunctionPointer _fall;
rolf.meyer@arm.com 11:1c1ebd0324fa 118
rolf.meyer@arm.com 11:1c1ebd0324fa 119 void setup_interrupt(int rising, int enable);
rolf.meyer@arm.com 11:1c1ebd0324fa 120
rolf.meyer@arm.com 11:1c1ebd0324fa 121 };
rolf.meyer@arm.com 11:1c1ebd0324fa 122
rolf.meyer@arm.com 11:1c1ebd0324fa 123 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 124
rolf.meyer@arm.com 11:1c1ebd0324fa 125 #endif