Welcome to Project MU

🔹 Copyright

Copyright (c) 2017, Microsoft Corporation

All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

About

This document provides a brief introduction to Project MU as well as information about building a UEFI image for the iMX8. There's more to booting an iMX8 than UEFI; additional documentation for those steps is provided here.

Building with MU TL;DR

1. Run git submodule update --init --recursive to check out all the submodules.
2. Run python {Platform}/{Device}/PlatformBuild.py --setup to set up the build environment. Includes fetching Nuget dependencies and synchronizing submodules.
3. Run python {Platform}/{Device}/PlatformBuild.py to invoke the build process.

MU Repos

NXP Platform

This is platform repo, which is the root repository in which all the other submodules are located. This is also where code specific to the platform or devices would be located, including PlatformBuild.py and PlatformBuildWorker.py.

Silicon/ARM/NXP

Silicon code provided from a manufacturer is kept in its own submodule so it can be maintained seperately from platform code.

MU_BASECORE

This is the main repo. Contains the guts of the build system as well as core UEFI code, forked from TianoCore.

Silicon/ARM/MU_TIANO

Silicon code from TianoCore has been broken out into indivudal submodules. iMX8 is ARM, so we need this submodule. An Intel project would include Intel/MU_TIANO.

Common/MU_TIANO

Additional, optional libraries and tools forked from TianoCore.

Common/MU

Additional, optional libraries and tools we've added to make MU great!

Common/MU_OEM_SAMPLE

This module is a sample implementation of a FrontPage and several BDS support libraries. This module is intended to be forked and customized.

Build Environment

Part of Project Mu is moving towards a fully Python build environment. We currently have three published Python modules, using pip, that encompass setting up the build environment, logging, and running CI builds.

Documentation of the build system is still in progress on the Project MU page under Code Repositories.

Pip modules

mu_python_library

Python files describing miscellaneous components (EDKII, TPM, etc.)

mu_environment

This is the code that PlatformBuild.py calls in to that sets up the build environment.

mu_build

Command line interface that fetches dependencies and builds each module specified by a descriptor file. See MU_BASECORE as an example.

Troubleshooting

To forcibly install the latest version of mu_environment: pip install --upgrade mu_environment --force-reinstall --no-cache-dir

Since mu_environment has a dependency on mu_python_library, it should be updated through this command as well. If they are not, the same command can be run for mu_python_library.

Setup Info for iMX8

• sudo apt-get install gcc g++ make python3 python3-pip git mono-devel
  • Minimum Python version is 3.6
  • Minimum git version 2.11
• git clone https://github.com/ms-iot/MU_PLATFORM_NXP
• Install pip modules for build:
  • pip3 install -r requirements.txt --upgrade
• Change into the directory you just cloned and run:
  • git submodule update --init --recursive
• Download Linaro AARCH 64 GCC 7.2.1
  • Set GCC5_AARCH64_PREFIX to this path
    • tar -xf gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu.tar.gz
    • export GCC5_AARCH64_PREFIX=$PWD/gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-
• python3 NXP/MCIMX8M_EVK_4GB/PlatformBuild.py --setup
  • This fetches any dependencies via NuGet and synchronizes submodules
• rm -r Build; rm -r Conf; python3 NXP/MCIMX8M_EVK_4GB/PlatformBuild.py TOOL_CHAIN_TAG=GCC5 BUILDREPORTING=TRUE BUILDREPORT_TYPES="PCD"
  • Removing Build and Conf directories ensures that you aren't accidentally keeping around configuration files and autogen build files that need to be updated.
  • Specify the TOOL_CHAIN_TAG either here or in NXP/Conf/Target.template.ms
  • Build reports are placed in the Build folder on a successful build and contain a complete list of every module that was built and what the PCDs were set to.
• Serial output
  • User Guide NXP
  • In Depth Guide NXP
  • The drivers that actually worked for me
  • Serial configuration
    • Speed = 921600
    • Data bits = 8
    • Stop bits = 1
    • Parity = None
    • Flow Control = XON/XOFF