Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/DigitalInOut.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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