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@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

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 170:e95d10626187 58 DigitalIn(PinName pin) : gpio()
AnnaBridge 170:e95d10626187 59 {
AnnaBridge 156:ff21514d8981 60 // No lock needed in the constructor
AnnaBridge 156:ff21514d8981 61 gpio_init_in(&gpio, pin);
AnnaBridge 156:ff21514d8981 62 }
AnnaBridge 156:ff21514d8981 63
AnnaBridge 156:ff21514d8981 64 /** Create a DigitalIn connected to the specified pin
AnnaBridge 156:ff21514d8981 65 *
AnnaBridge 156:ff21514d8981 66 * @param pin DigitalIn pin to connect to
AnnaBridge 156:ff21514d8981 67 * @param mode the initial mode of the pin
AnnaBridge 156:ff21514d8981 68 */
AnnaBridge 170:e95d10626187 69 DigitalIn(PinName pin, PinMode mode) : gpio()
AnnaBridge 170:e95d10626187 70 {
AnnaBridge 156:ff21514d8981 71 // No lock needed in the constructor
AnnaBridge 156:ff21514d8981 72 gpio_init_in_ex(&gpio, pin, mode);
AnnaBridge 156:ff21514d8981 73 }
AnnaBridge 156:ff21514d8981 74 /** Read the input, represented as 0 or 1 (int)
AnnaBridge 156:ff21514d8981 75 *
AnnaBridge 156:ff21514d8981 76 * @returns
AnnaBridge 156:ff21514d8981 77 * An integer representing the state of the input pin,
AnnaBridge 156:ff21514d8981 78 * 0 for logical 0, 1 for logical 1
AnnaBridge 156:ff21514d8981 79 */
AnnaBridge 170:e95d10626187 80 int read()
AnnaBridge 170:e95d10626187 81 {
AnnaBridge 156:ff21514d8981 82 // Thread safe / atomic HAL call
AnnaBridge 156:ff21514d8981 83 return gpio_read(&gpio);
AnnaBridge 156:ff21514d8981 84 }
AnnaBridge 156:ff21514d8981 85
AnnaBridge 156:ff21514d8981 86 /** Set the input pin mode
AnnaBridge 156:ff21514d8981 87 *
AnnaBridge 156:ff21514d8981 88 * @param pull PullUp, PullDown, PullNone, OpenDrain
AnnaBridge 156:ff21514d8981 89 */
AnnaBridge 170:e95d10626187 90 void mode(PinMode pull)
AnnaBridge 170:e95d10626187 91 {
AnnaBridge 156:ff21514d8981 92 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 93 gpio_mode(&gpio, pull);
AnnaBridge 156:ff21514d8981 94 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 95 }
AnnaBridge 156:ff21514d8981 96
AnnaBridge 156:ff21514d8981 97 /** Return the output setting, represented as 0 or 1 (int)
AnnaBridge 156:ff21514d8981 98 *
AnnaBridge 156:ff21514d8981 99 * @returns
AnnaBridge 156:ff21514d8981 100 * Non zero value if pin is connected to uc GPIO
AnnaBridge 156:ff21514d8981 101 * 0 if gpio object was initialized with NC
AnnaBridge 156:ff21514d8981 102 */
AnnaBridge 170:e95d10626187 103 int is_connected()
AnnaBridge 170:e95d10626187 104 {
AnnaBridge 156:ff21514d8981 105 // Thread safe / atomic HAL call
AnnaBridge 156:ff21514d8981 106 return gpio_is_connected(&gpio);
AnnaBridge 156:ff21514d8981 107 }
AnnaBridge 156:ff21514d8981 108
AnnaBridge 156:ff21514d8981 109 /** An operator shorthand for read()
AnnaBridge 156:ff21514d8981 110 * \sa DigitalIn::read()
AnnaBridge 171:3a7713b1edbc 111 * @code
AnnaBridge 171:3a7713b1edbc 112 * DigitalIn button(BUTTON1);
AnnaBridge 171:3a7713b1edbc 113 * DigitalOut led(LED1);
AnnaBridge 171:3a7713b1edbc 114 * led = button; // Equivalent to led.write(button.read())
AnnaBridge 171:3a7713b1edbc 115 * @endcode
AnnaBridge 156:ff21514d8981 116 */
AnnaBridge 170:e95d10626187 117 operator int()
AnnaBridge 170:e95d10626187 118 {
AnnaBridge 156:ff21514d8981 119 // Underlying read is thread safe
AnnaBridge 156:ff21514d8981 120 return read();
AnnaBridge 156:ff21514d8981 121 }
AnnaBridge 156:ff21514d8981 122
AnnaBridge 156:ff21514d8981 123 protected:
AnnaBridge 171:3a7713b1edbc 124 #if !defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 125 gpio_t gpio;
AnnaBridge 171:3a7713b1edbc 126 #endif //!defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 127 };
AnnaBridge 156:ff21514d8981 128
AnnaBridge 156:ff21514d8981 129 } // namespace mbed
AnnaBridge 156:ff21514d8981 130
AnnaBridge 156:ff21514d8981 131 #endif