Skip to content

Commit

Permalink
doc: device_mgmt: smp_groups: smp_group_1: Add upload hash note
Browse files Browse the repository at this point in the history 
Adds a note that the upload response hash is partially
optionally from the point of view of MCUboot's serial recovery.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
  • Loading branch information
@nordicjm @carlescufi
nordicjm authored and carlescufi committed Mar 29, 2023
1 parent 7806d5b commit f0e4223
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions doc/services/device_mgmt/smp_groups/smp_group_1.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ CBOR data of successful response:
(str,opt)"image" : (int)
(str)"slot" : (int)
(str)"version" : (str)
(str)"hash" : (byte str)
(str,opt*)"hash" : (byte str)
(str,opt)"bootable" : (bool)
(str,opt)"pending" : (bool)
(str,opt)"confirmed" : (bool)
Expand Down Expand Up @@ -156,7 +156,13 @@ where:
| | the whole file, it is the field in the MCUboot |
| | TLV section that contains a hash of the data |
| | which is used for signature verification |
| | purposes. |
| | purposes. This field is optional but only |
| | optional when using MCUboot's serial recovery |
| | feature with one pair of image slots, Kconfig |
| | :kconfig:option:`CONFIG_BOOT_SERIAL_IMG_GRP_HASH` |
| | can be disabled to remove support for hashes in |
| | this configuration. MCUmgr in applications must |
| | support sending hashes. |
| | |
| | .. note:: |
| | See ``IMAGE_TLV_SHA256`` in the MCUboot image |
Expand Down

0 comments on commit f0e4223

Please sign in to comment.