Jhon Plantikow / Dataloger

Dataloger

InterruptIn.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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