plm: Add support to extract metaheader

This patch updates the existing decrypt metaheader logic to
extract metaheader from Full or Partial PDIs. This logic is
using generic XLoader_PdiInit which supports both secure and
non-secure cases.

Signed-off-by: Bharath Mulagondla <bharath.mulagondla@xilinx.com>
Acked-by: Krishna Chaitanya Patakamuri <krishna.chaitanya.patakamuri@xilinx.com>

lib/sw_services/xilloader/src/xloader.c

@@ -109,6 +109,7 @@
 *       bm   08/09/2021 Removed obsolete XLoader_PMCStateClear API
 *       bsv  08/17/2021 Code clean up
 *       rb   08/11/2021 Fix compilation warnings
+*       bm   08/24/2021 Added Extract Metaheader support
 *
 * </pre>
 *
@@ -645,7 +646,8 @@ static int XLoader_ReadAndValidateHdrs(XilPdi* PdiPtr, u32 RegVal)
 	/*
 	 * Read meta header from PDI source
 	 */
-	if (PdiPtr->PdiType == XLOADER_PDI_TYPE_FULL) {
+	if ((PdiPtr->PdiType == XLOADER_PDI_TYPE_FULL) ||
+			(PdiPtr->PdiType == XLOADER_PDI_TYPE_FULL_METAHEADER)) {
 		XilPdi_ReadBootHdr(&PdiPtr->MetaHdr);
 		/*
 		 * Print FW Rsvd fields Details
@@ -682,6 +684,11 @@ static int XLoader_ReadAndValidateHdrs(XilPdi* PdiPtr, u32 RegVal)
 		else {
 			PdiPtr->MetaHdr.FlashOfstAddr = PdiPtr->PdiAddr;
 		}
+
+		if (PdiPtr->PdiType == XLOADER_PDI_TYPE_FULL_METAHEADER) {
+			XPlmi_Out32((UINTPTR)&PdiPtr->MetaHdr.BootHdrPtr->BootHdrFwRsvd.MetaHdrOfst,
+				XPlmi_In64(PdiPtr->PdiAddr + XIH_BH_META_HDR_OFFSET));
+		}
 	}
 	else {
 		PdiPtr->ImageNum = 0U;
@@ -1578,7 +1585,8 @@ int XLoader_LoadImageInfoTbl(u64 DestAddr, u32 MaxSize, u32 *NumEntries)
 	u64 ImageInfoOffset = 0U;
 
 	if (Len > MaxLen) {
-		Len = MaxLen;
+		Status  = XLOADER_ERR_INVALID_DEST_IMGINFOTBL_SIZE;
+		goto END;
 	}
 
 	while (Count < Len) {

lib/sw_services/xilloader/src/xloader.h

@@ -83,9 +83,9 @@
 * 1.04  bm   07/16/2021 Updated XLoader_PdiInit prototype
 *       bsv  07/19/2021 Disable UART prints when invalid header is encountered
 *                       in slave boot modes
-*       bm   07/30/2021 Added Metaheader PDI type
 *       bsv  08/02/2021 Updated function return type as part of code clean up
 *       bm   08/09/2021 Removed obsolete XLoader_PMCStateClear API prototype
+*       bm   08/24/2021 Added Extract Metaheader support
 *
 * </pre>
 *
@@ -153,7 +153,7 @@ extern "C" {
 #define XLOADER_PDI_TYPE_FULL		(0x1U)
 #define XLOADER_PDI_TYPE_PARTIAL	(0x2U)
 #define XLOADER_PDI_TYPE_RESTORE	(0x3U)
-#define XLOADER_PDI_TYPE_METAHEADER	(0x4U)
+#define XLOADER_PDI_TYPE_FULL_METAHEADER 	(0x4U)
 
 /*
  * Secondary boot mode related macros
@@ -259,6 +259,22 @@ enum {
 							UsbPrivateData */
 	XLOADER_ERR_MEMSET_DFU_OBJ, /**< 0xD - Error during memset on
 							DfuObj */
+	XLOADER_ERR_INVALID_METAHDR_BUFF_SIZE, /**< 0xE- Error when buffer size given by user
+							is less than the metaheader length */
+	XLOADER_ERR_INVALID_PDI_INPUT,	/**< 0xF - Error when PDI given is not a full PDI
+							or partial PDI */
+	XLOADER_ERR_INVALID_DEST_IMGINFOTBL_SIZE, /**< 0x10 - Error when the destination
+							buffer provided to store image info
+							table is less than the current length
+							of image info table */
+	XLOADER_ERR_INVALID_METAHEADER_SRC_ADDR, /**< 0x11 - Error when invalid source address
+							is passed as a input to extract metaheader
+							command */
+	XLOADER_ERR_INVALID_METAHEADER_DEST_ADDR, /**< 0x12 - Error when invalid destination address
+							is passed as a input to extract metaheader
+							command */
+	XLOADER_ERR_INVALID_METAHEADER_OFFSET,	/**< 0x13 - Error when the metaheader offset provided
+							in full PDI is not present in DDR */
 };
 
 /* Multiboot register offset mask */

lib/sw_services/xilloader/src/xloader_auth_enc.c

@@ -49,9 +49,9 @@
 *                     XLoader_CheckAuthJtagIntStatus scheduler task
 *       har  07/15/21 Fixed doxygen warnings
 *       td   07/15/21 Fixed doxygen warnings
-*       bm   07/30/21 Updated decrypt metaheader logic to support full PDIs
 *       bsv  08/17/21 Code clean up
 *       rb   08/11/21 Fix compilation warnings
+*       bm   08/24/2021 Added Extract Metaheader support
 *
 * </pre>
 *
@@ -601,13 +601,8 @@ int XLoader_ImgHdrTblAuth(XLoader_SecureParams *SecurePtr)
 	}
 
 	/* Copy Authentication certificate */
-	if (SecurePtr->PdiPtr->PdiType == XLOADER_PDI_TYPE_METAHEADER) {
-		AcOffset = SecurePtr->PdiPtr->MetaHdr.FlashOfstAddr + XIH_IHT_LEN;
-	}
-	else {
-		AcOffset = SecurePtr->PdiPtr->MetaHdr.FlashOfstAddr +
-				((u64)(ImgHdrTbl->AcOffset) * XIH_PRTN_WORD_LEN);
-	}
+	AcOffset = SecurePtr->PdiPtr->MetaHdr.FlashOfstAddr +
+			((u64)(ImgHdrTbl->AcOffset) * XIH_PRTN_WORD_LEN);
 
 	Status = SecurePtr->PdiPtr->MetaHdr.DeviceCopy(AcOffset,
 		(UINTPTR)SecurePtr->AcPtr, XLOADER_AUTH_CERT_MIN_SIZE, 0U);
@@ -738,17 +733,6 @@ int XLoader_ReadAndVerifySecureHdrs(XLoader_SecureParams *SecurePtr,
 		/* Read headers to a buffer */
 		/* Read IHT and PHT to buffers along with encryption overhead */
 		TotalSize =  MetaHdr->ImgHdrTbl.TotalHdrLen * XIH_PRTN_WORD_LEN;
-		if (SecurePtr->PdiPtr->PdiType == XLOADER_PDI_TYPE_METAHEADER) {
-			if (SecurePtr->IsAuthenticated == (u8)TRUE) {
-				ImgHdrAddr = ((MetaHdr->ImgHdrTbl.ImgHdrAddr -
-					MetaHdr->ImgHdrTbl.AcOffset) *
-					XIH_PRTN_WORD_LEN) + XIH_IHT_LEN;
-			}
-			else {
-				ImgHdrAddr = XIH_IHT_LEN;
-			}
-		}
-
 		if ((SecurePtr->IsAuthenticated == (u8)TRUE) ||
 			(SecurePtr->IsAuthenticatedTmp == (u8)TRUE)) {
 			XPlmi_Printf(DEBUG_INFO, "Authentication is enabled\n\r");

lib/sw_services/xilloader/src/xloader_cmd.c

@@ -46,6 +46,7 @@
 * 1.06  bm   07/16/2021 Added decrypt metaheader support
 *       bm   07/30/2021 Updated decrypt metaheader logic to support full PDIs
 *       kpt  08/22/2021 Added redundancy to XLoader_CheckIpiAccess
+*       bm   08/24/2021 Updated decrypt metaheader command to extract metaheader
 *
 * </pre>
 *
@@ -101,6 +102,11 @@ static XPlmi_Module XPlmi_Loader;
 #define XLOADER_CMD_MULTIBOOT_IMG_LOCATION_INDEX	(1U)
 #define XLOADER_CMD_IMGSTORE_PDIADDR_HIGH_INDEX		(0U)
 #define XLOADER_CMD_IMGSTORE_PDIADDR_LOW_INDEX		(1U)
+#define XLOADER_CMD_EXTRACT_METAHDR_PDIADDR_HIGH_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_RESP_CMD_EXEC_STATUS_INDEX	(0U)
 #define XLOADER_RESP_CMD_FEATURES_CMD_SUPPORTED	(1U)
 #define XLOADER_RESP_CMD_READBACK_PROCESSED_LEN_INDEX	(1U)
@@ -127,7 +133,7 @@ static XPlmi_Module XPlmi_Loader;
 #define XLOADER_IMG_HDR_TBL_EXPORT_MASK0	(0x00021F7FU)
 #define XLOADER_IMG_HDR_EXPORT_MASK0	(0x00003FFBU)
 #define XLOADER_PRTN_HDR_EXPORT_MASK0	(0x00001DFFU)
-#define XLOADER_META_HDR_LEN_OFFSET	(0x30U)
+#define XLOADER_DDR_LOW_END_ADDR	(0x7FFFFFFFU)
 
 /************************** Function Prototypes ******************************/
 
@@ -679,34 +685,75 @@ static void XLoader_GetExportableBuffer(u32 *Buffer, u32 Mask, u32 Size)
  * @return	XST_SUCCESS on success and error code on failure
  *
  *****************************************************************************/
-static int XLoader_DecryptMetaheader(XPlmi_Cmd *Cmd)
+static int XLoader_ExtractMetaheader(XPlmi_Cmd *Cmd)
 {
 	int Status = XST_FAILURE;
 	XilPdi* PdiPtr = &SubsystemPdiIns;
-	u64 SrcAddr = (u64)Cmd->Payload[0U];
-	u64 DestAddr = (u64)Cmd->Payload[3U];
-	u32 SrcSize = (u32)Cmd->Payload[2U];
-	u32 DestSize = (u32)Cmd->Payload[5U];
-	u32 DataSize = 0U;
-	u32 Index = 0U;
+	u64 SrcAddr = (u64)Cmd->Payload[XLOADER_CMD_EXTRACT_METAHDR_PDIADDR_HIGH_INDEX];
+	u64 DestAddr = (u64)Cmd->Payload[XLOADER_CMD_EXTRACT_METAHDR_DESTADDR_HIGH_INDEX];
+	u32 DestSize = (u32)Cmd->Payload[XLOADER_CMD_EXTRACT_METAHDR_DEST_SIZE_INDEX];
+	u32 IdString;
+	u32 DataSize;
+	u64 MetaHdrOfst;
+	u32 Index;
 
 	XPlmi_SetPlmMode(XPLMI_MODE_CONFIGURATION);
-	SrcAddr = ((u64)Cmd->Payload[1U]) | (SrcAddr << 32U);
-	DestAddr = ((u64)Cmd->Payload[4U]) | (DestAddr << 32U);
-	DataSize = XPlmi_In64(SrcAddr + XLOADER_META_HDR_LEN_OFFSET);
-	DataSize *= XPLMI_WORD_LEN;
-	if ((SrcSize < DataSize) || (DestSize < DataSize)) {
-		Status = XPlmi_UpdateStatus(
-				XLOADER_ERR_INVALID_METAHDR_BUFF_SIZE, 0);
+	SrcAddr = ((u64)Cmd->Payload[XLOADER_CMD_EXTRACT_METAHDR_PDIADDR_LOW_INDEX]) |
+			(SrcAddr << 32U);
+	DestAddr = ((u64)Cmd->Payload[XLOADER_CMD_EXTRACT_METAHDR_DESTADDR_LOW_INDEX]) |
+			(DestAddr << 32U);
+
+	IdString = XPlmi_In64(SrcAddr + XIH_BH_IMAGE_IDENT_OFFSET);
+	if (IdString == XIH_BH_IMAGE_IDENT) {
+		PdiPtr->PdiType = XLOADER_PDI_TYPE_FULL_METAHEADER;
+	}
+	else {
+		IdString = XPlmi_In64(SrcAddr + SMAP_BUS_WIDTH_LENGTH +
+				XIH_IHT_IDENT_STRING_OFFSET);
+		if (IdString == XIH_IHT_PPDI_IDENT_VAL) {
+			PdiPtr->PdiType = XLOADER_PDI_TYPE_PARTIAL;;
+		}
+		else {
+			Status = XLOADER_ERR_INVALID_PDI_INPUT;
+			goto END;
+		}
+	}
+
+	Status = XPlmi_VerifyAddrRange(SrcAddr, SrcAddr + (XPLMI_WORD_LEN - 1U));
+	if (Status != XST_SUCCESS) {
+		Status = XLOADER_ERR_INVALID_METAHEADER_SRC_ADDR;
+		goto END;
+	}
+
+	/* Check if Metaheader offset is pointing to a valid location */
+	if (PdiPtr->PdiType == XLOADER_PDI_TYPE_FULL_METAHEADER) {
+		MetaHdrOfst = SrcAddr + (u64)XPlmi_In64(SrcAddr +
+				XIH_BH_META_HDR_OFFSET);
+		if ((MetaHdrOfst > XLOADER_DDR_LOW_END_ADDR) &&
+			(MetaHdrOfst <= (u64)XPAR_PSV_OCM_RAM_0_S_AXI_HIGHADDR)) {
+			Status = XLOADER_ERR_INVALID_METAHEADER_OFFSET;
+			goto END;
+		}
+	}
+
+	Status = XPlmi_VerifyAddrRange(DestAddr, DestAddr + DestSize - 1U);
+	if (Status != XST_SUCCESS) {
+		Status = XLOADER_ERR_INVALID_METAHEADER_DEST_ADDR;
 		goto END;
 	}
 
-	PdiPtr->PdiType = XLOADER_PDI_TYPE_METAHEADER;
 	PdiPtr->IpiMask = Cmd->IpiMask;
-	/* Decrypt Metaheader by using PdiInit */
+	/* Extract Metaheader using PdiInit */
 	XSECURE_TEMPORAL_CHECK(END, Status, XLoader_PdiInit, PdiPtr,
 			XLOADER_PDI_SRC_DDR, SrcAddr);
 
+	DataSize = (PdiPtr->MetaHdr.ImgHdrTbl.TotalHdrLen * XPLMI_WORD_LEN) +
+			XIH_IHT_LEN;
+	if (DestSize < DataSize) {
+		Status = XLOADER_ERR_INVALID_METAHDR_BUFF_SIZE;
+		goto END;
+	}
+
 	/* Zeroize non-exportable fields of image header table */
 	XLoader_GetExportableBuffer((u32 *)&PdiPtr->MetaHdr.ImgHdrTbl,
 		XLOADER_IMG_HDR_TBL_EXPORT_MASK0, XIH_IHT_LEN);
@@ -744,7 +791,7 @@ static int XLoader_DecryptMetaheader(XPlmi_Cmd *Cmd)
 	if (Status != XST_SUCCESS) {
 		goto END;
 	}
-	XPlmi_Printf(DEBUG_GENERAL, "Decrypted Metaheader Successfully\n\r");
+	XPlmi_Printf(DEBUG_GENERAL, "Extracted Metaheader Successfully\n\r");
 
 END:
 	XPlmi_Out32(PMC_GLOBAL_DONE, XLOADER_PDI_LOAD_COMPLETE);
@@ -814,7 +861,7 @@ static const XPlmi_ModuleCmd XLoader_Cmds[] =
 	XPLMI_MODULE_COMMAND(XLoader_GetImageInfo),
 	XPLMI_MODULE_COMMAND(XLoader_SetImageInfo),
 	XPLMI_MODULE_COMMAND(XLoader_GetImageInfoList),
-	XPLMI_MODULE_COMMAND(XLoader_DecryptMetaheader),
+	XPLMI_MODULE_COMMAND(XLoader_ExtractMetaheader),
 	XPLMI_MODULE_COMMAND(XLoader_LoadReadBackPdi),
 	XPLMI_MODULE_COMMAND(XLoader_UpdateMultiboot),
 	XPLMI_MODULE_COMMAND(XLoader_AddImageStorePdi),

lib/sw_services/xilpdi/src/xilpdi.h

@@ -47,6 +47,7 @@
 *       har  03/31/2021 Added PdiId in XilPdi_ImgHdrTbl structure
 * 1.06  td   07/08/2021 Fix doxygen warnings
 *       bsv  08/16/2021 Code clean up
+*       bm   08/24/2021 Added Extract Metaheader support
 *
 * </pre>
 *
@@ -78,6 +79,17 @@ extern "C" {
 #define XIH_MIN_IMGS			(1U)
 #define XIH_MAX_IMGS			(32U)
 
+/**
+ * Boot header identification string
+ */
+#define XIH_BH_IMAGE_IDENT		(0x584C4E58U) /**< XLNX pattern */
+#define XIH_BH_IMAGE_IDENT_OFFSET	(0x14U)
+
+/**
+ * Offset to the metaheader offset field present in boot header
+ */
+#define XIH_BH_META_HDR_OFFSET		(0xC4U)
+
 /**
  * Boot header address in PRAM copied by ROM
  */
@@ -131,6 +143,12 @@ extern "C" {
 
 #define XIH_IHT_EXT_IDCODE_MASK			(0x3FU)
 
+/*
+ * IHT Identification string
+ */
+#define XIH_IHT_IDENT_STRING_OFFSET		(0x28U)
+#define XIH_IHT_PPDI_IDENT_VAL			(0x50504449U)
+
 /**
  * Secondary Boot Device (SBD) in IHT Attributes
  */

lib/sw_services/xilplmi/src/xplmi_status.h

@@ -85,7 +85,6 @@
 *       bm   07/12/2021 Added error code for setting IRO frequency
 *       bsv  07/16/2021 Fix doxygen warnings
 *       bsv  07/16/2021 Added Macronix flash support
-*       bm   07/16/2021 Added error code for decrypt metaheader
 *       bm   08/09/2021 Cleared PMC CDO buffer by default after processing
 *       bsv  08/17/2021 Code clean up
 *
@@ -517,8 +516,6 @@ typedef enum {
 	XLOADER_ERR_REQUEST_BOOT_DEVICE,	/**< 0x368 - Failed to Request Boot Device */
 	XLOADER_ERR_RELEASE_BOOT_DEVICE,	/**< 0x369 - Failed to Release Boot Device */
 	XLOADER_ERR_OSPI_DUAL_BYTE_OP_DISABLE,	/**< 0x36A - Failed to disable DUAL BYTE OP */
-	XLOADER_ERR_INVALID_METAHDR_BUFF_SIZE, /**< 0x36B - Error when buffer size given by user
-							is less than the metaheader length */
 
 	/**< Security Major error codes */
 	XLOADER_ERR_INIT_GET_DMA = 0x600,