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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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