[OTA] Add script for generating OTA image #13547
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pullapprove
bot
requested review from
andy31415,
anush-apple,
austinh0,
balducci-apple,
Byungjoo-Lee,
bzbarsky-apple,
chrisdecenzo,
chshu,
chulspro,
dhrishi,
electrocucaracha,
franck-apple,
gjc13,
hawk248,
jelderton,
jepenven-silabs,
jmartinez-silabs,
kghost,
kpschoedel,
LuDuda,
lzgrablic02,
mlepage-google,
mrjerryjohns,
msandstedt,
pan-apple,
robszewczyk,
sagar-apple and
saurabhst
|
PR #13547: Size comparison from bbf5d40 to a84c3a8 Full report (32 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
Damian-Nordic
force-pushed
the
ota-image-tool
branch
2 times, most recently
from
f71ea72 to
280c1e1
Compare
|
PR #13547: Size comparison from 5e61ce9 to 280c1e1 Full report (32 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
carol-apple
approved these changes
Jan 14, 2022
Add script for encoding spec-compliant OTA image header and concatenating a set of payload files.
Damian-Nordic
force-pushed
the
ota-image-tool
branch
2 times, most recently
from
31ef758 to
82add17
Compare
|
PR #13547: Size comparison from e4faade to 82add17 Full report (32 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
LuDuda
approved these changes
Jan 17, 2022
selissia
approved these changes
Jan 18, 2022
| if args.max_version: | ||
| fields.update({HeaderTag.MAX_VERSION: uint(args.max_version)}) | ||
|
|
||
| if args.release_notes: |
There was a problem hiding this comment.
Size range is 1..256. Suggest warning if it doesn't start with https://
Comment on lines
+114
to
+118
| if args.min_version: | ||
| fields.update({HeaderTag.MIN_VERSION: uint(args.min_version)}) | ||
|
|
||
| if args.max_version: | ||
| fields.update({HeaderTag.MAX_VERSION: uint(args.max_version)}) |
There was a problem hiding this comment.
Must validate the following (depending on presence):
- min_version <= max_version
- max_version < args.version
| HeaderTag.VENDOR_ID: uint(args.vendor_id), | ||
| HeaderTag.PRODUCT_ID: uint(args.product_id), | ||
| HeaderTag.VERSION: uint(args.version), | ||
| HeaderTag.VERSION_STRING: args.version_str, |
There was a problem hiding this comment.
Must verify length in range 1..64
|
|
||
| fields = { | ||
| HeaderTag.VENDOR_ID: uint(args.vendor_id), | ||
| HeaderTag.PRODUCT_ID: uint(args.product_id), |
| """ | ||
|
|
||
| fields = { | ||
| HeaderTag.VENDOR_ID: uint(args.vendor_id), |
| DIGEST_ALL_ALGORITHMS = hashlib.algorithms_available.intersection( | ||
| DIGEST_ALGORITHM_ID.keys()) | ||
|
|
||
| PAYLOAD_BUFFER_SIZE = 16 * 1024 |
There was a problem hiding this comment.
Suggest adding the comment:
# Buffer size used for file reads to ensure large files do not need to be loaded
# into memory fully before processing.
Comment on lines
+47
to
+54
| sha256_128=2, | ||
| sha256_120=3, | ||
| sha256_96=4, | ||
| sha256_64=5, | ||
| sha256_32=6, | ||
| sha384=7, | ||
| sha512=8, | ||
| sha3_224=9, |
There was a problem hiding this comment.
Suggest warning if sha256_x (len < 256 bits) and sha3_224 are used, since:
It is RECOMMENDED that a digest algorithm be chosen that has a minimum digest length of 256 bits, such as
sha-256(ID 1 in the registry).
|
|
||
| with open(args.image_file, 'rb') as file: | ||
| fixed_header_format = '<IQI' | ||
| fixed_header = file.read(struct.calcsize(fixed_header_format)) |
There was a problem hiding this comment.
Suggest adding: assert struct.calcsize(fixed_header_format) == 16
| Generate OTA image header | ||
| """ | ||
|
|
||
| fixed_header_format = '<IQI' |
There was a problem hiding this comment.
Suggest adding: assert struct.calcsize(fixed_header_format) == 16
selissia
pushed a commit
to selissia/connectedhomeip
that referenced
this pull request
Jan 28, 2022
Add script for encoding spec-compliant OTA image header and concatenating a set of payload files.
step0035
pushed a commit
to hank820/connectedhomeip
that referenced
this pull request
Feb 8, 2022
Add script for encoding spec-compliant OTA image header and concatenating a set of payload files.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
No tool for creating spec-compliant OTA images exists.
Change overview
Add script for encoding spec-compliant OTA image header and concatenating a set of payload files.
Additionally the script allows to parse the header and verify the contents were written correctly.
Fixes #2863.
Testing
Generated a sample OTA image and did simple manual verification of the contents.