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