Kev Mann / mbed-dev-OS5_10_4

RTC auf true

drivers/InterruptManager.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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