paulmon/imx-iotcore

Windows 10 IoT Core BSP for NXP i.MX Processors

Windows 10 IoT Core for NXP i.MX Processors

Component	Build Status
U-Boot Firmware
OP-TEE Firmware
Security TAs
Security TA Test
EDK2 Firmware
MU Firmware
All Firmware
FFU

Important! Please read this section first.

This code is provided as a public preview, it is still under development which means not all platform features are enabled or fully optimized. Notwithstanding the license attached to this code, should not be used in any commercial application at this time. For any questions and feedback on how the BSP can better support your targeted solution, please contact your Microsoft or NXP representative or post to the NXP community.

This code is available under the MIT license except where stated otherwise such as the imxnetmini driver and OpteeClientLib.

Board List

SoC Type	Board Vendor	Board Name	Board Package Name
i.MX 6Quad	SolidRun	HummingBoard Edge	HummingBoardEdge_iMX6Q_2GB
i.MX 6Quad	NXP	i.MX 6Quad SABRE	Sabre_iMX6Q_1GB
i.MX 6Quad	Boundry Devices	i.MX 6Quad SABRELITE	SabreLite_iMX6Q_1GB
i.MX 6Quad	VIA	VAB-820	VAB820_iMX6Q_1GB
i.MX 6QuadPlus	NXP	i.MX 6QuadPlus SABRE	Sabre_iMX6QP_1GB
i.MX 6DualLite	SolidRun	HummingBoard Edge	HummingBoardEdge_iMX6DL_1GB
i.MX 6Solo	SolidRun	HummingBoard Edge	HummingBoardEdge_iMX6S_512MB
i.MX 6SoloX	UDOO	Neo Full	UdooNeo_iMX6SX_1GB
i.MX 6SoloX	NXP	i.MX SX Sabre	Sabre_iMX6SX_1GB
i.MX 6ULL	NXP	i.MX 6ULL EVK	EVK_iMX6ULL_512MB
i.MX 7Dual	CompuLab	IoT Gateway, CL-SOM-iMX7+SBC-iMX7	ClSomImx7_iMX7D_1GB
i.MX 7Dual	NXP	i.MX 7Dual SABRE	Sabre_iMX7D_1GB
i.MX 8M	NXP	i.MX 8M EVK	NXPEVK_IMX8M_4GB
i.MX 8M Mini	NXP	i.MX 8M Mini EVK	NXPEVK_IMX8M_Mini_2GB

A table of the currently enabled features for each board can be found here. For hardware issues, please contact the hardware vendor.

Building the BSP

Cloning the Repository

This repository uses submodules and should be cloned with git clone --recurse-submodules

Required Tools

The following tools are required to build the driver packages and IoT Core FFU: Visual Studio 2017, Windows Kits (ADK/SDK/WDK), and the IoT Core OS Packages.

Visual Studio 2017

• Make sure that you install Visual Studio 2017 before the WDK so that the WDK can install a required plugin.
• Download Visual Studio 2017.
• During install select Desktop development with C++.
• During install select the following in the Individual components tab. If these options are not available try updating VS2017 to the latest release:
  • VC++ 2017 version 15.9 v14.16 Libs for Spectre (ARM)
  • VC++ 2017 version 15.9 v14.16 Libs for Spectre (ARM64)
  • VC++ 2017 version 15.9 v14.16 Libs for Spectre (X86 and x64)
  • Visual C++ compilers and libraries for ARM
  • Visual C++ compilers and libraries for ARM64

Windows Kits from Windows 10, version 1809

• IMPORTANT: Make sure that any previous versions of the ADK and WDK have been uninstalled!
• Install ADK version 1809
• Install WDK version 1809
  • Make sure that you allow the Visual Studio Extension to install after the WDK install completes.
• If the WDK installer says it could not find the correct SDK version, install SDK version 1809

IoT Core OS Packages

• Visit the Windows IoT Core Downloads page and download "Windows 10 IoT Core Packages – Windows 10 IoT Core, version 1809 (LTSC)".
• Open the iso and install Windows_10_IoT_Core_ARM_Packages.msi
• Install Windows_10_IoT_Core_ARM64_Packages.msi for ARM64 builds.

One-Time Environment Setup

Test certificates must be installed to generate driver packages on a development machine.

1. Open an Administrator Command Prompt.
2. Navigate to your newly cloned repo and into the folder imx-iotcore\build\tools.
3. Launch StartBuildEnv.bat.
4. Run SetupCertificate.bat to install the test certificates.
5. Make sure that submodules have been cloned. If you cloned with --recurse-submodules then this step won't output anything.

   git submodule init
   git submodule update
   

FFU Generation

1. Launch Visual Studio 2017 as Administrator.
2. Open the solution iMXPlatform.sln (imx-iotcore\build\solution\iMXPlatform).
3. Change the build type from Debug to Release. Change the build flavor from ARM to ARM64 if building for iMX8.
4. To build press Ctrl-Shift-B or choose Build -> Build Solution from menu. This will compile all driver packages then generate the FFU.
5. Depending on the speed of the build machine FFU generation may take around 10-20 minutes.
6. After a successful build the new FFU will be located in imx-iotcore\build\solution\iMXPlatform\Build\FFU\HummingBoardEdge_iMX6Q_2GB\ for ARM builds and imx-iotcore\build\solution\iMXPlatform\Build\FFU\NXPEVK_iMX8M_4GB for ARM64 builds.
7. The FFU contains firmware components for the HummingBoard Edge with the Quad Core SOM or NXP IMX8M EVK with i.MX8M Quad Core SOM depending on build flavor. This firmware is automatically applied to the SD Card during the FFU imaging process.

Building the FFU for other boards

In order to build an FFU for another board you'll need to modify GenerateFFU.bat in the Build Scripts folder of the Solution Explorer. Comment out the default HummingBoardEdge_iMX6Q_2GB or NXPEVK_iMX8M_4GB builds with REM and uncomment any other boards you want to build.

REM cd /d %BATCH_HOME%
REM echo "Building HummingBoardEdge_iMX6Q_2GB FFU"
REM call BuildImage HummingBoardEdge_iMX6Q_2GB HummingBoardEdge_iMX6Q_2GB_TestOEMInput.xml

cd /d %BATCH_HOME%
echo "Building Sabre_iMX6Q_1GB FFU"
call BuildImage Sabre_iMX6Q_1GB Sabre_iMX6Q_1GB_TestOEMInput.xml

Deploy the FFU

• Follow the instructions in the IoT Core Manufacturing Guide to flash the FFU to an SD Card using the Windows IoT Core Dashboard.

Installing to an eMMC

• Follow the instructions in the Booting WinPE and Flashing eMMC document.

Adding a New Board

• Follow the instructions in the Adding a New Board document.

Adding a New Driver

• Follow the instructions in the Adding a New Driver document.

Building the FFU with the IoT ADK AddonKit

1. Build the GenerateBSP project to create a BSP folder in the root of the repository.
2. Clone the IoT ADK AddonKit.
3. Follow the Create a basic image instructions from the IoT Core Manufacturing guide with the following changes.

• When importing a BSP use one of the board names from the newly generated BSP folder in the imx-iotcore repo.

  Import-IoTBSP HummingBoardEdge_iMX6Q_2GB <Path to imx-iotcore\BSP>
  

• When creating a product use the same board name from the BSP import.

  Add-IoTProduct ProductA HummingBoardEdge_iMX6Q_2GB
  

Building Firmware from Source

Building custom firmware into an FFU requires additional steps:

• Building and Updating Firmware for ARM
• Building and Updating Firmware for ARM64
• Firmware Boot Documentation
• Firmware Signing Documentation for ARM
• Testing your BSP
• Creating Windows PE images and booting from eMMC

The firmware code can be found in the following repos:

• U-Boot: https://github.com/ms-iot/u-boot.git
• OP-TEE: https://github.com/ms-iot/optee_os.git
• UEFI for ARM:
  • https://github.com/tianocore/edk2.git
  • https://github.com/ms-iot/imx-edk2-platforms.git
• UEFI for ARM64:
  • https://github.com/ms-iot/MU_PLATFORM_NXP.git
  • https://github.com/ms-iot/MU_SILICON_NXP.git
  • https://github.com/Microsoft/mu_basecore.git
  • https://github.com/Microsoft/mu_plus.git
  • https://github.com/Microsoft/mu_silicon_arm_tiano.git
  • https://github.com/Microsoft/mu_tiano_plus.git
  • https://github.com/openssl/openssl
• Arm Trusted Firmware for ARM64:
  • https://source.codeaurora.org/external/imx/imx-atf
• IMX MkImage for ARM64:
  • https://source.codeaurora.org/external/imx/imx-mkimage
• Firmware TPM2.0:
  • https://github.com/Microsoft/ms-tpm-20-ref

Directories

BSP - Generated at build time. Contains Board Support Packages for the IoT ADK AddonKit.

build - Contains Board Packages, build scripts, and the VS2017 solution file.

driver - Contains driver sources.

documentation - Contains usage documentation.

hal - Contains hal extension sources.

Info

For more information about Windows 10 IoT Core, see our online documentation here

We are working hard to improve Windows 10 IoT Core and deeply value any feedback we get.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.