Installation and Update of NXP MFGTool and congatec Bootloader Profiles (AN33)

From conga-wiki
Affected Products conga-QMX6 and conga-UMX6


Preface

This application note describes how to install and update the MFGTool and congatec bootloader Profiles via the git server.

Overview

NXP’s MFGTool (manufacturing tool) enables communication with i.MX6 based hardware designs (for example, conga QMX6 or conga UMX6) even if there is no working bootloader program resident in the SPI flash.

Previous releases were split up into separate MFGTool and MFG Profiles archive files. These archives were distributed via the congatec website and driver database. The newer releases (r006 and later) are available on the congatec public git server

This document describes how to install and update the MFGTool and MFG Profiles via the git server. Prior knowledge of git or version control in general is not required. However, to follow this guide, you require a Windows operating system and the Git GUI.

Please refer to the MFGTool readme (https://git.congatec.com/imx6-mfg-tool/mfgtool) for information on how to use the git command line or git bash. Refer also to the software guide for the latest information on the usage of the MFGTool.


Note:

Always use the latest release of MFGTool and MFG Profiles to ensure your design functions properly.

Preparation

Download the 2.8.2 git binary version from the following link depending on your processor architecture:


Note:

Do not obtain git binaries from unofficial sources.

Obtain git binaries only from the official website at https://github.com/git-for-windows/

The subsequently shown settings are recommended and should be strictly applied.

  1. Double-click the git binary executable file
  2. Select the components as shown below:
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (001).png
  1. Select Use Git from the Windows Component Prompt:
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (002).png
  1. Select Checkout as-is, commit Unix-style line endings:
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (003).png
  1. Select Use MinTTY (the default terminal of MSYS2):
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (004).png
  1. Select Enable file system caching:
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (005).png

Installation

Follow the steps below to fetch the latest MFGTool and MFG Profiles from the git server:

  1. Choose the installation destination for the MFGTool and MFG Profiles:
  • Open Windows Explorer (file manager)
  • Create a new directory and name it, for example "git_checkouts"
  • Double-click the newly created directory, for example "git_checkouts", to open it
  • Right-click anywhere in the open directory and click Git GUI Here
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (006).png
  1. Click Clone Existing Repository:
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (007).png


  1. Select the repository to clone and its local target directory:
  • In the Source Location box, enter the URL of the congatec mfgtool repository: https://git.congatec.com/imx6-mfg-tool/mfgtool.git
  • In the Target Directory box, enter the clone's local destination: MFGTool2
  • Select Recursively clone submodels too
  • Click Clone button
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (008).png


Note:

The latest MFGTool and its associated MFG Profiles are now cloned into the local target directory MFGTool2

Installation and Update of NXP MFGTool and congatec Bootloader Profiles (009).png


Note:

The MFGTool and MFG Profiles installation is complete if the Git GUI's main window displays (as shown below). This window opens automatically after a successful clone.

Installation and Update of NXP MFGTool and congatec Bootloader Profiles (010).png

Configuration

Follow the next steps to finalize the installation:

  1. Perform three mandatory configuration tasks:
  • On the menu bar, click ToolsAdd
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (010).png
  • Add the entry "Update MFG Profiles" as follows:
    • Name: Update MFG Profiles
    • Command: git submodule update --remote
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (013).png
  • Add the entry "Update MFGTool" as follows:
    • Name: Update MFGTool (!!backup your files first!!)
    • Command: git reset --hard HEAD && git pull origin master && git submodule update --init
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (014).png
  1. Update the MFG Profiles to the latest release as described in the paragraph Updating MFG Profiles
  2. Close Git GUI and locate the directory "MFGTool2"

Update

Updating MFG Profiles

The MFG Profiles contain various bootloader images required to boot Linux, Android or Windows Embedded Compact (WEC). To ensure, that one is burning the latest available bootloader revision, update the MFG Profiles regularly.

To update the MFG Profiles, follow the instructions below:

  1. Open the Windows Explorer (file manager)
  2. Locate the directory "MFGTool2"
  3. Right-click anywhere in the open directory and click Git GUI Here:
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (015).png
  1. At the menu bar, click on Tools → Update MFG Profiles
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (016).png

Updating the MFGTool

Update the MFGTool to the latest version if you encounter an issue with a new MFG Profile release.


Note:

Double-check your configuration settings before you update the MFGTool, to rule out misconfiguration.


Caution:

Updating the MFGTool will overwrite all MFG related files. Create a backup in order to prevent unintended data loss.


Steps for updating the MFGTool

  1. Open the Explorer (file manager)
  2. Double click the directory MFGTool2
  3. Backup the modified files (cfg.ini, ucl2.xml, etc.)
  4. Right click anywhere in the open directory and click Git GUI Here
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (017).png
  1. On the menu bar, click on Tools → Update MFGTool
Installation and Update of NXP MFGTool and congatec Bootloader Profiles (018).png