]>
Commit | Line | Data |
---|---|---|
49ba9447 | 1 | \r |
2 | === OVMF OVERVIEW ===\r | |
3 | \r | |
4 | The Open Virtual Machine Firmware (OVMF) project aims\r | |
5 | to support firmware for Virtual Machines using the edk2\r | |
6 | code base. More information can be found at:\r | |
7 | \r | |
c315da0a | 8 | http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=OVMF\r |
49ba9447 | 9 | \r |
10 | === STATUS ===\r | |
11 | \r | |
49ba9447 | 12 | Current capabilities:\r |
13 | * IA32 and X64 architectures\r | |
73f4a1c0 | 14 | * QEMU (0.10.0 or later)\r |
49ba9447 | 15 | - Video, keyboard, IDE, CD-ROM, serial\r |
16 | - Runs UEFI shell\r | |
7416f4eb | 17 | - Optional NIC support. Requires QEMU (0.12.2 or later)\r |
73f4a1c0 | 18 | * UEFI Linux boots\r |
19 | * UEFI Windows 8 boots\r | |
49ba9447 | 20 | \r |
21 | === FUTURE PLANS ===\r | |
22 | \r | |
49ba9447 | 23 | * Test/Stabilize UEFI Self-Certification Tests (SCT) results\r |
24 | \r | |
37e97c51 | 25 | === BUILDING OVMF ===\r |
26 | \r | |
27 | Pre-requisites:\r | |
28 | * Build environment capable of build the edk2 MdeModulePkg.\r | |
66325870 | 29 | * A properly configured ASL compiler:\r |
30 | - Intel ASL compiler: Available from http://www.acpica.org\r | |
31 | - Microsoft ASL compiler: Available from http://www.acpi.info\r | |
37e97c51 | 32 | \r |
33 | Update Conf/target.txt ACTIVE_PLATFORM for OVMF:\r | |
34 | PEI arch DXE arch UEFI interfaces\r | |
35 | * OvmfPkg/OvmfPkgIa32.dsc IA32 IA32 IA32\r | |
36 | * OvmfPkg/OvmfPkgIa32X64.dsc IA32 X64 X64\r | |
37 | * OvmfPkg/OvmfPkgX64.dsc X64 X64 X64\r | |
38 | \r | |
2dae09a5 | 39 | Update Conf/target.txt TARGET_ARCH based on the .dsc file:\r |
40 | TARGET_ARCH\r | |
41 | * OvmfPkg/OvmfPkgIa32.dsc IA32\r | |
42 | * OvmfPkg/OvmfPkgIa32X64.dsc IA32 X64\r | |
43 | * OvmfPkg/OvmfPkgX64.dsc X64\r | |
44 | \r | |
45 | Following the edk2 build process, you will find the OVMF binaries\r | |
46 | under the $WORKSPACE/Build/*/*/FV directory. The actual path will\r | |
47 | depend on how your build is configured. You can expect to find\r | |
48 | these binary outputs:\r | |
7416f4eb | 49 | * OVMF.FD\r |
66325870 | 50 | - Please note! This filename has changed. Older releases used OVMF.Fv.\r |
922f593a | 51 | * OvmfVideo.rom\r |
e79095b7 | 52 | - This file is not built separately any longer, starting with svn r13520.\r |
2dae09a5 | 53 | \r |
54 | More information on building OVMF can be found at:\r | |
c315da0a | 55 | \r |
56 | http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF\r | |
37e97c51 | 57 | \r |
58 | === RUNNING OVMF on QEMU ===\r | |
59 | \r | |
210c880f | 60 | * QEMU 0.12.2 or later is required.\r |
37e97c51 | 61 | * Be sure to use qemu-system-x86_64, if you are using and X64 firmware.\r |
62 | (qemu-system-x86_64 works for the IA32 firmware as well, of course.)\r | |
210c880f JJ |
63 | * Use OVMF for QEMU firmware (3 options available)\r |
64 | - Option 1: QEMU 1.6 or newer; Use QEMU -pflash parameter\r | |
65 | * QEMU/OVMF will use emulated flash, and fully support UEFI variables\r | |
66 | * Run qemu with: -pflash path/to/OVMF.fd\r | |
67 | - Option 2: Use QEMU -bios parameter\r | |
68 | * Note that UEFI variables will be partially emulated, and non-volatile\r | |
69 | variables may lose their contents after a reboot\r | |
70 | * Run qemu with: -bios path/to/OVMF.fd\r | |
71 | - Option 3: Use QEMU -L parameter\r | |
72 | * Note that UEFI variables will be partially emulated, and non-volatile\r | |
73 | variables may lose their contents after a reboot\r | |
74 | * Either copy, rename or symlink OVMF.fd => bios.bin\r | |
75 | * Use the QEMU -L parameter to specify the directory where the bios.bin\r | |
76 | file is located.\r | |
37e97c51 | 77 | * The EFI shell is built into OVMF builds at this time, so it should\r |
78 | run automatically if a UEFI boot application is not found on the\r | |
79 | removable media.\r | |
aed8e2ec | 80 | * On Linux, newer version of QEMU may enable KVM feature, and this might\r |
81 | cause OVMF to fail to boot. The QEMU '-no-kvm' may allow OVMF to boot.\r | |
bf23b44d | 82 | * Capturing OVMF debug messages on qemu:\r |
83 | - The default OVMF build writes debug messages to IO port 0x402. The\r | |
84 | following qemu command line options save them in the file called\r | |
85 | debug.log: '-debugcon file:debug.log -global isa-debugcon.iobase=0x402'.\r | |
86 | - It is possible to revert to the original behavior, when debug messages were\r | |
87 | written to the emulated serial port (potentially intermixing OVMF debug\r | |
88 | output with UEFI serial console output). For this the\r | |
89 | '-D DEBUG_ON_SERIAL_PORT' option has to be passed to the build command (see\r | |
90 | the next section), and in order to capture the serial output qemu needs to\r | |
91 | be started with eg. '-serial file:serial.log'.\r | |
92 | - Debug messages fall into several categories. Logged vs. suppressed\r | |
93 | categories are controlled at OVMF build time by the\r | |
94 | 'gEfiMdePkgTokenSpaceGuid.PcdDebugPrintErrorLevel' bitmask (an UINT32\r | |
95 | value) in the selected .dsc file. Individual bits of this bitmask are\r | |
96 | defined in <MdePkg/Include/Library/DebugLib.h>. One non-default bit (with\r | |
97 | some performance impact) that is frequently set for debugging is 0x00400000\r | |
98 | (DEBUG_VERBOSE).\r | |
99 | - The RELEASE build target ('-b RELEASE' build option, see below) disables\r | |
100 | all debug messages. The default build target is DEBUG.\r | |
5a9745b9 | 101 | \r |
102 | === Build Scripts ===\r | |
103 | \r | |
66325870 | 104 | On systems with the bash shell you can use OvmfPkg/build.sh to simplify\r |
105 | building and running OVMF.\r | |
5a9745b9 | 106 | \r |
107 | So, for example, to build + run OVMF X64:\r | |
66325870 | 108 | $ OvmfPkg/build.sh -a X64\r |
109 | $ OvmfPkg/build.sh -a X64 qemu\r | |
5a9745b9 | 110 | \r |
111 | And to run a 64-bit UEFI bootable ISO image:\r | |
66325870 | 112 | $ OvmfPkg/build.sh -a X64 qemu -cdrom /path/to/disk-image.iso\r |
113 | \r | |
bf23b44d | 114 | To build a 32-bit OVMF without debug messages using GCC 4.5:\r |
66325870 | 115 | $ OvmfPkg/build.sh -a IA32 -b RELEASE -t GCC45\r |
5a9745b9 | 116 | \r |
aed8e2ec | 117 | === Network Support ===\r |
118 | \r | |
7a1f5947 LE |
119 | OVMF provides a UEFI network stack by default. Its lowest level driver is the\r |
120 | NIC driver, higher levels are generic. In order to make DHCP, PXE Boot, and eg.\r | |
121 | socket test utilities from the StdLib edk2 package work, (1) qemu has to be\r | |
122 | configured to emulate a NIC, (2) a matching UEFI NIC driver must be available\r | |
123 | when OVMF boots.\r | |
7628b0f5 | 124 | \r |
125 | (If a NIC is configured for the virtual machine, and -- dependent on boot order\r | |
126 | -- PXE booting is attempted, but no DHCP server responds to OVMF's DHCP\r | |
127 | DISCOVER message at startup, the boot process may take approx. 3 seconds\r | |
128 | longer.)\r | |
129 | \r | |
130 | * For each NIC emulated by qemu, a GPLv2 licensed UEFI driver is available from\r | |
131 | the iPXE project. The qemu source distribution, starting with version 1.5,\r | |
132 | contains prebuilt binaries of these drivers (and of course allows one to\r | |
7a1f5947 | 133 | rebuild them from source as well). This is the recommended set of drivers.\r |
7628b0f5 | 134 | \r |
135 | * Use the qemu -netdev and -device options, or the legacy -net option, to\r | |
136 | enable NIC support: <http://wiki.qemu.org/Documentation/Networking>.\r | |
137 | \r | |
138 | * For a qemu >= 1.5 binary running *without* any "-M machine" option where\r | |
139 | "machine" would identify a < qemu-1.5 configuration (for example: "-M\r | |
7a1f5947 LE |
140 | pc-i440fx-1.4" or "-M pc-0.13"), the iPXE drivers are automatically available\r |
141 | to and configured for OVMF in the default qemu installation.\r | |
7628b0f5 | 142 | \r |
143 | * For a qemu binary in [0.13, 1.5), or a qemu >= 1.5 binary with an "-M\r | |
144 | machine" option where "machine" selects a < qemu-1.5 configuration:\r | |
145 | \r | |
146 | - download a >= 1.5.0-rc1 source tarball from <http://wiki.qemu.org/Download>,\r | |
147 | \r | |
7a1f5947 LE |
148 | - extract the following iPXE driver files from the tarball and install them\r |
149 | in a location that is accessible to qemu processes (this may depend on your\r | |
7628b0f5 | 150 | SELinux configuration, for example):\r |
151 | \r | |
152 | qemu-VERSION/pc-bios/efi-e1000.rom\r | |
153 | qemu-VERSION/pc-bios/efi-ne2k_pci.rom\r | |
154 | qemu-VERSION/pc-bios/efi-pcnet.rom\r | |
155 | qemu-VERSION/pc-bios/efi-rtl8139.rom\r | |
156 | qemu-VERSION/pc-bios/efi-virtio.rom\r | |
157 | \r | |
158 | - extend the NIC's -device option on the qemu command line with a matching\r | |
159 | "romfile=" optarg:\r | |
160 | \r | |
161 | -device e1000,...,romfile=/full/path/to/efi-e1000.rom\r | |
162 | -device ne2k_pci,...,romfile=/full/path/to/efi-ne2k_pci.rom\r | |
163 | -device pcnet,...,romfile=/full/path/to/efi-pcnet.rom\r | |
164 | -device rtl8139,...,romfile=/full/path/to/efi-rtl8139.rom\r | |
165 | -device virtio-net-pci,...,romfile=/full/path/to/efi-virtio.rom\r | |
166 | \r | |
7a1f5947 LE |
167 | * Independently of the iPXE NIC drivers, the default OVMF build provides a\r |
168 | basic virtio-net driver, located in OvmfPkg/VirtioNetDxe.\r | |
169 | \r | |
170 | * Also independently of the iPXE NIC drivers, Intel's proprietary E1000 NIC\r | |
171 | driver (PROEFI) can be embedded in the OVMF image at build time:\r | |
7628b0f5 | 172 | \r |
173 | - Download UEFI drivers for the e1000 NIC\r | |
174 | - http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng\r | |
175 | - Install the drivers into a directory called Intel3.5 in your WORKSPACE.\r | |
176 | \r | |
177 | - Include the driver in OVMF during the build:\r | |
178 | - Add "-D E1000_ENABLE -D FD_SIZE_2MB" to your build command,\r | |
179 | - For example: "build -D E1000_ENABLE -D FD_SIZE_2MB".\r | |
aed8e2ec | 180 | \r |
7a1f5947 LE |
181 | * When a matching iPXE driver is configured for a NIC as described above, it\r |
182 | takes priority over other drivers that could possibly drive the card too:\r | |
183 | \r | |
184 | | e1000 ne2k_pci pcnet rtl8139 virtio-net-pci\r | |
185 | -------------+------------------------------------------------\r | |
186 | iPXE | x x x x x\r | |
187 | VirtioNetDxe | x\r | |
188 | Intel PROEFI | x\r | |
189 | \r | |
e58e5bcd JJ |
190 | === OVMF Flash Layout ===\r |
191 | \r | |
192 | Like all current IA32/X64 system designs, OVMF's firmware\r | |
193 | device (rom/flash) appears in QEMU's physical address space\r | |
194 | just below 4GB (0x100000000).\r | |
195 | \r | |
196 | The layout of the firmware device in memory looks like:\r | |
197 | \r | |
198 | +--------------------------------------- 4GB (0x100000000)\r | |
199 | | VTF0 (16-bit reset code) and OVMF SEC\r | |
200 | | (SECFV)\r | |
201 | +--------------------------------------- varies based on flash size\r | |
202 | |\r | |
203 | | Compressed main firmware image\r | |
204 | | (FVMAIN_COMPACT)\r | |
205 | |\r | |
206 | +--------------------------------------- base + 0x20000\r | |
207 | | Fault-tolerant write (FTW)\r | |
208 | | Spare blocks (64KB/0x10000)\r | |
209 | +--------------------------------------- base + 0x10000\r | |
210 | | FTW Work block (4KB/0x1000)\r | |
211 | +--------------------------------------- base + 0x0f000\r | |
212 | | Event log area (4KB/0x1000)\r | |
213 | +--------------------------------------- base + 0x0e000\r | |
214 | | Non-volatile variable storage\r | |
215 | | area (56KB/0xe000)\r | |
216 | +--------------------------------------- base address\r | |
217 | \r | |
218 | OVMF supports building a 1MB or a 2MB flash image. The base address for\r | |
219 | a 1MB image in QEMU physical memory is 0xfff00000. The base address for\r | |
220 | a 2MB image is 0xffe00000.\r | |
221 | \r | |
222 | The code in SECFV locates FVMAIN_COMPACT, and decompresses the\r | |
223 | main firmware (MAINFV) into RAM memory at address 0x800000. The\r | |
224 | remaining OVMF firmware then uses this decompressed firmware\r | |
225 | volume image.\r | |
226 | \r | |
0b5a5022 | 227 | === UNIXGCC Debug ===\r |
228 | \r | |
229 | If you build with the UNIXGCC toolchain, then debugging will be disabled\r | |
230 | due to larger image sizes being produced by the UNIXGCC toolchain. The\r | |
231 | first choice recommendation is to use GCC44 or newer instead.\r | |
232 | \r | |
233 | If you must use UNIXGCC, then you can override the build options for\r | |
234 | particular libraries and modules in the .dsc to re-enable debugging\r | |
235 | selectively. For example:\r | |
236 | [Components]\r | |
237 | OvmfPkg/Library/PlatformBdsLib/PlatformBdsLib.inf {\r | |
238 | <BuildOptions>\r | |
239 | GCC:*_*_*_CC_FLAGS = -UMDEPKG_NDEBUG\r | |
240 | }\r | |
241 | IntelFrameworkModulePkg/Universal/BdsDxe/BdsDxe.inf {\r | |
242 | <BuildOptions>\r | |
243 | GCC:*_*_*_CC_FLAGS = -UMDEPKG_NDEBUG\r | |
244 | }\r | |
245 | \r |