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/hal/gpio_api.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
vipinranka 12:9a20164dcc47 2 /** \addtogroup hal */
vipinranka 12:9a20164dcc47 3 /** @{*/
vipinranka 12:9a20164dcc47 4 /* mbed Microcontroller Library
vipinranka 12:9a20164dcc47 5 * Copyright (c) 2006-2013 ARM Limited
vipinranka 12:9a20164dcc47 6 *
vipinranka 12:9a20164dcc47 7 * Licensed under the Apache License, Version 2.0 (the "License");
vipinranka 12:9a20164dcc47 8 * you may not use this file except in compliance with the License.
vipinranka 12:9a20164dcc47 9 * You may obtain a copy of the License at
vipinranka 12:9a20164dcc47 10 *
vipinranka 12:9a20164dcc47 11 * http://www.apache.org/licenses/LICENSE-2.0
vipinranka 12:9a20164dcc47 12 *
vipinranka 12:9a20164dcc47 13 * Unless required by applicable law or agreed to in writing, software
vipinranka 12:9a20164dcc47 14 * distributed under the License is distributed on an "AS IS" BASIS,
vipinranka 12:9a20164dcc47 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vipinranka 12:9a20164dcc47 16 * See the License for the specific language governing permissions and
vipinranka 12:9a20164dcc47 17 * limitations under the License.
vipinranka 12:9a20164dcc47 18 */
vipinranka 12:9a20164dcc47 19 #ifndef MBED_GPIO_API_H
vipinranka 12:9a20164dcc47 20 #define MBED_GPIO_API_H
vipinranka 12:9a20164dcc47 21
vipinranka 12:9a20164dcc47 22 #include <stdint.h>
vipinranka 12:9a20164dcc47 23 #include "device.h"
vipinranka 12:9a20164dcc47 24
vipinranka 12:9a20164dcc47 25 #ifdef __cplusplus
vipinranka 12:9a20164dcc47 26 extern "C" {
vipinranka 12:9a20164dcc47 27 #endif
vipinranka 12:9a20164dcc47 28
vipinranka 12:9a20164dcc47 29 /**
vipinranka 12:9a20164dcc47 30 * \defgroup hal_gpio GPIO HAL functions
vipinranka 12:9a20164dcc47 31 * @{
vipinranka 12:9a20164dcc47 32 */
vipinranka 12:9a20164dcc47 33
vipinranka 12:9a20164dcc47 34 /** Set the given pin as GPIO
vipinranka 12:9a20164dcc47 35 *
vipinranka 12:9a20164dcc47 36 * @param pin The pin to be set as GPIO
vipinranka 12:9a20164dcc47 37 * @return The GPIO port mask for this pin
vipinranka 12:9a20164dcc47 38 **/
vipinranka 12:9a20164dcc47 39 uint32_t gpio_set(PinName pin);
vipinranka 12:9a20164dcc47 40 /* Checks if gpio object is connected (pin was not initialized with NC)
vipinranka 12:9a20164dcc47 41 * @param pin The pin to be set as GPIO
vipinranka 12:9a20164dcc47 42 * @return 0 if port is initialized with NC
vipinranka 12:9a20164dcc47 43 **/
vipinranka 12:9a20164dcc47 44 int gpio_is_connected(const gpio_t *obj);
vipinranka 12:9a20164dcc47 45
vipinranka 12:9a20164dcc47 46 /** Initialize the GPIO pin
vipinranka 12:9a20164dcc47 47 *
vipinranka 12:9a20164dcc47 48 * @param obj The GPIO object to initialize
vipinranka 12:9a20164dcc47 49 * @param pin The GPIO pin to initialize
vipinranka 12:9a20164dcc47 50 */
vipinranka 12:9a20164dcc47 51 void gpio_init(gpio_t *obj, PinName pin);
vipinranka 12:9a20164dcc47 52
vipinranka 12:9a20164dcc47 53 /** Set the input pin mode
vipinranka 12:9a20164dcc47 54 *
vipinranka 12:9a20164dcc47 55 * @param obj The GPIO object
vipinranka 12:9a20164dcc47 56 * @param mode The pin mode to be set
vipinranka 12:9a20164dcc47 57 */
vipinranka 12:9a20164dcc47 58 void gpio_mode(gpio_t *obj, PinMode mode);
vipinranka 12:9a20164dcc47 59
vipinranka 12:9a20164dcc47 60 /** Set the pin direction
vipinranka 12:9a20164dcc47 61 *
vipinranka 12:9a20164dcc47 62 * @param obj The GPIO object
vipinranka 12:9a20164dcc47 63 * @param direction The pin direction to be set
vipinranka 12:9a20164dcc47 64 */
vipinranka 12:9a20164dcc47 65 void gpio_dir(gpio_t *obj, PinDirection direction);
vipinranka 12:9a20164dcc47 66
vipinranka 12:9a20164dcc47 67 /** Set the output value
vipinranka 12:9a20164dcc47 68 *
vipinranka 12:9a20164dcc47 69 * @param obj The GPIO object
vipinranka 12:9a20164dcc47 70 * @param value The value to be set
vipinranka 12:9a20164dcc47 71 */
vipinranka 12:9a20164dcc47 72 void gpio_write(gpio_t *obj, int value);
vipinranka 12:9a20164dcc47 73
vipinranka 12:9a20164dcc47 74 /** Read the input value
vipinranka 12:9a20164dcc47 75 *
vipinranka 12:9a20164dcc47 76 * @param obj The GPIO object
vipinranka 12:9a20164dcc47 77 * @return An integer value 1 or 0
vipinranka 12:9a20164dcc47 78 */
vipinranka 12:9a20164dcc47 79 int gpio_read(gpio_t *obj);
vipinranka 12:9a20164dcc47 80
vipinranka 12:9a20164dcc47 81 // the following functions are generic and implemented in the common gpio.c file
vipinranka 12:9a20164dcc47 82 // TODO: fix, will be moved to the common gpio header file
vipinranka 12:9a20164dcc47 83
vipinranka 12:9a20164dcc47 84 /** Init the input pin and set mode to PullDefault
vipinranka 12:9a20164dcc47 85 *
vipinranka 12:9a20164dcc47 86 * @param obj The GPIO object
vipinranka 12:9a20164dcc47 87 * @param pin The pin name
vipinranka 12:9a20164dcc47 88 */
vipinranka 12:9a20164dcc47 89 void gpio_init_in(gpio_t* gpio, PinName pin);
vipinranka 12:9a20164dcc47 90
vipinranka 12:9a20164dcc47 91 /** Init the input pin and set the mode
vipinranka 12:9a20164dcc47 92 *
vipinranka 12:9a20164dcc47 93 * @param obj The GPIO object
vipinranka 12:9a20164dcc47 94 * @param pin The pin name
vipinranka 12:9a20164dcc47 95 * @param mode The pin mode to be set
vipinranka 12:9a20164dcc47 96 */
vipinranka 12:9a20164dcc47 97 void gpio_init_in_ex(gpio_t* gpio, PinName pin, PinMode mode);
vipinranka 12:9a20164dcc47 98
vipinranka 12:9a20164dcc47 99 /** Init the output pin as an output, with predefined output value 0
vipinranka 12:9a20164dcc47 100 *
vipinranka 12:9a20164dcc47 101 * @param obj The GPIO object
vipinranka 12:9a20164dcc47 102 * @param pin The pin name
vipinranka 12:9a20164dcc47 103 * @return An integer value 1 or 0
vipinranka 12:9a20164dcc47 104 */
vipinranka 12:9a20164dcc47 105 void gpio_init_out(gpio_t* gpio, PinName pin);
vipinranka 12:9a20164dcc47 106
vipinranka 12:9a20164dcc47 107 /** Init the pin as an output and set the output value
vipinranka 12:9a20164dcc47 108 *
vipinranka 12:9a20164dcc47 109 * @param obj The GPIO object
vipinranka 12:9a20164dcc47 110 * @param pin The pin name
vipinranka 12:9a20164dcc47 111 * @param value The value to be set
vipinranka 12:9a20164dcc47 112 */
vipinranka 12:9a20164dcc47 113 void gpio_init_out_ex(gpio_t* gpio, PinName pin, int value);
vipinranka 12:9a20164dcc47 114
vipinranka 12:9a20164dcc47 115 /** Init the pin to be in/out
vipinranka 12:9a20164dcc47 116 *
vipinranka 12:9a20164dcc47 117 * @param obj The GPIO object
vipinranka 12:9a20164dcc47 118 * @param pin The pin name
vipinranka 12:9a20164dcc47 119 * @param direction The pin direction to be set
vipinranka 12:9a20164dcc47 120 * @param mode The pin mode to be set
vipinranka 12:9a20164dcc47 121 * @param value The value to be set for an output pin
vipinranka 12:9a20164dcc47 122 */
vipinranka 12:9a20164dcc47 123 void gpio_init_inout(gpio_t* gpio, PinName pin, PinDirection direction, PinMode mode, int value);
vipinranka 12:9a20164dcc47 124
vipinranka 12:9a20164dcc47 125 /**@}*/
vipinranka 12:9a20164dcc47 126
vipinranka 12:9a20164dcc47 127 #ifdef __cplusplus
vipinranka 12:9a20164dcc47 128 }
vipinranka 12:9a20164dcc47 129 #endif
vipinranka 12:9a20164dcc47 130
vipinranka 12:9a20164dcc47 131 #endif
vipinranka 12:9a20164dcc47 132
vipinranka 12:9a20164dcc47 133 /** @}*/