Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

drivers/DigitalOut.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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