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.9.1 or later is required.
  64 * Either copy, rename or symlink OVMF.FD => bios.bin
  65 * Be sure to use qemu-system-x86_64, if you are using and X64 firmware.
  66   (qemu-system-x86_64 works for the IA32 firmware as well, of course.)
  67 * Use the QEMU -L parameter to specify the directory where the bios.bin
  68   file is located.
  69 * Optionally you can use the QEMU -serial command to capture the
  70   OVMF debug messages.  For example: -serial file:serial.log
  71 * The EFI shell is built into OVMF builds at this time, so it should
  72   run automatically if a UEFI boot application is not found on the
  73   removable media.
  74 * On Linux, newer version of QEMU may enable KVM feature, and this might
  75   cause OVMF to fail to boot.  The QEMU '-no-kvm' may allow OVMF to boot.
  76
  77 === Build Scripts ===
  78
  79 On systems with the bash shell you can use OvmfPkg/build.sh to simplify
  80 building and running OVMF.
  81
  82 So, for example, to build + run OVMF X64:
  83 $ OvmfPkg/build.sh -a X64
  84 $ OvmfPkg/build.sh -a X64 qemu
  85
  86 And to run a 64-bit UEFI bootable ISO image:
  87 $ OvmfPkg/build.sh -a X64 qemu -cdrom /path/to/disk-image.iso
  88
  89 To build a 32-bit OVMF without debug serial messages using GCC 4.5:
  90 $ OvmfPkg/build.sh -a IA32 -b RELEASE -t GCC45
  91
  92 === Network Support ===
  93
  94 To add network drivers to OVMF:
  95
  96 * Download UEFI drivers for the e1000 NIC
  97   - http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng
  98   - Install the drivers into a directory called Intel3.5 in your WORKSPACE
  99
 100 * Include the drivers in OVMF during the build:
 101   - Add '-D NETWORK_ENABLE' to your build command
 102   - For example: build -D NETWORK_ENABLE
 103
 104 * Use the QEMU -net parameter to enable NIC support.
 105   - QEMU does not support UEFI DHCP or UEFI PXE Boot, so long timeouts will
 106     occur when NICs are enabled.  The long timeouts can be avoided by
 107     interrupts the boot sequence by pressing a key when the logo appears.
 108   - Example: Enable e1000 NIC with a DHCP server and restrict packet
 109     forwarding:
 110     -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10
 111   - Example: Enable e1000 NIC with a DHCP server, restrict packet forwarding,
 112     and generate PCAP file:
 113     -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10
 114     -net dump,file=a.pcap
 115   - Example: Enable 2 e1000 NICs with a DHCP server and restrict
 116     packet forwarding:
 117     -net nic,model=e1000,addr=3 -net nic,model=e1000,addr=4
 118     -net user,restrict=yes -net user,dhcpstart=10.0.2.10
 119
 120 === UNIXGCC Debug ===
 121
 122 If you build with the UNIXGCC toolchain, then debugging will be disabled
 123 due to larger image sizes being produced by the UNIXGCC toolchain. The
 124 first choice recommendation is to use GCC44 or newer instead.
 125
 126 If you must use UNIXGCC, then you can override the build options for
 127 particular libraries and modules in the .dsc to re-enable debugging
 128 selectively. For example:
 129   [Components]
 130   OvmfPkg/Library/PlatformBdsLib/PlatformBdsLib.inf {
 131     <BuildOptions>
 132       GCC:*_*_*_CC_FLAGS             = -UMDEPKG_NDEBUG
 133   }
 134   IntelFrameworkModulePkg/Universal/BdsDxe/BdsDxe.inf {
 135     <BuildOptions>
 136       GCC:*_*_*_CC_FLAGS             = -UMDEPKG_NDEBUG
 137   }
 138