takashi kadono / Mbed OS Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/drivers/InterruptIn.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /* mbed Microcontroller Library
kadonotakashi 0:8fdf9a60065b 2 * Copyright (c) 2006-2013 ARM Limited
kadonotakashi 0:8fdf9a60065b 3 *
kadonotakashi 0:8fdf9a60065b 4 * Licensed under the Apache License, Version 2.0 (the "License");
kadonotakashi 0:8fdf9a60065b 5 * you may not use this file except in compliance with the License.
kadonotakashi 0:8fdf9a60065b 6 * You may obtain a copy of the License at
kadonotakashi 0:8fdf9a60065b 7 *
kadonotakashi 0:8fdf9a60065b 8 * http://www.apache.org/licenses/LICENSE-2.0
kadonotakashi 0:8fdf9a60065b 9 *
kadonotakashi 0:8fdf9a60065b 10 * Unless required by applicable law or agreed to in writing, software
kadonotakashi 0:8fdf9a60065b 11 * distributed under the License is distributed on an "AS IS" BASIS,
kadonotakashi 0:8fdf9a60065b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kadonotakashi 0:8fdf9a60065b 13 * See the License for the specific language governing permissions and
kadonotakashi 0:8fdf9a60065b 14 * limitations under the License.
kadonotakashi 0:8fdf9a60065b 15 */
kadonotakashi 0:8fdf9a60065b 16 #ifndef MBED_INTERRUPTIN_H
kadonotakashi 0:8fdf9a60065b 17 #define MBED_INTERRUPTIN_H
kadonotakashi 0:8fdf9a60065b 18
kadonotakashi 0:8fdf9a60065b 19 #include "platform/platform.h"
kadonotakashi 0:8fdf9a60065b 20
kadonotakashi 0:8fdf9a60065b 21 #if defined (DEVICE_INTERRUPTIN) || defined(DOXYGEN_ONLY)
kadonotakashi 0:8fdf9a60065b 22
kadonotakashi 0:8fdf9a60065b 23 #include "hal/gpio_api.h"
kadonotakashi 0:8fdf9a60065b 24 #include "hal/gpio_irq_api.h"
kadonotakashi 0:8fdf9a60065b 25 #include "platform/Callback.h"
kadonotakashi 0:8fdf9a60065b 26 #include "platform/mbed_critical.h"
kadonotakashi 0:8fdf9a60065b 27 #include "platform/mbed_toolchain.h"
kadonotakashi 0:8fdf9a60065b 28 #include "platform/NonCopyable.h"
kadonotakashi 0:8fdf9a60065b 29
kadonotakashi 0:8fdf9a60065b 30 namespace mbed {
kadonotakashi 0:8fdf9a60065b 31 /** \addtogroup drivers */
kadonotakashi 0:8fdf9a60065b 32
kadonotakashi 0:8fdf9a60065b 33 /** A digital interrupt input, used to call a function on a rising or falling edge
kadonotakashi 0:8fdf9a60065b 34 *
kadonotakashi 0:8fdf9a60065b 35 * @note Synchronization level: Interrupt safe
kadonotakashi 0:8fdf9a60065b 36 *
kadonotakashi 0:8fdf9a60065b 37 * Example:
kadonotakashi 0:8fdf9a60065b 38 * @code
kadonotakashi 0:8fdf9a60065b 39 * // Flash an LED while waiting for events
kadonotakashi 0:8fdf9a60065b 40 *
kadonotakashi 0:8fdf9a60065b 41 * #include "mbed.h"
kadonotakashi 0:8fdf9a60065b 42 *
kadonotakashi 0:8fdf9a60065b 43 * InterruptIn event(p16);
kadonotakashi 0:8fdf9a60065b 44 * DigitalOut led(LED1);
kadonotakashi 0:8fdf9a60065b 45 *
kadonotakashi 0:8fdf9a60065b 46 * void trigger() {
kadonotakashi 0:8fdf9a60065b 47 * printf("triggered!\n");
kadonotakashi 0:8fdf9a60065b 48 * }
kadonotakashi 0:8fdf9a60065b 49 *
kadonotakashi 0:8fdf9a60065b 50 * int main() {
kadonotakashi 0:8fdf9a60065b 51 * event.rise(&trigger);
kadonotakashi 0:8fdf9a60065b 52 * while(1) {
kadonotakashi 0:8fdf9a60065b 53 * led = !led;
kadonotakashi 0:8fdf9a60065b 54 * wait(0.25);
kadonotakashi 0:8fdf9a60065b 55 * }
kadonotakashi 0:8fdf9a60065b 56 * }
kadonotakashi 0:8fdf9a60065b 57 * @endcode
kadonotakashi 0:8fdf9a60065b 58 * @ingroup drivers
kadonotakashi 0:8fdf9a60065b 59 */
kadonotakashi 0:8fdf9a60065b 60 class InterruptIn : private NonCopyable<InterruptIn> {
kadonotakashi 0:8fdf9a60065b 61
kadonotakashi 0:8fdf9a60065b 62 public:
kadonotakashi 0:8fdf9a60065b 63
kadonotakashi 0:8fdf9a60065b 64 /** Create an InterruptIn connected to the specified pin
kadonotakashi 0:8fdf9a60065b 65 *
kadonotakashi 0:8fdf9a60065b 66 * @param pin InterruptIn pin to connect to
kadonotakashi 0:8fdf9a60065b 67 */
kadonotakashi 0:8fdf9a60065b 68 InterruptIn(PinName pin);
kadonotakashi 0:8fdf9a60065b 69
kadonotakashi 0:8fdf9a60065b 70 /** Create an InterruptIn connected to the specified pin,
kadonotakashi 0:8fdf9a60065b 71 * and the pin configured to the specified mode.
kadonotakashi 0:8fdf9a60065b 72 *
kadonotakashi 0:8fdf9a60065b 73 * @param pin InterruptIn pin to connect to
kadonotakashi 0:8fdf9a60065b 74 * @param mode The mode to set the pin to (PullUp/PullDown/etc.)
kadonotakashi 0:8fdf9a60065b 75 */
kadonotakashi 0:8fdf9a60065b 76 InterruptIn(PinName pin, PinMode mode);
kadonotakashi 0:8fdf9a60065b 77
kadonotakashi 0:8fdf9a60065b 78 virtual ~InterruptIn();
kadonotakashi 0:8fdf9a60065b 79
kadonotakashi 0:8fdf9a60065b 80 /** Read the input, represented as 0 or 1 (int)
kadonotakashi 0:8fdf9a60065b 81 *
kadonotakashi 0:8fdf9a60065b 82 * @returns
kadonotakashi 0:8fdf9a60065b 83 * An integer representing the state of the input pin,
kadonotakashi 0:8fdf9a60065b 84 * 0 for logical 0, 1 for logical 1
kadonotakashi 0:8fdf9a60065b 85 */
kadonotakashi 0:8fdf9a60065b 86 int read();
kadonotakashi 0:8fdf9a60065b 87
kadonotakashi 0:8fdf9a60065b 88 /** An operator shorthand for read()
kadonotakashi 0:8fdf9a60065b 89 */
kadonotakashi 0:8fdf9a60065b 90 operator int();
kadonotakashi 0:8fdf9a60065b 91
kadonotakashi 0:8fdf9a60065b 92
kadonotakashi 0:8fdf9a60065b 93 /** Attach a function to call when a rising edge occurs on the input
kadonotakashi 0:8fdf9a60065b 94 *
kadonotakashi 0:8fdf9a60065b 95 * @param func A pointer to a void function, or 0 to set as none
kadonotakashi 0:8fdf9a60065b 96 */
kadonotakashi 0:8fdf9a60065b 97 void rise(Callback<void()> func);
kadonotakashi 0:8fdf9a60065b 98
kadonotakashi 0:8fdf9a60065b 99 /** Attach a member function to call when a rising edge occurs on the input
kadonotakashi 0:8fdf9a60065b 100 *
kadonotakashi 0:8fdf9a60065b 101 * @param obj pointer to the object to call the member function on
kadonotakashi 0:8fdf9a60065b 102 * @param method pointer to the member function to be called
kadonotakashi 0:8fdf9a60065b 103 * @deprecated
kadonotakashi 0:8fdf9a60065b 104 * The rise function does not support cv-qualifiers. Replaced by
kadonotakashi 0:8fdf9a60065b 105 * rise(callback(obj, method)).
kadonotakashi 0:8fdf9a60065b 106 */
kadonotakashi 0:8fdf9a60065b 107 template<typename T, typename M>
kadonotakashi 0:8fdf9a60065b 108 MBED_DEPRECATED_SINCE("mbed-os-5.1",
kadonotakashi 0:8fdf9a60065b 109 "The rise function does not support cv-qualifiers. Replaced by "
kadonotakashi 0:8fdf9a60065b 110 "rise(callback(obj, method)).")
kadonotakashi 0:8fdf9a60065b 111 void rise(T *obj, M method)
kadonotakashi 0:8fdf9a60065b 112 {
kadonotakashi 0:8fdf9a60065b 113 core_util_critical_section_enter();
kadonotakashi 0:8fdf9a60065b 114 rise(callback(obj, method));
kadonotakashi 0:8fdf9a60065b 115 core_util_critical_section_exit();
kadonotakashi 0:8fdf9a60065b 116 }
kadonotakashi 0:8fdf9a60065b 117
kadonotakashi 0:8fdf9a60065b 118 /** Attach a function to call when a falling edge occurs on the input
kadonotakashi 0:8fdf9a60065b 119 *
kadonotakashi 0:8fdf9a60065b 120 * @param func A pointer to a void function, or 0 to set as none
kadonotakashi 0:8fdf9a60065b 121 */
kadonotakashi 0:8fdf9a60065b 122 void fall(Callback<void()> func);
kadonotakashi 0:8fdf9a60065b 123
kadonotakashi 0:8fdf9a60065b 124 /** Attach a member function to call when a falling edge occurs on the input
kadonotakashi 0:8fdf9a60065b 125 *
kadonotakashi 0:8fdf9a60065b 126 * @param obj pointer to the object to call the member function on
kadonotakashi 0:8fdf9a60065b 127 * @param method pointer to the member function to be called
kadonotakashi 0:8fdf9a60065b 128 * @deprecated
kadonotakashi 0:8fdf9a60065b 129 * The rise function does not support cv-qualifiers. Replaced by
kadonotakashi 0:8fdf9a60065b 130 * rise(callback(obj, method)).
kadonotakashi 0:8fdf9a60065b 131 */
kadonotakashi 0:8fdf9a60065b 132 template<typename T, typename M>
kadonotakashi 0:8fdf9a60065b 133 MBED_DEPRECATED_SINCE("mbed-os-5.1",
kadonotakashi 0:8fdf9a60065b 134 "The fall function does not support cv-qualifiers. Replaced by "
kadonotakashi 0:8fdf9a60065b 135 "fall(callback(obj, method)).")
kadonotakashi 0:8fdf9a60065b 136 void fall(T *obj, M method)
kadonotakashi 0:8fdf9a60065b 137 {
kadonotakashi 0:8fdf9a60065b 138 core_util_critical_section_enter();
kadonotakashi 0:8fdf9a60065b 139 fall(callback(obj, method));
kadonotakashi 0:8fdf9a60065b 140 core_util_critical_section_exit();
kadonotakashi 0:8fdf9a60065b 141 }
kadonotakashi 0:8fdf9a60065b 142
kadonotakashi 0:8fdf9a60065b 143 /** Set the input pin mode
kadonotakashi 0:8fdf9a60065b 144 *
kadonotakashi 0:8fdf9a60065b 145 * @param pull PullUp, PullDown, PullNone
kadonotakashi 0:8fdf9a60065b 146 */
kadonotakashi 0:8fdf9a60065b 147 void mode(PinMode pull);
kadonotakashi 0:8fdf9a60065b 148
kadonotakashi 0:8fdf9a60065b 149 /** Enable IRQ. This method depends on hw implementation, might enable one
kadonotakashi 0:8fdf9a60065b 150 * port interrupts. For further information, check gpio_irq_enable().
kadonotakashi 0:8fdf9a60065b 151 */
kadonotakashi 0:8fdf9a60065b 152 void enable_irq();
kadonotakashi 0:8fdf9a60065b 153
kadonotakashi 0:8fdf9a60065b 154 /** Disable IRQ. This method depends on hw implementation, might disable one
kadonotakashi 0:8fdf9a60065b 155 * port interrupts. For further information, check gpio_irq_disable().
kadonotakashi 0:8fdf9a60065b 156 */
kadonotakashi 0:8fdf9a60065b 157 void disable_irq();
kadonotakashi 0:8fdf9a60065b 158
kadonotakashi 0:8fdf9a60065b 159 static void _irq_handler(uint32_t id, gpio_irq_event event);
kadonotakashi 0:8fdf9a60065b 160
kadonotakashi 0:8fdf9a60065b 161 protected:
kadonotakashi 0:8fdf9a60065b 162 gpio_t gpio;
kadonotakashi 0:8fdf9a60065b 163 gpio_irq_t gpio_irq;
kadonotakashi 0:8fdf9a60065b 164
kadonotakashi 0:8fdf9a60065b 165 Callback<void()> _rise;
kadonotakashi 0:8fdf9a60065b 166 Callback<void()> _fall;
kadonotakashi 0:8fdf9a60065b 167
kadonotakashi 0:8fdf9a60065b 168 void irq_init(PinName pin);
kadonotakashi 0:8fdf9a60065b 169 };
kadonotakashi 0:8fdf9a60065b 170
kadonotakashi 0:8fdf9a60065b 171 } // namespace mbed
kadonotakashi 0:8fdf9a60065b 172
kadonotakashi 0:8fdf9a60065b 173 #endif
kadonotakashi 0:8fdf9a60065b 174
kadonotakashi 0:8fdf9a60065b 175 #endif