Skip to content

Commit cc88b6b

Browse files
committed
Pull request project-chip#1755: OTA documentation update
Merge in WMN_TOOLS/matter from ota_doc_updates to RC_2.3.0-1.3 Squashed commit of the following: commit 5a424081597806b9d54aac6474662dbe38a462d6 Author: Michael Rupp <michael.rupp@silabs.com> Date: Fri Apr 19 12:21:46 2024 -0400 review comment, add section to create encrypted .ota commit 8094896d93b304979257c8297e1a24639784cf34 Author: Michael Rupp <michael.rupp@silabs.com> Date: Sat Apr 13 11:58:32 2024 -0400 OTA documentation update
1 parent 067b3f5 commit cc88b6b

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

docs/silabs/general/OTA_SOFTWARE_UPDATE.md

+14
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,20 @@ Host will initiate OTA download to receive combined image (TA+M4) and store M4 a
280280
```
281281
- The application device will connect to the Provider and start the image download. Once the image is downloaded the device will reboot into the downloaded image.
282282

283+
## Multi-Chip OTA Images
284+
Multi-Chip OTA is implemented only for EFR32 devices. Multi-chip OTA uses an enhanced ota_image_tool.py script which creates .ota files that contain additional TLV headers. These TLV headers describe the binaries to be sent over the air. The enhanced script is located at scripts/tool/silabs/ota/ota_image_tool.py which is a wrapper to the original src/app/ota_image_tool.py. Multiple binaries can be packaged in the .ota file. Some Tags are reserved for specific Silicon Labs binaries, and other Tags are available to be used for arbitrary TLVs. The payloads can be encrypted.
285+
286+
For more information on creating a Multi-Chip .ota file see the
287+
[README.md](https://github.com/SiliconLabs/matter/blob/latest/scripts/tools/silabs/ota/README.md)
288+
289+
OTA-A applications must be built with an additional gn argument to enable them to process the TLVs.
290+
291+
```shell
292+
$ ./scripts/examples/gn_silabs_example.sh examples/lighting-app/silabs/ out/lighting-app BRD41xx chip_enable_multi_ota_requestor=true
293+
```
294+
295+
chip_enable_multi_ota_encryption=true should be added to the build command if the requestor is meant to process encrypted payloads.
296+
283297
## Additional Info
284298

285299
Developers can find more resources on

scripts/tools/silabs/ota/README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ python3 ./scripts/tools/silabs/ota/ota_image_tool.py create -v 0xDEAD -p 0xBEEF
2525
```
2626

2727
followed by \*_custom options_- and a positional argument (should be last) that
28-
specifies the output file. Please see the `create_ota_images.sh` for some
29-
reference commands.
28+
specifies the output file.
3029

3130
The list of **custom options**:
3231

@@ -38,19 +37,17 @@ The list of **custom options**:
3837
--app-version-str --> Application version string. Same as above.
3938
--app-build-date --> Application build date. Same as above.
4039
41-
# SSBL options
42-
--bl-input-file --> Path to the SSBL binary.
43-
--bl-version --> SSBL version.
44-
--bl-version-str --> SSBL version string.
45-
--bl-build-date --> SSBL build date.
46-
4740
# Factory data options
4841
--factory-data --> If set, enables the generation of factory data.
4942
--cert_declaration --> Certification Declaration.
5043
--dac_cert --> DAC certificate.
5144
--dac_key --> DAC private key.
5245
--pai_cert --> PAI certificate.
5346
47+
# Encryption options
48+
--enc_enable --> Enable ota encryption
49+
--input_ota_key --> 16 Byte AES key
50+
5451
# Custom TLV options
5552
--json --> Path to a JSON file following ota_payload.schema
5653
```
@@ -67,5 +64,5 @@ processing.
6764
When defining a custom processor, a user is able to also specify the custom
6865
format of the TLV by creating a JSON file based on the `ota_payload.schema`. The
6966
tool offers support for describing multiple TLV in the same JSON file. Please
70-
see the `examples/ota_max_entries_example.json` for a multi-app + SSBL example.
67+
see the `examples/ota_custom_entries_example.json` for a multi-binary example.
7168
Option `--json` must be used to specify the path to the JSON file.

0 commit comments

Comments
 (0)