Diff: mbed/drivers/InterruptIn.h

Revision:

12:406f75196a12

Parent:

11:32eeb052cda5

Child:

13:0c732e06d675

--- a/mbed/drivers/InterruptIn.h	Wed Aug 26 14:26:27 2020 +0530
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,182 +0,0 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
- * SPDX-License-Identifier: Apache-2.0
- *
- * 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_INTERRUPTIN_H
-#define MBED_INTERRUPTIN_H
-
-#include "platform/platform.h"
-
-#if DEVICE_INTERRUPTIN || defined(DOXYGEN_ONLY)
-
-#include "hal/gpio_api.h"
-#include "hal/gpio_irq_api.h"
-#include "platform/Callback.h"
-#include "platform/mbed_critical.h"
-#include "platform/mbed_toolchain.h"
-#include "platform/NonCopyable.h"
-
-namespace mbed {
-/** \addtogroup drivers */
-
-/** A digital interrupt input, used to call a function on a rising or falling edge
- *
- * @note Synchronization level: Interrupt safe
- *
- * Example:
- * @code
- * // Flash an LED while waiting for events
- *
- * #include "mbed.h"
- *
- * InterruptIn event(p16);
- * DigitalOut led(LED1);
- *
- * void trigger() {
- *     printf("triggered!\n");
- * }
- *
- * int main() {
- *     // register trigger() to be called upon the rising edge of event
- *     event.rise(&trigger);
- *     while(1) {
- *         led = !led;
- *         wait(0.25);
- *     }
- * }
- * @endcode
- * @ingroup drivers
- */
-class InterruptIn : private NonCopyable<InterruptIn> {
-
-public:
-
-    /** Create an InterruptIn connected to the specified pin
-     *
-     *  @param pin InterruptIn pin to connect to
-     */
-    InterruptIn(PinName pin);
-
-    /** Create an InterruptIn connected to the specified pin,
-     *  and the pin configured to the specified mode.
-     *
-     *  @param pin InterruptIn pin to connect to
-     *  @param mode Desired Pin mode configuration.
-     *  (Valid values could be PullNone, PullDown, PullUp and PullDefault.
-     *  See PinNames.h for your target for definitions)
-     *
-     */
-    InterruptIn(PinName pin, PinMode mode);
-
-    virtual ~InterruptIn();
-
-    /** Read the input, represented as 0 or 1 (int)
-     *
-     *  @returns
-     *    An integer representing the state of the input pin,
-     *    0 for logical 0, 1 for logical 1
-     */
-    int read();
-
-    /** An operator shorthand for read()
-     */
-    operator int();
-
-
-    /** Attach a function to call when a rising edge occurs on the input
-     *
-     *  @param func A pointer to a void function, or 0 to set as none
-     */
-    void rise(Callback<void()> func);
-
-    /** Attach a member function to call when a rising edge occurs on the input
-     *
-     *  @param obj pointer to the object to call the member function on
-     *  @param method pointer to the member function to be called
-     *  @deprecated
-     *      The rise function does not support cv-qualifiers. Replaced by
-     *      rise(callback(obj, method)).
-     */
-    template<typename T, typename M>
-    MBED_DEPRECATED_SINCE("mbed-os-5.1",
-                          "The rise function does not support cv-qualifiers. Replaced by "
-                          "rise(callback(obj, method)).")
-    void rise(T *obj, M method)
-    {
-        core_util_critical_section_enter();
-        rise(callback(obj, method));
-        core_util_critical_section_exit();
-    }
-
-    /** Attach a function to call when a falling edge occurs on the input
-     *
-     *  @param func A pointer to a void function, or 0 to set as none
-     */
-    void fall(Callback<void()> func);
-
-    /** Attach a member function to call when a falling edge occurs on the input
-     *
-     *  @param obj pointer to the object to call the member function on
-     *  @param method pointer to the member function to be called
-     *  @deprecated
-     *      The rise function does not support cv-qualifiers. Replaced by
-     *      rise(callback(obj, method)).
-     */
-    template<typename T, typename M>
-    MBED_DEPRECATED_SINCE("mbed-os-5.1",
-                          "The fall function does not support cv-qualifiers. Replaced by "
-                          "fall(callback(obj, method)).")
-    void fall(T *obj, M method)
-    {
-        core_util_critical_section_enter();
-        fall(callback(obj, method));
-        core_util_critical_section_exit();
-    }
-
-    /** Set the input pin mode
-     *
-     *  @param pull PullUp, PullDown, PullNone, PullDefault
-     *  See PinNames.h for your target for definitions)
-     */
-    void mode(PinMode pull);
-
-    /** Enable IRQ. This method depends on hardware implementation, might enable one
-     *  port interrupts. For further information, check gpio_irq_enable().
-     */
-    void enable_irq();
-
-    /** Disable IRQ. This method depends on hardware implementation, might disable one
-     *  port interrupts. For further information, check gpio_irq_disable().
-     */
-    void disable_irq();
-
-    static void _irq_handler(uint32_t id, gpio_irq_event event);
-#if !defined(DOXYGEN_ONLY)
-protected:
-    gpio_t gpio;
-    gpio_irq_t gpio_irq;
-
-    Callback<void()> _rise;
-    Callback<void()> _fall;
-
-    void irq_init(PinName pin);
-#endif
-};
-
-} // namespace mbed
-
-#endif
-
-#endif