Xbar

Overview

Data Structures
struct	xbar_info_t
	Find the instance index from base address and register offset mappings. More...
struct	xbar_control_config_t
	Defines the configuration structure of the XBAR control register. More...

Enumerations
enum	xbar_active_edge_t {   kXBAR_EdgeNone = 0U,   kXBAR_EdgeRising = 1U,   kXBAR_EdgeFalling = 2U,   kXBAR_EdgeRisingAndFalling = 3U }
	XBAR active edge for detection. More...
enum	xbar_request_t {   kXBAR_RequestDisable = 0U,   kXBAR_RequestDMAEnable = 1U,   kXBAR_RequestInterruptEnable = 2U }
	Defines the XBAR DMA and interrupt configurations. More...

XBAR functional Operation
void	XBAR_Init (xbar_instance_t xbarInstance)
	Initializes the XBAR modules. More...
void	XBAR_Deinit (xbar_instance_t xbarInstance)
	Shutdown the XBAR modules. More...
status_t	XBAR_SetSignalsConnection (xbar_input_signal_t input, xbar_output_signal_t output)
	Set connection between the selected XBAR_IN[*] input and the XBAR_OUT[*] output signal. More...
status_t	XBAR_ClearOutputStatusFlag (xbar_output_signal_t output)
	Clears the edge detection status flags. More...
status_t	XBAR_GetOutputStatusFlag (xbar_output_signal_t output, bool *flag)
	Gets the active edge detection status. More...
status_t	XBAR_SetOutputSignalConfig (xbar_output_signal_t output, const xbar_control_config_t *controlConfig)
	Configures the XBAR control register. More...

---

Data Structure Documentation

struct xbar_info_t

struct xbar_control_config_t

This structure keeps the configuration of XBAR control register for one output. Control registers are available only for a few outputs. Not every XBAR module has control registers.

Data Fields
xbar_active_edge_t	activeEdge
	Active edge to be detected. More...
xbar_request_t	requestType
	Selects DMA/Interrupt request. More...

Field Documentation

xbar_active_edge_t xbar_control_config_t::activeEdge

xbar_request_t xbar_control_config_t::requestType

Enumeration Type Documentation

enum xbar_active_edge_t

Enumerator
kXBAR_EdgeNone	Edge detection status bit never asserts.
kXBAR_EdgeRising	Edge detection status bit asserts on rising edges.
kXBAR_EdgeFalling	Edge detection status bit asserts on falling edges.
kXBAR_EdgeRisingAndFalling	Edge detection status bit asserts on rising and falling edges.

enum xbar_request_t

Enumerator
kXBAR_RequestDisable	Interrupt and DMA are disabled.
kXBAR_RequestDMAEnable	DMA enabled, interrupt disabled.
kXBAR_RequestInterruptEnable	Interrupt enabled, DMA disabled.

Function Documentation

void XBAR_Init

(

xbar_instance_t

xbarInstance

)

This function un-gates the XBAR clock.

Parameters

xbarInstance

XBAR peripheral address.

void XBAR_Deinit

(

xbar_instance_t

xbarInstance

)

This function disables XBAR clock.

Parameters

xbarInstance

XBAR peripheral address.

status_t XBAR_SetSignalsConnection	(	xbar_input_signal_t	input,
		xbar_output_signal_t	output
	)

This function connects the XBAR input to the selected XBAR output. If more than one XBAR module is available, only the inputs and outputs from the same module can be connected.

Example:

XBAR_SetSignalsConnection(kXBAR_DSC1_InputLogicLow, kXBAR_DSC1_OutputTriggerSyncIn0);

Parameters

input	XBAR input signal.
output	XBAR output signal.

Return values

kStatus_Success	Signal connection set successfully.
kStatus_InvalidArgument	Failed because of invalid argument.

status_t XBAR_ClearOutputStatusFlag

(

xbar_output_signal_t

output

)

Parameters

output

XBAR output signal.

Return values

kStatus_Success	Signal connection set successfully.
kStatus_InvalidArgument	Failed because of invalid argument.

status_t XBAR_GetOutputStatusFlag	(	xbar_output_signal_t	output,
		bool *	flag
	)

This function gets the active edge detect status of all XBAR_OUTs. If the active edge occurs, the return value is asserted. When the interrupt or the DMA functionality is enabled for the XBAR_OUTx, this field is 1 when the interrupt or DMA request is asserted and 0 when the interrupt or DMA request has been cleared.

Parameters

output	XBAR output signal.
flag	get XBAR output status flag.

Return values

kStatus_Success	Signal connection set successfully.
kStatus_InvalidArgument	Failed because of invalid argument.

status_t XBAR_SetOutputSignalConfig	(	xbar_output_signal_t	output,
		const xbar_control_config_t *	controlConfig
	)

This function configures an XBAR control register. The active edge detection and the DMA/IRQ function on the corresponding XBAR output can be set.

Example:

xbar_control_config_t userConfig;
userConfig.activeEdge = kXBAR_EdgeRising;
userConfig.requestType = kXBAR_RequestInterruptEnable;
XBAR_SetOutputSignalConfig(kXBARA_OutputDMAMUX18, &userConfig);

Parameters

output	XBAR output signal.
controlConfig	Pointer to structure that keeps configuration of control register.

Return values

kStatus_Success	Signal connection set successfully.
kStatus_InvalidArgument	Failed because of invalid argument.