Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/InterruptManager.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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