mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/gpio_api.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

Who changed what in which revision?

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