Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/DigitalInOut.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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