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.cpp File Reference
Functions

gpio.cpp File Reference

Implementation of GPIO No-OS platform driver interfaces. More...

Go to the source code of this file.

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

Implementation of GPIO No-OS platform driver interfaces.

Copyright (c) 2019, 2020 Analog Devices, Inc.

All rights reserved.

This software is proprietary to Analog Devices, Inc. and its licensors. By using this software you agree to the terms of the associated Analog Devices Software License Agreement.

Definition in file gpio.cpp.

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