Add address to firmware filenames

Open

#31 opened on Apr 9, 2024 15 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language: C
Stars: 158
Forks: 26
PR merge metrics: No merged PRs in 30d

Description

It would be nice to have address of FLASH memory in the the firmware filename. It helps beginners, it is self documenting feature.

EXAMPLE.

Current filenames of firmware for LeafMiner 0.0.13 for ESP32:

```
bootloader_esp32.bin
partitions_esp32.bin
firmware_esp32.bin
```

Better filenames:

```
0x1000_bootloader_esp32.bin
0x8000_partitions_esp32.bin
0x10000_firmware_esp32.bin
```

Other point is that flashing of firmware could be scripted and when offset address is stored in filename, it is easier to design script...

BTW, I just guessed addresses in my example, it is possible that addresses I used are not correct...

---

This is list of suggested filenames, work in progress. ESP32 and ESP8266 were verified to be correct. I do not have ESP-S2 device and GeekMagic-smallTV (I assume it is based on ESP8266).

```
0x0000_firmware_esp8266.bin

0x0000_firmware_geekmagic-smalltv.bin

0x1000_bootloader_esp32.bin
0x8000_partitions_esp32.bin
0x10000_firmware_esp32.bin

0x0000_bootloader_esp32-s2.bin
0x8000_partitions_esp32-s2.bin
0x10000_firmware_esp32-s2.bin

0x0000_bootloader_esp32-s3.bin
0x8000_partitions_esp32-s3.bin
0x10000_firmware_esp32-s3.bin

0x0000_bootloader_lilygo-t-display-s3.bin
0x8000_partitions_lilygo-t-display-s3.bin
0x10000_firmware_lilygo-t-display-s3.bin
```

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Research direction

Start by locating the firmware build or release-packaging entry point that produces the listed .bin files for ESP8266, ESP32, ESP32-S2, ESP32-S3, and LilyGO T-Display S3. Verify each flash offset against the project configuration or device documentation, then confirm that every generated filename includes the correct address and remains usable for scripted flashing.

Written by the indexing model from the issue text.

Assessment

Tech stack: c
Domain: embedded-iot
Issue type: Feature
Difficulty: 4/5
Estimated time: 3-5 days
Activity status: Stale
Clarity: Mostly clear
Newbie friendliness: 35/100