xloader_client.h File Reference

Overview

This file Contains the client function prototypes, defines and macros.

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_SLR_INDEX_SHIFT   (6U)
	< shift constant to place slr id More...
#define	XLOADER_SLR_INDEX_0   (0U)
	SLR Index 0. More...
#define	XLOADER_SLR_INDEX_1   (1U)
	SLR Index 1. More...
#define	XLOADER_SLR_INDEX_2   (2U)
	SLR Index 2. More...
#define	XLOADER_SLR_INDEX_3   (3U)
	SLR Index 3. More...
#define	XLOADER_PDI_SRC_DDR   (0xF)
	Source of PDI is DDR. More...
#define	XLOADER_PDI_SRC_IS   (0x10)
	Source of PDI is Image Store. More...

Enumerations
enum	XLoader_PdiSrc {   XLOADER_PDI_JTAG = 0, XLOADER_PDI_QSPI24, XLOADER_PDI_QSPI32, XLOADER_PDI_SD0,   XLOADER_PDI_EMMC0, XLOADER_PDI_SD1, XLOADER_PDI_EMMC1, XLOADER_PDI_USB,   XLOADER_PDI_OSPI, XLOADER_PDI_SBI, XLOADER_PDI_SMAP = 0xAU, XLOADER_PDI_PCIE,   XLOADER_PDI_SD1_LS = 0XEU, XLOADER_PDI_DDR = 0xFU, XLOADER_PDI_IS = 0x10U, XLOADER_PDI_INVALID = 0xFFU }
enum	XLoader_FlashType { XLOADER_FLASH_RAW = 0, XLOADER_FLASH_FS, XLOADER_FLASH_RAW_BP1, XLOADER_FLASH_RAW_BP2 }

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...

Macro Definition Documentation

#define XLOADER_PDI_SRC_DDR   (0xF)

Source of PDI is DDR.

Referenced by XLoader_DdrRelease(), XLoader_DumpDdrmcRegisters(), XLoader_GetOptionalData(), XLoader_InitPdiInstanceForExtractMHAndOptData(), XLoader_LoadLpdAndPsmElf(), and XLoader_RestartImage().

#define XLOADER_PDI_SRC_IS   (0x10)

Source of PDI is Image Store.

Referenced by XLoader_GetOptionalData().

#define XLOADER_SLR_INDEX_0   (0U)

SLR Index 0.

Referenced by main().

#define XLOADER_SLR_INDEX_1   (1U)

SLR Index 1.

#define XLOADER_SLR_INDEX_2   (2U)

SLR Index 2.

#define XLOADER_SLR_INDEX_3   (3U)

SLR Index 3.

Referenced by XLoader_InputSlrIndex().

#define XLOADER_SLR_INDEX_SHIFT   (6U)

< shift constant to place slr id

SlrIndexs constants

Referenced by XLoader_CfiSelectiveReadback().

Enumeration Type Documentation

enum XLoader_FlashType

Enumerator
XLOADER_FLASH_RAW	0
XLOADER_FLASH_FS	1
XLOADER_FLASH_RAW_BP1	2
XLOADER_FLASH_RAW_BP2	3

enum XLoader_PdiSrc

Enumerator
XLOADER_PDI_JTAG	0U PDI source JTAG
XLOADER_PDI_QSPI24	1U PDI source QSPI24
XLOADER_PDI_QSPI32	2U PDI source QSPI32
XLOADER_PDI_SD0	3U PDI source SD0
XLOADER_PDI_EMMC0	4U PDI source EMMC0
XLOADER_PDI_SD1	5U PDI source SD1
XLOADER_PDI_EMMC1	6U PDI source EMMC1
XLOADER_PDI_USB	7U PDI source USB
XLOADER_PDI_OSPI	8U PDI source OSPI
XLOADER_PDI_SBI	9U PDI source SBI
XLOADER_PDI_SMAP	0xAU PDI source SMAP
XLOADER_PDI_PCIE	0xBU PDI source PCIE
XLOADER_PDI_SD1_LS	0xEU PDI source SD1-LS
XLOADER_PDI_DDR	0xFU PDI source DDR
XLOADER_PDI_IS	0x10U PDI source Image Store
XLOADER_PDI_INVALID	0xFFU PDI source invalid