Nicolas Borla / Mbed OS ROME2_Robot_Firmware

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.

mbed-os/drivers/DigitalOut.h@3:6fe17b8a6d62, 2021-03-09 (annotated)

Committer:
boro
Date:
Tue Mar 09 13:10:40 2021 +0000
Revision:
3:6fe17b8a6d62
Parent:
0:4beb2ea291ec 
SDBlockDevice added

Who changed what in which revision?

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