[mirror_edk2.git] / MdePkg / Include / Guid / AprioriFileName.h

/** @file\r
\r
  The GUID PEI_APRIORI_FILE_NAME_GUID definition is the file\r
  name of the PEI a priori file that is stored in a firmware\r
  volume.\r
\r
  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
  @par Revision Reference: PI\r
  Version 1.00.\r
\r
**/\r
\r
#ifndef __PEI_APRIORI_FILE_NAME_H__\r
#define __PEI_APRIORI_FILE_NAME_H__\r
\r
#define PEI_APRIORI_FILE_NAME_GUID \\r
  { 0x1b45cc0a, 0x156a, 0x428a, { 0x62, 0XAF, 0x49, 0x86, 0x4d, 0xa0, 0xe6, 0xe6 } }\r
\r
\r
/**\r
   \r
  This file must be of type EFI_FV_FILETYPE_FREEFORM and must\r
  contain a single section of type EFI_SECTION_RAW. For details on\r
  firmware volumes, firmware file types, and firmware file section\r
  types.\r
\r
  @param FileNamesWithinVolume[]  An array of zero or more\r
                                  EFI_GUID type entries that\r
                                  match the file names of PEIM\r
                                  modules in the same Firmware\r
                                  Volume. The maximum number of\r
                                  entries.\r
\r
  @param NumberOfModulesInVolume  Determined by the number of\r
                                  modules in the FV.\r
  \r
**/\r
typedef struct {\r
  EFI_GUID  FileNamesWithinVolume[1];\r
// Optional list of file-names\r
} PEI_APRIORI_FILE_CONTENTS;\r
\r
extern EFI_GUID gPeiAprioriFileNameGuid;\r
\r
#endif\r
\r
Commit	Line	Data
c2f83f0a	1	/** @file\r
	2	\r
	3	The GUID PEI_APRIORI_FILE_NAME_GUID definition is the file\r
	4	name of the PEI a priori file that is stored in a firmware\r
	5	volume.\r
	6	\r
	7	Copyright (c) 2006 - 2007, Intel Corporation \r
	8	All rights reserved. This program and the accompanying materials \r
	9	are licensed and made available under the terms and conditions of the BSD License \r
	10	which accompanies this distribution. The full text of the license may be found at \r
	11	http://opensource.org/licenses/bsd-license.php \r
	12	\r
	13	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	14	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	15	\r
c2f83f0a	16	@par Revision Reference: PI\r
	17	Version 1.00.\r
	18	\r
	19	**/\r
	20	\r
	21	#ifndef __PEI_APRIORI_FILE_NAME_H__\r
	22	#define __PEI_APRIORI_FILE_NAME_H__\r
	23	\r
	24	#define PEI_APRIORI_FILE_NAME_GUID \\r
	25	{ 0x1b45cc0a, 0x156a, 0x428a, { 0x62, 0XAF, 0x49, 0x86, 0x4d, 0xa0, 0xe6, 0xe6 } }\r
	26	\r
	27	\r
	28	/**\r
	29	\r
	30	This file must be of type EFI_FV_FILETYPE_FREEFORM and must\r
	31	contain a single section of type EFI_SECTION_RAW. For details on\r
	32	firmware volumes, firmware file types, and firmware file section\r
	33	types.\r
	34	\r
	35	@param FileNamesWithinVolume[] An array of zero or more\r
	36	EFI_GUID type entries that\r
	37	match the file names of PEIM\r
	38	modules in the same Firmware\r
	39	Volume. The maximum number of\r
	40	entries.\r
	41	\r
	42	@param NumberOfModulesInVolume Determined by the number of\r
	43	modules in the FV.\r
	44	\r
	45	**/\r
	46	typedef struct {\r
	47	EFI_GUID FileNamesWithinVolume[1];\r
	48	// Optional list of file-names\r
	49	} PEI_APRIORI_FILE_CONTENTS;\r
	50	\r
	51	extern EFI_GUID gPeiAprioriFileNameGuid;\r
	52	\r
	53	#endif\r
	54	\r