Iftikhar Aziz / mbed-dev

4545

Dependents:   LSS_Rev_1

Fork of mbed-dev by Umar Naeem

drivers/InterruptManager.h@166:33361e55dd8c, 2017-08-23 (annotated)

Committer:
iftaziz
Date:
Wed Aug 23 10:32:38 2017 +0000
Revision:
166:33361e55dd8c
Parent:
149:156823d33999 
r1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 149:156823d33999 1 /* mbed Microcontroller Library
<> 149:156823d33999 2 * Copyright (c) 2006-2013 ARM Limited
<> 149:156823d33999 3 *
<> 149:156823d33999 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 149:156823d33999 5 * you may not use this file except in compliance with the License.
<> 149:156823d33999 6 * You may obtain a copy of the License at
<> 149:156823d33999 7 *
<> 149:156823d33999 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 149:156823d33999 9 *
<> 149:156823d33999 10 * Unless required by applicable law or agreed to in writing, software
<> 149:156823d33999 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 149:156823d33999 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 149:156823d33999 13 * See the License for the specific language governing permissions and
<> 149:156823d33999 14 * limitations under the License.
<> 149:156823d33999 15 */
<> 149:156823d33999 16 #ifndef MBED_INTERRUPTMANAGER_H
<> 149:156823d33999 17 #define MBED_INTERRUPTMANAGER_H
<> 149:156823d33999 18
<> 149:156823d33999 19 #include "cmsis.h"
<> 149:156823d33999 20 #include "platform/CallChain.h"
<> 149:156823d33999 21 #include "platform/PlatformMutex.h"
<> 149:156823d33999 22 #include <string.h>
<> 149:156823d33999 23
<> 149:156823d33999 24 namespace mbed {
<> 149:156823d33999 25 /** \addtogroup drivers */
<> 149:156823d33999 26 /** @{*/
<> 149:156823d33999 27
<> 149:156823d33999 28 /** Use this singleton if you need to chain interrupt handlers.
<> 149:156823d33999 29 *
<> 149:156823d33999 30 * @Note Synchronization level: Thread safe
<> 149:156823d33999 31 *
<> 149:156823d33999 32 * Example (for LPC1768):
<> 149:156823d33999 33 * @code
<> 149:156823d33999 34 * #include "InterruptManager.h"
<> 149:156823d33999 35 * #include "mbed.h"
<> 149:156823d33999 36 *
<> 149:156823d33999 37 * Ticker flipper;
<> 149:156823d33999 38 * DigitalOut led1(LED1);
<> 149:156823d33999 39 * DigitalOut led2(LED2);
<> 149:156823d33999 40 *
<> 149:156823d33999 41 * void flip(void) {
<> 149:156823d33999 42 * led1 = !led1;
<> 149:156823d33999 43 * }
<> 149:156823d33999 44 *
<> 149:156823d33999 45 * void handler(void) {
<> 149:156823d33999 46 * led2 = !led1;
<> 149:156823d33999 47 * }
<> 149:156823d33999 48 *
<> 149:156823d33999 49 * int main() {
<> 149:156823d33999 50 * led1 = led2 = 0;
<> 149:156823d33999 51 * flipper.attach(&flip, 1.0);
<> 149:156823d33999 52 * InterruptManager::get()->add_handler(handler, TIMER3_IRQn);
<> 149:156823d33999 53 * }
<> 149:156823d33999 54 * @endcode
<> 149:156823d33999 55 */
<> 149:156823d33999 56 class InterruptManager {
<> 149:156823d33999 57 public:
<> 149:156823d33999 58 /** Return the only instance of this class
<> 149:156823d33999 59 */
<> 149:156823d33999 60 static InterruptManager* get();
<> 149:156823d33999 61
<> 149:156823d33999 62 /** Destroy the current instance of the interrupt manager
<> 149:156823d33999 63 */
<> 149:156823d33999 64 static void destroy();
<> 149:156823d33999 65
<> 149:156823d33999 66 /** Add a handler for an interrupt at the end of the handler list
<> 149:156823d33999 67 *
<> 149:156823d33999 68 * @param function the handler to add
<> 149:156823d33999 69 * @param irq interrupt number
<> 149:156823d33999 70 *
<> 149:156823d33999 71 * @returns
<> 149:156823d33999 72 * The function object created for 'function'
<> 149:156823d33999 73 */
<> 149:156823d33999 74 pFunctionPointer_t add_handler(void (*function)(void), IRQn_Type irq) {
<> 149:156823d33999 75 // Underlying call is thread safe
<> 149:156823d33999 76 return add_common(function, irq);
<> 149:156823d33999 77 }
<> 149:156823d33999 78
<> 149:156823d33999 79 /** Add a handler for an interrupt at the beginning of the handler list
<> 149:156823d33999 80 *
<> 149:156823d33999 81 * @param function the handler to add
<> 149:156823d33999 82 * @param irq interrupt number
<> 149:156823d33999 83 *
<> 149:156823d33999 84 * @returns
<> 149:156823d33999 85 * The function object created for 'function'
<> 149:156823d33999 86 */
<> 149:156823d33999 87 pFunctionPointer_t add_handler_front(void (*function)(void), IRQn_Type irq) {
<> 149:156823d33999 88 // Underlying call is thread safe
<> 149:156823d33999 89 return add_common(function, irq, true);
<> 149:156823d33999 90 }
<> 149:156823d33999 91
<> 149:156823d33999 92 /** Add a handler for an interrupt at the end of the handler list
<> 149:156823d33999 93 *
<> 149:156823d33999 94 * @param tptr pointer to the object that has the handler function
<> 149:156823d33999 95 * @param mptr pointer to the actual handler function
<> 149:156823d33999 96 * @param irq interrupt number
<> 149:156823d33999 97 *
<> 149:156823d33999 98 * @returns
<> 149:156823d33999 99 * The function object created for 'tptr' and 'mptr'
<> 149:156823d33999 100 */
<> 149:156823d33999 101 template<typename T>
<> 149:156823d33999 102 pFunctionPointer_t add_handler(T* tptr, void (T::*mptr)(void), IRQn_Type irq) {
<> 149:156823d33999 103 // Underlying call is thread safe
<> 149:156823d33999 104 return add_common(tptr, mptr, irq);
<> 149:156823d33999 105 }
<> 149:156823d33999 106
<> 149:156823d33999 107 /** Add a handler for an interrupt at the beginning of the handler list
<> 149:156823d33999 108 *
<> 149:156823d33999 109 * @param tptr pointer to the object that has the handler function
<> 149:156823d33999 110 * @param mptr pointer to the actual handler function
<> 149:156823d33999 111 * @param irq interrupt number
<> 149:156823d33999 112 *
<> 149:156823d33999 113 * @returns
<> 149:156823d33999 114 * The function object created for 'tptr' and 'mptr'
<> 149:156823d33999 115 */
<> 149:156823d33999 116 template<typename T>
<> 149:156823d33999 117 pFunctionPointer_t add_handler_front(T* tptr, void (T::*mptr)(void), IRQn_Type irq) {
<> 149:156823d33999 118 // Underlying call is thread safe
<> 149:156823d33999 119 return add_common(tptr, mptr, irq, true);
<> 149:156823d33999 120 }
<> 149:156823d33999 121
<> 149:156823d33999 122 /** Remove a handler from an interrupt
<> 149:156823d33999 123 *
<> 149:156823d33999 124 * @param handler the function object for the handler to remove
<> 149:156823d33999 125 * @param irq the interrupt number
<> 149:156823d33999 126 *
<> 149:156823d33999 127 * @returns
<> 149:156823d33999 128 * true if the handler was found and removed, false otherwise
<> 149:156823d33999 129 */
<> 149:156823d33999 130 bool remove_handler(pFunctionPointer_t handler, IRQn_Type irq);
<> 149:156823d33999 131
<> 149:156823d33999 132 private:
<> 149:156823d33999 133 InterruptManager();
<> 149:156823d33999 134 ~InterruptManager();
<> 149:156823d33999 135
<> 149:156823d33999 136 void lock();
<> 149:156823d33999 137 void unlock();
<> 149:156823d33999 138
<> 149:156823d33999 139 // We declare the copy contructor and the assignment operator, but we don't
<> 149:156823d33999 140 // implement them. This way, if someone tries to copy/assign our instance,
<> 149:156823d33999 141 // he will get an error at compile time.
<> 149:156823d33999 142 InterruptManager(const InterruptManager&);
<> 149:156823d33999 143 InterruptManager& operator =(const InterruptManager&);
<> 149:156823d33999 144
<> 149:156823d33999 145 template<typename T>
<> 149:156823d33999 146 pFunctionPointer_t add_common(T *tptr, void (T::*mptr)(void), IRQn_Type irq, bool front=false) {
<> 149:156823d33999 147 _mutex.lock();
<> 149:156823d33999 148 int irq_pos = get_irq_index(irq);
<> 149:156823d33999 149 bool change = must_replace_vector(irq);
<> 149:156823d33999 150
<> 149:156823d33999 151 pFunctionPointer_t pf = front ? _chains[irq_pos]->add_front(tptr, mptr) : _chains[irq_pos]->add(tptr, mptr);
<> 149:156823d33999 152 if (change)
<> 149:156823d33999 153 NVIC_SetVector(irq, (uint32_t)&InterruptManager::static_irq_helper);
<> 149:156823d33999 154 _mutex.unlock();
<> 149:156823d33999 155 return pf;
<> 149:156823d33999 156 }
<> 149:156823d33999 157
<> 149:156823d33999 158 pFunctionPointer_t add_common(void (*function)(void), IRQn_Type irq, bool front=false);
<> 149:156823d33999 159 bool must_replace_vector(IRQn_Type irq);
<> 149:156823d33999 160 int get_irq_index(IRQn_Type irq);
<> 149:156823d33999 161 void irq_helper();
<> 149:156823d33999 162 void add_helper(void (*function)(void), IRQn_Type irq, bool front=false);
<> 149:156823d33999 163 static void static_irq_helper();
<> 149:156823d33999 164
<> 149:156823d33999 165 CallChain* _chains[NVIC_NUM_VECTORS];
<> 149:156823d33999 166 static InterruptManager* _instance;
<> 149:156823d33999 167 PlatformMutex _mutex;
<> 149:156823d33999 168 };
<> 149:156823d33999 169
<> 149:156823d33999 170 } // namespace mbed
<> 149:156823d33999 171
<> 149:156823d33999 172 #endif
<> 149:156823d33999 173
<> 149:156823d33999 174
<> 149:156823d33999 175 /** @}*/