]>
Commit | Line | Data |
---|---|---|
49ba9447 | 1 | \r |
2 | === OVMF OVERVIEW ===\r | |
3 | \r | |
4 | The Open Virtual Machine Firmware (OVMF) project aims\r | |
5 | to support firmware for Virtual Machines using the edk2\r | |
6 | code base. More information can be found at:\r | |
7 | \r | |
c315da0a | 8 | http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=OVMF\r |
49ba9447 | 9 | \r |
10 | === STATUS ===\r | |
11 | \r | |
12 | Current status: Alpha\r | |
13 | \r | |
14 | Current capabilities:\r | |
15 | * IA32 and X64 architectures\r | |
73f4a1c0 | 16 | * QEMU (0.10.0 or later)\r |
49ba9447 | 17 | - Video, keyboard, IDE, CD-ROM, serial\r |
18 | - Runs UEFI shell\r | |
7416f4eb | 19 | - Optional NIC support. Requires QEMU (0.12.2 or later)\r |
73f4a1c0 | 20 | * UEFI Linux boots\r |
21 | * UEFI Windows 8 boots\r | |
49ba9447 | 22 | \r |
23 | === FUTURE PLANS ===\r | |
24 | \r | |
25 | * Stabilize UEFI Linux boot\r | |
26 | * Test/Stabilize UEFI Self-Certification Tests (SCT) results\r | |
27 | \r | |
37e97c51 | 28 | === BUILDING OVMF ===\r |
29 | \r | |
30 | Pre-requisites:\r | |
31 | * Build environment capable of build the edk2 MdeModulePkg.\r | |
66325870 | 32 | * A properly configured ASL compiler:\r |
33 | - Intel ASL compiler: Available from http://www.acpica.org\r | |
34 | - Microsoft ASL compiler: Available from http://www.acpi.info\r | |
37e97c51 | 35 | \r |
36 | Update Conf/target.txt ACTIVE_PLATFORM for OVMF:\r | |
37 | PEI arch DXE arch UEFI interfaces\r | |
38 | * OvmfPkg/OvmfPkgIa32.dsc IA32 IA32 IA32\r | |
39 | * OvmfPkg/OvmfPkgIa32X64.dsc IA32 X64 X64\r | |
40 | * OvmfPkg/OvmfPkgX64.dsc X64 X64 X64\r | |
41 | \r | |
2dae09a5 | 42 | Update Conf/target.txt TARGET_ARCH based on the .dsc file:\r |
43 | TARGET_ARCH\r | |
44 | * OvmfPkg/OvmfPkgIa32.dsc IA32\r | |
45 | * OvmfPkg/OvmfPkgIa32X64.dsc IA32 X64\r | |
46 | * OvmfPkg/OvmfPkgX64.dsc X64\r | |
47 | \r | |
48 | Following the edk2 build process, you will find the OVMF binaries\r | |
49 | under the $WORKSPACE/Build/*/*/FV directory. The actual path will\r | |
50 | depend on how your build is configured. You can expect to find\r | |
51 | these binary outputs:\r | |
7416f4eb | 52 | * OVMF.FD\r |
66325870 | 53 | - Please note! This filename has changed. Older releases used OVMF.Fv.\r |
922f593a | 54 | * OvmfVideo.rom\r |
2dae09a5 | 55 | \r |
56 | More information on building OVMF can be found at:\r | |
c315da0a | 57 | \r |
58 | http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF\r | |
37e97c51 | 59 | \r |
60 | === RUNNING OVMF on QEMU ===\r | |
61 | \r | |
62 | * QEMU 0.9.1 or later is required.\r | |
7416f4eb | 63 | * Either copy, rename or symlink OVMF.FD => bios.bin\r |
37e97c51 | 64 | * Be sure to use qemu-system-x86_64, if you are using and X64 firmware.\r |
65 | (qemu-system-x86_64 works for the IA32 firmware as well, of course.)\r | |
2dae09a5 | 66 | * Use the QEMU -L parameter to specify the directory where the bios.bin\r |
aadb1d09 | 67 | file is located.\r |
37e97c51 | 68 | * Optionally you can use the QEMU -serial command to capture the\r |
69 | OVMF debug messages. For example: -serial file:serial.log\r | |
70 | * The EFI shell is built into OVMF builds at this time, so it should\r | |
71 | run automatically if a UEFI boot application is not found on the\r | |
72 | removable media.\r | |
aed8e2ec | 73 | * On Linux, newer version of QEMU may enable KVM feature, and this might\r |
74 | cause OVMF to fail to boot. The QEMU '-no-kvm' may allow OVMF to boot.\r | |
5a9745b9 | 75 | \r |
76 | === Build Scripts ===\r | |
77 | \r | |
66325870 | 78 | On systems with the bash shell you can use OvmfPkg/build.sh to simplify\r |
79 | building and running OVMF.\r | |
5a9745b9 | 80 | \r |
81 | So, for example, to build + run OVMF X64:\r | |
66325870 | 82 | $ OvmfPkg/build.sh -a X64\r |
83 | $ OvmfPkg/build.sh -a X64 qemu\r | |
5a9745b9 | 84 | \r |
85 | And to run a 64-bit UEFI bootable ISO image:\r | |
66325870 | 86 | $ OvmfPkg/build.sh -a X64 qemu -cdrom /path/to/disk-image.iso\r |
87 | \r | |
88 | To build a 32-bit OVMF without debug serial messages using GCC 4.5:\r | |
89 | $ OvmfPkg/build.sh -a IA32 -b RELEASE -t GCC45\r | |
5a9745b9 | 90 | \r |
aed8e2ec | 91 | === Network Support ===\r |
92 | \r | |
93 | To add network drivers to OVMF:\r | |
94 | \r | |
95 | * Download UEFI drivers for the e1000 NIC\r | |
96 | - http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng\r | |
97 | - Install the drivers into a directory called Intel3.5 in your WORKSPACE\r | |
98 | \r | |
99 | * Include the drivers in OVMF during the build:\r | |
100 | - Add '-D NETWORK_ENABLE' to your build command\r | |
101 | - For example: build -D NETWORK_ENABLE\r | |
102 | \r | |
103 | * Use the QEMU -net parameter to enable NIC support.\r | |
104 | - QEMU does not support UEFI DHCP or UEFI PXE Boot, so long timeouts will\r | |
105 | occur when NICs are enabled. The long timeouts can be avoided by\r | |
106 | interrupts the boot sequence by pressing a key when the logo appears.\r | |
107 | - Example: Enable e1000 NIC with a DHCP server and restrict packet\r | |
108 | forwarding:\r | |
109 | -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r | |
110 | - Example: Enable e1000 NIC with a DHCP server, restrict packet forwarding,\r | |
111 | and generate PCAP file:\r | |
112 | -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r | |
113 | -net dump,file=a.pcap\r | |
114 | - Example: Enable 2 e1000 NICs with a DHCP server and restrict\r | |
115 | packet forwarding:\r | |
116 | -net nic,model=e1000,addr=3 -net nic,model=e1000,addr=4\r | |
117 | -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r | |
118 | \r | |
0b5a5022 | 119 | === UNIXGCC Debug ===\r |
120 | \r | |
121 | If you build with the UNIXGCC toolchain, then debugging will be disabled\r | |
122 | due to larger image sizes being produced by the UNIXGCC toolchain. The\r | |
123 | first choice recommendation is to use GCC44 or newer instead.\r | |
124 | \r | |
125 | If you must use UNIXGCC, then you can override the build options for\r | |
126 | particular libraries and modules in the .dsc to re-enable debugging\r | |
127 | selectively. For example:\r | |
128 | [Components]\r | |
129 | OvmfPkg/Library/PlatformBdsLib/PlatformBdsLib.inf {\r | |
130 | <BuildOptions>\r | |
131 | GCC:*_*_*_CC_FLAGS = -UMDEPKG_NDEBUG\r | |
132 | }\r | |
133 | IntelFrameworkModulePkg/Universal/BdsDxe/BdsDxe.inf {\r | |
134 | <BuildOptions>\r | |
135 | GCC:*_*_*_CC_FLAGS = -UMDEPKG_NDEBUG\r | |
136 | }\r | |
137 | \r |