audk/EmulatorPkg
shenglei cc5c08f9d6 EmulatorPkg: Remove EdkShellBinPkg in FDF and DEC
Remove EdkShellBinPkg in EmulatorPkg.dec and
EmulatorPkg.fdf.
https://bugzilla.tianocore.org/show_bug.cgi?id=1108

v2: Remove USE_OLD_SHELL because it will not be used.

v4: Remove PcdShellFile in EmulatorPkg.dsc.
https://bugzilla.tianocore.org/show_bug.cgi?id=1298

Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Andrew Fish <afish@apple.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
2018-11-19 10:50:15 +08:00
..
AutoScanPei EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
BootModePei EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
CpuRuntimeDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
EmuBlockIoDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
EmuBusDriverDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
EmuGopDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
EmuSimpleFileSystemDxe EmulatorPkg: IoThunk->Close() is called too early, may causing hang 2018-08-31 10:40:20 +08:00
EmuSnpDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
EmuThunkDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
FirmwareVolumePei EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
FlashMapPei EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
FvbServicesRuntimeDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
Include EmulatorPkg: formalize line endings 2018-08-30 09:26:54 +08:00
Library EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
MiscSubClassPlatformDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
PlatformSmbiosDxe EmulatorPkg: formalize line endings 2018-08-30 09:26:54 +08:00
RealTimeClockRuntimeDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
ResetRuntimeDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
Sec EmulatorPkg: formalize line endings 2018-08-30 09:26:54 +08:00
ThunkPpiToProtocolPei EmulatorPkg: Remove all trailing whitespace 2011-06-28 16:50:26 +00:00
TimerDxe EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
Unix EmulatorPkg: Removing ipf which is no longer supported from edk2. 2018-09-25 23:46:00 +08:00
Win Emulator/Win: Fix build failure using VS2015x86 or old WinSDK 2018-09-10 10:29:35 +08:00
EmulatorPkg.dec EmulatorPkg: Remove EdkShellBinPkg in FDF and DEC 2018-11-19 10:50:15 +08:00
EmulatorPkg.dsc EmulatorPkg: Remove EdkShellBinPkg in FDF and DEC 2018-11-19 10:50:15 +08:00
EmulatorPkg.fdf EmulatorPkg: Remove EdkShellBinPkg in FDF and DEC 2018-11-19 10:50:15 +08:00
Readme.md EmulatorPkg: Update package level Readme.md 2018-09-10 10:29:34 +08:00
build.sh EmulatorPkg/build.sh: Fix 'run' path to simulator host executable 2018-11-18 16:31:24 -08:00

Readme.md

Overview

EmulatorPkg provides an environment where a UEFI environment can be emulated under an environment where a full UEFI compatible environment is not possible. (For example, running under an OS where an OS process hosts the UEFI emulation environment.)

https://github.com/tianocore/tianocore.github.io/wiki/EmulatorPkg

Status

  • Builds and runs under
    • a posix-like environment with X windows
      • Linux
      • OS X
    • Windows environment
      • Win10 (verified)
      • Win8 (not verified)

How to Build & Run

You can use the following command to build.

  • 32bit emulator in Windows:

    build -p EmulatorPkg\EmulatorPkg.dsc -t VS2017 -D WIN_SEC_BUILD -a IA32

  • 64bit emulator in Windows:

    build -p EmulatorPkg\EmulatorPkg.dsc -t VS2017 -D WIN_SEC_BUILD -a X64

  • 32bit emulator in Linux:

    build -p EmulatorPkg\EmulatorPkg.dsc -t GCC5 -D UNIX_SEC_BUILD -a IA32

  • 64bit emulator in Linux:

    build -p EmulatorPkg\EmulatorPkg.dsc -t GCC5 -D UNIX_SEC_BUILD -a X64

You can start/run the emulator using the following command:

  • 32bit emulator in Windows:

    cd Build\EmulatorIA32\DEBUG_VS2017\IA32\ && WinHost.exe

  • 64bit emulator in Windows:

    cd Build\EmulatorX64\DEBUG_VS2017\X64\ && WinHost.exe

  • 32bit emulator in Linux:

    cd Build/EmulatorIA32/DEBUG_GCC5/IA32/ && ./Host

  • 64bit emulator in Linux:

    cd Build/EmulatorX64/DEBUG_GCC5/X64/ && ./Host

On posix-like environment with the bash shell you can use EmulatorPkg/build.sh to simplify building and running emulator.

For example, to build + run:

$ EmulatorPkg/build.sh
$ EmulatorPkg/build.sh run

The build architecture will match your host machine's architecture.

On X64 host machines, you can build + run IA32 mode as well:

$ EmulatorPkg/build.sh -a IA32
$ EmulatorPkg/build.sh -a IA32 run