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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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 172:65be27845400 3 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 156:ff21514d8981 4 *
AnnaBridge 156:ff21514d8981 5 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 6 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 7 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 8 *
AnnaBridge 156:ff21514d8981 9 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 12 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 14 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 15 * limitations under the License.
AnnaBridge 156:ff21514d8981 16 */
AnnaBridge 156:ff21514d8981 17 #ifndef MBED_DIGITALINOUT_H
AnnaBridge 156:ff21514d8981 18 #define MBED_DIGITALINOUT_H
AnnaBridge 156:ff21514d8981 19
AnnaBridge 156:ff21514d8981 20 #include "platform/platform.h"
AnnaBridge 156:ff21514d8981 21
AnnaBridge 156:ff21514d8981 22 #include "hal/gpio_api.h"
AnnaBridge 156:ff21514d8981 23 #include "platform/mbed_critical.h"
AnnaBridge 156:ff21514d8981 24
AnnaBridge 156:ff21514d8981 25 namespace mbed {
AnnaBridge 156:ff21514d8981 26 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 27
AnnaBridge 156:ff21514d8981 28 /** A digital input/output, used for setting or reading a bi-directional pin
AnnaBridge 156:ff21514d8981 29 *
AnnaBridge 156:ff21514d8981 30 * @note Synchronization level: Interrupt safe
AnnaBridge 156:ff21514d8981 31 * @ingroup drivers
AnnaBridge 156:ff21514d8981 32 */
AnnaBridge 156:ff21514d8981 33 class DigitalInOut {
AnnaBridge 156:ff21514d8981 34
AnnaBridge 156:ff21514d8981 35 public:
AnnaBridge 156:ff21514d8981 36 /** Create a DigitalInOut connected to the specified pin
AnnaBridge 156:ff21514d8981 37 *
AnnaBridge 156:ff21514d8981 38 * @param pin DigitalInOut pin to connect to
AnnaBridge 156:ff21514d8981 39 */
AnnaBridge 170:e95d10626187 40 DigitalInOut(PinName pin) : gpio()
AnnaBridge 170:e95d10626187 41 {
AnnaBridge 156:ff21514d8981 42 // No lock needed in the constructor
AnnaBridge 156:ff21514d8981 43 gpio_init_in(&gpio, pin);
AnnaBridge 156:ff21514d8981 44 }
AnnaBridge 156:ff21514d8981 45
AnnaBridge 156:ff21514d8981 46 /** Create a DigitalInOut connected to the specified pin
AnnaBridge 156:ff21514d8981 47 *
AnnaBridge 156:ff21514d8981 48 * @param pin DigitalInOut pin to connect to
AnnaBridge 156:ff21514d8981 49 * @param direction the initial direction of the pin
AnnaBridge 156:ff21514d8981 50 * @param mode the initial mode of the pin
AnnaBridge 156:ff21514d8981 51 * @param value the initial value of the pin if is an output
AnnaBridge 156:ff21514d8981 52 */
AnnaBridge 170:e95d10626187 53 DigitalInOut(PinName pin, PinDirection direction, PinMode mode, int value) : gpio()
AnnaBridge 170:e95d10626187 54 {
AnnaBridge 156:ff21514d8981 55 // No lock needed in the constructor
AnnaBridge 156:ff21514d8981 56 gpio_init_inout(&gpio, pin, direction, mode, value);
AnnaBridge 156:ff21514d8981 57 }
AnnaBridge 156:ff21514d8981 58
AnnaBridge 156:ff21514d8981 59 /** Set the output, specified as 0 or 1 (int)
AnnaBridge 156:ff21514d8981 60 *
AnnaBridge 156:ff21514d8981 61 * @param value An integer specifying the pin output value,
AnnaBridge 156:ff21514d8981 62 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
AnnaBridge 156:ff21514d8981 63 */
AnnaBridge 170:e95d10626187 64 void write(int value)
AnnaBridge 170:e95d10626187 65 {
AnnaBridge 156:ff21514d8981 66 // Thread safe / atomic HAL call
AnnaBridge 156:ff21514d8981 67 gpio_write(&gpio, value);
AnnaBridge 156:ff21514d8981 68 }
AnnaBridge 156:ff21514d8981 69
AnnaBridge 156:ff21514d8981 70 /** Return the output setting, represented as 0 or 1 (int)
AnnaBridge 156:ff21514d8981 71 *
AnnaBridge 156:ff21514d8981 72 * @returns
AnnaBridge 156:ff21514d8981 73 * an integer representing the output setting of the pin if it is an output,
AnnaBridge 156:ff21514d8981 74 * or read the input if set as an input
AnnaBridge 156:ff21514d8981 75 */
AnnaBridge 170:e95d10626187 76 int read()
AnnaBridge 170:e95d10626187 77 {
AnnaBridge 156:ff21514d8981 78 // Thread safe / atomic HAL call
AnnaBridge 156:ff21514d8981 79 return gpio_read(&gpio);
AnnaBridge 156:ff21514d8981 80 }
AnnaBridge 156:ff21514d8981 81
AnnaBridge 156:ff21514d8981 82 /** Set as an output
AnnaBridge 156:ff21514d8981 83 */
AnnaBridge 170:e95d10626187 84 void output()
AnnaBridge 170:e95d10626187 85 {
AnnaBridge 156:ff21514d8981 86 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 87 gpio_dir(&gpio, PIN_OUTPUT);
AnnaBridge 156:ff21514d8981 88 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 89 }
AnnaBridge 156:ff21514d8981 90
AnnaBridge 156:ff21514d8981 91 /** Set as an input
AnnaBridge 156:ff21514d8981 92 */
AnnaBridge 170:e95d10626187 93 void input()
AnnaBridge 170:e95d10626187 94 {
AnnaBridge 156:ff21514d8981 95 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 96 gpio_dir(&gpio, PIN_INPUT);
AnnaBridge 156:ff21514d8981 97 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 98 }
AnnaBridge 156:ff21514d8981 99
AnnaBridge 156:ff21514d8981 100 /** Set the input pin mode
AnnaBridge 156:ff21514d8981 101 *
AnnaBridge 156:ff21514d8981 102 * @param pull PullUp, PullDown, PullNone, OpenDrain
AnnaBridge 156:ff21514d8981 103 */
AnnaBridge 170:e95d10626187 104 void mode(PinMode pull)
AnnaBridge 170:e95d10626187 105 {
AnnaBridge 156:ff21514d8981 106 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 107 gpio_mode(&gpio, pull);
AnnaBridge 156:ff21514d8981 108 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 109 }
AnnaBridge 156:ff21514d8981 110
AnnaBridge 156:ff21514d8981 111 /** Return the output setting, represented as 0 or 1 (int)
AnnaBridge 156:ff21514d8981 112 *
AnnaBridge 156:ff21514d8981 113 * @returns
AnnaBridge 156:ff21514d8981 114 * Non zero value if pin is connected to uc GPIO
AnnaBridge 156:ff21514d8981 115 * 0 if gpio object was initialized with NC
AnnaBridge 156:ff21514d8981 116 */
AnnaBridge 170:e95d10626187 117 int is_connected()
AnnaBridge 170:e95d10626187 118 {
AnnaBridge 156:ff21514d8981 119 // Thread safe / atomic HAL call
AnnaBridge 156:ff21514d8981 120 return gpio_is_connected(&gpio);
AnnaBridge 156:ff21514d8981 121 }
AnnaBridge 156:ff21514d8981 122
AnnaBridge 156:ff21514d8981 123 /** A shorthand for write()
AnnaBridge 156:ff21514d8981 124 * \sa DigitalInOut::write()
AnnaBridge 171:3a7713b1edbc 125 * @code
AnnaBridge 171:3a7713b1edbc 126 * DigitalInOut inout(PIN);
AnnaBridge 171:3a7713b1edbc 127 * DigitalIn button(BUTTON1);
AnnaBridge 171:3a7713b1edbc 128 * inout.output();
AnnaBridge 171:3a7713b1edbc 129 *
AnnaBridge 171:3a7713b1edbc 130 * inout = button; // Equivalent to inout.write(button.read())
AnnaBridge 171:3a7713b1edbc 131 * @endcode
AnnaBridge 156:ff21514d8981 132 */
AnnaBridge 170:e95d10626187 133 DigitalInOut &operator= (int value)
AnnaBridge 170:e95d10626187 134 {
AnnaBridge 156:ff21514d8981 135 // Underlying write is thread safe
AnnaBridge 156:ff21514d8981 136 write(value);
AnnaBridge 156:ff21514d8981 137 return *this;
AnnaBridge 156:ff21514d8981 138 }
AnnaBridge 156:ff21514d8981 139
AnnaBridge 171:3a7713b1edbc 140 /**A shorthand for write() using the assignment operator which copies the
AnnaBridge 171:3a7713b1edbc 141 * state from the DigitalInOut argument.
AnnaBridge 156:ff21514d8981 142 * \sa DigitalInOut::write()
AnnaBridge 156:ff21514d8981 143 */
AnnaBridge 170:e95d10626187 144 DigitalInOut &operator= (DigitalInOut &rhs)
AnnaBridge 170:e95d10626187 145 {
AnnaBridge 156:ff21514d8981 146 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 147 write(rhs.read());
AnnaBridge 156:ff21514d8981 148 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 149 return *this;
AnnaBridge 156:ff21514d8981 150 }
AnnaBridge 156:ff21514d8981 151
AnnaBridge 156:ff21514d8981 152 /** A shorthand for read()
AnnaBridge 156:ff21514d8981 153 * \sa DigitalInOut::read()
AnnaBridge 171:3a7713b1edbc 154 * @code
AnnaBridge 171:3a7713b1edbc 155 * DigitalInOut inout(PIN);
AnnaBridge 171:3a7713b1edbc 156 * DigitalOut led(LED1);
AnnaBridge 171:3a7713b1edbc 157 *
AnnaBridge 171:3a7713b1edbc 158 * inout.input();
AnnaBridge 171:3a7713b1edbc 159 * led = inout; // Equivalent to led.write(inout.read())
AnnaBridge 171:3a7713b1edbc 160 * @endcode
AnnaBridge 156:ff21514d8981 161 */
AnnaBridge 170:e95d10626187 162 operator int()
AnnaBridge 170:e95d10626187 163 {
AnnaBridge 156:ff21514d8981 164 // Underlying call is thread safe
AnnaBridge 156:ff21514d8981 165 return read();
AnnaBridge 156:ff21514d8981 166 }
AnnaBridge 156:ff21514d8981 167
AnnaBridge 156:ff21514d8981 168 protected:
AnnaBridge 172:65be27845400 169 #if !defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 170 gpio_t gpio;
AnnaBridge 172:65be27845400 171 #endif //!defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 172 };
AnnaBridge 156:ff21514d8981 173
AnnaBridge 156:ff21514d8981 174 } // namespace mbed
AnnaBridge 156:ff21514d8981 175
AnnaBridge 156:ff21514d8981 176 #endif