Christopher Haster / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/InterruptIn.h@13:d6551a5dcbbf, 2016-03-31 (annotated)

Committer:
Christopher Haster
Date:
Thu Mar 31 20:10:32 2016 -0500
Revision:
13:d6551a5dcbbf
Parent:
7:4fdb3a44f646
Child:
16:086d28575041
Adopted FunctionPointer for the common function interfaces

Who changed what in which revision?

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