audk/EmulatorPkg
Antoine Coeur 3d6b7fd303 EmulatorPkg/Win: Fix various typos
Fix various typos in comments and documentation.

Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Andrew Fish <afish@apple.com>
Cc: Ray Ni <ray.ni@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Acked-by: Liming Gao <liming.gao@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-7-philmd@redhat.com>
2020-02-10 22:30:07 +00:00
..
AutoScanPei
BootModePei
CpuRuntimeDxe
EmuBlockIoDxe
EmuBusDriverDxe
EmuGopDxe EmulatorPkg: stop abusing EFI_HANDLE for keystroke notify registration 2019-10-09 09:40:09 +02:00
EmuSimpleFileSystemDxe
EmuSnpDxe
EmuThunkDxe
FirmwareVolumePei
FlashMapPei
FvbServicesRuntimeDxe
Include
Library
PlatformSmbiosDxe EmulatorPkg/PlatformSmbiosDxe: fix a spell error of platform. 2019-11-13 02:11:03 +00:00
RealTimeClockRuntimeDxe
ResetRuntimeDxe
Sec EmulatorPkg/Sec: Fix various typos 2020-02-10 22:30:07 +00:00
ThunkPpiToProtocolPei
TimerDxe
Unix EmulatorPkg/Unix: Fix various typos 2020-02-10 22:30:07 +00:00
Win EmulatorPkg/Win: Fix various typos 2020-02-10 22:30:07 +00:00
EmulatorPkg.dec
EmulatorPkg.dsc EmulatorPkg DSC and WinHost.inf: Update tool chain name to CLANGPDB 2019-11-15 06:04:21 +00:00
EmulatorPkg.fdf
Readme.md
build.sh

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 -a IA32

  • 64bit emulator in Windows:

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

  • 32bit emulator in Linux:

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

  • 64bit emulator in Linux:

    build -p EmulatorPkg\EmulatorPkg.dsc -t GCC5 -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