]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Source/TianoTools/GenTEImage/GenTEImage.c
Restructuring for better separation of Tool packages.
[mirror_edk2.git] / Tools / Source / TianoTools / GenTEImage / GenTEImage.c
diff --git a/Tools/Source/TianoTools/GenTEImage/GenTEImage.c b/Tools/Source/TianoTools/GenTEImage/GenTEImage.c
deleted file mode 100644 (file)
index 90f3b39..0000000
+++ /dev/null
@@ -1,916 +0,0 @@
-/*++\r
-\r
-Copyright (c)  1999-2006 Intel Corporation. All rights reserved\r
-This program and the accompanying materials are licensed and made available \r
-under the terms and conditions of the BSD License which accompanies this \r
-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
-  GenTEImage.c\r
-  \r
-Abstract:\r
-\r
-  Utility program to shrink a PE32 image down by replacing\r
-  the DOS, PE, and optional headers with a minimal header.\r
-\r
---*/\r
-\r
-#include <stdio.h>\r
-#include <string.h>\r
-#include <stdlib.h>\r
-\r
-#include <Common/UefiBaseTypes.h>\r
-#include <Common/EfiImage.h> // for PE32 structure definitions\r
-\r
-#include "CommonLib.h"\r
-#include "EfiUtilityMsgs.h"\r
-\r
-//\r
-// Version of this utility\r
-//\r
-#define UTILITY_NAME    "GenTEImage"\r
-#define UTILITY_VERSION "v0.11"\r
-\r
-//\r
-// Define the max length of a filename\r
-//\r
-#define MAX_PATH                  256\r
-#define DEFAULT_OUTPUT_EXTENSION  ".te"\r
-\r
-//\r
-// Use this to track our command-line options and globals\r
-//\r
-struct {\r
-  INT8  OutFileName[MAX_PATH];\r
-  INT8  InFileName[MAX_PATH];\r
-  INT8  Verbose;\r
-  INT8  Dump;\r
-} mOptions;\r
-\r
-//\r
-// Use these to convert from machine type value to a named type\r
-//\r
-typedef struct {\r
-  UINT16  Value;\r
-  INT8    *Name;\r
-} STRING_LOOKUP;\r
-\r
-static STRING_LOOKUP  mMachineTypes[] = {\r
-  EFI_IMAGE_MACHINE_IA32,\r
-  "IA32",\r
-  EFI_IMAGE_MACHINE_IA64,\r
-  "IA64",\r
-  EFI_IMAGE_MACHINE_EBC,\r
-  "EBC",\r
-  0,\r
-  NULL\r
-};\r
-\r
-static STRING_LOOKUP  mSubsystemTypes[] = {\r
-  EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION,\r
-  "EFI application",\r
-  EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER,\r
-  "EFI boot service driver",\r
-  EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER,\r
-  "EFI runtime driver",\r
-  0,\r
-  NULL\r
-};\r
-//\r
-//  Function prototypes\r
-//\r
-static\r
-void\r
-Usage (\r
-  VOID\r
-  );\r
-\r
-static\r
-STATUS\r
-ParseCommandLine (\r
-  int       Argc,\r
-  char      *Argv[]\r
-  );\r
-\r
-static\r
-STATUS\r
-CheckPE32File (\r
-  INT8      *FileName,\r
-  FILE      *Fptr,\r
-  UINT16    *MachineType,\r
-  UINT16    *SubSystem\r
-  );\r
-\r
-static\r
-STATUS\r
-ProcessFile (\r
-  INT8      *InFileName,\r
-  INT8      *OutFileName\r
-  );\r
-\r
-static\r
-void\r
-DumpImage (\r
-  INT8      *FileName\r
-  );\r
-\r
-static\r
-INT8                  *\r
-GetMachineTypeStr (\r
-  UINT16    MachineType\r
-  );\r
-\r
-static\r
-INT8                  *\r
-GetSubsystemTypeStr (\r
-  UINT16  SubsystemType\r
-  );\r
-\r
-main (\r
-  int   Argc,\r
-  char  *Argv[]\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
-\r
-Arguments:\r
-\r
-  Argc            - standard C main() argument count\r
-\r
-  Argv            - standard C main() argument list\r
-\r
-Returns:\r
-\r
-  0             success\r
-  non-zero      otherwise\r
-\r
---*/\r
-// GC_TODO:    ] - add argument and description to function comment\r
-{\r
-  INT8    *Ext;\r
-  UINT32  Status;\r
-\r
-  SetUtilityName (UTILITY_NAME);\r
-  //\r
-  // Parse the command line arguments\r
-  //\r
-  if (ParseCommandLine (Argc, Argv)) {\r
-    return STATUS_ERROR;\r
-  }\r
-  //\r
-  // If dumping an image, then do that and quit\r
-  //\r
-  if (mOptions.Dump) {\r
-    DumpImage (mOptions.InFileName);\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Determine the output filename. Either what they specified on\r
-  // the command line, or the first input filename with a different extension.\r
-  //\r
-  if (!mOptions.OutFileName[0]) {\r
-    strcpy (mOptions.OutFileName, mOptions.InFileName);\r
-    //\r
-    // Find the last . on the line and replace the filename extension with\r
-    // the default\r
-    //\r
-    for (Ext = mOptions.OutFileName + strlen (mOptions.OutFileName) - 1;\r
-         (Ext >= mOptions.OutFileName) && (*Ext != '.') && (*Ext != '\\');\r
-         Ext--\r
-        )\r
-      ;\r
-    //\r
-    // If dot here, then insert extension here, otherwise append\r
-    //\r
-    if (*Ext != '.') {\r
-      Ext = mOptions.OutFileName + strlen (mOptions.OutFileName);\r
-    }\r
-\r
-    strcpy (Ext, DEFAULT_OUTPUT_EXTENSION);\r
-  }\r
-  //\r
-  // Make sure we don't have the same filename for input and output files\r
-  //\r
-  if (stricmp (mOptions.OutFileName, mOptions.InFileName) == 0) {\r
-    Error (NULL, 0, 0, mOptions.OutFileName, "input and output file names must be different");\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Process the file\r
-  //\r
-  ProcessFile (mOptions.InFileName, mOptions.OutFileName);\r
-Finish:\r
-  Status = GetUtilityStatus ();\r
-  return Status;\r
-}\r
-\r
-static\r
-STATUS\r
-ProcessFile (\r
-  INT8      *InFileName,\r
-  INT8      *OutFileName\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
-  Process a PE32 EFI file.\r
-\r
-Arguments:\r
-  \r
-  InFileName      - the file name pointer to the input file\r
-  OutFileName     - the file name pointer to the output file\r
-\r
-Returns:\r
-\r
-  STATUS_SUCCESS  - the process has been finished successfully\r
-  STATUS_ERROR    - error occured during the processing\r
-\r
---*/\r
-{\r
-  STATUS                      Status;\r
-  FILE                        *InFptr;\r
-  FILE                        *OutFptr;\r
-  UINT16                      MachineType;\r
-  UINT16                      SubSystem;\r
-  EFI_TE_IMAGE_HEADER         TEImageHeader;\r
-  UINT32                      PESigOffset;\r
-  EFI_IMAGE_FILE_HEADER       FileHeader;\r
-  EFI_IMAGE_OPTIONAL_HEADER32 OptionalHeader32;\r
-  EFI_IMAGE_OPTIONAL_HEADER64 OptionalHeader64;\r
-  UINT32                      BytesStripped;\r
-  UINT32                      FileSize;\r
-  UINT8                       *Buffer;\r
-  long                        SaveFilePosition;\r
-\r
-  InFptr  = NULL;\r
-  OutFptr = NULL;\r
-  Buffer  = NULL;\r
-  Status  = STATUS_ERROR;\r
-\r
-  //\r
-  // Try to open the input file\r
-  //\r
-  if ((InFptr = fopen (InFileName, "rb")) == NULL) {\r
-    Error (NULL, 0, 0, InFileName, "failed to open input file for reading");\r
-    return STATUS_ERROR;\r
-  }\r
-  //\r
-  // Double-check the file to make sure it's what we expect it to be\r
-  //\r
-  if (CheckPE32File (InFileName, InFptr, &MachineType, &SubSystem) != STATUS_SUCCESS) {\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Initialize our new header\r
-  //\r
-  memset (&TEImageHeader, 0, sizeof (EFI_TE_IMAGE_HEADER));\r
-\r
-  //\r
-  // Seek to the end to get the file size\r
-  //\r
-  fseek (InFptr, 0, SEEK_END);\r
-  FileSize = ftell (InFptr);\r
-  fseek (InFptr, 0, SEEK_SET);\r
-\r
-  //\r
-  // Per the PE/COFF specification, at offset 0x3C in the file is a 32-bit\r
-  // offset (from the start of the file) to the PE signature, which always\r
-  // follows the MSDOS stub. The PE signature is immediately followed by the\r
-  // COFF file header.\r
-  //\r
-  //\r
-  if (fseek (InFptr, 0x3C, SEEK_SET) != 0) {\r
-    Error (NULL, 0, 0, InFileName, "failed to seek to PE signature in file", NULL);\r
-    goto Finish;\r
-  }\r
-\r
-  if (fread (&PESigOffset, sizeof (PESigOffset), 1, InFptr) != 1) {\r
-    Error (NULL, 0, 0, InFileName, "failed to read PE signature offset from file");\r
-    goto Finish;\r
-  }\r
-\r
-  if (fseek (InFptr, PESigOffset + 4, SEEK_SET) != 0) {\r
-    Error (NULL, 0, 0, InFileName, "failed to seek to PE signature");\r
-    goto Finish;\r
-  }\r
-  //\r
-  // We should now be at the COFF file header. Read it in and verify it's\r
-  // of an image type we support.\r
-  //\r
-  if (fread (&FileHeader, sizeof (EFI_IMAGE_FILE_HEADER), 1, InFptr) != 1) {\r
-    Error (NULL, 0, 0, InFileName, "failed to read file header from image");\r
-    goto Finish;\r
-  }\r
-\r
-  if ((FileHeader.Machine != EFI_IMAGE_MACHINE_IA32) && (FileHeader.Machine != EFI_IMAGE_MACHINE_IA64)) {\r
-    Error (NULL, 0, 0, InFileName, "image is of an unsupported machine type 0x%X", (UINT32) FileHeader.Machine);\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Calculate the total number of bytes we're going to strip off. The '4' is for the\r
-  // PE signature PE\0\0. Then sanity check the size.\r
-  //\r
-  BytesStripped = PESigOffset + 4 + sizeof (EFI_IMAGE_FILE_HEADER) + FileHeader.SizeOfOptionalHeader;\r
-  if (BytesStripped >= FileSize) {\r
-    Error (NULL, 0, 0, InFileName, "attempt to strip more bytes than the total file size");\r
-    goto Finish;\r
-  }\r
-\r
-  if (BytesStripped &~0xFFFF) {\r
-    Error (NULL, 0, 0, InFileName, "attempt to strip more than 64K bytes", NULL);\r
-    goto Finish;\r
-  }\r
-\r
-  TEImageHeader.StrippedSize = (UINT16) BytesStripped;\r
-\r
-  //\r
-  // Read in the optional header. Assume PE32, and if not, then re-read as PE32+\r
-  //\r
-  SaveFilePosition = ftell (InFptr);\r
-  if (fread (&OptionalHeader32, sizeof (EFI_IMAGE_OPTIONAL_HEADER32), 1, InFptr) != 1) {\r
-    Error (NULL, 0, 0, InFileName, "failed to read optional header from input file");\r
-    goto Finish;\r
-  }\r
-\r
-  if (OptionalHeader32.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
-    //\r
-    // Fill in our new header with required data directory entries\r
-    //\r
-    TEImageHeader.AddressOfEntryPoint = OptionalHeader32.AddressOfEntryPoint;\r
-    //\r
-    // - BytesStripped + sizeof (EFI_TE_IMAGE_HEADER);\r
-    //\r
-    // We're going to pack the subsystem into 1 byte. Make sure it fits\r
-    //\r
-    if (OptionalHeader32.Subsystem &~0xFF) {\r
-      Error (\r
-        NULL,\r
-        0,\r
-        0,\r
-        InFileName,\r
-        NULL,\r
-        "image subsystem 0x%X cannot be packed into 1 byte",\r
-        (UINT32) OptionalHeader32.Subsystem\r
-        );\r
-      goto Finish;\r
-    }\r
-\r
-    TEImageHeader.Subsystem   = (UINT8) OptionalHeader32.Subsystem;\r
-    TEImageHeader.BaseOfCode  = OptionalHeader32.BaseOfCode;\r
-    TEImageHeader.ImageBase = (UINT64) (OptionalHeader32.ImageBase + TEImageHeader.StrippedSize - sizeof (EFI_TE_IMAGE_HEADER));\r
-    if (OptionalHeader32.NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {\r
-      TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC].VirtualAddress = OptionalHeader32.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC].VirtualAddress;\r
-      TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC].Size = OptionalHeader32.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC].Size;\r
-    }\r
-\r
-    if (OptionalHeader32.NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_DEBUG) {\r
-      TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress = OptionalHeader32.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress;\r
-      TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].Size = OptionalHeader32.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG].Size;\r
-    }\r
-  } else if (OptionalHeader32.Magic == EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC) {\r
-    //\r
-    // Rewind and re-read the optional header\r
-    //\r
-    fseek (InFptr, SaveFilePosition, SEEK_SET);\r
-    if (fread (&OptionalHeader64, sizeof (EFI_IMAGE_OPTIONAL_HEADER64), 1, InFptr) != 1) {\r
-      Error (NULL, 0, 0, InFileName, "failed to re-read optional header from input file");\r
-      goto Finish;\r
-    }\r
-\r
-    TEImageHeader.AddressOfEntryPoint = OptionalHeader64.AddressOfEntryPoint;\r
-    //\r
-    // - BytesStripped + sizeof (EFI_TE_IMAGE_HEADER);\r
-    //\r
-    // We're going to pack the subsystem into 1 byte. Make sure it fits\r
-    //\r
-    if (OptionalHeader64.Subsystem &~0xFF) {\r
-      Error (\r
-        NULL,\r
-        0,\r
-        0,\r
-        InFileName,\r
-        NULL,\r
-        "image subsystem 0x%X cannot be packed into 1 byte",\r
-        (UINT32) OptionalHeader64.Subsystem\r
-        );\r
-      goto Finish;\r
-    }\r
-\r
-    TEImageHeader.Subsystem   = (UINT8) OptionalHeader64.Subsystem;\r
-    TEImageHeader.BaseOfCode  = OptionalHeader32.BaseOfCode;\r
-    TEImageHeader.ImageBase = (UINT64) (OptionalHeader64.ImageBase + TEImageHeader.StrippedSize - sizeof (EFI_TE_IMAGE_HEADER));\r
-    if (OptionalHeader64.NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {\r
-      TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC].VirtualAddress = OptionalHeader64.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC].VirtualAddress;\r
-      TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC].Size = OptionalHeader64.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC].Size;\r
-    }\r
-\r
-    if (OptionalHeader64.NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_DEBUG) {\r
-      TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress = OptionalHeader64.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress;\r
-      TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].Size = OptionalHeader64.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG].Size;\r
-    }\r
-  } else {\r
-    Error (\r
-      NULL,\r
-      0,\r
-      0,\r
-      InFileName,\r
-      "unsupported magic number 0x%X found in optional header",\r
-      (UINT32) OptionalHeader32.Magic\r
-      );\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Fill in the remainder of our new image header\r
-  //\r
-  TEImageHeader.Signature = EFI_TE_IMAGE_HEADER_SIGNATURE;\r
-  TEImageHeader.Machine   = FileHeader.Machine;\r
-  //\r
-  // We're going to pack the number of sections into a single byte. Make sure it fits.\r
-  //\r
-  if (FileHeader.NumberOfSections &~0xFF) {\r
-    Error (\r
-      NULL,\r
-      0,\r
-      0,\r
-      InFileName,\r
-      NULL,\r
-      "image's number of sections 0x%X cannot be packed into 1 byte",\r
-      (UINT32) FileHeader.NumberOfSections\r
-      );\r
-    goto Finish;\r
-  }\r
-\r
-  TEImageHeader.NumberOfSections = (UINT8) FileHeader.NumberOfSections;\r
-\r
-  //\r
-  // Now open our output file\r
-  //\r
-  if ((OutFptr = fopen (OutFileName, "wb")) == NULL) {\r
-    Error (NULL, 0, 0, OutFileName, "failed to open output file for writing");\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Write the TE header\r
-  //\r
-  if (fwrite (&TEImageHeader, sizeof (EFI_TE_IMAGE_HEADER), 1, OutFptr) != 1) {\r
-    Error (NULL, 0, 0, "failed to write image header to output file", NULL);\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Position into the input file, read the part we're not stripping, and\r
-  // write it out.\r
-  //\r
-  fseek (InFptr, BytesStripped, SEEK_SET);\r
-  Buffer = (UINT8 *) malloc (FileSize - BytesStripped);\r
-  if (Buffer == NULL) {\r
-    Error (NULL, 0, 0, "application error", "failed to allocate memory");\r
-    goto Finish;\r
-  }\r
-\r
-  if (fread (Buffer, FileSize - BytesStripped, 1, InFptr) != 1) {\r
-    Error (NULL, 0, 0, InFileName, "failed to read remaining contents of input file");\r
-    goto Finish;\r
-  }\r
-\r
-  if (fwrite (Buffer, FileSize - BytesStripped, 1, OutFptr) != 1) {\r
-    Error (NULL, 0, 0, OutFileName, "failed to write all bytes to output file");\r
-    goto Finish;\r
-  }\r
-\r
-  Status = STATUS_SUCCESS;\r
-\r
-Finish:\r
-  if (InFptr != NULL) {\r
-    fclose (InFptr);\r
-  }\r
-  //\r
-  // Close the output file. If there was an error, delete the output file so\r
-  // that a subsequent build will rebuild it.\r
-  //\r
-  if (OutFptr != NULL) {\r
-    fclose (OutFptr);\r
-    if (GetUtilityStatus () == STATUS_ERROR) {\r
-      remove (OutFileName);\r
-    }\r
-  }\r
-\r
-  //\r
-  // Free up our buffer\r
-  //\r
-  if (Buffer != NULL) {\r
-    free (Buffer);\r
-  }\r
-\r
-  return Status;\r
-}\r
-\r
-static\r
-STATUS\r
-CheckPE32File (\r
-  INT8      *FileName,\r
-  FILE      *Fptr,\r
-  UINT16    *MachineType,\r
-  UINT16    *SubSystem\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  FileName    - GC_TODO: add argument description\r
-  Fptr        - GC_TODO: add argument description\r
-  MachineType - GC_TODO: add argument description\r
-  SubSystem   - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
-{\r
-  /*++\r
-\r
-Routine Description:\r
-  \r
-  Given a file pointer to a supposed PE32 image file, verify that it is indeed a\r
-  PE32 image file, and then return the machine type in the supplied pointer.\r
-\r
-Arguments:\r
-\r
-  Fptr          File pointer to the already-opened PE32 file\r
-  MachineType   Location to stuff the machine type of the PE32 file. This is needed\r
-                because the image may be Itanium-based, IA32, or EBC.\r
-\r
-Returns:\r
-\r
-  0             success\r
-  non-zero      otherwise\r
-\r
---*/\r
-  EFI_IMAGE_DOS_HEADER      DosHeader;\r
-  EFI_IMAGE_FILE_HEADER     FileHdr;\r
-  EFI_IMAGE_OPTIONAL_HEADER OptionalHdr;\r
-  UINT32                    PESig;\r
-  STATUS                    Status;\r
-\r
-  Status = STATUS_ERROR;\r
-  //\r
-  // Position to the start of the file\r
-  //\r
-  fseek (Fptr, 0, SEEK_SET);\r
-  //\r
-  // Read the DOS header\r
-  //\r
-  if (fread (&DosHeader, sizeof (DosHeader), 1, Fptr) != 1) {\r
-    Error (NULL, 0, 0, FileName, "failed to read the DOS stub from the input file");\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Check the magic number (0x5A4D)\r
-  //\r
-  if (DosHeader.e_magic != EFI_IMAGE_DOS_SIGNATURE) {\r
-    Error (NULL, 0, 0, FileName, "input file does not appear to be a PE32 image (magic number)");\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Position into the file and check the PE signature\r
-  //\r
-  fseek (Fptr, (long) DosHeader.e_lfanew, SEEK_SET);\r
-  if (fread (&PESig, sizeof (PESig), 1, Fptr) != 1) {\r
-    Error (NULL, 0, 0, FileName, "failed to read PE signature bytes");\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Check the PE signature in the header "PE\0\0"\r
-  //\r
-  if (PESig != EFI_IMAGE_NT_SIGNATURE) {\r
-    Error (NULL, 0, 0, FileName, "file does not appear to be a PE32 image (signature)");\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Read the file header\r
-  //\r
-  if (fread (&FileHdr, sizeof (FileHdr), 1, Fptr) != 1) {\r
-    Error (NULL, 0, 0, FileName, "failed to read PE file header from input file");\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Read the optional header so we can get the subsystem\r
-  //\r
-  if (fread (&OptionalHdr, sizeof (OptionalHdr), 1, Fptr) != 1) {\r
-    Error (NULL, 0, 0, FileName, "failed to read COFF optional header from input file");\r
-    goto Finish;\r
-  }\r
-\r
-  *SubSystem = OptionalHdr.Subsystem;\r
-  if (mOptions.Verbose) {\r
-    fprintf (stdout, "  Got subsystem = 0x%X from image\n", (int) *SubSystem);\r
-  }\r
-  //\r
-  // Good to go\r
-  //\r
-  Status = STATUS_SUCCESS;\r
-Finish:\r
-  fseek (Fptr, 0, SEEK_SET);\r
-  return Status;\r
-}\r
-\r
-static\r
-int\r
-ParseCommandLine (\r
-  int         Argc,\r
-  char        *Argv[]\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
-  Given the Argc/Argv program arguments, and a pointer to an options structure,\r
-  parse the command-line options and check their validity.\r
-\r
-\r
-Arguments:\r
-\r
-  Argc            - standard C main() argument count\r
-  Argv            - standard C main() argument list\r
-\r
-Returns:\r
-\r
-  STATUS_SUCCESS    success\r
-  non-zero          otherwise\r
-\r
---*/\r
-// GC_TODO:    ] - add argument and description to function comment\r
-{\r
-  //\r
-  // Clear out the options\r
-  //\r
-  memset ((char *) &mOptions, 0, sizeof (mOptions));\r
-  //\r
-  // Skip over the program name\r
-  //\r
-  Argc--;\r
-  Argv++;\r
-  //\r
-  // If no arguments, assume they want usage info\r
-  //\r
-  if (Argc == 0) {\r
-    Usage ();\r
-    return STATUS_ERROR;\r
-  }\r
-  //\r
-  // Process until no more arguments\r
-  //\r
-  while ((Argc > 0) && (Argv[0][0] == '-')) {\r
-    if (stricmp (Argv[0], "-o") == 0) {\r
-      //\r
-      // Output filename specified with -o\r
-      // Make sure there's another parameter\r
-      //\r
-      if (Argc > 1) {\r
-        strcpy (mOptions.OutFileName, Argv[1]);\r
-      } else {\r
-        Error (NULL, 0, 0, Argv[0], "missing output file name with option");\r
-        Usage ();\r
-        return STATUS_ERROR;\r
-      }\r
-\r
-      Argv++;\r
-      Argc--;\r
-    } else if ((stricmp (Argv[0], "-h") == 0) || (strcmp (Argv[0], "-?") == 0)) {\r
-      //\r
-      // Help option\r
-      //\r
-      Usage ();\r
-      return STATUS_ERROR;\r
-    } else if (stricmp (Argv[0], "-v") == 0) {\r
-      //\r
-      // -v for verbose\r
-      //\r
-      mOptions.Verbose = 1;\r
-    } else if (stricmp (Argv[0], "-dump") == 0) {\r
-      //\r
-      // -dump for dumping an image\r
-      //\r
-      mOptions.Dump = 1;\r
-    } else {\r
-      Error (NULL, 0, 0, Argv[0], "unrecognized option");\r
-      Usage ();\r
-      return STATUS_ERROR;\r
-    }\r
-    //\r
-    // Next argument\r
-    //\r
-    Argv++;\r
-    Argc--;\r
-  }\r
-  //\r
-  // Better be one more arg for input file name\r
-  //\r
-  if (Argc == 0) {\r
-    Error (NULL, 0, 0, "input file name required", NULL);\r
-    Usage ();\r
-    return STATUS_ERROR;\r
-  }\r
-\r
-  if (Argc != 1) {\r
-    Error (NULL, 0, 0, Argv[1], "extra arguments on command line");\r
-    return STATUS_ERROR;\r
-  }\r
-\r
-  strcpy (mOptions.InFileName, Argv[0]);\r
-  return STATUS_SUCCESS;\r
-}\r
-\r
-static\r
-void\r
-Usage (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
-  Print usage information for this utility.\r
-\r
-Arguments:\r
-\r
-  None.\r
-\r
-Returns:\r
-\r
-  Nothing.\r
-\r
---*/\r
-{\r
-  int               Index;\r
-  static const char *Msg[] = {\r
-    UTILITY_NAME " version "UTILITY_VERSION " - TE image utility",\r
-    "  Generate a TE image from an EFI PE32 image",\r
-    "  Usage: "UTILITY_NAME " {-v} {-dump} {-h|-?} {-o OutFileName} InFileName",\r
-    "                [-e|-b] [FileName(s)]",\r
-    "    where:",\r
-    "      -v             - for verbose output",\r
-    "      -dump          - to dump the input file to a text file",\r
-    "      -h -?          - for this help information",\r
-    "      -o OutFileName - to write output to OutFileName rather than InFileName"DEFAULT_OUTPUT_EXTENSION,\r
-    "      InFileName     - name of the input PE32 file",\r
-    "",\r
-    NULL\r
-  };\r
-  for (Index = 0; Msg[Index] != NULL; Index++) {\r
-    fprintf (stdout, "%s\n", Msg[Index]);\r
-  }\r
-}\r
-\r
-static\r
-VOID\r
-DumpImage (\r
-  INT8    *FileName\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
-  Dump a specified image information\r
-\r
-Arguments:\r
-  \r
-  FileName - File name pointer to the image to dump\r
-\r
-Returns:\r
-\r
-  Nothing.\r
-\r
---*/\r
-{\r
-  FILE                *InFptr;\r
-  EFI_TE_IMAGE_HEADER TEImageHeader;\r
-  INT8                *NamePtr;\r
-\r
-  //\r
-  // Open the input file\r
-  //\r
-  InFptr  = NULL;\r
-\r
-  if ((InFptr = fopen (FileName, "rb")) == NULL) {\r
-    Error (NULL, 0, 0, FileName, "failed to open input file for reading");\r
-    return ;\r
-  }\r
-\r
-  if (fread (&TEImageHeader, sizeof (EFI_TE_IMAGE_HEADER), 1, InFptr) != 1) {\r
-    Error (NULL, 0, 0, FileName, "failed to read image header from input file");\r
-    goto Finish;\r
-  }\r
-\r
-  if (TEImageHeader.Signature != EFI_TE_IMAGE_HEADER_SIGNATURE) {\r
-    Error (NULL, 0, 0, FileName, "Image does not appear to be a TE image (bad signature)");\r
-    goto Finish;\r
-  }\r
-  //\r
-  // Dump the header\r
-  //\r
-  fprintf (stdout, "Header (%d bytes):\n", sizeof (EFI_TE_IMAGE_HEADER));\r
-  fprintf (stdout, "  Signature:          0x%04X (TE)\n", (UINT32) TEImageHeader.Signature);\r
-  NamePtr = GetMachineTypeStr (TEImageHeader.Machine);\r
-  fprintf (stdout, "  Machine:            0x%04X (%s)\n", (UINT32) TEImageHeader.Machine, NamePtr);\r
-  NamePtr = GetSubsystemTypeStr (TEImageHeader.Subsystem);\r
-  fprintf (stdout, "  Subsystem:          0x%02X (%s)\n", (UINT32) TEImageHeader.Subsystem, NamePtr);\r
-  fprintf (stdout, "  Number of sections  0x%02X\n", (UINT32) TEImageHeader.NumberOfSections);\r
-  fprintf (stdout, "  Stripped size:      0x%04X\n", (UINT32) TEImageHeader.StrippedSize);\r
-  fprintf (stdout, "  Entry point:        0x%08X\n", TEImageHeader.AddressOfEntryPoint);\r
-  fprintf (stdout, "  Base of code:       0x%08X\n", TEImageHeader.BaseOfCode);\r
-  fprintf (stdout, "  Data directories:\n");\r
-  fprintf (\r
-    stdout,\r
-    "    %8X [%8X] RVA [size] of Base Relocation Directory\n",\r
-    TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC].VirtualAddress,\r
-    TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC].Size\r
-    );\r
-  fprintf (\r
-    stdout,\r
-    "    %8X [%8X] RVA [size] of Debug Directory\n",\r
-    TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress,\r
-    TEImageHeader.DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].Size\r
-    );\r
-\r
-Finish:\r
-  if (InFptr != NULL) {\r
-    fclose (InFptr);\r
-  }\r
-}\r
-\r
-static\r
-INT8 *\r
-GetMachineTypeStr (\r
-  UINT16    MachineType\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  MachineType - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
-{\r
-  int Index;\r
-\r
-  for (Index = 0; mMachineTypes[Index].Name != NULL; Index++) {\r
-    if (mMachineTypes[Index].Value == MachineType) {\r
-      return mMachineTypes[Index].Name;\r
-    }\r
-  }\r
-\r
-  return "unknown";\r
-}\r
-\r
-static\r
-INT8 *\r
-GetSubsystemTypeStr (\r
-  UINT16  SubsystemType\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  SubsystemType - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  GC_TODO: add return values\r
-\r
---*/\r
-{\r
-  int Index;\r
-\r
-  for (Index = 0; mSubsystemTypes[Index].Name != NULL; Index++) {\r
-    if (mSubsystemTypes[Index].Value == SubsystemType) {\r
-      return mSubsystemTypes[Index].Name;\r
-    }\r
-  }\r
-\r
-  return "unknown";\r
-}\r