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/DigitalInOut.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_DIGITALINOUT_H
<> 128:9bcdf88f62b0 17 #define MBED_DIGITALINOUT_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/output, used for setting or reading a bi-directional pin
<> 128:9bcdf88f62b0 28 *
AnnaBridge 145:64910690c574 29 * @note Synchronization level: Interrupt safe
AnnaBridge 145:64910690c574 30 * @ingroup drivers
<> 128:9bcdf88f62b0 31 */
<> 128:9bcdf88f62b0 32 class DigitalInOut {
<> 128:9bcdf88f62b0 33
<> 128:9bcdf88f62b0 34 public:
<> 128:9bcdf88f62b0 35 /** Create a DigitalInOut connected to the specified pin
<> 128:9bcdf88f62b0 36 *
<> 128:9bcdf88f62b0 37 * @param pin DigitalInOut pin to connect to
<> 128:9bcdf88f62b0 38 */
<> 128:9bcdf88f62b0 39 DigitalInOut(PinName pin) : gpio() {
<> 128:9bcdf88f62b0 40 // No lock needed in the constructor
<> 128:9bcdf88f62b0 41 gpio_init_in(&gpio, pin);
<> 128:9bcdf88f62b0 42 }
<> 128:9bcdf88f62b0 43
<> 128:9bcdf88f62b0 44 /** Create a DigitalInOut connected to the specified pin
<> 128:9bcdf88f62b0 45 *
<> 128:9bcdf88f62b0 46 * @param pin DigitalInOut pin to connect to
<> 128:9bcdf88f62b0 47 * @param direction the initial direction of the pin
<> 128:9bcdf88f62b0 48 * @param mode the initial mode of the pin
<> 128:9bcdf88f62b0 49 * @param value the initial value of the pin if is an output
<> 128:9bcdf88f62b0 50 */
<> 128:9bcdf88f62b0 51 DigitalInOut(PinName pin, PinDirection direction, PinMode mode, int value) : gpio() {
<> 128:9bcdf88f62b0 52 // No lock needed in the constructor
<> 128:9bcdf88f62b0 53 gpio_init_inout(&gpio, pin, direction, mode, value);
<> 128:9bcdf88f62b0 54 }
<> 128:9bcdf88f62b0 55
<> 128:9bcdf88f62b0 56 /** Set the output, specified as 0 or 1 (int)
<> 128:9bcdf88f62b0 57 *
<> 128:9bcdf88f62b0 58 * @param value An integer specifying the pin output value,
<> 128:9bcdf88f62b0 59 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
<> 128:9bcdf88f62b0 60 */
<> 128:9bcdf88f62b0 61 void write(int value) {
<> 128:9bcdf88f62b0 62 // Thread safe / atomic HAL call
<> 128:9bcdf88f62b0 63 gpio_write(&gpio, value);
<> 128:9bcdf88f62b0 64 }
<> 128:9bcdf88f62b0 65
<> 128:9bcdf88f62b0 66 /** Return the output setting, represented as 0 or 1 (int)
<> 128:9bcdf88f62b0 67 *
<> 128:9bcdf88f62b0 68 * @returns
<> 128:9bcdf88f62b0 69 * an integer representing the output setting of the pin if it is an output,
<> 128:9bcdf88f62b0 70 * or read the input if set as an input
<> 128:9bcdf88f62b0 71 */
<> 128:9bcdf88f62b0 72 int read() {
<> 128:9bcdf88f62b0 73 // Thread safe / atomic HAL call
<> 128:9bcdf88f62b0 74 return gpio_read(&gpio);
<> 128:9bcdf88f62b0 75 }
<> 128:9bcdf88f62b0 76
<> 128:9bcdf88f62b0 77 /** Set as an output
<> 128:9bcdf88f62b0 78 */
<> 128:9bcdf88f62b0 79 void output() {
<> 128:9bcdf88f62b0 80 core_util_critical_section_enter();
<> 128:9bcdf88f62b0 81 gpio_dir(&gpio, PIN_OUTPUT);
<> 128:9bcdf88f62b0 82 core_util_critical_section_exit();
<> 128:9bcdf88f62b0 83 }
<> 128:9bcdf88f62b0 84
<> 128:9bcdf88f62b0 85 /** Set as an input
<> 128:9bcdf88f62b0 86 */
<> 128:9bcdf88f62b0 87 void input() {
<> 128:9bcdf88f62b0 88 core_util_critical_section_enter();
<> 128:9bcdf88f62b0 89 gpio_dir(&gpio, PIN_INPUT);
<> 128:9bcdf88f62b0 90 core_util_critical_section_exit();
<> 128:9bcdf88f62b0 91 }
<> 128:9bcdf88f62b0 92
<> 128:9bcdf88f62b0 93 /** Set the input pin mode
<> 128:9bcdf88f62b0 94 *
AnnaBridge 145:64910690c574 95 * @param pull PullUp, PullDown, PullNone, OpenDrain
<> 128:9bcdf88f62b0 96 */
<> 128:9bcdf88f62b0 97 void mode(PinMode pull) {
<> 128:9bcdf88f62b0 98 core_util_critical_section_enter();
<> 128:9bcdf88f62b0 99 gpio_mode(&gpio, pull);
<> 128:9bcdf88f62b0 100 core_util_critical_section_exit();
<> 128:9bcdf88f62b0 101 }
<> 128:9bcdf88f62b0 102
<> 128:9bcdf88f62b0 103 /** Return the output setting, represented as 0 or 1 (int)
<> 128:9bcdf88f62b0 104 *
<> 128:9bcdf88f62b0 105 * @returns
<> 128:9bcdf88f62b0 106 * Non zero value if pin is connected to uc GPIO
<> 128:9bcdf88f62b0 107 * 0 if gpio object was initialized with NC
<> 128:9bcdf88f62b0 108 */
<> 128:9bcdf88f62b0 109 int is_connected() {
<> 128:9bcdf88f62b0 110 // Thread safe / atomic HAL call
<> 128:9bcdf88f62b0 111 return gpio_is_connected(&gpio);
<> 128:9bcdf88f62b0 112 }
<> 128:9bcdf88f62b0 113
<> 128:9bcdf88f62b0 114 /** A shorthand for write()
AnnaBridge 145:64910690c574 115 * \sa DigitalInOut::write()
<> 128:9bcdf88f62b0 116 */
<> 128:9bcdf88f62b0 117 DigitalInOut& operator= (int value) {
<> 128:9bcdf88f62b0 118 // Underlying write is thread safe
<> 128:9bcdf88f62b0 119 write(value);
<> 128:9bcdf88f62b0 120 return *this;
<> 128:9bcdf88f62b0 121 }
<> 128:9bcdf88f62b0 122
AnnaBridge 145:64910690c574 123 /** A shorthand for write()
AnnaBridge 145:64910690c574 124 * \sa DigitalInOut::write()
AnnaBridge 145:64910690c574 125 */
<> 128:9bcdf88f62b0 126 DigitalInOut& operator= (DigitalInOut& rhs) {
<> 128:9bcdf88f62b0 127 core_util_critical_section_enter();
<> 128:9bcdf88f62b0 128 write(rhs.read());
<> 128:9bcdf88f62b0 129 core_util_critical_section_exit();
<> 128:9bcdf88f62b0 130 return *this;
<> 128:9bcdf88f62b0 131 }
<> 128:9bcdf88f62b0 132
<> 128:9bcdf88f62b0 133 /** A shorthand for read()
AnnaBridge 145:64910690c574 134 * \sa DigitalInOut::read()
<> 128:9bcdf88f62b0 135 */
<> 128:9bcdf88f62b0 136 operator int() {
<> 128:9bcdf88f62b0 137 // Underlying call is thread safe
<> 128:9bcdf88f62b0 138 return read();
<> 128:9bcdf88f62b0 139 }
<> 128:9bcdf88f62b0 140
<> 128:9bcdf88f62b0 141 protected:
<> 128:9bcdf88f62b0 142 gpio_t gpio;
<> 128:9bcdf88f62b0 143 };
<> 128:9bcdf88f62b0 144
<> 128:9bcdf88f62b0 145 } // namespace mbed
<> 128:9bcdf88f62b0 146
<> 128:9bcdf88f62b0 147 #endif