123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353 |
- /** @file
- This file contains the relevant declarations required to generate Option Rom File
- Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #ifndef __EFI_ROM_H__
- #define __EFI_ROM_H__
- #include <stdio.h>
- #include <string.h>
- #include <stdlib.h>
- #include <Common/UefiBaseTypes.h>
- #include <IndustryStandard/PeImage.h> // for PE32 structure definitions
- #include <IndustryStandard/pci22.h> // for option ROM header structures
- #include <IndustryStandard/pci30.h>
- #include "Compress.h"
- #include "CommonLib.h"
- //
- // Version of this utility
- //
- #define UTILITY_NAME "EfiRom"
- #define UTILITY_MAJOR_VERSION 0
- #define UTILITY_MINOR_VERSION 1
- //
- // Define the max length of a filename
- //
- #define MAX_PATH 200
- //
- // Define the default file extension name
- //
- #define DEFAULT_OUTPUT_EXTENSION ".rom"
- //
- // Max size for an option ROM image
- //
- #define MAX_OPTION_ROM_SIZE (1024 * 1024 * 16) // 16MB
- //
- // Values for the indicator field in the PCI data structure
- //
- #define INDICATOR_LAST 0x80 // last file in series of files
- //
- // Masks for the FILE_LIST.FileFlags field
- //
- #define FILE_FLAG_BINARY 0x01
- #define FILE_FLAG_EFI 0x02
- #define FILE_FLAG_COMPRESS 0x04
- //
- // Use this linked list structure to keep track of all the filenames
- // specified on the command line.
- //
- typedef struct _FILE_LIST {
- struct _FILE_LIST *Next;
- CHAR8 *FileName;
- UINT32 FileFlags;
- UINT32 ClassCode;
- UINT16 CodeRevision;
- } FILE_LIST;
- //
- // Use this to track our command-line options
- //
- typedef struct {
- CHAR8 OutFileName[MAX_PATH];
- INT8 NoLast;
- UINT16 ClassCode;
- UINT16 PciRevision;
- UINT16 VendId;
- UINT16 *DevIdList;
- UINT32 DevIdCount;
- UINT8 VendIdValid;
- INT8 Verbose;
- INT8 Quiet;
- INT8 Debug;
- INT8 Pci23;
- INT8 Pci30;
- INT8 DumpOption;
- // INT8 Help;
- // INT8 Version;
- FILE_LIST *FileList;
- } OPTIONS;
- //
- // Make a global structure to keep track of command-line options
- //
- static OPTIONS mOptions;
- //
- // Use these to convert from machine type value to a named type
- //
- typedef struct {
- UINT16 Value;
- CHAR8 *Name;
- } STRING_LOOKUP;
- //
- // Machine Types
- //
- static STRING_LOOKUP mMachineTypes[] = {
- { EFI_IMAGE_MACHINE_IA32, "IA32" },
- { EFI_IMAGE_MACHINE_X64, "X64" },
- { EFI_IMAGE_MACHINE_EBC, "EBC" },
- { EFI_IMAGE_MACHINE_ARMT, "ARM" },
- { EFI_IMAGE_MACHINE_AARCH64, "AA64" },
- { 0, NULL }
- };
- //
- // Subsystem Types
- //
- static STRING_LOOKUP mSubsystemTypes[] = {
- { EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION, "EFI application" },
- { EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER, "EFI boot service driver" },
- { EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER, "EFI runtime driver" },
- { 0, NULL }
- };
- //
- // Function prototypes
- //
- static
- void
- Version (
- VOID
- )
- /*++
- Routine Description:
- Displays the utility version to STDOUT
- Arguments:
- None
- Returns:
- None
- --*/
- ;
- static
- void
- Usage (
- VOID
- )
- /*++
- Routine Description:
- Displays the utility usage syntax to STDOUT
- Arguments:
- None
- Returns:
- None
- --*/
- ;
- static
- int
- ParseCommandLine (
- int Argc,
- char *Argv[],
- OPTIONS *Options
- )
- /*++
- Routine Description:
- Given the Argc/Argv program arguments, and a pointer to an options structure,
- parse the command-line options and check their validity.
- Arguments:
- Argc - standard C main() argument count
- Argv[] - standard C main() argument list
- Options - pointer to a structure to store the options in
- Returns:
- STATUS_SUCCESS success
- non-zero otherwise
- --*/
- ;
- static
- int
- CheckPE32File (
- FILE *Fptr,
- UINT16 *MachineType,
- UINT16 *SubSystem
- )
- /*++
- Routine Description:
- Given the Argc/Argv program arguments, and a pointer to an options structure,
- parse the command-line options and check their validity.
- Arguments:
- Argc - standard C main() argument count
- Argv[] - standard C main() argument list
- Options - pointer to a structure to store the options in
- Returns:
- STATUS_SUCCESS success
- non-zero otherwise
- --*/
- ;
- static
- int
- ProcessEfiFile (
- FILE *OutFptr,
- FILE_LIST *InFile,
- UINT16 VendId,
- UINT16 DevId,
- UINT32 *Size
- )
- /*++
- Routine Description:
- Process a PE32 EFI file.
- Arguments:
- OutFptr - file pointer to output binary ROM image file we're creating
- InFile - structure contains information on the PE32 file to process
- VendId - vendor ID as required in the option ROM header
- DevId - device ID as required in the option ROM header
- Size - pointer to where to return the size added to the output file
- Returns:
- 0 - successful
- --*/
- ;
- static
- int
- ProcessBinFile (
- FILE *OutFptr,
- FILE_LIST *InFile,
- UINT32 *Size
- )
- /*++
- Routine Description:
- Process a binary input file.
- Arguments:
- OutFptr - file pointer to output binary ROM image file we're creating
- InFile - structure contains information on the binary file to process
- Size - pointer to where to return the size added to the output file
- Returns:
- 0 - successful
- --*/
- ;
- static
- void
- DumpImage (
- FILE_LIST *InFile
- )
- /*++
- Routine Description:
- Dump the headers of an existing option ROM image
- Arguments:
- InFile - the file name of an existing option ROM image
- Returns:
- none
- --*/
- ;
- char *
- GetMachineTypeStr (
- UINT16 MachineType
- )
- /*++
- Routine Description:
- GC_TODO: Add function description
- Arguments:
- MachineType - GC_TODO: add argument description
- Returns:
- GC_TODO: add return values
- --*/
- ;
- static
- char *
- GetSubsystemTypeStr (
- UINT16 SubsystemType
- )
- /*++
- Routine Description:
- GC_TODO: Add function description
- Arguments:
- SubsystemType - GC_TODO: add argument description
- Returns:
- GC_TODO: add return values
- --*/
- ;
- #endif
|