命令行

通用参数适用于所有需连接设备的命令，不包括无需与设备通信的本地命令，如help、merge、generate和device等。这些参数主要包括连接参数和芯片类型等。

执行外部Flash操作命令（writeFlash、updateFlash、 readFlash、eraseFlash）时，需要额外配置外部Flash参数。

• 命令名称：help
• 命令描述：列出命令，并展示命令的使用方法。
• 参数说明：

  表 11 help命令参数描述

  参数名称	参数说明
  命令名称	help不跟任何参数，列出所有命令。 help后跟某条命令名称，可查看命令的描述、参数及使用方法等。

• 命令示例：
  1. 列出所有命令。

     help

  2. 查看program命令的描述和使用方法。

     help program

• 命令名称：generate
• 命令描述：将开发编译的Bin/Hex文件生成可烧录的Bin固件。
• 参数说明：

  表 12 generate命令参数描述

  参数名称	参数说明
  --chip	指定芯片类型，如GR5515、GR5525、 GR5332、 GR5405等
  --input	开发编译的Bin或Hex文件
  --output	生成的可烧录的二进制固件

• 命令示例：

  将开发编译的Bin文件app_bootloader.bin生成可烧录的固件app_bootloader_fw.bin。

  generate --chip gr5525 --input app_bootloader.bin --output app_bootloader_fw.bin

• 命令名称：merge
• 命令描述：将多个子固件打包合并成一个固件，以便一次性烧录。
  说明：

  目前，merge命令合并的固件仅支持使用program命令进行烧录，无法通过GProgrammer界面工具烧录。

• 参数说明：

  表 13 merge命令参数描述

  参数名称	参数说明
  --files	指定待合并的非启动固件，多个文件之间用空格分开 。
  --boot	指定一个启动固件。合并固件时，通常需要指定一个固件程序为启动固件。
  --out	合并后的二进制固件的保存路径。

• 命令示例：

  合并1个应用固件和1个启动固件。

  merge --files ble_app_template_dfu_fw.bin --boot ble_dfu_boot_fw.bin --out out.bin

• 命令名称：lockFlash
• 命令描述：对内部Flash进行解锁和上锁。
• 参数说明：

  表 14 lockFlash命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。 说明： 仅UART通信方式下支持此命令。
  --mode	0：解锁 1：解锁并擦除Flash 2：上锁

• 命令示例：

  解锁GR5405 Flash。

  lockFlash --chip gr5405 --mode 0 --uart COM30

• 命令名称：reset
• 命令描述：复位设备。
• 参数说明：

  表 15 reset命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。

• 命令示例：

  复位设备。

  reset --chip gr5332 --jlink 0

• 命令名称：program
• 命令描述：烧录固件至目标设备的内部Flash。
• 参数说明：

  表 16 program命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  --file	指定待烧录固件的文件路径。 待烧录固件可以是单个固件，也可以是由merge命令生成的合成固件。
  --run	固件烧录完成后是否立即运行程序。 true：立即执行 false：不处理
  --erase	固件烧录前是否擦除Flash 。 0：不擦除 1：擦除整个Flash 2：擦除BootInfo

• 命令示例：
  1. 烧录固件app_bootloader_fw.bin，且烧录前先擦除整个Flash，烧录完成后立即运行程序。

     program --jlink 0 --chip GR5405 --file app_bootloader_fw.bin --erase 1 --run 1

  2. 生成可烧录固件并烧录。

     generate --chip GR5405 --input app_bootloader.bin --output app_bootloader_fw.bin
     program --uart COM10 --chip GR5405 --file app_bootloader_fw.bin --erase 1 --run 1
     

  3. 合并固件并烧录。

     merge --files ble_app_template_dfu_fw.bin --boot ble_dfu_boot_fw.bin --out out.bin
     program --uart COM10 --chip GR5405 --file out.bin --erase 1 --run 1
     

• 命令名称：writeFlash
• 命令描述：写入数据至Flash。
• 参数说明：

  表 17 writeFlash命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  外部Flash配置参数（可选）	当flashType选择外部Flash时，需要输入外部Flash配置参数，具体参考外部Flash配置参数章节。
  --flashType（可选）	Flash 类型 0 ：内部Flash（默认） 1 ：外部Flash
  --flashSize（推荐）	Flash容量大小，单位为Kbytes。
  --file	文件数据，参数名后跟文件路径。
  --hex	Hex数据，参数名后跟Hex字符串。
  --address	待写入数据的目标地址（16进制）
  --force	如果数据写入地址与当前NVDS、BOOT_INFO 或IMAGE地址冲突，是否强制写入。 true：强制写入 false：不执行写入操作

• 命令示例：
  1. 写入文件数据至内部Flash指定地址。

     writeFlash --chip GR5525 --file bootloader.bin --address 0x00210000 --force false --uart COM32

  2. 写入Hex数据至内部Flash指定地址。

     writeFlash --chip GR5405 --hex 0x11223344 --address 0x00210000 --force true --jlink 0

• 命令名称：updateFlash
• 命令描述：更新Flash数据。
• 参数说明：

  表 18 updateFlash命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  外部Flash配置参数（可选）	当flashType选择外部Flash时，需要输入外部Flash配置参数，具体参考外部Flash配置参数章节。
  --flashType（可选）	Flash 类型 0 ：内部Flash（默认） 1 ：外部Flash
  --flashSize（推荐）	Flash容量大小，单位为Kbytes。
  --file	文件数据，参数名后跟文件路径。
  --hex	Hex数据，参数名后跟Hex字符串。
  --address	待更新数据的目标地址（16进制）

• 命令示例：
  1. 更新文件数据至内部Flash指定地址 。

     updateFlash --chip GR5405 --file save.bin --address 0x00210000 --jlink 0

  2. 更新Hex数据至内部Flash指定地址。

     updateFlash --chip GR5405 --hex 0x11223344 --address 0x00210000 --force true --jlink 0

• 命令名称：readFlash
• 命令描述：从Flash指定地址读取数据 。
• 参数说明：

  表 19 readFlash命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  外部Flash配置参数（可选）	当flashType选择外部Flash时，需要输入外部Flash配置参数，具体参考外部Flash配置参数章节。
  --flashType（可选）	Flash 类型 0 ：内部Flash（默认） 1 ：外部Flash
  --flashSize（推荐）	Flash容量大小，单位为Kbytes。
  --save	保存读取的数据至文件。若未输入此参数，则将在终端以Hex格式显示前1K数据。
  --address	待读取数据的目标地址
  --size	读取的数据大小，单位为字节。

• 命令示例：

  从内部Flash指定地址读取数据，并将数据保存到文件。

  readFlash --chip GR5515 --address 0x01070000 --size 10240 --save save.bin --uart COM32

• 命令名称：eraseFlash
• 命令描述：擦除Flash。
• 参数说明：

  表 20 eraseFlash命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  外部Flash配置参数（可选）	当flashType选择外部Flash时，需要输入外部Flash配置参数，具体参考外部Flash配置参数章节。
  --flashType（可选）	Flash 类型 0 ：内部Flash（默认） 1 ：外部Flash
  --flashSize（推荐）	Flash容量大小，单位为Kbytes。
  --start	待擦除Flash区域的起始地址（16进制）。实际擦除操作将从该地址所在的Sector开始执行 。
  --end	待擦除Flash区域的结束地址（16进制）。实际擦除操作将执行到该地址所在的Sector结束。
  --force	进行非全片擦除时，若擦除地址与当前NVDS、BOOT_INFO 或IMAGE地址冲突，是否强制擦除。 true：强制擦除 false：不执行擦除操作

• 命令示例：
  1. 全片擦除内部Flash 。

     eraseFlash --all true --chip GR5332 --uart COM77

  2. 擦除内部Flash指定区域。

     eraseFlash --start 0x00210000 --end 0x00212000 --chip GR5405 --jlink 0

• 命令名称：writeNvds
• 命令描述：写入数据至NVDS。
• 参数说明：

  表 21 writeNvds命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  --address	NVDS起始地址（16进制）
  --sectors	NVDS Sector总数目，等于NVDS容量除以4K。
  --tag	待写入数据的目标Tag。
  --hex	以Hex字符串方式输入待写入的数据。

• 命令示例：

  写入数据至NVDS。

  writeNvds --address 0x00270000  --sectors 1 --tag C001 --hex 0123456789BB --jlink 0 --chip GR5332

• 命令名称：readNvds
• 命令描述：从NVDS 指定Tag读取数据。
• 参数说明：

  表 22 readNvds命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  --address	NVDS起始地址（16进制）
  --sectors	NVDS Sector总数目，等于NVDS容量除以4K。
  --tag	待读取数据的目标Tag。
  --save（可选）	保存读取的数据至文件。若未输入此参数，则以Hex格式显示前1K数据至终端。

• 命令示例：

  从NVDS指定Tag读取数据。

  readNvds --address 0x00270000  --sectors 1 --tag C001 --chip GR5332 --jlink 0

• 命令名称：eraseNvds
• 命令描述：删除NVDS 指定TAG数据。
• 参数说明：

  表 23 eraseNvds命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  --address	NVDS起始地址（16进制）
  --sectors	NVDS Sector总数目，等于NVDS容量除以4K。
  --tag	待删除数据的目标Tag。

• 命令示例：

  删除NVDS 指定TAG数据。

  eraseNvds --address 0x00270000  --sectors 1 --tag C001 --chip GR5332 --jlink 0

• 命令名称：writeEfuse
• 命令描述：写入数据至eFuse的User Region区域（地址范围为0x00 ～ 0x1F） 。
  说明：

  该命令仅适用于GR551x、GR5525、GR5526系列芯片。

• 参数说明：

  表 24 writeEfuse命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  --offset	待写入数据的目标偏移地址（0x00 ～ 0x1C），需以4字节对齐。
  --file	文件数据，参数名后跟文件路径，且文件大小需以4字节对齐。
  --hex	Hex数据，参数名后跟十六进制字符串，需以8个字符对齐。

• 命令示例：

  写入Hex数据至eFuse。

  writeEfuse --offset 0 --hex 12345678 --chip GR5525 --uart COM77

• 命令名称：readEfuse
• 命令描述：从eFuse读取数据。
• 参数说明：

  表 25 readEfuse命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  --offset	待读取数据的目标偏移地址，需以4字节对齐。
  --size	读取的数据长度（单位为字节），需以4字节对齐。
  --save（可选）	保存读取的数据至文件。若未输入此参数，则将数据以Hex格式输出到终端。

• 命令示例：

  从eFuse读取数据。

  readEfuse --offset 0 --size 32 --chip GR5332 --uart COM77

• 命令名称：writeOtp
• 命令描述：写入数据至OTP指定地址。
  说明：

  该命令仅适用于GR533x系列、GR5405芯片。

• 参数说明：

  表 26 writeOtp命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  --address	待写入数据的目标地址（16进制）
  --file	文件数据，参数名后跟文件路径。
  --hex	Hex数据，参数名后跟Hex字符串。

• 命令示例：

  写入数据至OTP。

  writeOtp --address 0x2008 --hex 12345678 --uart COM77 --chip GR5332

• 命令名称：readOtp
• 命令描述：从OTP指定地址读取数据。
  说明：

  该命令仅适用于GR533x系列、GR5405芯片。

• 参数说明：

  表 27 readOtp命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  --address	待读取数据的目标地址（16进制）
  --size	读取的数据长度，单位为字节。
  --save（可选）	保存读取的数据至文件。若未输入此参数，则将数据以Hex格式输出到终端。

• 命令示例：

  从OTP读取数据。

  readOtp --address 0x2008 --size 0x10 --uart COM77 --chip GR5332

• 命令名称：eraseOtp
• 命令描述：删除OTP指定地址数据。
  说明：

  该命令仅适用于GR533x系列、GR5405芯片。

• 参数说明：

  表 28 eraseOtp命令参数描述

  参数名称	参数说明
  通用参数	参考 通用参数。
  --address	待删除数据的目标地址（16进制）

• 命令示例：

  删除OTP数据。

  eraseOtp --address 0x2008 --uart COM77 --chip GR5332

• 命令名称：device
• 命令描述：展示设备列表。
• 参数说明：

  表 29 device命令参数描述

  参数名称	参数说明
  --type	展示的设备类型，包括： uart、jlink或all。其中，all表示同时展示uart和jlink设备列表。
  --count（可选）	展示的设备数目（不超过50），默认值为50

• 命令示例：
  1. 展示所有uart设备。

     device --type uart

  2. 展示所有jlink设备。

     device --type jlink

  3. 展示所有uart和jlink设备。

     device --type all