[edk2-devel] [PATCH] AlderlakeOpenBoardPkg: Add Readme.

[dorax.hsueh@intel.com]

From: DoraX Hsueh <dorax.hsueh@intel.com>

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4667

Add Readme to explain how to build AlderlakeOpenBoardPkg.

Cc: Sai Chaganty <rangasai.v.chaganty@intel.com>
Cc: Rosen Chuang <rosen.chuang@intel.com>
Cc: Saloni Kasbekar <saloni.kasbekar@intel.com>
Cc: Haoyu Tang <haoyu.tang@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Signed-off-by: DoraX Hsueh <dorax.hsueh@intel.com>
---
 .../Intel/AlderlakeOpenBoardPkg/ReadMe.md     | 56 +++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 Platform/Intel/AlderlakeOpenBoardPkg/ReadMe.md

diff --git a/Platform/Intel/AlderlakeOpenBoardPkg/ReadMe.md b/Platform/Intel/AlderlakeOpenBoardPkg/ReadMe.md
new file mode 100644
index 00000000..cc475673
--- /dev/null
+++ b/Platform/Intel/AlderlakeOpenBoardPkg/ReadMe.md
@@ -0,0 +1,56 @@
+# **EDK II Minimized firmware for Intel(R)AlderLake platforms**
+
+##Features
+The Minimized AlderLake provides the minimal feature of the AlderLake BIOS.
+
+## **Windows Build Instructions**
+
+### Pre-requisites
+
+* GIT client: Available from https://git-scm.com/downloads
+* Microsoft Visual Studio.
+  - Visual Studio 2015 recommended and is used in the examples below.
+* ASL compiler: Available from http://www.acpica.org
+  - Install into ```C:\ASL``` to match default tools_def.txt configuration.
+* NASM assembler:  Available from: http://www.nasm.us/
+  - Install into ```C:\NASM``` to match default tools_def.txt configuration.
+* Python 3.7.3:  Available from: https://www.python.org/downloads/release/python-373/
+  - Other versions of Python 3.x should be compatible.
+  - It is recommended to use the Python launcher to ensure the Python build script is launched using Python 3.
+  - E.g. "py -3.7 build_bios.py -l"
+
+### Download the required components run GitBash.exe
+1. Create a new directory for the EDK II WORKSPACE.
+2. Download below repository to this WORKSPACE:
+* edk2 repository
+  * ``git clone  https://github.com/tianocore/edk2.git
+
+* edk2-platforms repository
+  * ``git clone  https://github.com/tianocore/edk2-platforms.git
+
+* edk2-non-osi repository
+  * ``git clone  https://github.com/tianocore/edk2-non-osi.git
+
+* FSP repository
+  * ``git clone  https://github.com/IntelFsp/FSP.git
+
+* Get buildable EDK II repository, need additional submodule
+  * ``cd edk2
+  * ``git submodule update --init
+  * ``git checkout e10f1f5a043a402fb2daf2091b8f725fd2951743
+
+* Get buildable edk2-platforms repository
+  * ``cd ..
+  * ``cd edk2-platforms
+  * ``git checkout fc6e3523d868650ad4f8aaac0ccdd8f138370341
+
+### Build
+1. cd ..\edk2-platform\platform\intel
+2. py -3 build_bios.py -t VS2019 -p AlderLakePRvp
+
+### **Known limitations**
+1. This firmware project has been tested booting to Microsoft Windows 11 x64 with M2 SSD Disk and Integrated Graphic Device.
+2. AlderlakeOpenBoardPkg/Acpi/MinDsdt has been modified from MinPlatformPkg/Acpi/MinDsdt to avoid hang on boot to Microsoft Windows 11 x64.
+3. Since the FSP binary is incompatible with the latest Edk2 version, a working edk2 version needs to be kept
+   EDK2 SHA-1: e10f1f5a043a402fb2daf2091b8f725fd2951743
+   EDK2-Platforms SHA-1: fc6e3523d868650ad4f8aaac0ccdd8f138370341
\ No newline at end of file
-- 
2.26.2.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115055): https://edk2.groups.io/g/devel/message/115055
Mute This Topic: https://groups.io/mt/104120131/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-