HiSpark编程指南
前言¶
概述
本文档主要介绍BurnTool的使用方法。用于指导工程人员快速使用BurnTool工具进行镜像烧写。
产品版本
与本文档相对应的产品版本如下。
产品名称 |
产品版本 |
|---|---|
4GCat1 |
V100 |
5GNB |
V100 |
BS25 |
V100 |
BS2X |
V100 |
GNSS71 |
V100 |
Melody |
V100 |
MP1X |
V100 |
NB1X |
V100 |
SP31 |
V100 |
Sparta |
V100 |
SW21 |
V100 |
SW38 |
V100 |
SW39 |
V100 |
TG1 |
V100 |
TG2 |
V100 |
TG2E |
V100 |
TG3 |
V100 |
WS53 |
V100 |
WS63 |
V100 |
WS73 |
V100 |
读者对象
本文档主要适用于以下工程师：
技术支持工程师
软件工程师
硬件工程师
符号约定
在本文中可能出现下列标志，它们所代表的含义如下。
符号 |
说明 |
|---|---|
|
表示如不避免则将会导致死亡或严重伤害的具有高等级风险的危害。 |
|
表示如不避免则可能导致死亡或严重伤害的具有中等级风险的危害。 |
|
表示如不避免则可能导致轻微或中度伤害的具有低等级风险的危害。 |
|
用于传递设备或环境安全警示信息。如不避免则可能会导致设备损坏、数据丢失、设备性能降低或其它不可预知的结果。 “须知”不涉及人身伤害。 |
|
对正文中重点信息的补充说明。 “说明”不是安全警示信息，不涉及人身、设备及环境伤害信息。 |
修改记录
文档版本 |
发布日期 |
修改说明 |
|---|---|---|
00B18 |
2025-09-01 |
新增“USB烧写”。 |
00B17 |
2025-08-07 |
更新“工厂烧写”小节。 更新“工厂烧写”小节。 |
00B16 |
2025-04-14 |
更新“产品安装”章节 |
00B15 |
2025-03-25 |
增加“USB或SLE烧写时无法找到目标设备”章节。 |
00B14 |
2024-12-07 |
更新“LUOFU、EMEI、XILING和TG0”、“TG1和TG2”章节“Option：Language”说明。 |
00B13 |
2024-11-14 |
|
00B12 |
2024-10-14 |
|
00B11 |
2024-08-29 |
|
00B10 |
2024-07-05 |
|
00B09 |
2024-06-30 |
|
00B08 |
2024-01-08 |
|
00B07 |
2022-06-15 |
在“手动烧写”中新增说明内容。 |
00B06 |
2022-04-29 |
|
00B05 |
2022-03-11 |
|
00B04 |
2022-02-22 |
|
00B03 |
2022-01-14 |
|
00B01 |
2021-09-01 |
第一次临时版本发布。 |
产品安装¶
BurnTool安装程序的安装步骤如下：
打开BurnTool安装程序“BurnTool.exe”。
弹出BurnTool安装路径选择界面，如图1所示，选择好安装路径后单击“Next”按钮。若安装路径选择为C盘“Program Files”需要在运行时使用管理员权限。
图 1 BurnTool安装界面
弹出BurnTool选择协议界面，如图2所示，选择对应的产品，单击“Next”按钮。
图 2 BurnTool选择协议界面
弹出BurnTool额外任务选择界面，如图3所示，单击“Install”按钮。
图 3 BurnTool额外任务选择界面
弹出BurnTool正在安装界面，请等待，直至安装完成。
弹出BurnTool安装完成界面，如图4所示，单击“Finish”按钮退出安装。
图 4 BurnTool安装完成界面
BurnTool工具简介¶
功能说明¶
BurnTool是芯片配套的烧写工具，通过打断程序启动的方式，对单板烧写镜像文件。
应用场景¶
BurnTool主要适用于以下场景：
镜像烧写
导出镜像
界面说明¶
选择Chip¶
通过“Option”-“Change chip”打开芯片选择框，用于选择与单板匹配的芯片类型，部分芯片还可选择需要的烧写方式，界面如图1所示。
图 1 选择Chip界面示意图
表 1 选择Chip界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
BurnTool¶
BurnTool界面如图1所示。
图 1 BurnTool界面示意图
表 1 BurnTool界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
3 |
|
4 |
|
5 |
Send file：按照表格选中信息依次烧写镜像。 |
6 |
镜像表格：显示可被烧写的镜像信息。各列含义为：
|
7 |
烧写进度。 |
8 |
回显视图：显示打断之后单板上报的数据。 |
9 |
|
10 |
Reset：重启单板。(本功能仅在烧写loader之后生效) Erase all：全片擦除。(本功能仅在烧写loader之后生效) |
11 |
Export：导出镜像。(本功能仅在烧写loader之后生效) |
12 |
|
13 |
Multiple burn：进入工厂烧写界面。 |
14 |
|
BurnTool-3x¶
BurnTool界面如图1所示。
图 1 BurnTool界面示意图
表 1 BurnTool界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
镜像表格：显示可被烧写的镜像信息。各列含义为：
|
7 |
|
8 |
|
9 |
|
10 |
|
11 |
|
BurnTool-Sparta¶
BurnTool界面如图1所示。
图 1 BurnTool界面示意图
表 1 BurnTool界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
镜像表格：显示可被烧写的镜像信息。各列含义为：
|
7 |
|
8 |
|
10 |
|
11 |
|
BurnTool-Dfu¶
DFU升级界面如图1所示，Auto DFU烧写界面如图2所示，Hid DFU升级界面如图3所示
图 1 DFU升级界面
图 2 Auto DFU烧写界面
图 3 Hid DFU升级界面
表 1 Dfu烧写界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
镜像表格：显示可被烧写的镜像信息。各列含义为：
|
7 |
|
8 |
|
9 |
|
10 |
|
BurnTool-Jlink¶
Jlink烧写界面如图1所示
图 1 Jlink烧写界面
表 1 Jlink烧写界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
Select file：选择格式为fwpkg的烧写镜像。 |
3 |
Start burn：按照表格选中信息依次烧写镜像。 |
4 |
镜像表格：显示可被烧写的镜像信息。各列含义如下。
|
5 |
烧写进度。 |
6 |
日志视图：显示烧写过程中单板上报的日志及工具打印的日志。 |
BurnTool-组播升级¶
组播升级界面如图1所示。
图 1 组播升级界面
表 1 组播升级界面说明
区域 |
说明 |
|---|---|
1 |
Network card：选择网卡。组播升级默认使用13456端口。 |
2 |
Select file：选择升级文件。 |
3 |
|
4 |
升级文件信息表。各列含义如下。
|
5 |
升级进度。 |
6 |
Package file send time：文件发送次数。 |
7 |
Current packet No.：当前包的编号。 |
BurnTool-OTA升级¶
OTA升级界面如图1所示
图 1 OTA升级界面示意图
表 1 Jlink烧写界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
|
8 |
镜像表格：显示可被烧写的镜像信息。各列含义如下。
|
9 |
|
10 |
|
BurnTool-TFTP¶
TFTP烧写包括LUOFU、EMEI、XILING、TG0、TG1和TG2六种不同芯片，通过“选择Chip”章节选择所需要的芯片种类。LUOFU、EMEI、XILING和TG0界面请参见“LUOFU、EMEI、XILING和TG0”章节，TG1和TG2请参见“TG1和TG2”章节。
LUOFU、EMEI、XILING和TG0¶
LUOFU、EMEI、XILING和TG0界面如图1所示。
图 1 LUOFU、EMEI、XILING和TG0烧写界面
表 1 LUOFU、EMEI、XILING和TG0烧写界面说明
区域 |
说明 |
|---|---|
1 |
Option：
Help：
|
2 |
COM：串口号列表，显示当前可用串口号。 |
3 |
IP Adress：PC的IP地址。 |
4 |
IP Config：点击打开配置板端需要的IP配置信息，配置界面请参见“板端IP配置界面”章节。 |
5 |
Erase config：点击打开擦除内容配置，配置界面请参见“擦除配置信息界面”章节。 |
6 |
Empty flash：用来设置是否为裸烧模式。 |
7 |
File：选择升级文件。 |
8 |
Start：开始升级。 |
9 |
镜像表格：显示可被烧写的镜像信息。各列含义如下。
|
10 |
日志视图：显示烧写过程中单板上报的日志及工具打印的日志。 |
TG1和TG2¶
TG1和TG2界面如图1所示。
图 1 TG1和TG2烧写界面
表 1 TG1和TG2烧写界面说明
区域 |
说明 |
|---|---|
1 |
Option：
Help：
|
2 |
Type：设置bootroom的烧写方式。
|
3 |
Vid：设备的Vendor ID； Pid：设备的Product ID。 |
4 |
COM：串口号列表，显示当前可用串口号。 |
5 |
IP Adress：PC的IP地址。 |
6 |
IP Config：点击打开配置板端需要的IP配置信息，配置界面请参见“板端IP配置界面”章节。 |
7 |
Erase config：点击打开擦除内容配置，配置界面请参见“擦除配置信息界面”章节。 |
8 |
Empty flash：用来设置是否为裸烧模式。 |
9 |
File：选择升级文件。 |
10 |
Start：开始升级。 |
11 |
镜像表格：显示可被烧写的镜像信息。各列含义如下。
|
12 |
|
板端IP配置界面¶
板侧IP配置界面如图1所示。
图 1 板侧IP配置界面
表 1 板侧IP配置界面说明
区域 |
说明 |
|---|---|
1 |
IP address：IP地址。 |
2 |
Subnet mask：子网掩码。 |
3 |
Gateway：网关。 |
4 |
Save：保存配置； Cancel：取消设置的配置。 |
擦除配置信息界面¶
擦除配置信息界面如图1所示。
图 1 擦除配置信息界面
表 1 板侧IP配置界面说明
区域 |
说明 |
|---|---|
1 |
Erase config：擦除配置项，设置擦除区间。 |
2 |
OK：确认设置。 |
BurnTool-MCU¶
MCU烧写界面¶
MCU烧写界面如图1所示。
图 1 烧写界面
表 1 MCU烧写界面说明
区域 |
说明 |
|---|---|
1 |
Setting：
Option：
Help：
|
2 |
Chip model：选择需要烧写的芯片。 |
3 |
Transfer method：烧写方式。 |
4 |
Connect：连接设备。 |
5 |
Param setting：NV参数配置，配置界面请参见“参数配置”章节。 |
6 |
参数区：根据所选的Transfer method确定设置的参数。 当选择SWD和JTAG时参数为频率和调试设备，当选择CAN、UART（USB）、UART时参数为波特率，当选择I2C和SPI时参数为速率。 |
7 |
Read back and verify after loader：加载后回读校验。 |
8 |
Run directly after loading：加载后直接运行。 |
9 |
Select file：选择文件。 |
10 |
Start burn：开始升级。 |
11 |
Mutiple burn：工厂烧写。 |
12 |
镜像表格：显示可被烧写的镜像信息。各列含义如下。
|
13 |
烧写进度。 |
14 |
日志视图：显示烧写过程中单板上报的日志及工具打印的日志。 |
15 |
Select target：选择导出的文件。 |
16 |
Addr：导出的地址或擦除地址。输入内容为16进制。 |
17 |
Size：导出长度或擦除长度。 |
18 |
Export：导出文件。 |
19 |
Erase：擦除文件。 |
20 |
Erase All：全擦。 |
参数配置¶
NV参数配置如图1所示。
图 1 NV参数配置
表 1 NV参数配置界面说明
区域 |
说明 |
|---|---|
1 |
参数列表。 |
2 |
File：选择保存到的文件。 |
3 |
Save：保存到所选文件中。 |
4 |
Effective immediately after setting：设置后立即生效。 |
5 |
Read：读取参数； write：写入参数。 |
BurnTool-USB¶
USB升级界面如图1所示。
图 1 USB升级界面
表 1 Dfu烧写界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
镜像表格：显示可被烧写的镜像信息。各列含义为：
|
8 |
|
9 |
|
10 |
|
工厂烧写¶
工厂烧写功能用于大批量烧写场景。在打断之后根据表格中的选中顺序发送文件。工厂烧写界面如图1所示。
图 1 工厂烧写界面示意图
表 1 工厂烧写界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
3 |
烧写结果统计：成功数，失败数，成功率，本次烧写时间。 |
4 |
Setting：包括以下菜单
|
图 2 机械臂串口设置界面
区域 |
说明 |
|---|---|
1 |
选择是否启用机械臂串口，勾选之后，以下参数才可以配置。 |
2 |
|
3 |
|
设置界面¶
设置界面主要用于设置串口参数，设置界面如图1所示。
图 1 设置界面示意图
表 1 设置界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
3 |
|
设置界面-3x¶
设置界面主要用于设置串口参数，设置界面如图1所示。
图 1 设置界面示意图
表 1 设置界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
3 |
|
选择Jlink执行程序界面¶
通过“Setting”-“Jlink Settings”打开Jlink设置，用来配置Jlink执行程序路径，界面如图1所示。
图 1 选择Jlink执行程序界面
表 1 选择JJlink执行程序界面说明
区域 |
说明 |
|---|---|
1 |
|
2 |
|
操作指南¶
手动烧写¶
串口烧写¶
在BurnTool界面中单击“Select file”按钮，选择各产品编译生成的固件包，并单击“OK”。
在表格中选中需要烧写的文件（请参考各产品文档中关于烧写的部分）。
选择“Setting”→“Settings”，配置串口参数，默认配置如图1所示。
说明：
Force Read Time：定时读取的时间，以毫秒为单位。勾选时为定时读取串口，不勾选时为事件触发读取串口。适用于不勾选该选项无法正常烧录的场景。图 1 串口设置示例
选择目标串口号并单击“Connect”按钮（单击后“Connect”变为“Disconnect”），复位单板。打断后效果如图2所示。
图 2 打断效果示意图
当界面显示字符串“CCC”时，单击“Send file”按钮。不同产品“CCC”上方的字符串可能不同。
等待传输完成后结束烧写，烧写完成会出现“All images burn successfully”。烧写完成效果如图3所示。
图 3 烧写完成示意图
3x协议串口烧写¶
参考选择Chip章节选择正确的芯片。
在BurnTool界面的COM处选择串口。如图1所示
图 1 选择串口
在BurnTool界面中单击“Select file”按钮，选择产品编译生成的固件包，并单击“打开”。
在表格中选中需要烧写的文件。
（可选）点击“Setting”→“Settings”，配置串口参数，默认配置如图2所示。
图 2 串口设置示例
单击“Start burn”按钮（单击后“Start burn”变为“Stop burn”），出现如图3所示提示，复位单板。
图 3 复位单板提示
等待传输完成后结束烧写，烧写完成会出现“All images burn successfully”。烧写完成效果如图4所示。
图 4 烧写完成示意图
图 6 询问是否加载配置示意图
DFU烧写¶
使用管理员权限打开程序（右键点击应用程序，点击以管理员身份运行，如图1所示）。
图 1 以管理员身份运行示意图
参考“选择Chip”章节选择带DFU后缀的芯片，如“XXX-USB”。
选择烧写模式，如图2所示，选择dfu升级模式。
图 2 烧写模式选择示意图
根据3选择的模式选择设备或者填写设备信息。Dfu模式时选择设备信息如图3所示。Auto dfu和 Hid dfu模式时填写设备信息如图4所示。
图 3 选择USB设备
图 4 填写usb设备信息
在BurnTool界面中单击“Select file”按钮，选择产品编译生成的固件包，并单击“打开”。
在表格中选中需要烧写的文件。
单击“Start burn”按钮（单击后“Start burn”变为“Stop burn”）。
等待传输完成后结束烧写，烧写完成会出现“All images burn successfully”。烧写完成效果如图5所示。
图 5 烧写完成示意图
警告：
在打印“All images burn successfully”之前请一定不要断电，否则单板将有概率异常。
JLIINK烧写¶
参考“选择Chip”章节选择带Jlink后缀的芯片，如“XXX-Jlink”。
在BurnTool界面中单击“Select file”按钮，选择产品编译生成的固件包，并单击“打开”。
在表格中选中需要烧写的文件。
单击“Start burn”按钮（单击后“Start burn”变为“Stop burn”）。
等待传输完成后结束烧写，烧写完成会出现“All images burn successfully”。烧写完成效果如图1所示。
图 1 烧写完成示意图
TCP烧写¶
在BurnTool界面中单击“Select file”按钮，选择各产品编译生成的固件包，并单击“OK”。
在表格中选中需要烧写的文件（请参考各产品文档中关于烧写的部分）。
配置串口服务器的ip地址和端口，并单击“Connect”按钮（单击后“Connect”变为“Disconnect”），复位单板。打断后效果如图1所示。
图 1 打断效果示意图
当界面显示字符串“CCC”时，单击“Send file”按钮。不同产品“CCC”上方的字符串可能不同。
等待传输完成后结束烧写，烧写完成会出现“All images burn successfully”。烧写完成效果如图2所示。
图 2 烧写完成示意图
USB烧写¶
在BurnTool界面中正确填写USB设备的Vid和Pid信息，单击“Select file”按钮，如图1所示，选择各产品编译生成的固件包，并单击“打开”。
图 1 单击“Select file”按钮
在表格中选中需要烧写的文件（请参考各产品文档中关于烧写的部分），如图2所示。
图 2 烧写文件表格
单击“Start burn”按钮，待日志窗口出现“Reset the device...”如图 等待单板复位所示，此时按下单板的复位键。工具等待单板复位超时默认为10s，如果超时时间内未检测到单板复位日志窗口会打印“Driver may not be installed. Open the device manager to confirm.No DFU capable USB device available.”，如图 检测单板复位超时所示。
图 3 等待单板复位
图 4 检测单板复位超时
等待传输完成后结束烧写，烧写完成会出现“All images burnt successfully”。烧写完成效果如图 烧写完成示意图所示。
图 5 烧写完成示意图
工厂烧写¶
在BurnTool界面中单击“Select file”按钮，选择各产品编译生成的固件包，并单击“OK”。
在表格中选中需要烧写的文件。
选择“Setting”→“Settings”，配置串口参数，默认配置如图1所示。
图 1 串口设置示例
说明：
Total num在研发测试中最大已压测个数为20，实际烧录最大个数上限理论不限制，一般与电脑性能、夹具、接线稳定性有关。单击“Multiple burn”按钮，打开工厂烧写窗口，若已有配置会自动读取。若无配置手动选择串口后，可以选择“Setting”→“Save config”生成配置。
单击“Connect all”按钮，并复位所有单板。
等待所有回显视图都显示绿色“PASS”或红色“Fail”。
工厂烧写-金版校准和机械臂设置¶
在BurnTool界面中单击“Select file”按钮，选择各产品编译生成的固件包，并单击“OK”。
在表格中选中需要烧写的文件。
选择“Setting”→“Settings”，配置串口参数，默认配置如图1所示。
图 1 串口设置示例
说明：
Total num在研发测试中最大已压测个数为20，实际烧录最大个数上限理论不限制，一般与电脑性能、夹具、接线稳定性有关。单击“Multiple burn”按钮，打开工厂烧写窗口，若已有配置会自动读取。若无配置手动选择串口后，可以选择“Setting”→“Save config”生成配置。
可选步骤，如果需要使用串口检查功能，选择“Setting”，点击“Check COM”, 工具会根据单板返回的位置信息，把单板对应的串口排到界面对应位置，
注意该功能需单板镜像支持。
可选步骤，如果需要使用机械臂串口功能，选择“Setting”，点击“Robotic Arm Com Setting”,在弹出的界面配置串口信息，配置后烧写单板后，
会向选择的串口发送成功和失败信息。
图 2 机械臂串口设置界面
单击“Connect all”按钮，并复位所有单板。
等待所有回显视图都显示绿色“PASS”或红色“Fail”。
命令行烧写¶
串口烧写¶
在Windows环境下，BurnTool.exe支持以命令行的方式调用，可用于集成到用户已有的工厂产线烧写程序中，调用命令如下：
BurnTool.exe params
命令之间用空格隔开，如果命令带有参数，命令与参数之间用冒号隔开，最简示例如下：
BurnTool.exe -com:1 -bin:C:\test_bin\xxx.fwpkg -signalbaud:921600
BurnTool.exe烧写命令可以配置的params参数如表1所示。
表 1 BurnTool.exe烧写命令参数表
命令 |
参数 |
说明 |
|---|---|---|
-com: |
x |
PC端的串口号（例如：1）。 |
-bin: |
path\xxx.bin |
固件包xxx.bin的绝对路径。固件包的名称和文件类型根据各产品实际情况可能有所不同。（路径不能存在空格字符） |
-signalbaud: |
115200 |
RomBoot下传输固件包时的串口波特率，默认为115200bit/s。建议根据硬件支持情况，配置成921600bit/s或更高波特率，以提升烧写效率。 |
-burninterval: |
x |
使用xms间隔发送打断报文，常用于快速启动场景。不包含此参数时，间隔则为10ms。 |
-forceread: |
10 |
包含此参数表示打开串口定时读功能，读数据间隔为10ms。 一般无需打开，在如下场景可考虑打开：
|
-erasemode: |
x |
擦除模式。其中：
|
-timeout: |
x |
打断的超时时间，单位ms。 |
-console |
无 |
使用标准输入输出，为重定向做准备。 |
-clearlog |
无 |
屏蔽单板打印的日志。 |
-onlyeraseall |
无 |
仅进行全片擦除 |
-onlyburn: |
name |
指定烧写对应名字的文件，可重复传参，效果累加。 |
-reset |
无 |
烧写完成后自动重启设备。 |
-packagesize: |
x |
每次传输的包大小，当前支持1024，2048，4096，8192 |
-switchafterloader |
无 |
在加载loader完成后再切换波特率。 |
其他典型场景
如果需要使用标准输入输出获取烧写过程的打印，命令如下：
BurnTool.exe -com:1 -bin:C:\test_bin\xxx.fwpkg -signalbaud:921600 -console如果需要指定烧写一个烧录包中的其中两个bin文件，命令如下：
BurnTool.exe -com:1 -bin:C:\test_bin\xxx.fwpkg -signalbaud:921600 -onlyburn:a.bin -onlyburn:b.bin如果需要使用全片擦除且烧写完之后自动复位单板，命令如下：
BurnTool.exe -com:1 -bin:C:\test_bin\xxx.fwpkg -signalbaud:921600 -erasemode:1 -reset
3x协议烧写¶
BurnTool.exe支持不打开界面，直接通过命令行进行参数设置与工具启动调度并烧写，可用于集成到用户已有的工厂产线烧写程序中，调用命令如下：
BurnTool.exe params
命令之间用空格隔开，如果命令带有参数，命令与参数之间用冒号隔开，最简示例如下：
BurnTool.exe -com:1 -bin:C:\test_bin\xxx.fwpkg -signalbaud:115200 -3x
BurnTool.exe烧写命令可以配置的params参数如表1所示
表 1 BurnTool.exe烧写命令参数表
命令 |
参数 |
说明 |
|---|---|---|
-com: |
x |
PC端的串口号。 说明：
参数为10进制数字。 |
-bin: |
path\xxx.fwpkg |
固件包xxx.fwpkg的绝对路径。固件包的名称和文件类型根据各产品实际情况可能有所不同。 说明：
路径不能包含空格字符。 |
-signalbaud: |
115200 |
传输固件包时的串口波特率，默认为115200bit/s。 说明：
参数为10进制数字。 建议根据产品形态，硬件支持情况，实际使用情况设置合适的波特率。 |
-3x |
无 |
按照3x协议烧写。选择3x则不能选择dfu。 |
-console |
无 |
使用标准输入输出，为重定向做准备。 |
-timeout: |
30000 |
烧写ssb文件握手超时时间，默认为30000ms。 说明：
参数为10进制数字，单位：ms。 |
其他典型场景
如果需要使用标准输入输出获取烧写过程的打印，命令如下：
BurnTool.exe -3x -com:1 -bin:C:\test_bin\xxx.fwpkg -signalbaud:115200 -console
DFU烧写¶
BurnTool.exe支持不打开界面，直接通过命令行进行参数设置与工具启动调度并烧写，可用于集成到用户已有的工厂产线烧写程序中。需在管理员权限下执行命令。调用命令如下：
BurnTool.exe params
使用C++代码管理员权限调用示例如下：
#include <windows.h>
int main(int argc, char *argv[])
{
char cmd[] = "D:\\BurnTool\\BurnTool.exe";
ShellExecuteA(NULL, "runas", cmd, "-dfu -vid:0x01 -pid:0x01 -usage:0x01 -usagepage:0x01 -bin:C:\test_bin\xxx.fwpkg -console", NULL, SW_NORMAL);
return 0;
}
命令之间用空格隔开，如果命令带有参数，命令与参数之间用冒号隔开，最简示例如下：
BurnTool.exe -dfu -pid:0x01 -vid:0x01 -usage:0x01 -usagepage:0x01 -bin:C:\test_bin\xxx.fwpkg
BurnTool.exe dfu模式烧写命令可以配置的params参数如表1所示
表 1 BurnTool.exe dfu模式烧写命令参数表
命令 |
参数 |
说明 |
|---|---|---|
-dfu |
- |
hid状态下dfu烧写模式。和-autodfu，-hiddfu互斥。 |
-autodfu |
- |
dfu状态下直接烧写模式。和-dfu, -hiddfu互斥。 |
-hiddfu |
- |
hid状态下直接进行usb烧写。和-autodfu，-dfu互斥。 |
-bin: |
path\xxx.fwpkg |
固件包xxx.fwpkg的绝对路径。固件包的名称和文件类型根据各产品实际情况可能有所不同。 说明：
路径不能包含空格字符。 |
-pid: |
0x... |
待烧写设备的pid。 说明：
参数为16进制数字。 |
-vid： |
0x... |
待烧写设备的vid。 说明：
参数为16进制数字。 |
-usage: |
0x... |
待烧写设备的usage。 说明：
参数为16进制数字。 |
-usagepage: |
0x... |
待烧写设备的usagepage。 说明：
参数为16进制数字。 |
-console |
无 |
使用标准输入输出，为重定向做准备。 |
其他典型场景
如果需要使用标准输入输出获取烧写过程的打印，命令如下：
BurnTool.exe -dfu -pid:0x01 -vid:0x01 -usage:0x01 -usagepage:0x01 -bin:C:\test_bin\xxx.fwpkg -console
TCP 烧写¶
在Windows环境下，BurnTool.exe支持以命令行的方式调用，可用于集成到用户已有的工厂产线烧写程序中，调用命令如下：
BurnTool.exe params
命令之间用空格隔开，如果命令带有参数，命令与参数之间用冒号隔开，最简示例如下：
BurnTool.exe -ipaddr:0.0.0.0 -ipport:10001 -bin:C:\test_bin\xxx.fwpkg
部分params参数如表1所示，其余参数配置同串口烧写说明，不再赘述。
表 1 BurnTool.exe烧写命令参数表
命令 |
参数 |
说明 |
|---|---|---|
-ipaddr: |
0.0.0.0 |
串口服务器的ip地址 |
-ipport: |
10001 |
串口服务器的端口 |
USB烧写¶
在Windows环境下，BurnTool.exe支持以命令行的方式调用，可用于集成到用户已有的工厂产线烧写程序中，调用命令如下：
BurnTool.exe params
命令之间用空格隔开，如果命令带有参数，命令与参数之间用冒号隔开，最简示例如下：
BurnTool.exe -chiptype:4GCAT1-USB -autodfu -usblocation:xxxx -pid:0xxxxx -vid:0xxxxx -bin:xxx.fwpkg
BurnTool.exe烧写命令可以配置的params参数如表 BurnTool.exe烧写命令参数表所示。
表 1 BurnTool.exe烧写命令参数表
命令 |
参数 |
说明 |
|---|---|---|
-chiptype:（必选） |
xxxx |
芯片类型。 |
-autodfu（必选） |
无 |
USB烧写模式。 |
-pid:（必选） |
xxxx |
USB设备的PID（16进制格式）。 |
-devicepathid: |
xxxx |
USB设备实例路径。 |
-usblocation:（必选） |
xxxx |
USB设备位置信息。（例如：Port_#0011.Hub_#0001） |
-vid:（必选） |
xxxx |
USB设备的VID（16进制格式）。 |
-bin:（必选） |
path\xxx.fwpkg |
固件包xxx.bin的绝对路径。固件包的名称和文件类型根据各产品实际情况可能有所不同。 |
-erasemode: |
x |
擦除模式。其中：
|
-console |
无 |
使用标准输入输出，为重定向做准备。 |
读eFuse¶
导出镜像¶
导出镜像-3x¶
Flash导出
命令行导出¶
BurnTool.exe支持不打开界面，直接通过命令行进行Flash导出操作，调用命令如下：
BurnTool.exe params
命令之间用空格隔开，如果命令带有参数，命令与参数之间用冒号隔开，最简示例如下：
BurnTool.exe -export -com:1 -signalbaud:115200 -bin:C:\test_bin\xxx.fwpkg -target:C:\test_bin\xxx.bin -addr:0x... -size:0x...
BurnTool.exe Flash导出命令可以配置的params参数如表1所示。
表 1 BurnTool.exe flash导出命令参数表
命令 |
参数 |
说明 |
|---|---|---|
-export |
无 |
Flash导出操作。 |
-bin: |
path\xxx.bin |
固件包xxx.bin的绝对路径。固件包的名称和文件类型根据各产品实际情况可能有所不同。需要烧写其中的loader文件（路径不能存在空格字符）。 |
-com: |
x |
PC端的串口号。 说明：
参数为10进制数字。 |
-signalbaud: |
115200 |
传输固件包时的串口波特率，默认为115200bit/s。 说明：
参数为10进制数字。 建议根据产品形态，硬件支持情况，实际使用情况设置合适的波特率。 |
-target: |
path\xxx.bin |
导出到本地路径。 |
-addr: |
0x.... |
导出Flash地址。 说明：
带有0x为16进制输入，不带0x为10进制输入。 |
-size: |
0x.... |
导出Flash大小。 说明：
带有0x为16进制输入，不带0x为10进制输入。 |
-console |
无 |
使用标准输入输出，为重定向做准备。 |
-onlyburn: |
name |
指定烧写对应名字的文件，可重复传参，效果累加。 |
其他典型场景
如果需要使用标准输入输出获取烧写过程的打印，命令如下：
BurnTool.exe -export -com:1 -signalbaud:115200 -bin:C:\test_bin\xxx.fwpkg -target:C:\test_bin\xxx.bin -addr:0x... -size:0x... -console
命令行导出-3x¶
BurnTool.exe支持不打开界面，直接通过命令行进行Flash导出操作，调用命令如下：
BurnTool.exe params
命令之间用空格隔开，如果命令带有参数，命令与参数之间用冒号隔开，最简示例如下：
BurnTool.exe -export -3x -com:1 -signalbaud:115200 -target:C:\test_bin\xxx.bin -addr:0x... -size:0x...
BurnTool.exe Flash导出命令可以配置的params参数如表1所示。
表 1 BurnTool.exe flash导出命令参数表
命令 |
参数 |
说明 |
|---|---|---|
-export |
无 |
Flash导出操作。 |
-3x |
无 |
按照3x协议导出镜像。 |
-com: |
x |
PC端的串口号。 说明：
参数为10进制数字。 |
-signalbaud: |
115200 |
传输固件包时的串口波特率，默认为115200bit/s。 说明：
参数为10进制数字。 建议根据产品形态，硬件支持情况，实际使用情况设置合适的波特率。 |
-target: |
path\xxx.bin |
导出到本地路径。 |
-addr: |
0x.... |
导出Flash地址。 说明：
带有0x为16进制输入，不带0x为10进制输入。 |
-size: |
0x.... |
导出Flash大小。 说明：
带有0x为16进制输入，不带0x为10进制输入。 |
-console |
无 |
使用标准输入输出，为重定向做准备。 |
其他典型场景
如果需要使用标准输入输出获取烧写过程的打印，命令如下：
BurnTool.exe -export -3x -com:1 -signalbaud:115200 -target:C:\test_bin\xxx.bin -addr:0x... -size:0x... -console
组播升级¶
开始升级¶
参考“选择Chip”章节选择带UPGRADE后缀的芯片，如“XXX-UPGRADE”。
选择需要升级的网卡。
选择升级文件。
勾选表格中需要升级的内。
点击“Start”按钮，开始升级。“start”、“Stop”和进度条变化如图1所示。
图 1 正在升级时界面
停止升级¶
进行“开始升级”操作。
升级过程中点击“Stop”按钮，停止升级。“start”和“Stop”按钮状态如图1所示。
图 1 按钮状态示意图
OTA升级¶
参考“选择Chip”章节选择带SLE后缀的芯片，如“XXX-SLE”。
选择设备信息如图1所示。
图 1 选择设备信息示意图
点击“Open”按钮，打开所选设备，并将扫描到的对端设备地址加载到Address中。
选择想要升级的地址，点击“Connect”连接设备，打印出"Device connected successfully"代表连接成功，如图2所示。
图 2 连接成功示意图
选择所升级的文件，如图3所示。
图 3 选择文件示意图
点击“Start”开始升级，“Start”按钮变更为“Stop”按钮（点击“Stop”按钮可停止升级），升级成功打印“Upgrade successfully”。如图4所示
图 4 升级成功示意图
TFTP烧写¶
LUOFU、EMEI、XILING和TG0¶
请参见“选择Chip”章节选择正确的芯片。
在BurnTool界面的COM处选择串口，如图1所示。
图 1 选择串口
选择使用的PC的IP地址，如图2所示。
图 2 选择PC的IP地址
单击“IP Config”按钮配置板端IP信息，配置项如图3所示。
图 3 板端IP配置项
单击“Erase config”配置擦除项，不同的产品有不同的配置项，如图4所示。
图 4 擦除项配置
选择是否勾选Empty flash，勾选为裸烧模式，去勾选为非裸烧模式。
在BurnTool界面中单击“...”按钮，选择产品编译生成的固件包，并单击“打开”，如图5所示。
图 5 选择文件界面
在表格中选中需要烧写的文件，点击“Start”开始烧写（点击后有可能需要手动重启）。
等待传输完成后结束烧写，烧写完成会出现“All images burn successfully”。烧写完成效果如图6所示。
图 6 烧写完成示意图
TG1和TG2¶
请参见“选择Chip”章节选择正确的芯片。
选择bootloader烧写方式，选择Serial执行4，选择USB执行3。
图 1 bootloader烧写方式
填写设备的Vid和Pid，如图2所示。
图 2 Vid、Pid填写区
在BurnTool界面的com处选择串口，如图3所示。
图 3 选择串口
选择使用的PC的IP地址，如图4所示。
图 4 选择PC的IP地址
单击“IP Config”按钮配置板端IP信息，配置项如图5所示。
图 5 板端IP配置项
单击“Erase config”配置擦除项，不同的产品有不同的配置项，如图6所示。
图 6 擦除项配置
选择是否勾选Empty flash。勾选为裸烧模式，去勾选为非裸烧模式。
在BurnTool界面中单击“...”按钮，选择产品编译生成的固件包，并单击“打开”。如图7所示。
图 7 选择文件界面
在表格中选中需要烧写的文件，点击“Start”开始烧写（点击后有可能需要手动重启）。
等待传输完成后结束烧写，烧写完成会出现“All images burn successfully”，烧写完成效果如图8所示。
图 8 烧写完成示意图
MCU¶
烧写¶
擦除¶
请参见“选择Chip”章节选择MCU。
选择芯片、传输方式。
在参数区设置对应传输方式的参数，点击“Connect”进行连接（连接时除SWD和JTAG方式外都需要重启单板，需要重启单板时会给出如图1所示的提示）。
图 1 需重启单板提示
设置擦除的起始位置和大小。
单击“Erase”按钮开始擦除。
等待擦除完成会出现“Erase successfully”。擦除完成效果如图2所示。
图 2 烧写完成示意图
全部擦除¶
请参见“选择Chip”章节选择MCU。
选择芯片、传输方式。
在参数区设置对应传输方式的参数，点击“Connect”进行连接（连接时除SWD和JTAG方式外都需要重启单板，需要重启单板时会给出如图1所示的提示）。
图 1 需重启单板提示
单击“EraseAll”按钮开始全部擦除。
等待擦除完成会出现“Erase successfully”。擦除完成效果如图2所示。
图 2 烧写完成示意图
导出¶
请参见“选择Chip”章节选择MCU。
选择芯片、传输方式。
在参数区设置对应传输方式的参数，点击“Connect”进行连接（连接时除SWD和JTAG方式外都需要重启单板，需要重启单板时会给出如图1所示的提示）。
图 1 需重启单板提示
单击“Select file”按钮，填写导出文件的保存位置，并设置导出的起始位置和大小。
单击“Export”按钮开始导出。
等待传输完成后结束烧写，烧写完成会出现“Read successfully”。烧写完成效果如图2所示。
图 2 烧写完成示意图
全部擦除¶
fwpkg生成及拆分¶
点击导入fwpkg文件。
图 1 导入fwpkg文件
编辑分区数据，Type可以直接编辑，点击+，-可以添加和删除分区，双击分区所在行的path列，可以更新该分区的bin文件，
之后可以编辑该行的烧写地址和烧写长度。
右击分区表，会弹出一个菜单栏，点击“Create new file”,可以生成编辑后的新fwpkg文件。点击"Create new file”，
可以保存每个分区的bin文件到选择的目录下，没有显示在界面上的分区文件也会保存。
FAQ¶
工具未进入打断状态¶
问题描述
单击连接、断电重启后，工具并没有进入打断状态。
解决办法
可能是串口选择错误或没有正常连接串口，请检查串口配置。
可能单板设置了1ms快速启动，需要在BurnTool“Setting”→“Burn interval”中选择2ms间隔。
可能使用win7系统产生部分兼容性问题，可切换至win10尝试。
如何获取符合格式的固件包¶
问题描述
如何获取BurnTool可识别的固件包。
解决办法
请参见各产品关于编译或固件生成的文档。
加载配置文件时出现错误提示¶
问题描述
在启动BurnTool后，如果同级目录或C盘BurnTool路径下有配置文件，则会提示“是否加载已存在的配置文件？”；如果选择加载配置文件且配置文件格式不正确，则会提示“文件格式错误，是否继续”。
解决办法
提示“文件格式错误，是否继续”表示当前的配置文件中有部分内容没有配置或配置值不符合预期，造成此问题的原因可能是由于手动修改过配置文件或当前版本没有主动保存过配置文件。此时可以选择不加载配置文件，全部重新手工配置并保存配置文件。
工厂烧写时随机串口无法进入doing状态¶
问题描述
因串口驱动配合问题，在工厂烧写时，可能会出现随机串口无法进入工作（doing）状态的情况。
解决办法
在“Setting”→“Settings”中查看“Reopen Com Everytime”的勾选状态。
如果未勾选，则尝试勾选并重新开始工厂烧写；如果已勾选，则尝试取消勾选并重新开始工厂烧写。
如何提升镜像烧录速度¶
问题描述
产线上烧录大镜像所需时间过长，导致生产成本增加。
解决办法
将烧写工具波特率设置为所能支持的最大值（目前单板所支持最大值为6M波特率，需串口小板支持6M及以上波特率）。
将每包大小设置为20480。如图1所示。
图 1 烧写工具配置示意图
按照“手动烧写”章节步骤进行烧写即可。
一拖多烧写时反复烧写该如何解决¶
问题描述
一拖多烧写时，每次烧写完成会重新开始烧写，具体表现为在没有进行手动复位的情况下，进度条达到100%后又从0%开始烧录。
解决办法
将设置中的“Reset after success”去勾选。
全擦功能异常¶
问题描述
点击“Erase all”后，未擦除成功或单板死机或有其他异常打印。
解决办法
Sparta 1.1.10.600之前版本不支持全擦功能，单板需烧写到Sparta 1.1.10.600及之后版本再执行全擦。
USB或SLE烧写时无法找到目标设备¶
问题描述
在USB或SLE烧写时，设备下拉列表中找不到名为HH6666（名称是代码决定）的设备中usage page为0xffb2（usage page是代码决定）的设备，但设备管理器中能看到HH6666设备。
解决办法
设备管理器中是否有HH6666，如果有就右键点击卸载设备，并勾选删除驱动，然后点击确定。如果没有则检查连线。
如何使用BurnTool读取Flash¶
问题描述
如何使用BurnTool进行读取Flash。
解决办法
BurnTool配置如下。
**参数说明：**图片中第7步的地址，为从0开始的地址，我们代码中使用的地址是在该基础上加上了偏移0x200000。
开始读取Flash。
如何使用BurnTool进行固件全擦¶
问题描述
如何使用BurnTool进行固件全擦。
解决方法
按照下图步骤依次操作即可。
