Aditya Mehrotra / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

drivers/DigitalInOut.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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