]>
Commit | Line | Data |
---|---|---|
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 | |
8 | http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=OVMF\r | |
9 | \r | |
10 | === STATUS ===\r | |
11 | \r | |
12 | Current status: Alpha\r | |
13 | \r | |
14 | Current capabilities:\r | |
15 | * IA32 and X64 architectures\r | |
16 | * QEMU (0.10.0 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 boots\r | |
21 | * UEFI Windows 8 boots\r | |
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 | |
28 | === BUILDING OVMF ===\r | |
29 | \r | |
30 | Pre-requisites:\r | |
31 | * Build environment capable of build the edk2 MdeModulePkg.\r | |
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 | |
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 | |
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 | |
52 | * OVMF.FD\r | |
53 | - Please note! This filename has changed. Older releases used OVMF.Fv.\r | |
54 | * OvmfVideo.rom\r | |
55 | - This file is not built separately any longer, starting with svn r13520.\r | |
56 | \r | |
57 | More information on building OVMF can be found at:\r | |
58 | \r | |
59 | http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF\r | |
60 | \r | |
61 | === RUNNING OVMF on QEMU ===\r | |
62 | \r | |
63 | * QEMU 0.9.1 or later is required.\r | |
64 | * Either copy, rename or symlink OVMF.FD => bios.bin\r | |
65 | * Be sure to use qemu-system-x86_64, if you are using and X64 firmware.\r | |
66 | (qemu-system-x86_64 works for the IA32 firmware as well, of course.)\r | |
67 | * Use the QEMU -L parameter to specify the directory where the bios.bin\r | |
68 | file is located.\r | |
69 | * The EFI shell is built into OVMF builds at this time, so it should\r | |
70 | run automatically if a UEFI boot application is not found on the\r | |
71 | removable media.\r | |
72 | * On Linux, newer version of QEMU may enable KVM feature, and this might\r | |
73 | cause OVMF to fail to boot. The QEMU '-no-kvm' may allow OVMF to boot.\r | |
74 | * Capturing OVMF debug messages on qemu:\r | |
75 | - The default OVMF build writes debug messages to IO port 0x402. The\r | |
76 | following qemu command line options save them in the file called\r | |
77 | debug.log: '-debugcon file:debug.log -global isa-debugcon.iobase=0x402'.\r | |
78 | - It is possible to revert to the original behavior, when debug messages were\r | |
79 | written to the emulated serial port (potentially intermixing OVMF debug\r | |
80 | output with UEFI serial console output). For this the\r | |
81 | '-D DEBUG_ON_SERIAL_PORT' option has to be passed to the build command (see\r | |
82 | the next section), and in order to capture the serial output qemu needs to\r | |
83 | be started with eg. '-serial file:serial.log'.\r | |
84 | - Debug messages fall into several categories. Logged vs. suppressed\r | |
85 | categories are controlled at OVMF build time by the\r | |
86 | 'gEfiMdePkgTokenSpaceGuid.PcdDebugPrintErrorLevel' bitmask (an UINT32\r | |
87 | value) in the selected .dsc file. Individual bits of this bitmask are\r | |
88 | defined in <MdePkg/Include/Library/DebugLib.h>. One non-default bit (with\r | |
89 | some performance impact) that is frequently set for debugging is 0x00400000\r | |
90 | (DEBUG_VERBOSE).\r | |
91 | - The RELEASE build target ('-b RELEASE' build option, see below) disables\r | |
92 | all debug messages. The default build target is DEBUG.\r | |
93 | \r | |
94 | === Build Scripts ===\r | |
95 | \r | |
96 | On systems with the bash shell you can use OvmfPkg/build.sh to simplify\r | |
97 | building and running OVMF.\r | |
98 | \r | |
99 | So, for example, to build + run OVMF X64:\r | |
100 | $ OvmfPkg/build.sh -a X64\r | |
101 | $ OvmfPkg/build.sh -a X64 qemu\r | |
102 | \r | |
103 | And to run a 64-bit UEFI bootable ISO image:\r | |
104 | $ OvmfPkg/build.sh -a X64 qemu -cdrom /path/to/disk-image.iso\r | |
105 | \r | |
106 | To build a 32-bit OVMF without debug messages using GCC 4.5:\r | |
107 | $ OvmfPkg/build.sh -a IA32 -b RELEASE -t GCC45\r | |
108 | \r | |
109 | === Network Support ===\r | |
110 | \r | |
111 | To add network drivers to OVMF:\r | |
112 | \r | |
113 | * Download UEFI drivers for the e1000 NIC\r | |
114 | - http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng\r | |
115 | - Install the drivers into a directory called Intel3.5 in your WORKSPACE\r | |
116 | \r | |
117 | * Include the drivers in OVMF during the build:\r | |
118 | - Add '-D NETWORK_ENABLE' to your build command\r | |
119 | - For example: build -D NETWORK_ENABLE\r | |
120 | \r | |
121 | * Use the QEMU -net parameter to enable NIC support.\r | |
122 | - QEMU does not support UEFI DHCP or UEFI PXE Boot, so long timeouts will\r | |
123 | occur when NICs are enabled. The long timeouts can be avoided by\r | |
124 | interrupts the boot sequence by pressing a key when the logo appears.\r | |
125 | - Example: Enable e1000 NIC with a DHCP server and restrict packet\r | |
126 | forwarding:\r | |
127 | -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r | |
128 | - Example: Enable e1000 NIC with a DHCP server, restrict packet forwarding,\r | |
129 | and generate PCAP file:\r | |
130 | -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r | |
131 | -net dump,file=a.pcap\r | |
132 | - Example: Enable 2 e1000 NICs with a DHCP server and restrict\r | |
133 | packet forwarding:\r | |
134 | -net nic,model=e1000,addr=3 -net nic,model=e1000,addr=4\r | |
135 | -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r | |
136 | \r | |
137 | === UNIXGCC Debug ===\r | |
138 | \r | |
139 | If you build with the UNIXGCC toolchain, then debugging will be disabled\r | |
140 | due to larger image sizes being produced by the UNIXGCC toolchain. The\r | |
141 | first choice recommendation is to use GCC44 or newer instead.\r | |
142 | \r | |
143 | If you must use UNIXGCC, then you can override the build options for\r | |
144 | particular libraries and modules in the .dsc to re-enable debugging\r | |
145 | selectively. For example:\r | |
146 | [Components]\r | |
147 | OvmfPkg/Library/PlatformBdsLib/PlatformBdsLib.inf {\r | |
148 | <BuildOptions>\r | |
149 | GCC:*_*_*_CC_FLAGS = -UMDEPKG_NDEBUG\r | |
150 | }\r | |
151 | IntelFrameworkModulePkg/Universal/BdsDxe/BdsDxe.inf {\r | |
152 | <BuildOptions>\r | |
153 | GCC:*_*_*_CC_FLAGS = -UMDEPKG_NDEBUG\r | |
154 | }\r | |
155 | \r |