Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/DigitalOut.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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