Board-independent GPIO functions. More...

Detailed Description

Board-independent GPIO functions.

Definition in file gpio.h.

Typedefs
typedef uint8_t	gpio_id_t
	GPIO identification number. More...

typedef uint8_t	gpio_port_t
	GPIO port number. More...

typedef uint8_t	gpio_pin_t
	GPIO pin number. More...

typedef void(*	gpio_in_event_cb_f) (gpio_id_t id, gpio_in_event_e event)
	Callback structure for a GPIO event. More...

Functions
gpio_res_e	Gpio_init (void)
	Initialize GPIO module. More...

gpio_res_e	Gpio_inputSetCfg (gpio_id_t id, const gpio_in_cfg_t *in_cfg)
	Configure a GPIO as an input GPIO. More...

gpio_res_e	Gpio_inputRead (gpio_id_t id, gpio_level_e *level)
	Read the GPIO input level. More...

gpio_res_e	Gpio_outputSetCfg (gpio_id_t id, const gpio_out_cfg_t *out_cfg)
	Configure a GPIO as an output GPIO. More...

gpio_res_e	Gpio_outputWrite (gpio_id_t id, gpio_level_e level)
	Write GPIO output level. More...

gpio_res_e	Gpio_outputToggle (gpio_id_t id)
	Toggle GPIO output level. More...

gpio_res_e	Gpio_outputRead (gpio_id_t id, gpio_level_e *level)
	Read the GPIO output level. More...

gpio_res_e	Gpio_getPin (gpio_id_t id, gpio_port_t port, gpio_pin_t pin)
	Get the GPIO port and pin numbers of the given GPIO id. More...

uint8_t	Gpio_getNumber (void)
	Get the number of GPIOs. More...

Data Structures
struct	gpio_in_cfg_t
	GPIO input configuration. More...

struct	gpio_out_cfg_t
	GPIO output configuration. More...

Enumerations
enum	gpio_res_e { GPIO_RES_OK = 0, GPIO_RES_UNINITIALIZED = 1, GPIO_RES_NOT_IMPLEMENTED = 2, GPIO_RES_INVALID_PARAM = 3, GPIO_RES_INVALID_PIN = 4, GPIO_RES_INVALID_DIRECTION = 5, GPIO_RES_NO_FREE_IT = 6 }
	List of return code. More...

enum	gpio_level_e { GPIO_LEVEL_LOW, GPIO_LEVEL_HIGH }
	GPIO logical level. More...

enum	gpio_in_mode_cfg_e { GPIO_IN_DISABLED, GPIO_IN_PULL_NONE, GPIO_IN_PULL_DOWN, GPIO_IN_PULL_UP }
	GPIO pull configuration. More...

enum	gpio_out_mode_cfg_e { GPIO_OUT_MODE_PUSH_PULL, GPIO_OUT_MODE_OPEN_DRAIN, GPIO_OUT_MODE_OPEN_DRAIN_WITH_PULL_UP }
	GPIO operating mode configuration. More...

enum	gpio_in_event_e { GPIO_IN_EVENT_NONE = 0, GPIO_IN_EVENT_RISING_EDGE = 1U << 0U, GPIO_IN_EVENT_FALLING_EDGE = 1U << 1U }
	GPIO event. More...

Macros
#define	IS_RISING_EDGE(event) ((event & GPIO_IN_EVENT_RISING_EDGE) == GPIO_IN_EVENT_RISING_EDGE)
	Check if event has its rising edge bit set. More...

#define	IS_FALLING_EDGE(event) ((event & GPIO_IN_EVENT_FALLING_EDGE) == GPIO_IN_EVENT_FALLING_EDGE)
	Check if event has its falling edge bit set. More...

Typedef Documentation

◆ gpio_id_t

typedef uint8_t gpio_id_t

GPIO identification number.

Definition at line 18 of file gpio.h.

◆ gpio_in_event_cb_f

typedef void(* gpio_in_event_cb_f) (gpio_id_t id, gpio_in_event_e event)

Callback structure for a GPIO event.

Parameters

id	Id of the GPIO which raised the event
event	Event raised

Definition at line 110 of file gpio.h.

◆ gpio_pin_t

typedef uint8_t gpio_pin_t

GPIO pin number.

Definition at line 24 of file gpio.h.

◆ gpio_port_t

typedef uint8_t gpio_port_t

GPIO port number.

Definition at line 21 of file gpio.h.

Function Documentation

◆ Gpio_getNumber()

uint8_t Gpio_getNumber ( void )

Get the number of GPIOs.

Returns: Number of GPIOs

◆ Gpio_getPin()

gpio_res_e Gpio_getPin	(	gpio_id_t	id,
		gpio_port_t *	port,
		gpio_pin_t *	pin
	)

Get the GPIO port and pin numbers of the given GPIO id.

Parameters

	id	Id of the GPIO
[out]	port	Returned GPIO port number
[out]	pin	Returned GPIO pin number

Returns: Return code of operation

◆ Gpio_init()

gpio_res_e Gpio_init ( void )

Initialize GPIO module.

Example on use:

void App_init(const app_global_functions_t * functions)
{
    ...
    // Set up GPIOs first
    Gpio_init();
    ...
    Gpio_inputSetCfg(GPIO_INPUT_ID, &in_cfg);
    ...
    Gpio_outputSetCfg(GPIO_OUTPUT_ID, &out_cfg);
    ...
}

◆ Gpio_inputRead()

gpio_res_e Gpio_inputRead	(	gpio_id_t	id,
		gpio_level_e *	level
	)

Read the GPIO input level.

Note: The GPIO should be configured as an input GPIO

Parameters

	id	Id of the GPIO
[out]	level	Returned GPIO level (low or high)

Returns: Return code of operation

◆ Gpio_inputSetCfg()

gpio_res_e Gpio_inputSetCfg	(	gpio_id_t	id,
		const gpio_in_cfg_t *	in_cfg
	)

Configure a GPIO as an input GPIO.

Parameters

	id	Id of the GPIO
[in]	in_cfg	GPIO input configuration

Returns: Return code of operation

◆ Gpio_outputRead()

gpio_res_e Gpio_outputRead	(	gpio_id_t	id,
		gpio_level_e *	level
	)

Read the GPIO output level.

Note: The GPIO should be configured as an output GPIO

Parameters

	id	Id of the GPIO
[out]	level	Returned GPIO level (low or high)

Returns: Return code of operation

◆ Gpio_outputSetCfg()

gpio_res_e Gpio_outputSetCfg	(	gpio_id_t	id,
		const gpio_out_cfg_t *	out_cfg
	)

Configure a GPIO as an output GPIO.

Parameters

	id	Id of the GPIO
[in]	out_cfg	GPIO output configuration

Returns: Return code of operation

Examples: ruuvi_evk/app.c.

◆ Gpio_outputToggle()

gpio_res_e Gpio_outputToggle ( gpio_id_t id )

Toggle GPIO output level.

Note: The GPIO should be configured as an output GPIO

Parameters

id	Id of the GPIO

Returns: Return code of operation

◆ Gpio_outputWrite()

gpio_res_e Gpio_outputWrite	(	gpio_id_t	id,
		gpio_level_e	level
	)

Write GPIO output level.

Note: The GPIO should be configured as an output GPIO

Parameters

id	Id of the GPIO
level	GPIO level (low or high) to write

Returns: Return code of operation

Data Structure Documentation

◆ gpio_in_cfg_t

struct gpio_in_cfg_t

GPIO input configuration.

Definition at line 113 of file gpio.h.

Data Fields
gpio_in_event_cb_f	event_cb	Callback called on GPIO events
gpio_in_event_e	event_cfg: 2	Event configuration. Use \| (OR) operator to detect both rising and falling edges. e.g.: .event_cfg = (GPIO_IN_EVENT_RISING_EDGE \| GPIO_IN_EVENT_FALLING_EDGE)
gpio_in_mode_cfg_e	in_mode_cfg: 2	Pull configuration (e.g.: Pull-down)

◆ gpio_out_cfg_t

struct gpio_out_cfg_t

GPIO output configuration.

Examples: ruuvi_evk/app.c.

Definition at line 128 of file gpio.h.

Data Fields
gpio_level_e	level_default: 1	GPIO default logical level (e.g.: Low)
gpio_out_mode_cfg_e	out_mode_cfg: 2	Operating mode configuration (e.g.: Push-pull)

Enumeration Type Documentation

◆ gpio_in_event_e

enum gpio_in_event_e

GPIO event.

Note: Used for input GPIOs

Enumerator
GPIO_IN_EVENT_NONE	No event
GPIO_IN_EVENT_RISING_EDGE	Rising edge event
GPIO_IN_EVENT_FALLING_EDGE	Falling edge event

Definition at line 88 of file gpio.h.

 {
     GPIO_IN_EVENT_NONE = 0,
     GPIO_IN_EVENT_RISING_EDGE = 1U << 0U,
     GPIO_IN_EVENT_FALLING_EDGE = 1U << 1U,
 } gpio_in_event_e;

◆ gpio_in_mode_cfg_e

enum gpio_in_mode_cfg_e

GPIO pull configuration.

Note: Used for input GPIOs

Enumerator
GPIO_IN_DISABLED	input disabled
GPIO_IN_PULL_NONE	No pull (floating if no external pull-up or pull-down)
GPIO_IN_PULL_DOWN	Pull-down
GPIO_IN_PULL_UP	Pull-up

Definition at line 58 of file gpio.h.

 {
     GPIO_IN_DISABLED,
     GPIO_IN_PULL_NONE,
     GPIO_IN_PULL_DOWN,
     GPIO_IN_PULL_UP
 } gpio_in_mode_cfg_e;

◆ gpio_level_e

enum gpio_level_e

GPIO logical level.

Enumerator
GPIO_LEVEL_LOW	The GPIO is low
GPIO_LEVEL_HIGH	The GPIO is high

Definition at line 46 of file gpio.h.

 {
     GPIO_LEVEL_LOW,
     GPIO_LEVEL_HIGH
 } gpio_level_e;

◆ gpio_out_mode_cfg_e

enum gpio_out_mode_cfg_e

GPIO operating mode configuration.

Note: Used for output GPIOs

Enumerator
GPIO_OUT_MODE_PUSH_PULL	Push-pull
GPIO_OUT_MODE_OPEN_DRAIN	Open-drain
GPIO_OUT_MODE_OPEN_DRAIN_WITH_PULL_UP	Open-drain with pull-up

Definition at line 74 of file gpio.h.

 {
     GPIO_OUT_MODE_PUSH_PULL,
     GPIO_OUT_MODE_OPEN_DRAIN,
     GPIO_OUT_MODE_OPEN_DRAIN_WITH_PULL_UP
 } gpio_out_mode_cfg_e;

◆ gpio_res_e

enum gpio_res_e

List of return code.

Enumerator
GPIO_RES_OK	Operation is successful
GPIO_RES_UNINITIALIZED	GPIO iniatialization has not been performed
GPIO_RES_NOT_IMPLEMENTED	GPIO HAL is not implemented. Weak definitions are used instead
GPIO_RES_INVALID_PARAM	Invalid parameter(s)
GPIO_RES_INVALID_PIN	Invalid pin number
GPIO_RES_INVALID_DIRECTION	Invalid GPIO direction
GPIO_RES_NO_FREE_IT	No free external interrupt: all of them are already in use. Note: Only used on SiLabs/EFR32 boards

Definition at line 27 of file gpio.h.

 {
     GPIO_RES_OK = 0,
     GPIO_RES_UNINITIALIZED  = 1,
     GPIO_RES_NOT_IMPLEMENTED = 2,
     GPIO_RES_INVALID_PARAM = 3,
     GPIO_RES_INVALID_PIN   = 4,
     GPIO_RES_INVALID_DIRECTION   = 5,
     GPIO_RES_NO_FREE_IT = 6
 } gpio_res_e;

Macro Definition Documentation

◆ IS_FALLING_EDGE

#define IS_FALLING_EDGE ( event ) ((event & GPIO_IN_EVENT_FALLING_EDGE) == GPIO_IN_EVENT_FALLING_EDGE)

Check if event has its falling edge bit set.

Definition at line 101 of file gpio.h.

◆ IS_RISING_EDGE

#define IS_RISING_EDGE ( event ) ((event & GPIO_IN_EVENT_RISING_EDGE) == GPIO_IN_EVENT_RISING_EDGE)

Check if event has its rising edge bit set.

Definition at line 99 of file gpio.h.

Detailed Description

Typedefs

Functions

Data Structures

Enumerations

Macros

Typedef Documentation

◆ gpio_id_t

◆ gpio_in_event_cb_f

◆ gpio_pin_t

◆ gpio_port_t

Function Documentation

◆ Gpio_getNumber()

◆ Gpio_getPin()

◆ Gpio_init()

◆ Gpio_inputRead()

◆ Gpio_inputSetCfg()

◆ Gpio_outputRead()

◆ Gpio_outputSetCfg()

◆ Gpio_outputToggle()

◆ Gpio_outputWrite()

Data Structure Documentation

◆ gpio_in_cfg_t

◆ gpio_out_cfg_t

Enumeration Type Documentation

◆ gpio_in_event_e

◆ gpio_in_mode_cfg_e

◆ gpio_level_e

◆ gpio_out_mode_cfg_e

◆ gpio_res_e

Macro Definition Documentation

◆ IS_FALLING_EDGE

◆ IS_RISING_EDGE