u-connectXpress bootloader, protocol specification

u-connectXpress

u-connectXpress bootloader, protocol specification - u-blox

18 juin 2019 — u-blox or third parties may hold intellectual property rights in the products, names, logos and designs included in this document.

u-connectXpress bootloader, protocol specification

UBX-17065404 - R04 C1-Public www.u-blox.com u-connectXpress Bootloader Protocol specification Abstract Description of standard and proprietary bootloader commands used with u-blox short range,

PDF Viewing Options

Not Your Device? Search For Manuals or Datasheets below:


File Info : application/pdf, 14 Pages, 251.74KB

Document DEVICE REPORTu-connectXpress-Bootloader ProtocolSpec UBX-17065404
u-connectXpress
Bootloader
Protocol specification
Abstract
Description of standard and proprietary bootloader commands used with u-blox short range, stand-alone modules.

UBX-17065404 - R04 C1-Public

www.u-blox.com

u-connectXpress Bootloader - Protocol specification

Document information

Title Subtitle Document type Document number Revision and date Disclosure restriction

u-connectXpress Bootloader Protocol specification UBX-17065404 R04 C1-Public

29-Nov-2021

This document applies to the following products:

Product name

Type number

ANNA-B112

All

ANNA-B412

All

NINA-B111

NINA-B111-03B-00 or later

NINA-B112

NINA-B112-03B-00 or later

NINA-B221

All

NINA-B222

All

NINA-B311

All

NINA-B312

All

NINA-B316

All

NINA-B410

All

NINA-B411

All

NINA-B416

All

NINA-W131

All

NINA-W132

All

NINA-W151

All

NINA-W152

All

NINA-W156

All

ODIN-W260

All

ODIN-W262

All

ODIN-W263

All

u-connectXpress software version All All 4.0.0 or later 4.0.0 or later All All All All All All All All All All All All 3.1.0 or later All All 7.1.0 or later

u-blox or third parties may hold intellectual property rights in the products, names, logos and designs included in this document. Copying, reproduction, modification or disclosure to third parties of this document or any part thereof is only permitted with the express written permission of u-blox. The information contained herein is provided "as is" and u-blox assumes no liability for its use. No warranty, either express or implied, is given, including but not limited to, with respect to the accuracy, correctness, reliability and fitness for a particular purpose of the information. This document may be revised by u-blox at any time without notice. For the most recent documents, visit www.u-blox.com. Copyright © u-blox AG.

UBX-17065404 - R04 C1-Public

Document information

Page 2 of 14

u-connectXpress Bootloader - Protocol specification
Contents
Document information ............................................................................................................................. 2 Contents ....................................................................................................................................................... 3 1 Introduction .......................................................................................................................................... 4 2 General commands ............................................................................................................................. 5
2.1 Help ................................................................................................................................................................ 5 2.2 Device information...................................................................................................................................... 5 2.3 Serial baud rate ........................................................................................................................................... 5 2.4 Reset module ............................................................................................................................................... 5 2.5 Dump flash memory ................................................................................................................................... 6 2.6 Erase flash memory.................................................................................................................................... 6 2.7 Boot image.................................................................................................................................................... 6 2.8 Download binary image.............................................................................................................................. 7 2.9 Version .......................................................................................................................................................... 7 3 Secure boot commands .................................................................................................................... 8 3.1 Boot image.................................................................................................................................................... 8 3.2 Download binary image.............................................................................................................................. 8 3.3 Store image signature ............................................................................................................................... 9 3.4 Set startup firmware.................................................................................................................................. 9 3.5 Dump hash of memory............................................................................................................................... 9 3.6 List all images .............................................................................................................................................. 9 4 Miscellaneous commands ............................................................................................................. 10 4.1 CRC check...................................................................................................................................................10 5 Software update examples ........................................................................................................... 11 5.1 ODIN-W2 .....................................................................................................................................................11 5.2 NINA-B1 and ANNA-B112 .......................................................................................................................11 5.3 ANNA-B412, NINA-B31, and NINA-B41 ...............................................................................................11 5.4 NINA-W13-SW1.0.0 .................................................................................................................................12 5.5 NINA-B2, NINA-W15, and NINA-W13 from v2.0.0 .............................................................................12 Related documents ................................................................................................................................ 13 Revision history ....................................................................................................................................... 13 Contact....................................................................................................................................................... 14

UBX-17065404 - R04 C1-Public

Contents

Page 3 of 14

u-connectXpress Bootloader - Protocol specification
1 Introduction
This document is the description of standard and proprietary bootloader commands used with u-blox short range stand-alone modules. The bootloader commands provide options to modify flash memory and update the firmware that is being executed. See also Software update examples.

UBX-17065404 - R04 C1-Public

Introduction

Page 4 of 14

u-connectXpress Bootloader - Protocol specification

2 General commands
All input and output parameters of the commands in this section are in HEX format.

2.1 Help

Command

Description

?

Opens the bootloader help menu and listing all supported commands.

Response

Description

<productname> bootloader <bootversion> u-blox All parameters in HEX format <availableoptions>

Successful response.

OK

2.2 Device information

Command I
Response UID: <MCU id> OK

Description Gets the unique identifier of the MCU. Description Successful response.

2.3 Serial baud rate

Command r <baudrate> Parameter baudrate
Response OK ERROR

Description Sets the baudrate of the serial port. Description Baudrate of the serial port UART in hexadecimal Acceptable values: 2580, 4B00, 9600, 1C200, 38400, 70800, E1000. Note: ODIN-W26 does not accept 0xE1000. Note: NINA-B1 Software version 4.0.0 and ANNA-B112 support only 1C200. Description Successful response. Error response.

2.4 Reset module

Command q Response
>

Description
Reset the module.
Description
Note: OK will NOT be obtained. Module will reset upon success. If no valid connectivity software is configured, a new bootloader prompt will be obtained. If a valid connectivity software is available, the bootloader will boot into that software.

UBX-17065404 - R04 C1-Public

General commands

Page 5 of 14

u-connectXpress Bootloader - Protocol specification

2.5 Dump flash memory

Command d <startaddress> <size>
Parameter startaddress size Response OK ERROR

Description Dump bytes of the flash memory from the start address. Note: All values of the different parameters used in this command are available in the configuration.json file as part of every software release. Description Start address of the flash area to be erased. Number of bytes to be dumped. Description Successful response. Error response.

2.6 Erase flash memory

Command e <startaddress> <size>
Parameter startaddress
size
Response OK ERROR

Description
Erase bytes of the flash memory from the start address. Note: All values of the different parameters used in this command are available in the configuration.json file as part of every software release.
Description
Start address of the flash area to be erased. Note: If startaddress is not a multiple of flash sector size, the entire flash page (in which this address lies in) will be erased.
Number of bytes to be erased. Note: if the startaddress + size is not a multiple of flash sector size, the entire flash page (in which this address lies) will be erased.
Description
Successful response.
Error response.

2.7 Boot image
Command b <imageaddress> Parameter imageaddress
Response ERROR

Description Executes (boots into) the binary image at the mentioned address. Description Start address of the binary image in the flash. Note: This information is usually available in the configuration.json file of every software release. Description Error response. Note: OK will NOT be obtained upon Success. If a valid connectivity software is available, the bootloader will boot into that software.

UBX-17065404 - R04 C1-Public

General commands

Page 6 of 14

u-connectXpress Bootloader - Protocol specification

2.8 Download binary image

Command x <imageaddress> Parameter imageaddress
Response CCCCCC.... OK ERROR

Description Downloads a binary image using x-modem protocols in the corresponding flash address. Description Start address of the binary image in the flash. Note: This information is usually available in the configuration.json file of every software release. Description Successful response.
Error response.

2.9 Version

 This command is supported by NINA-W13 bootloader from version 2.0.0, NINA-W15 bootloader
from version 2.0.0, NINA-B2 bootloader from version 2.0.0.

Command v Response <bootversion> OK
ERROR

Description Returns version of bootloader Description Successful response.
Command not supported. Use the Help command to obtain the information instead.

UBX-17065404 - R04 C1-Public

General commands

Page 7 of 14

u-connectXpress Bootloader - Protocol specification

3 Secure boot commands
These commands can be run only when the device has secure boot inbuilt in it. All input and output parameters of the commands in this section are in HEX format.
 These commands can NOT be executed in ODIN-W2, NINA-B1, and ANNA-B112.

3.1 Boot image
Command b <imageid> Parameter imageid
Response ERROR

Description
Executes (boots into) the binary image.
Description
Id of the secure binary image. This value can also be replaced with the start address of the secure binary image in the flash. Note: This information is usually available in the configuration.json file of every software release.
Description
Error response.
Note: OK will NOT be obtained upon Success. If a valid connectivity software is available, the bootloader will boot into that software.

3.2 Download binary image

Command

Description

x <imageaddress> <imagesize> Downloads a binary image using x-modem protocols in the corresponding flash address.

<imagename> <permissions> <imageid>

Note: All values of the different parameters used in this command are available in the configuration.json file as part of every software release.

Parameter

Description

imageaddress

Start address of the secure binary image in the flash.

imagesize

Size of the secure binary image in bytes.

imagename

Name of the binary image. Maximum length of the name is 22 characters.

permissions

Access permissions for the bootloader over this binary image: `r': Read `w': Write `x': Execute

imageid

Id of the secure binary image.

Response

Description

CCCCCCC.... OK

Successful response.

ERROR

Error response.

UBX-17065404 - R04 C1-Public

Secure boot commands

Page 8 of 14

u-connectXpress Bootloader - Protocol specification

3.3 Store image signature

Command s <imageid> <signature>
Parameter imageid signature Response OK ERROR

Description Store the secure binary image's signature in the bootloader. Note: All values of the different parameters used in this command are available in the configuration.json file as part of every software release. Description Id of the secure binary image. The base64 encoded signature string. Description Successful response. Error response.

3.4 Set startup firmware

Command f <imageid>
Parameter imageid Response OK ERROR

Description Stores a particular binary image as the startup image. Note: All values of the different parameters used in this command are available in the configuration.json file as part of every software release. Note: This command must be issued after the binary image has been downloaded. Description Id of the secure binary image. Description Successful response. Error response.

3.5 Dump hash of memory

Command h <startaddress> <size>
Parameter startaddress size Response OK ERROR

Description Calculates the SHA256 digest of the given flash region. Note: All values of the different parameters used in this command are available in the configuration.json file as a part of every software release. Description Start address of the flash area to be hashed. Number of bytes to be hashed. Description Successful response. Error response.

3.6 List all images

Command
l
Response
Image_id Image_name Image_addr ...... ..... OK

0 yyyyy
FFFFF

Description List all the secure binary images in the flash. Description Successful write response

UBX-17065404 - R04 C1-Public

Secure boot commands

Page 9 of 14

u-connectXpress Bootloader - Protocol specification

4 Miscellaneous commands

These commands are specific for certain devices and cannot be classified into any other category. All input and output parameters of the commands in this section are in HEX format.

4.1 CRC check

Command c <imagetype> <imagesize> <crc32value>
Parameter imagetype
imagesize crc32value Response OK ERROR

Description Performs a CRC32 check and a dual banked swap of the softdevice Note: This command is applicable only for NINA-B1 and ANNA-B112. Note: Values of the different parameters used in this command are available in the configuration.json file as part of every software release.
Description Type of the binary image. Acceptable values: SOFTDEVICE Note: This parameter is case sensitive. Size of the softdevice image in bytes. The Crc32 value of the softdevice binary image. Description Successful response. Error response.

UBX-17065404 - R04 C1-Public

Miscellaneous commands

Page 10 of 14

u-connectXpress Bootloader - Protocol specification

5 Software update examples
This section provides examples of how to update the firmware for u-blox modules. This section assumes that the modules are already in boot rescue mode. Check the System Integration Manual of the corresponding modules for instructions on how to enter the boot rescue mode. To execute the connectivity software from the boot rescue mode, use the boot command or reset the module.
 Change serial port baud rate to the highest permissible speeds using the Serial Baud Rate
command.
 Parameter values used here are examples. Check the configuration.json file in the software
release for actual values.
5.1 ODIN-W2
Use the x-modem command to update the firmware in the flash memory.
> x 8010000 CCCCCCC....... OK > b 8010000 +STARTUP
5.2 NINA-B1 and ANNA-B112
NINA-B1 and ANNA-B112 firmware updates involve a soft device update followed by a connectivity software update. Soft device updates are dual banked and need to pass a CRC check before the actual swap.
 A soft device update invalidates the connectivity software. So always update the connectivity
software after a soft device update.
> x 0 CCCCCCC....... OK > c SOFTDEVICE 22A48 7A9F9312 OK > x 23000 CCCCCCC...... OK > q +STARTUP
5.3 ANNA-B412, NINA-B31, and NINA-B41
ANNA-B412, NINA-B31 and NINA-B41 firmware updates involve a soft device update followed by a connectivity software update. Soft device updates are dual banked and need to pass the secure boot signature verification before the actual swap. Always input a signature for the binary image before starting its x-modem download.
 A soft device update invalidates the connectivity software. So always update the connectivity
software after a soft device update.
> s 1 l/IeYxT4HHrosE77FsLry6EUPqTXpazBkcmN7kwutBySTiXDL7IHKjtX2wzpUjyPCnF/g== OK > x 0 210F8 NINA-B3-SOFTDEVICE rw 1 CCCCCCC....... OK > s 0 z6V5hMPfsppfnaYqMTac604pnF++RvlcGT//UdHZsEe2JUj4+dqtq/g== OK > x 22000 4b8E4 NINA-B3-FIRMWARE rwx 0

UBX-17065404 - R04 C1-Public

Software update examples

Page 11 of 14

u-connectXpress Bootloader - Protocol specification
CCCCCCC...... OK > f 0 OK > q +STARTUP
The RAM can also be used to securely execute applications. (Production test software uses RAM). To use the RAM, go to boot mode using the buttons or AT+UFWUPD=1 command.
> s 0 l/IeYxT4HHrosE77FsLry6EUPqTXpazBkcmN7kwutBySTiXDL7IHKjtX2wzpUjyPCnF/g== OK > x 20028000 10F8 NINA-B3-PRODUCTION rwx 0 CCCCC...... OK > b 0
The module should have booted into the software at the given address (in this example 0x20028000).
5.4 NINA-W13-SW1.0.0
NINA-W13 connectivity software requires a few other binary images besides the actual software such as partition table. Use the x-modem command to flash it in. Always input a signature for the binary image before starting its x-modem download.
Once the firmware has been upgraded, this is no longer required.
> x 13000 CCCCCCC...... OK > s 0 p/pfnaYqMTac604pnF++Rvlcas342daGT//UdHZsEe2JUj4+dqtq/g== OK > x 20000 A6170 NINA-W1-FIRMWARE rwx 0 CCCCCCC...... OK > f 0 > b 20000 +STARTUP
5.5 NINA-B2, NINA-W15, and NINA-W13 from v2.0.0
Use the x-modem command to update the firmware in the flash memory. Always input a signature for the binary image before starting its x-modem download.
> s 0 p/pfnaYqMTac604pnF++Rvlcas342daGT//UdHZsEe2JUj4+dqtq/g== OK > x 20000 A6170 FIRMWARE rwx 0 CCCCCCC...... OK > f 0 > b 0 +STARTUP

UBX-17065404 - R04 C1-Public

Software update examples

Page 12 of 14

u-connectXpress Bootloader - Protocol specification
Related documents
[1] u-connectXpress AT commands manual, UBX-14044127 [2] ODIN-W2 system integration manual, UBX-14040040 [3] NINA-B1 system integration manual, UBX-15026175 [4] ANNA-B112 system integration manual, UBX-18009821 [5] NINA-W1 system integration manual, UBX- 17005730 [6] NINA-B3 system integration manual, UBX-17056748 [7] u-connectXpress user guide, UBX-16024251 [8] NINA-B2 system integration manual, UBX-18011096 [9] NINA-B4 system integration manual, UBX-19052230 [10] ANNA-B4 system integration manual, UBX-21000517
 For product change notifications and regular updates of u-blox documentation, register on our
website, www.u-blox.com.

Revision history

Revision R01 R02 R03
R04

Date 18-Jun-2019 19-Dec-2019 04-Feb-2021
22-Oct-2021

Name hvig, lhau, kgom lhau, mlju flun
hisa

Comments
Initial release. Update table on page 2 with ODIN-W263. Added chapter 2.9. Included NINA-B316, NINA-B41, NINA-W156. Clarified that the f command must be issued after the binary image has been downloaded for modules with secure boot. Renamed document. Included NINA-B411, ANNA-B412.

UBX-17065404 - R04 C1-Public

Related documents

Page 13 of 14

u-connectXpress Bootloader - Protocol specification

Contact

For complete contact information, visit us at www.u-blox.com.
u-blox Offices

North, Central and South America
u-blox America, Inc. Phone: +1 703 483 3180 E-mail: [email protected]
Regional Office West Coast: Phone: +1 408 573 3640 E-mail: [email protected]
Technical Support: Phone: +1 703 483 3185 E-mail: [email protected]

Headquarters Europe, Middle East, Africa
u-blox AG
Phone: +41 44 722 74 44 E-mail: [email protected] Support: [email protected]

Asia, Australia, Pacific
u-blox Singapore Pte. Ltd. Phone: +65 6734 3811 E-mail: [email protected] Support: [email protected]
Regional Office Australia: Phone: +61 3 9566 7255 E-mail: [email protected] Support: [email protected]
Regional Office China (Beijing): Phone: +86 10 68 133 545 E-mail: [email protected] Support: [email protected]
Regional Office China (Chongqing): Phone: +86 23 6815 1588 E-mail: [email protected] Support: [email protected]
Regional Office China (Shanghai): Phone: +86 21 6090 4832 E-mail: [email protected] Support: [email protected]
Regional Office China (Shenzhen): Phone: +86 755 8627 1083 E-mail: [email protected] Support: [email protected]
Regional Office India: Phone: +91 80 405 092 00 E-mail: [email protected] Support: [email protected]
Regional Office Japan (Osaka): Phone: +81 6 6941 3660 E-mail: [email protected] Support: [email protected]
Regional Office Japan (Tokyo): Phone: +81 3 5775 3850 E-mail: [email protected] Support: [email protected]
Regional Office Korea: Phone: +82 2 542 0861 E-mail: [email protected] Support: [email protected]
Regional Office Taiwan: Phone: +886 2 2657 1090 E-mail: [email protected] Support: [email protected]

UBX-17065404 - R04 C1-Public

Contact

Page 14 of 14



References

Microsoft Word for Microsoft 365

Search Any Device: