Header file of GPIO Interface. More...

#include <stdint.h>

Include dependency graph for gpio.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	gpio_init_param
	Structure holding the parameters for GPIO initialization. More...

struct	gpio_desc
	Structure holding the GPIO descriptor. More...

struct	gpio_platform_ops
	Structure holding gpio function pointers that point to the platform specific function. More...

Macros
#define	GPIO_OUT 0x01

#define	GPIO_IN 0x00

Typedefs
typedef struct gpio_init_param	gpio_init_param

typedef struct gpio_desc	gpio_desc

Enumerations
enum	gpio_pull_up { NO_OS_PULL_NONE, NO_OS_PULL_UP, NO_OS_PULL_DOWN, NO_OS_PULL_UP_WEAK, NO_OS_PULL_DOWN_WEAK }
	Enum that holds the possible pull up/ pull down resistor configuration. More...

enum	gpio_values { GPIO_LOW, GPIO_HIGH, GPIO_HIGH_Z }
	Enum that holds the possible output states of a GPIO. More...

Functions
int32_t	gpio_get (struct gpio_desc *desc, const struct gpio_init_param param)
	Obtain the GPIO decriptor. More...

int32_t	gpio_get_optional (struct gpio_desc *desc, const struct gpio_init_param param)
	Get the value of an optional GPIO. More...

int32_t	gpio_remove (struct gpio_desc *desc)
	Free the resources allocated by gpio_get(). More...

int32_t	gpio_direction_input (struct gpio_desc *desc)
	Enable the input direction of the specified GPIO. More...

int32_t	gpio_direction_output (struct gpio_desc *desc, uint8_t value)
	Enable the output direction of the specified GPIO. More...

int32_t	gpio_get_direction (struct gpio_desc desc, uint8_t direction)
	Get the direction of the specified GPIO. More...

int32_t	gpio_set_value (struct gpio_desc *desc, uint8_t value)
	Set the value of the specified GPIO. More...

int32_t	gpio_get_value (struct gpio_desc desc, uint8_t value)
	Get the value of the specified GPIO. More...

Detailed Description

Header file of GPIO Interface.

Author: DBogdan (drago.nosp@m.s.bo.nosp@m.gdan@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

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.

Macro Definition Documentation

◆ GPIO_IN

#define GPIO_IN 0x00

◆ GPIO_OUT

#define GPIO_OUT 0x01

Typedef Documentation

◆ gpio_desc

typedef struct gpio_desc gpio_desc

◆ gpio_init_param

typedef struct gpio_init_param gpio_init_param

Enumeration Type Documentation

◆ gpio_pull_up

enum gpio_pull_up

Enum that holds the possible pull up/ pull down resistor configuration.

Enumerator
NO_OS_PULL_NONE
NO_OS_PULL_UP	Strong pull up
NO_OS_PULL_DOWN	Strong pull down
NO_OS_PULL_UP_WEAK
NO_OS_PULL_DOWN_WEAK

◆ gpio_values

enum gpio_values

Enum that holds the possible output states of a GPIO.

Enumerator
GPIO_LOW	GPIO logic low
GPIO_HIGH	GPIO logic high
GPIO_HIGH_Z	GPIO high impedance

Function Documentation

◆ gpio_direction_input()

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.

Here is the caller graph for this function:

◆ gpio_direction_output()

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.

Here is the caller graph for this function:

◆ gpio_get()

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

Obtain the GPIO decriptor.

Parameters

desc	- The GPIO descriptor.
param	- GPIO Initialization parameters.

Returns: SUCCESS in case of success, FAILURE otherwise.

Here is the caller graph for this function:

◆ gpio_get_direction()

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.

◆ gpio_get_optional()

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.

Here is the caller graph for this function:

◆ gpio_get_value()

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.

Here is the caller graph for this function:

◆ gpio_remove()

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.

Here is the caller graph for this function:

◆ gpio_set_value()

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.

Here is the caller graph for this function:

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ GPIO_IN

◆ GPIO_OUT

Typedef Documentation

◆ gpio_desc

◆ gpio_init_param

Enumeration Type Documentation

◆ gpio_pull_up

◆ gpio_values

Function Documentation

◆ gpio_direction_input()

◆ gpio_direction_output()

◆ gpio_get()

◆ gpio_get_direction()

◆ gpio_get_optional()

◆ gpio_get_value()

◆ gpio_remove()

◆ gpio_set_value()