X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=OvmfPkg%2FREADME;h=147e6e0ebf1403f68f3cf3cc0872fa28dfb446f1;hb=bdb1c98f036154b53d97cd5a30e49878e85fa8cb;hp=213d8648d6bd9f4e6ade68cb832c7563662c0121;hpb=7a1f59476d40348429575b26b5612b219ddb83e2;p=mirror_edk2.git

diff --git a/OvmfPkg/README b/OvmfPkg/README
index 213d8648d6..147e6e0ebf 100644
--- a/OvmfPkg/README
+++ b/OvmfPkg/README
@@ -5,12 +5,10 @@ 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:
 
-http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=OVMF
+http://www.tianocore.org/ovmf/
 
 === STATUS ===
 
-Current status: Alpha
-
 Current capabilities:
 * IA32 and X64 architectures
 * QEMU (0.10.0 or later)
@@ -19,10 +17,10 @@ Current capabilities:
   - Optional NIC support.  Requires QEMU (0.12.2 or later)
 * UEFI Linux boots
 * UEFI Windows 8 boots
+* UEFI Windows 7 & Windows 2008 Server boot (see important notes below!)
 
 === FUTURE PLANS ===
 
-* Stabilize UEFI Linux boot
 * Test/Stabilize UEFI Self-Certification Tests (SCT) results
 
 === BUILDING OVMF ===
@@ -32,6 +30,7 @@ Pre-requisites:
 * A properly configured ASL compiler:
   - Intel ASL compiler: Available from http://www.acpica.org
   - Microsoft ASL compiler: Available from http://www.acpi.info
+* NASM: http://www.nasm.us/
 
 Update Conf/target.txt ACTIVE_PLATFORM for OVMF:
                              PEI arch   DXE arch   UEFI interfaces
@@ -56,16 +55,29 @@ these binary outputs:
 
 More information on building OVMF can be found at:
 
-http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF
+https://github.com/tianocore/tianocore.github.io/wiki/How%20to%20build%20OVMF
 
 === RUNNING OVMF on QEMU ===
 
-* QEMU 0.9.1 or later is required.
-* Either copy, rename or symlink OVMF.FD => bios.bin
+* QEMU 0.12.2 or later is required.
 * 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
-  file is located.
+* Use OVMF for QEMU firmware (3 options available)
+  - Option 1: QEMU 1.6 or newer; Use QEMU -pflash parameter
+    * QEMU/OVMF will use emulated flash, and fully support UEFI variables
+    * Run qemu with: -pflash path/to/OVMF.fd
+    * Note that this option is required for running SecureBoot-enabled builds
+      (-D SECURE_BOOT_ENABLE).
+  - Option 2: Use QEMU -bios parameter
+    * Note that UEFI variables will be partially emulated, and non-volatile
+      variables may lose their contents after a reboot
+    * Run qemu with: -bios path/to/OVMF.fd
+  - Option 3: Use QEMU -L parameter
+    * Note that UEFI variables will be partially emulated, and non-volatile
+      variables may lose their contents after a reboot
+    * Either copy, rename or symlink OVMF.fd => bios.bin
+    * Use the QEMU -L parameter to specify the directory where the bios.bin
+      file is located.
 * 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.
@@ -179,6 +191,43 @@ longer.)
     VirtioNetDxe |                                        x
     Intel PROEFI |   x
 
+=== OVMF Flash Layout ===
+
+Like all current IA32/X64 system designs, OVMF's firmware
+device (rom/flash) appears in QEMU's physical address space
+just below 4GB (0x100000000).
+
+The layout of the firmware device in memory looks like:
+
++--------------------------------------- 4GB (0x100000000)
+| VTF0 (16-bit reset code) and OVMF SEC
+| (SECFV)
++--------------------------------------- varies based on flash size
+|
+| Compressed main firmware image
+| (FVMAIN_COMPACT)
+|
++--------------------------------------- base + 0x20000
+| Fault-tolerant write (FTW)
+| Spare blocks (64KB/0x10000)
++--------------------------------------- base + 0x10000
+| FTW Work block (4KB/0x1000)
++--------------------------------------- base + 0x0f000
+| Event log area (4KB/0x1000)
++--------------------------------------- base + 0x0e000
+| Non-volatile variable storage
+| area (56KB/0xe000)
++--------------------------------------- base address
+
+OVMF supports building a 1MB or a 2MB flash image. The base address for
+a 1MB image in QEMU physical memory is 0xfff00000. The base address for
+a 2MB image is 0xffe00000.
+
+The code in SECFV locates FVMAIN_COMPACT, and decompresses the
+main firmware (MAINFV) into RAM memory at address 0x800000. The
+remaining OVMF firmware then uses this decompressed firmware
+volume image.
+
 === UNIXGCC Debug ===
 
 If you build with the UNIXGCC toolchain, then debugging will be disabled
@@ -198,3 +247,13 @@ selectively. For example:
       GCC:*_*_*_CC_FLAGS             = -UMDEPKG_NDEBUG
   }
 
+=== UEFI Windows 7 & Windows 2008 Server ===
+
+* One of the '-vga std' and '-vga qxl' QEMU options should be used.
+* Only one video mode, 1024x768x32, is supported at OS runtime.
+* The '-vga qxl' QEMU option is recommended. After booting the installed
+  guest OS, select the video card in Device Manager, and upgrade its driver
+  to the QXL XDDM one. Download location:
+  <http://www.spice-space.org/download.html>, Guest | Windows binaries.
+  This enables further resolutions at OS runtime, and provides S3
+  (suspend/resume) capability.