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