no-OS
Classes | Macros | Typedefs | Enumerations | Functions
gpio.h File Reference

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:

Go to the source code of 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_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)

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:

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

Enumeration Type Documentation

◆ 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: