\r
=== STATUS ===\r
\r
-Current status: Alpha\r
-\r
Current capabilities:\r
* IA32 and X64 architectures\r
* QEMU (0.10.0 or later)\r
\r
=== FUTURE PLANS ===\r
\r
-* Stabilize UEFI Linux boot\r
* Test/Stabilize UEFI Self-Certification Tests (SCT) results\r
\r
=== BUILDING OVMF ===\r
\r
=== RUNNING OVMF on QEMU ===\r
\r
-* QEMU 0.9.1 or later is required.\r
-* Either copy, rename or symlink OVMF.FD => bios.bin\r
+* QEMU 0.12.2 or later is required.\r
* Be sure to use qemu-system-x86_64, if you are using and X64 firmware.\r
(qemu-system-x86_64 works for the IA32 firmware as well, of course.)\r
-* Use the QEMU -L parameter to specify the directory where the bios.bin\r
- file is located.\r
+* Use OVMF for QEMU firmware (3 options available)\r
+ - Option 1: QEMU 1.6 or newer; Use QEMU -pflash parameter\r
+ * QEMU/OVMF will use emulated flash, and fully support UEFI variables\r
+ * Run qemu with: -pflash path/to/OVMF.fd\r
+ - Option 2: Use QEMU -bios parameter\r
+ * Note that UEFI variables will be partially emulated, and non-volatile\r
+ variables may lose their contents after a reboot\r
+ * Run qemu with: -bios path/to/OVMF.fd\r
+ - Option 3: Use QEMU -L parameter\r
+ * Note that UEFI variables will be partially emulated, and non-volatile\r
+ variables may lose their contents after a reboot\r
+ * Either copy, rename or symlink OVMF.fd => bios.bin\r
+ * Use the QEMU -L parameter to specify the directory where the bios.bin\r
+ file is located.\r
* The EFI shell is built into OVMF builds at this time, so it should\r
run automatically if a UEFI boot application is not found on the\r
removable media.\r
\r
=== Network Support ===\r
\r
-OVMF provides a generic UEFI network stack by default, with the lowest level\r
-driver (the NIC driver) missing in the default build. In order to complete the\r
-stack and make eg. DHCP, PXE Boot, and socket test utilities from the StdLib\r
-edk2 package work, (1) qemu has to be configured to emulate a NIC, (2) a\r
-matching UEFI NIC driver must be available when OVMF boots.\r
+OVMF provides a UEFI network stack by default. Its lowest level driver is the\r
+NIC driver, higher levels are generic. In order to make DHCP, PXE Boot, and eg.\r
+socket test utilities from the StdLib edk2 package work, (1) qemu has to be\r
+configured to emulate a NIC, (2) a matching UEFI NIC driver must be available\r
+when OVMF boots.\r
\r
(If a NIC is configured for the virtual machine, and -- dependent on boot order\r
-- PXE booting is attempted, but no DHCP server responds to OVMF's DHCP\r
* For each NIC emulated by qemu, a GPLv2 licensed UEFI driver is available from\r
the iPXE project. The qemu source distribution, starting with version 1.5,\r
contains prebuilt binaries of these drivers (and of course allows one to\r
- rebuild them from source as well).\r
+ rebuild them from source as well). This is the recommended set of drivers.\r
\r
* Use the qemu -netdev and -device options, or the legacy -net option, to\r
enable NIC support: <http://wiki.qemu.org/Documentation/Networking>.\r
\r
* For a qemu >= 1.5 binary running *without* any "-M machine" option where\r
"machine" would identify a < qemu-1.5 configuration (for example: "-M\r
- pc-i440fx-1.4" or "-M pc-0.13"), the drivers are available from the default\r
- qemu installation to OVMF without further settings.\r
+ pc-i440fx-1.4" or "-M pc-0.13"), the iPXE drivers are automatically available\r
+ to and configured for OVMF in the default qemu installation.\r
\r
* For a qemu binary in [0.13, 1.5), or a qemu >= 1.5 binary with an "-M\r
machine" option where "machine" selects a < qemu-1.5 configuration:\r
\r
- download a >= 1.5.0-rc1 source tarball from <http://wiki.qemu.org/Download>,\r
\r
- - extract the following files from the tarball and install them in a\r
- location that is accessible to qemu processes (this may depend on your\r
+ - extract the following iPXE driver files from the tarball and install them\r
+ in a location that is accessible to qemu processes (this may depend on your\r
SELinux configuration, for example):\r
\r
qemu-VERSION/pc-bios/efi-e1000.rom\r
-device rtl8139,...,romfile=/full/path/to/efi-rtl8139.rom\r
-device virtio-net-pci,...,romfile=/full/path/to/efi-virtio.rom\r
\r
-* Independently of the iPXE NIC drivers, Intel's proprietary E1000 NIC driver\r
- can be embedded in the OVMF image at build time, as an alternative guest\r
- driver for "-device e1000":\r
+* Independently of the iPXE NIC drivers, the default OVMF build provides a\r
+ basic virtio-net driver, located in OvmfPkg/VirtioNetDxe.\r
+\r
+* Also independently of the iPXE NIC drivers, Intel's proprietary E1000 NIC\r
+ driver (PROEFI) can be embedded in the OVMF image at build time:\r
\r
- Download UEFI drivers for the e1000 NIC\r
- http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng\r
- Add "-D E1000_ENABLE -D FD_SIZE_2MB" to your build command,\r
- For example: "build -D E1000_ENABLE -D FD_SIZE_2MB".\r
\r
+* When a matching iPXE driver is configured for a NIC as described above, it\r
+ takes priority over other drivers that could possibly drive the card too:\r
+\r
+ | e1000 ne2k_pci pcnet rtl8139 virtio-net-pci\r
+ -------------+------------------------------------------------\r
+ iPXE | x x x x x\r
+ VirtioNetDxe | x\r
+ Intel PROEFI | x\r
+\r
+=== OVMF Flash Layout ===\r
+\r
+Like all current IA32/X64 system designs, OVMF's firmware\r
+device (rom/flash) appears in QEMU's physical address space\r
+just below 4GB (0x100000000).\r
+\r
+The layout of the firmware device in memory looks like:\r
+\r
++--------------------------------------- 4GB (0x100000000)\r
+| VTF0 (16-bit reset code) and OVMF SEC\r
+| (SECFV)\r
++--------------------------------------- varies based on flash size\r
+|\r
+| Compressed main firmware image\r
+| (FVMAIN_COMPACT)\r
+|\r
++--------------------------------------- base + 0x20000\r
+| Fault-tolerant write (FTW)\r
+| Spare blocks (64KB/0x10000)\r
++--------------------------------------- base + 0x10000\r
+| FTW Work block (4KB/0x1000)\r
++--------------------------------------- base + 0x0f000\r
+| Event log area (4KB/0x1000)\r
++--------------------------------------- base + 0x0e000\r
+| Non-volatile variable storage\r
+| area (56KB/0xe000)\r
++--------------------------------------- base address\r
+\r
+OVMF supports building a 1MB or a 2MB flash image. The base address for\r
+a 1MB image in QEMU physical memory is 0xfff00000. The base address for\r
+a 2MB image is 0xffe00000.\r
+\r
+The code in SECFV locates FVMAIN_COMPACT, and decompresses the\r
+main firmware (MAINFV) into RAM memory at address 0x800000. The\r
+remaining OVMF firmware then uses this decompressed firmware\r
+volume image.\r
+\r
=== UNIXGCC Debug ===\r
\r
If you build with the UNIXGCC toolchain, then debugging will be disabled\r
projects / mirror_edk2.git / blobdiff