xilloader
Vitis Drivers API Documentation
xloader_client.c File Reference

Overview

This file contains the implementation of the client interface functions.

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_CfiSelectiveReadback, XLoader_InputSlrIndex functions pre 10/26/24 Removed XLoader_LoadReadBackPdi API

 

Macros

#define XLOADER_ADDR_HIGH_SHIFT   (32U)
 Shift value to get higher 32 bit address. More...
 
#define XLOADER_MSB_MASK   (0x80000000)
 Mask for MSB bit. More...
 
#define XLOADER_SELREADBACK_ROW_START_POS   (23U)
 Row field start bit position. More...
 
#define XLOADER_SELREADBACK_BLKTYPE_START_POS   (20U)
 Block type field start bit position. More...
 
#define XLOADER_SELREADBACK_ROW_MASK   (0x7800000U)
 Mask for row. More...
 
#define XLOADER_SLEREADBACK_BLKTYPE_MASK   (0X700000U)
 Mask for block type. More...
 
#define XLOADER_SLEREADBACK_FRAMEADDR_MASK   (0xFFFFFU)
 Mask for frame address. More...
 

Functions

int XLoader_LoadPartialPdi (XLoader_ClientInstance *InstancePtr, XLoader_PdiSrc PdiSrc, u64 PdiAddr, u32 *PlmErrStatus)
 This function sends IPI request to provides PDI execution. More...
 
int XLoader_LoadImage (XLoader_ClientInstance *InstancePtr, u32 NodeId, u32 FunctionId)
 This function sends IPI request to Load image. More...
 
int XLoader_GetImageInfo (XLoader_ClientInstance *InstancePtr, u32 NodeId, XLoader_ImageInfo *ImageInfo)
 This function sends IPI request to get image information. More...
 
int XLoader_GetImageInfoList (XLoader_ClientInstance *InstancePtr, u64 Buff_Addr, u32 Maxsize, u32 *NumEntries)
 This function sends IPI request to gets ImageInfo Table. More...
 
int XLoader_ExtractMetaheader (XLoader_ClientInstance *InstancePtr, u64 PdiSrcAddr, u64 DestBuffAddr, u32 DestBuffSize)
 This function sends IPI request to Extract meta header. More...
 
int XLoader_UpdateMultiboot (XLoader_ClientInstance *InstancePtr, XLoader_PdiSrc BootMode, XLoader_FlashType Type, u32 ImageLocation)
 This function sends IPI request to update multiboot. More...
 
int XLoader_AddImageStorePdi (XLoader_ClientInstance *InstancePtr, u32 PdiId, const u64 PdiAddr, u32 PdiSize)
 This function sends IPI request to add Image store pdi. More...
 
int XLoader_RemoveImageStorePdi (XLoader_ClientInstance *InstancePtr, u32 PdiId)
 This function sends IPI request to remove Image store pdi. More...
 
int XLoader_GetATFHandOffParams (XLoader_ClientInstance *InstancePtr, u64 BuffAddr, u32 Size, u32 *BufferSize)
 This function sends IPI request to get ATF Handoff parameters. More...
 
int XLoader_CfiSelectiveReadback (XLoader_ClientInstance *InstancePtr, XLoader_CfiSelReadbackParams *SelectiveReadbackPtr)
 This function sends IPI request to read selective frames from configuration memory. More...
 
int XLoader_InputSlrIndex (XLoader_ClientInstance *InstancePtr, u32 SlrIndex)
 Adds the SLR Index. More...
 
int XLoader_GetOptionalData (XLoader_ClientInstance *InstancePtr, const XLoader_OptionalDataInfo *OptionalDataInfo, u64 DestAddr, u32 *DestSize)
 This function sends IPI request to get optional data from the PDI available in DDR or Image Store. More...