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@43:aff670d0d510, 2012-10-24 (annotated)

Committer:
screamer
Date:
Wed Oct 24 10:44:49 2012 +0000
Revision:
43:aff670d0d510
Parent:
27:7110ebee3484 
Conversion of the classes documentation to Doxygen format

Who changed what in which revision?

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