[mirror_edk2.git] / OvmfPkg / README

\r
=== OVMF OVERVIEW ===\r
\r
The Open Virtual Machine Firmware (OVMF) project aims\r
to support firmware for Virtual Machines using the edk2\r
code base.  More information can be found at:\r
\r
http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=OVMF\r
\r
=== STATUS ===\r
\r
Current status: Alpha\r
\r
Current capabilities:\r
* IA32 and X64 architectures\r
* QEMU (0.9.1 or later)\r
  - Video, keyboard, IDE, CD-ROM, serial\r
  - Runs UEFI shell\r
  - Optional NIC support.  Requires QEMU (0.12.2 or later)\r
* UEFI Linux has booted (but is not stable)\r
\r
=== FUTURE PLANS ===\r
\r
* Stabilize UEFI Linux boot\r
* Test/Stabilize UEFI Self-Certification Tests (SCT) results\r
\r
=== BUILDING OVMF ===\r
\r
Pre-requisites:\r
* Build environment capable of build the edk2 MdeModulePkg.\r
* A properly configured ASL compiler\r
  * Intel ASL compiler: Available from http://www.acpica.org\r
      or\r
  * Microsoft ASL compiler: Available from http://www.acpi.info\r
\r
Optional Pre-requisites:\r
* UEFI drivers for the e1000 NIC supported by QEMU\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
Update Conf/target.txt ACTIVE_PLATFORM for OVMF:\r
                             PEI arch   DXE arch   UEFI interfaces\r
* OvmfPkg/OvmfPkgIa32.dsc      IA32       IA32           IA32\r
* OvmfPkg/OvmfPkgIa32X64.dsc   IA32       X64            X64\r
* OvmfPkg/OvmfPkgX64.dsc       X64        X64            X64\r
\r
Update Conf/target.txt TARGET_ARCH based on the .dsc file:\r
                             TARGET_ARCH\r
* OvmfPkg/OvmfPkgIa32.dsc     IA32\r
* OvmfPkg/OvmfPkgIa32X64.dsc  IA32 X64\r
* OvmfPkg/OvmfPkgX64.dsc      X64\r
\r
Following the edk2 build process, you will find the OVMF binaries\r
under the $WORKSPACE/Build/*/*/FV directory.  The actual path will\r
depend on how your build is configured.  You can expect to find\r
these binary outputs:\r
* OVMF.FD\r
  * Please note!  This filename has changed.  Older releases used OVMF.Fv.\r
* CirrusLogic5446.rom\r
\r
To enable network support add -D NETWORK_ENABLE to the build.exe command\r
* build -D NETWORK_ENABLE\r
\r
More information on building OVMF can be found at:\r
\r
http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF\r
\r
=== RUNNING OVMF on QEMU ===\r
\r
* QEMU 0.9.1 or later is required.\r
* Either copy, rename or symlink OVMF.FD => bios.bin\r
* Either copy, rename or symlink CirrusLogic5446.rom => vgabios-cirrus.bin\r
* Be sure to use qemu-system-x86_64, if you are using and X64 firmware.\r
  (qemu-system-x86_64 works for the IA32 firmware as well, of course.)\r
* Use the QEMU -L parameter to specify the directory where the bios.bin\r
  and vgabios-cirrus.bin files are located.\r
* Optionally you can use the QEMU -serial command to capture the\r
  OVMF debug messages.  For example: -serial file:serial.log\r
* The EFI shell is built into OVMF builds at this time, so it should\r
  run automatically if a UEFI boot application is not found on the\r
  removable media.\r
* On Linux, newer version of QEMU may enable KVM feature, and this might cause OVMF\r
  to fail to boot.  The QEMU '-no-kvm' may allow OVMF to boot.\r
* Use the QEMU -net parameter to enable NIC support.\r
  * QEMU does not support UEFI DHCP or UEFI PXE Boot, so lomg timeouts will occur\r
    when NICs are enabled.  The long timeouts can be avoided by interrupts the \r
    boot sequence by pressing a key when the logo appears. \r
  * Enable e1000 NIC with a DHCP server and restrict packet forwarding\r
    -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r
  * Enable e1000 NIC with a DHCP server, restrict packet forwarding, and generate PCAP file\r
    -net nic,model=e1000 -net user,restrict=yes -net user,dhcpstart=10.0.2.10 -net dump,file=a.pcap\r
  * Enable 2 e1000 NICs with a DHCP server and restrict packet forwarding\r
    -net nic,model=e1000,addr=3 -net nic,model=e1000,addr=4 -net user,restrict=yes -net user,dhcpstart=10.0.2.10\r
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
	16	* QEMU (0.9.1 or later)\r
	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
49ba9447	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
37e97c51	27	=== BUILDING OVMF ===\r
	28	\r
	29	Pre-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
7416f4eb	36	Optional 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
37e97c51	41	Update 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
2dae09a5	47	Update 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
	53	Following the edk2 build process, you will find the OVMF binaries\r
	54	under the $WORKSPACE/Build///FV directory. The actual path will\r
	55	depend on how your build is configured. You can expect to find\r
	56	these binary outputs:\r
7416f4eb	57	* OVMF.FD\r
7416f4eb	58	* Please note! This filename has changed. Older releases used OVMF.Fv.\r
2dae09a5	59	* CirrusLogic5446.rom\r
2dae09a5	60	\r
7416f4eb	61	To enable network support add -D NETWORK_ENABLE to the build.exe command\r
	62	* build -D NETWORK_ENABLE\r
	63	\r
2dae09a5	64	More information on building OVMF can be found at:\r
c315da0a	65	\r
c315da0a	66	http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=How_to_build_OVMF\r
37e97c51	67	\r
	68	=== RUNNING OVMF on QEMU ===\r
	69	\r
	70	* QEMU 0.9.1 or later is required.\r
7416f4eb	71	* Either copy, rename or symlink OVMF.FD => bios.bin\r
2dae09a5	72	* Either copy, rename or symlink CirrusLogic5446.rom => vgabios-cirrus.bin\r
37e97c51	73	* Be sure to use qemu-system-x86_64, if you are using and X64 firmware.\r
37e97c51	74	(qemu-system-x86_64 works for the IA32 firmware as well, of course.)\r
2dae09a5	75	* Use the QEMU -L parameter to specify the directory where the bios.bin\r
2dae09a5	76	and vgabios-cirrus.bin files are located.\r
37e97c51	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
c315da0a	82	* On Linux, newer version of QEMU may enable KVM feature, and this might cause OVMF\r
c315da0a	83	to fail to boot. The QEMU '-no-kvm' may allow OVMF to boot.\r
7416f4eb	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