### Example Design Setup for RepeaterPro Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_hdmirxss/examples/xhdmi_example/RepeaterProfessional/Readme_RepeaterProfessional_A53.txt Instructions on how to set up the RepeaterPro example design in SDK for the Xilinx HDMI RX Subsystem. ```APIDOC ## Example Design Setup for RepeaterPro ### Description This section provides step-by-step instructions to import and build the RepeaterPro example design in the SDK. ### Steps 1. **Create Placeholder File**: Navigate to `/v_hdmirxss/examples/xhdmi_example/dummy/`. Create a new file named `RepeaterPro_A53.txt` and copy the contents of the provided file into it. 2. **Modify dependencies.props**: Open the file `/v_hdmirxss/data/dependencies.props` in a text editor. Append the following line to the end of the file: ``` xhdmi_example/dummy/RepeaterPro_A53.txt=xhdmi_example/RepeaterProfessional/xhdmi_example.c,xhdmi_example/RepeaterProfessional/xhdmi_example.h,xhdmi_example/PassThrough/xhdmi_edid.h,xhdmi_example/PassThrough/xhdmi_edid.c,xhdmi_example/xhdmi_hdcp_keys_table.h,xhdmi_example/idt_8t49n24x.c,xhdmi_example/idt_8t49n24x.h,xhdmi_example/xvidframe_crc.c,xhdmi_example/xvidframe_crc.h,xhdmi_example/PassThrough/xhdmi_menu.c,xhdmi_example/PassThrough/xhdmi_menu.h,xhdmi_example/RepeaterProfessional/xhdcp.c,xhdmi_example/RepeaterProfessional/xhdcp.h,xhdmi_example/aes256.c,xhdmi_example/aes256.h,xhdmi_example/audiogen_drv.c,xhdmi_example/audiogen_drv.h,xhdmi_example/dp159.c,xhdmi_example/dp159.h,xhdmi_example/sha256.c,xhdmi_example/sha256.h,xhdmi_example/si5324drv.c,xhdmi_example/si5324drv.h,xhdmi_example/xhdmi_hdcp_keys.c,xhdmi_example/xhdmi_hdcp_keys.h,platforms/platform.c,platforms/platform.h,platforms/platform_config.h,platforms/zynq_us_a53_64/lscript.ld ``` 3. **Add to Repositories**: In the SDK GUI, navigate to Xilinx->Repositories and include the necessary drivers. 4. **Build BSP**: Build the board support package (BSP). 5. **Build Example Design**: You should now see the option to build the `RepeaterPro_A53` example design in the selection box that appears. ### Endpoint N/A (This section describes build and setup procedures) ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### GET /main Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/axiethernet/doc/html/api/xaxiethernet__example__extvlan_8c.html The main entry point for the AxiEthernet example application. This function initializes the example execution flow. ```APIDOC ## GET /main ### Description This is the main function for the Axi Ethernet example. It orchestrates the execution of the example logic and returns the status of the operation. ### Method GET ### Endpoint /main ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Request Example N/A ### Response #### Success Response (200) - **status** (int) - Returns XST_SUCCESS (0) to indicate success. #### Error Response (500) - **status** (int) - Returns XST_FAILURE (1) to indicate failure. #### Response Example { "status": 0 } ``` -------------------------------- ### DisplayPort RX Subsystem Interrupt Example Setup (C) Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp14rxss/doc/html/api/xdprxss__intr__example_8c.html Main entry point for the interrupt example of the DisplayPort RX Subsystem driver. It sets up system interrupt handlers and requires the device ID. Returns XST_FAILURE on setup failure and is blocking if successful. ```c u32 DpRxSs_IntrExample( u16 _DeviceId_ ) ``` -------------------------------- ### Get I3C Tsu Start Time (C) Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/i3c/doc/html/api/group___overview.html Retrieves the Tsu Start time from the I3C START SETUP Register. This function reads the specified register using XI3c_ReadReg and masks the result to obtain the timing value. It's essential for I3C setup timing analysis. ```c #define XI3c_GetTsuStartTime( InstancePtr ) (( (XI3c_ReadReg(InstancePtr->Config.BaseAddress, \ XI3C_TSU_START_OFFSET)) & XI3C_18BITS_MASK)) ``` -------------------------------- ### Dptx_SetupExample Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp14/doc/html/api/xdp__tx__example__common_8c.html Initializes the DisplayPort TX core using the provided device ID and instance pointer. ```APIDOC ## Dptx_SetupExample ### Description Initializes the DisplayPort TX core and retrieves configuration parameters based on the device ID. ### Method Function Call (C) ### Parameters #### Path Parameters - **InstancePtr** (XDp*) - Required - Pointer to the XDp instance data. - **DeviceId** (u16) - Required - Unique device ID of the DisplayPort TX core. ### Response #### Success Response (XST_SUCCESS) - **u32** - Returns XST_SUCCESS if configuration is found and link is established. #### Error Response (XST_FAILURE) - **u32** - Returns XST_FAILURE if initialization fails. ``` -------------------------------- ### XDsiTxSs Main Self-Test Example Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dsitxss/doc/html/api/xdsitxss__video__test__example_8c.html The main function for the XDsiTxSs self-test example. It orchestrates the execution of various test functions, including VDMA reset, setup, channel start, and waiting for completion, to verify the XDsiTxSs driver's functionality. Returns XST_SUCCESS on success, XST_FAILURE otherwise. ```c s32 main(void) { // Function implementation details... return XST_SUCCESS; } ``` -------------------------------- ### Run DisplayPort TX Example Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/xdp__tx__example__common_8c.html Configures the link and initiates the video stream transmission. This function wraps the link establishment process. ```c u32 Dptx_Run(XDp *InstancePtr) { /* Establish link and start video stream */ return Dptx_StartLink(InstancePtr); } ``` -------------------------------- ### IIC PS Repeated Start Example Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/iicps/doc/html/api/globals_func.html Details the entry point for the IIC PS repeated start condition example. ```APIDOC ## IIC PS Repeated Start Example ### Description Provides the entry point for the IIC PS repeated start condition example. ### Example - `xiicps_repeated_start_example.c` ``` -------------------------------- ### Dptx_AudioExample Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp14/doc/html/api/xdp__tx__audio__example_8c.html The main entry point for the audio example using the XDp driver, responsible for setting up audio, initiating link training, and starting the video stream. ```APIDOC ## Dptx_AudioExample ### Description This function initializes the audio subsystem, performs link training, and begins sending a video stream over the main link. ### Method N/A (C Function) ### Parameters #### Path Parameters - **InstancePtr** (XDp*) - Required - Pointer to the XDp instance data. - **DeviceId** (u16) - Required - Unique device ID of the DisplayPort TX core. ### Response - **Returns** (u32) - XST_SUCCESS if setup and link training were successful, XST_FAILURE otherwise. ``` -------------------------------- ### IIC PS Repeated Start Example Execution Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/iicps/doc/html/api/xiicps__repeated__start__example_8c.html This function executes the complete repeated start example, involving writing data to and reading data from an IIC EEPROM. It demonstrates the usage of the IIC PS driver's repeated start capability for seamless data transfer. ```c int IicPsRepeatedStartExample(void) { // ... implementation details ... // Calls EepromWriteData and EepromReadDataRepStart return XST_SUCCESS; } ``` -------------------------------- ### DpPsu_SetupExample Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dppsu/doc/html/api/xdppsu__common__example_8c.html Initializes the DisplayPort TX core using the provided device ID and instance pointer. ```APIDOC ## DpPsu_SetupExample ### Description Initializes the DisplayPort TX core and establishes the main link with the receiver. ### Method Function Call ### Parameters - **InstancePtr** (XDpPsu*) - Required - Pointer to the XDpPsu driver instance. - **DeviceId** (u16) - Required - Unique device ID of the DisplayPort TX core. ### Response - **Return** (u32) - XST_SUCCESS if initialization and link establishment succeed, XST_FAILURE otherwise. ``` -------------------------------- ### Main Function for USB Interrupt Example Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/usb/doc/html/api/xusb__microphone_8c.html The main function to start and manage the USB interrupt example. ```APIDOC ## int main ( void ) ### Description This main function starts the USB Interrupt example. ### Method int ### Endpoint N/A (Function) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (0) - XST_SUCCESS: Indicates successful execution. #### Response Example ``` XST_SUCCESS ``` ### Error Response #### Failure Response (1) - XST_FAILURE: Indicates that the test failed. ### Notes None. ``` -------------------------------- ### Initialize XDp Audio Example Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/xdp__tx__audio__example_8c.html The Dptx_AudioExample function serves as the primary entry point for setting up audio and initiating link training for the DisplayPort TX core. It requires a pointer to the XDp instance and the device ID, returning XST_SUCCESS upon successful configuration. ```c u32 Dptx_AudioExample(XDp *InstancePtr, u16 DeviceId) { /* Setup audio, initiate link training, and start video stream */ Dptx_SetupExample(InstancePtr, DeviceId); Dptx_Run(InstancePtr); return XST_SUCCESS; } ``` -------------------------------- ### MST Example Entry Point Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp14rxss/doc/html/api/xdprxss__mst__example_8c.html Main function to initialize and configure the DisplayPort RX Subsystem for MST/SST operations. ```c u32 DpRxSs_MstExample(u16 DeviceId) { /* Configuration and initialization logic for XDpRxSs */ return XST_SUCCESS; } ``` -------------------------------- ### Layer 12 - Start Y Position Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8c.html Functions to set and get the start Y position for hardware layer 12. ```APIDOC ## XV_mix_Set_HwReg_layerStartY_12 ### Description Sets the start Y position for hardware layer 12 in the XV_mix instance. ### Method Not Applicable (C function) ### Endpoint Not Applicable (C function) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Required - Pointer to the XV_mix instance. - **Data** (u32) - Required - The Y position value to set. ### Request Example ```c XV_mix_Set_HwReg_layerStartY_12(InstancePtr, 100); ``` ### Response #### Success Response (void) This function does not return a value. #### Response Example None ## XV_mix_Get_HwReg_layerStartY_12 ### Description Retrieves the value of the HWReg_layerStartY_12 hardware register. ### Method Not Applicable (C function) ### Endpoint Not Applicable (C function) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Required - Pointer to the XV_mix instance. ### Request Example ```c u32 startY = XV_mix_Get_HwReg_layerStartY_12(InstancePtr); ``` ### Response #### Success Response (u32) - **Return Value** (u32) - The current value of the HWReg_layerStartY_12 register. #### Response Example ```json 100 ``` ``` -------------------------------- ### XV_mix Layer 3 Start Y Coordinate Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8c.html Functions to set and get the starting Y coordinate for layer 3. ```APIDOC ## XV_mix Set Hardware Register for Layer 3 Start Y ### Description Sets the start Y position for layer 3 in the hardware register. ### Method void ### Endpoint N/A (Function Call) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body - **InstancePtr** (*XV_mix*) - Pointer to the XV_mix driver instance. - **Data** (*u32*) - The starting Y coordinate value to set. ### Request Example ```c XV_mix_Set_HwReg_layerStartY_3(InstancePtr, startYValue); ``` ### Response #### Success Response (200) N/A (void function) #### Response Example N/A ## XV_mix Get Hardware Register for Layer 3 Start Y ### Description Retrieves the value of the HWReg_layerStartY_3 hardware register for the specified XV_mix instance. ### Method u32 ### Endpoint N/A (Function Call) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body - **InstancePtr** (*XV_mix*) - Pointer to the XV_mix driver instance. ### Request Example ```c u32 startY = XV_mix_Get_HwReg_layerStartY_3(InstancePtr); ``` ### Response #### Success Response (200) - **Return Value** (*u32*) - The starting Y coordinate value for layer 3. #### Response Example ```json { "startY": 200 } ``` ``` -------------------------------- ### POST /XAieGbl_HwInit Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/aiengine/doc/html/api/xaiegbl_8h.html Initializes the hardware configuration using a provided configuration pointer. ```APIDOC ## POST /XAieGbl_HwInit ### Description This routine initializes the hardware configuration by processing the provided configuration data structure. ### Method POST ### Endpoint /XAieGbl_HwInit ### Parameters #### Request Body - **CfgPtr** (XAieGbl_HwCfg*) - Required - Pointer to the HW configuration data structure. ### Response #### Success Response (200) - **None** (void) - Returns no value. ``` -------------------------------- ### DP12TXSS HDCP Example API Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12txss/doc/html/api/xdptxss__hdcp__example_8c.html This section details the main functions for the DP12TXSS HDCP example, including initialization, stream setup, and the main example function. ```APIDOC ## DpTxSs_HdcpExample ### Description This function is the main entry point for the HDCP example using the XDpTxSs driver. It enables HDCP during DisplayPort TX Subsystem setup for MST/SST mode. ### Method N/A (This is a function documentation, not an API endpoint) ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) * XST_SUCCESS if DisplayPort TX Subsystem HDCP enabled successfully. #### Response Example None ## DpTxSs_PlatformInit ### Description This function initializes required platform-specific peripherals. ### Method N/A ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) * XST_SUCCESS if required peripherals are initialized and configured successfully. #### Response Example None ## DpTxSs_StreamSrc ### Description This function sets up the stream source to input to the DisplayPort TX Subsystem. ### Method N/A ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * **VerticalSplit** (u8) - Description not fully provided in source text. ### Request Example None ### Response #### Success Response (200) * Description not fully provided in source text. #### Response Example None ## main ### Description This is the main function for the XDpTxSs SST/MST example. ### Method N/A ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) * Description not fully provided in source text. #### Response Example None ``` -------------------------------- ### Initialize XQspiPs Driver Instance Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/qspips/doc/html/api/index.html Demonstrates the standard initialization sequence for the XQspiPs driver, involving looking up the configuration and initializing the driver instance. ```c XQspiPs_Config *ConfigPtr; ConfigPtr = XQspiPs_LookupConfig(DeviceId); XQspiPs_CfgInitialize(&InstancePtr, ConfigPtr, ConfigPtr->BaseAddress); ``` -------------------------------- ### Layer 3 Start Y API Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8h.html Functions to set and get the hardware register for the starting Y coordinate of layer 3. ```APIDOC ## XV_mix_Set_HwReg_layerStartY_3 ### Description Sets the start Y position for layer 3 in the hardware register. ### Method void ### Endpoint N/A (Function call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (*XV_mix*) - Pointer to the XV_mix driver instance. - **Data** (*u32*) - The starting Y coordinate value to set. ### Request Example ```c XV_mix_Set_HwReg_layerStartY_3(InstancePtr, startYValue); ``` ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## XV_mix_Get_HwReg_layerStartY_3 ### Description Retrieves the value of the HWReg_layerStartY_3 hardware register for the specified XV_mix instance. ### Method u32 ### Endpoint N/A (Function call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (*XV_mix*) - Pointer to the XV_mix driver instance. ### Request Example ```c u32 startY = XV_mix_Get_HwReg_layerStartY_3(InstancePtr); ``` ### Response #### Success Response (200) - **Return Value** (*u32*) - The current start Y coordinate value for layer 3. ``` -------------------------------- ### Layer 0 Start Y Position Configuration Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8h.html Functions to set and get the vertical start position for layer 0. ```APIDOC ## XV_mix_Set_HwReg_layerStartY_0 ### Description Sets the starting Y coordinate for layer 0 in the XV_mix hardware register. ### Method void ### Endpoint N/A (Function Call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Pointer to the XV_mix instance. - **Data** (u32) - The value to set for the layer's start Y position. ### Request Example ```c XV_mix_Set_HwReg_layerStartY_0(InstancePtr, startY_value); ``` ### Response #### Success Response (200) N/A (void function) #### Response Example None ## XV_mix_Get_HwReg_layerStartY_0 ### Description Retrieves the value of the HWReg_layerStartY_0 hardware register for the specified XV_mix instance. ### Method u32 ### Endpoint N/A (Function Call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Pointer to the XV_mix instance. ### Request Example ```c u32 startY = XV_mix_Get_HwReg_layerStartY_0(InstancePtr); ``` ### Response #### Success Response (200) - **startY** (u32) - The current value of the layer 0 start Y position register. #### Response Example ```json { "startY": 1080 } ``` ``` -------------------------------- ### main() - Multiboot Update Example Source: https://github.com/xilinx/embeddedsw/blob/master/lib/sw_services/xilloader/doc/html/api/globals_0x6d.html The main entry point for the multiboot update client example, demonstrating how to interface with the Xilloader driver for system updates. ```APIDOC ## main() ### Description This function serves as the entry point for the multiboot update client example. It initializes the necessary hardware components and executes the update sequence for the multiboot configuration. ### Method N/A (C Function) ### Parameters - **void** - None ### Request Example N/A ### Response #### Success Response (0) - **int** - Returns 0 on successful execution of the multiboot update process. #### Response Example int status = main(); ``` -------------------------------- ### Layer 0 Start Position Configuration Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8h.html Functions to set and get the horizontal start position for layer 0. ```APIDOC ## XV_mix_Set_HwReg_layerStartX_0 ### Description Sets the hardware register value for the start X position of layer 0 in the XV_mix instance. ### Method void ### Endpoint N/A (Function Call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Pointer to the XV_mix instance. - **Data** (u32) - The value to set for the layer's start X position. ### Request Example ```c XV_mix_Set_HwReg_layerStartX_0(InstancePtr, startX_value); ``` ### Response #### Success Response (200) N/A (void function) #### Response Example None ## XV_mix_Get_HwReg_layerStartX_0 ### Description Retrieves the value of the HWReg_layerStartX_0 hardware register for the specified XV_mix instance. ### Method u32 ### Endpoint N/A (Function Call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Pointer to the XV_mix instance. ### Request Example ```c u32 startX = XV_mix_Get_HwReg_layerStartX_0(InstancePtr); ``` ### Response #### Success Response (200) - **startX** (u32) - The current value of the layer 0 start X position register. #### Response Example ```json { "startX": 1920 } ``` ``` -------------------------------- ### POST /XQspiPsu_CfgInitialize Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/qspipsu/doc/html/api/group__qspipsu__api.html Initializes a specific XQspiPsu instance, preparing the driver for use. ```APIDOC ## POST /XQspiPsu_CfgInitialize ### Description Initializes a specific XQspiPsu instance as such the driver is ready to use. ### Method POST ### Endpoint XQspiPsu_CfgInitialize ### Parameters #### Path Parameters - **InstancePtr** (XQspiPsu*) - Required - Pointer to the XQspiPsu instance. - **ConfigPtr** (XQspiPsu_Config*) - Required - Reference to a structure containing information about a specific QSPIPSU device. - **EffectiveAddr** (UINTPTR) - Required - Device base address in the virtual memory address space. ### Request Example { "InstancePtr": "&Instance", "ConfigPtr": "&Config", "EffectiveAddr": "0x00000000" } ### Response #### Success Response (200) - **status** (int) - XST_SUCCESS if successful. #### Response Example { "status": "XST_SUCCESS" } ``` -------------------------------- ### Main Example Entry Point Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12txss/doc/html/api/xdptxss__hdcp__example_8c.html Main function for the XDpTxSs SST/MST example execution. ```APIDOC ## EXECUTE_EXAMPLE ### Description This is the main function for the XDpTxSs SST/MST example. It initializes the subsystem and runs the test sequence. ### Method POST ### Endpoint /api/dptxss/example/run ### Response #### Success Response (200) - **status** (string) - XST_SUCCESS if the MST/SST example passed. #### Error Response (500) - **status** (string) - XST_FAILURE if the MST/SST example was unsuccessful. ``` -------------------------------- ### Layer 14 Start Y Register Access Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8c.html Functions to set and get the start Y coordinate for layer 14 in the hardware register. ```APIDOC ## XV_mix_Set_HwReg_layerStartY_14 ### Description Sets the Y-coordinate start position for layer 14 in the hardware register. ### Method void ### Endpoint N/A (Function call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Pointer to the XV_mix instance. - **Data** (u32) - The start Y coordinate value. ### Request Example ```c XV_mix_Set_HwReg_layerStartY_14(InstancePtr, start_y_coordinate); ``` ### Response #### Success Response (200) N/A (void function) #### Response Example N/A ## XV_mix_Get_HwReg_layerStartY_14 ### Description Retrieves the value of the HWReg_layerStartY_14 hardware register for the specified XV_mix instance. ### Method u32 ### Endpoint N/A (Function call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Pointer to the XV_mix instance. ### Request Example ```c u32 start_y = XV_mix_Get_HwReg_layerStartY_14(InstancePtr); ``` ### Response #### Success Response (200) - **ReturnValue** (u32) - The start Y coordinate value. #### Response Example ```json { "ReturnValue": 200 } ``` ``` -------------------------------- ### main Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/uartpsv/doc/html/api/xuartpsv__hello__world__example_8c.html The main entry point for the hello world example application. ```APIDOC ## main ### Description Main function that triggers the execution of the UartPsvHelloWorldExample. ### Response #### Success Response (Success) - **int** - A non-negative number indicating the number of characters sent. #### Error Response (Failure) - **XST_FAILURE** (int) - Returned if the test failed. ``` -------------------------------- ### Execute XDpRxSs SST/MST Example Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp14rxss/doc/html/api/xdprxss__hdcp__example_8c.html Main entry point for running the DisplayPort RX Subsystem SST/MST demonstration. ```APIDOC ## FUNCTION: int main() ### Description This is the main function for the XDpRxSs SST/MST example, which validates the DisplayPort RX Subsystem functionality. ### Parameters - None ### Returns - **XST_SUCCESS** - If the MST/SST example passed. - **XST_FAILURE** - If the MST/SST example was unsuccessful. ### References - DpRxSs_HdcpExample() ``` -------------------------------- ### XV_mix Layer 3 Start X Coordinate Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8c.html Functions to set and get the starting X coordinate for layer 3. ```APIDOC ## XV_mix Set Hardware Register for Layer 3 Start X ### Description Sets the starting X coordinate for layer 3 in the hardware register. ### Method void ### Endpoint N/A (Function Call) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body - **InstancePtr** (*XV_mix*) - Pointer to the XV_mix driver instance. - **Data** (*u32*) - The starting X coordinate value to set. ### Request Example ```c XV_mix_Set_HwReg_layerStartX_3(InstancePtr, startXValue); ``` ### Response #### Success Response (200) N/A (void function) #### Response Example N/A ## XV_mix Get Hardware Register for Layer 3 Start X ### Description Retrieves the value of the hardware register for the start X position of layer 3. ### Method u32 ### Endpoint N/A (Function Call) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body - **InstancePtr** (*XV_mix*) - Pointer to the XV_mix driver instance. ### Request Example ```c u32 startX = XV_mix_Get_HwReg_layerStartX_3(InstancePtr); ``` ### Response #### Success Response (200) - **Return Value** (*u32*) - The starting X coordinate value for layer 3. #### Response Example ```json { "startX": 100 } ``` ``` -------------------------------- ### Implement TFT Example Main Entry Point Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/tft/doc/html/api/xtft__example_8c.html The main function serves as the entry point for the TFT example application, invoking the primary TftExample function and returning the execution status. ```c int main() { return TftExample(TFT_DEVICE_ID); } ``` -------------------------------- ### IIC PS Repeated Start Example Main Function Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/iicps/doc/html/api/xiicps__repeated__start__example_8c.html The main function that orchestrates the repeated start example for the IIC PS driver. It initializes the IIC controller and calls other functions to perform read, write, and verification operations on an IIC EEPROM. ```c int main(void) { // ... implementation details ... // Calls IicPsRepeatedStartExample return 0; } ``` -------------------------------- ### XQspiPsu Example Functions Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/qspipsu/doc/html/api/struct_x_qspi_psu.html Demonstrates specific use cases and functionalities of the QSPI controller. These examples showcase how to integrate QSPI with flash memory, handle interrupts, and perform polled operations, providing practical implementation guidance. ```c QspiPsuInterruptFlashExample(Xil_Input *InstancePtr) ``` ```c QspiPsuPolledFlashExample(Xil_Input *InstancePtr) ``` ```c QspiPsuFlashNonBlockingReadExample(Xil_Input *InstancePtr) ``` ```c QspiPsuWriteProtectFlashExample(Xil_Input *InstancePtr) ``` ```c QspiPsuConfigurePoll(Xil_Input *InstancePtr) ``` -------------------------------- ### Layer 3 Start X API Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8h.html Functions to set and get the hardware register for the starting X coordinate of layer 3. ```APIDOC ## XV_mix_Set_HwReg_layerStartX_3 ### Description Sets the starting X coordinate for layer 3 in the hardware register. ### Method void ### Endpoint N/A (Function call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (*XV_mix*) - Pointer to the XV_mix driver instance. - **Data** (*u32*) - The starting X coordinate value to set. ### Request Example ```c XV_mix_Set_HwReg_layerStartX_3(InstancePtr, startXValue); ``` ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## XV_mix_Get_HwReg_layerStartX_3 ### Description Retrieves the value of the hardware register for the start X position of layer 3. ### Method u32 ### Endpoint N/A (Function call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (*XV_mix*) - Pointer to the XV_mix driver instance. ### Request Example ```c u32 startX = XV_mix_Get_HwReg_layerStartX_3(InstancePtr); ``` ### Response #### Success Response (200) - **Return Value** (*u32*) - The current start X coordinate value for layer 3. ``` -------------------------------- ### UsbKbdExample Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/usb/doc/html/api/xusb__keyboard_8c.html Initializes and runs the USB Keyboard example on the specified hardware. ```APIDOC ## int UsbKbdExample(u16 UsbId, u16 GpioId) ### Description This function implements the USB Keyboard example, configuring the USB device and setting up the necessary GPIO interrupts for key actions. ### Method Function Call ### Parameters #### Path Parameters - **UsbId** (u16) - Required - The device ID of the USB controller. - **GpioId** (u16) - Required - The device ID of the GPIO controller used for push buttons. ### Response - **int** - Returns XST_SUCCESS if the example runs successfully, or an error code otherwise. ``` -------------------------------- ### SDI Example and Menu Files Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_sditxss/doc/html/api/files.html Documentation for files related to the Xilinx SDI Rx Subsystem example and menu implementation. ```APIDOC ## Files ### xsdi_example.c #### Description This file demonstrates how to use Xilinx SDI Rx Subsystem for standalone. ### xsdi_menu.c #### Description This file contains the Xilinx Menu implementation as used in the SDI example design. ### xsdi_menu.h #### Description This is the main header file for the Xilinx Menu implementation as used in the SDI example design. ``` -------------------------------- ### GET /XTpg_GetZPlateHStart Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/tpg/doc/html/api/group__tpg.html Retrieves the horizontal starting point for the Z-plate. ```APIDOC ## GET /XTpg_GetZPlateHStart ### Description This function gets the starting point in the ROM based sinusoidal values for the horizontal component. ### Method GET ### Endpoint XTpg_GetZPlateHStart(XTpg *InstancePtr) ### Parameters #### Path Parameters - **InstancePtr** (XTpg*) - Required - A pointer to the XTpg driver instance data structure. ### Response #### Success Response (200) - **u16** - Starting point in the ROM based sinusoidal value for the horizontal component. ``` -------------------------------- ### Initialize and Start DisplayPort Receiver Subsystem Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp14rxss/doc/html/api/xdprxss_8h.html Demonstrates the standard workflow for initializing and starting the DisplayPort Receiver Subsystem using the provided configuration. ```c XDpRxSs_Config *ConfigPtr; XDpRxSs DpRxSsInst; /* Look up configuration */ ConfigPtr = XDpRxSs_LookupConfig(DeviceId); /* Initialize the subsystem */ XDpRxSs_CfgInitialize(&DpRxSsInst, ConfigPtr, ConfigPtr->BaseAddress); /* Start the subsystem */ Status = XDpRxSs_Start(&DpRxSsInst); ``` -------------------------------- ### XV_mix: Get Layer 8 Start Y Hardware Register (C) Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8c.html Retrieves the starting Y coordinate for layer 8 from the hardware register. This function reads the current vertical starting position of layer 8. ```c u32 XV_mix_Get_HwReg_layerStartY_8(XV_mix *InstancePtr) ``` -------------------------------- ### main Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12rxss/doc/html/api/xdprxss__mst__example_8c.html Main entry point for the DisplayPort RX Subsystem SST/MST example application. ```APIDOC ## main ### Description Executes the SST/MST example application for the DisplayPort RX Subsystem. ### Method Function Call ### Endpoint main(void) ### Parameters None ### Response - **XST_SUCCESS** (int) - Returned if the MST/SST example passed. - **XST_FAILURE** (int) - Returned if the MST/SST example was unsuccessful. ``` -------------------------------- ### Layer 14 Start X Register Access Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8c.html Functions to set and get the start X coordinate for layer 14 in the XV_mix hardware register. ```APIDOC ## XV_mix_Set_HwReg_layerStartX_14 ### Description Sets the start X coordinate for layer 14 in the XV_mix hardware register. ### Method void ### Endpoint N/A (Function call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Pointer to the XV_mix instance. - **Data** (u32) - The start X coordinate value. ### Request Example ```c XV_mix_Set_HwReg_layerStartX_14(InstancePtr, start_x_coordinate); ``` ### Response #### Success Response (200) N/A (void function) #### Response Example N/A ## XV_mix_Get_HwReg_layerStartX_14 ### Description Retrieves the value of the hardware register for the start X position of layer 14. ### Method u32 ### Endpoint N/A (Function call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **InstancePtr** (XV_mix *) - Pointer to the XV_mix instance. ### Request Example ```c u32 start_x = XV_mix_Get_HwReg_layerStartX_14(InstancePtr); ``` ### Response #### Success Response (200) - **ReturnValue** (u32) - The start X coordinate value. #### Response Example ```json { "ReturnValue": 100 } ``` ``` -------------------------------- ### Initialize PCIe Driver Instance Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/pciepsu/doc/html/api/xpciepsu_8h.html Demonstrates how to look up the device configuration and initialize the driver instance using the provided configuration structure. ```c XPciePsu_Config *ConfigPtr; XPciePsu PcieInstance; // Look up configuration ConfigPtr = XPciePsu_LookupConfig(DeviceId); // Initialize the driver instance Status = XPciePsu_CfgInitialize(&PcieInstance, ConfigPtr, ConfigPtr->BaseAddress); ``` -------------------------------- ### XV_mix: Get Layer 14 Start X Coordinate Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8c.html Retrieves the value of the hardware register for the start X position of layer 14. This function reads the configured horizontal starting position for layer 14. ```c u32 XV_mix_Get_HwReg_layerStartX_14(XV_mix *InstancePtr) ``` -------------------------------- ### Main Function for Device Configuration Example (C) Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/devcfg/doc/html/api/xdevcfg__interrupt__example_8c.html The main function serves as the entry point for the Device Configuration example. It initializes the necessary components, including the interrupt controller and the device configuration driver, and then calls the interrupt example function to perform the bitstream download. It returns XST_SUCCESS upon successful execution or XST_FAILURE if an error occurs. ```c int main(void) { XScuGic IntcInstance; XDcfg DcfgInstance; XScuGic *IntcInstPtr = &IntcInstance; XDcfg *DcfgInstPtr = &DcfgInstance; int Status; /* * Initialize the interrupt controller */ Status = XScuGic_Initialize(IntcInstPtr, XPAR_PS7_SCUGIC_0_DEVICE_ID); if (Status != XST_SUCCESS) { return XST_FAILURE; } /* * Initialize the Device Configuration driver */ Status = XDcfg_CfgInitialize(DcfgInstPtr, XPAR_XDCFG_0_DEVICE_ID); if (Status != XST_SUCCESS) { return XST_FAILURE; } /* * Call the interrupt mode example function */ Status = XDcfgInterruptExample(IntcInstPtr, DcfgInstPtr, XPAR_XDCFG_0_DEVICE_ID, XPAR_XDCFG_0_INTR); return Status; } ``` -------------------------------- ### XV_mix: Get Hardware Register Layer Start X (C) Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8h.html Retrieves the hardware register value for the start X position of layer 7. This function is used to read the horizontal starting position of the layer. ```c u32 XV_mix_Get_HwReg_layerStartX_7(XV_mix *InstancePtr) ``` -------------------------------- ### main() - AES Example Entry Point Source: https://github.com/xilinx/embeddedsw/blob/master/lib/sw_services/xilsecure/doc/html/api/group__xsecure__versal__aes__example.html The main entry point for the XilSecure AES example, which initializes and executes the SecureAesExample function. ```APIDOC ## main() ### Description This function serves as the entry point for the XilSecure AES example. It invokes the SecureAesExample function to perform cryptographic operations. ### Method N/A (C Function) ### Parameters - **None** ### Returns - **XST_SUCCESS** (int) - Returned if the example executes successfully. - **ErrorCode** (int) - Returned if the example fails during execution. ### Dependencies - SecureAesExample() - XSECURE_KEY_SIZE ``` -------------------------------- ### Layer 4 Start X Configuration Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8h.html Functions to set and get the hardware register value for the horizontal start position (X coordinate) of layer 4. ```APIDOC ## XV_mix_Set_HwReg_layerStartX_4 ### Description Sets the horizontal start position (X coordinate) for layer 4 in the XV_mix hardware. ### Method void ### Endpoint XV_mix_Set_HwReg_layerStartX_4 ### Parameters #### Path Parameters - InstancePtr (XV_mix *) - Required - Pointer to the XV_mix instance. - Data (u32) - Required - The horizontal start X coordinate value to set. ### Request Example ```c XV_mix_Set_HwReg_layerStartX_4(InstancePtr, start_x_value); ``` ### Response #### Success Response (200) N/A (void function) ## XV_mix_Get_HwReg_layerStartX_4 ### Description Retrieves the hardware register value for the horizontal start position (X coordinate) of layer 4. ### Method u32 ### Endpoint XV_mix_Get_HwReg_layerStartX_4 ### Parameters #### Path Parameters - InstancePtr (XV_mix *) - Required - Pointer to the XV_mix instance. ### Request Example ```c u32 start_x = XV_mix_Get_HwReg_layerStartX_4(InstancePtr); ``` ### Response #### Success Response (200) - start_x (u32) - The current horizontal start X coordinate of layer 4. #### Response Example ```c // Example response is implicit in the return type ``` ``` -------------------------------- ### xmbox_example.c Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/mbox/doc/html/api/example.html This example demonstrates the direct usage of the XMbox driver, covering initialization and data transfer between two processors. ```APIDOC ## xmbox_example.c ### Description Contains an example on how to use the XMbox driver directly. This example shows the usage of the driver and illustrates how the mbox driver can be used to: 1. Initialize the Mailbox core. 2. Pass data between two processors. ### Method N/A (C source file example) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Further Details See [xmbox_example.c](xmbox__example_8c.html) for detailed code. ``` -------------------------------- ### xdp_tx_audio_example.c - Overview Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp12/doc/html/api/xdp__tx__audio__example_8c.html This section provides an overview of the xdp_tx_audio_example.c file, explaining its role in demonstrating audio transmission using the XDp driver in TX mode. ```APIDOC ## Overview Contains a design example using the [XDp](struct_x_dp.html "The XDp instance data. ") driver (operating in TX mode) to train the main link and to display video. In this example application, the sequence to enable audio is illustrated. **Note** This example requires an audio source such as an S/PDIF instance to be part of the hardware system. See XAPP1178 for reference. This example requires that the audio enable configuration parameter for DisplayPort be turned on when creating the hardware design. For this example to output audio, the user will need to implement initialization of the system (Dptx_PlatformInit), configuration of the audio source (Dptx_ConfigureAudioSrc) and, depending on the hardware system, will need to implement sending of an info frame (Dptx_AudioSendInfoFrame). See XAPP1178 and the IP documentation for reference. For this example to display output, after training is complete, the user will need to implement configuration of the video stream source in order to provide the DisplayPort core with input (Dptx_StreamSrc* - called in [xdp_tx_example_common.c](xdp__tx__example__common_8c.html "Contains a design example using the XDp driver (operating in TX mode). ")). See XAPP1178 for reference. The functions Dptx_PlatformInit and Dptx_StreamSrc* are declared extern in [xdp_tx_example_common.h](xdp__tx__example__common_8h.html "Contains a design example using the XDp driver (operating in TX mode). ") and are left up to the user to implement. The functions Dptx_ConfigureAudioSrc and Dptx_AudioSendInfoFrame are present in this file and are also left for the user to implement. **MODIFICATION HISTORY:** Ver Who Date Changes * * * 1.0 als 01/20/15 Initial creation. 5.1 ms 01/23/17 Added xil_printf statement in main function to ensure that "Successfully ran" and "Failed" strings are available in all examples. This is a fix for CR-965028. ``` -------------------------------- ### XV_mix: Get HWReg Layer Start X 15 (C) Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8h.html Retrieves the 32-bit value of the hardware register for the start X position of layer 15. This function allows reading the configured horizontal starting position. ```c u32 XV_mix_Get_HwReg_layerStartX_15(XV_mix *InstancePtr) ``` -------------------------------- ### XUartPs Hello World Example Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/uartps/doc/html/api/example.html Demonstrates the usage of XUartPs driver functions with a "hello world" example. ```APIDOC ## XUartPs Hello World Example ### Description Contains an example on how to use the XUartps driver directly. This example shows the usage of functions of the driver. ### Method N/A (Example code) ### Endpoint N/A (Example code) ### Parameters N/A ### Request Example N/A ### Response N/A ### Notes This file contains a design example using the XUartPs driver in polled mode. ``` -------------------------------- ### XV_mix: Get Layer 8 Start X Hardware Register (C) Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8c.html Retrieves the starting X coordinate for layer 8 from the hardware register. This function reads the current horizontal starting position of layer 8. ```c u32 XV_mix_Get_HwReg_layerStartX_8(XV_mix *InstancePtr) ``` -------------------------------- ### XV_mix: Get HWReg for Layer 10 Start X Coordinate Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/v_mix/doc/html/api/xv__mix_8h.html Retrieves the start X position for layer 10 from the hardware register. The function requires an XV_mix instance pointer and returns the current X start value. ```c u32 XV_mix_Get_HwReg_layerStartX_10(XV_mix *InstancePtr) ``` -------------------------------- ### POST /XDpTxSs_Start Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/dp14txss/doc/html/api/group__dptxss.html Starts the DisplayPort Transmitter Subsystem and initializes all associated sub-cores. ```APIDOC ## POST /XDpTxSs_Start ### Description This function starts the DisplayPort Transmitter Subsystem including all sub-cores. ### Method POST ### Endpoint XDpTxSs_Start ### Parameters #### Path Parameters - **InstancePtr** (XDpTxSs*) - Required - Pointer to the core instance. ### Response #### Success Response (200) - **u32** - Returns XST_SUCCESS if configured successfully, XST_FAILURE otherwise. ``` -------------------------------- ### Get TPG Z-Plate Horizontal Start - C Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/tpg/doc/html/api/group__tpg.html Obtains the starting point for sinusoidal values used in the horizontal component of the Z-plate pattern. It takes a pointer to the XTpg instance and returns a u16 value indicating the starting point. ```c u16 XTpg_GetZPlateHStart(XTpg *InstancePtr) { // Implementation details would be here, likely calling XTpg_ReadReg // For example: // return (u16)(XTpg_ReadReg(InstancePtr->Config.BaseAddress, XTPG_ZPLATE_HOR_CONTROL_OFFSET) & XTPG_ZPLATEHOR_START_MASK); return 0; // Placeholder } ``` -------------------------------- ### XHwicap Test App Example Source: https://github.com/xilinx/embeddedsw/blob/master/XilinxProcessorIPLib/drivers/hwicap/examples/readme.txt Demonstrates the general usage of the XHwicap driver. ```APIDOC ## xhwicap_testapp_example.c ### Description Contains an example on how to use the XHwicap driver directly. This example shows the usage of the hwicap driver. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Response Example N/A ```