Xilinx Embedded Software

https://github.com/xilinx/embeddedsw
Admin
Xilinx Embedded Software is a comprehensive repository containing device drivers, board support...
Tokens:7,430,350
Snippets:84,406
Trust Score:9.3
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### XTpm_Startup

Source: https://github.com/xilinx/embeddedsw/blob/master/lib/sw_services/xiltpm/doc/html/api/xtpm__client_8c.html

Starts the TPM by sending the startup command to PLM.

```APIDOC
## XTpm_Startup

### Description
This function sends TPM startup command to PLM to start the TPM.

### Method
Function

### Signature
int XTpm_Startup(XTpm_ClientInstance *InstancePtr)

### Parameters
- **InstancePtr** (XTpm_ClientInstance*) - Required - Pointer to the TPM client instance.

### Returns
- **int** - Status of the operation (0 on success, non-zero on failure).
```

--------------------------------

### main

Source: https://github.com/xilinx/embeddedsw/blob/master/lib/sw_services/xiltpm/doc/html/api/xiltpm__example_8c.html

Main function to call the TPMExample. This is the entry point for the example application.

```APIDOC
## main

### Description
Main function to call the TPMExample.

### Method
Function

### Endpoint
main(void)

### Parameters
- **void** - No parameters.

### Returns
- **int** - Return value indicating success or failure.

### Example
c
int main(void) {
    // Call TPMExample
    return TPMExample();
}

```

--------------------------------

### Exdes_StartSysTmr()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_hdmirxss1/doc/html/api/globals_func_0x65.html

Starts the system timer in the example application. This function is part of the example code for the v_hdmirxss1 driver.

```APIDOC
## Exdes_StartSysTmr()

### Description
Starts the system timer in the example application. This function is part of the example code for the v_hdmirxss1 driver.

### Source File
xhdmi_example.c

### Parameters
- Not specified in the source.

### Returns
- Not specified in the source.

```

--------------------------------

### Dptx_SetupExample

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/xdp__tx__example__common_8c.html

Sets up and initializes the DisplayPort TX core.

```APIDOC
## Dptx_SetupExample

### Description
This function sets up and initializes the DisplayPort TX core.

### Function Signature
u32 Dptx_SetupExample(XDp *InstancePtr, u16 DeviceId)

### Parameters
- **InstancePtr** (XDp*) - Pointer to the XDp instance.
- **DeviceId** (u16) - Device ID of the DisplayPort TX core.

### Return Value
u32 - Status code indicating success or failure.
```

--------------------------------

### XAxiPmon_GetWrLatencyStart()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/axipmon/doc/html/api/globals_func.html

Gets the write latency start value.

```APIDOC
## XAxiPmon_GetWrLatencyStart()

### Description
Gets the write latency start value.

### Function Signature
`XAxiPmon_GetWrLatencyStart()`

### Parameters
- **InstancePtr** (XAxiPmon*) - Pointer to the driver instance.

### Returns
- **u32** - The write latency start value.

### Source File
`xaxipmon.c`
```

--------------------------------

### Dptx_SetupExample()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/globals_func.html

Sets up the transmit example for the DP12 driver.

```APIDOC
## Dptx_SetupExample()

### Description
Sets up the transmit example for the DP12 driver.

### Function
Dptx_SetupExample()

### Source Files
xdp_tx_example_common.c, xdp_tx_example_common.h

```

--------------------------------

### XAxiPmon_GetRdLatencyStart()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/axipmon/doc/html/api/globals_func.html

Gets the read latency start value.

```APIDOC
## XAxiPmon_GetRdLatencyStart()

### Description
Gets the read latency start value.

### Function Signature
`XAxiPmon_GetRdLatencyStart()`

### Parameters
- **InstancePtr** (XAxiPmon*) - Pointer to the driver instance.

### Returns
- **u32** - The read latency start value.

### Source File
`xaxipmon.c`
```

--------------------------------

### Dptx_SetupExample

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/xdp__tx__example__common_8c.html

Sets up and initializes the DisplayPort TX core, retrieving configuration parameters based on the device ID.

```APIDOC
## Dptx_SetupExample

### Description
This function sets up and initializes the DisplayPort TX core. The core's configuration parameters are retrieved based on the configuration to the DisplayPort TX core instance with the specified device ID.

### Function Signature
u32 Dptx_SetupExample(XDp *InstancePtr, u16 DeviceId)

### Parameters
- **InstancePtr** (XDp*) - Pointer to the XDp instance.
- **DeviceId** (u16) - Unique device ID of the DisplayPort TX core instance.

### Returns
- XST_SUCCESS if the device configuration was found and obtained and if the main link was successfully established.
- XST_FAILURE otherwise.

### Notes
None.

### References
- XDp_Config::BaseAddr
- XDp_CfgInitialize()
- XDp_Initialize()
- XDp_LookupConfig()

### Referenced By
- Dptx_AudioExample()
- Dptx_IntrExample()
- Dptx_MstExample()
- Dptx_PollExample()
- Dptx_TimerExample()
```

--------------------------------

### XPlmi Server APIs

Source: https://github.com/xilinx/embeddedsw/blob/master/lib/sw_services/xilplmi/doc/html/api/group__xilplmi__server__apis.html

This code snippet provides structured documentation for the XPlmi server APIs, including functions to set PLM update IPI mask, set PMC IRO frequency, set up interrupt system, set XRAM available flag, get secure lockdown state, soft reset handler, and acknowledge SSIT events.

```APIDOC
## XPlmi_SetPlmUpdateIpiMask

### Description
This function sets the PlmUpdateIpiMask variable value.

### Parameters
- **value** (u32) - Required - The value of PlmUpdateIpiMask.

### Returns
None.
```

```APIDOC
## XPlmi_SetPmcIroFreq

### Description
This function sets the PMC IRO frequency. During PLM phase, it sets the PMC IRO frequency to 400MHz for MP,HP parts, with redundancy to make it single glitch immune. It also updates the PPU1 MB frequency used in BSP for timing calculations.

### Returns
- XST_SUCCESS on success
- Error code on failure
```

```APIDOC
## XPlmi_SetUpInterruptSystem

### Description
This function connects the interrupt handler of the IO Module to the processor. It registers the IO module interrupt handler with the exception table, enables interrupts, and clears Break In Progress to get interrupts.

### Returns
- XST_SUCCESS if handlers are registered properly.
- XPLMI_ERR_IOMOD_CONNECT if IOModule driver fails to establish connection.
```

```APIDOC
## XPlmi_SetXRamAvailable

### Description
This function sets the XRAM Available Flag.

### Returns
None.
```

```APIDOC
## XPlmi_SldState

### Description
This function returns the Secure Lockdown State.

### Returns
- Secure Lockdown State (u32)
```

```APIDOC
## XPlmi_SoftResetHandler

### Description
This function sets the clock source to IRO for ES1 silicon and resets the device.

### Returns
None.
```

```APIDOC
## XPlmi_SsitAcknowledgeEvent

### Description
This function acknowledges an event on a specified SLR index.

### Parameters
- **SlrIndex** (u8) - Required - The SLR index.
- **EventIndex** (u32) - Required - The event index.

### Returns
None.
```

--------------------------------

### Dptx_StartLink()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/globals_func.html

Starts the link for the transmit example for the DP12 driver.

```APIDOC
## Dptx_StartLink()

### Description
Starts the link for the transmit example for the DP12 driver.

### Function
Dptx_StartLink()

### Source Files
xdp_tx_example_common.h, xdp_tx_example_common.c

```

--------------------------------

### XQspiPsu_RXSetup()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/qspipsu/doc/html/api/globals_0x78.html

Sets up the RX path.

```APIDOC
## XQspiPsu_RXSetup()

### Description
Sets up the RX path.

### Method
Function

### Endpoint
XQspiPsu_RXSetup()

### Parameters
- **InstancePtr** (XQspiPsu*) - Required - Pointer to the QSPI driver instance.
- **BufferPtr** (u8*) - Required - Pointer to the RX buffer.
- **ByteCount** (u32) - Required - Number of bytes to receive.

### Returns
- **int** - Status of the operation (XST_SUCCESS or error code).
```

--------------------------------

### XV_letterbox_Get_HwReg_row_start()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_letterbox/doc/html/api/globals_func.html

Gets the row start hardware register value.

```APIDOC
## XV_letterbox_Get_HwReg_row_start()

### Description
Gets the row start hardware register value.

### Function Signature
`u32 XV_letterbox_Get_HwReg_row_start(XV_letterbox *InstancePtr)`

### Parameters
- **InstancePtr** (XV_letterbox*) - Pointer to the XV_letterbox instance.

### Returns
- **u32** - The value of the row start register.
```

--------------------------------

### XQspiPsu_TXRXSetup()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/qspipsu/doc/html/api/globals_0x78.html

Sets up both TX and RX for the QSPI PSU controller.

```APIDOC
## XQspiPsu_TXRXSetup()

### Description
Sets up both TX and RX for the QSPI PSU controller.

### Method
Function

### Endpoint
XQspiPsu_TXRXSetup()

### Parameters
- **InstancePtr** (XQspiPsu*) - Required - Pointer to the QSPI PSU instance.
- **BufferAddress** (UINTPTR) - Required - The buffer address for DMA.
- **NumBytes** (u32) - Required - Number of bytes to transfer.

### Returns
- **int** - Status of the operation (XST_SUCCESS or error code).

### Source File
xqspipsu_hw.c
```

--------------------------------

### XV_letterbox_Get_HwReg_col_start()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_letterbox/doc/html/api/globals_func.html

Gets the column start hardware register value.

```APIDOC
## XV_letterbox_Get_HwReg_col_start()

### Description
Gets the column start hardware register value.

### Function Signature
`u32 XV_letterbox_Get_HwReg_col_start(XV_letterbox *InstancePtr)`

### Parameters
- **InstancePtr** (XV_letterbox*) - Pointer to the XV_letterbox instance.

### Returns
- **u32** - The value of the column start register.
```

--------------------------------

### XQspiPsu_TXSetup()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/qspipsu/doc/html/api/globals_0x78.html

Sets up TX for the QSPI PSU controller.

```APIDOC
## XQspiPsu_TXSetup()

### Description
Sets up TX for the QSPI PSU controller.

### Method
Function

### Endpoint
XQspiPsu_TXSetup()

### Parameters
- **InstancePtr** (XQspiPsu*) - Required - Pointer to the QSPI PSU instance.
- **BufferAddress** (UINTPTR) - Required - The buffer address for DMA.
- **NumBytes** (u32) - Required - Number of bytes to transfer.

### Returns
- **int** - Status of the operation (XST_SUCCESS or error code).

### Source File
xqspipsu_hw.c
```

--------------------------------

### Dptx_AudioExample(XDp *InstancePtr, u16 DeviceId)

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/xdp__tx__audio__example_8c.html

The main entry point for the audio example using the XDp driver. This function sets up audio, initiates link training, and starts a video stream over the main link.

```APIDOC
## Dptx_AudioExample(XDp *InstancePtr, u16 DeviceId)

### Description
The main entry point for the audio example using the XDp driver. This function sets up audio, initiates link training, and starts a video stream over the main link.

### Parameters
- **InstancePtr** (XDp*) - Pointer to the XDp instance.
- **DeviceId** (u16) - Unique device ID of the DisplayPort TX core instance.

### Returns
- XST_SUCCESS if the system was set up correctly and link training was successful.
- XST_FAILURE otherwise.

### References
- Dptx_Run()
- Dptx_SetupExample()

### Referenced By
- main()
```

--------------------------------

### main()

Source: https://github.com/xilinx/embeddedsw/blob/master/lib/sw_services/xilffs/doc/html/api/globals.html

Main entry point for the polled example programs. This function is called by the system to start the example and demonstrates the usage of the FatFs library.

```APIDOC
## main()

### Description
Main entry point for the polled example programs. This function is called by the system to start the example and demonstrates the usage of the FatFs library.

### Method
Function

### Signature
`int main(void)`

### Parameters
None

### Return Value
- **int** - Returns 0 on success, or a non-zero error code on failure.

```

--------------------------------

### Csi2TxSs_SetupIntrSystem()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/csi2txss/doc/html/api/globals_func.html

Setup interrupt system routine for the csi2txss interrupt example.

```APIDOC
## Csi2TxSs_SetupIntrSystem()

### Description
Setup interrupt system routine for the csi2txss interrupt example.

### Source File
xcsi2txss_intr_example.c

### Group
csi2txss
```

--------------------------------

### DpPsu_SetupExample

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dppsu/doc/html/api/xdppsu__common__example_8c.html

This function sets up and initializes the DisplayPort TX core. The core's configuration parameters are retrieved based on the configuration to the DisplayPort TX core instance with the specified device ID.

```APIDOC
## DpPsu_SetupExample

### Description
This function sets up and initializes the DisplayPort TX core. The core's configuration parameters are retrieved based on the configuration to the DisplayPort TX core instance with the specified device ID.

### Parameters
- **InstancePtr** (XDpPsu*) - Required - Pointer to the XDpPsu instance.
- **DeviceId** (u32) - Required - Unique device ID of the DisplayPort TX core instance.

### Returns
- XST_SUCCESS if the device configuration was found and obtained and if the main link was successfully established.
- XST_FAILURE otherwise.

### Notes
None.
```

--------------------------------

### XEmacPs_SetupPCS()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/emacps/doc/html/api/globals_func.html

Sets up the PCS.

```APIDOC
## XEmacPs_SetupPCS()

### Description
Sets up the PCS.

### Function
XEmacPs_SetupPCS()

### Source File
xemacps_pcs.c

```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_9()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 9 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_9()

### Description
Gets the hardware register value for layer 9 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_9(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 9.
```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_8()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 8 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_8()

### Description
Gets the hardware register value for layer 8 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_8(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 8.
```

--------------------------------

### main()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/usbpsu/doc/html/api/globals_0x6d.html

The main() function is the entry point for the USB example applications. It is documented in multiple example files including xusb_audio_dfu_example.c, xusb_poll_example.c, xusb_intr_example.c, and xusb_composite_example.c.

```APIDOC
## main()

### Description
The main() function serves as the entry point for the USB example applications. It is documented in multiple example files including xusb_audio_dfu_example.c, xusb_poll_example.c, xusb_intr_example.c, and xusb_composite_example.c.

### Method
main

### Endpoint
main()

### Parameters
None

### Return Value
- **int** - The return value is not explicitly documented in the source.
```

--------------------------------

### XQspiPsu_RXSetup()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/qspipsu/doc/html/api/globals_func.html

Sets up the receiver for a transfer.

```APIDOC
## XQspiPsu_RXSetup()

### Description
Sets up the receiver for a transfer.

### Source File
xqspipsu_hw.c

### Parameters
- **InstancePtr** (XQspiPsu*) - Required - Pointer to the QSPIPSU driver instance.

### Returns
- **void** - None.

```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_7()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 7 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_7()

### Description
Gets the hardware register value for layer 7 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_7(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 7.
```

--------------------------------

### XV_LBoxInitialize

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_letterbox/doc/html/api/group__v__letterbox.html

Initializes the core instance.

```APIDOC
## XV_LBoxInitialize

### Description
Initializes the core instance.

### Function Signature
int XV_LBoxInitialize(XV_Lbox_l2 *InstancePtr, u16 DeviceId)

### Parameters
- **InstancePtr** (XV_Lbox_l2*) - Pointer to core instance to be worked upon.
- **DeviceId** (u16) - Instance id of the core.

### Returns
- XST_SUCCESS if device is found and initialized.
- XST_DEVICE_NOT_FOUND if device is not found.
```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_6()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 6 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_6()

### Description
Gets the hardware register value for layer 6 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_6(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 6.
```

--------------------------------

### main()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/axicdma/doc/html/api/xaxicdma__example__sg__poll_8c.html

The entry point for this example. It sets up uart16550 if one is available, invokes the example function, and reports the execution status.

```APIDOC
## [main] [void]

### Description
The entry point for this example. It sets up uart16550 if one is available, invokes the example function, and reports the execution status.

### Method
main

### Endpoint
main()

### Parameters
None.

### Returns
- XST_SUCCESS if example finishes successfully
- XST_FAILURE if example fails.

### Note
None.

### References
- XAxiCdma_SgPollExample()
```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_5()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 5 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_5()

### Description
Gets the hardware register value for layer 5 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_5(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 5.
```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_4()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 4 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_4()

### Description
Gets the hardware register value for layer 4 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_4(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 4.
```

--------------------------------

### XQspiPsu_TXSetup()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/qspipsu/doc/html/api/globals_func.html

Sets up the transmitter for a transfer.

```APIDOC
## XQspiPsu_TXSetup()

### Description
Sets up the transmitter for a transfer.

### Source File
xqspipsu_hw.c

### Parameters
- **InstancePtr** (XQspiPsu*) - Required - Pointer to the QSPIPSU driver instance.

### Returns
- **void** - None.

```

--------------------------------

### main

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/uartpsv/doc/html/api/xuartpsv__selftest__example_8c.html

Main function to call the example. It invokes UartPsvSelfTestExample.

```APIDOC
## main

### Description
Main function to call the example. It invokes UartPsvSelfTestExample.

### Returns
- XST_SUCCESS if successful, otherwise XST_FAILURE.

### Notes
- None

### References
- UartPsvSelfTestExample()
```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_3()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 3 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_3()

### Description
Gets the hardware register value for layer 3 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_3(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 3.
```

--------------------------------

### main()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/globals_0x6d.html

The main() function is the entry point for the dp12 driver example programs. It is defined in multiple example source files, including xdp_rx_mst_example.c, xdp_tx_timer_example.c, xdp_tx_poll_example.c, xdp_tx_mst_example.c, xdp_tx_intr_example.c, xdp_tx_audio_example.c, xdp_selftest_example.c, and xdp_rx_sst_dp159_example.c.

```APIDOC
## main()

### Description
The main() function is the entry point for the dp12 driver example programs. It is defined in multiple example source files, including xdp_rx_mst_example.c, xdp_tx_timer_example.c, xdp_tx_poll_example.c, xdp_tx_mst_example.c, xdp_tx_intr_example.c, xdp_tx_audio_example.c, xdp_selftest_example.c, and xdp_rx_sst_dp159_example.c.

### Function Signature
int main(void)

### Parameters
None

### Returns
- **int** - Return code indicating success or failure of the example program.

### Usage
This function is the entry point for each example program. It initializes the dp12 driver, runs the example logic, and returns a status code.

### Source Files
- xdp_rx_mst_example.c
- xdp_tx_timer_example.c
- xdp_tx_poll_example.c
- xdp_tx_mst_example.c
- xdp_tx_intr_example.c
- xdp_tx_audio_example.c
- xdp_selftest_example.c
- xdp_rx_sst_dp159_example.c
```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_2()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 2 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_2()

### Description
Gets the hardware register value for layer 2 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_2(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 2.
```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_16()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 16 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_16()

### Description
Gets the hardware register value for layer 16 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_16(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 16.
```

--------------------------------

### Dp21RxSs_Pt_Setup

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp21rxss/doc/html/api/xdprxss__dp21__pt_8c.html

Sets up the DisplayPort RX Subsystem pass-through example.

```APIDOC
## Dp21RxSs_Pt_Setup

### Description
Sets up the DisplayPort RX Subsystem pass-through example.

### Function Signature
void Dp21RxSs_Pt_Setup (void)

### Parameters
None

### Returns
None
```

--------------------------------

### main()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/hwicap/doc/html/api/globals.html

Main entry point for the hwicap example applications. It initializes the system and calls the respective example functions.

```APIDOC
## main()

### Description
Main entry point for the hwicap example applications. It initializes the system and calls the respective example functions.

### Source Files
- xhwicap_intr_example.c
- xhwicap_testapp_example.c
- xhwicap_read_frame_polled_example.c
- xhwicap_read_config_reg_example.c
- xhwicap_low_level_example.c
```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_15()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 15 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_15()

### Description
Gets the hardware register value for layer 15 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_15(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 15.
```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_14()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 14 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_14()

### Description
Gets the hardware register value for layer 14 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_14(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 14.
```

--------------------------------

### main()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/sysmonpsu/doc/html/api/globals.html

The main() function is the entry point for the sysmonpsu driver example applications. It is documented in multiple example files, including xsysmonpsu_ams_example.c, xsysmonpsu_single_ch_intr_example.c, xsysmonpsu_polled_example.c, xsysmonpsu_low_level_example.c, and xsysmonpsu_intr_example.c.

```APIDOC
## main()

### Description
The main() function serves as the entry point for the sysmonpsu driver example applications. It is defined in multiple example files, each demonstrating different usage modes of the driver.

### Files
- xsysmonpsu_ams_example.c
- xsysmonpsu_single_ch_intr_example.c
- xsysmonpsu_polled_example.c
- xsysmonpsu_low_level_example.c
- xsysmonpsu_intr_example.c

### Return Value
- int - Returns 0 on success, non-zero on failure (as typical for main functions).

### Parameters
- None explicitly documented in the source.

### Usage
Refer to the individual example files for detailed usage and implementation.
```

--------------------------------

### main()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/globals_func.html

Main entry point for the DP12 driver examples.

```APIDOC
## main()

### Description
Main entry point for the DP12 driver examples.

### Function
main()

### Source Files
xdp_rx_mst_example.c, xdp_tx_timer_example.c, xdp_tx_poll_example.c, xdp_tx_mst_example.c, xdp_tx_intr_example.c, xdp_tx_audio_example.c, xdp_selftest_example.c, xdp_rx_sst_dp159_example.c

```

--------------------------------

### XV_mix_Get_HwReg_layerStartY_13()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/struct_x_v__mix___config.html

Gets the hardware register value for layer 13 start Y position.

```APIDOC
## XV_mix_Get_HwReg_layerStartY_13()

### Description
Gets the hardware register value for layer 13 start Y position.

### Method
Function

### Signature
`u32 XV_mix_Get_HwReg_layerStartY_13(XV_mix *InstancePtr)`

### Parameters
- **InstancePtr** (XV_mix*) - Pointer to the XV_mix instance.

### Returns
- **u32** - The start Y position for layer 13.
```

--------------------------------

### XQspiPsu_TXRXSetup()

Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/qspipsu/doc/html/api/globals_func.html

Sets up both transmit and receive for a transfer.

```APIDOC
## XQspiPsu_TXRXSetup()

### Description
Sets up both transmit and receive for a transfer.

### Source File
xqspipsu_hw.c

### Parameters
- **InstancePtr** (XQspiPsu*) - Required - Pointer to the QSPIPSU driver instance.

### Returns
- **void** - None.

```
Tokens:
Raw