The ProkBox Reference

Part V · Writing firmware

This Part is about ProkBox’s own firmware: how to get the source, build it, test a change and contribute it. It assumes you are comfortable with C and a command line, but not that you know Rockbox or this player.

In this edition:

Chapters FW-1, FW-5 to FW-7, FW-9 to FW-17 and FW-19 come in later editions. Their numbers are reserved, so the numbers above will not change.

  1. FW-2 From clone to releaseThe whole process in one chapter, and a map of the repository.
  2. FW-3 Setting up the toolchainThe compilers and tools ProkBox needs, on macOS, on Linux and in a container.
  3. FW-4 BuildingBuilding the simulator, the firmware and the bootloader, and putting a build on a player.
  4. FW-8 The CPU and the COPWhat runs on which of the PP5022's two cores, in 0.8.0 and in the target design.
  5. FW-18 TestingHow to test a change to the ProkBox5g firmware: the gate, the quick loops, reading a failure, and the rules that keep the gate honest.
  6. FW-20 ContributingHow to send a change to ProkBox5g, and the licence, naming and evidence rules every contribution follows.