From aa30a51f3e2d9120aa819c1bc8162793662ccf32 Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Wed, 10 May 2017 13:17:31 +0100 Subject: Adding initial files --- mbed/drivers/InterruptIn.h | 164 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 164 insertions(+) create mode 100644 mbed/drivers/InterruptIn.h (limited to 'mbed/drivers/InterruptIn.h') diff --git a/mbed/drivers/InterruptIn.h b/mbed/drivers/InterruptIn.h new file mode 100644 index 0000000..5f39acc --- /dev/null +++ b/mbed/drivers/InterruptIn.h @@ -0,0 +1,164 @@ +/* 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_INTERRUPTIN_H +#define MBED_INTERRUPTIN_H + +#include "platform/platform.h" + +#if DEVICE_INTERRUPTIN + +#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" + +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() { + * event.rise(&trigger); + * while(1) { + * led = !led; + * wait(0.25); + * } + * } + * @endcode + */ +class InterruptIn { + +public: + + /** Create an InterruptIn connected to the specified pin + * + * @param pin InterruptIn pin to connect to + * @param name (optional) A string to identify the object + */ + InterruptIn(PinName pin); + 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 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 + 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 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 + 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 mode PullUp, PullDown, PullNone + */ + void mode(PinMode pull); + + /** Enable IRQ. This method depends on hw implementation, might enable one + * port interrupts. For further information, check gpio_irq_enable(). + */ + void enable_irq(); + + /** Disable IRQ. This method depends on hw 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); + +protected: + gpio_t gpio; + gpio_irq_t gpio_irq; + + Callback _rise; + Callback _fall; +}; + +} // namespace mbed + +#endif + +#endif + +/** @}*/ -- cgit