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@170:e95d10626187, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:39:34 2018 +0100
Revision:
170:e95d10626187
Parent:
156:ff21514d8981
Child:
171:3a7713b1edbc
mbed library. Release version 163

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 170:e95d10626187 53 DigitalOut(PinName pin) : gpio()
AnnaBridge 170:e95d10626187 54 {
AnnaBridge 156:ff21514d8981 55 // No lock needed in the constructor
AnnaBridge 156:ff21514d8981 56 gpio_init_out(&gpio, pin);
AnnaBridge 156:ff21514d8981 57 }
AnnaBridge 156:ff21514d8981 58
AnnaBridge 156:ff21514d8981 59 /** Create a DigitalOut connected to the specified pin
AnnaBridge 156:ff21514d8981 60 *
AnnaBridge 156:ff21514d8981 61 * @param pin DigitalOut pin to connect to
AnnaBridge 156:ff21514d8981 62 * @param value the initial pin value
AnnaBridge 156:ff21514d8981 63 */
AnnaBridge 170:e95d10626187 64 DigitalOut(PinName pin, int value) : gpio()
AnnaBridge 170:e95d10626187 65 {
AnnaBridge 156:ff21514d8981 66 // No lock needed in the constructor
AnnaBridge 156:ff21514d8981 67 gpio_init_out_ex(&gpio, pin, value);
AnnaBridge 156:ff21514d8981 68 }
AnnaBridge 156:ff21514d8981 69
AnnaBridge 156:ff21514d8981 70 /** Set the output, specified as 0 or 1 (int)
AnnaBridge 156:ff21514d8981 71 *
AnnaBridge 156:ff21514d8981 72 * @param value An integer specifying the pin output value,
AnnaBridge 156:ff21514d8981 73 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
AnnaBridge 156:ff21514d8981 74 */
AnnaBridge 170:e95d10626187 75 void write(int value)
AnnaBridge 170:e95d10626187 76 {
AnnaBridge 156:ff21514d8981 77 // Thread safe / atomic HAL call
AnnaBridge 156:ff21514d8981 78 gpio_write(&gpio, value);
AnnaBridge 156:ff21514d8981 79 }
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 /** Return the output setting, represented as 0 or 1 (int)
AnnaBridge 156:ff21514d8981 82 *
AnnaBridge 156:ff21514d8981 83 * @returns
AnnaBridge 156:ff21514d8981 84 * an integer representing the output setting of the pin,
AnnaBridge 156:ff21514d8981 85 * 0 for logical 0, 1 for logical 1
AnnaBridge 156:ff21514d8981 86 */
AnnaBridge 170:e95d10626187 87 int read()
AnnaBridge 170:e95d10626187 88 {
AnnaBridge 156:ff21514d8981 89 // Thread safe / atomic HAL call
AnnaBridge 156:ff21514d8981 90 return gpio_read(&gpio);
AnnaBridge 156:ff21514d8981 91 }
AnnaBridge 156:ff21514d8981 92
AnnaBridge 156:ff21514d8981 93 /** Return the output setting, represented as 0 or 1 (int)
AnnaBridge 156:ff21514d8981 94 *
AnnaBridge 156:ff21514d8981 95 * @returns
AnnaBridge 156:ff21514d8981 96 * Non zero value if pin is connected to uc GPIO
AnnaBridge 156:ff21514d8981 97 * 0 if gpio object was initialized with NC
AnnaBridge 156:ff21514d8981 98 */
AnnaBridge 170:e95d10626187 99 int is_connected()
AnnaBridge 170:e95d10626187 100 {
AnnaBridge 156:ff21514d8981 101 // Thread safe / atomic HAL call
AnnaBridge 156:ff21514d8981 102 return gpio_is_connected(&gpio);
AnnaBridge 156:ff21514d8981 103 }
AnnaBridge 156:ff21514d8981 104
AnnaBridge 156:ff21514d8981 105 /** A shorthand for write()
AnnaBridge 156:ff21514d8981 106 * \sa DigitalOut::write()
AnnaBridge 156:ff21514d8981 107 */
AnnaBridge 170:e95d10626187 108 DigitalOut &operator= (int value)
AnnaBridge 170:e95d10626187 109 {
AnnaBridge 156:ff21514d8981 110 // Underlying write is thread safe
AnnaBridge 156:ff21514d8981 111 write(value);
AnnaBridge 156:ff21514d8981 112 return *this;
AnnaBridge 156:ff21514d8981 113 }
AnnaBridge 156:ff21514d8981 114
AnnaBridge 156:ff21514d8981 115 /** A shorthand for write()
AnnaBridge 156:ff21514d8981 116 * \sa DigitalOut::write()
AnnaBridge 156:ff21514d8981 117 */
AnnaBridge 170:e95d10626187 118 DigitalOut &operator= (DigitalOut &rhs)
AnnaBridge 170:e95d10626187 119 {
AnnaBridge 156:ff21514d8981 120 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 121 write(rhs.read());
AnnaBridge 156:ff21514d8981 122 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 123 return *this;
AnnaBridge 156:ff21514d8981 124 }
AnnaBridge 156:ff21514d8981 125
AnnaBridge 156:ff21514d8981 126 /** A shorthand for read()
AnnaBridge 156:ff21514d8981 127 * \sa DigitalOut::read()
AnnaBridge 156:ff21514d8981 128 */
AnnaBridge 170:e95d10626187 129 operator int()
AnnaBridge 170:e95d10626187 130 {
AnnaBridge 156:ff21514d8981 131 // Underlying call is thread safe
AnnaBridge 156:ff21514d8981 132 return read();
AnnaBridge 156:ff21514d8981 133 }
AnnaBridge 156:ff21514d8981 134
AnnaBridge 156:ff21514d8981 135 protected:
AnnaBridge 156:ff21514d8981 136 gpio_t gpio;
AnnaBridge 156:ff21514d8981 137 };
AnnaBridge 156:ff21514d8981 138
AnnaBridge 156:ff21514d8981 139 } // namespace mbed
AnnaBridge 156:ff21514d8981 140
AnnaBridge 156:ff21514d8981 141 #endif