[mirror_edk2.git] / EmulatorPkg / Library / SecPeiServicesLib / FwVol.c

/*++ @file\r
  A simple FV stack so the SEC can extract the SEC Core from an\r
  FV.\r
\r
Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiPei.h>\r
\r
#define GET_OCCUPIED_SIZE(ActualSize, Alignment) \\r
  (ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1))\r
\r
EFI_FFS_FILE_STATE\r
GetFileState (\r
  IN UINT8                ErasePolarity,\r
  IN EFI_FFS_FILE_HEADER  *FfsHeader\r
  )\r
\r
/*++\r
\r
Routine Description:\r
  Returns the highest bit set of the State field\r
\r
Arguments:\r
  ErasePolarity   - Erase Polarity  as defined by EFI_FVB2_ERASE_POLARITY\r
                    in the Attributes field.\r
  FfsHeader       - Pointer to FFS File Header.\r
\r
Returns:\r
  Returns the highest bit in the State field\r
\r
**/\r
{\r
  EFI_FFS_FILE_STATE  FileState;\r
  EFI_FFS_FILE_STATE  HighestBit;\r
\r
  FileState = FfsHeader->State;\r
\r
  if (ErasePolarity != 0) {\r
    FileState = (EFI_FFS_FILE_STATE) ~FileState;\r
  }\r
\r
  HighestBit = 0x80;\r
  while (HighestBit != 0 && (HighestBit & FileState) == 0) {\r
    HighestBit >>= 1;\r
  }\r
\r
  return HighestBit;\r
}\r
\r
UINT8\r
CalculateHeaderChecksum (\r
  IN EFI_FFS_FILE_HEADER  *FileHeader\r
  )\r
\r
/*++\r
\r
Routine Description:\r
  Calculates the checksum of the header of a file.\r
\r
Arguments:\r
  FileHeader       - Pointer to FFS File Header.\r
\r
Returns:\r
  Checksum of the header.\r
\r
**/\r
{\r
  UINT8  *ptr;\r
  UINTN  Index;\r
  UINT8  Sum;\r
\r
  Sum = 0;\r
  ptr = (UINT8 *)FileHeader;\r
\r
  for (Index = 0; Index < sizeof (EFI_FFS_FILE_HEADER) - 3; Index += 4) {\r
    Sum = (UINT8)(Sum + ptr[Index]);\r
    Sum = (UINT8)(Sum + ptr[Index + 1]);\r
    Sum = (UINT8)(Sum + ptr[Index + 2]);\r
    Sum = (UINT8)(Sum + ptr[Index + 3]);\r
  }\r
\r
  for ( ; Index < sizeof (EFI_FFS_FILE_HEADER); Index++) {\r
    Sum = (UINT8)(Sum + ptr[Index]);\r
  }\r
\r
  //\r
  // State field (since this indicates the different state of file).\r
  //\r
  Sum = (UINT8)(Sum - FileHeader->State);\r
  //\r
  // Checksum field of the file is not part of the header checksum.\r
  //\r
  Sum = (UINT8)(Sum - FileHeader->IntegrityCheck.Checksum.File);\r
\r
  return Sum;\r
}\r
\r
EFI_STATUS\r
SecFfsFindNextFile (\r
  IN EFI_FV_FILETYPE          SearchType,\r
  IN EFI_PEI_FV_HANDLE        FvHandle,\r
  IN OUT EFI_PEI_FILE_HANDLE  *FileHandle\r
  )\r
\r
/*++\r
\r
Routine Description:\r
    Given the input file pointer, search for the next matching file in the\r
    FFS volume as defined by SearchType. The search starts from FileHeader inside\r
    the Firmware Volume defined by FwVolHeader.\r
\r
Arguments:\r
    SearchType - Filter to find only files of this type.\r
                 Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r
    FwVolHeader - Pointer to the FV header of the volume to search.\r
                  This parameter must point to a valid FFS volume.\r
    FileHeader  - Pointer to the current file from which to begin searching.\r
                  This pointer will be updated upon return to reflect the file\r
                  found.\r
\r
Returns:\r
    EFI_NOT_FOUND - No files matching the search criteria were found\r
    EFI_SUCCESS\r
\r
**/\r
{\r
  EFI_FFS_FILE_HEADER         *FfsFileHeader;\r
  UINT32                      FileLength;\r
  UINT32                      FileOccupiedSize;\r
  UINT32                      FileOffset;\r
  UINT64                      FvLength;\r
  UINT8                       ErasePolarity;\r
  UINT8                       FileState;\r
  EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader;\r
  EFI_FFS_FILE_HEADER         **FileHeader;\r
\r
  //\r
  // Convert the handle of FV to FV header for memory-mapped firmware volume\r
  //\r
  FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)FvHandle;\r
  FileHeader  = (EFI_FFS_FILE_HEADER **)FileHandle;\r
\r
  FvLength = FwVolHeader->FvLength;\r
  if (FwVolHeader->Attributes & EFI_FVB2_ERASE_POLARITY) {\r
    ErasePolarity = 1;\r
  } else {\r
    ErasePolarity = 0;\r
  }\r
\r
  //\r
  // If FileHeader is not specified (NULL) start with the first file in the\r
  // firmware volume.  Otherwise, start from the FileHeader.\r
  //\r
  if (*FileHeader == NULL) {\r
    FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FwVolHeader + FwVolHeader->HeaderLength);\r
  } else {\r
    //\r
    // Length is 24 bits wide so mask upper 8 bits\r
    // FileLength is adjusted to FileOccupiedSize as it is 8 byte aligned.\r
    //\r
    FileLength       = *(UINT32 *)(*FileHeader)->Size & 0x00FFFFFF;\r
    FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
    FfsFileHeader    = (EFI_FFS_FILE_HEADER *)((UINT8 *)*FileHeader + FileOccupiedSize);\r
  }\r
\r
  FileOffset = (UINT32)((UINT8 *)FfsFileHeader - (UINT8 *)FwVolHeader);\r
\r
  while (FileOffset < (FvLength - sizeof (EFI_FFS_FILE_HEADER))) {\r
    //\r
    // Get FileState which is the highest bit of the State\r
    //\r
    FileState = GetFileState (ErasePolarity, FfsFileHeader);\r
\r
    switch (FileState) {\r
      case EFI_FILE_HEADER_INVALID:\r
        FileOffset   += sizeof (EFI_FFS_FILE_HEADER);\r
        FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER));\r
        break;\r
\r
      case EFI_FILE_DATA_VALID:\r
      case EFI_FILE_MARKED_FOR_UPDATE:\r
        if (CalculateHeaderChecksum (FfsFileHeader) == 0) {\r
          FileLength       = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
          FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
\r
          if ((SearchType == FfsFileHeader->Type) || (SearchType == EFI_FV_FILETYPE_ALL)) {\r
            *FileHeader = FfsFileHeader;\r
\r
            return EFI_SUCCESS;\r
          }\r
\r
          FileOffset   += FileOccupiedSize;\r
          FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r
        } else {\r
          return EFI_NOT_FOUND;\r
        }\r
\r
        break;\r
\r
      case EFI_FILE_DELETED:\r
        FileLength       = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
        FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
        FileOffset      += FileOccupiedSize;\r
        FfsFileHeader    = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r
        break;\r
\r
      default:\r
        return EFI_NOT_FOUND;\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
EFI_STATUS\r
SecFfsFindSectionData (\r
  IN EFI_SECTION_TYPE     SectionType,\r
  IN EFI_FFS_FILE_HEADER  *FfsFileHeader,\r
  IN OUT VOID             **SectionData\r
  )\r
\r
/*++\r
\r
Routine Description:\r
    Given the input file pointer, search for the next matching section in the\r
    FFS volume.\r
\r
Arguments:\r
    SearchType    - Filter to find only sections of this type.\r
    FfsFileHeader - Pointer to the current file to search.\r
    SectionData   - Pointer to the Section matching SectionType in FfsFileHeader.\r
                     NULL if section not found\r
\r
Returns:\r
    EFI_NOT_FOUND - No files matching the search criteria were found\r
    EFI_SUCCESS\r
\r
**/\r
{\r
  UINT32                     FileSize;\r
  EFI_COMMON_SECTION_HEADER  *Section;\r
  UINT32                     SectionLength;\r
  UINT32                     ParsedLength;\r
\r
  //\r
  // Size is 24 bits wide so mask upper 8 bits.\r
  //    Does not include FfsFileHeader header size\r
  // FileSize is adjusted to FileOccupiedSize as it is 8 byte aligned.\r
  //\r
  Section   = (EFI_COMMON_SECTION_HEADER *)(FfsFileHeader + 1);\r
  FileSize  = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r
  FileSize -= sizeof (EFI_FFS_FILE_HEADER);\r
\r
  *SectionData = NULL;\r
  ParsedLength = 0;\r
  while (ParsedLength < FileSize) {\r
    if (Section->Type == SectionType) {\r
      *SectionData = (VOID *)(Section + 1);\r
      return EFI_SUCCESS;\r
    }\r
\r
    //\r
    // Size is 24 bits wide so mask upper 8 bits.\r
    // SectionLength is adjusted it is 4 byte aligned.\r
    // Go to the next section\r
    //\r
    SectionLength = *(UINT32 *)Section->Size & 0x00FFFFFF;\r
    SectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r
\r
    ParsedLength += SectionLength;\r
    Section       = (EFI_COMMON_SECTION_HEADER *)((UINT8 *)Section + SectionLength);\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
Commit	Line	Data
79e4f2a5 RN	1	/*++ @file\r
	2	A simple FV stack so the SEC can extract the SEC Core from an\r
	3	FV.\r
	4	\r
	5	Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
e3ba31da	6	SPDX-License-Identifier: BSD-2-Clause-Patent\r
79e4f2a5 RN	7	\r
	8	**/\r
	9	\r
	10	#include <PiPei.h>\r
	11	\r
79e4f2a5 RN	12	#define GET_OCCUPIED_SIZE(ActualSize, Alignment) \\r
	13	(ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1))\r
	14	\r
	15	EFI_FFS_FILE_STATE\r
	16	GetFileState (\r
	17	IN UINT8 ErasePolarity,\r
	18	IN EFI_FFS_FILE_HEADER *FfsHeader\r
	19	)\r
a550d468	20	\r
79e4f2a5 RN	21	/*++\r
	22	\r
	23	Routine Description:\r
	24	Returns the highest bit set of the State field\r
	25	\r
	26	Arguments:\r
	27	ErasePolarity - Erase Polarity as defined by EFI_FVB2_ERASE_POLARITY\r
	28	in the Attributes field.\r
	29	FfsHeader - Pointer to FFS File Header.\r
	30	\r
	31	Returns:\r
	32	Returns the highest bit in the State field\r
	33	\r
	34	**/\r
	35	{\r
	36	EFI_FFS_FILE_STATE FileState;\r
	37	EFI_FFS_FILE_STATE HighestBit;\r
	38	\r
	39	FileState = FfsHeader->State;\r
	40	\r
	41	if (ErasePolarity != 0) {\r
a550d468	42	FileState = (EFI_FFS_FILE_STATE) ~FileState;\r
79e4f2a5 RN	43	}\r
	44	\r
	45	HighestBit = 0x80;\r
	46	while (HighestBit != 0 && (HighestBit & FileState) == 0) {\r
	47	HighestBit >>= 1;\r
	48	}\r
	49	\r
	50	return HighestBit;\r
	51	}\r
	52	\r
	53	UINT8\r
	54	CalculateHeaderChecksum (\r
	55	IN EFI_FFS_FILE_HEADER *FileHeader\r
	56	)\r
a550d468	57	\r
79e4f2a5 RN	58	/*++\r
	59	\r
	60	Routine Description:\r
	61	Calculates the checksum of the header of a file.\r
	62	\r
	63	Arguments:\r
	64	FileHeader - Pointer to FFS File Header.\r
	65	\r
	66	Returns:\r
	67	Checksum of the header.\r
	68	\r
	69	**/\r
	70	{\r
a550d468 MK	71	UINT8 *ptr;\r
	72	UINTN Index;\r
	73	UINT8 Sum;\r
79e4f2a5 RN	74	\r
79e4f2a5 RN	75	Sum = 0;\r
a550d468	76	ptr = (UINT8 *)FileHeader;\r
79e4f2a5 RN	77	\r
79e4f2a5 RN	78	for (Index = 0; Index < sizeof (EFI_FFS_FILE_HEADER) - 3; Index += 4) {\r
a550d468 MK	79	Sum = (UINT8)(Sum + ptr[Index]);\r
	80	Sum = (UINT8)(Sum + ptr[Index + 1]);\r
	81	Sum = (UINT8)(Sum + ptr[Index + 2]);\r
	82	Sum = (UINT8)(Sum + ptr[Index + 3]);\r
79e4f2a5 RN	83	}\r
79e4f2a5 RN	84	\r
a550d468 MK	85	for ( ; Index < sizeof (EFI_FFS_FILE_HEADER); Index++) {\r
a550d468 MK	86	Sum = (UINT8)(Sum + ptr[Index]);\r
79e4f2a5	87	}\r
a550d468	88	\r
79e4f2a5 RN	89	//\r
	90	// State field (since this indicates the different state of file).\r
	91	//\r
a550d468	92	Sum = (UINT8)(Sum - FileHeader->State);\r
79e4f2a5 RN	93	//\r
	94	// Checksum field of the file is not part of the header checksum.\r
	95	//\r
a550d468	96	Sum = (UINT8)(Sum - FileHeader->IntegrityCheck.Checksum.File);\r
79e4f2a5 RN	97	\r
	98	return Sum;\r
	99	}\r
	100	\r
	101	EFI_STATUS\r
	102	SecFfsFindNextFile (\r
a550d468 MK	103	IN EFI_FV_FILETYPE SearchType,\r
	104	IN EFI_PEI_FV_HANDLE FvHandle,\r
	105	IN OUT EFI_PEI_FILE_HANDLE *FileHandle\r
79e4f2a5	106	)\r
a550d468	107	\r
79e4f2a5 RN	108	/*++\r
	109	\r
	110	Routine Description:\r
	111	Given the input file pointer, search for the next matching file in the\r
	112	FFS volume as defined by SearchType. The search starts from FileHeader inside\r
	113	the Firmware Volume defined by FwVolHeader.\r
	114	\r
	115	Arguments:\r
	116	SearchType - Filter to find only files of this type.\r
	117	Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r
	118	FwVolHeader - Pointer to the FV header of the volume to search.\r
	119	This parameter must point to a valid FFS volume.\r
	120	FileHeader - Pointer to the current file from which to begin searching.\r
	121	This pointer will be updated upon return to reflect the file\r
	122	found.\r
	123	\r
	124	Returns:\r
	125	EFI_NOT_FOUND - No files matching the search criteria were found\r
	126	EFI_SUCCESS\r
	127	\r
	128	**/\r
	129	{\r
a550d468 MK	130	EFI_FFS_FILE_HEADER *FfsFileHeader;\r
	131	UINT32 FileLength;\r
	132	UINT32 FileOccupiedSize;\r
	133	UINT32 FileOffset;\r
	134	UINT64 FvLength;\r
	135	UINT8 ErasePolarity;\r
	136	UINT8 FileState;\r
79e4f2a5 RN	137	EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
	138	EFI_FFS_FILE_HEADER **FileHeader;\r
	139	\r
	140	//\r
	141	// Convert the handle of FV to FV header for memory-mapped firmware volume\r
	142	//\r
a550d468	143	FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)FvHandle;\r
79e4f2a5 RN	144	FileHeader = (EFI_FFS_FILE_HEADER **)FileHandle;\r
	145	\r
	146	FvLength = FwVolHeader->FvLength;\r
	147	if (FwVolHeader->Attributes & EFI_FVB2_ERASE_POLARITY) {\r
	148	ErasePolarity = 1;\r
	149	} else {\r
	150	ErasePolarity = 0;\r
	151	}\r
a550d468	152	\r
79e4f2a5 RN	153	//\r
	154	// If FileHeader is not specified (NULL) start with the first file in the\r
	155	// firmware volume. Otherwise, start from the FileHeader.\r
	156	//\r
	157	if (*FileHeader == NULL) {\r
a550d468	158	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FwVolHeader + FwVolHeader->HeaderLength);\r
79e4f2a5 RN	159	} else {\r
	160	//\r
	161	// Length is 24 bits wide so mask upper 8 bits\r
	162	// FileLength is adjusted to FileOccupiedSize as it is 8 byte aligned.\r
	163	//\r
a550d468 MK	164	FileLength = (UINT32 )(*FileHeader)->Size & 0x00FFFFFF;\r
	165	FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
	166	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )*FileHeader + FileOccupiedSize);\r
79e4f2a5 RN	167	}\r
79e4f2a5 RN	168	\r
a550d468	169	FileOffset = (UINT32)((UINT8 )FfsFileHeader - (UINT8 )FwVolHeader);\r
79e4f2a5 RN	170	\r
	171	while (FileOffset < (FvLength - sizeof (EFI_FFS_FILE_HEADER))) {\r
	172	//\r
	173	// Get FileState which is the highest bit of the State\r
	174	//\r
	175	FileState = GetFileState (ErasePolarity, FfsFileHeader);\r
	176	\r
	177	switch (FileState) {\r
a550d468 MK	178	case EFI_FILE_HEADER_INVALID:\r
	179	FileOffset += sizeof (EFI_FFS_FILE_HEADER);\r
	180	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FfsFileHeader + sizeof (EFI_FFS_FILE_HEADER));\r
	181	break;\r
	182	\r
	183	case EFI_FILE_DATA_VALID:\r
	184	case EFI_FILE_MARKED_FOR_UPDATE:\r
	185	if (CalculateHeaderChecksum (FfsFileHeader) == 0) {\r
	186	FileLength = (UINT32 )(FfsFileHeader->Size) & 0x00FFFFFF;\r
	187	FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
	188	\r
	189	if ((SearchType == FfsFileHeader->Type) \|\| (SearchType == EFI_FV_FILETYPE_ALL)) {\r
	190	*FileHeader = FfsFileHeader;\r
	191	\r
	192	return EFI_SUCCESS;\r
	193	}\r
	194	\r
	195	FileOffset += FileOccupiedSize;\r
	196	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FfsFileHeader + FileOccupiedSize);\r
	197	} else {\r
	198	return EFI_NOT_FOUND;\r
79e4f2a5 RN	199	}\r
79e4f2a5 RN	200	\r
a550d468	201	break;\r
79e4f2a5	202	\r
a550d468 MK	203	case EFI_FILE_DELETED:\r
	204	FileLength = (UINT32 )(FfsFileHeader->Size) & 0x00FFFFFF;\r
	205	FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r
	206	FileOffset += FileOccupiedSize;\r
	207	FfsFileHeader = (EFI_FFS_FILE_HEADER )((UINT8 )FfsFileHeader + FileOccupiedSize);\r
	208	break;\r
79e4f2a5	209	\r
a550d468 MK	210	default:\r
a550d468 MK	211	return EFI_NOT_FOUND;\r
79e4f2a5 RN	212	}\r
	213	}\r
	214	\r
	215	return EFI_NOT_FOUND;\r
	216	}\r
	217	\r
	218	EFI_STATUS\r
	219	SecFfsFindSectionData (\r
a550d468 MK	220	IN EFI_SECTION_TYPE SectionType,\r
	221	IN EFI_FFS_FILE_HEADER *FfsFileHeader,\r
	222	IN OUT VOID **SectionData\r
79e4f2a5	223	)\r
a550d468	224	\r
79e4f2a5 RN	225	/*++\r
	226	\r
	227	Routine Description:\r
	228	Given the input file pointer, search for the next matching section in the\r
	229	FFS volume.\r
	230	\r
	231	Arguments:\r
	232	SearchType - Filter to find only sections of this type.\r
	233	FfsFileHeader - Pointer to the current file to search.\r
	234	SectionData - Pointer to the Section matching SectionType in FfsFileHeader.\r
	235	NULL if section not found\r
	236	\r
	237	Returns:\r
	238	EFI_NOT_FOUND - No files matching the search criteria were found\r
	239	EFI_SUCCESS\r
	240	\r
	241	**/\r
	242	{\r
a550d468 MK	243	UINT32 FileSize;\r
	244	EFI_COMMON_SECTION_HEADER *Section;\r
	245	UINT32 SectionLength;\r
	246	UINT32 ParsedLength;\r
79e4f2a5 RN	247	\r
	248	//\r
	249	// Size is 24 bits wide so mask upper 8 bits.\r
	250	// Does not include FfsFileHeader header size\r
	251	// FileSize is adjusted to FileOccupiedSize as it is 8 byte aligned.\r
	252	//\r
a550d468 MK	253	Section = (EFI_COMMON_SECTION_HEADER *)(FfsFileHeader + 1);\r
a550d468 MK	254	FileSize = (UINT32 )(FfsFileHeader->Size) & 0x00FFFFFF;\r
79e4f2a5 RN	255	FileSize -= sizeof (EFI_FFS_FILE_HEADER);\r
79e4f2a5 RN	256	\r
a550d468 MK	257	*SectionData = NULL;\r
a550d468 MK	258	ParsedLength = 0;\r
79e4f2a5 RN	259	while (ParsedLength < FileSize) {\r
79e4f2a5 RN	260	if (Section->Type == SectionType) {\r
a550d468	261	SectionData = (VOID )(Section + 1);\r
79e4f2a5 RN	262	return EFI_SUCCESS;\r
79e4f2a5 RN	263	}\r
a550d468	264	\r
79e4f2a5 RN	265	//\r
	266	// Size is 24 bits wide so mask upper 8 bits.\r
	267	// SectionLength is adjusted it is 4 byte aligned.\r
	268	// Go to the next section\r
	269	//\r
a550d468	270	SectionLength = (UINT32 )Section->Size & 0x00FFFFFF;\r
79e4f2a5 RN	271	SectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r
	272	\r
	273	ParsedLength += SectionLength;\r
a550d468	274	Section = (EFI_COMMON_SECTION_HEADER )((UINT8 )Section + SectionLength);\r
79e4f2a5 RN	275	}\r
	276	\r
	277	return EFI_NOT_FOUND;\r
	278	}\r