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