Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/DigitalOut.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_DIGITALOUT_H
valeyev 0:e056ac8fecf8 17 #define MBED_DIGITALOUT_H
valeyev 0:e056ac8fecf8 18
valeyev 0:e056ac8fecf8 19 #include "platform/platform.h"
valeyev 0:e056ac8fecf8 20 #include "hal/gpio_api.h"
valeyev 0:e056ac8fecf8 21 #include "platform/mbed_critical.h"
valeyev 0:e056ac8fecf8 22
valeyev 0:e056ac8fecf8 23 namespace mbed {
valeyev 0:e056ac8fecf8 24 /** \addtogroup drivers */
valeyev 0:e056ac8fecf8 25
valeyev 0:e056ac8fecf8 26 /** A digital output, used for setting the state of a pin
valeyev 0:e056ac8fecf8 27 *
valeyev 0:e056ac8fecf8 28 * @note Synchronization level: Interrupt safe
valeyev 0:e056ac8fecf8 29 *
valeyev 0:e056ac8fecf8 30 * Example:
valeyev 0:e056ac8fecf8 31 * @code
valeyev 0:e056ac8fecf8 32 * // Toggle a LED
valeyev 0:e056ac8fecf8 33 * #include "mbed.h"
valeyev 0:e056ac8fecf8 34 *
valeyev 0:e056ac8fecf8 35 * DigitalOut led(LED1);
valeyev 0:e056ac8fecf8 36 *
valeyev 0:e056ac8fecf8 37 * int main() {
valeyev 0:e056ac8fecf8 38 * while(1) {
valeyev 0:e056ac8fecf8 39 * led = !led;
valeyev 0:e056ac8fecf8 40 * wait(0.2);
valeyev 0:e056ac8fecf8 41 * }
valeyev 0:e056ac8fecf8 42 * }
valeyev 0:e056ac8fecf8 43 * @endcode
valeyev 0:e056ac8fecf8 44 * @ingroup drivers
valeyev 0:e056ac8fecf8 45 */
valeyev 0:e056ac8fecf8 46 class DigitalOut {
valeyev 0:e056ac8fecf8 47
valeyev 0:e056ac8fecf8 48 public:
valeyev 0:e056ac8fecf8 49 /** Create a DigitalOut connected to the specified pin
valeyev 0:e056ac8fecf8 50 *
valeyev 0:e056ac8fecf8 51 * @param pin DigitalOut pin to connect to
valeyev 0:e056ac8fecf8 52 */
valeyev 0:e056ac8fecf8 53 DigitalOut(PinName pin) : gpio() {
valeyev 0:e056ac8fecf8 54 // No lock needed in the constructor
valeyev 0:e056ac8fecf8 55 gpio_init_out(&gpio, pin);
valeyev 0:e056ac8fecf8 56 }
valeyev 0:e056ac8fecf8 57
valeyev 0:e056ac8fecf8 58 /** Create a DigitalOut connected to the specified pin
valeyev 0:e056ac8fecf8 59 *
valeyev 0:e056ac8fecf8 60 * @param pin DigitalOut pin to connect to
valeyev 0:e056ac8fecf8 61 * @param value the initial pin value
valeyev 0:e056ac8fecf8 62 */
valeyev 0:e056ac8fecf8 63 DigitalOut(PinName pin, int value) : gpio() {
valeyev 0:e056ac8fecf8 64 // No lock needed in the constructor
valeyev 0:e056ac8fecf8 65 gpio_init_out_ex(&gpio, pin, value);
valeyev 0:e056ac8fecf8 66 }
valeyev 0:e056ac8fecf8 67
valeyev 0:e056ac8fecf8 68 /** Set the output, specified as 0 or 1 (int)
valeyev 0:e056ac8fecf8 69 *
valeyev 0:e056ac8fecf8 70 * @param value An integer specifying the pin output value,
valeyev 0:e056ac8fecf8 71 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
valeyev 0:e056ac8fecf8 72 */
valeyev 0:e056ac8fecf8 73 void write(int value) {
valeyev 0:e056ac8fecf8 74 // Thread safe / atomic HAL call
valeyev 0:e056ac8fecf8 75 gpio_write(&gpio, value);
valeyev 0:e056ac8fecf8 76 }
valeyev 0:e056ac8fecf8 77
valeyev 0:e056ac8fecf8 78 /** Return the output setting, represented as 0 or 1 (int)
valeyev 0:e056ac8fecf8 79 *
valeyev 0:e056ac8fecf8 80 * @returns
valeyev 0:e056ac8fecf8 81 * an integer representing the output setting of the pin,
valeyev 0:e056ac8fecf8 82 * 0 for logical 0, 1 for logical 1
valeyev 0:e056ac8fecf8 83 */
valeyev 0:e056ac8fecf8 84 int read() {
valeyev 0:e056ac8fecf8 85 // Thread safe / atomic HAL call
valeyev 0:e056ac8fecf8 86 return gpio_read(&gpio);
valeyev 0:e056ac8fecf8 87 }
valeyev 0:e056ac8fecf8 88
valeyev 0:e056ac8fecf8 89 /** Return the output setting, represented as 0 or 1 (int)
valeyev 0:e056ac8fecf8 90 *
valeyev 0:e056ac8fecf8 91 * @returns
valeyev 0:e056ac8fecf8 92 * Non zero value if pin is connected to uc GPIO
valeyev 0:e056ac8fecf8 93 * 0 if gpio object was initialized with NC
valeyev 0:e056ac8fecf8 94 */
valeyev 0:e056ac8fecf8 95 int is_connected() {
valeyev 0:e056ac8fecf8 96 // Thread safe / atomic HAL call
valeyev 0:e056ac8fecf8 97 return gpio_is_connected(&gpio);
valeyev 0:e056ac8fecf8 98 }
valeyev 0:e056ac8fecf8 99
valeyev 0:e056ac8fecf8 100 /** A shorthand for write()
valeyev 0:e056ac8fecf8 101 * \sa DigitalOut::write()
valeyev 0:e056ac8fecf8 102 */
valeyev 0:e056ac8fecf8 103 DigitalOut& operator= (int value) {
valeyev 0:e056ac8fecf8 104 // Underlying write is thread safe
valeyev 0:e056ac8fecf8 105 write(value);
valeyev 0:e056ac8fecf8 106 return *this;
valeyev 0:e056ac8fecf8 107 }
valeyev 0:e056ac8fecf8 108
valeyev 0:e056ac8fecf8 109 /** A shorthand for write()
valeyev 0:e056ac8fecf8 110 * \sa DigitalOut::write()
valeyev 0:e056ac8fecf8 111 */
valeyev 0:e056ac8fecf8 112 DigitalOut& operator= (DigitalOut& rhs) {
valeyev 0:e056ac8fecf8 113 core_util_critical_section_enter();
valeyev 0:e056ac8fecf8 114 write(rhs.read());
valeyev 0:e056ac8fecf8 115 core_util_critical_section_exit();
valeyev 0:e056ac8fecf8 116 return *this;
valeyev 0:e056ac8fecf8 117 }
valeyev 0:e056ac8fecf8 118
valeyev 0:e056ac8fecf8 119 /** A shorthand for read()
valeyev 0:e056ac8fecf8 120 * \sa DigitalOut::read()
valeyev 0:e056ac8fecf8 121 */
valeyev 0:e056ac8fecf8 122 operator int() {
valeyev 0:e056ac8fecf8 123 // Underlying call is thread safe
valeyev 0:e056ac8fecf8 124 return read();
valeyev 0:e056ac8fecf8 125 }
valeyev 0:e056ac8fecf8 126
valeyev 0:e056ac8fecf8 127 protected:
valeyev 0:e056ac8fecf8 128 gpio_t gpio;
valeyev 0:e056ac8fecf8 129 };
valeyev 0:e056ac8fecf8 130
valeyev 0:e056ac8fecf8 131 } // namespace mbed
valeyev 0:e056ac8fecf8 132
valeyev 0:e056ac8fecf8 133 #endif