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@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
145:64910690c574 
Release 147 of the mbed library.

Who changed what in which revision?

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