mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

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

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

Who changed what in which revision?

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