]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/README
OvmfPkg: enable building VirtioNetDxe
[mirror_edk2.git] / OvmfPkg / README
index 13058eae47a89c4abcf34ce2be62de829e8da17a..213d8648d6bd9f4e6ade68cb832c7563662c0121 100644 (file)
@@ -108,11 +108,11 @@ $ OvmfPkg/build.sh -a IA32 -b RELEASE -t GCC45
 \r
 === Network Support ===\r
 \r
-OVMF provides a generic UEFI network stack by default, with the lowest level\r
-driver (the NIC driver) missing in the default build. In order to complete the\r
-stack and make eg. DHCP, PXE Boot, and socket test utilities from the StdLib\r
-edk2 package work, (1) qemu has to be configured to emulate a NIC, (2) a\r
-matching UEFI NIC driver must be available when OVMF boots.\r
+OVMF provides a UEFI network stack by default. Its lowest level driver is the\r
+NIC driver, higher levels are generic. In order to make DHCP, PXE Boot, and eg.\r
+socket test utilities from the StdLib edk2 package work, (1) qemu has to be\r
+configured to emulate a NIC, (2) a matching UEFI NIC driver must be available\r
+when OVMF boots.\r
 \r
 (If a NIC is configured for the virtual machine, and -- dependent on boot order\r
 -- PXE booting is attempted, but no DHCP server responds to OVMF's DHCP\r
@@ -122,23 +122,23 @@ longer.)
 * For each NIC emulated by qemu, a GPLv2 licensed UEFI driver is available from\r
   the iPXE project. The qemu source distribution, starting with version 1.5,\r
   contains prebuilt binaries of these drivers (and of course allows one to\r
-  rebuild them from source as well).\r
+  rebuild them from source as well). This is the recommended set of drivers.\r
 \r
 * Use the qemu -netdev and -device options, or the legacy -net option, to\r
   enable NIC support: <http://wiki.qemu.org/Documentation/Networking>.\r
 \r
 * For a qemu >= 1.5 binary running *without* any "-M machine" option where\r
   "machine" would identify a < qemu-1.5 configuration (for example: "-M\r
-  pc-i440fx-1.4" or "-M pc-0.13"), the drivers are available from the default\r
-  qemu installation to OVMF without further settings.\r
+  pc-i440fx-1.4" or "-M pc-0.13"), the iPXE drivers are automatically available\r
+  to and configured for OVMF in the default qemu installation.\r
 \r
 * For a qemu binary in [0.13, 1.5), or a qemu >= 1.5 binary with an "-M\r
   machine" option where "machine" selects a < qemu-1.5 configuration:\r
 \r
   - download a >= 1.5.0-rc1 source tarball from <http://wiki.qemu.org/Download>,\r
 \r
-  - extract the following files from the tarball and install them in a\r
-    location that is accessible to qemu processes (this may depend on your\r
+  - extract the following iPXE driver files from the tarball and install them\r
+    in a location that is accessible to qemu processes (this may depend on your\r
     SELinux configuration, for example):\r
 \r
     qemu-VERSION/pc-bios/efi-e1000.rom\r
@@ -156,9 +156,11 @@ longer.)
     -device rtl8139,...,romfile=/full/path/to/efi-rtl8139.rom\r
     -device virtio-net-pci,...,romfile=/full/path/to/efi-virtio.rom\r
 \r
-* Independently of the iPXE NIC drivers, Intel's proprietary E1000 NIC driver\r
-  can be embedded in the OVMF image at build time, as an alternative guest\r
-  driver for "-device e1000":\r
+* Independently of the iPXE NIC drivers, the default OVMF build provides a\r
+  basic virtio-net driver, located in OvmfPkg/VirtioNetDxe.\r
+\r
+* Also independently of the iPXE NIC drivers, Intel's proprietary E1000 NIC\r
+  driver (PROEFI) can be embedded in the OVMF image at build time:\r
 \r
   - Download UEFI drivers for the e1000 NIC\r
     - http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng\r
@@ -168,6 +170,15 @@ longer.)
     - Add "-D E1000_ENABLE -D FD_SIZE_2MB" to your build command,\r
     - For example: "build -D E1000_ENABLE -D FD_SIZE_2MB".\r
 \r
+* When a matching iPXE driver is configured for a NIC as described above, it\r
+  takes priority over other drivers that could possibly drive the card too:\r
+\r
+                 | e1000  ne2k_pci  pcnet  rtl8139  virtio-net-pci\r
+    -------------+------------------------------------------------\r
+    iPXE         |   x       x        x       x           x\r
+    VirtioNetDxe |                                        x\r
+    Intel PROEFI |   x\r
+\r
 === UNIXGCC Debug ===\r
 \r
 If you build with the UNIXGCC toolchain, then debugging will be disabled\r