mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/gpio_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
187:0387e8f68319 
mbed library release version 165

Who changed what in which revision?

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