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@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
188:bcfe06ba3d64 
mbed library release version 165

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