Update ReadMe.MD

Contributed-under: TianoCore Contribution Agreement 1.0

Signed-off-by: Guo Mang <mang.guo@intel.com>

1 files changed, 74 insertions, 40 deletions

diff --git a/ReadMe.MD b/ReadMe.MD
index ae1556bf20..f5cbc7c052 100644
--- a/ReadMe.MD
+++ b/ReadMe.MD
@@ -24,56 +24,45 @@ This code base is based on UDK2017 core packages.
    under the "C:\MyWorkspace\edk2-platforms" directory.

 

 3. Get the BaseTools binary and copy them to BaseTools binary folder.

-   1. Enter folder BaseTools\Bin

-   2. `git clone https://github.com/tianocore/edk2-BaseTools-win32.git Win32`

-   3. Enter folder Win32

-   4. `git checkout 7b52b1a9bf853b5c498ea61d0a4f17083f543be4`

+   1. `git clone https://github.com/tianocore/edk2-BaseTools-win32.git Win32`

+   2. Enter folder Win32

+   3. `git checkout 0e088c19ab31fccd1d2f55d9e4fe0314b57c0097`

+   4. Copy Win32 to the BaseTools Binary folder.

+       (C:\MyWorkspace\edk2-platforms\BaseTools\Bin\)

 

 4. Get the Intel(R) Firmware Support Package(Intel FSP).

    1. Run `git clone -b ApolloLake https://github.com/IntelFsp/FSP.git` to download FSP

    2. Enter folder FSP

-   3. Run `git checkout 08b5af471a0caea79724ca3eb4794e6a0a7a31aa`

+   3. Run `git checkout de67689ef6261c1a0ecee01b7312bd635e3435e7`

    4. Copy the ApolloLakeFspBinPkg to the folder

       "C:\MyWorkspace\edk2-platforms\Silicon\BroxtonSoC\BroxtonFspPkg"

 

 5. Install UEFI UNDI driver:

-   1. Download PREBOOT.EXE Version 21.1 from the "Intel® Ethernet Connections

+      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

-   2. Install PREBOOT.EXE into the default folder (C:\Intel21.1).

-   3. Copy the UEFI x64 PCI-E gigabit driver (C:\Intel21.1\APPS\EFI\EFIx64\EnnnnX3.EFI,

-      where "nnnn" is the driver version number) to the platform package directory below, create the folder if it does not exist:

+   Windows user:

+   1. Install PREBOOT.EXE into the default folder (C:\Intel21.1).

+   2. 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"

-   4. Open the file "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\PlatformPkg.fdf"

-      and change the UNDI driver file name reference with the one that was downloaded:

-         SECTION PE32 = BroxtonPlatformPkg/Common/Binaries/UNDI/I210PcieUndiDxe/E7006X3.EFI

-

-6. Install the NASM assembly language compiler:

-   1. Download NASM 2.12.02 binaries:

-      * http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win32/nasm-2.12.02-win32.zip

-      * http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win64/nasm-2.12.02-win64.zip

-   2. Unzip the 32-bit & 64-bit versions of nasm.exe to the directories listed below,

-      respectively, and create the folders if they do not exist:

-      * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\nasm\Win32"

-      * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\nasm\Win64"

-

-7. Install the ACPI Source Language (ASL) compiler:

-   1. Install the IASL 2016-09-30 compiler from acpica.org:

-      https://acpica.org/sites/acpica/files/iasl-win-20160930.zip

-   2. Unzip the "iasl.exe" file into the directory below, and create the folder

+   Linux user:

+   1. Use command "unzip PREBOOT.EXE" to extract UEFI x64 PCI-E gigabit driver

+      (preboot/APPS/EFI/EFIx64/E7320X3.EFI)

+   2. Copy E7320X3.EFI to platform package directory below, create the folder

       if it does not exist:

-      * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\Iasl"

+    * "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Common/Binaries/UNDI/I210PcieUndiDxe"

 

-8. Follow the instructions found in the "Patch-HOWTO.txt" file located in the Workspace

+6. Follow the instructions found in the "Patch-HOWTO.txt" file located in the Workspace

    (e.g. "C:\MyWorkspace\edk2-platforms\Core\CryptoPkg\Library\OpensslLib\Patch-HOWTO.txt")

    to install the OpenSSL source code and enable the CryptoPkg module.

 

-9. Download MinnowBoard v3 Binary Object Modules

+7. Download MinnowBoard v3 Binary Object Modules

    1. Download the "MinnowBoard_v3-0.63-Binary.Objects.zip" from the project page:

       * https://firmware.intel.com/projects/minnowboardv3

-   2. Unzip and copy the two folders (A_Stepping, B_Stepping) into

+   2. Unzip and copy the two folders (FAB_A, FAB_B) into

       the directory below, and create the folder if it does not exist:

-      * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Binaries\IFWI"

+      * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Binaries\IFWI\MinnowBoard3"

 

 ## 2. HOW TO BUILD (WINDOWS ENVIRONMENT)

 

@@ -84,23 +73,39 @@ Windows System Configuration:
 

    1. Install Visual Studio 2013/2015 on the build machine.

 

-   2. Install the latest Python 2 Release from: https://www.python.org/downloads/windows/

+   2. Install version Python 2.7.10 from: https://www.python.org/downloads/release/python-2710/

       * Make sure that a file with the extension of ".py" will be opened by Python.exe.

 

+   3. Install the NASM assembly language compiler:

+      a. Download NASM 2.12.02 binaries:

+        * http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win32/nasm-2.12.02-win32.zip

+        * http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win64/nasm-2.12.02-win64.zip

+      b. Unzip the 32-bit & 64-bit versions of nasm.exe to the directories listed below,

+         respectively, and create the folders if they do not exist:

+        * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\nasm\Win32"

+        * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\nasm\Win64"

+

+   4. Install the ACPI Source Language (ASL) compiler:

+      a. Install the IASL 2016-09-30 compiler from acpica.org:

+         https://acpica.org/sites/acpica/files/iasl-win-20160930.zip

+      b. Unzip the "iasl.exe" file into the directory below, and create the folder

+         if it does not exist:

+         * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\Iasl"

+

 2. Build

 

   2a. Build Steps (32-bit)

     1. To build a 32-bit release version

       * Open a command prompt of Microsoft Visual Studio, such as "Developer Command Prompt for VS2013";

       * Type the command: `cd C:\MyWorkspace\edk2-platforms`

-      * Type the command: `BuildBIOS.bat /VS13 /IA32 Broxton Release` to build a release version.

-        (Please use "VS15" flag for Visual Studio 2015 build)

+      * Type the command: `BuildBIOS.bat /B /VS13 /IA32 Broxton Release` to build a release version.

+        (Please use "/VS15" flag for Visual Studio 2015 build; Replace "/B" with "/A" flag for MinnowBoard 3 FAB A board)

 

     2. To build a 32-bit debug version

       * Open a command prompt of Microsoft Visual Studio, such as "Developer Command Prompt for VS2013";

       * Type the command: `cd C:\MyWorkspace\edk2-platforms`

-      * Type the command: `BuildBIOS.bat /VS13 /IA32 Broxton Debug` to build a debug version.

-        (Please use "VS15" flag for Visual Studio 2015 build)

+      * Type the command: `BuildBIOS.bat /B /VS13 /IA32 Broxton Debug` to build a debug version.

+        (Please use "/VS15" flag for Visual Studio 2015 build; Replace "/B" with "/A" flag for MinnowBoard 3 FAB A board)

 

     3. After the build successfully completes, the 8MB firmware binary image will be located in the

        following location on your local hard drive:

@@ -111,20 +116,49 @@ Windows System Configuration:
     1. To build a 64-bit release version

       * Open a command prompt of Microsoft Visual Studio, such as "Developer Command Prompt for VS2013";

       * Type the command: `cd C:\MyWorkspace\edk2-platforms`

-      * Type the command: `BuildBIOS.bat /VS13 /x64 Broxton Release` to build a release version.

-        (Please use "VS15" flag for Visual Studio 2015 build)

+      * Type the command: `BuildBIOS.bat /B /VS13 /x64 Broxton Release` to build a release version.

+        (Please use "/VS15" flag for Visual Studio 2015 build; Replace "/B" with "/A" flag for MinnowBoard 3 FAB A board)

 

     2. To build a 64-bit debug version

       * Open a command prompt of Microsoft Visual Studio, such as "Developer Command Prompt for VS2013";

       * Type the command: `cd C:\MyWorkspace\edk2-platforms`

-      * Type the command: `BuildBIOS.bat /VS13 /x64 Broxton Debug` to build a debug version.

-        (Please use "VS15" flag for Visual Studio 2015 build)

+      * Type the command: `BuildBIOS.bat /B /VS13 /x64 Broxton Debug` to build a debug version.

+        (Please use "/VS15" flag for Visual Studio 2015 build; Replace "/B" with "/A" flag for MinnowBoard 3 FAB A board)

 

     3. 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"

 

+## 3. HOW TO BUILD (LINUX ENVIRONMENT)

+

+Linux System Configuration:

+  Ubuntu 16.04 64-bit

+  bash shell

+  gcc version 5 or above

+

+1. Setup Build Environment

+   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

+

+2. Build Steps (64-bit)

+    1. To build a 64-bit release version

+      * Open a command prompt, type command: "cd ~/src/MyWorkspace/edk2-platforms";

+      * For MinnowBoard 3 FAB B, type the command:"./BuildBIOS.sh /B Release" to build a release version.

+        (Replace "/B" with "/A" for MinnowBoard 3 FAB A board)

+    2. To build a 64-bit debug version 

+      * Open a command prompt, type command: "cd ~/src/MyWorkspace/edk2-platforms";

+      * For MinnowBoard 3 FAB B, type the command:"./BuildBIOS.sh /B Debug" to build a debug version.

+        (Replace "/B" with "/A" for MinnowBoard 3 FAB A board)

+    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/"

+

 ## MAINTAINERS

 

 * david.wei@intel.com