[mirror_edk2.git] / EdkCompatibilityPkg / Sample / Tools / Source / GenFvImage / GenFvImageLibInternal.h

/*++\r
\r
Copyright (c) 2004 - 2007, Intel Corporation. All rights reserved.<BR>\r
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
Module Name:\r
  \r
  GenFvImageLibInternal.h\r
\r
Abstract:\r
\r
  This file contains describes the private declarations for the GenFvImage Library.\r
  The basic purpose of the library is to create Firmware Volume images.\r
\r
--*/\r
\r
#ifndef _EFI_GEN_FV_IMAGE_LIB_INTERNAL_H\r
#define _EFI_GEN_FV_IMAGE_LIB_INTERNAL_H\r
\r
//\r
// Include files\r
//\r
#include "GenFvImageLib.h"\r
#include <stdlib.h>\r
#include "EfiFirmwareVolumeHeader.h"\r
\r
//\r
// Private data declarations\r
//\r
//\r
// The maximum number of block map entries supported by the library\r
//\r
#define MAX_NUMBER_OF_FV_BLOCKS 100\r
\r
//\r
// The maximum number of files in the FV supported by the library\r
//\r
#define MAX_NUMBER_OF_FILES_IN_FV       1000\r
#define MAX_NUMBER_OF_COMPONENTS_IN_FV  10\r
\r
//\r
// INF file strings\r
//\r
#define OPTIONS_SECTION_STRING            "[options]"\r
#define ATTRIBUTES_SECTION_STRING         "[attributes]"\r
#define FILES_SECTION_STRING              "[files]"\r
#define COMPONENT_SECTION_STRING          "[components]"\r
\r
#define EFI_FV_BASE_ADDRESS_STRING        "EFI_BASE_ADDRESS"\r
#define EFI_FV_FILE_NAME_STRING           "EFI_FILE_NAME"\r
#define EFI_SYM_FILE_NAME_STRING          "EFI_SYM_FILE_NAME"\r
#define EFI_NUM_BLOCKS_STRING             "EFI_NUM_BLOCKS"\r
#define EFI_BLOCK_SIZE_STRING             "EFI_BLOCK_SIZE"\r
#define EFI_FV_GUID_STRING                "EFI_FV_GUID"\r
\r
#define EFI_FVB_READ_DISABLED_CAP_STRING  "EFI_READ_DISABLED_CAP"\r
#define EFI_FVB_READ_ENABLED_CAP_STRING   "EFI_READ_ENABLED_CAP"\r
#define EFI_FVB_READ_STATUS_STRING        "EFI_READ_STATUS"\r
\r
#define EFI_FVB_WRITE_DISABLED_CAP_STRING "EFI_WRITE_DISABLED_CAP"\r
#define EFI_FVB_WRITE_ENABLED_CAP_STRING  "EFI_WRITE_ENABLED_CAP"\r
#define EFI_FVB_WRITE_STATUS_STRING       "EFI_WRITE_STATUS"\r
\r
#define EFI_FVB_LOCK_CAP_STRING           "EFI_LOCK_CAP"\r
#define EFI_FVB_LOCK_STATUS_STRING        "EFI_LOCK_STATUS"\r
\r
#define EFI_FVB_STICKY_WRITE_STRING       "EFI_STICKY_WRITE"\r
#define EFI_FVB_MEMORY_MAPPED_STRING      "EFI_MEMORY_MAPPED"\r
#define EFI_FVB_ERASE_POLARITY_STRING     "EFI_ERASE_POLARITY"\r
\r
#define EFI_FVB_ALIGNMENT_CAP_STRING      "EFI_ALIGNMENT_CAP"\r
#define EFI_FVB_ALIGNMENT_2_STRING        "EFI_ALIGNMENT_2"\r
#define EFI_FVB_ALIGNMENT_4_STRING        "EFI_ALIGNMENT_4"\r
#define EFI_FVB_ALIGNMENT_8_STRING        "EFI_ALIGNMENT_8"\r
#define EFI_FVB_ALIGNMENT_16_STRING       "EFI_ALIGNMENT_16"\r
#define EFI_FVB_ALIGNMENT_32_STRING       "EFI_ALIGNMENT_32"\r
#define EFI_FVB_ALIGNMENT_64_STRING       "EFI_ALIGNMENT_64"\r
#define EFI_FVB_ALIGNMENT_128_STRING      "EFI_ALIGNMENT_128"\r
#define EFI_FVB_ALIGNMENT_256_STRING      "EFI_ALIGNMENT_256"\r
#define EFI_FVB_ALIGNMENT_512_STRING      "EFI_ALIGNMENT_512"\r
#define EFI_FVB_ALIGNMENT_1K_STRING       "EFI_ALIGNMENT_1K"\r
#define EFI_FVB_ALIGNMENT_2K_STRING       "EFI_ALIGNMENT_2K"\r
#define EFI_FVB_ALIGNMENT_4K_STRING       "EFI_ALIGNMENT_4K"\r
#define EFI_FVB_ALIGNMENT_8K_STRING       "EFI_ALIGNMENT_8K"\r
#define EFI_FVB_ALIGNMENT_16K_STRING      "EFI_ALIGNMENT_16K"\r
#define EFI_FVB_ALIGNMENT_32K_STRING      "EFI_ALIGNMENT_32K"\r
#define EFI_FVB_ALIGNMENT_64K_STRING      "EFI_ALIGNMENT_64K"\r
\r
//\r
// Add these for PI1.0 new Attributes.\r
//\r
#define EFI_FVB_READ_LOCK_CAP_STRING            "EFI_READ_LOCK_CAP"\r
#define EFI_FVB_READ_LOCK_STATUS_STRING         "EFI_READ_LOCK_STATUS"\r
#define EFI_FVB_WRITE_LOCK_CAP_STRING           "EFI_WRITE_LOCK_CAP"\r
#define EFI_FVB_WRITE_LOCK_STATUS_STRING        "EFI_WRITE_LOCK_STATUS"\r
#define EFI_FVB2_ALIGNMENT_STRING               "EFI_FVB2_ALIGNMENT"\r
\r
#define EFI_FVB2_ALIGNMENT_1_STRING             "1"\r
#define EFI_FVB2_ALIGNMENT_2_STRING             "2"\r
#define EFI_FVB2_ALIGNMENT_4_STRING             "4"\r
#define EFI_FVB2_ALIGNMENT_8_STRING             "8"\r
#define EFI_FVB2_ALIGNMENT_16_STRING            "16"\r
#define EFI_FVB2_ALIGNMENT_32_STRING            "32"\r
#define EFI_FVB2_ALIGNMENT_64_STRING            "64"\r
#define EFI_FVB2_ALIGNMENT_128_STRING           "128"\r
#define EFI_FVB2_ALIGNMENT_256_STRING           "256"\r
#define EFI_FVB2_ALIGNMENT_512_STRING           "512"\r
#define EFI_FVB2_ALIGNMENT_1K_STRING            "1K"\r
#define EFI_FVB2_ALIGNMENT_2K_STRING            "2K"\r
#define EFI_FVB2_ALIGNMENT_4K_STRING            "4K"\r
#define EFI_FVB2_ALIGNMENT_8K_STRING            "8K"\r
#define EFI_FVB2_ALIGNMENT_16K_STRING           "16K"\r
#define EFI_FVB2_ALIGNMENT_32K_STRING           "32K"\r
#define EFI_FVB2_ALIGNMENT_64K_STRING           "64K"\r
#define EFI_FVB2_ALIGNMENT_128K_STRING          "128K"\r
#define EFI_FVB2_ALIGNMENT_256K_STRING          "256K"\r
#define EFI_FVB2_ALIGNMENT_512K_STRING          "512K"\r
#define EFI_FVB2_ALIGNMENT_1M_STRING            "1M"\r
#define EFI_FVB2_ALIGNMENT_2M_STRING            "2M"\r
#define EFI_FVB2_ALIGNMENT_4M_STRING            "4M"\r
#define EFI_FVB2_ALIGNMENT_8M_STRING            "8M"\r
#define EFI_FVB2_ALIGNMENT_16M_STRING           "16M"\r
#define EFI_FVB2_ALIGNMENT_32M_STRING           "32M"\r
#define EFI_FVB2_ALIGNMENT_64M_STRING           "64M"\r
#define EFI_FVB2_ALIGNMENT_128M_STRING          "128M"\r
#define EFI_FVB2_ALIGNMENT_256M_STRING          "256M"\r
#define EFI_FVB2_ALIGNMENT_512M_STRING          "512M"\r
#define EFI_FVB2_ALIGNMENT_1G_STRING            "1G"\r
#define EFI_FVB2_ALIGNMENT_2G_STRING            "2G"\r
\r
\r
//\r
// Component sections\r
//\r
#define EFI_NV_VARIABLE_STRING    "EFI_NV_VARIABLE"\r
#define EFI_NV_EVENT_LOG_STRING   "EFI_NV_EVENT_LOG"\r
#define EFI_NV_FTW_WORKING_STRING "EFI_NV_FTW_WORKING"\r
#define EFI_NV_FTW_SPARE_STRING   "EFI_NV_FTW_SPARE"\r
\r
#define EFI_FILE_NAME_STRING      "EFI_FILE_NAME"\r
\r
#define ONE_STRING                "1"\r
#define ZERO_STRING               "0"\r
#define TRUE_STRING               "TRUE"\r
#define FALSE_STRING              "FALSE"\r
#define NULL_STRING               "NULL"\r
\r
//\r
// Defines to calculate the offset for PEI CORE entry points\r
//\r
#define IA32_PEI_CORE_ENTRY_OFFSET  0x20\r
\r
//\r
// Defines to calculate the FIT table\r
//\r
#define IPF_FIT_ADDRESS_OFFSET  0x20\r
\r
//\r
// Defines to calculate the offset for SALE_ENTRY\r
//\r
#define IPF_SALE_ENTRY_ADDRESS_OFFSET 0x18\r
\r
//\r
// Symbol file definitions, current max size if 512K\r
//\r
#define SYMBOL_FILE_SIZE  0x80000\r
\r
#define FV_IMAGES_TOP_ADDRESS             0x100000000\r
\r
//\r
// Private data types\r
//\r
//\r
// Component information\r
//\r
typedef struct {\r
  UINTN Size;\r
  CHAR8 ComponentName[_MAX_PATH];\r
} COMPONENT_INFO;\r
\r
//\r
// FV information holder\r
//\r
typedef struct {\r
  EFI_PHYSICAL_ADDRESS    BaseAddress;\r
  EFI_GUID                FvGuid;\r
  UINTN                   Size;\r
  CHAR8                   FvName[_MAX_PATH];\r
  CHAR8                   SymName[_MAX_PATH];\r
  EFI_FV_BLOCK_MAP_ENTRY  FvBlocks[MAX_NUMBER_OF_FV_BLOCKS];\r
  EFI_FVB_ATTRIBUTES      FvAttributes;\r
  CHAR8                   FvFiles[MAX_NUMBER_OF_FILES_IN_FV][_MAX_PATH];\r
  COMPONENT_INFO          FvComponents[MAX_NUMBER_OF_COMPONENTS_IN_FV];\r
} FV_INFO;\r
\r
//\r
// Private function prototypes\r
//\r
EFI_STATUS\r
ParseFvInf (\r
  IN MEMORY_FILE  *InfFile,\r
  IN FV_INFO      *FvInfo\r
  );\r
\r
#endif\r
Commit	Line	Data
3eb9473e	1	/*++\r
3eb9473e	2	\r
4b1e1121 HT	3	Copyright (c) 2004 - 2007, Intel Corporation. All rights reserved.<BR>\r
4b1e1121 HT	4	This program and the accompanying materials \r
3eb9473e	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	Module Name:\r
	13	\r
	14	GenFvImageLibInternal.h\r
	15	\r
	16	Abstract:\r
	17	\r
	18	This file contains describes the private declarations for the GenFvImage Library.\r
	19	The basic purpose of the library is to create Firmware Volume images.\r
	20	\r
	21	--*/\r
	22	\r
	23	#ifndef _EFI_GEN_FV_IMAGE_LIB_INTERNAL_H\r
	24	#define _EFI_GEN_FV_IMAGE_LIB_INTERNAL_H\r
	25	\r
	26	//\r
	27	// Include files\r
	28	//\r
	29	#include "GenFvImageLib.h"\r
	30	#include <stdlib.h>\r
	31	#include "EfiFirmwareVolumeHeader.h"\r
	32	\r
	33	//\r
	34	// Private data declarations\r
	35	//\r
	36	//\r
	37	// The maximum number of block map entries supported by the library\r
	38	//\r
	39	#define MAX_NUMBER_OF_FV_BLOCKS 100\r
	40	\r
	41	//\r
	42	// The maximum number of files in the FV supported by the library\r
	43	//\r
	44	#define MAX_NUMBER_OF_FILES_IN_FV 1000\r
	45	#define MAX_NUMBER_OF_COMPONENTS_IN_FV 10\r
	46	\r
	47	//\r
	48	// INF file strings\r
	49	//\r
	50	#define OPTIONS_SECTION_STRING "[options]"\r
	51	#define ATTRIBUTES_SECTION_STRING "[attributes]"\r
	52	#define FILES_SECTION_STRING "[files]"\r
	53	#define COMPONENT_SECTION_STRING "[components]"\r
	54	\r
	55	#define EFI_FV_BASE_ADDRESS_STRING "EFI_BASE_ADDRESS"\r
	56	#define EFI_FV_FILE_NAME_STRING "EFI_FILE_NAME"\r
	57	#define EFI_SYM_FILE_NAME_STRING "EFI_SYM_FILE_NAME"\r
	58	#define EFI_NUM_BLOCKS_STRING "EFI_NUM_BLOCKS"\r
	59	#define EFI_BLOCK_SIZE_STRING "EFI_BLOCK_SIZE"\r
	60	#define EFI_FV_GUID_STRING "EFI_FV_GUID"\r
	61	\r
	62	#define EFI_FVB_READ_DISABLED_CAP_STRING "EFI_READ_DISABLED_CAP"\r
	63	#define EFI_FVB_READ_ENABLED_CAP_STRING "EFI_READ_ENABLED_CAP"\r
	64	#define EFI_FVB_READ_STATUS_STRING "EFI_READ_STATUS"\r
	65	\r
	66	#define EFI_FVB_WRITE_DISABLED_CAP_STRING "EFI_WRITE_DISABLED_CAP"\r
	67	#define EFI_FVB_WRITE_ENABLED_CAP_STRING "EFI_WRITE_ENABLED_CAP"\r
	68	#define EFI_FVB_WRITE_STATUS_STRING "EFI_WRITE_STATUS"\r
69	\r
70	#define EFI_FVB_LOCK_CAP_STRING "EFI_LOCK_CAP"\r
71	#define EFI_FVB_LOCK_STATUS_STRING "EFI_LOCK_STATUS"\r
72	\r
73	#define EFI_FVB_STICKY_WRITE_STRING "EFI_STICKY_WRITE"\r
74	#define EFI_FVB_MEMORY_MAPPED_STRING "EFI_MEMORY_MAPPED"\r
75	#define EFI_FVB_ERASE_POLARITY_STRING "EFI_ERASE_POLARITY"\r
76	\r
77	#define EFI_FVB_ALIGNMENT_CAP_STRING "EFI_ALIGNMENT_CAP"\r
78	#define EFI_FVB_ALIGNMENT_2_STRING "EFI_ALIGNMENT_2"\r
79	#define EFI_FVB_ALIGNMENT_4_STRING "EFI_ALIGNMENT_4"\r
80	#define EFI_FVB_ALIGNMENT_8_STRING "EFI_ALIGNMENT_8"\r
81	#define EFI_FVB_ALIGNMENT_16_STRING "EFI_ALIGNMENT_16"\r
82	#define EFI_FVB_ALIGNMENT_32_STRING "EFI_ALIGNMENT_32"\r
83	#define EFI_FVB_ALIGNMENT_64_STRING "EFI_ALIGNMENT_64"\r
84	#define EFI_FVB_ALIGNMENT_128_STRING "EFI_ALIGNMENT_128"\r
85	#define EFI_FVB_ALIGNMENT_256_STRING "EFI_ALIGNMENT_256"\r
86	#define EFI_FVB_ALIGNMENT_512_STRING "EFI_ALIGNMENT_512"\r
87	#define EFI_FVB_ALIGNMENT_1K_STRING "EFI_ALIGNMENT_1K"\r
88	#define EFI_FVB_ALIGNMENT_2K_STRING "EFI_ALIGNMENT_2K"\r
89	#define EFI_FVB_ALIGNMENT_4K_STRING "EFI_ALIGNMENT_4K"\r
90	#define EFI_FVB_ALIGNMENT_8K_STRING "EFI_ALIGNMENT_8K"\r
91	#define EFI_FVB_ALIGNMENT_16K_STRING "EFI_ALIGNMENT_16K"\r
92	#define EFI_FVB_ALIGNMENT_32K_STRING "EFI_ALIGNMENT_32K"\r
93	#define EFI_FVB_ALIGNMENT_64K_STRING "EFI_ALIGNMENT_64K"\r
94	\r
95	//\r
96	// Add these for PI1.0 new Attributes.\r
97	//\r
98	#define EFI_FVB_READ_LOCK_CAP_STRING "EFI_READ_LOCK_CAP"\r
99	#define EFI_FVB_READ_LOCK_STATUS_STRING "EFI_READ_LOCK_STATUS"\r
100	#define EFI_FVB_WRITE_LOCK_CAP_STRING "EFI_WRITE_LOCK_CAP"\r
101	#define EFI_FVB_WRITE_LOCK_STATUS_STRING "EFI_WRITE_LOCK_STATUS"\r
102	#define EFI_FVB2_ALIGNMENT_STRING "EFI_FVB2_ALIGNMENT"\r
103	\r
104	#define EFI_FVB2_ALIGNMENT_1_STRING "1"\r
105	#define EFI_FVB2_ALIGNMENT_2_STRING "2"\r
106	#define EFI_FVB2_ALIGNMENT_4_STRING "4"\r
107	#define EFI_FVB2_ALIGNMENT_8_STRING "8"\r
108	#define EFI_FVB2_ALIGNMENT_16_STRING "16"\r
109	#define EFI_FVB2_ALIGNMENT_32_STRING "32"\r
110	#define EFI_FVB2_ALIGNMENT_64_STRING "64"\r
111	#define EFI_FVB2_ALIGNMENT_128_STRING "128"\r
112	#define EFI_FVB2_ALIGNMENT_256_STRING "256"\r
113	#define EFI_FVB2_ALIGNMENT_512_STRING "512"\r
114	#define EFI_FVB2_ALIGNMENT_1K_STRING "1K"\r
115	#define EFI_FVB2_ALIGNMENT_2K_STRING "2K"\r
116	#define EFI_FVB2_ALIGNMENT_4K_STRING "4K"\r
117	#define EFI_FVB2_ALIGNMENT_8K_STRING "8K"\r
118	#define EFI_FVB2_ALIGNMENT_16K_STRING "16K"\r
119	#define EFI_FVB2_ALIGNMENT_32K_STRING "32K"\r
120	#define EFI_FVB2_ALIGNMENT_64K_STRING "64K"\r
121	#define EFI_FVB2_ALIGNMENT_128K_STRING "128K"\r
122	#define EFI_FVB2_ALIGNMENT_256K_STRING "256K"\r
123	#define EFI_FVB2_ALIGNMENT_512K_STRING "512K"\r
124	#define EFI_FVB2_ALIGNMENT_1M_STRING "1M"\r
125	#define EFI_FVB2_ALIGNMENT_2M_STRING "2M"\r
126	#define EFI_FVB2_ALIGNMENT_4M_STRING "4M"\r
127	#define EFI_FVB2_ALIGNMENT_8M_STRING "8M"\r
128	#define EFI_FVB2_ALIGNMENT_16M_STRING "16M"\r
129	#define EFI_FVB2_ALIGNMENT_32M_STRING "32M"\r
130	#define EFI_FVB2_ALIGNMENT_64M_STRING "64M"\r
131	#define EFI_FVB2_ALIGNMENT_128M_STRING "128M"\r
132	#define EFI_FVB2_ALIGNMENT_256M_STRING "256M"\r
133	#define EFI_FVB2_ALIGNMENT_512M_STRING "512M"\r
134	#define EFI_FVB2_ALIGNMENT_1G_STRING "1G"\r
135	#define EFI_FVB2_ALIGNMENT_2G_STRING "2G"\r
136	\r
137	\r
138	//\r
139	// Component sections\r
140	//\r
141	#define EFI_NV_VARIABLE_STRING "EFI_NV_VARIABLE"\r
142	#define EFI_NV_EVENT_LOG_STRING "EFI_NV_EVENT_LOG"\r
143	#define EFI_NV_FTW_WORKING_STRING "EFI_NV_FTW_WORKING"\r
144	#define EFI_NV_FTW_SPARE_STRING "EFI_NV_FTW_SPARE"\r
145	\r
146	#define EFI_FILE_NAME_STRING "EFI_FILE_NAME"\r
147	\r
148	#define ONE_STRING "1"\r
149	#define ZERO_STRING "0"\r
150	#define TRUE_STRING "TRUE"\r
151	#define FALSE_STRING "FALSE"\r
152	#define NULL_STRING "NULL"\r
153	\r
154	//\r
155	// Defines to calculate the offset for PEI CORE entry points\r
156	//\r
157	#define IA32_PEI_CORE_ENTRY_OFFSET 0x20\r
158	\r
159	//\r
160	// Defines to calculate the FIT table\r
161	//\r
162	#define IPF_FIT_ADDRESS_OFFSET 0x20\r
163	\r
164	//\r
165	// Defines to calculate the offset for SALE_ENTRY\r
166	//\r
167	#define IPF_SALE_ENTRY_ADDRESS_OFFSET 0x18\r
168	\r
169	//\r
170	// Symbol file definitions, current max size if 512K\r
171	//\r
172	#define SYMBOL_FILE_SIZE 0x80000\r
173	\r
174	#define FV_IMAGES_TOP_ADDRESS 0x100000000\r
175	\r
176	//\r
177	// Private data types\r
178	//\r
179	//\r
180	// Component information\r
181	//\r
182	typedef struct {\r
183	UINTN Size;\r
184	CHAR8 ComponentName[_MAX_PATH];\r
185	} COMPONENT_INFO;\r
186	\r
187	//\r
188	// FV information holder\r
189	//\r
190	typedef struct {\r
191	EFI_PHYSICAL_ADDRESS BaseAddress;\r
192	EFI_GUID FvGuid;\r
193	UINTN Size;\r
194	CHAR8 FvName[_MAX_PATH];\r
195	CHAR8 SymName[_MAX_PATH];\r
196	EFI_FV_BLOCK_MAP_ENTRY FvBlocks[MAX_NUMBER_OF_FV_BLOCKS];\r
197	EFI_FVB_ATTRIBUTES FvAttributes;\r
198	CHAR8 FvFiles[MAX_NUMBER_OF_FILES_IN_FV][_MAX_PATH];\r
199	COMPONENT_INFO FvComponents[MAX_NUMBER_OF_COMPONENTS_IN_FV];\r
200	} FV_INFO;\r
201	\r
202	//\r
203	// Private function prototypes\r
204	//\r
205	EFI_STATUS\r
206	ParseFvInf (\r
207	IN MEMORY_FILE *InfFile,\r
208	IN FV_INFO *FvInfo\r
e00e1d46	209	);\r
3eb9473e	210	\r
3eb9473e	211	#endif\r