Lancaster University / mbed-dev-bin

Binary version of Lancaster University's mbed branch, soon to be merged. The source lives here:https://developer.mbed.org/teams/Lancaster-University/code/mbed-src/

Dependents:   microbit-dal microbit-ble-open microbit-dal-eddystone microbit-dal ... more

Fork of mbed-lite-test by Lancaster University

InterruptIn.h@3:768173a57492, 2016-07-13 (annotated)

Committer:
jamesadevine
Date:
Wed Jul 13 15:12:06 2016 +0100
Revision:
3:768173a57492
Parent:
0:e1a608bb55e8 
further updates to mbed-dev-bin

Who changed what in which revision?

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