[Patch][edk2-platforms/devel-IntelAtomProcessorE3900] Platform/ReadMe.MD

[Patch][edk2-platforms/devel-IntelAtomProcessorE3900] Platform/ReadMe.MD

[Guo, Mang]

Contributed-under: TianoCore Contribution Agreement 1.1

Signed-off-by: Guo Mang <mang.guo@intel.com>
---
 Platform/ReadMe.MD | 186 +++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 175 insertions(+), 11 deletions(-)

diff --git a/Platform/ReadMe.MD b/Platform/ReadMe.MD
index 9f5ae85..5381de3 100644
--- a/Platform/ReadMe.MD
+++ b/Platform/ReadMe.MD
@@ -1,19 +1,183 @@
-#   Intel Atom(R) Processor E3900 Series Platforms
+# UEFI Firmware Project for Intel Atom(R) Processor E3900 Series platforms
 
-This codebase is designed for Intel Atom(R) Processor E3900 Series platforms.(https://www.intel.com/content/www/us/en/embedded/products/apollo-lake/overview.html) (formerly Apollo Lake).
+This codebase is designed for Intel Atom(R) Processor E3900 Series platforms (formerly Apollo Lake). https://www.intel.com/content/www/us/en/embedded/products/apollo-lake/overview.html
 
-Contributions to this open source project are covered by the
-[TianoCore Contribution Agreement 1.1](Contributions.txt)
+## Download Official Releases
 
-The majority of the content in the this open source project uses a
-[BSD 2-Clause License](License.txt).
+Please refer to the release notes to download official releases (source code and binary images). Information is available at https://firmware.intel.com/projects/minnowboard3
 
-The maintainers are listed in [Maintainers.txt](Maintainers.txt).
+## Download the Latest Source Code
 
-# Resources
+Official source releases are recommended since they have passed stability testing. Use the directions below to download the latest code.
+```
+1. Create a new folder (directory) on the root of your local development machine
+   for use as your workspace (this example uses "C:\MyWorkspace").
 
-* [devel-IntelAtomProcessorE3900](Platform/ReadMe.MD) -- Instructions
+2. Get devel-IntelAtomProcessorE3900 branch from GitHub*
+   git clone https://github.com/tianocore/edk2-platforms.git -b devel-IntelAtomProcessorE3900
 
-* http://minnowboard.org/ -- Platform Information.
+3. Get EDK II packages
+   git clone -b vUDK2018 https://github.com/tianocore/edk2.git
+
+4. Get the Intel(R) Firmware Support Package(Intel(R) FSP)
+   1.git clone -b ApolloLake https://github.com/IntelFsp/FSP.git
+   2.cd FSP
+   3.git checkout a57c66616e78b471515a1e1862796bf61d3824d8
+   4.Copy the ApolloLakeFspBinPkg to the folder
+     "C:\MyWorkspace\edk2-platforms\Silicon\BroxtonSoC\BroxtonFspPkg".
+
+5. Install UEFI UNDI driver:
+   1.Install UEFI UNDI driver for Intel i210 Ethernet Controller
+   Download PREBOOT.EXE Version 21.1 from the "Intel® Ethernet Connections 
+   Boot Utility, Preboot Images, and EFI Drivers" page.
+     https://downloadcenter.intel.com/download/19186/Intel-Ethernet-Connections-Boot-Utility-Preboot-Images-and-EFI-Drivers
+
+   Windows user:
+   a. Install PREBOOT.EXE into the default folder (C:\Intel21.1).
+   b. Copy the UEFI x64 PCI-E gigabit driver (C:\Intel21.1\APPS\EFI\EFIx64\E7320X3.EFI) 
+      to the platform package directory below, create the folder if it does not exist:
+      "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Binaries\UNDI\I210PcieUndiDxe"
+
+   Linux user:
+   a. Use command "unzip PREBOOT.EXE" to extract UEFI x64 PCI-E gigabit driver 
+      (preboot/APPS/EFI/EFIx64/E7320X3.EFI)
+   b. Copy E7320X3.EFI to platform package directory below, create the folder
+      if it does not exist:
+      "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Common/Binaries/UNDI/I210PcieUndiDxe"
+
+   2.Install UNDI driver for AX88179 USB-to-LAN adapter
+   a. Download AX88179_178A_UEFI_V2.8.0.zip from http://www.asix.com.tw/FrootAttach/driver/AX88179_178A_UEFI_V2.8.0.zip.
+   b. Unzip AX88179_178A_UEFI_V2.8.0.zip to get AX88179_178A_UEFI_V2.8.0_X64.efi and AX88179_178A_UEFI_V2.8.0_IA32.efi.
+   C. Copy AX88179_178A_UEFI_V2.8.0_X64.efi and AX88179_178A_UEFI_V2.8.0_IA32.efi to below directory, create the folder
+      if it does not exist:
+      Windows user: "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Binaries\UNDI\AX88179\"
+      Linux user: "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Common/Binaries/UNDI/AX88179/"
+
+6. Follow the instructions found in the "OpenSSL-HOWTO.txt" file located in the Workspace
+   (e.g. "C:\MyWorkspace\edk2\CryptoPkg\Library\OpensslLib\OpenSSL-HOWTO.txt")
+   to install the OpenSSL* source code and enable the CryptoPkg module.   
+
+7. Download "IntelAtomE3900-0.70-Binary.Objects.zip" Binary Object Modules
+   a. Download the "IntelAtomE3900-0.70-Binary.Objects.zip" from the project page:
+      https://firmware.intel.com/projects/IntelAtomProcessorE3900
+
+   b. Unzip and copy the folders into the directory below, and create the folder if it does not exist:
+      "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Board\"
+```
+
+## **Windows Build Instructions**
+
+### Pre-requisites
+
+* Microsoft Visual Studio
+  - Install C compiler (Visual Studio .NET* VS2013/VS2015) on the build machine.
+* ASL compiler: Available from http://www.acpica.org
+  - Unzip and copy ```iasl.exe``` into ```C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\Iasl```.
+* NASM assembler:  Available from: http://www.nasm.us/
+  - Unzip the 32-bit & 64-bit versions of nasm.exe to the directories listed below
+  ```
+  C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\nasm\Win32
+  C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\nasm\Win64
+  ```
+* Python 2.7.10:  Available from: https://www.python.org/downloads/release/python-2710/
+  - Install Python and make sure that a file with the extension of ".py" will be opened by Python.exe.
+
+### Build
+
+1. Open a command prompt of Microsoft Visual Studio, such as "Developer Command Prompt for VS2013";
+2. Type the command: "cd C:\MyWorkspace\edk2-platforms" to enter your workspace;
+3. Run below command to build:
+   ```
+   Build Command Usage: BuildBIOS.bat [Build Options] <PlatformName> <BuildTarget>
+   Build Options:
+        To Select Visual Studio Version:
+          /vs13  Set Compiler to vs2013 build (default)
+          /vs15  Set Compiler to vs2015 build
+       
+        To Select CPU Arch supported by BIOS:
+          /x64   Set Arch to X64  (default)
+          /IA32  Set Arch to IA32 
+       
+        To Select Board Supported by BIOS:
+          /MX    MinnowBoard 3 Module
+          /LH    Leaf Hill CRB
+               
+        To Select FAB ID supported by BIOS:
+          /D     Set FabId to D
+     
+   PlatformName:  Broxton
+   BuildTargets:  Release or Debug
+   
+      Examples:      
+       To build release version 32-bit BIOS for Minnowboard 3 Module Pre-production with VS2015,
+         BuildBIOS.bat /vs15 /MX /A /IA32 Broxton Release
+
+       To build release version 64-bit BIOS for Minnowboard 3 Module Pre-production with VS2015,
+         BuildBIOS.bat /vs15 /MX /A /x64 Broxton Release  
+ 
+       To build release version 32-bit BIOS for Leaf Hill CRB with VS2015,
+         BuildBIOS.bat /vs15 /LH /D /IA32 Broxton Release
+       
+       To build release version 64-bit BIOS for Leaf Hill CRB with VS2015,
+         BuildBIOS.bat /vs15 /LH /D /x64 Broxton Release  
+
+   ```
+4. After the build successfully completes, the 8MB firmware binary image will
+   be located in the following location on your local hard drive:
+   "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\Stitch"
+   
+## **Linux Build Instructions**
+
+### Pre-requisites
+
+* Linux System Configuration
+  - Ubuntu 16.04 64-bit
+  - GCC version 5
+* Use below command to install required packages:
+    ```
+      # sudo apt-get update
+      # sudo apt-get install nasm 
+      # sudo apt-get install iasl
+      # sudo apt-get install build-essential
+      # sudo apt-get install uuid-dev
+    ```
+
+### Build
+
+1. Open a command prompt, type command: "cd ~/src/MyWorkspace/edk2-platforms"
+   to enter your workspace directory;
+2. Run below command to build:
+   ```
+   Build Command Usage: BuildBIOS.bat [Build Options] <PlatformName> <BuildTarget>
+   Build Options:
+     To Select Board Supported by BIOS:
+       /MX    MinnowBoard 3 Module
+       /LH    Leaf Hill CRB
+
+     To Select FAB ID supported by BIOS:
+       /D     Set FabId to D 
+
+   PlatformName:  Broxton
+   BuildTargets:  Release or Debug
+       Examples:
+       To build release version 64-bit BIOS for MinnowBoard 3 Module,
+         ./BuildBIOS.sh /MX /A Broxton Release
+
+       To build release version 64-bit BIOS for Leaf Hill CRB,
+         ./BuildBIOS.sh /LH /D Broxton Release
+
+       To build debug version 64-bit BIOS for Leaf Hill CRB,
+         ./BuildBIOS.sh /LH /D Broxton Debug
+
+   ```
+ 
+3. After the build successfully completes, the 8MB firmware binary image will
+      be located in the following location on your local hard drive:
+      "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Common/Tools/Stitch/"
+
+## **Related Materials**
+  
+   http://minnowboard.org/ -- Open Source Hardware Project
+
+   https://firmware.intel.com/projects/IntelAtomProcessorE3900  -- Release notes, pre-built release/debug binaries, build instructions, and binary objects required to compile firmware.
 
-* https://firmware.intel.com/projects/IntelAtomProcessorE3900  -- Release notes, pre-built release/debug binaries, build instructions, and binary objects required to compile firmware.
\ No newline at end of file
-- 
2.10.1.windows.1