mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/DigitalOut.h@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
156:ff21514d8981
Child:
170:e95d10626187
mbed library. Release version 158

Who changed what in which revision?

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