Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/hal/api/DigitalIn.h@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

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