Manufacturing Tool V2 (MFGTool2)

　　Update Command List (UCL) User Guide

　　　　　　　　　　　　　　　　　　Contents（目录）

　　　　　　　　Contents（目录）                                                        1

　　　　　　　　1 Overview（概述）                                                      2

　　　　　　　　2 UTP mode operation（UTP模式操作）                           2

　　　　　　　　　　2.1 Global Configuration（全局配置）                        2　　

　　　　　　　　　　2.2 Update Command List（更新命令列表）               3

　　　　　　　　　　　　2.2.1 Host Specific Commands（主机命令）         3

　　　　　　　　　　　　2.2.2 Firmware Specific Commands（固件命令）  5

1 Overview（概述）

Manufacturing (Mfg) tool provides a flexible way for users to set their own operations. An xml script file is used to configure the users operation.

An xml file typically consists of a number of tasks which can be executed by running the manufacturing tool just once.

Mfg工具给用户提供了一种灵活的方式来设置用户自己的操作。xml脚本文件用于配置用户操作。xml文件通常包含一系列将要被Mfg工具运行的操作，每次只能被运行一次。

2 UTP mode operation（UTP模式操作）

2.1 Global Configuration（全局配置）

Mfg tool uses global configuration to recognize which device the user wants to flash among different USB devices connected to the PC.

当前连接到PC机上USB设备可能很多，Mfg工具使用全局配置来选择对哪一个USB设备进行程序烧入。

Let’s explain it by an example.举个例子看看

1   <CFG>
2 　　<STATE name="BootStrap" dev="MX6Q" vid="15A2" pid="0054"/>
3 　　<STATE name="Updater"   dev="MSC" vid="066F" pid="37FF"/>
4   </CFG>

Global configuration is contained between parameter <CFG> and </CFG>

全局配置是包含在<CFG>和</CFG>之间的参数

<STATE name="BootStrap" dev="MX6Q" vid="15A2" pid="0054"/> indicates the first phase of the burning process, the phase name is “BootStrap”, and a device named “MX6Q” should be connected with the USB pid “0054” and vid “15A2”. For i.MX 6 serial, in the phase “BootStrap”, the valid strings for dev are: “MX6Q”, “MX6D”, “MX6SL”; in the phase “Updater”, the valid string for dev is: “MSC”.

<STATE name="BootStrap" dev="MX6Q" vid="15A2" pid="0054"/>指定烧写过程的第一个阶段，阶段的名字叫“BootStrap”，设备名叫“MX6Q”，并且这个设备实际上就是USB的pid为“0054”和vid为“15A2”的设备（USB（Universal Serial BUS，通用串行总线）协议规定，所有的USB设备都有VID（Vendor ID，供应商识别码）和PID（Product ID，产品识别码））。对于i.MX6系列，在“BootStrap”阶段，设备有效字符串有：“MX6Q”、“MX6D”，“MX6SL”，在“Updater”阶段，设备有效字符串为：“MSC”。

<STATE name="Updater"   dev="MSC" vid="066F" pid="37FF"/> indicates the second phase of the burning process, the phase name is “Updater”, and a device named “MSC” should be connected with the USB pid “37FF” and vid “066F”.

<STATE name="Updater"   dev="MSC" vid="066F" pid="37FF"/> 指定烧写过程的第二个阶段，这个阶段的名字叫“Updater”，设备名为“MSC”，也就是USB的pid为“37FF”和vid为“066F”的设备。

2.2 Update Command List（更新命令列表）

The tool uses Update Command List (UCL) to specify all the user tasks. The UCL contains a distinct list for each use case. Each list contains a set of command elements with attributes for the command type, body, and payload. The command element text provides a user interface message for the current operation.

Mfg工具使用更新命令列表（UCL）来指定所有的用户任务。包含一个不同的列表为每个用例，每个用例对应一个目标列表，每一个目标列表抱哈 了一系列的命令元素，每个命令元素由命令类型、命令实体、命令有效载荷，命令元素文本内容提为当前操作的用户操作信息

Each UCL begins from <LIST name=”xx”, desc=”xxx”> while ending with </LIST>, the name of which can be specified by users. Parameter “desc” is used for comment purpose.

There are two types of commands: host specific commands and firmware specific commands. Host specific commands are parsed and executed by host tool while firmware specific commands are parsed and executed by firmware runs on targeted device.

每一个UCL以<LIST name=”xx”, desc=”xxx”>开始，并以</LIST>结束，“name”可以由用户自己指定，参数“desc”用于说明用途。这其中有2种命令：主机命令和固件命令。主机命令被主机工具（Mfg工具）解析并执行，固件命令被目标设备解析并执行。

2.2.1 Host Specific Commands（主机命令）

The example below shows a typical command. “state” indicates the phase of the command executed and “type” specifies the type of a command. “body” is a parameter of the command. “file” is another parameter. “Loading Kernel” is a description of the command.

下面这个例子向我们展示一个典型的命令：

　　“state”指定命令执行的阶段；

　　“type”指定了命令的类型；

　　“body”是命令参数（这里不是指shell命令的参数，是指type命令的参数，可以是shell命令+shell命令参数）；

　　“file”是其他参数中的一种，指定要加载的文件；

　　“Loading Kernel”是命令的描述，用于描述这条命令用于做什么。

1 <CMD state="BootStrap" type="load" file="uImage" address="0x10800000"
2         loadSection="OTH" setSection="OTH" HasFlashHeader="FALSE" >Loading Kernel.</CMD>

2.2.2 Firmware Specific Commands（固件命令）

If a command is typed as “push”, which means the command is parsed and executed by the targeted device instead of host, the only thing host has to do is to send the command to the targeted device.

如果命令类型是“push”，这个命令也就意味这是被目标设备执行，主机唯一要做的就是发送命令道目标设备

The commands actually executed by OS image are downloaded in Command lists. As a result, each OS has its own commands.

被OS image执行的命令被下载在Command lists中，因此，每个OS都有自己的commands

2.2.2.1 OTP Bits Programming（OTP位编程）

Command below shows how to write a file to a disk:

下面展示了如何写一个文件到磁盘中

1   <CMD state="Updater" type="push" body="$ ls /sys/fsl_otp ">Showing HW_OCOTP fuse bank</CMD>
2   <CMD state="Updater" type="push" body="$ echo 0x11223344 > /sys/fsl_otp/HW_OCOTP_MAC0">write 0x11223344 to HW_OCOTP_MAC0 fuse bank</CMD>
3   <CMD state="Updater" type="push" body="$ cat /sys/fsl_otp/HW_OCOTP_MAC0">Read value from HW_OCOTP_MAC0 fuse bank</CMD>

The fuse bank name (ex: HW_OCOTP_MAC0) should be set as needed.