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.9.1 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 has booted (but is not stable)
  21
  22 === FUTURE PLANS ===
  23
  24 * Stabilize UEFI Linux boot
  25 * Test/Stabilize UEFI Self-Certification Tests (SCT) results
  26
  27 === BUILDING OVMF ===
  28
  29 Pre-requisites:
  30 * Build environment capable of build the edk2 MdeModulePkg.
  31 * A properly configured ASL compiler
  32   * Intel ASL compiler: Available from http://www.acpica.org
  33       or
  34   * Microsoft ASL compiler: Available from http://www.acpi.info
  35
  36 Optional Pre-requisites:
  37 * UEFI drivers for the e1000 NIC supported by QEMU
  38   * http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng
  39   * Install the drivers into a directory called Intel3.5 in your WORKSPACE
  40
  41 Update Conf/target.txt ACTIVE_PLATFORM for OVMF:
  42                              PEI arch   DXE arch   UEFI interfaces
  43 * OvmfPkg/OvmfPkgIa32.dsc      IA32       IA32           IA32
  44 * OvmfPkg/OvmfPkgIa32X64.dsc   IA32       X64            X64
  45 * OvmfPkg/OvmfPkgX64.dsc       X64        X64            X64
  46
  47 Update Conf/target.txt TARGET_ARCH based on the .dsc file:
  48                              TARGET_ARCH
  49 * OvmfPkg/OvmfPkgIa32.dsc     IA32
  50 * OvmfPkg/OvmfPkgIa32X64.dsc  IA32 X64
  51 * OvmfPkg/OvmfPkgX64.dsc      X64
  52
  53 Following the edk2 build process, you will find the OVMF binaries
  54 under the $WORKSPACE/Build/*/*/FV directory.  The actual path will
  55 depend on how your build is configured.  You can expect to find
  56 these binary outputs:
  57 * OVMF.FD
  58   * Please note!  This filename has changed.  Older releases used OVMF.Fv.
  59 * CirrusLogic5446.rom
  60
  61 To enable network support add -D NETWORK_ENABLE to the build.exe command
  62 * build -D NETWORK_ENABLE
  63
  64 More information on building OVMF can be found at:
  65
  66 http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF
  67
  68 === RUNNING OVMF on QEMU ===
  69
  70 * QEMU 0.9.1 or later is required.
  71 * Either copy, rename or symlink OVMF.FD => bios.bin
  72 * Either copy, rename or symlink CirrusLogic5446.rom => vgabios-cirrus.bin
  73 * Be sure to use qemu-system-x86_64, if you are using and X64 firmware.
  74   (qemu-system-x86_64 works for the IA32 firmware as well, of course.)
  75 * Use the QEMU -L parameter to specify the directory where the bios.bin
  76   and vgabios-cirrus.bin files are located.
  77 * Optionally you can use the QEMU -serial command to capture the
  78   OVMF debug messages.  For example: -serial file:serial.log
  79 * The EFI shell is built into OVMF builds at this time, so it should
  80   run automatically if a UEFI boot application is not found on the
  81   removable media.
  82 * On Linux, newer version of QEMU may enable KVM feature, and this might cause OVMF
  83   to fail to boot.  The QEMU '-no-kvm' may allow OVMF to boot.
  84 * Use the QEMU -net parameter to enable NIC support.
  85   * QEMU does not support UEFI DHCP or UEFI PXE Boot, so lomg timeouts will occur
  86     when NICs are enabled.  The long timeouts can be avoided by interrupts the
  87     boot sequence by pressing a key when the logo appears.
  88   * Enable e1000 NIC with a DHCP server and restrict packet forwarding
  89     -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10
  90   * Enable e1000 NIC with a DHCP server, restrict packet forwarding, and generate PCAP file
  91     -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10 -net dump,file=a.pcap
  92   * Enable 2 e1000 NICs with a DHCP server and restrict packet forwarding
  93     -net nic,model=e1000,addr=3 -net nic,model=e1000,addr=4 -net user,restrict=yes -net user,dhcpstart=10.0.2.10
  94
  95 === Build Scripts ===
  96
  97 On environments with the bash shell you can use OvmfPkg/build32.sh and
  98 OvmfPkg/build64.sh to simplify building and running OVMF.
  99
 100 So, for example, to build + run OVMF X64:
 101 $ OvmfPkg/build64.sh
 102 $ OvmfPkg/build64.sh qemu
 103
 104 And to run a 64-bit UEFI bootable ISO image:
 105 $ OvmfPkg/build64.sh qemu -cdrom /path/to/disk-image.iso
 106