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@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
156:ff21514d8981
Child:
170:e95d10626187
mbed library. Release version 162

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