mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/DigitalOut.h@188:bcfe06ba3d64, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:46:34 2018 +0000
Revision:
188:bcfe06ba3d64
Parent:
187:0387e8f68319
Child:
189:f392fc9709a3
mbed-dev library. Release version 164

Who changed what in which revision?

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