Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

InterruptManager.h@96:487b796308b0, 2015-03-17 (annotated)

Committer:
Kojto
Date:
Tue Mar 17 14:27:45 2015 +0000
Revision:
96:487b796308b0
Parent:
85:024bf7f99721 
Release 96 of the mbed library



Changes:

- IAR support for ble boards, lpc, ethernet stack

- RTC - attach function to redirect time functions

- Nucleo F103RB - cube driver

- k20xx - fixes for teensy and k20 platforms in sleep/deepsleep and usb

- STM32L0, Nucleo/Disco L053 - refactoring

Who changed what in which revision?

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