Astra SRSDK Peripheral Driver Library
 
Loading...
Searching...
No Matches
General Functions

General functions for Pinmux driver. More...

Functions

pinmux_status_en pinmux_set_pin_elec_config (pinmux_pin_name_en pin_name, pinmux_elec_config_t *elec_config)
 
pinmux_status_en pinmux_get_pin_elec_config (pinmux_pin_name_en pin_name, pinmux_elec_config_t *elec_config)
 
pinmux_status_en pinmux_set_pin_elec_param (pinmux_pin_name_en pin_name, pinmux_elec_params_en param, uint32_t value)
 
pinmux_status_en pinmux_get_pin_elec_param (pinmux_pin_name_en pin_name, pinmux_elec_params_en param, int32_t *value)
 
pinmux_status_en pinmux_set_pin_function (pinmux_pin_name_en pin_name, pinmux_functions_en function)
 
pinmux_status_en pinmux_get_pin_function (pinmux_pin_name_en pin_name, pinmux_functions_en *function)
 
pinmux_status_en pinmux_config_all (const pinmux_config_all_t *config_all)
 
pinmux_status_en pinmux_config_all_mult (const pinmux_config_all_t *config_all, uint32_t num_pins)
 

Detailed Description

General functions for Pinmux driver.

Function Documentation

◆ pinmux_set_pin_elec_config()

pinmux_status_en pinmux_set_pin_elec_config ( pinmux_pin_name_en pin_name,
pinmux_elec_config_t * elec_config )

Configures all electrical parameters for a given pin.

Parameters
pin_nameName of the pin to configure.
elec_configPointer to electrical configuration structure.
Returns
pinmux_status_en Status code indicating success or the reason for failure.

◆ pinmux_get_pin_elec_config()

pinmux_status_en pinmux_get_pin_elec_config ( pinmux_pin_name_en pin_name,
pinmux_elec_config_t * elec_config )

Retrieves all electrical parameters for a given pin.

Parameters
pin_nameName of the pin to query.
elec_configPointer to structure to be populated with the current electrical configuration.
Returns
pinmux_status_en Status code indicating success or the reason for failure.

◆ pinmux_set_pin_elec_param()

pinmux_status_en pinmux_set_pin_elec_param ( pinmux_pin_name_en pin_name,
pinmux_elec_params_en param,
uint32_t value )

Configures a single electrical parameter for a pin.

Parameters
pin_nameName of the pin.
paramParameter to configure (pinmux_elec_params_en).
valueValue to set for the specified parameter.
Returns
pinmux_status_en Status code indicating success or the reason for failure.

◆ pinmux_get_pin_elec_param()

pinmux_status_en pinmux_get_pin_elec_param ( pinmux_pin_name_en pin_name,
pinmux_elec_params_en param,
int32_t * value )

Reads a single electrical parameter for a pin.

Parameters
pin_nameName of the pin.
paramParameter to read (pinmux_elec_params_en).
valuePointer to receive the value of the parameter.
Returns
pinmux_status_en Status code indicating success or the reason for failure.

◆ pinmux_set_pin_function()

pinmux_status_en pinmux_set_pin_function ( pinmux_pin_name_en pin_name,
pinmux_functions_en function )

Routes a peripheral function to a specified pin

Parameters
pin_nameName of the pin.
functionFunction to route to the pin.
Returns
pinmux_status_en Status code indicating success or the reason for failure.

◆ pinmux_get_pin_function()

pinmux_status_en pinmux_get_pin_function ( pinmux_pin_name_en pin_name,
pinmux_functions_en * function )

Retrieves the function currently routed to a pin.

Parameters
pin_nameName of the pin.
functionPointer to receive the function enum.
Returns
pinmux_status_en Status code indicating success or the reason for failure.

◆ pinmux_config_all()

pinmux_status_en pinmux_config_all ( const pinmux_config_all_t * config_all)

Configures electrical parameters and function for a single pin.

Parameters
config_allPointer to combined configuration structure (pinmux_config_all_t).
Returns
pinmux_status_en Status code indicating success or the reason for failure.

◆ pinmux_config_all_mult()

pinmux_status_en pinmux_config_all_mult ( const pinmux_config_all_t * config_all,
uint32_t num_pins )

Configures multiple pins in one call.

Parameters
config_allPointer to array of configuration structures (pinmux_config_all_t).
num_pinsNumber of pins to configure.
Returns
pinmux_status_en Status code indicating success or the reason for failure.