mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/DigitalIn.h@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
170:e95d10626187
Release 155 of the mbed library.

Who changed what in which revision?

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