Kev Mann / mbed-dev-OS5_10_4

RTC auf true

drivers/DigitalOut.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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