Jhon Plantikow / mbed

.

Dependents:   RTC

InterruptIn.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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