EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/gpio_api.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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