Gan likun / mbed-dev11

1232

drivers/DigitalOut.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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