X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=OvmfPkg%2FREADME;h=147e6e0ebf1403f68f3cf3cc0872fa28dfb446f1;hb=d6970b9b4155db6835629ec938f86490b3ae5091;hp=13058eae47a89c4abcf34ce2be62de829e8da17a;hpb=7628b0f5aaa2b46ffcd3df2e574e6bb487268b92;p=mirror_edk2.git diff --git a/OvmfPkg/README b/OvmfPkg/README index 13058eae47..147e6e0ebf 100644 --- a/OvmfPkg/README +++ b/OvmfPkg/README @@ -5,12 +5,10 @@ The Open Virtual Machine Firmware (OVMF) project aims to support firmware for Virtual Machines using the edk2 code base. More information can be found at: -http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=OVMF +http://www.tianocore.org/ovmf/ === STATUS === -Current status: Alpha - Current capabilities: * IA32 and X64 architectures * QEMU (0.10.0 or later) @@ -19,10 +17,10 @@ Current capabilities: - Optional NIC support. Requires QEMU (0.12.2 or later) * UEFI Linux boots * UEFI Windows 8 boots +* UEFI Windows 7 & Windows 2008 Server boot (see important notes below!) === FUTURE PLANS === -* Stabilize UEFI Linux boot * Test/Stabilize UEFI Self-Certification Tests (SCT) results === BUILDING OVMF === @@ -32,6 +30,7 @@ Pre-requisites: * A properly configured ASL compiler: - Intel ASL compiler: Available from http://www.acpica.org - Microsoft ASL compiler: Available from http://www.acpi.info +* NASM: http://www.nasm.us/ Update Conf/target.txt ACTIVE_PLATFORM for OVMF: PEI arch DXE arch UEFI interfaces @@ -56,16 +55,29 @@ these binary outputs: More information on building OVMF can be found at: -http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF +https://github.com/tianocore/tianocore.github.io/wiki/How%20to%20build%20OVMF === RUNNING OVMF on QEMU === -* QEMU 0.9.1 or later is required. -* Either copy, rename or symlink OVMF.FD => bios.bin +* QEMU 0.12.2 or later is required. * Be sure to use qemu-system-x86_64, if you are using and X64 firmware. (qemu-system-x86_64 works for the IA32 firmware as well, of course.) -* Use the QEMU -L parameter to specify the directory where the bios.bin - file is located. +* Use OVMF for QEMU firmware (3 options available) + - Option 1: QEMU 1.6 or newer; Use QEMU -pflash parameter + * QEMU/OVMF will use emulated flash, and fully support UEFI variables + * Run qemu with: -pflash path/to/OVMF.fd + * Note that this option is required for running SecureBoot-enabled builds + (-D SECURE_BOOT_ENABLE). + - Option 2: Use QEMU -bios parameter + * Note that UEFI variables will be partially emulated, and non-volatile + variables may lose their contents after a reboot + * Run qemu with: -bios path/to/OVMF.fd + - Option 3: Use QEMU -L parameter + * Note that UEFI variables will be partially emulated, and non-volatile + variables may lose their contents after a reboot + * Either copy, rename or symlink OVMF.fd => bios.bin + * Use the QEMU -L parameter to specify the directory where the bios.bin + file is located. * The EFI shell is built into OVMF builds at this time, so it should run automatically if a UEFI boot application is not found on the removable media. @@ -108,11 +120,11 @@ $ OvmfPkg/build.sh -a IA32 -b RELEASE -t GCC45 === Network Support === -OVMF provides a generic UEFI network stack by default, with the lowest level -driver (the NIC driver) missing in the default build. In order to complete the -stack and make eg. DHCP, PXE Boot, and socket test utilities from the StdLib -edk2 package work, (1) qemu has to be configured to emulate a NIC, (2) a -matching UEFI NIC driver must be available when OVMF boots. +OVMF provides a UEFI network stack by default. Its lowest level driver is the +NIC driver, higher levels are generic. In order to make DHCP, PXE Boot, and eg. +socket test utilities from the StdLib edk2 package work, (1) qemu has to be +configured to emulate a NIC, (2) a matching UEFI NIC driver must be available +when OVMF boots. (If a NIC is configured for the virtual machine, and -- dependent on boot order -- PXE booting is attempted, but no DHCP server responds to OVMF's DHCP @@ -122,23 +134,23 @@ longer.) * For each NIC emulated by qemu, a GPLv2 licensed UEFI driver is available from the iPXE project. The qemu source distribution, starting with version 1.5, contains prebuilt binaries of these drivers (and of course allows one to - rebuild them from source as well). + rebuild them from source as well). This is the recommended set of drivers. * Use the qemu -netdev and -device options, or the legacy -net option, to enable NIC support: . * For a qemu >= 1.5 binary running *without* any "-M machine" option where "machine" would identify a < qemu-1.5 configuration (for example: "-M - pc-i440fx-1.4" or "-M pc-0.13"), the drivers are available from the default - qemu installation to OVMF without further settings. + pc-i440fx-1.4" or "-M pc-0.13"), the iPXE drivers are automatically available + to and configured for OVMF in the default qemu installation. * For a qemu binary in [0.13, 1.5), or a qemu >= 1.5 binary with an "-M machine" option where "machine" selects a < qemu-1.5 configuration: - download a >= 1.5.0-rc1 source tarball from , - - extract the following files from the tarball and install them in a - location that is accessible to qemu processes (this may depend on your + - extract the following iPXE driver files from the tarball and install them + in a location that is accessible to qemu processes (this may depend on your SELinux configuration, for example): qemu-VERSION/pc-bios/efi-e1000.rom @@ -156,9 +168,11 @@ longer.) -device rtl8139,...,romfile=/full/path/to/efi-rtl8139.rom -device virtio-net-pci,...,romfile=/full/path/to/efi-virtio.rom -* Independently of the iPXE NIC drivers, Intel's proprietary E1000 NIC driver - can be embedded in the OVMF image at build time, as an alternative guest - driver for "-device e1000": +* Independently of the iPXE NIC drivers, the default OVMF build provides a + basic virtio-net driver, located in OvmfPkg/VirtioNetDxe. + +* Also independently of the iPXE NIC drivers, Intel's proprietary E1000 NIC + driver (PROEFI) can be embedded in the OVMF image at build time: - Download UEFI drivers for the e1000 NIC - http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng @@ -168,6 +182,52 @@ longer.) - Add "-D E1000_ENABLE -D FD_SIZE_2MB" to your build command, - For example: "build -D E1000_ENABLE -D FD_SIZE_2MB". +* When a matching iPXE driver is configured for a NIC as described above, it + takes priority over other drivers that could possibly drive the card too: + + | e1000 ne2k_pci pcnet rtl8139 virtio-net-pci + -------------+------------------------------------------------ + iPXE | x x x x x + VirtioNetDxe | x + Intel PROEFI | x + +=== OVMF Flash Layout === + +Like all current IA32/X64 system designs, OVMF's firmware +device (rom/flash) appears in QEMU's physical address space +just below 4GB (0x100000000). + +The layout of the firmware device in memory looks like: + ++--------------------------------------- 4GB (0x100000000) +| VTF0 (16-bit reset code) and OVMF SEC +| (SECFV) ++--------------------------------------- varies based on flash size +| +| Compressed main firmware image +| (FVMAIN_COMPACT) +| ++--------------------------------------- base + 0x20000 +| Fault-tolerant write (FTW) +| Spare blocks (64KB/0x10000) ++--------------------------------------- base + 0x10000 +| FTW Work block (4KB/0x1000) ++--------------------------------------- base + 0x0f000 +| Event log area (4KB/0x1000) ++--------------------------------------- base + 0x0e000 +| Non-volatile variable storage +| area (56KB/0xe000) ++--------------------------------------- base address + +OVMF supports building a 1MB or a 2MB flash image. The base address for +a 1MB image in QEMU physical memory is 0xfff00000. The base address for +a 2MB image is 0xffe00000. + +The code in SECFV locates FVMAIN_COMPACT, and decompresses the +main firmware (MAINFV) into RAM memory at address 0x800000. The +remaining OVMF firmware then uses this decompressed firmware +volume image. + === UNIXGCC Debug === If you build with the UNIXGCC toolchain, then debugging will be disabled @@ -187,3 +247,13 @@ selectively. For example: GCC:*_*_*_CC_FLAGS = -UMDEPKG_NDEBUG } +=== UEFI Windows 7 & Windows 2008 Server === + +* One of the '-vga std' and '-vga qxl' QEMU options should be used. +* Only one video mode, 1024x768x32, is supported at OS runtime. +* The '-vga qxl' QEMU option is recommended. After booting the installed + guest OS, select the video card in Device Manager, and upgrade its driver + to the QXL XDDM one. Download location: + , Guest | Windows binaries. + This enables further resolutions at OS runtime, and provides S3 + (suspend/resume) capability.