Gan likun / The prosthetic control

The prosthetic control（MIT）

drivers/DigitalOut.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

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