audk/OvmfPkg
jljusten 37e97c51dd Add more details to OvmfPkg/README for building & running.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8402 6f19259b-4bc3-4df7-8a09-765794883524
2009-05-28 18:02:25 +00:00
..
AcpiTables Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
Library Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
PlatformPei Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
ResetVector Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
Sec Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
OvmfPkg.dec Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
OvmfPkg.fdf Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
OvmfPkgIa32.dsc Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
OvmfPkgIa32X64.dsc Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
OvmfPkgIa32X64.fdf Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
OvmfPkgX64.dsc Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
README Add more details to OvmfPkg/README for building & running. 2009-05-28 18:02:25 +00:00

README

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.



=== OVMF OVERVIEW ===



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:



  https://edk2.tianocore.org/OVMF.html



=== STATUS ===



Current status: Alpha



Current capabilities:

* IA32 and X64 architectures

* QEMU (0.9.1 or later)

  - Video, keyboard, IDE, CD-ROM, serial

  - Runs UEFI shell

* UEFI Linux has booted (but is not stable)



=== FUTURE PLANS ===



* Stabilize UEFI Linux boot

* Test/Stabilize UEFI Self-Certification Tests (SCT) results



=== BUILDING OVMF ===



Pre-requisites:

* Build environment capable of build the edk2 MdeModulePkg.

* A properly configured ASL compiler

  * Intel ASL compiler: Available from http://www.acpica.org

      or

  * Microsoft ASL compiler: Available from http://www.acpi.info



Update Conf/target.txt ACTIVE_PLATFORM for OVMF:

                             PEI arch   DXE arch   UEFI interfaces

* OvmfPkg/OvmfPkgIa32.dsc      IA32       IA32           IA32

* OvmfPkg/OvmfPkgIa32X64.dsc   IA32       X64            X64

* OvmfPkg/OvmfPkgX64.dsc       X64        X64            X64



Following the edk2 build process, you will find OVMF.fd at:

$WORKSPACE/Build/*/*/FV/OVMF.fd



=== RUNNING OVMF on QEMU ===



* QEMU 0.9.1 or later is required.

* Either copy, rename or symlink OVMF.fd => bios.bin

* 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 bios.bin

  is located.

* If QEMU returns an error about not finding a video bios, you can

  try creating an empty copy of the video bios file, or copy the

  video bios from QEMU's BIOS directory.

* Optionally you can use the QEMU -serial command to capture the

  OVMF debug messages.  For example: -serial file:serial.log

* 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.