Skip to content
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.

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

write-bin truncates data when length not divisible by 4 #698

Open
zargony opened this issue Oct 29, 2024 · 1 comment
Open

write-bin truncates data when length not divisible by 4 #698

zargony opened this issue Oct 29, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@zargony
Copy link

zargony commented Oct 29, 2024

It seems that write-bin truncates data to full 256 bytes blocks when length of data is not divisible by 4.

I.e.:

  • any data with length divisable by 4 is flashed correctly
  • any data with length not divisable by 4 gets truncated to full 256 bytes blocks

Some examples:
64 bytes -> ok
66 bytes -> nothing flashed (all 0xff)
256 bytes -> ok
258 bytes -> truncated to 256 bytes
260 bytes -> ok
262 bytes -> truncated to 256 bytes

Analysis

Looking through espflash code (Esp32Target), I couldn't find the cause for this issue. I suspect this has something to do with how the stub decompresses data or handles chunks of data. And indeed the issue doesn't happen when using --no-stub. It might even be a (known?) limitation of the stub, however neither documentation nor code seems to mention it anywhere.

This sounds like it would need to be fixed in the stub code (which is precompiled binary, so no idea if it can be modified). It could also be worked around in espflash by padding data to length divisible by 4 before compressing and sending it to the stub.

My environment: ESP32-C3, Rust 1.82.0, espflash 3.2.0, macOS 15.0 (24A335)

Steps to reproduce

  • create a file with 262 bytes (not divisible by 4)
  • flash it (espflash write-bin 0xc000 foo.txt)
  • read it back (espflash read-flash 0xc000 0x1000 foo.bin)
  • compare and see it truncated to length 256 (filled with 0xff)
  • repeat with 260 bytes (divisible by 4): ok
  • repeat with 262 bytes and --no-stub: ok
@jessebraham jessebraham added the bug Something isn't working label Oct 29, 2024
@zargony
Copy link
Author

zargony commented Oct 29, 2024

I tried the same with esptool.py: it works fine with any data length. I noticed it says "Wrote 240 bytes" when writing a file with 238 bytes of data. It seems to use the same above mentioned workaround (here) and pads data to be divisible by 4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Todo
Development

No branches or pull requests

2 participants