Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

drivers/DigitalInOut.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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