 |
xilloader
Vitis Drivers API Documentation
|
|
xilloader
Vitis Drivers API Documentation
|
This file contains the xilloader API IDs.
MODIFICATION HISTORY:
Ver Who Date Changes
1.00 dd 01/09/24 Initial release har 03/05/24 Fixed doxygen warnings pre 08/22/24 Added XLOADER_CFI_SEL_READBACK_ID pre 10/26/24 Made XLOADER_CMD_ID_LOAD_READBACK_PDI command ID as reserved
Macros | |
| #define | XLOADER_CMD_ID_FEATURES (0U) |
| command id for features More... | |
| #define | XLOADER_CMD_ID_LOAD_SUBSYSTEM_PDI (1U) |
| command id for load subsystem pdi More... | |
| #define | XLOADER_CMD_ID_LOAD_DDRCPY_IMG (2U) |
| command id for DDR copy image More... | |
| #define | XLOADER_CMD_ID_GET_IMAGE_INFO (3U) |
| command id for get Image info More... | |
| #define | XLOADER_CMD_ID_SET_IMAGE_INFO (4U) |
| command id for set Image info More... | |
| #define | XLOADER_CMD_ID_GET_IMAGE_INFO_LIST (5U) |
| command id for get Image info list More... | |
| #define | XLOADER_CMD_ID_EXTRACT_METAHEADER (6U) |
| command id for Extract meta header More... | |
| #define | XLOADER_CMD_ID_RESERVED (7U) |
| Reserved command id. More... | |
| #define | XLOADER_CMD_ID_UPDATE_MULTIBOOT (8U) |
| command id for update Multiboot More... | |
| #define | XLOADER_CMD_ID_ADD_IMAGESTORE_PDI (9U) |
| command id for add Imagestore pdi More... | |
| #define | XLOADER_CMD_ID_REMOVE_IMAGESTORE_PDI (10U) |
| command id for remove Imagestore pdi More... | |
| #define | XLOADER_CMD_ID_GET_ATF_HANDOFF_PARAMS (11U) |
| command id for get ATF handoff parameters More... | |
| #define | XLOADER_CMD_ID_CFRAME_DATA_CLEAR_CHECK (12U) |
| command id for Cframe data clear check More... | |
| #define | XLOADER_CMD_ID_WRITE_IMAGESTORE_PDI (13U) |
| command id for write Imagestore pdi More... | |
| #define | XLOADER_CMD_ID_CONFIG_JTAG_STATE (14U) |
| command id for config jtag state More... | |
| #define | XLOADER_CMD_ID_READ_DDR_CRYPTO_COUNTERS (15U) |
| command id for read DDR crypto counters More... | |
| #define | XLOADER_CMD_ID_I2C_HANDSHAKE (16U) |
| command id for I2C handshake More... | |
| #define | XLOADER_CFI_SEL_READBACK_ID (18U) |
| command id for CFI selective readback More... | |
| #define | XLOADER_HEADER_LEN_1 (1U) |
| Header length 1. More... | |
| #define | XLOADER_HEADER_LEN_2 (2U) |
| Header length 2. More... | |
| #define | XLOADER_HEADER_LEN_3 (3U) |
| Header length 3. More... | |
| #define | XLOADER_HEADER_LEN_4 (4U) |
| Header length 4. More... | |
| #define | XLOADER_HEADER_LEN_5 (5U) |
| Header length 5. More... | |
| #define | XLOADER_HEADER_LEN_6 (6U) |
| Header length 6. More... | |
| #define | XLOADER_ADDR_HIGH_SHIFT (32U) |
| Shift value to get higher 32 bit address. More... | |
| #define | XLOADER_GET_OPT_DATA_FLAG (0x80U) |
| Flag to indicate that Extract Metaheader request is to extract optional data only. More... | |
| #define | XLOADER_DATA_ID_SHIFT (16U) |
| Shift to get data ID from the payload of Extract metaheader command. More... | |
Payload arguments for Extract Metaheader command | |
| #define | XLOADER_CMD_EXTRACT_METAHDR_PDIADDR_HIGH_INDEX (0U) |
| < Indices for payload arguments in Extract Metaheader command More... | |
| #define | XLOADER_CMD_EXTRACT_METAHDR_PDI_ID_INDEX (0U) |
| #define | XLOADER_CMD_EXTRACT_METAHDR_PDIADDR_LOW_INDEX (1U) |
| #define | XLOADER_CMD_EXTRACT_METAHDR_DESTADDR_HIGH_INDEX (2U) |
| #define | XLOADER_CMD_EXTRACT_METAHDR_DESTADDR_LOW_INDEX (3U) |
| #define | XLOADER_CMD_EXTRACT_METAHDR_DEST_SIZE_INDEX (4U) |
| #define | XLOADER_CMD_EXTRACT_METAHDR_DATAID_PDISRC_INDEX (5U) |
| #define XLOADER_ADDR_HIGH_SHIFT (32U) |
Shift value to get higher 32 bit address.
| #define XLOADER_CFI_SEL_READBACK_ID (18U) |
command id for CFI selective readback
Referenced by XLoader_CfiSelectiveRead(), and XLoader_CfiSelectiveReadback().
| #define XLOADER_CMD_EXTRACT_METAHDR_PDIADDR_HIGH_INDEX (0U) |
< Indices for payload arguments in Extract Metaheader command
| #define XLOADER_CMD_ID_ADD_IMAGESTORE_PDI (9U) |
command id for add Imagestore pdi
Referenced by XLoader_AddImageStorePdi().
| #define XLOADER_CMD_ID_CFRAME_DATA_CLEAR_CHECK (12U) |
command id for Cframe data clear check
| #define XLOADER_CMD_ID_CONFIG_JTAG_STATE (14U) |
command id for config jtag state
Referenced by XLoader_ConfigureJtagState().
| #define XLOADER_CMD_ID_EXTRACT_METAHEADER (6U) |
command id for Extract meta header
Referenced by XLoader_ExtractMetaheader(), and XLoader_GetOptionalData().
| #define XLOADER_CMD_ID_FEATURES (0U) |
command id for features
| #define XLOADER_CMD_ID_GET_ATF_HANDOFF_PARAMS (11U) |
command id for get ATF handoff parameters
Referenced by XLoader_GetATFHandOffParams().
| #define XLOADER_CMD_ID_GET_IMAGE_INFO (3U) |
command id for get Image info
Referenced by XLoader_GetImageInfo().
| #define XLOADER_CMD_ID_GET_IMAGE_INFO_LIST (5U) |
command id for get Image info list
Referenced by XLoader_GetImageInfoList().
| #define XLOADER_CMD_ID_I2C_HANDSHAKE (16U) |
command id for I2C handshake
| #define XLOADER_CMD_ID_LOAD_DDRCPY_IMG (2U) |
command id for DDR copy image
Referenced by XLoader_LoadImage().
| #define XLOADER_CMD_ID_LOAD_SUBSYSTEM_PDI (1U) |
command id for load subsystem pdi
Referenced by XLoader_LoadPartialPdi().
| #define XLOADER_CMD_ID_READ_DDR_CRYPTO_COUNTERS (15U) |
command id for read DDR crypto counters
Referenced by XLoader_ReadDdrCryptoPerfCounters().
| #define XLOADER_CMD_ID_REMOVE_IMAGESTORE_PDI (10U) |
command id for remove Imagestore pdi
Referenced by XLoader_RemoveImageStorePdi().
| #define XLOADER_CMD_ID_RESERVED (7U) |
Reserved command id.
| #define XLOADER_CMD_ID_SET_IMAGE_INFO (4U) |
command id for set Image info
| #define XLOADER_CMD_ID_UPDATE_MULTIBOOT (8U) |
command id for update Multiboot
Referenced by XLoader_UpdateMultiboot().
| #define XLOADER_CMD_ID_WRITE_IMAGESTORE_PDI (13U) |
command id for write Imagestore pdi
| #define XLOADER_DATA_ID_SHIFT (16U) |
Shift to get data ID from the payload of Extract metaheader command.
Referenced by XLoader_GetOptionalData().
| #define XLOADER_GET_OPT_DATA_FLAG (0x80U) |
Flag to indicate that Extract Metaheader request is to extract optional data only.
Referenced by XLoader_GetOptionalData(), and XLoader_InitPdiInstanceForExtractMHAndOptData().
| #define XLOADER_HEADER_LEN_1 (1U) |
Header length 1.
Referenced by XLoader_ConfigureJtagState(), XLoader_GetImageInfo(), XLoader_ReadDdrCryptoPerfCounters(), and XLoader_RemoveImageStorePdi().
| #define XLOADER_HEADER_LEN_2 (2U) |
Header length 2.
Referenced by XLoader_LoadImage(), and XLoader_UpdateMultiboot().
| #define XLOADER_HEADER_LEN_3 (3U) |
Header length 3.
Referenced by XLoader_GetATFHandOffParams(), XLoader_GetImageInfoList(), and XLoader_LoadPartialPdi().
| #define XLOADER_HEADER_LEN_4 (4U) |
Header length 4.
Referenced by XLoader_AddImageStorePdi(), and XLoader_CfiSelectiveReadback().
| #define XLOADER_HEADER_LEN_5 (5U) |
Header length 5.
| #define XLOADER_HEADER_LEN_6 (6U) |
Header length 6.
Referenced by XLoader_ExtractMetaheader().