General

General Functions for GPIO Driver. More...

Functions
gpio_status_en	gpio_init (gpio_instance_en id)
gpio_status_en	gpio_deinit (gpio_instance_en id)
gpio_status_en	gpio_pin_set_config (gpio_instance_en id, uint32_t pin, gpio_pin_config_t *pin_config)
gpio_status_en	gpio_pin_get_config (gpio_instance_en id, uint32_t pin, gpio_pin_config_t *pin_config)
gpio_status_en	gpio_pin_write (gpio_instance_en id, uint32_t pin, uint32_t out)
gpio_status_en	gpio_pin_read (gpio_instance_en id, uint32_t pin, uint32_t *out)
gpio_status_en	gpio_pin_enable_int (gpio_instance_en id, uint32_t pin, bool enable)
gpio_status_en	gpio_pin_mask_int (gpio_instance_en id, uint32_t pin, bool enable)
gpio_status_en	gpio_pin_clear_int (gpio_instance_en id, uint32_t pin)
gpio_status_en	gpio_get_pin_int_stat (gpio_instance_en id, uint32_t pin, bool raw, bool *stat)

Detailed Description

General Functions for GPIO Driver.

Function Documentation

gpio_init()

gpio_status_en gpio_init

(

gpio_instance_en

id

)

Initialize the specified GPIO port. Enables clocks and resets registers. This function must be called first before any other GPIO functions are called.

Parameters

id	GPIO Instance ID

Returns

gpio_status_en Status code indicating success or the reason for failure.

gpio_deinit()

gpio_status_en gpio_deinit

(

gpio_instance_en

id

)

Deinitialize the specified GPIO port. Disables clocks and resets registers.

Parameters

id	GPIO Instance ID

Returns

gpio_status_en Status code indicating success or the reason for failure.

gpio_pin_set_config()

gpio_status_en gpio_pin_set_config	(	gpio_instance_en	id,
		uint32_t	pin,
		gpio_pin_config_t *	pin_config )

Configure a single GPIO pin using provided settings.

Parameters

id	GPIO Instance ID
pin	GPIO pin mask.
pin_config	Pointer to pin configuration structure (gpio_pin_config_t).

Returns

gpio_status_en Status code indicating success or the reason for failure.

gpio_pin_get_config()

gpio_status_en gpio_pin_get_config	(	gpio_instance_en	id,
		uint32_t	pin,
		gpio_pin_config_t *	pin_config )

Retrieve current configuration of a GPIO pin.

Parameters

id	GPIO Instance ID
pin	GPIO pin mask.
pin_config	Pointer to receive configuration (gpio_pin_config_t).

Returns

gpio_status_en Status code indicating success or the reason for failure.

gpio_pin_write()

gpio_status_en gpio_pin_write	(	gpio_instance_en	id,
		uint32_t	pin,
		uint32_t	out )

Write output value to a GPIO pin.

Parameters

id	GPIO Instance ID
pin	GPIO pin mask.
out	Value to write (0 or 1).

Returns

gpio_status_en Status code indicating success or the reason for failure.

gpio_pin_read()

gpio_status_en gpio_pin_read	(	gpio_instance_en	id,
		uint32_t	pin,
		uint32_t *	out )

Read input value from a GPIO pin.

Parameters

id	GPIO Instance ID
pin	GPIO pin mask.
out	Pin input value (0 or 1).

Returns

gpio_status_en Status code indicating success or the reason for failure.

gpio_pin_enable_int()

gpio_status_en gpio_pin_enable_int	(	gpio_instance_en	id,
		uint32_t	pin,
		bool	enable )

Enable or disable interrupt on a GPIO pin.

Parameters

id	GPIO Instance ID
pin	GPIO pin mask.
enable	True to enable, false to disable.

Returns

gpio_status_en Status code indicating success or the reason for failure.

gpio_pin_mask_int()

gpio_status_en gpio_pin_mask_int	(	gpio_instance_en	id,
		uint32_t	pin,
		bool	enable )

Mask or unmask interrupt on a GPIO pin.

Parameters

id	GPIO Instance ID
pin	GPIO pin mask.
enable	True to mask, false to unmask.

Returns

gpio_status_en Status code indicating success or the reason for failure.

gpio_pin_clear_int()

gpio_status_en gpio_pin_clear_int	(	gpio_instance_en	id,
		uint32_t	pin )

Clear pending interrupt on a GPIO pin.

Parameters

id	GPIO Instance ID
pin	GPIO pin mask.

Returns

gpio_status_en Status code indicating success or the reason for failure.

gpio_get_pin_int_stat()

gpio_status_en gpio_get_pin_int_stat	(	gpio_instance_en	id,
		uint32_t	pin,
		bool	raw,
		bool *	stat )

Get interrupt status for a GPIO pin.

Parameters

id	GPIO Instance ID
pin	GPIO pin mask.
raw	True for raw status, false for masked.
stat	True if interrupt active.

Returns

gpio_status_en Status code indicating success or the reason for failure.