libyggdrasil  v1.0.0
gpio.h File Reference

GPIO Pin abstraction implementation for Asgard. More...

#include <c/common/types.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_t
 GPIO handle type. More...
 

Macros

#define LOW_ACTIVE   true
 
#define HIGH_ACTIVE   false
 

Functions

bool yggdrasil_GPIO_Init (gpio_t gpio)
 GPIO initialization. More...
 
C_LINKAGE bool yggdrasil_GPIO_Deinit (gpio_t gpio)
 GPIO deinitialization. More...
 
C_LINKAGE bool yggdrasil_GPIO_MakeOutput (gpio_t gpio)
 Turn pin into an output. More...
 
C_LINKAGE bool yggdrasil_GPIO_MakeInput (gpio_t gpio)
 Turn pin into an input. More...
 
C_LINKAGE bool yggdrasil_GPIO_Get (gpio_t gpio)
 Get GPIO state. More...
 
C_LINKAGE void yggdrasil_GPIO_Set (gpio_t gpio, bool state)
 Set GPIO state. More...
 
C_LINKAGE void yggdrasil_GPIO_Toggle (gpio_t gpio)
 Toggle GPIO. More...
 

Detailed Description

GPIO Pin abstraction implementation for Asgard.

Author
Fabian Weber, Nikolaij Saegesser

Macro Definition Documentation

◆ HIGH_ACTIVE

#define HIGH_ACTIVE   false

◆ LOW_ACTIVE

#define LOW_ACTIVE   true

Function Documentation

◆ yggdrasil_GPIO_Deinit()

C_LINKAGE bool yggdrasil_GPIO_Deinit ( gpio_t  gpio)

GPIO deinitialization.

Parameters
gpioGPIO handle
Returns
Success

◆ yggdrasil_GPIO_Get()

C_LINKAGE bool yggdrasil_GPIO_Get ( gpio_t  gpio)

Get GPIO state.

Parameters
gpioGPIO handle
Returns
GPIO state

◆ yggdrasil_GPIO_Init()

bool yggdrasil_GPIO_Init ( gpio_t  gpio)

GPIO initialization.

Parameters
gpioGPIO handle
Returns
Success

◆ yggdrasil_GPIO_MakeInput()

C_LINKAGE bool yggdrasil_GPIO_MakeInput ( gpio_t  gpio)

Turn pin into an input.

Parameters
gpioGPIO handle
Returns
Success

◆ yggdrasil_GPIO_MakeOutput()

C_LINKAGE bool yggdrasil_GPIO_MakeOutput ( gpio_t  gpio)

Turn pin into an output.

Parameters
gpioGPIO handle
Returns
Success

◆ yggdrasil_GPIO_Set()

C_LINKAGE void yggdrasil_GPIO_Set ( gpio_t  gpio,
bool  state 
)

Set GPIO state.

Parameters
gpioGPIO handle
stateGPIO state

◆ yggdrasil_GPIO_Toggle()

C_LINKAGE void yggdrasil_GPIO_Toggle ( gpio_t  gpio)

Toggle GPIO.

Parameters
gpioGPIO handle