mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/InterruptManager.h@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Parent:
128:9bcdf88f62b0
Child:
146:22da6e220af6
Release 145 of the mbed library.

Who changed what in which revision?

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