espressif / esptool

Espressif SoC serial bootloader utility
https://docs.espressif.com/projects/esptool
GNU General Public License v2.0
5.6k stars 1.39k forks source link

make_image: support ESP32 image format (ESPTOOL-946) #1024

Closed sven337 closed 4 weeks ago

sven337 commented 1 month ago

This change adds ability to generate ESP32 firmware images with make_image. This had been requested a long time ago and not implemented, but I found use for that feature.

This change fixes the following bug(s):

https://github.com/espressif/esptool/issues/178

I have tested this change with the following hardware & software combinations:

ESP32-WROOM-32D firmware: dumped, extracted, rebuilt with make_image. This change will not preserve the flash flags, but these can be manually added.

I have run the esptool.py automated integration tests with this change and the above hardware:

NO TESTING

github-actions[bot] commented 1 month ago
Warnings
:warning: **Some issues found for the commit messages in this PR:** - the commit message `"make_image: support ESP32 image format"`: - *type/action* should be one of [`change`, `ci`, `docs`, `feat`, `fix`, `refactor`, `remove`, `revert`, `test`] *** **Please fix these commit messages** - here are some basic tips: - follow [Conventional Commits style](https://www.conventionalcommits.org/en/v1.0.0/) - correct format of commit message should be: `(): `, for example `fix(esp32): Fixed startup timeout issue` - allowed types are: `change,ci,docs,feat,fix,refactor,remove,revert,test` - sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter - avoid Jira references in commit messages (unavailable/irrelevant for our customers) `TIP:` Install pre-commit hooks and run this check when committing (uses the [Conventional Precommit Linter](https://github.com/espressif/conventional-precommit-linter)).

👋 Hello sven337, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by :no_entry_sign: dangerJS against 6b5963dce3af90cbaa54193ed44a354429ad328f

dobairoland commented 4 weeks ago

Please see the note at https://docs.espressif.com/projects/esptool/en/latest/esp8266/esptool/advanced-commands.html#assemble-a-firmware-image-make-image:

In general, it is better to create an ELF image (including any binary data as part of the ELF, by using objcopy or other tools) and then use elf2image to generate the .bin file.

make_image was only supported for ESP8266 and it was deprecated after that in favor of elf2image. This command will be probably removed in the next major release of esptool.

I'm sorry but we will not accept this PR.

sven337 commented 4 weeks ago

Please do not remove it, this is a useful feature. This patch trivially adds support for ESP32, I don't understand what could justify refusing it. elf2image requires an ELF file but you do not always have that if you're editing segments directly.