]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/C/GenSec/GenSec.c
BaseTools: Clean up source files
[mirror_edk2.git] / BaseTools / Source / C / GenSec / GenSec.c
index 46149762586ef0d7b849b3fa7333f462d5d40a3f..f3dfaf63bae3f1b75fc3c419efd89385707c7397 100644 (file)
@@ -2,13 +2,13 @@
 Creates output file that is a properly formed section per the PI spec.\r
 \r
 Copyright (c) 2004 - 2018, 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
+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
 **/\r
 #ifndef __GNUC__\r
@@ -103,7 +103,7 @@ STATIC EFI_GUID  mZeroGuid                 = {0x0, 0x0, 0x0, {0x0, 0x0, 0x0, 0x0
 STATIC EFI_GUID  mEfiCrc32SectionGuid      = EFI_CRC32_GUIDED_SECTION_EXTRACTION_PROTOCOL_GUID;\r
 \r
 STATIC\r
-VOID \r
+VOID\r
 Version (\r
   VOID\r
   )\r
@@ -116,12 +116,12 @@ Routine Description:
 Arguments:\r
 \r
   None\r
-  \r
+\r
 Returns:\r
 \r
   None\r
-  \r
---*/ \r
+\r
+--*/\r
 {\r
   fprintf (stdout, "%s Version %d.%d %s \n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION);\r
 }\r
@@ -151,11 +151,11 @@ Returns:
   // Summary usage\r
   //\r
   fprintf (stdout, "\nUsage: %s [options] [input_file]\n\n", UTILITY_NAME);\r
-  \r
+\r
   //\r
   // Copyright declaration\r
-  // \r
-  fprintf (stdout, "Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.\n\n");\r
+  //\r
+  fprintf (stdout, "Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.\n\n");\r
 \r
   //\r
   // Details Option\r
@@ -176,7 +176,7 @@ Returns:
                         EFI_SECTION_ALL is default section type.\n");\r
   fprintf (stdout, "  -c [Type], --compress [Type]\n\\r
                         Compress method type can be PI_NONE or PI_STD.\n\\r
-                        if -c option is not given, PI_STD is default type.\n"); \r
+                        if -c option is not given, PI_STD is default type.\n");\r
   fprintf (stdout, "  -g GuidValue, --vendor GuidValue\n\\r
                         GuidValue is one specific vendor guid value.\n\\r
                         Its format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n");\r
@@ -215,7 +215,7 @@ Ascii2UnicodeString (
 \r
 Routine Description:\r
 \r
-  Write ascii string as unicode string format to FILE \r
+  Write ascii string as unicode string format to FILE\r
 \r
 Arguments:\r
 \r
@@ -235,7 +235,7 @@ Returns:
   // End the UniString with a NULL.\r
   //\r
   *UniString = '\0';\r
-} \r
+}\r
 \r
 STATUS\r
 GenSectionCommonLeafSection (\r
@@ -245,19 +245,19 @@ GenSectionCommonLeafSection (
   UINT8   **OutFileBuffer\r
   )\r
 /*++\r
-        \r
+\r
 Routine Description:\r
-           \r
+\r
   Generate a leaf section of type other than EFI_SECTION_VERSION\r
   and EFI_SECTION_USER_INTERFACE. Input file must be well formed.\r
   The function won't validate the input file's contents. For\r
   common leaf sections, the input file may be a binary file.\r
   The utility will add section header to the file.\r
-            \r
+\r
 Arguments:\r
-               \r
+\r
   InputFileName  - Name of the input file.\r
-                \r
+\r
   InputFileNum   - Number of input files. Should be 1 for leaf section.\r
 \r
   SectionType    - A valid section type string\r
@@ -265,7 +265,7 @@ Arguments:
   OutFileBuffer  - Buffer pointer to Output file contents\r
 \r
 Returns:\r
-                       \r
+\r
   STATUS_ERROR            - can't continue\r
   STATUS_SUCCESS          - successful return\r
 \r
@@ -323,7 +323,7 @@ Returns:
   //\r
   Buffer = (UINT8 *) malloc ((size_t) TotalLength);\r
   if (Buffer == NULL) {\r
-    Error (NULL, 0, 4001, "Resource", "memory cannot be allcoated"); \r
+    Error (NULL, 0, 4001, "Resource", "memory cannot be allcoated");\r
     goto Done;\r
   }\r
   CommonSect = (EFI_COMMON_SECTION_HEADER *) Buffer;\r
@@ -336,7 +336,7 @@ Returns:
     memset(CommonSect->Size, 0xff, sizeof(UINT8) * 3);\r
     ((EFI_COMMON_SECTION_HEADER2 *)CommonSect)->ExtendedSize = TotalLength;\r
   }\r
-  \r
+\r
   //\r
   // read data from the input file.\r
   //\r
@@ -348,7 +348,7 @@ Returns:
   }\r
 \r
   //\r
-  // Set OutFileBuffer \r
+  // Set OutFileBuffer\r
   //\r
   *OutFileBuffer = Buffer;\r
   Status = STATUS_SUCCESS;\r
@@ -408,14 +408,14 @@ GetSectionContents (
   UINT32  *BufferLength\r
   )\r
 /*++\r
-        \r
+\r
 Routine Description:\r
-           \r
+\r
   Get the contents of all section files specified in InputFileName\r
   into FileBuffer.\r
-            \r
+\r
 Arguments:\r
-               \r
+\r
   InputFileName  - Name of the input file.\r
 \r
   InputFileAlign - Alignment required by the input file data.\r
@@ -424,11 +424,11 @@ Arguments:
 \r
   FileBuffer     - Output buffer to contain data\r
 \r
-  BufferLength   - On input, this is size of the FileBuffer. \r
+  BufferLength   - On input, this is size of the FileBuffer.\r
                    On output, this is the actual length of the data.\r
 \r
 Returns:\r
-                       \r
+\r
   EFI_SUCCESS on successful return\r
   EFI_INVALID_PARAMETER if InputFileNum is less than 1 or BufferLength point is NULL.\r
   EFI_ABORTED if unable to open input file.\r
@@ -475,8 +475,8 @@ Returns:
       }\r
       Size++;\r
     }\r
-    \r
-    // \r
+\r
+    //\r
     // Open file and read contents\r
     //\r
     InFile = fopen (LongFilePath (InputFileName[Index]), "rb");\r
@@ -488,7 +488,7 @@ Returns:
     fseek (InFile, 0, SEEK_END);\r
     FileSize = ftell (InFile);\r
     fseek (InFile, 0, SEEK_SET);\r
-    DebugMsg (NULL, 0, 9, "Input files", "the input file name is %s and the size is %u bytes", InputFileName[Index], (unsigned) FileSize); \r
+    DebugMsg (NULL, 0, 9, "Input files", "the input file name is %s and the size is %u bytes", InputFileName[Index], (unsigned) FileSize);\r
     //\r
     // Adjust section buffer when section alignment is required.\r
     //\r
@@ -525,7 +525,7 @@ Returns:
             HeaderSize = GuidSectHeader.DataOffset;\r
           }\r
         }\r
-      } \r
+      }\r
 \r
       fseek (InFile, 0, SEEK_SET);\r
 \r
@@ -544,7 +544,7 @@ Returns:
       if ((InputFileAlign [Index] != 0) && (((Size + HeaderSize + TeOffset) % InputFileAlign [Index]) != 0)) {\r
         Offset = (Size + sizeof (EFI_COMMON_SECTION_HEADER) + HeaderSize + TeOffset + InputFileAlign [Index] - 1) & ~(InputFileAlign [Index] - 1);\r
         Offset = Offset - Size - HeaderSize - TeOffset;\r
-         \r
+\r
         if (FileBuffer != NULL && ((Size + Offset) < *BufferLength)) {\r
           //\r
           // The maximal alignment is 64K, the raw section size must be less than 0xffffff\r
@@ -577,7 +577,7 @@ Returns:
     fclose (InFile);\r
     Size += FileSize;\r
   }\r
-  \r
+\r
   //\r
   // Set the real required buffer size.\r
   //\r
@@ -599,28 +599,28 @@ GenSectionCompressionSection (
   UINT8   **OutFileBuffer\r
   )\r
 /*++\r
-        \r
+\r
 Routine Description:\r
-           \r
+\r
   Generate an encapsulating section of type EFI_SECTION_COMPRESSION\r
   Input file must be already sectioned. The function won't validate\r
-  the input files' contents. Caller should hand in files already \r
+  the input files' contents. Caller should hand in files already\r
   with section header.\r
-            \r
+\r
 Arguments:\r
-               \r
+\r
   InputFileName  - Name of the input file.\r
 \r
   InputFileAlign - Alignment required by the input file data.\r
 \r
   InputFileNum   - Number of input files. Should be at least 1.\r
 \r
-  SectCompSubType - Specify the compression algorithm requested. \r
-  \r
+  SectCompSubType - Specify the compression algorithm requested.\r
+\r
   OutFileBuffer   - Buffer pointer to Output file contents\r
 \r
 Returns:\r
-                       \r
+\r
   EFI_SUCCESS           on successful return\r
   EFI_INVALID_PARAMETER if InputFileNum is less than 1\r
   EFI_ABORTED           if unable to open input file.\r
@@ -754,7 +754,7 @@ Returns:
     }\r
   }\r
 \r
-  DebugMsg (NULL, 0, 9, "comprss file size", \r
+  DebugMsg (NULL, 0, 9, "comprss file size",\r
             "the original section size is %d bytes and the compressed section size is %u bytes", (unsigned) InputLength, (unsigned) CompressedLength);\r
 \r
   //if (TotalLength >= MAX_SECTION_SIZE) {\r
@@ -782,7 +782,7 @@ Returns:
     CompressionSect2->UncompressedLength        = InputLength;\r
   } else {\r
     CompressionSect = (EFI_COMPRESSION_SECTION *) FileBuffer;\r
-    \r
+\r
     CompressionSect->CommonHeader.Type     = EFI_SECTION_COMPRESSION;\r
     CompressionSect->CommonHeader.Size[0]  = (UINT8) (TotalLength & 0xff);\r
     CompressionSect->CommonHeader.Size[1]  = (UINT8) ((TotalLength & 0xff00) >> 8);\r
@@ -792,7 +792,7 @@ Returns:
   }\r
 \r
   //\r
-  // Set OutFileBuffer \r
+  // Set OutFileBuffer\r
   //\r
   *OutFileBuffer = FileBuffer;\r
 \r
@@ -810,32 +810,32 @@ GenSectionGuidDefinedSection (
   UINT8    **OutFileBuffer\r
   )\r
 /*++\r
-        \r
+\r
 Routine Description:\r
-           \r
+\r
   Generate an encapsulating section of type EFI_SECTION_GUID_DEFINED\r
   Input file must be already sectioned. The function won't validate\r
-  the input files' contents. Caller should hand in files already \r
+  the input files' contents. Caller should hand in files already\r
   with section header.\r
-            \r
+\r
 Arguments:\r
-               \r
+\r
   InputFileName - Name of the input file.\r
-                \r
+\r
   InputFileAlign - Alignment required by the input file data.\r
 \r
   InputFileNum  - Number of input files. Should be at least 1.\r
 \r
   VendorGuid    - Specify vendor guid value.\r
 \r
-  DataAttribute - Specify attribute for the vendor guid data. \r
-  \r
+  DataAttribute - Specify attribute for the vendor guid data.\r
+\r
   DataHeaderSize- Guided Data Header Size\r
-  \r
+\r
   OutFileBuffer   - Buffer pointer to Output file contents\r
 \r
 Returns:\r
-                       \r
+\r
   EFI_SUCCESS on successful return\r
   EFI_INVALID_PARAMETER if InputFileNum is less than 1\r
   EFI_ABORTED if unable to open input file.\r
@@ -935,7 +935,7 @@ Returns:
     //\r
     Crc32Checksum = 0;\r
     CalculateCrc32 (FileBuffer + Offset, InputLength, &Crc32Checksum);\r
-    \r
+\r
     if (TotalLength >= MAX_SECTION_SIZE) {\r
       Crc32GuidSect2 = (CRC32_SECTION_HEADER2 *) FileBuffer;\r
       Crc32GuidSect2->GuidSectionHeader.CommonHeader.Type     = EFI_SECTION_GUID_DEFINED;\r
@@ -985,9 +985,9 @@ Returns:
     }\r
   }\r
   VerboseMsg ("the size of the created section file is %u bytes", (unsigned) TotalLength);\r
-  \r
+\r
   //\r
-  // Set OutFileBuffer \r
+  // Set OutFileBuffer\r
   //\r
   *OutFileBuffer = FileBuffer;\r
 \r
@@ -1126,7 +1126,7 @@ Returns:
   int                       VersionNumber;\r
   UINT8                     SectType;\r
   UINT8                     SectCompSubType;\r
-  UINT16                    SectGuidAttribute; \r
+  UINT16                    SectGuidAttribute;\r
   UINT64                    SectGuidHeaderLength;\r
   EFI_VERSION_SECTION       *VersionSect;\r
   EFI_USER_INTERFACE_SECTION *UiSect;\r
@@ -1172,9 +1172,9 @@ Returns:
   InFile                = NULL;\r
   InFileSize            = 0;\r
   InFileBuffer          = NULL;\r
-  \r
+\r
   SetUtilityName (UTILITY_NAME);\r
-  \r
+\r
   if (argc == 1) {\r
     Error (NULL, 0, 1001, "Missing options", "No options input");\r
     Usage ();\r
@@ -1190,12 +1190,12 @@ Returns:
   if ((stricmp (argv[0], "-h") == 0) || (stricmp (argv[0], "--help") == 0)) {\r
     Version ();\r
     Usage ();\r
-    return STATUS_SUCCESS;    \r
+    return STATUS_SUCCESS;\r
   }\r
 \r
   if (stricmp (argv[0], "--version") == 0) {\r
     Version ();\r
-    return STATUS_SUCCESS;    \r
+    return STATUS_SUCCESS;\r
   }\r
 \r
   while (argc > 0) {\r
@@ -1207,7 +1207,7 @@ Returns:
       }\r
       argc -= 2;\r
       argv += 2;\r
-      continue; \r
+      continue;\r
     }\r
 \r
     if ((stricmp (argv[0], "-o") == 0) || (stricmp (argv[0], "--outputfile") == 0)) {\r
@@ -1218,7 +1218,7 @@ Returns:
       }\r
       argc -= 2;\r
       argv += 2;\r
-      continue; \r
+      continue;\r
     }\r
 \r
     if ((stricmp (argv[0], "-c") == 0) || (stricmp (argv[0], "--compress") == 0)) {\r
@@ -1387,7 +1387,7 @@ Returns:
       argc -= 2;\r
       argv += 2;\r
       InputFileAlignNum ++;\r
-      continue; \r
+      continue;\r
     }\r
 \r
     //\r
@@ -1529,14 +1529,14 @@ Returns:
     VerboseMsg ("Compress method is %s", mCompressionTypeName [SectCompSubType]);\r
   } else if (stricmp (SectionName, mSectionTypeName[EFI_SECTION_GUID_DEFINED]) == 0) {\r
     SectType     = EFI_SECTION_GUID_DEFINED;\r
-    \r
+\r
     if ((SectGuidAttribute & EFI_GUIDED_SECTION_NONE) != 0) {\r
       //\r
       // NONE attribute, clear attribute value.\r
       //\r
       SectGuidAttribute = SectGuidAttribute & ~EFI_GUIDED_SECTION_NONE;\r
     }\r
-    VerboseMsg ("Vendor Guid is %08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X", \r
+    VerboseMsg ("Vendor Guid is %08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",\r
                 (unsigned) VendorGuid.Data1,\r
                 VendorGuid.Data2,\r
                 VendorGuid.Data3,\r
@@ -1595,7 +1595,7 @@ Returns:
     Error (NULL, 0, 1003, "Invalid option value", "SectionType = %s", SectionName);\r
     goto Finish;\r
   }\r
-  \r
+\r
   //\r
   // GuidValue is only required by Guided section.\r
   //\r
@@ -1604,10 +1604,10 @@ Returns:
     (CompareGuid (&VendorGuid, &mZeroGuid) != 0)) {\r
     fprintf (stdout, "Warning: the input guid value is not required for this section type %s\n", SectionName);\r
   }\r
-  \r
+\r
   //\r
   // Check whether there is input file\r
-  //  \r
+  //\r
   if ((SectType != EFI_SECTION_VERSION) && (SectType != EFI_SECTION_USER_INTERFACE)) {\r
     //\r
     // The input file are required for other section type.\r
@@ -1730,7 +1730,7 @@ Returns:
               OutFileBuffer,\r
               &InputLength\r
               );\r
-  \r
+\r
     if (Status == EFI_BUFFER_TOO_SMALL) {\r
       OutFileBuffer = (UINT8 *) malloc (InputLength);\r
       if (OutFileBuffer == NULL) {\r
@@ -1762,10 +1762,10 @@ Returns:
               );\r
     break;\r
   }\r
-  \r
+\r
   if (Status != EFI_SUCCESS || OutFileBuffer == NULL) {\r
     Error (NULL, 0, 2000, "Status is not successful", "Status value is 0x%X", (int) Status);\r
-         goto Finish;\r
+    goto Finish;\r
   }\r
 \r
   //\r
@@ -1778,7 +1778,7 @@ Returns:
       InputLength = ((EFI_COMMON_SECTION_HEADER2 *)SectionHeader)->ExtendedSize;\r
     }\r
   }\r
-  \r
+\r
   //\r
   // Write the output file\r
   //\r