]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/README
ArmPkg/ArmV7Mmu.h: Fixed XN bit conversion from section to small/large page format
[mirror_edk2.git] / OvmfPkg / README
index 2c8b51fc76bf79e4ec5d397313b730096bd100a9..213d8648d6bd9f4e6ade68cb832c7563662c0121 100644 (file)
@@ -108,31 +108,76 @@ $ OvmfPkg/build.sh -a IA32 -b RELEASE -t GCC45
 \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
+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
+DISCOVER message at startup, the boot process may take approx. 3 seconds\r
+longer.)\r
+\r
+* 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). 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 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 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
+    qemu-VERSION/pc-bios/efi-ne2k_pci.rom\r
+    qemu-VERSION/pc-bios/efi-pcnet.rom\r
+    qemu-VERSION/pc-bios/efi-rtl8139.rom\r
+    qemu-VERSION/pc-bios/efi-virtio.rom\r
+\r
+  - extend the NIC's -device option on the qemu command line with a matching\r
+    "romfile=" optarg:\r
+\r
+    -device e1000,...,romfile=/full/path/to/efi-e1000.rom\r
+    -device ne2k_pci,...,romfile=/full/path/to/efi-ne2k_pci.rom\r
+    -device pcnet,...,romfile=/full/path/to/efi-pcnet.rom\r
+    -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, 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
+    - Install the drivers into a directory called Intel3.5 in your WORKSPACE.\r
+\r
+  - Include the driver in OVMF during the build:\r
+    - 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