Enda Kilgarriff / platform_drivers

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

gpio.h File Reference
Data Structures | Functions

gpio.h File Reference

Header file of GPIO Interface. More...

Go to the source code of this file.

Data Structures

struct  gpio_init_param
 Structure holding the parameters for GPIO initialization. More...
struct  gpio_desc
 Structure holding the GPIO descriptor. More...

Functions

int32_t gpio_get (struct gpio_desc **desc, const struct gpio_init_param *param)
 Obtain the GPIO decriptor.
int32_t gpio_get_optional (struct gpio_desc **desc, const struct gpio_init_param *param)
 Get the value of an optional GPIO.
int32_t gpio_remove (struct gpio_desc *desc)
 Free the resources allocated by gpio_get().
int32_t gpio_direction_input (struct gpio_desc *desc)
 Enable the input direction of the specified GPIO.
int32_t gpio_direction_output (struct gpio_desc *desc, uint8_t value)
 Enable the output direction of the specified GPIO.
int32_t gpio_get_direction (struct gpio_desc *desc, uint8_t *direction)
 Get the direction of the specified GPIO.
int32_t gpio_set_value (struct gpio_desc *desc, uint8_t value)
 Set the value of the specified GPIO.
int32_t gpio_get_value (struct gpio_desc *desc, uint8_t *value)
 Get the value of the specified GPIO.

Detailed Description

Header file of GPIO Interface.

Author:
DBogdan (dragos.bogdan@analog.com)

Copyright 2019(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
  • The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
  • Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file gpio.h.

Function Documentation

int32_t gpio_direction_input ( struct gpio_desc *  desc )

Enable the input direction of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
Returns:
SUCCESS in case of success, FAILURE otherwise.
Note:
does not support reconfiguration of already set pin direction

Definition at line 118 of file gpio.cpp.

int32_t gpio_direction_output ( struct gpio_desc *  desc,
uint8_t  value 
)

Enable the output direction of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
value- The value. Example: GPIO_HIGH GPIO_LOW
Returns:
SUCCESS in case of success, FAILURE otherwise.
Note:
does not support reconfiguration of already set pin direction

Definition at line 155 of file gpio.cpp.

int32_t gpio_get ( struct gpio_desc **  desc,
const struct gpio_init_param *  param 
)

Obtain the GPIO decriptor.

Parameters:
desc- The GPIO descriptor.
gpio_number- The number of the GPIO.
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 34 of file gpio.cpp.

int32_t gpio_get_direction ( struct gpio_desc *  desc,
uint8_t *  direction 
)

Get the direction of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
direction- The direction. Example: GPIO_OUT GPIO_IN
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 193 of file gpio.cpp.

int32_t gpio_get_optional ( struct gpio_desc **  desc,
const struct gpio_init_param *  param 
)

Get the value of an optional GPIO.

Parameters:
desc- The GPIO descriptor.
param- GPIO Initialization parameters.
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 72 of file gpio.cpp.

int32_t gpio_get_value ( struct gpio_desc *  desc,
uint8_t *  value 
)

Get the value of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
value- The value. Example: GPIO_HIGH GPIO_LOW
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 247 of file gpio.cpp.

int32_t gpio_remove ( struct gpio_desc *  desc )

Free the resources allocated by gpio_get().

Parameters:
desc- The GPIO descriptor.
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 89 of file gpio.cpp.

int32_t gpio_set_value ( struct gpio_desc *  desc,
uint8_t  value 
)

Set the value of the specified GPIO.

Parameters:
desc- The GPIO descriptor.
value- The value. Example: GPIO_HIGH GPIO_LOW
Returns:
SUCCESS in case of success, FAILURE otherwise.

Definition at line 219 of file gpio.cpp.

Generated on Tue Jul 12 2022 17:15:46 by  doxygen 1.7.2