Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

InterruptManager.h@65:5798e58a58b1, 2013-08-12 (annotated)

Committer:
bogdanm
Date:
Mon Aug 12 13:17:46 2013 +0300
Revision:
65:5798e58a58b1
Child:
66:9c8f0e3462fb
New target (LPC4088), new features (interrupt chaining), bug fixes (KL25Z I2C).

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 65:5798e58a58b1 1 #ifndef MBED_INTERRUPTMANAGER_H
bogdanm 65:5798e58a58b1 2 #define MBED_INTERRUPTMANAGER_H
bogdanm 65:5798e58a58b1 3
bogdanm 65:5798e58a58b1 4 #include "cmsis.h"
bogdanm 65:5798e58a58b1 5 #include "CallChain.h"
bogdanm 65:5798e58a58b1 6 #include <string.h>
bogdanm 65:5798e58a58b1 7
bogdanm 65:5798e58a58b1 8 namespace mbed {
bogdanm 65:5798e58a58b1 9
bogdanm 65:5798e58a58b1 10 /** Use this singleton if you need to chain interrupt handlers.
bogdanm 65:5798e58a58b1 11 *
bogdanm 65:5798e58a58b1 12 * Example (for LPC1768):
bogdanm 65:5798e58a58b1 13 * @code
bogdanm 65:5798e58a58b1 14 * #include "InterruptManager.h"
bogdanm 65:5798e58a58b1 15 * #include "mbed.h"
bogdanm 65:5798e58a58b1 16 *
bogdanm 65:5798e58a58b1 17 * Ticker flipper;
bogdanm 65:5798e58a58b1 18 * DigitalOut led1(LED1);
bogdanm 65:5798e58a58b1 19 * DigitalOut led2(LED2);
bogdanm 65:5798e58a58b1 20 *
bogdanm 65:5798e58a58b1 21 * void flip(void) {
bogdanm 65:5798e58a58b1 22 * led1 = !led1;
bogdanm 65:5798e58a58b1 23 * }
bogdanm 65:5798e58a58b1 24 *
bogdanm 65:5798e58a58b1 25 * void handler(void) {
bogdanm 65:5798e58a58b1 26 * led2 = !led1;
bogdanm 65:5798e58a58b1 27 * }
bogdanm 65:5798e58a58b1 28 *
bogdanm 65:5798e58a58b1 29 * int main() {
bogdanm 65:5798e58a58b1 30 * led1 = led2 = 0;
bogdanm 65:5798e58a58b1 31 * flipper.attach(&flip, 1.0);
bogdanm 65:5798e58a58b1 32 * InterruptManager::get()->add_handler(handler, TIMER3_IRQn);
bogdanm 65:5798e58a58b1 33 * }
bogdanm 65:5798e58a58b1 34 * @endcode
bogdanm 65:5798e58a58b1 35 */
bogdanm 65:5798e58a58b1 36 class InterruptManager {
bogdanm 65:5798e58a58b1 37 public:
bogdanm 65:5798e58a58b1 38 /** Return the only instance of this class
bogdanm 65:5798e58a58b1 39 */
bogdanm 65:5798e58a58b1 40 static InterruptManager* get();
bogdanm 65:5798e58a58b1 41
bogdanm 65:5798e58a58b1 42 /** Destroy the current instance of the interrupt manager
bogdanm 65:5798e58a58b1 43 */
bogdanm 65:5798e58a58b1 44 static void destroy();
bogdanm 65:5798e58a58b1 45
bogdanm 65:5798e58a58b1 46 /** Add a handler for an interrupt at the end of the handler list
bogdanm 65:5798e58a58b1 47 *
bogdanm 65:5798e58a58b1 48 * @param function the handler to add
bogdanm 65:5798e58a58b1 49 * @param irq interrupt number
bogdanm 65:5798e58a58b1 50 *
bogdanm 65:5798e58a58b1 51 * @returns
bogdanm 65:5798e58a58b1 52 * The function object created for 'function'
bogdanm 65:5798e58a58b1 53 */
bogdanm 65:5798e58a58b1 54 pFunctionPointer_t add_handler(void (*function)(void), IRQn_Type irq) {
bogdanm 65:5798e58a58b1 55 return add_common(function, irq);
bogdanm 65:5798e58a58b1 56 }
bogdanm 65:5798e58a58b1 57
bogdanm 65:5798e58a58b1 58 /** Add a handler for an interrupt at the beginning of the handler list
bogdanm 65:5798e58a58b1 59 *
bogdanm 65:5798e58a58b1 60 * @param function the handler to add
bogdanm 65:5798e58a58b1 61 * @param irq interrupt number
bogdanm 65:5798e58a58b1 62 *
bogdanm 65:5798e58a58b1 63 * @returns
bogdanm 65:5798e58a58b1 64 * The function object created for 'function'
bogdanm 65:5798e58a58b1 65 */
bogdanm 65:5798e58a58b1 66 pFunctionPointer_t add_handler_front(void (*function)(void), IRQn_Type irq) {
bogdanm 65:5798e58a58b1 67 return add_common(function, irq, true);
bogdanm 65:5798e58a58b1 68 }
bogdanm 65:5798e58a58b1 69
bogdanm 65:5798e58a58b1 70 /** Add a handler for an interrupt at the end of the handler list
bogdanm 65:5798e58a58b1 71 *
bogdanm 65:5798e58a58b1 72 * @param tptr pointer to the object that has the handler function
bogdanm 65:5798e58a58b1 73 * @param mptr pointer to the actual handler function
bogdanm 65:5798e58a58b1 74 * @param irq interrupt number
bogdanm 65:5798e58a58b1 75 *
bogdanm 65:5798e58a58b1 76 * @returns
bogdanm 65:5798e58a58b1 77 * The function object created for 'tptr' and 'mptr'
bogdanm 65:5798e58a58b1 78 */
bogdanm 65:5798e58a58b1 79 template<typename T>
bogdanm 65:5798e58a58b1 80 pFunctionPointer_t add_handler(T* tptr, void (T::*mptr)(void), IRQn_Type irq) {
bogdanm 65:5798e58a58b1 81 return add_common(tptr, mptr, irq);
bogdanm 65:5798e58a58b1 82 }
bogdanm 65:5798e58a58b1 83
bogdanm 65:5798e58a58b1 84 /** Add a handler for an interrupt at the beginning of the handler list
bogdanm 65:5798e58a58b1 85 *
bogdanm 65:5798e58a58b1 86 * @param tptr pointer to the object that has the handler function
bogdanm 65:5798e58a58b1 87 * @param mptr pointer to the actual handler function
bogdanm 65:5798e58a58b1 88 * @param irq interrupt number
bogdanm 65:5798e58a58b1 89 *
bogdanm 65:5798e58a58b1 90 * @returns
bogdanm 65:5798e58a58b1 91 * The function object created for 'tptr' and 'mptr'
bogdanm 65:5798e58a58b1 92 */
bogdanm 65:5798e58a58b1 93 template<typename T>
bogdanm 65:5798e58a58b1 94 pFunctionPointer_t add_handler_front(T* tptr, void (T::*mptr)(void), IRQn_Type irq) {
bogdanm 65:5798e58a58b1 95 return add_common(tptr, mptr, irq, true);
bogdanm 65:5798e58a58b1 96 }
bogdanm 65:5798e58a58b1 97
bogdanm 65:5798e58a58b1 98 /** Remove a handler from an interrupt
bogdanm 65:5798e58a58b1 99 *
bogdanm 65:5798e58a58b1 100 * @param handler the function object for the handler to remove
bogdanm 65:5798e58a58b1 101 * @param irq the interrupt number
bogdanm 65:5798e58a58b1 102 *
bogdanm 65:5798e58a58b1 103 * @returns
bogdanm 65:5798e58a58b1 104 * true if the handler was found and removed, false otherwise
bogdanm 65:5798e58a58b1 105 */
bogdanm 65:5798e58a58b1 106 bool remove_handler(pFunctionPointer_t handler, IRQn_Type irq);
bogdanm 65:5798e58a58b1 107
bogdanm 65:5798e58a58b1 108 private:
bogdanm 65:5798e58a58b1 109 InterruptManager();
bogdanm 65:5798e58a58b1 110 ~InterruptManager();
bogdanm 65:5798e58a58b1 111
bogdanm 65:5798e58a58b1 112 // We declare the copy contructor and the assignment operator, but we don't
bogdanm 65:5798e58a58b1 113 // implement them. This way, if someone tries to copy/assign our instance,
bogdanm 65:5798e58a58b1 114 // he will get an error at compile time.
bogdanm 65:5798e58a58b1 115 InterruptManager(const InterruptManager&);
bogdanm 65:5798e58a58b1 116 InterruptManager& operator =(const InterruptManager&);
bogdanm 65:5798e58a58b1 117
bogdanm 65:5798e58a58b1 118 template<typename T>
bogdanm 65:5798e58a58b1 119 pFunctionPointer_t add_common(T *tptr, void (T::*mptr)(void), IRQn_Type irq, bool front=false) {
bogdanm 65:5798e58a58b1 120 int irq_pos = get_irq_index(irq);
bogdanm 65:5798e58a58b1 121 bool change = must_replace_vector(irq);
bogdanm 65:5798e58a58b1 122
bogdanm 65:5798e58a58b1 123 pFunctionPointer_t pf = front ? _chains[irq_pos]->add_front(tptr, mptr) : _chains[irq_pos]->add(tptr, mptr);
bogdanm 65:5798e58a58b1 124 if (change)
bogdanm 65:5798e58a58b1 125 NVIC_SetVector(irq, (uint32_t)&InterruptManager::static_irq_helper);
bogdanm 65:5798e58a58b1 126 return pf;
bogdanm 65:5798e58a58b1 127 }
bogdanm 65:5798e58a58b1 128
bogdanm 65:5798e58a58b1 129 pFunctionPointer_t add_common(void (*function)(void), IRQn_Type irq, bool front=false);
bogdanm 65:5798e58a58b1 130 bool must_replace_vector(IRQn_Type irq);
bogdanm 65:5798e58a58b1 131 int get_irq_index(IRQn_Type irq);
bogdanm 65:5798e58a58b1 132 void irq_helper();
bogdanm 65:5798e58a58b1 133 void add_helper(void (*function)(void), IRQn_Type irq, bool front=false);
bogdanm 65:5798e58a58b1 134 static void static_irq_helper();
bogdanm 65:5798e58a58b1 135
bogdanm 65:5798e58a58b1 136 CallChain* _chains[NVIC_NUM_VECTORS];
bogdanm 65:5798e58a58b1 137 static InterruptManager* _instance;
bogdanm 65:5798e58a58b1 138 };
bogdanm 65:5798e58a58b1 139
bogdanm 65:5798e58a58b1 140 } // namespace mbed
bogdanm 65:5798e58a58b1 141
bogdanm 65:5798e58a58b1 142 #endif
bogdanm 65:5798e58a58b1 143