mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/drivers/DigitalInOut.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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