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@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
145:64910690c574 
Release 147 of the mbed library.

Who changed what in which revision?

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