]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - OvmfPkg/README
1. Add new API supports for PEM & X509 key retrieving & verification;
[mirror_edk2.git] / OvmfPkg / README
... / ...
CommitLineData
1\r
2=== OVMF OVERVIEW ===\r
3\r
4The Open Virtual Machine Firmware (OVMF) project aims\r
5to support firmware for Virtual Machines using the edk2\r
6code base. More information can be found at:\r
7\r
8http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=OVMF\r
9\r
10=== STATUS ===\r
11\r
12Current status: Alpha\r
13\r
14Current capabilities:\r
15* IA32 and X64 architectures\r
16* QEMU (0.9.1 or later)\r
17 - Video, keyboard, IDE, CD-ROM, serial\r
18 - Runs UEFI shell\r
19 - Optional NIC support. Requires QEMU (0.12.2 or later)\r
20* UEFI Linux has booted (but is not stable)\r
21\r
22=== FUTURE PLANS ===\r
23\r
24* Stabilize UEFI Linux boot\r
25* Test/Stabilize UEFI Self-Certification Tests (SCT) results\r
26\r
27=== BUILDING OVMF ===\r
28\r
29Pre-requisites:\r
30* Build environment capable of build the edk2 MdeModulePkg.\r
31* A properly configured ASL compiler\r
32 * Intel ASL compiler: Available from http://www.acpica.org\r
33 or\r
34 * Microsoft ASL compiler: Available from http://www.acpi.info\r
35\r
36Optional Pre-requisites:\r
37* UEFI drivers for the e1000 NIC supported by QEMU\r
38 * http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng\r
39 * Install the drivers into a directory called Intel3.5 in your WORKSPACE\r
40 \r
41Update Conf/target.txt ACTIVE_PLATFORM for OVMF:\r
42 PEI arch DXE arch UEFI interfaces\r
43* OvmfPkg/OvmfPkgIa32.dsc IA32 IA32 IA32\r
44* OvmfPkg/OvmfPkgIa32X64.dsc IA32 X64 X64\r
45* OvmfPkg/OvmfPkgX64.dsc X64 X64 X64\r
46\r
47Update Conf/target.txt TARGET_ARCH based on the .dsc file:\r
48 TARGET_ARCH\r
49* OvmfPkg/OvmfPkgIa32.dsc IA32\r
50* OvmfPkg/OvmfPkgIa32X64.dsc IA32 X64\r
51* OvmfPkg/OvmfPkgX64.dsc X64\r
52\r
53Following the edk2 build process, you will find the OVMF binaries\r
54under the $WORKSPACE/Build/*/*/FV directory. The actual path will\r
55depend on how your build is configured. You can expect to find\r
56these binary outputs:\r
57* OVMF.FD\r
58 * Please note! This filename has changed. Older releases used OVMF.Fv.\r
59* CirrusLogic5446.rom\r
60\r
61To enable network support add -D NETWORK_ENABLE to the build.exe command\r
62* build -D NETWORK_ENABLE\r
63\r
64More information on building OVMF can be found at:\r
65\r
66http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF\r
67\r
68=== RUNNING OVMF on QEMU ===\r
69\r
70* QEMU 0.9.1 or later is required.\r
71* Either copy, rename or symlink OVMF.FD => bios.bin\r
72* Either copy, rename or symlink CirrusLogic5446.rom => vgabios-cirrus.bin\r
73* Be sure to use qemu-system-x86_64, if you are using and X64 firmware.\r
74 (qemu-system-x86_64 works for the IA32 firmware as well, of course.)\r
75* Use the QEMU -L parameter to specify the directory where the bios.bin\r
76 and vgabios-cirrus.bin files are located.\r
77* Optionally you can use the QEMU -serial command to capture the\r
78 OVMF debug messages. For example: -serial file:serial.log\r
79* The EFI shell is built into OVMF builds at this time, so it should\r
80 run automatically if a UEFI boot application is not found on the\r
81 removable media.\r
82* On Linux, newer version of QEMU may enable KVM feature, and this might cause OVMF\r
83 to fail to boot. The QEMU '-no-kvm' may allow OVMF to boot.\r
84* Use the QEMU -net parameter to enable NIC support.\r
85 * QEMU does not support UEFI DHCP or UEFI PXE Boot, so lomg timeouts will occur\r
86 when NICs are enabled. The long timeouts can be avoided by interrupts the \r
87 boot sequence by pressing a key when the logo appears. \r
88 * Enable e1000 NIC with a DHCP server and restrict packet forwarding\r
89 -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r
90 * Enable e1000 NIC with a DHCP server, restrict packet forwarding, and generate PCAP file\r
91 -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10 -net dump,file=a.pcap\r
92 * Enable 2 e1000 NICs with a DHCP server and restrict packet forwarding\r
93 -net nic,model=e1000,addr=3 -net nic,model=e1000,addr=4 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r