Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

hal/gpio_api.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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