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@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
156:ff21514d8981
Child:
165:d1b4690b3f8b
mbed library. Release version 158

Who changed what in which revision?

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