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