Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/drivers/DigitalOut.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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