OvmfPkg README: Group network information together

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11216 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/OvmfPkg/README b/OvmfPkg/README
index 92ae76253d1a38d7ad951a77869c4e0acef196ef..c37bfb6316f0cb82e48d7c0ac5c8f9f88533e2ba 100644 (file)
--- a/OvmfPkg/README
+++ b/OvmfPkg/README
@@ -33,11 +33,6 @@ Pre-requisites:
       or\r
   * Microsoft ASL compiler: Available from http://www.acpi.info\r
 \r
       or\r
   * Microsoft ASL compiler: Available from http://www.acpi.info\r
 \r

-Optional Pre-requisites:\r
-* UEFI drivers for the e1000 NIC supported by QEMU\r
-  * http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng\r
-  * Install the drivers into a directory called Intel3.5 in your WORKSPACE\r
-  \r

 Update Conf/target.txt ACTIVE_PLATFORM for OVMF:\r
                              PEI arch   DXE arch   UEFI interfaces\r
 * OvmfPkg/OvmfPkgIa32.dsc      IA32       IA32           IA32\r
 Update Conf/target.txt ACTIVE_PLATFORM for OVMF:\r
                              PEI arch   DXE arch   UEFI interfaces\r
 * OvmfPkg/OvmfPkgIa32.dsc      IA32       IA32           IA32\r


@@ -58,9 +53,6 @@ these binary outputs:
   * Please note!  This filename has changed.  Older releases used OVMF.Fv.\r
 * CirrusLogic5446.rom\r
 \r
   * Please note!  This filename has changed.  Older releases used OVMF.Fv.\r
 * CirrusLogic5446.rom\r
 \r

-To enable network support add -D NETWORK_ENABLE to the build.exe command\r
-* build -D NETWORK_ENABLE\r
-\r

 More information on building OVMF can be found at:\r
 \r
 http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF\r
 More information on building OVMF can be found at:\r
 \r
 http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF\r


@@ -79,18 +71,8 @@ http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVM
 * The EFI shell is built into OVMF builds at this time, so it should\r
   run automatically if a UEFI boot application is not found on the\r
   removable media.\r
 * The EFI shell is built into OVMF builds at this time, so it should\r
   run automatically if a UEFI boot application is not found on the\r
   removable media.\r

-* On Linux, newer version of QEMU may enable KVM feature, and this might cause OVMF\r
-  to fail to boot.  The QEMU '-no-kvm' may allow OVMF to boot.\r
-* Use the QEMU -net parameter to enable NIC support.\r
-  * QEMU does not support UEFI DHCP or UEFI PXE Boot, so lomg timeouts will occur\r
-    when NICs are enabled.  The long timeouts can be avoided by interrupts the \r
-    boot sequence by pressing a key when the logo appears. \r
-  * Enable e1000 NIC with a DHCP server and restrict packet forwarding\r
-    -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r
-  * Enable e1000 NIC with a DHCP server, restrict packet forwarding, and generate PCAP file\r
-    -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10 -net dump,file=a.pcap\r
-  * Enable 2 e1000 NICs with a DHCP server and restrict packet forwarding\r
-    -net nic,model=e1000,addr=3 -net nic,model=e1000,addr=4 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r
+* On Linux, newer version of QEMU may enable KVM feature, and this might\r
+  cause OVMF to fail to boot.  The QEMU '-no-kvm' may allow OVMF to boot.\r

 \r
 === Build Scripts ===\r
 \r
 \r
 === Build Scripts ===\r
 \r


@@ -104,3 +86,31 @@ $ OvmfPkg/build64.sh qemu
 And to run a 64-bit UEFI bootable ISO image:\r
 $ OvmfPkg/build64.sh qemu -cdrom /path/to/disk-image.iso\r
 \r
 And to run a 64-bit UEFI bootable ISO image:\r
 $ OvmfPkg/build64.sh qemu -cdrom /path/to/disk-image.iso\r
 \r

+=== Network Support ===\r
+\r
+To add network drivers to OVMF:\r
+\r
+* Download UEFI drivers for the e1000 NIC\r
+  - http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng\r
+  - Install the drivers into a directory called Intel3.5 in your WORKSPACE\r
+\r
+* Include the drivers in OVMF during the build:\r
+  - Add '-D NETWORK_ENABLE' to your build command\r
+  - For example: build -D NETWORK_ENABLE\r
+\r
+* Use the QEMU -net parameter to enable NIC support.\r
+  - QEMU does not support UEFI DHCP or UEFI PXE Boot, so long timeouts will\r
+    occur when NICs are enabled.  The long timeouts can be avoided by\r
+    interrupts the boot sequence by pressing a key when the logo appears.\r
+  - Example: Enable e1000 NIC with a DHCP server and restrict packet\r
+    forwarding:\r
+    -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r
+  - Example: Enable e1000 NIC with a DHCP server, restrict packet forwarding,\r
+    and generate PCAP file:\r
+    -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r
+    -net dump,file=a.pcap\r
+  - Example: Enable 2 e1000 NICs with a DHCP server and restrict\r
+    packet forwarding:\r
+    -net nic,model=e1000,addr=3 -net nic,model=e1000,addr=4\r
+    -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r
+\r