OvmfPkg/README

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