From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.93; helo=mga11.intel.com; envelope-from=mang.guo@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 E3F23209574C8 for ; Sun, 4 Mar 2018 18:11:28 -0800 (PST) X-Amp-Result: UNKNOWN X-Amp-Original-Verdict: FILE UNKNOWN X-Amp-File-Uploaded: False Received: from orsmga008.jf.intel.com ([10.7.209.65]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 04 Mar 2018 18:17:40 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.47,425,1515484800"; d="dat'59?scan'59,208,59";a="22527973" Received: from fmsmsx106.amr.corp.intel.com ([10.18.124.204]) by orsmga008.jf.intel.com with ESMTP; 04 Mar 2018 18:17:40 -0800 Received: from fmsmsx123.amr.corp.intel.com (10.18.125.38) by FMSMSX106.amr.corp.intel.com (10.18.124.204) with Microsoft SMTP Server (TLS) id 14.3.319.2; Sun, 4 Mar 2018 18:17:40 -0800 Received: from shsmsx102.ccr.corp.intel.com (10.239.4.154) by fmsmsx123.amr.corp.intel.com (10.18.125.38) with Microsoft SMTP Server (TLS) id 14.3.319.2; Sun, 4 Mar 2018 18:17:39 -0800 Received: from shsmsx103.ccr.corp.intel.com ([169.254.4.116]) by shsmsx102.ccr.corp.intel.com ([169.254.2.124]) with mapi id 14.03.0319.002; Mon, 5 Mar 2018 10:17:37 +0800 From: "Guo, Mang" To: "edk2-devel@lists.01.org" CC: "Wei, David" , "Richardson, Brian" Thread-Topic: [Patch][edk2-platforms/devel-MinnowBoard3-UDK2017] Update ReadMe.MD Thread-Index: AdO0KCEvj+4w6l7zRU2uLDS5zWU5Cw== Date: Mon, 5 Mar 2018 02:17:37 +0000 Message-ID: <22D2C85ED001C54AA20BFE3B0E4751D1525B880B@SHSMSX103.ccr.corp.intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: <22D2C85ED001C54AA20BFE3B0E4751D1525B880B@SHSMSX103.ccr.corp.intel.com> x-originating-ip: [10.239.127.40] MIME-Version: 1.0 X-Content-Filtered-By: Mailman/MimeDel 2.1.23 Subject: [Patch][edk2-platforms/devel-MinnowBoard3-UDK2017] Update ReadMe.MD X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 05 Mar 2018 02:11:29 -0000 Content-Language: en-US Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Guo Mang --- ReadMe.MD | 178 ++++++++--------------------------------------------------= ---- 1 file changed, 21 insertions(+), 157 deletions(-) diff --git a/ReadMe.MD b/ReadMe.MD index a42260e..3c35cbd 100644 --- a/ReadMe.MD +++ b/ReadMe.MD @@ -1,172 +1,37 @@ -=EF=BB=BF -This code base is designed for the MinnowBoard v3 platform using the Intel= (R) Atom(tm) Processor E3900 Series. -This code base is based on UDK2017 core packages. +# =EF=BB=BFMinnowBoard 3 and Leaf Hill CRB Platform =20 -# INDEX +This codebase is designed for the MinnowBoard 3 platform and Leaf Hill Cus= tomer Reference Board (CRB), using the [Intel Atom(R) Processor E3900 Serie= s](https://www.intel.com/content/www/us/en/embedded/products/apollo-lake/ov= erview.html) (formerly Apollo Lake). =20 -1. HOW TO CREATE A FULL SOURCE TREE -2. HOW TO BUILD (WINDOWS ENVIRONMENT) -3. MAINTAINERS +## Codebase Overview =20 -## 1. HOW TO CREATE A FULL SOURCE TREE +This codebase is based on UDK2017 core packages, [Intel(R) Firmware Suppor= t Package](https://github.com/IntelFsp/FSP.git) +(Intel(R) FSP), [UEFI UNDI driver](https://downloadcenter.intel.com/downlo= ad/19186/Intel-Ethernet-Connections-Boot-Utility-Preboot-Images-and-EFI-Dri= vers) +for Intel Ethernet Controllers, and pre-compiled binary objects required f= or the final Integrated Firmware Image (IFWI). =20 -1. Create a new folder (directory) on the root of your local development m= achine - for use as your work space (this example uses "C:\MyWorkspace"). +Additional information on this project is available at [firmware.intel.com= ](https://firmware.intel.com/projects/minnowboard3). =20 - NOTE: Some code paths are very long, and placing the working directory = too - deep below the ROOT directory may cause the path to be longer tha= n the - operating system or file system's maximum path length. +## Build Instructions =20 -2. Get MinnowBoard v3 branch from GitHub with the following command. - * `git clone -b devel-MinnowBoard3-UDK2017 https://github.com/tianocore= /edk2-platforms.git` +Instructions for downloading a source tree and compiling firmware are avai= lable in the project release notes at [firmware.intel.com](https://firmware= .intel.com/projects/minnowboard3): +* https://firmware.intel.com/sites/default/files/MinnowBoard3-Rel_0_69-Rel= easeNotes.txt +* https://firmware.intel.com/sites/default/files/LeafHill-Rel_0_69-Release= Notes.txt =20 - Once the download completes, all EDK II packages and files will be foun= d - under the "C:\MyWorkspace\edk2-platforms" directory. +*Note that Release 0.69 added a separate [release notes file for the Leaf = Hill CRB](https://firmware.intel.com/sites/default/files/LeafHill-Rel_0_69-= ReleaseNotes.txt). Instructions for downloading the Leaf Hill CRB source t= ree and compiling an IFWI image differ slightly from MinnowBoard 3.* =20 -3. Get the BaseTools binary and copy them to BaseTools binary folder. - 1. `git clone https://github.com/tianocore/edk2-BaseTools-win32.git Win= 32` - 2. Enter folder Win32 - 3. `git checkout 0e088c19ab31fccd1d2f55d9e4fe0314b57c0097` - 4. Copy Win32 to the BaseTools Binary folder. - (C:\MyWorkspace\edk2-platforms\BaseTools\Bin\) +This project's build instructions have been validated in the following env= ironments: +* Microsoft Windows 7 Ultimate 64-bit & Microsoft Windows 10 Enterprise 64= -bit with Microsoft Visual Studio 2013/2015 +* Ubuntu Linux 16.04.3.LTS with GCC 5 =20 -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 de67689ef6261c1a0ecee01b7312bd635e3435e7` - 4. Copy the ApolloLakeFspBinPkg to the folder - "C:\MyWorkspace\edk2-platforms\Silicon\BroxtonSoC\BroxtonFspPkg" +## Pre-Compiled Firmware Images =20 -5. Install UEFI UNDI driver: - Download PREBOOT.EXE Version 21.1 from the "Intel=C2=AE Ethernet Con= nections - Boot Utility, Preboot Images, and EFI Drivers" page. - https://downloadcenter.intel.com/download/19186/Intel-Ethernet-Conne= ctions-Boot-Utility-Preboot-Images-and-EFI-Drivers +Pre-compiled binary images are available at https://firmware.intel.com/pro= jects/minnowboard3 =20 - 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\EFI= x64\E7320X3.EFI)=20 - to the platform package directory below, create the folder if it doe= s not exist: - * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Commo= n\Binaries\UNDI\I210PcieUndiDxe" +This [project](https://firmware.intel.com/projects/minnowboard3) also incl= udes IA32 & x64 'flash update' tools for the UEFI Shell (FirmwareUpdateUtil= ities). +These utilities require the 'BIOS Lock' feature to be disabled. Please ref= er to the release notes for programming instructions. =20 - 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: - * "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Co= mmon/Binaries/UNDI/I210PcieUndiDxe" +## Reporting Issues =20 -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. - -7. Download MinnowBoard v3 Binary Object Modules - 1. Download the "MinnowBoard_v3-0.63-Binary.Objects.zip" from the proje= ct page: - * https://firmware.intel.com/projects/minnowboardv3 - 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\MinnowBoard3" - -## 2. HOW TO BUILD (WINDOWS ENVIRONMENT) - -Windows System Configuration: - - Microsoft Windows 7 Ultimate 64-bit* - -1. Setup Build Environment - - 1. Install Visual Studio 2013/2015 on the build machine. - - 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 b= y 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.1= 2.02-win32.zip - * http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win64/nasm-2.1= 2.02-win64.zip - - b. Unzip the 32-bit & 64-bit versions of nasm.exe to the directori= es listed below, - respectively, and create the folders if they do not exist: - * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Commo= n\Tools\nasm\Win32" - * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Commo= n\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\Comm= on\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 "Develop= er Command Prompt for VS2013"; - * Type the command: `cd C:\MyWorkspace\edk2-platforms` - * Type the command: `BuildBIOS.bat /B /VS13 /IA32 Broxton Release` t= o 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 "Develop= er Command Prompt for VS2013"; - * Type the command: `cd C:\MyWorkspace\edk2-platforms` - * 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 ima= ge will be located in the - following location on your local hard drive: - - * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\= Tools\Stitch" - - 2b. Build Steps (64-bit) - - 1. To build a 64-bit release version - * Open a command prompt of Microsoft Visual Studio, such as "Develop= er Command Prompt for VS2013"; - * Type the command: `cd C:\MyWorkspace\edk2-platforms` - * 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 "Develop= er Command Prompt for VS2013"; - * Type the command: `cd C:\MyWorkspace\edk2-platforms` - * Type the command: `BuildBIOS.bat /B /VS13 /x64 Broxton Debug` to b= uild 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 ima= ge will be located in the - following location on your local hard drive: - - * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\T= ools\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-pl= atforms`; - * For MinnowBoard 3 FAB B, type the command:`./BuildBIOS.sh /B Relea= se` to build a release version. - (Replace "/B" with "/A" for MinnowBoard 3 FAB A board) - 2. To build a 64-bit debug version=20 - * Open a command prompt, type command: `cd ~/src/MyWorkspace/edk2-pl= atforms`; - * 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 ima= ge will be located in the - following location on your local hard drive: - - * "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Commo= n/Tools/Stitch/" +To report issues on this codebase, please use [TianoCore Bugzilla](https:/= /bugzilla.tianocore.org/). For more information, please refer to the [Repor= ting Issues](https://github.com/tianocore/tianocore.github.io/wiki/Reportin= g-Issues) entry on the [TianoCore wiki](https://github.com/tianocore/tianoc= ore.github.io/wiki). =20 ## MAINTAINERS =20 @@ -175,4 +40,3 @@ Linux System Configuration: * vincent.zimmer@intel.com * mike.wu@intel.com * shifeix.a.lu@intel.com - --=20 2.10.1.windows.1