tillitis-key/hw/application_fpga/tools/README.md
Michael Cardell Widerkrantz 90a91ba1ba
build: Create and use a complete filesystem image
- Create a flash image in flash_image.bin, useful for both a real TKey
  and QEMU.

- Use flash_image.bin directly in prog_flash for a real TKey, which
  also flashes the bitstream.

- Remove building of tools/default_partition.bin.

- Update documentation about the tool use.

- We keep the load_preloaded_app.sh for development purposes,
  but it's no longer used in the build.
2025-09-01 18:19:54 +02:00

37 lines
1.4 KiB
Markdown

# Tools
We have developed some tools necessary for the build.
- `app_bin_to_spram_hex.py`: Script used to include a device app in a
testbench simulation.
- `b2s`: Compute and print a BLAKE2s digest over a file. Used for the
digest of the app in app slot 0 included in the firmware.
- `load_preloaded_app.sh`: Script to load two copies of the partition
table to flash and a pre-loaded to app slot 0 or 1. Needs
`default_partition.bin`, generated with `tkeyimage` and the binary
of the device app to load. Call like:
```
./tkeyimage/tkeyimage -app0 path/to/binary -o default_partition.bin
./load_preloaded_app 0 path/to/binary
```
- `makehex.py`: Used to build hex version of firmware ROM for FPGA
bitstream build.
- `patch_uds_udi.py`: Script used to patch in the Unique Device Secret
in `data/uds.hex` and the Unique Device Identifier in `data/udi.hex`
into the bitstream without having to rebuild the entire bitstream.
- `run_pnr.sh`: Script to run place and route with `nextpnr` in order
to find a routing seed that will meet desired timing.
- `tkeyimage`: Utility to create and parse a partition table or entire
flash images with a TKey filesystem. You can flash the image with
the [iceprog tool](https://github.com/tillitis/icestorm/). Remember
to flash the flash image first and the FPGA bitstream afterwards.
- `tpt/tpt.py`: Utility to create the Unique Device Secret (UDS) and
Unique Device Identity (UDI) interactively.