From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Permerror (SPF Permanent Error: Two or more type TXT spf records found.) identity=mailfrom; client-ip=192.55.52.93; helo=mga11.intel.com; envelope-from=ruiyu.ni@intel.com; receiver=edk2-devel@lists.01.org Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id E7EAD21106F09 for ; Mon, 3 Sep 2018 18:18:42 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 03 Sep 2018 18:18:42 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.53,327,1531810800"; d="scan'208";a="80621360" Received: from ray-dev.ccr.corp.intel.com ([10.239.9.8]) by orsmga003.jf.intel.com with ESMTP; 03 Sep 2018 18:18:04 -0700 From: Ruiyu Ni To: edk2-devel@lists.01.org Cc: Michael D Kinney , Hao A Wu Date: Tue, 4 Sep 2018 09:18:51 +0800 Message-Id: <20180904011851.69884-1-ruiyu.ni@intel.com> X-Mailer: git-send-email 2.16.1.windows.1 Subject: [PATCH] EmulatorPkg: Update package level Readme.md X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 04 Sep 2018 01:18:43 -0000 Since the emulator under Windows is enabled, the patch changes README to include the information of emulator under Windows. It also changes README to Readme.md for better looking. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ruiyu Ni Cc: Michael D Kinney Cc: Hao A Wu --- EmulatorPkg/README | 35 -------------------------- EmulatorPkg/Readme.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 35 deletions(-) delete mode 100644 EmulatorPkg/README create mode 100644 EmulatorPkg/Readme.md diff --git a/EmulatorPkg/README b/EmulatorPkg/README deleted file mode 100644 index fdb26de503..0000000000 --- a/EmulatorPkg/README +++ /dev/null @@ -1,35 +0,0 @@ - -=== EmulatorPkg 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 - -=== Future Plans === - -* Win32 and Win64 support - -=== Build Scripts === - -On systems with the bash shell you can use EmulatorPkg/build.sh to simplify -building and running EmulatorPkg. - -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 - diff --git a/EmulatorPkg/Readme.md b/EmulatorPkg/Readme.md new file mode 100644 index 0000000000..461975e859 --- /dev/null +++ b/EmulatorPkg/Readme.md @@ -0,0 +1,68 @@ +## 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` -- 2.16.1.windows.1