EmulatorPkg/Readme.md

   1 ## Overview
   2
   3 EmulatorPkg provides an environment where a UEFI environment can be
   4 emulated under an environment where a full UEFI compatible
   5 environment is not possible.  (For example, running under an OS
   6 where an OS process hosts the UEFI emulation environment.)
   7
   8 https://github.com/tianocore/tianocore.github.io/wiki/EmulatorPkg
   9
  10 ## Status
  11
  12 * Builds and runs under
  13   *  a posix-like environment with X windows
  14       - Linux
  15       - OS X
  16   *  Windows environment
  17       - Win10 (verified)
  18       - Win8 (not verified)
  19
  20 ## How to Build & Run
  21 **You can use the following command to build.**
  22   * 32bit emulator in Windows:
  23
  24     `build -p EmulatorPkg\EmulatorPkg.dsc -t VS2017 -a IA32`
  25
  26   * 64bit emulator in Windows:
  27
  28     `build -p EmulatorPkg\EmulatorPkg.dsc -t VS2017 -a X64`
  29
  30   * 32bit emulator in Linux:
  31
  32     `build -p EmulatorPkg\EmulatorPkg.dsc -t GCC5 -a IA32`
  33
  34   * 64bit emulator in Linux:
  35
  36     `build -p EmulatorPkg\EmulatorPkg.dsc -t GCC5 -a X64`
  37
  38 **You can start/run the emulator using the following command:**
  39   * 32bit emulator in Windows:
  40
  41     `cd Build\EmulatorIA32\DEBUG_VS2017\IA32\ && WinHost.exe`
  42
  43   * 64bit emulator in Windows:
  44
  45     `cd Build\EmulatorX64\DEBUG_VS2017\X64\ && WinHost.exe`
  46
  47   * 32bit emulator in Linux:
  48
  49     `cd Build/EmulatorIA32/DEBUG_GCC5/IA32/ && ./Host`
  50
  51   * 64bit emulator in Linux:
  52
  53     `cd Build/EmulatorX64/DEBUG_GCC5/X64/ && ./Host`
  54
  55 **On posix-like environment with the bash shell you can use EmulatorPkg/build.sh to simplify building and running
  56 emulator.**
  57
  58 For example, to build + run:
  59
  60 `$ EmulatorPkg/build.sh`
  61 `$ EmulatorPkg/build.sh run`
  62
  63 The build architecture will match your host machine's architecture.
  64
  65 On X64 host machines, you can build + run IA32 mode as well:
  66
  67 `$ EmulatorPkg/build.sh -a IA32`
  68 `$ EmulatorPkg/build.sh -a IA32 run`