Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

DigitalIn.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mturner5 0:b7116bd48af6 1 /* mbed Microcontroller Library
mturner5 0:b7116bd48af6 2 * Copyright (c) 2006-2013 ARM Limited
mturner5 0:b7116bd48af6 3 *
mturner5 0:b7116bd48af6 4 * Licensed under the Apache License, Version 2.0 (the "License");
mturner5 0:b7116bd48af6 5 * you may not use this file except in compliance with the License.
mturner5 0:b7116bd48af6 6 * You may obtain a copy of the License at
mturner5 0:b7116bd48af6 7 *
mturner5 0:b7116bd48af6 8 * http://www.apache.org/licenses/LICENSE-2.0
mturner5 0:b7116bd48af6 9 *
mturner5 0:b7116bd48af6 10 * Unless required by applicable law or agreed to in writing, software
mturner5 0:b7116bd48af6 11 * distributed under the License is distributed on an "AS IS" BASIS,
mturner5 0:b7116bd48af6 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mturner5 0:b7116bd48af6 13 * See the License for the specific language governing permissions and
mturner5 0:b7116bd48af6 14 * limitations under the License.
mturner5 0:b7116bd48af6 15 */
mturner5 0:b7116bd48af6 16 #ifndef MBED_DIGITALIN_H
mturner5 0:b7116bd48af6 17 #define MBED_DIGITALIN_H
mturner5 0:b7116bd48af6 18
mturner5 0:b7116bd48af6 19 #include "platform.h"
mturner5 0:b7116bd48af6 20
mturner5 0:b7116bd48af6 21 #include "gpio_api.h"
mturner5 0:b7116bd48af6 22 #include "critical.h"
mturner5 0:b7116bd48af6 23
mturner5 0:b7116bd48af6 24 namespace mbed {
mturner5 0:b7116bd48af6 25
mturner5 0:b7116bd48af6 26 /** A digital input, used for reading the state of a pin
mturner5 0:b7116bd48af6 27 *
mturner5 0:b7116bd48af6 28 * @Note Synchronization level: Interrupt safe
mturner5 0:b7116bd48af6 29 *
mturner5 0:b7116bd48af6 30 * Example:
mturner5 0:b7116bd48af6 31 * @code
mturner5 0:b7116bd48af6 32 * // Flash an LED while a DigitalIn is true
mturner5 0:b7116bd48af6 33 *
mturner5 0:b7116bd48af6 34 * #include "mbed.h"
mturner5 0:b7116bd48af6 35 *
mturner5 0:b7116bd48af6 36 * DigitalIn enable(p5);
mturner5 0:b7116bd48af6 37 * DigitalOut led(LED1);
mturner5 0:b7116bd48af6 38 *
mturner5 0:b7116bd48af6 39 * int main() {
mturner5 0:b7116bd48af6 40 * while(1) {
mturner5 0:b7116bd48af6 41 * if(enable) {
mturner5 0:b7116bd48af6 42 * led = !led;
mturner5 0:b7116bd48af6 43 * }
mturner5 0:b7116bd48af6 44 * wait(0.25);
mturner5 0:b7116bd48af6 45 * }
mturner5 0:b7116bd48af6 46 * }
mturner5 0:b7116bd48af6 47 * @endcode
mturner5 0:b7116bd48af6 48 */
mturner5 0:b7116bd48af6 49 class DigitalIn {
mturner5 0:b7116bd48af6 50
mturner5 0:b7116bd48af6 51 public:
mturner5 0:b7116bd48af6 52 /** Create a DigitalIn connected to the specified pin
mturner5 0:b7116bd48af6 53 *
mturner5 0:b7116bd48af6 54 * @param pin DigitalIn pin to connect to
mturner5 0:b7116bd48af6 55 */
mturner5 0:b7116bd48af6 56 DigitalIn(PinName pin) : gpio() {
mturner5 0:b7116bd48af6 57 // No lock needed in the constructor
mturner5 0:b7116bd48af6 58 gpio_init_in(&gpio, pin);
mturner5 0:b7116bd48af6 59 }
mturner5 0:b7116bd48af6 60
mturner5 0:b7116bd48af6 61 /** Create a DigitalIn connected to the specified pin
mturner5 0:b7116bd48af6 62 *
mturner5 0:b7116bd48af6 63 * @param pin DigitalIn pin to connect to
mturner5 0:b7116bd48af6 64 * @param mode the initial mode of the pin
mturner5 0:b7116bd48af6 65 */
mturner5 0:b7116bd48af6 66 DigitalIn(PinName pin, PinMode mode) : gpio() {
mturner5 0:b7116bd48af6 67 // No lock needed in the constructor
mturner5 0:b7116bd48af6 68 gpio_init_in_ex(&gpio, pin, mode);
mturner5 0:b7116bd48af6 69 }
mturner5 0:b7116bd48af6 70 /** Read the input, represented as 0 or 1 (int)
mturner5 0:b7116bd48af6 71 *
mturner5 0:b7116bd48af6 72 * @returns
mturner5 0:b7116bd48af6 73 * An integer representing the state of the input pin,
mturner5 0:b7116bd48af6 74 * 0 for logical 0, 1 for logical 1
mturner5 0:b7116bd48af6 75 */
mturner5 0:b7116bd48af6 76 int read() {
mturner5 0:b7116bd48af6 77 // Thread safe / atomic HAL call
mturner5 0:b7116bd48af6 78 return gpio_read(&gpio);
mturner5 0:b7116bd48af6 79 }
mturner5 0:b7116bd48af6 80
mturner5 0:b7116bd48af6 81 /** Set the input pin mode
mturner5 0:b7116bd48af6 82 *
mturner5 0:b7116bd48af6 83 * @param mode PullUp, PullDown, PullNone, OpenDrain
mturner5 0:b7116bd48af6 84 */
mturner5 0:b7116bd48af6 85 void mode(PinMode pull) {
mturner5 0:b7116bd48af6 86 core_util_critical_section_enter();
mturner5 0:b7116bd48af6 87 gpio_mode(&gpio, pull);
mturner5 0:b7116bd48af6 88 core_util_critical_section_exit();
mturner5 0:b7116bd48af6 89 }
mturner5 0:b7116bd48af6 90
mturner5 0:b7116bd48af6 91 /** Return the output setting, represented as 0 or 1 (int)
mturner5 0:b7116bd48af6 92 *
mturner5 0:b7116bd48af6 93 * @returns
mturner5 0:b7116bd48af6 94 * Non zero value if pin is connected to uc GPIO
mturner5 0:b7116bd48af6 95 * 0 if gpio object was initialized with NC
mturner5 0:b7116bd48af6 96 */
mturner5 0:b7116bd48af6 97 int is_connected() {
mturner5 0:b7116bd48af6 98 // Thread safe / atomic HAL call
mturner5 0:b7116bd48af6 99 return gpio_is_connected(&gpio);
mturner5 0:b7116bd48af6 100 }
mturner5 0:b7116bd48af6 101
mturner5 0:b7116bd48af6 102 /** An operator shorthand for read()
mturner5 0:b7116bd48af6 103 */
mturner5 0:b7116bd48af6 104 operator int() {
mturner5 0:b7116bd48af6 105 // Underlying read is thread safe
mturner5 0:b7116bd48af6 106 return read();
mturner5 0:b7116bd48af6 107 }
mturner5 0:b7116bd48af6 108
mturner5 0:b7116bd48af6 109 protected:
mturner5 0:b7116bd48af6 110 gpio_t gpio;
mturner5 0:b7116bd48af6 111 };
mturner5 0:b7116bd48af6 112
mturner5 0:b7116bd48af6 113 } // namespace mbed
mturner5 0:b7116bd48af6 114
mturner5 0:b7116bd48af6 115 #endif