edk2/OvmfPkg
jljusten 9607962def OVMF: Add support for saving the NV variables to disk following each SetVariable call.
Note:
* This only works before ExitBootServices
* For OVMF, variables are only preserved on the disk if there
  is a hard disk connected which has a writeable FAT file system.

The Ovmf/Library/EmuVariableFvbLib library will look for the
gUefiOvmfPkgTokenSpaceGuid.PcdEmuVariableEvent PCD to be set to
a non-zero value.  If set, it is treated as an event handle, and
each write to the EmuVariableFvb will cause the event to be
signaled.

In this change, the OVMF platform BDS library sets up this event,
and sets the PCD so that after each write to the EMU Variable FVB,
the non-volatile variables will be saved out to the file system.

The end result is that NV variables that are written prior to the
ExitBootServices call should be preserved by storing them on the
disk.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9318 6f19259b-4bc3-4df7-8a09-765794883524
2009-09-26 07:15:55 +00:00
..
AcpiTables 1. update AcpiTable module type to USER_DEFINED 2009-08-11 05:30:52 +00:00
EmuVariableFvbRuntimeDxe Add EmuVariableFvbRuntimeDxe driver. 2009-09-26 07:15:45 +00:00
Include/Library OVMF: Add support for saving the NV variables to disk following each SetVariable call. 2009-09-26 07:15:55 +00:00
Library OVMF: Add support for saving the NV variables to disk following each SetVariable call. 2009-09-26 07:15:55 +00:00
PlatformPei OVMF: Convert from EmuVariableRuntimeDxe to VariableRuntimeDxe. 2009-09-26 07:15:51 +00:00
ResetVector Add initial version of Open Virtual Machine Firmware (OVMF) platform. 2009-05-27 21:10:18 +00:00
Sec Fix bug that home addresses for register parameters must be allocated for calling C function from X64 assembly code to follow x64 calling convention. 2009-09-22 09:19:59 +00:00
OvmfPkg.dec OVMF: Add library to customize the EMU Variable FVB driver. 2009-09-26 07:15:48 +00:00
OvmfPkg.fdf OVMF: Convert from EmuVariableRuntimeDxe to VariableRuntimeDxe. 2009-09-26 07:15:51 +00:00
OvmfPkgIa32.dsc OVMF: Convert from EmuVariableRuntimeDxe to VariableRuntimeDxe. 2009-09-26 07:15:51 +00:00
OvmfPkgIa32X64.dsc OVMF: Convert from EmuVariableRuntimeDxe to VariableRuntimeDxe. 2009-09-26 07:15:51 +00:00
OvmfPkgIa32X64.fdf OVMF: Convert from EmuVariableRuntimeDxe to VariableRuntimeDxe. 2009-09-26 07:15:51 +00:00
OvmfPkgX64.dsc OVMF: Convert from EmuVariableRuntimeDxe to VariableRuntimeDxe. 2009-09-26 07:15:51 +00:00
README Update README for video driver split from main OVMF firmware. 2009-07-14 23:32:44 +00:00

README

=== 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

Update Conf/target.txt TARGET_ARCH based on the .dsc file:
                             TARGET_ARCH
* OvmfPkg/OvmfPkgIa32.dsc     IA32
* OvmfPkg/OvmfPkgIa32X64.dsc  IA32 X64
* OvmfPkg/OvmfPkgX64.dsc      X64

Following the edk2 build process, you will find the OVMF binaries
under the $WORKSPACE/Build/*/*/FV directory.  The actual path will
depend on how your build is configured.  You can expect to find
these binary outputs:
* OVMF.fd 
* CirrusLogic5446.rom

More information on building OVMF can be found at:
* https://edk2.tianocore.org/build-ovmf.html

=== RUNNING OVMF on QEMU ===

* QEMU 0.9.1 or later is required.
* Either copy, rename or symlink OVMF.fd => bios.bin
* Either copy, rename or symlink CirrusLogic5446.rom => vgabios-cirrus.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 the bios.bin
  and vgabios-cirrus.bin files are located.
* 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.