Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/gpio_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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