projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 40d841f6 LG |
1 | {\rtf1\ansi\ansicpg1252\deff0\deflang1033\deflangfe2052\deftab360{\fonttbl{\f0\fswiss\fprq2\fcharset0 Verdana;}{\f1\froman\fprq2\fcharset0 Times New Roman;}}\r |
| 2 | {\colortbl ;\red8\green96\blue168;\red0\green0\blue0;}\r | |
| 3 | {\stylesheet{ Normal;}{\s1 heading 1;}{\s2 heading 2;}}\r | |
| 4 | {\*\generator Msftedit 5.41.15.1515;}\viewkind4\uc1\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Name\par\r | |
| 5 | \pard\nowidctlpar\sb200\cf2\b0\fs18 EfiRom.exe - build an Option ROM image\par\r | |
| 6 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Synopsis\par\r | |
| 7 | \pard\nowidctlpar\sb200\cf2\fs18 EfiRom.exe [options] Filename [Filename]\'85\par\r | |
| 8 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\fs28 Description\par\r | |
| 9 | \pard\nowidctlpar\sb200\cf2\b0\fs18 EfiRom is used to build an Option ROM image from UEFI PE32 file(s) and/or legacy option ROM images that conform to PCI 2.3 or PCI 3.0 specifications for Option ROM layout. The EfiRom utility performs some rudimentary checking on the input Portable Executable (PE) PE32 files to verify they are indeed PE32 images. These checks include:\par\r | |
| 10 | \pard\nowidctlpar\li360\sb200 Verification that the DOS stub magic value is 0x5A4D\par\r | |
| 11 | Verification that the PE signature is \ldblquote PE\\0\\0\rdblquote\par\r | |
| 12 | \pard\nowidctlpar\sb200 If either of these checks fails then the utility will abort without creating the output ROM image file.\par\r | |
| 13 | This utility performs some rudimentary checking of the input binary files to verify they are indeed valid option ROM images. These checks include:\par\r | |
| 14 | \pard\nowidctlpar\li360\sb200 Verification that the signature of the option ROM header is 0xAA55\par\r | |
| 15 | Verification that the offset to the PCI data structure is within the range of the file size.\par\r | |
| 16 | Verification that the signature of the PCI data structure is \ldblquote PCIR\rdblquote .\par\r | |
| 17 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Options\par\r | |
| 18 | \pard\nowidctlpar\sb200\cf2\fs18 Filename1 [FilenameN]\par\r | |
| 19 | \pard\nowidctlpar\li360\sb200\b0 Input PE/PE32+/COFF or legacy option ROM image file(s).\par\r | |
| 20 | \pard\nowidctlpar\sb200\b -o, --output RomFilename\par\r | |
| 21 | \pard\nowidctlpar\li360\sb200\b0 The ROM filename being created. If not specified, use the first input filename as name and *.rom as the output filename extension.\par\r | |
| 22 | \pard\nowidctlpar\sb200\b -e, --efi\par\r | |
| 23 | \pard\nowidctlpar\li360\sb200\b0 Input PE/PE32+/COFF file(s)\par\r | |
| 24 | \pard\nowidctlpar\sb200\b -b, --binary\par\r | |
| 25 | \pard\nowidctlpar\li360\sb200\b0 Input legacy option ROM image files.\par\r | |
| 26 | \pard\nowidctlpar\sb200\b -ec, --compress\par\r | |
| 27 | \pard\nowidctlpar\li360\sb200\b0 Compress input PE/PE32+/COFF file.\par\r | |
| 28 | \pard\nowidctlpar\sb200\b -n, --no-last-bit\par\r | |
| 29 | \pard\nowidctlpar\li360\sb200\b0 Do not set the LAST bit on the last file.\par\r | |
| 30 | \pard\nowidctlpar\sb200\lang1036\b -l ClassCode, --class-code=ClassCode\par\r | |
| 31 | \pard\nowidctlpar\li360\sb200\lang1033\b0 Use ClassCode in the PCI data structure header in the input file.\par\r | |
| 32 | \pard\nowidctlpar\sb200\b -r Rev, --Revision=Rev\par\r | |
| 33 | \pard\nowidctlpar\li360\sb200\b0 Use Rev in the PCI data structure header in the input file.\par\r | |
| 34 | \pard\nowidctlpar\sb200\b -p, --pci23\par\r | |
| 35 | \pard\nowidctlpar\li360\sb200\b0 Default layout meets PCI 3.0 specifications, specifying this flag will for a PCI 2.3 layout.\par\r | |
| 36 | \pard\nowidctlpar\sb200\b -d, --dump\par\r | |
| 37 | \pard\nowidctlpar\li360\sb200\b0 Dump the header of input option ROM image\par\r | |
| 38 | \pard\nowidctlpar\sb200\b -i, --device-id\par\r | |
| 39 | \pard\nowidctlpar\li360\sb200\b0 Device ID \par\r | |
| 40 | \pard\nowidctlpar\sb200\b -f, --vendor-id\par\r | |
| 41 | \pard\nowidctlpar\li360\sb200\b0 Vendor ID\par\r | |
| 42 | \pard\nowidctlpar\sb200\b --version\par\r | |
| 43 | \pard\nowidctlpar\li360\sb200\b0 Print version and copyright of this program then exit.\par\r | |
| 44 | \pard\nowidctlpar\sb200\b -v, --verbose\par\r | |
| 45 | \pard\nowidctlpar\li360\sb200\b0 Turn on verbose output with informational messages printed. This is a count value, so specifying \endash vv can be used to increase the verbosity level.\par\r | |
| 46 | \pard\nowidctlpar\sb200\b -q, --quiet\par\r | |
| 47 | \pard\nowidctlpar\li360\sb200\b0 Disable all messages except FATAL ERRORS.\par\r | |
| 48 | \pard\nowidctlpar\sb200\b -d, --debug [#]\par\r | |
| 49 | \pard\nowidctlpar\li360\sb200\b0 Enable debug messages, at level #.\par\r | |
| 50 | \pard\nowidctlpar\sb200\b -h, --help\par\r | |
| 51 | \pard\nowidctlpar\li360\sb200\b0 Print the copyright, version and usage of this program then exit.\par\r | |
| 52 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Examples\par\r | |
| 53 | \pard\nowidctlpar\sb200\cf2\b0\fs18 Generate the Option ROM with two efi binary files and one legacy binary file. The output filename is not specified in command line, so the output filename will be \ldblquote File1.rom\rdblquote . The output filename is the same as the first input filename with the extension \ldblquote .rom\rdblquote\par\r | |
| 54 | \b EfiRom \endash e File1.efi File2.efi \endash b Legacy.bin\par\r | |
| 55 | \b0 Generate the Option ROM with two efi binary files and one legacy binary file with the output filename specified on the command line.\par\r | |
| 56 | \b EfiRom \endash o file.rom \endash e File1.efi File2.efi \endash b Legacy.bin\par\r | |
| 57 | \b0 Generate the Option ROM with two efi binary files and one legacy binary file. The output filename is not specified in command line, so the output filename will be \ldblquote File1.rom\rdblquote . The output filename is the same as the first input filename with the extension \ldblquote .rom\rdblquote . Vendor ID and Device ID are both specified in command line and the efi binary files will be compressed using the Tiano Compression algorithm.\par\r | |
| 58 | \b EfiRom \endash i 0xABCD \endash f 0x1234 \endash ec File1.efi File2.efi \endash b Legacy.bin\par\r | |
| 59 | \b0 Generate the Option ROM with two efi binary files and one legacy binary file with the output filename is specified in command line. Vendor ID and Device ID are both specified in command line and the efi binary files will be compressed using the Tiano Compression algorithm.\par\r | |
| 60 | \b EfiRom \endash o file.rom \endash i 0xABCD \endash f 0x1234 \endash ec File1.efi File2.efi \endash b Legacy.bin\par\r | |
| 61 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\fs28 Bugs\par\r | |
| 62 | \pard\nowidctlpar\sb200\cf2\b0\fs18 No known bugs.\par\r | |
| 63 | Report bugs to edk2-buildtools-devel@lists.sourceforge.net\f1\par\r | |
| 64 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Files\par\r | |
| 65 | \pard\nowidctlpar\sb200\cf2\b0\fs18 None\par\r | |
| 66 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 See also\par\r | |
| 67 | \pard\nowidctlpar\sb200\cf2\b0\fs18 None\par\r | |
| 68 | \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 License\par\r | |
| 69 | \pard\nowidctlpar\cf2\b0\fs18 Copyright (c) 1999 - 2009, Intel Corporation. All rights reserved.\par\r | |
| 70 | This program and the accompanying materials are licensed and made available \par\r | |
| 71 | under the terms and conditions of the BSD License which accompanies this \par\r | |
| 72 | distribution. The full text of the license may be found at\par\r | |
| 73 | http://opensource.org/licenses/bsd-license.php\par\r | |
| 74 | \par\r | |
| 75 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par\r | |
| 76 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par\r | |
| 77 | }\r | |
| 78 | \0 |