Mu OnePlus6T Platform Repository

Project Mu based OnePlus6T Platform Repo. For Building Project Mu firmware of the OnePlus6T Device.

Contents

• Current Status & Schedule
• Getting Started
• Acknowledgement
• License

Current Status & Schedule

Repository

• Implement configuration of compilation environment with scripts.
• Implement compilation with scripts.
• Use upstream master branch of the OnePlus6TPkg from sdm845Pkg instead of specific modified branches.

OnePlus6TPkg

	GCC	MSVC
Config	YES	YES
Compile	YES	NO
Bootable	LIMITED	NO

Getting Started

Details

This repository is NOT a part of Project Mu, but it depends on some parts of Project Mu.

• mu_plus
• mu_basecore
• mu_oem_sample
• mu_tiano_plus
• mu_silicon_arm_tiano

For more information about these repositories, see Project Mu.

Preparation (Ubuntu 20.04 x64)

Upgrade

1. Upgrade your system to the latest state before you begin installing the necessary packages.

   sudo apt-get update
   sudo apt-get upgrade

Install Package

1. The packages we need to install include Python-3, Git, abootimg .

   sudo apt-get install python3 git abootimg python3-venv python3-pip

Cross Compiler Tool Chain

1. In order to avoid the differences caused by the tool chain, we will use the recommended tool chain to complete the compilation.

2. Download gcc-linaro-7.4.1-x86_64_aarch64-linux-gnu.

   wget http://releases.linaro.org/components/toolchain/binaries/7.4-2019.02/aarch64-linux-gnu/gcc-linaro-7.4.1-2019.02-x86_64_aarch64-linux-gnu.tar.xz

3. Decompress the package to somewhere you want.

   xz -d gcc-linaro-7.4.1-2019.02-x86_64_aarch64-linux-gnu.tar.xz
   tar xvf gcc-linaro-7.4.1-2019.02-x86_64_aarch64-linux-gnu.tar

4. Add the toolchain to environment variable.

   export PATH="$PATH:<Your Toolchain Installation Dir>/gcc-linaro-7.4.1-2019.02-x86_64_aarch64-linux-gnu/bin"

   Or you can permanently add the toolchain to the system by modifying the /etc/ environment .

5. Switch default compiler to cross compiler. Sometimes setting CC variable is invalid, so we have to change cross compiler to local compiler temporarily.

   sudo update-alternatives --install /usr/bin/gcc gcc <Your Toolchain Installation Dir>/gcc-linaro-7.4.1-2019.02-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-gcc 70
   sudo update-alternatives --install /usr/bin/gcc-ar gcc-ar <Your Toolchain Installation Dir>/gcc-linaro-7.4.1-2019.02-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-gcc-ar 70

   Don't forget to reset the local compiler after using the cross compiler.

Workspace & Virtual Environment

1. Create the workspace like this.

   /WorkspaceRoot (basic platform)
   |-- src_of_project
   |-- venv        <-- Virtual environment for Project in workspace root
   |
   

2. Run python cmd to create virtual environment.

   python3 -m venv <your virtual env name>

3. Activate it for your session.

   source <your virtual env name>/bin/activate

Preparation (Windows10 x64)

Python

1. Download latest Python from https://www.python.org/downloads

   https://www.python.org/ftp/python/3.8.2/python-3.8.2-amd64.exe

2. It is recommended you use the following options when installing python:

   1. include pip support.
   2. include test support.
   3. include venv virtual environment support.

Git

1. Download latest Git For Windows from https://git-scm.com/download/win .

   https://github.com/git-for-windows/git/releases/download/v2.25.1.windows.1/Git-2.25.1-64-bit.exe

2. It is recommended you use the following options:

   1. Checkout as is, commit as is.
   2. Native Channel support (this will help in corp environments).
   3. Check the box to "Enable Git Credential Manager".

Visual Studio 2019

1. Download latest version of VS build Tools to c:\TEMP.

   https://aka.ms/vs/16/release/vs_buildtools.exe

2. Install from cmd line with required features (this set will change over time).

   C:\TEMP\vs_buildtools.exe --quiet --wait --norestart --nocache --installPath C:\BuildTools \
   --add Microsoft.VisualStudio.Component.VC.CoreBuildTools --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 \
   --add Microsoft.VisualStudio.Component.Windows10SDK.17763 --add Microsoft.VisualStudio.Component.VC.Tools.ARM \
   --add Microsoft.VisualStudio.Component.VC.Tools.ARM64

   See component list here for more options. https://docs.microsoft.com/en-us/visualstudio/install/workload-component-id-vs-build-tools?view=vs-2019

NASM

1. Download lastest version of NASM (NetWide Assembler).

   https://www.nasm.us/pub/nasm/releasebuilds/2.15.05/win64/nasm-2.15.05-installer-x64.exe

2. Add NASM to Widnows Environment variable.

   Variable Name:  NASM_PREFIX
   Variable Value: <NASM installation dir>/

Workspace & Virtual Environment

1. Create the workspace like this.

   /WorkspaceRoot (basic platform)
   |-- src_of_project
   |-- venv        <-- Virtual environment for Project in workspace root
   |
   

2. Run python cmd to create virtual environment.

   python -m venv <your virtual env name>

3. Activate it for your session.

   <your virtual env name>/Scripts/activate.bat

Compile

CI Build Process

1. Open cmd prompt at workspace root.

2. Activate your python virtual environment.

3. Install or update Python dependencies using pip.

   pip install --upgrade -r pip-requirements.txt

4. Run stuart_setup to download required submodules.

   stuart_setup -c .pytool/CISettings.py

5. Run stuart_ci_setup to download CI only dependencies.

   stuart_ci_setup -c .pytool/CISettings.py

6. Run stuart_update to download or update binary dependencies.

   stuart_update -c .pytool/CISettings.py

7. Run stuart_ci_build to build and test the packages.

   stuart_ci_build -c .pytool/CISettings.py

8. Open TestResults.xml in the build output for results (usually in workspace/Build).

9. Open log files to debug any errors.

Platform Build Process

1. Open cmd prompt at workspace root.

2. Activate your python virtual environment.

3. Install or update Python dependencies using pip.

   pip install --upgrade -r pip-requirements.txt

4. Run stuart_setup to download required submodules.

   stuart_setup -c Platforms/OnePlus6TPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=VS2019

5. Run stuart_update to download or update binary dependencies.

   stuart_update -c Platforms/OnePlus6TPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=VS2019

6. Run stuart_build to build and test the packages.

   stuart_build -c Platforms/OnePlus6TPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=VS2019

7. Open the build output for log files to debug any errors (usually in workspace/Build).

Generation Bootable Image Process

1. Get the necessary documents.

   mkdir img
   cp Build/OnePlus6TPkg/DEBUG_<your toolchian tag>/FV/ONEPLUS6TPKG_UEFI.fd ./img
   cp dtb/fajita.dtb ./img
   echo > ./img/ramdisk

2. Using abootimg tool to generate image.

   cd img
   gzip -c < ./ONEPLUS6TPKG_UEFI.fd > "./uefi-fajita.img.gz"
   cat "./uefi-fajita.img.gz" "./fajita.dtb" > "./uefi-fajita.img.gz-dtb"
   abootimg --create "./boot-fajita.img" -k "./uefi-fajita.img.gz-dtb" -r ramdisk

3. Use FastBoot to start.

   fastboot boot boot-fajita.img

Acknowledgement

• mu: Provids details of project mu.
• mu_tiano_platforms: Provides a template for such firmware projects.
• edk2-sdm845: Most of the code for OnePlus6TPkg comes from sdm845Pkg.

License

The software is distributed under BSD 2-Clause License.