Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/InterruptIn.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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