libmygpio
libmygpio API documentation
Loading...
Searching...
No Matches
GPIO

This module provides functions to access the t_mygpio_gpio struct, received by gpioinfo or gpiolist. More...

Enumerations

enum  mygpio_gpio_direction { MYGPIO_GPIO_DIRECTION_UNKNOWN = -1 , MYGPIO_GPIO_DIRECTION_IN , MYGPIO_GPIO_DIRECTION_OUT }
enum  mygpio_gpio_value { MYGPIO_GPIO_VALUE_UNKNOWN = -1 , MYGPIO_GPIO_VALUE_INACTIVE , MYGPIO_GPIO_VALUE_ACTIVE }
enum  mygpio_gpio_bias {
  MYGPIO_BIAS_UNKNOWN = -1 , MYGPIO_BIAS_AS_IS , MYGPIO_BIAS_DISABLED , MYGPIO_BIAS_PULL_DOWN ,
  MYGPIO_BIAS_PULL_UP
}
enum  mygpio_event_request { MYGPIO_EVENT_REQUEST_UNKNOWN = -1 , MYGPIO_EVENT_REQUEST_FALLING , MYGPIO_EVENT_REQUEST_RISING , MYGPIO_EVENT_REQUEST_BOTH }
enum  mygpio_event_clock { MYGPIO_EVENT_CLOCK_UNKNOWN = -1 , MYGPIO_EVENT_CLOCK_MONOTONIC , MYGPIO_EVENT_CLOCK_REALTIME , MYGPIO_EVENT_CLOCK_HTE }
enum  mygpio_drive { MYGPIO_DRIVE_UNKNOWN = -1 , MYGPIO_DRIVE_PUSH_PULL , MYGPIO_DRIVE_OPEN_DRAIN , MYGPIO_DRIVE_OPEN_SOURCE }

Functions

unsigned mygpio_gpio_get_gpio (struct t_mygpio_gpio *gpio)
enum mygpio_gpio_direction mygpio_gpio_get_direction (struct t_mygpio_gpio *gpio)
enum mygpio_gpio_value mygpio_gpio_get_value (struct t_mygpio_gpio *gpio)
bool mygpio_gpio_in_get_active_low (struct t_mygpio_gpio *gpio)
enum mygpio_gpio_bias mygpio_gpio_in_get_bias (struct t_mygpio_gpio *gpio)
enum mygpio_event_request mygpio_gpio_in_get_event_request (struct t_mygpio_gpio *gpio)
bool mygpio_gpio_in_get_is_debounced (struct t_mygpio_gpio *gpio)
int mygpio_gpio_in_get_debounce_period_us (struct t_mygpio_gpio *gpio)
enum mygpio_event_clock mygpio_gpio_in_get_event_clock (struct t_mygpio_gpio *gpio)
enum mygpio_drive mygpio_gpio_out_get_drive (struct t_mygpio_gpio *gpio)
const char * mygpio_gpio_get_name (struct t_mygpio_gpio *gpio)
void mygpio_free_gpio (struct t_mygpio_gpio *gpio)

Detailed Description

This module provides functions to access the t_mygpio_gpio struct, received by gpioinfo or gpiolist.

Enumeration Type Documentation

◆ mygpio_drive

enum mygpio_drive

Drive setting for an output GPIO.

Enumerator
MYGPIO_DRIVE_UNKNOWN 

Unknown drive setting.

MYGPIO_DRIVE_PUSH_PULL 

Drive setting is push-pull.

MYGPIO_DRIVE_OPEN_DRAIN 

Drive setting is open-drain.

MYGPIO_DRIVE_OPEN_SOURCE 

Drive setting is open-source.

◆ mygpio_event_clock

enum mygpio_event_clock

Clock setting for an input GPIO.

Enumerator
MYGPIO_EVENT_CLOCK_UNKNOWN 

Unknown event clock setting.

MYGPIO_EVENT_CLOCK_MONOTONIC 

Monotonic clock.

MYGPIO_EVENT_CLOCK_REALTIME 

Realtime clock.

MYGPIO_EVENT_CLOCK_HTE 

Hardware timestamp engine.

◆ mygpio_event_request

enum mygpio_event_request

Events requested for an input GPIO.

Enumerator
MYGPIO_EVENT_REQUEST_UNKNOWN 

Unknown event request setting.

MYGPIO_EVENT_REQUEST_FALLING 

Request falling events.

MYGPIO_EVENT_REQUEST_RISING 

Request rising events.

MYGPIO_EVENT_REQUEST_BOTH 

Request falling and rising events.

◆ mygpio_gpio_bias

enum mygpio_gpio_bias

Bias setting for an input GPIO.

Enumerator
MYGPIO_BIAS_UNKNOWN 

Unknown bias setting.

MYGPIO_BIAS_AS_IS 

Do not touch the bias state.

MYGPIO_BIAS_DISABLED 

Disable the bias.

MYGPIO_BIAS_PULL_DOWN 

Pull-down the GPIO.

MYGPIO_BIAS_PULL_UP 

Pull-up the GPIO.

◆ mygpio_gpio_direction

enum mygpio_gpio_direction

The direction of a GPIO.

Enumerator
MYGPIO_GPIO_DIRECTION_UNKNOWN 

Unknown GPIO direction.

MYGPIO_GPIO_DIRECTION_IN 

Input direction, myGPIOd can read events from this GPIO.

MYGPIO_GPIO_DIRECTION_OUT 

Output direction, myGPIOd can set the value to: MYGPIO_GPIO_VALUE_ACTIVE or MYGPIO_GPIO_VALUE_INACTIVE.

◆ mygpio_gpio_value

enum mygpio_gpio_value

The value of a GPIO.

Enumerator
MYGPIO_GPIO_VALUE_UNKNOWN 

Unknown GPIO value.

MYGPIO_GPIO_VALUE_INACTIVE 

GPIO state is inactive.

MYGPIO_GPIO_VALUE_ACTIVE 

GPIO state is active.

Function Documentation

◆ mygpio_free_gpio()

void mygpio_free_gpio ( struct t_mygpio_gpio * gpio)

Frees the struct received by mygpio_recv_gpio.

Parameters
gpioPointer to struct mygpio_recv_gpio.

◆ mygpio_gpio_get_direction()

enum mygpio_gpio_direction mygpio_gpio_get_direction ( struct t_mygpio_gpio * gpio)

Returns the GPIO direction from struct t_mygpio_gpio.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO direction, one of enum mygpio_gpio_direction.

◆ mygpio_gpio_get_gpio()

unsigned mygpio_gpio_get_gpio ( struct t_mygpio_gpio * gpio)

Returns the GPIO number from struct t_mygpio_gpio.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO number.

◆ mygpio_gpio_get_name()

const char * mygpio_gpio_get_name ( struct t_mygpio_gpio * gpio)

Returns the GPIO name

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO name

◆ mygpio_gpio_get_value()

enum mygpio_gpio_value mygpio_gpio_get_value ( struct t_mygpio_gpio * gpio)

Returns the GPIO value from struct t_mygpio_gpio.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO value, one of enum mygpio_gpio_value.

◆ mygpio_gpio_in_get_active_low()

bool mygpio_gpio_in_get_active_low ( struct t_mygpio_gpio * gpio)

Returns the GPIO active_low from struct t_mygpio_gpio.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO is set to active_low?

◆ mygpio_gpio_in_get_bias()

enum mygpio_gpio_bias mygpio_gpio_in_get_bias ( struct t_mygpio_gpio * gpio)

Returns the GPIO bias from struct t_mygpio_gpio.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO bias, one of enum mygpio_gpio_bias.

◆ mygpio_gpio_in_get_debounce_period_us()

int mygpio_gpio_in_get_debounce_period_us ( struct t_mygpio_gpio * gpio)

Returns the GPIO debounce period from struct t_mygpio_gpio.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO debounce period in microseconds.

◆ mygpio_gpio_in_get_event_clock()

enum mygpio_event_clock mygpio_gpio_in_get_event_clock ( struct t_mygpio_gpio * gpio)

Returns the GPIO event clock from struct t_mygpio_gpio.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO event clock, one of enum mygpio_event_clock.

◆ mygpio_gpio_in_get_event_request()

enum mygpio_event_request mygpio_gpio_in_get_event_request ( struct t_mygpio_gpio * gpio)

Returns the requested events from struct t_mygpio_gpio.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
requested GPIO events, one of enum event_request.

◆ mygpio_gpio_in_get_is_debounced()

bool mygpio_gpio_in_get_is_debounced ( struct t_mygpio_gpio * gpio)

Returns true if the GPIO is debounced.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO debounced?

◆ mygpio_gpio_out_get_drive()

enum mygpio_drive mygpio_gpio_out_get_drive ( struct t_mygpio_gpio * gpio)

Returns the GPIO drive setting from struct t_mygpio_gpio.

Parameters
gpioPointer to struct t_mygpio_gpio.
Returns
GPIO drive setting, one of enum mygpio_drive.