Skip to content

Fix typo in firmware image format documentation (ESPTOOL-1205) #1135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Fix typo in firmware image format documentation (ESPTOOL-1205) #1135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/advanced-topics/firmware-image-format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The image header is 8 bytes long:
+--------+------------------------------------------------------------------------------------------------+
| 3 | High four bits - Flash size (``0`` = 1MB, ``1`` = 2MB, ``2`` = 4MB, ``3`` = 8MB, ``4`` = 16MB) |
| | |
| | Low four bits - Flash frequency (``0`` = 80MHz, ``0`` = 40MHz, ``2`` = 20MHz) |
| | Low four bits - Flash frequency (``0`` = 80MHz, ``1`` = 40MHz, ``2`` = 20MHz) |
Copy link
Collaborator

@peterdragun peterdragun Nov 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that this is correct and explained a couple of lines later, after the table in the note: Flash frequency with value ``0`` can mean either 80MHz or 40MHz based on MSPI clock source mode. Basically, there is a clock divider that will be set in ESP-IDF, which defines the final clock frequency.

Also, please note that these values correspond to ones in the code: https://github.com/espressif/esptool/blob/master/esptool/targets/esp32c6.py#L82-L86

Copy link
Collaborator

@dobairoland dobairoland Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this could be improved in a way so it won't raise suspicion about being a mistake. For example:

``0`` = 80MHz or 40MHz

Copy link
Author

@tyeth tyeth Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah wonderful, thanks folks for the info and suggestion

+--------+------------------------------------------------------------------------------------------------+
| 4-7 | Entry point address |
+--------+------------------------------------------------------------------------------------------------+
Expand Down
Loading