Hi Leif,<br /><br />Please find my responds inline.<br /><br />On Thu, Dec 3, 2020 at 07:49 PM, Leif Lindholm wrote:<br />
<blockquote>On Thu, Dec 03, 2020 at 11:04:00 +0700, Nhi Pham wrote:<br />
<blockquote>From: Phong Vo &lt;phong@os.amperecomputing.com&gt;<br /><br />Add initial version of Readme.md for Ampere platform<br /><br />Cc: Leif Lindholm &lt;leif@nuviainc.com&gt;<br />Cc: Michael D Kinney &lt;michael.d.kinney@intel.com&gt;<br />Cc: Ard Biesheuvel &lt;ard.biesheuvel@arm.com&gt;<br />Cc: Nate DeSimone &lt;nathaniel.l.desimone@intel.com&gt;<br /><br />Signed-off-by: Phong Vo &lt;phong@os.amperecomputing.com&gt;<br />---<br />Platform/Ampere/Readme.md | 167 ++++++++++++++++++++<br />1 file changed, 167 insertions(+)<br /><br />diff --git a/Platform/Ampere/Readme.md b/Platform/Ampere/Readme.md<br />new file mode 100644<br />index 000000000000..c93b35a62e84<br />--- /dev/null<br />+++ b/Platform/Ampere/Readme.md<br />@@ -0,0 +1,167 @@<br />+# Overview<br />+<br />+This document provides the guideline to build UEFI firmware for Ampere Computing's arm64 reference platforms.<br />+<br />+Platform code is located under Platform/Ampere/{Platform Name}Pkg.<br />+<br />+Silicon code is located under Silicon/Ampere/Ampere{SoC Name}Pkg.<br />+<br />+# How to build (Linux Environment)<br />+<br />+## Build machines<br />+<br />+The build instructions provided in this document are supported on the following operating systems:</blockquote>
s/are supported/have been verified/</blockquote>
<br />Thanks, will fix it.<br /><br />
<blockquote>
<blockquote>+<br />+- Ubuntu 18.04 (x86)<br />+- CentOS 8.2 (x86)</blockquote>
*sigh*<br />These platforms have 160-cores, support 8TB of DRAM, and you *still*<br />consider cross compilation from another architecture to be how to<br />build software for them?<br /><a href="https://www.youtube.com/embed/nqxbeEy8dMk?autoplay=1&amp;playlist=nqxbeEy8dMk&amp;loop=1" target="_blank" rel="noopener">https://www.youtube.com/embed/nqxbeEy8dMk?autoplay=1&amp;playlist=nqxbeEy8dMk&amp;loop=1</a></blockquote>
Thanks Leif for the catch.&nbsp; I'll update this to include our supported platforms as native compilation works, too.<br /><br />
<blockquote>
<blockquote>+However, it does not mean this guideline is not applicable for other Ubuntu/CentOS versions,<br />+or other Linux distributions. You may, at your own risk, try it on other Linux distributions<br />+if all steps below are performed correctly.<br />+<br />+## Essential development tools<br />+<br />+The following is the list of tools needed for development: `bison, build-essential, bzip2, default-jre, flex<br />+gawk, gpg, libc6:i386, libgcc1:i386, openssl, libssl-dev, m4, make, python, python3-distutils, tar, uuid-dev wget`<br />+<br />+They can be installed using standard OS distro's `apt-get` (for Ubuntu) or `yum` (for CentOS).<br />+<br />+## Toolchain<br />+<br />+### GCC for aarch64<br />+<br />+Ampere provides GCC toolchains<br />+[aarch64-ampere-linux-gnu](<a href="https://cdn.amperecomputing.com/tools/compilers/cross/8.3.0/ampere-8.3.0-20191025-dynamic-nosysroot-crosstools.tar.xz" target="_blank" rel="noopener">https://cdn.amperecomputing.com/tools/compilers/cross/8.3.0/ampere-8.3.0-20191025-dynamic-nosysroot-crosstools.tar.xz</a>)<br />+<br />+Linaro provides GCC toolchains for<br />+[aarch64-linux-gnu](<a href="https://releases.linaro.org/components/toolchain/binaries/latest/aarch64-linux-gnu/" target="_blank" rel="noopener">https://releases.linaro.org/components/toolchain/binaries/latest/aarch64-linux-gnu/</a>)</blockquote>
Why on earth would you want custom toolchains?<br />Even *if* cross compiling, all of the relevant distributions have<br />packaged aarch64 cross compilers since LTS versions no longer<br />supported.</blockquote>
We&rsquo;ll update to clarify the use of Ampere&rsquo;s custom toolchain as an option, for both cross compiling and native compiling.<br /><br />
<blockquote>On the whole though, instructions for how to build a platform is<br />already documented in the top-level Readme.md. This file should<br />restrict itself to aspects that are specific to Ampere.<br /><br />
<blockquote>+Throughout this document, Ampere toolchain is assumed to be installed at location /opt/toolchain/.<br />+<br />+When cross compiling, it is necessary to provide the appropriate compilation prefix depending on<br />+whether Ampere toolchain or Linaro toolchain is used.<br />+<br />+Target architecture | Cross compilation prefix<br />+--------------------|-------------------------<br />+AARCH64 | aarch64-linux-gnu- (Linaro toolchain)<br />+AARCH64 | aarch64-ampere-linux-gnu- (Ampere toolchain)<br />+<br />+### Intel ASL+ Optimizing Compiler/Disassembler<br />+<br />+Download and install the ISAL compiler as follows:</blockquote>
IASL</blockquote>
Thanks. Will fix.<br /><br />
<blockquote>
<blockquote>+<br />+```bash<br />+$ wget <a href="https://acpica.org/sites/acpica/files/acpica-unix2-20200110.tar.gz" target="_blank" rel="noopener">https://acpica.org/sites/acpica/files/acpica-unix2-20200110.tar.gz</a><br />+$ tar xzf acpica-unix2-20200110.tar.gz<br />+$ cd acpica-unix2-20200110<br />+$ make &amp;&amp; sudo make install<br />+$ iasl -v<br />+```</blockquote>
I could well believe a newer version of IASL than shipped with the<br />abovementioned Linux distros would be required. However, Instructions<br />for how to rebuild/install a newer acpica-tools would be better to<br />have in the top-level Readme.md.</blockquote>
The top level README does not mention the IASL compiler. Do you think we should add it?<br /><br />
<blockquote>Here, it would be more useful to document which is the minimum (and<br />worst case, maximum) version needed, and why.<br /><br />
<blockquote>+<br />+## Obtaining source code<br />+<br />+1. Create a new folder (directory) on your local development machine<br />+for use as your workspace. This example uses `/work/git/tianocore`, modify as<br />+appropriate for your needs.<br />+<br />+ ```bash<br />+ $ export WORKSPACE=/work/git/tianocore<br />+ $ mkdir -p $WORKSPACE<br />+ $ cd $WORKSPACE<br />+ ```<br />+<br />+2. Into that folder, clone:<br />+<br />+ ```bash<br />+ $ git clone --recurse-submodules <a href="https://github.com/AmpereComputing/edk2.git" target="_blank" rel="noopener">https://github.com/AmpereComputing/edk2.git</a><br />+ $ git clone --recurse-submodules <a href="https://github.com/AmpereComputing/edk2-platforms.git" target="_blank" rel="noopener">https://github.com/AmpereComputing/edk2-platforms.git</a><br />+ ```</blockquote>
Not relevant for this repo.</blockquote>
Thanks. Will fix.<br /><br />
<blockquote><br />/<br />Leif<br /><br />
<blockquote>+<br />+Set up a PACKAGES_PATH to point to the locations of these three repositories:<br />+`$ export PACKAGES_PATH=$PWD/edk2:$PWD/edk2-platforms`<br />+<br />+## Manual building<br />+<br />+### Additional environment setup<br />+<br />+```bash<br />+$ export CROSS_COMPILER_PATH=/opt/toolchain/ampere-8.3.0-20191025-dynamic-nosysroot/bin<br />+$ export PATH=${CROSS_COMPILER_PATH}:${PATH}<br />+$ export CROSS_COMPILE=aarch64-ampere-linux-gnu-<br />+$ export GCC5_AARCH64_PREFIX=${CROSS_COMPILE}<br />+```<br />+<br />+1. Set up the build environment (this will modify your environment variables)<br />+<br />+ `$ . edk2/edksetup.sh`<br />+<br />+ (This step _depends_ on **WORKSPACE** being set as per above.)<br />+<br />+2. Build BaseTools<br />+<br />+ `make -C edk2/BaseTools`<br />+<br />+ (BaseTools can currently not be built in parallel, so do not specify any `-j`<br />+ option, either on the command line or in a **MAKEFLAGS** environment<br />+ variable.)<br />+<br />+### Build options<br />+<br />+There are a number of options that can (or must) be specified at the point of<br />+building. Their default values are set in `edk2/Conf/target.txt`. If we are<br />+working only on a single platform, it makes sense to just update this file.<br />+<br />+target.txt option | command line | Description<br />+------------------|--------------|------------<br />+ACTIVE_PLATFORM | `-p` | Description file (.dsc) of platform<br />+TARGET | `-b` | One of DEBUG, RELEASE or NOOPT.<br />+TARGET_ARCH | `-a` | Architecture to build for. In our case, use AARCH64.<br />+TOOL_CHAIN_TAG | `-t` | Toolchain profile to use for building. In our case, use GCC5.<br />+<br />+There is also MAX_CONCURRENT_THREAD_NUMBER (`-n`), roughly equivalent to<br />+`make -j`.<br />+<br />+When specified on command line, `-b` can be repeated multiple times in order to<br />+build multiple targets sequentially.<br />+<br />+After a successful build, the resulting images can be found in<br />+`Build/{Platform Name}/{TARGET}_{TOOL_CHAIN_TAG}/FV`.<br />+<br />+For example,<br />+`Build/Jade/RELEASE_GCC5/FV`<br />+<br />+### Build a platform<br />+<br />+The main build process _can_ run in parallel - so figure out how many threads we<br />+have available.<br />+<br />+```bash<br />+$ getconf _NPROCESSORS_ONLN<br />+8<br />+```<br />+<br />+Set up the build to use a little more than that:<br />+<br />+```bash<br />+$ NUM_CPUS=$((`getconf _NPROCESSORS_ONLN` + 2))<br />+```<br />+<br />+Now build the UEFI image:<br />+<br />+```bash<br />+$ cd edk2-platforms &amp;&amp; build -a AARCH64 -t GCC5 -b RELEASE -D SECURE_BOOT_ENABLE -p Platform/Ampere/JadePkg/Jade.dsc<br />+```<br />+<br />+(Note that the description file gets resolved by the build command through<br />+searching in all locations specified in **PACKAGES_PATH**.)<br />+<br />+## Additional build tools<br />+<br />+Ampere provides additional tools and documentation for automating the manual process described above,<br />+and for building a final Tianocore UEFI image that can be flashed on the target system.<br />+<br />+To use these tools, clone the following to the **WORKSPACE** location:<br />+<br />+```bash<br />+$ git clone <a href="https://github.com/AmpereComputing/edk2-ampere-tools.git" target="_blank" rel="noopener">https://github.com/AmpereComputing/edk2-ampere-tools.git</a><br />+```<br />-- <br />2.17.1</blockquote>
</blockquote>