[mirror_edk2.git] / Tools / CodeTools / Source / GenCRC32Section / GenCRC32Section.c

/*++\r
\r
Copyright (c) 2004, 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
Module Name:\r
  \r
    GenCRC32Section.c\r
\r
Abstract:\r
\r
  This file contains functions required to generate a Firmware File System \r
  file. The code is compliant with the Tiano C Coding standards.\r
\r
--*/\r
\r
#include "GenCRC32Section.h"\r
\r
#define TOOLVERSION   "0.2"\r
\r
#define UTILITY_NAME  "GenCrc32Section"\r
\r
EFI_GUID  gEfiCrc32SectionGuid = EFI_CRC32_GUIDED_SECTION_EXTRACTION_PROTOCOL_GUID;\r
\r
EFI_STATUS\r
SignSectionWithCrc32 (\r
  IN OUT UINT8  *FileBuffer,\r
  IN OUT UINT32 *BufferSize,\r
  IN UINT32     DataSize\r
  )\r
/*++\r
        \r
Routine Description:\r
           \r
  Signs the section with CRC32 and add GUIDed section header for the \r
  signed data. data stays in same location (overwrites source data).\r
            \r
Arguments:\r
               \r
  FileBuffer  - Buffer containing data to sign\r
                \r
  BufferSize  - On input, the size of FileBuffer. On output, the size of \r
                actual section data (including added section header).              \r
\r
  DataSize    - Length of data to Sign\r
\r
  Key         - Key to use when signing. Currently only CRC32 is supported.\r
                                       \r
Returns:\r
                       \r
  EFI_SUCCESS           - Successful\r
  EFI_OUT_OF_RESOURCES  - Not enough resource to complete the operation.\r
                        \r
--*/\r
{\r
\r
  UINT32                Crc32Checksum;\r
  EFI_STATUS            Status;\r
  UINT32                TotalSize;\r
  CRC32_SECTION_HEADER  Crc32Header;\r
  UINT8                 *SwapBuffer;\r
\r
  Crc32Checksum = 0;\r
  SwapBuffer    = NULL;\r
\r
  if (DataSize == 0) {\r
    *BufferSize = 0;\r
\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = CalculateCrc32 (FileBuffer, DataSize, &Crc32Checksum);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  TotalSize = DataSize + CRC32_SECTION_HEADER_SIZE;\r
  Crc32Header.GuidSectionHeader.CommonHeader.Type     = EFI_SECTION_GUID_DEFINED;\r
  Crc32Header.GuidSectionHeader.CommonHeader.Size[0]  = (UINT8) (TotalSize & 0xff);\r
  Crc32Header.GuidSectionHeader.CommonHeader.Size[1]  = (UINT8) ((TotalSize & 0xff00) >> 8);\r
  Crc32Header.GuidSectionHeader.CommonHeader.Size[2]  = (UINT8) ((TotalSize & 0xff0000) >> 16);\r
  memcpy (&(Crc32Header.GuidSectionHeader.SectionDefinitionGuid), &gEfiCrc32SectionGuid, sizeof (EFI_GUID));\r
  Crc32Header.GuidSectionHeader.Attributes  = EFI_GUIDED_SECTION_AUTH_STATUS_VALID;\r
  Crc32Header.GuidSectionHeader.DataOffset  = CRC32_SECTION_HEADER_SIZE;\r
  Crc32Header.CRC32Checksum                 = Crc32Checksum;\r
\r
  SwapBuffer = (UINT8 *) malloc (DataSize);\r
  if (SwapBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  memcpy (SwapBuffer, FileBuffer, DataSize);\r
  memcpy (FileBuffer, &Crc32Header, CRC32_SECTION_HEADER_SIZE);\r
  memcpy (FileBuffer + CRC32_SECTION_HEADER_SIZE, SwapBuffer, DataSize);\r
\r
  //\r
  // Make sure section ends on a DWORD boundary\r
  //\r
  while ((TotalSize & 0x03) != 0) {\r
    FileBuffer[TotalSize] = 0;\r
    TotalSize++;\r
  }\r
\r
  *BufferSize = TotalSize;\r
\r
  if (SwapBuffer != NULL) {\r
    free (SwapBuffer);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
VOID\r
PrintUsage (\r
  VOID\r
  )\r
{\r
  printf ("Usage:\n");\r
  printf (UTILITY_NAME " -i \"inputfile1\" \"inputfile2\" -o \"outputfile\" \n");\r
  printf ("   -i \"inputfile\":\n ");\r
  printf ("       specifies the input files that would be signed to CRC32 Guided section.\n");\r
  printf ("   -o \"outputfile\":\n");\r
  printf ("       specifies the output file that is a CRC32 Guided section.\n");\r
}\r
\r
INT32\r
ReadFilesContentsIntoBuffer (\r
  IN      CHAR8   *argv[],\r
  IN      INT32   Start,\r
  IN OUT  UINT8   **FileBuffer,\r
  IN OUT  UINT32  *BufferSize,\r
  OUT     UINT32  *ContentSize,\r
  IN      INT32   MaximumArguments\r
  )\r
{\r
  INT32   Index;\r
  CHAR8   *FileName;\r
  FILE    *InputFile;\r
  UINT8   Temp;\r
  UINT32  Size;\r
\r
  FileName  = NULL;\r
  InputFile = NULL;\r
  Size      = 0;\r
  Index     = 0;\r
\r
  //\r
  // read all input files into one file buffer\r
  //\r
  while (argv[Start + Index][0] != '-') {\r
\r
    FileName  = argv[Start + Index];\r
    InputFile = fopen (FileName, "rb");\r
    if (InputFile == NULL) {\r
      Error (NULL, 0, 0, FileName, "failed to open input binary file");\r
      return -1;\r
    }\r
\r
    fread (&Temp, sizeof (UINT8), 1, InputFile);\r
    while (!feof (InputFile)) {\r
      (*FileBuffer)[Size++] = Temp;\r
      fread (&Temp, sizeof (UINT8), 1, InputFile);\r
    }\r
\r
    fclose (InputFile);\r
    InputFile = NULL;\r
\r
    //\r
    // Make sure section ends on a DWORD boundary\r
    //\r
    while ((Size & 0x03) != 0) {\r
      (*FileBuffer)[Size] = 0;\r
      Size++;\r
    }\r
\r
    Index++;\r
    if (Index == MaximumArguments) {\r
      break;\r
    }\r
  }\r
\r
  *ContentSize = Size;\r
  return Index;\r
}\r
\r
int\r
main (\r
  INT32 argc,\r
  CHAR8 *argv[]\r
  )\r
{\r
  FILE        *OutputFile;\r
  UINT8       *FileBuffer;\r
  UINT32      BufferSize;\r
  EFI_STATUS  Status;\r
  UINT32      ContentSize;\r
  CHAR8       *OutputFileName;\r
  INT32       ReturnValue;\r
  INT32       Index;\r
\r
  OutputFile      = NULL;\r
  FileBuffer      = NULL;\r
  ContentSize     = 0;\r
  OutputFileName  = NULL;\r
\r
  SetUtilityName (UTILITY_NAME);\r
\r
  if (argc == 1) {\r
    PrintUsage ();\r
    return -1;\r
  }\r
\r
  BufferSize  = 1024 * 1024 * 16;\r
  FileBuffer  = (UINT8 *) malloc (BufferSize * sizeof (UINT8));\r
  if (FileBuffer == NULL) {\r
    Error (NULL, 0, 0, "memory allocation failed", NULL);\r
    return -1;\r
  }\r
\r
  ZeroMem (FileBuffer, BufferSize);\r
\r
  for (Index = 0; Index < argc; Index++) {\r
    if (strcmpi (argv[Index], "-i") == 0) {\r
      ReturnValue = ReadFilesContentsIntoBuffer (\r
                      argv,\r
                      (Index + 1),\r
                      &FileBuffer,\r
                      &BufferSize,\r
                      &ContentSize,\r
                      (argc - (Index + 1))\r
                      );\r
      if (ReturnValue == -1) {\r
        Error (NULL, 0, 0, "failed to read file contents", NULL);\r
        return -1;\r
      }\r
\r
      Index += ReturnValue;\r
    }\r
\r
    if (strcmpi (argv[Index], "-o") == 0) {\r
      OutputFileName = argv[Index + 1];\r
    }\r
  }\r
\r
  OutputFile = fopen (OutputFileName, "wb");\r
  if (OutputFile == NULL) {\r
    Error (NULL, 0, 0, OutputFileName, "failed to open output binary file");\r
    free (FileBuffer);\r
    return -1;\r
  }\r
\r
  /*  \r
  //\r
  // make sure section ends on a DWORD boundary ??\r
  //\r
  while ( (Size & 0x03) != 0 ) {\r
    FileBuffer[Size] = 0;\r
    Size ++;\r
  }\r
*/\r
  Status = SignSectionWithCrc32 (FileBuffer, &BufferSize, ContentSize);\r
  if (EFI_ERROR (Status)) {\r
    Error (NULL, 0, 0, "failed to sign section", NULL);\r
    free (FileBuffer);\r
    fclose (OutputFile);\r
    return -1;\r
  }\r
\r
  ContentSize = fwrite (FileBuffer, sizeof (UINT8), BufferSize, OutputFile);\r
  if (ContentSize != BufferSize) {\r
    Error (NULL, 0, 0, "failed to write output buffer", NULL);\r
    ReturnValue = -1;\r
  } else {\r
    ReturnValue = 0;\r
  }\r
\r
  free (FileBuffer);\r
  fclose (OutputFile);\r
  return ReturnValue;\r
}\r
Commit	Line	Data
878ddf1f	1	/*++\r
	2	\r
	3	Copyright (c) 2004, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	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	GenCRC32Section.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	This file contains functions required to generate a Firmware File System \r
	19	file. The code is compliant with the Tiano C Coding standards.\r
	20	\r
	21	--*/\r
	22	\r
	23	#include "GenCRC32Section.h"\r
	24	\r
	25	#define TOOLVERSION "0.2"\r
	26	\r
	27	#define UTILITY_NAME "GenCrc32Section"\r
	28	\r
	29	EFI_GUID gEfiCrc32SectionGuid = EFI_CRC32_GUIDED_SECTION_EXTRACTION_PROTOCOL_GUID;\r
	30	\r
	31	EFI_STATUS\r
	32	SignSectionWithCrc32 (\r
	33	IN OUT UINT8 *FileBuffer,\r
	34	IN OUT UINT32 *BufferSize,\r
	35	IN UINT32 DataSize\r
	36	)\r
	37	/*++\r
	38	\r
	39	Routine Description:\r
	40	\r
	41	Signs the section with CRC32 and add GUIDed section header for the \r
	42	signed data. data stays in same location (overwrites source data).\r
	43	\r
	44	Arguments:\r
	45	\r
	46	FileBuffer - Buffer containing data to sign\r
	47	\r
	48	BufferSize - On input, the size of FileBuffer. On output, the size of \r
	49	actual section data (including added section header). \r
	50	\r
	51	DataSize - Length of data to Sign\r
	52	\r
	53	Key - Key to use when signing. Currently only CRC32 is supported.\r
	54	\r
	55	Returns:\r
	56	\r
	57	EFI_SUCCESS - Successful\r
	58	EFI_OUT_OF_RESOURCES - Not enough resource to complete the operation.\r
	59	\r
	60	--*/\r
	61	{\r
	62	\r
	63	UINT32 Crc32Checksum;\r
	64	EFI_STATUS Status;\r
65	UINT32 TotalSize;\r
66	CRC32_SECTION_HEADER Crc32Header;\r
67	UINT8 *SwapBuffer;\r
68	\r
69	Crc32Checksum = 0;\r
70	SwapBuffer = NULL;\r
71	\r
72	if (DataSize == 0) {\r
73	*BufferSize = 0;\r
74	\r
75	return EFI_SUCCESS;\r
76	}\r
77	\r
78	Status = CalculateCrc32 (FileBuffer, DataSize, &Crc32Checksum);\r
79	if (EFI_ERROR (Status)) {\r
80	return Status;\r
81	}\r
82	\r
83	TotalSize = DataSize + CRC32_SECTION_HEADER_SIZE;\r
84	Crc32Header.GuidSectionHeader.CommonHeader.Type = EFI_SECTION_GUID_DEFINED;\r
85	Crc32Header.GuidSectionHeader.CommonHeader.Size[0] = (UINT8) (TotalSize & 0xff);\r
86	Crc32Header.GuidSectionHeader.CommonHeader.Size[1] = (UINT8) ((TotalSize & 0xff00) >> 8);\r
87	Crc32Header.GuidSectionHeader.CommonHeader.Size[2] = (UINT8) ((TotalSize & 0xff0000) >> 16);\r
88	memcpy (&(Crc32Header.GuidSectionHeader.SectionDefinitionGuid), &gEfiCrc32SectionGuid, sizeof (EFI_GUID));\r
89	Crc32Header.GuidSectionHeader.Attributes = EFI_GUIDED_SECTION_AUTH_STATUS_VALID;\r
90	Crc32Header.GuidSectionHeader.DataOffset = CRC32_SECTION_HEADER_SIZE;\r
91	Crc32Header.CRC32Checksum = Crc32Checksum;\r
92	\r
93	SwapBuffer = (UINT8 *) malloc (DataSize);\r
94	if (SwapBuffer == NULL) {\r
95	return EFI_OUT_OF_RESOURCES;\r
96	}\r
97	\r
98	memcpy (SwapBuffer, FileBuffer, DataSize);\r
99	memcpy (FileBuffer, &Crc32Header, CRC32_SECTION_HEADER_SIZE);\r
100	memcpy (FileBuffer + CRC32_SECTION_HEADER_SIZE, SwapBuffer, DataSize);\r
101	\r
102	//\r
103	// Make sure section ends on a DWORD boundary\r
104	//\r
105	while ((TotalSize & 0x03) != 0) {\r
106	FileBuffer[TotalSize] = 0;\r
107	TotalSize++;\r
108	}\r
109	\r
110	*BufferSize = TotalSize;\r
111	\r
112	if (SwapBuffer != NULL) {\r
113	free (SwapBuffer);\r
114	}\r
115	\r
116	return EFI_SUCCESS;\r
117	}\r
118	\r
119	VOID\r
120	PrintUsage (\r
121	VOID\r
122	)\r
123	{\r
124	printf ("Usage:\n");\r
125	printf (UTILITY_NAME " -i \"inputfile1\" \"inputfile2\" -o \"outputfile\" \n");\r
126	printf (" -i \"inputfile\":\n ");\r
127	printf (" specifies the input files that would be signed to CRC32 Guided section.\n");\r
128	printf (" -o \"outputfile\":\n");\r
129	printf (" specifies the output file that is a CRC32 Guided section.\n");\r
130	}\r
131	\r
132	INT32\r
133	ReadFilesContentsIntoBuffer (\r
134	IN CHAR8 *argv[],\r
135	IN INT32 Start,\r
136	IN OUT UINT8 **FileBuffer,\r
137	IN OUT UINT32 *BufferSize,\r
138	OUT UINT32 *ContentSize,\r
139	IN INT32 MaximumArguments\r
140	)\r
141	{\r
142	INT32 Index;\r
143	CHAR8 *FileName;\r
144	FILE *InputFile;\r
145	UINT8 Temp;\r
146	UINT32 Size;\r
147	\r
148	FileName = NULL;\r
149	InputFile = NULL;\r
150	Size = 0;\r
151	Index = 0;\r
152	\r
153	//\r
154	// read all input files into one file buffer\r
155	//\r
156	while (argv[Start + Index][0] != '-') {\r
157	\r
158	FileName = argv[Start + Index];\r
159	InputFile = fopen (FileName, "rb");\r
160	if (InputFile == NULL) {\r
161	Error (NULL, 0, 0, FileName, "failed to open input binary file");\r
162	return -1;\r
163	}\r
164	\r
165	fread (&Temp, sizeof (UINT8), 1, InputFile);\r
166	while (!feof (InputFile)) {\r
167	(*FileBuffer)[Size++] = Temp;\r
168	fread (&Temp, sizeof (UINT8), 1, InputFile);\r
169	}\r
170	\r
171	fclose (InputFile);\r
172	InputFile = NULL;\r
173	\r
174	//\r
175	// Make sure section ends on a DWORD boundary\r
176	//\r
177	while ((Size & 0x03) != 0) {\r
178	(*FileBuffer)[Size] = 0;\r
179	Size++;\r
180	}\r
181	\r
182	Index++;\r
183	if (Index == MaximumArguments) {\r
184	break;\r
185	}\r
186	}\r
187	\r
188	*ContentSize = Size;\r
189	return Index;\r
190	}\r
191	\r
192	int\r
193	main (\r
194	INT32 argc,\r
195	CHAR8 *argv[]\r
196	)\r
197	{\r
198	FILE *OutputFile;\r
199	UINT8 *FileBuffer;\r
200	UINT32 BufferSize;\r
201	EFI_STATUS Status;\r
202	UINT32 ContentSize;\r
203	CHAR8 *OutputFileName;\r
204	INT32 ReturnValue;\r
205	INT32 Index;\r
206	\r
207	OutputFile = NULL;\r
208	FileBuffer = NULL;\r
209	ContentSize = 0;\r
210	OutputFileName = NULL;\r
211	\r
212	SetUtilityName (UTILITY_NAME);\r
213	\r
214	if (argc == 1) {\r
215	PrintUsage ();\r
216	return -1;\r
217	}\r
218	\r
219	BufferSize = 1024 * 1024 * 16;\r
220	FileBuffer = (UINT8 ) malloc (BufferSize sizeof (UINT8));\r
221	if (FileBuffer == NULL) {\r
222	Error (NULL, 0, 0, "memory allocation failed", NULL);\r
223	return -1;\r
224	}\r
225	\r
226	ZeroMem (FileBuffer, BufferSize);\r
227	\r
228	for (Index = 0; Index < argc; Index++) {\r
229	if (strcmpi (argv[Index], "-i") == 0) {\r
230	ReturnValue = ReadFilesContentsIntoBuffer (\r
231	argv,\r
232	(Index + 1),\r
233	&FileBuffer,\r
234	&BufferSize,\r
235	&ContentSize,\r
236	(argc - (Index + 1))\r
237	);\r
238	if (ReturnValue == -1) {\r
239	Error (NULL, 0, 0, "failed to read file contents", NULL);\r
240	return -1;\r
241	}\r
242	\r
243	Index += ReturnValue;\r
244	}\r
245	\r
246	if (strcmpi (argv[Index], "-o") == 0) {\r
247	OutputFileName = argv[Index + 1];\r
248	}\r
249	}\r
250	\r
251	OutputFile = fopen (OutputFileName, "wb");\r
252	if (OutputFile == NULL) {\r
253	Error (NULL, 0, 0, OutputFileName, "failed to open output binary file");\r
254	free (FileBuffer);\r
255	return -1;\r
256	}\r
257	\r
258	/* \r
259	//\r
260	// make sure section ends on a DWORD boundary ??\r
261	//\r
262	while ( (Size & 0x03) != 0 ) {\r
263	FileBuffer[Size] = 0;\r
264	Size ++;\r
265	}\r
266	*/\r
267	Status = SignSectionWithCrc32 (FileBuffer, &BufferSize, ContentSize);\r
268	if (EFI_ERROR (Status)) {\r
269	Error (NULL, 0, 0, "failed to sign section", NULL);\r
270	free (FileBuffer);\r
271	fclose (OutputFile);\r
272	return -1;\r
273	}\r
274	\r
275	ContentSize = fwrite (FileBuffer, sizeof (UINT8), BufferSize, OutputFile);\r
276	if (ContentSize != BufferSize) {\r
277	Error (NULL, 0, 0, "failed to write output buffer", NULL);\r
278	ReturnValue = -1;\r
279	} else {\r
280	ReturnValue = 0;\r
281	}\r
282	\r
283	free (FileBuffer);\r
284	fclose (OutputFile);\r
285	return ReturnValue;\r
286	}\r