Adding merge_image functionality (ESPTOOL-79) #568
Conversation
github-actions
bot
changed the title
There was a problem hiding this comment.
Hi @Barmaley13,
I'm sorry noone has gotten back to you for such a long time.
Thanks for contributing this, it's a useful function and something that's been obviously missing from esptool.py for some time.
This PR needs some work before we can accept it. If you're interested in reworking it then I can promise a < 2 month turnaround from now on - although if you'd rather not then that's OK as well.
As well as the inline comments, some other things:
- The PR is showing a lot of unrelated changes (I just reviewed the
merge_imagefunction not the other code as it was mostly merge-related issues). Please rebase on the master branch to clean this up. - The PR is failing some of the automated Python checks (flake8, etc). Please check those out.
- It would be great to have some unit tests that the output is correct, errors correctly detected, etc.
- The
--flash_size/--flash_modeoptions are actually not applied unless you flash a binary directly at the bootloader offset (so 0x1000 for ESP32). So this part won't quite work as described in the PR. It'd be great if these options could be supplied to this command as well, in the same way they can be supplied d towrite_flashcommand, so that the output file is generated with the specified modes/etc.
| if encrypt: | ||
| with open(unenc_name, 'rb') as input_file: | ||
| with open(enc_name, 'wb') as output_file: | ||
| espsecure._flash_encryption_operation( |
There was a problem hiding this comment.
the underscore prefix in python is for private methods. overall, as this command will probably be run as part of a script or a custom build process then I'd prefer to make encryption a separate step in the script - otherwise when we add ESP32-S2 flash encryption support (for example) this command will also need updating to support that.
There was a problem hiding this comment.
You are probably right! I am going to leave it as it is for now. But maybe you can change it to serve esptool needs better
esptool.py
Outdated
| def check_if_possible(self): | ||
| for i in range(1, len(self.bin_array)): | ||
| if self.bin_array[i].addr <= (self.bin_array[i - 1].addr + self.bin_array[i - 1].size): | ||
| print(self.bin_array[i].addr, (self.bin_array[i - 1].addr + self.bin_array[i - 1].size)) |
There was a problem hiding this comment.
debug statement left in by mistake?
It should be possible to use the AddrFilenamePairAction which is already used by write_flash command to test none of the binaries overlap.
There was a problem hiding this comment.
Removed debug statement. I've also cleaned up overlap check. But by no means if we have this functionality else where we should use it rather than rewrite it.
|
Hi @projectgus,
Sorry, I have not used rebase much. I think I just did it though
Just finished cleaning up portion of the code. Will see what kind of suggestions travis will come up with
I would love to leave this for someone else. I am hoping this latest version is good enough for handing it over to someone else to polish it up to the finish line.
Going to leave this as is. Since I am not sure if this is done as a binary file offset or dynamically at flash time |
|
Hi guys. Is any work being done for this feature? This will be very useful in CI/CD pipelines that automatically build firmwares |
|
Hi @positron96, I'm working on this but I need to write some tests for it, hopefully it'll be in the master branch in the next week or two. This PR will be updated once that happens. Angus |
Description of change
Added command to merge multiple .bin files into one file for flashing.
Furthermore, you can create both unencrypted and encrypted images (-k is optional)
esptool.py --port PORT merge_image -k flash_key.bin @download.configand flash those with 0x0 offset, for instance
esptool.py --port PORT -b 460800 write_flash --flash_mode dio --flash_freq 40m --flash_size detect 0x0 flash.binor similar (for the encrypted flash)
esptool.py --port PORT -b 460800 write_flash --flash_mode dio --flash_freq 40m --flash_size detect 0x0 flash.enc.binThis change fixes the following bug(s):
#254
I have tested this change with the following hardware & software combinations:
Ubuntu 18.04
ESP32-WROOM-32D
ESP32
I have NOT run the esptool.py automated integration tests with this change and the above hardware.
This addition would not affect automated integration tests since this pull request does not modify existing functionality it appends it.