teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

api/DigitalIn.h@148:4802eb17e82b, 2016-10-17 (annotated)

Committer:
rodriguise
Date:
Mon Oct 17 18:47:01 2016 +0000
Revision:
148:4802eb17e82b
Parent:
144:ef7eb2e8f9f7 
backup

Who changed what in which revision?

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