EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

drivers/DigitalOut.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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