You've already forked torvalds-GuitarPedal
mirror of
https://github.com/torvalds/GuitarPedal.git
synced 2026-08-19 13:34:01 +00:00
0c1b9c3db3
'Software' was the directory everything that was not KiCad ended up in, which stopped describing anything a while ago - Validation and the web app are software too. Worse, it put the shared parts inside the firmware, where they read as the firmware's own. They are not. Effects/ has three consumers built from it: the firmware, Validation's bench, and the web app's controls, all generated from the same POT: comments by gen_effects.py. Audio/ has two - the bench compiles the same biquads, the same envelope followers and the same single_sample(), which is the whole reason a measurement on a workstation says anything about the pedal. Neither belongs under Firmware/, so neither is under it any more: Effects/ one file per effect Audio/ the DSP they are built from, and the audio loop Firmware/ the rest of what runs on the pedal, and the submodules WebMIDI/ the web app scripts/ what the build runs Validation/ unchanged Hardware/, Documentation/, Images/ CMakeLists.txt and the wrapper Makefile move to the top with them, because the build now consumes four of those directories and generates into a fifth. board.local and build/ come along; MIDI_CC_MAP.md is generated into Documentation/ rather than into the old Software/ root. scripts/ goes with the build rather than staying under the firmware, because six of the ten had nothing to do with the firmware: gen_effects.py reads Effects/ and writes to three different places, pow2/log2/quarter_sine generate Audio/'s tables, check-readme.py compares Effects/ against the README, and server.py serves the web app. Four of them are invoked from Validation, which was reaching into Firmware/ for tooling - the same burying this commit is undoing. The four that really are about the firmware are ELF checks the top-level build drives anyway, and a second scripts directory would only be a second place to look. C includes say "Audio/foo.h" and the generated map says "Effects/bar.h", with the repository root on the include path for both the firmware and the bench. Spelling the directory out rather than relying on a bare name is what keeps Audio/cycles.h shimmable: a quoted include searches the including file's own directory first. The submodules are renamed as well as moved. git mv updates their paths but leaves the section names, and 'Software/pico-sdk' surviving in .gitmodules would be the word this commit removes, still load-bearing. That meant the nested modules under pico-sdk too - six .git files pointing into .git/modules/Software - which is why 'git submodule update --init --recursive' is worth running once after pulling this. Verified rather than assumed: a clean configure and build, make check (failing only on the missing-eeprom case it already failed on), check-effects, all four analysis pages reproducing every series and drawing every chart, and a flash to the board that still measures a routed reverb where it did before. One latent bug fell out of it. bench/coeff declared only quarter_sine.h of the three generated math tables, and Audio/util.h includes pow2.h and log2.h as well - so building that target with an empty gen/ could never have worked. 'make bench' builds bench/bench first, which generates all three, so it stayed hidden until this rebuilt everything from nothing. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
63 lines
2.3 KiB
Python
Executable File
63 lines
2.3 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
#
|
|
# Check that the firmware image does not reach into the save area.
|
|
#
|
|
# The save area is a fixed region at the top of flash, addressed
|
|
# arithmetically rather than by a linker symbol, because the whole point
|
|
# is that it survives being reflashed - it is not part of the image and
|
|
# the image does not know how big it is.
|
|
#
|
|
# Which means nothing connects the two. The image grows from the bottom
|
|
# and the save area sits at the top, and if they ever meet, the failure
|
|
# is that flashing the firmware silently destroys somebody's scenes, or
|
|
# that saving silently destroys the firmware. There is a megabyte and a
|
|
# half between them today; this is here so that the day that stops being
|
|
# true is a build failure and not a mystery.
|
|
#
|
|
# Called as: check-flash.py <elf> <flash_size> <area_offset> <nm>
|
|
#
|
|
import subprocess
|
|
import sys
|
|
|
|
XIP_BASE = 0x10000000
|
|
|
|
|
|
def main():
|
|
elf = sys.argv[1]
|
|
flash_size = int(sys.argv[2], 0)
|
|
area_offset = int(sys.argv[3], 0)
|
|
nm = sys.argv[4] if len(sys.argv) > 4 and sys.argv[4] else "arm-none-eabi-nm"
|
|
|
|
res = subprocess.run([nm, elf], capture_output=True, text=True)
|
|
if res.returncode:
|
|
sys.exit(f"check-flash: {nm} failed:\n{res.stderr}")
|
|
|
|
end = None
|
|
for line in res.stdout.splitlines():
|
|
parts = line.split()
|
|
if len(parts) == 3 and parts[2] == "__flash_binary_end":
|
|
end = int(parts[0], 16)
|
|
if end is None:
|
|
sys.exit("check-flash: no __flash_binary_end in the image - "
|
|
"a NO_FLASH build, or a stale one?")
|
|
|
|
area = XIP_BASE + area_offset
|
|
used = end - XIP_BASE
|
|
if end > area:
|
|
print(f"check-flash: the image reaches 0x{end:08x}, which is "
|
|
f"0x{end - area:x} bytes into the save area at 0x{area:08x}.",
|
|
file=sys.stderr)
|
|
print("\nEither the firmware has to get smaller, or the save area has "
|
|
"to\nmove up and lose slots - and moving it up means every "
|
|
"pedal in\nexistence loses whatever was saved in the slots that "
|
|
"went away.", file=sys.stderr)
|
|
return 1
|
|
|
|
print(f"check-flash: {used // 1024}kB of {flash_size // 1024}kB used, "
|
|
f"{(area - end) // 1024}kB clear of the save area")
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|