Diff: mbed-dev-master/drivers/InterruptManager.h

Revision:

0:bb348c97df44

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed-dev-master/drivers/InterruptManager.h	Wed Sep 16 01:11:49 2020 +0000
@@ -0,0 +1,205 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2006-2013 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef MBED_INTERRUPTMANAGER_H
+#define MBED_INTERRUPTMANAGER_H
+
+#include "cmsis.h"
+#include "platform/CallChain.h"
+#include "platform/PlatformMutex.h"
+#include "platform/NonCopyable.h"
+#include <string.h>
+
+namespace mbed {
+/** \addtogroup drivers */
+
+/** Use this singleton if you need to chain interrupt handlers.
+ *  @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.
+ *
+ * @note Synchronization level: Thread safe
+ *
+ * Example (for LPC1768):
+ * @code
+ * #include "InterruptManager.h"
+ * #include "mbed.h"
+ *
+ * Ticker flipper;
+ * DigitalOut led1(LED1);
+ * DigitalOut led2(LED2);
+ *
+ * void flip(void) {
+ *     led1 = !led1;
+ * }
+ *
+ * void handler(void) {
+ *     led2 = !led1;
+ * }
+ *
+ * int main() {
+ *     led1 = led2 = 0;
+ *     flipper.attach(&flip, 1.0);
+ *     InterruptManager::get()->add_handler(handler, TIMER3_IRQn);
+ * }
+ * @endcode
+ * @ingroup drivers
+ */
+class InterruptManager : private NonCopyable<InterruptManager> {
+public:
+    /** Get the instance of InterruptManager Class
+     *  @deprecated
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
+     *  @return the only instance of this class
+     */
+    MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
+                          "public API of mbed-os and is being removed in the future.")
+    static InterruptManager *get();
+
+    /** Destroy the current instance of the interrupt manager
+     *  @deprecated
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
+     */
+    MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
+                          "public API of mbed-os and is being removed in the future.")
+    static void destroy();
+
+    /** Add a handler for an interrupt at the end of the handler list
+     *  @deprecated
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
+     *  @param function the handler to add
+     *  @param irq interrupt number
+     *
+     *  @returns
+     *  The function object created for 'function'
+     */
+    MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
+                          "public API of mbed-os and is being removed in the future.")
+    pFunctionPointer_t add_handler(void (*function)(void), IRQn_Type irq)
+    {
+        // Underlying call is thread safe
+        return add_common(function, irq);
+    }
+
+    /** Add a handler for an interrupt at the beginning of the handler list
+     *  @deprecated
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
+     *  @param function the handler to add
+     *  @param irq interrupt number
+     *
+     *  @returns
+     *  The function object created for 'function'
+     */
+    MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
+                          "public API of mbed-os and is being removed in the future.")
+    pFunctionPointer_t add_handler_front(void (*function)(void), IRQn_Type irq)
+    {
+        // Underlying call is thread safe
+        return add_common(function, irq, true);
+    }
+
+    /** Add a handler for an interrupt at the end of the handler list
+     *  @deprecated
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
+     *  @param tptr pointer to the object that has the handler function
+     *  @param mptr pointer to the actual handler function
+     *  @param irq interrupt number
+     *
+     *  @returns
+     *  The function object created for 'tptr' and 'mptr'
+     */
+    template<typename T>
+    MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
+                          "public API of mbed-os and is being removed in the future.")
+    pFunctionPointer_t add_handler(T *tptr, void (T::*mptr)(void), IRQn_Type irq)
+    {
+        // Underlying call is thread safe
+        return add_common(tptr, mptr, irq);
+    }
+
+    /** Add a handler for an interrupt at the beginning of the handler list
+     *  @deprecated
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
+     *  @param tptr pointer to the object that has the handler function
+     *  @param mptr pointer to the actual handler function
+     *  @param irq interrupt number
+     *
+     *  @returns
+     *  The function object created for 'tptr' and 'mptr'
+     */
+    template<typename T>
+    MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
+                          "public API of mbed-os and is being removed in the future.")
+    pFunctionPointer_t add_handler_front(T *tptr, void (T::*mptr)(void), IRQn_Type irq)
+    {
+        // Underlying call is thread safe
+        return add_common(tptr, mptr, irq, true);
+    }
+
+    /** Remove a handler from an interrupt
+     *  @deprecated
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
+     *  @param handler the function object for the handler to remove
+     *  @param irq the interrupt number
+     *
+     *  @returns
+     *  true if the handler was found and removed, false otherwise
+     */
+    MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
+                          "public API of mbed-os and is being removed in the future.")
+    bool remove_handler(pFunctionPointer_t handler, IRQn_Type irq);
+
+private:
+    InterruptManager();
+    ~InterruptManager();
+
+    void lock();
+    void unlock();
+
+    template<typename T>
+    pFunctionPointer_t add_common(T *tptr, void (T::*mptr)(void), IRQn_Type irq, bool front = false)
+    {
+        _mutex.lock();
+        int irq_pos = get_irq_index(irq);
+        bool change = must_replace_vector(irq);
+
+        pFunctionPointer_t pf = front ? _chains[irq_pos]->add_front(tptr, mptr) : _chains[irq_pos]->add(tptr, mptr);
+        if (change) {
+            NVIC_SetVector(irq, (uint32_t)&InterruptManager::static_irq_helper);
+        }
+        _mutex.unlock();
+        return pf;
+    }
+
+    pFunctionPointer_t add_common(void (*function)(void), IRQn_Type irq, bool front = false);
+    bool must_replace_vector(IRQn_Type irq);
+    int get_irq_index(IRQn_Type irq);
+    void irq_helper();
+    void add_helper(void (*function)(void), IRQn_Type irq, bool front = false);
+    static void static_irq_helper();
+
+    CallChain *_chains[NVIC_NUM_VECTORS];
+    static InterruptManager *_instance;
+    PlatformMutex _mutex;
+};
+
+} // namespace mbed
+
+#endif