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/DigitalIn.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_DIGITALIN_H
dgabino 0:c76361bd82e8 17 #define MBED_DIGITALIN_H
dgabino 0:c76361bd82e8 18
dgabino 0:c76361bd82e8 19 #include "platform.h"
dgabino 0:c76361bd82e8 20
dgabino 0:c76361bd82e8 21 #include "gpio_api.h"
dgabino 0:c76361bd82e8 22 #include "critical.h"
dgabino 0:c76361bd82e8 23
dgabino 0:c76361bd82e8 24 namespace mbed {
dgabino 0:c76361bd82e8 25
dgabino 0:c76361bd82e8 26 /** A digital input, used for reading the state of a pin
dgabino 0:c76361bd82e8 27 *
dgabino 0:c76361bd82e8 28 * @Note Synchronization level: Interrupt safe
dgabino 0:c76361bd82e8 29 *
dgabino 0:c76361bd82e8 30 * Example:
dgabino 0:c76361bd82e8 31 * @code
dgabino 0:c76361bd82e8 32 * // Flash an LED while a DigitalIn is true
dgabino 0:c76361bd82e8 33 *
dgabino 0:c76361bd82e8 34 * #include "mbed.h"
dgabino 0:c76361bd82e8 35 *
dgabino 0:c76361bd82e8 36 * DigitalIn enable(p5);
dgabino 0:c76361bd82e8 37 * DigitalOut led(LED1);
dgabino 0:c76361bd82e8 38 *
dgabino 0:c76361bd82e8 39 * int main() {
dgabino 0:c76361bd82e8 40 * while(1) {
dgabino 0:c76361bd82e8 41 * if(enable) {
dgabino 0:c76361bd82e8 42 * led = !led;
dgabino 0:c76361bd82e8 43 * }
dgabino 0:c76361bd82e8 44 * wait(0.25);
dgabino 0:c76361bd82e8 45 * }
dgabino 0:c76361bd82e8 46 * }
dgabino 0:c76361bd82e8 47 * @endcode
dgabino 0:c76361bd82e8 48 */
dgabino 0:c76361bd82e8 49 class DigitalIn {
dgabino 0:c76361bd82e8 50
dgabino 0:c76361bd82e8 51 public:
dgabino 0:c76361bd82e8 52 /** Create a DigitalIn connected to the specified pin
dgabino 0:c76361bd82e8 53 *
dgabino 0:c76361bd82e8 54 * @param pin DigitalIn pin to connect to
dgabino 0:c76361bd82e8 55 */
dgabino 0:c76361bd82e8 56 DigitalIn(PinName pin) : gpio() {
dgabino 0:c76361bd82e8 57 // No lock needed in the constructor
dgabino 0:c76361bd82e8 58 gpio_init_in(&gpio, pin);
dgabino 0:c76361bd82e8 59 }
dgabino 0:c76361bd82e8 60
dgabino 0:c76361bd82e8 61 /** Create a DigitalIn connected to the specified pin
dgabino 0:c76361bd82e8 62 *
dgabino 0:c76361bd82e8 63 * @param pin DigitalIn pin to connect to
dgabino 0:c76361bd82e8 64 * @param mode the initial mode of the pin
dgabino 0:c76361bd82e8 65 */
dgabino 0:c76361bd82e8 66 DigitalIn(PinName pin, PinMode mode) : gpio() {
dgabino 0:c76361bd82e8 67 // No lock needed in the constructor
dgabino 0:c76361bd82e8 68 gpio_init_in_ex(&gpio, pin, mode);
dgabino 0:c76361bd82e8 69 }
dgabino 0:c76361bd82e8 70 /** Read the input, represented as 0 or 1 (int)
dgabino 0:c76361bd82e8 71 *
dgabino 0:c76361bd82e8 72 * @returns
dgabino 0:c76361bd82e8 73 * An integer representing the state of the input pin,
dgabino 0:c76361bd82e8 74 * 0 for logical 0, 1 for logical 1
dgabino 0:c76361bd82e8 75 */
dgabino 0:c76361bd82e8 76 int read() {
dgabino 0:c76361bd82e8 77 // Thread safe / atomic HAL call
dgabino 0:c76361bd82e8 78 return gpio_read(&gpio);
dgabino 0:c76361bd82e8 79 }
dgabino 0:c76361bd82e8 80
dgabino 0:c76361bd82e8 81 /** Set the input pin mode
dgabino 0:c76361bd82e8 82 *
dgabino 0:c76361bd82e8 83 * @param mode PullUp, PullDown, PullNone, OpenDrain
dgabino 0:c76361bd82e8 84 */
dgabino 0:c76361bd82e8 85 void mode(PinMode pull) {
dgabino 0:c76361bd82e8 86 core_util_critical_section_enter();
dgabino 0:c76361bd82e8 87 gpio_mode(&gpio, pull);
dgabino 0:c76361bd82e8 88 core_util_critical_section_exit();
dgabino 0:c76361bd82e8 89 }
dgabino 0:c76361bd82e8 90
dgabino 0:c76361bd82e8 91 /** Return the output setting, represented as 0 or 1 (int)
dgabino 0:c76361bd82e8 92 *
dgabino 0:c76361bd82e8 93 * @returns
dgabino 0:c76361bd82e8 94 * Non zero value if pin is connected to uc GPIO
dgabino 0:c76361bd82e8 95 * 0 if gpio object was initialized with NC
dgabino 0:c76361bd82e8 96 */
dgabino 0:c76361bd82e8 97 int is_connected() {
dgabino 0:c76361bd82e8 98 // Thread safe / atomic HAL call
dgabino 0:c76361bd82e8 99 return gpio_is_connected(&gpio);
dgabino 0:c76361bd82e8 100 }
dgabino 0:c76361bd82e8 101
dgabino 0:c76361bd82e8 102 /** An operator shorthand for read()
dgabino 0:c76361bd82e8 103 */
dgabino 0:c76361bd82e8 104 operator int() {
dgabino 0:c76361bd82e8 105 // Underlying read is thread safe
dgabino 0:c76361bd82e8 106 return read();
dgabino 0:c76361bd82e8 107 }
dgabino 0:c76361bd82e8 108
dgabino 0:c76361bd82e8 109 protected:
dgabino 0:c76361bd82e8 110 gpio_t gpio;
dgabino 0:c76361bd82e8 111 };
dgabino 0:c76361bd82e8 112
dgabino 0:c76361bd82e8 113 } // namespace mbed
dgabino 0:c76361bd82e8 114
dgabino 0:c76361bd82e8 115 #endif