Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

init

Dependencies:   mbed

mbed-os/drivers/DigitalInOut.h@10:46a4cf51ee38, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:16:49 2018 -0700
Revision:
10:46a4cf51ee38
Parent:
9:d58e77ebd769 
remove mbed-os

Who changed what in which revision?

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