Git-Mirrors/tillitis-key
1
0
Fork 0
mirror of https://github.com/tillitis/tillitis-key1.git synced 2024-12-18 12:24:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add make target secret, update quickstart

Browse Source
This commit is contained in:
Michael Cardell Widerkrantz 2022-10-20 17:02:09 +02:00
parent 65f2272a45
commit b8f1d4a083
No known key found for this signature in database
GPG Key ID: D3DB3DDF57E704E5
2 changed files with 41 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
doc/quickstart.md
View File

@ -1,8 +1,15 @@
# TK1 Quickstart
This document describes how to build the FPGA bitstream, including the This document describes how to build the FPGA bitstream, including the
firmware, and get this programmed onto the flash memory of the firmware, and get this programmed onto the flash memory of the
Tillitis Key 1 USB device. Tillitis Key 1 USB device.
*Note well*: If you have an already flashed TK1 you don't need to do
anything unless you want to set your own Unique Device Secret (UDS).
You can start running apps on it immediately. See
[tillitis-key1-apps](https://github.com/tillitis/tillitis-key1-apps)
for a few examples.
The Tillitis Key 1 kit includes: The Tillitis Key 1 kit includes:
- Tillitis Key 1 USB stick with USB-C plug, marked MTA1-USB V1 - Tillitis Key 1 USB stick with USB-C plug, marked MTA1-USB V1
@ -12,7 +19,7 @@ The Tillitis Key 1 kit includes:
- USB-C extension cable - USB-C extension cable
- USB-C to USB-A adapter - USB-C to USB-A adapter
# Programming FPGA bitstream and firmware onto Tillitis Key 1 ## Programming FPGA bitstream and firmware onto Tillitis Key 1
Connect the programmer to the computer using the USB cable with Connect the programmer to the computer using the USB cable with
micro-B plug. micro-B plug.
@ -39,7 +46,11 @@ refer to [toolchain_setup.md](toolchain_setup.md).
You are now ready to generate the FPGA bitstream (including building You are now ready to generate the FPGA bitstream (including building
the standard firmware) and program it onto the flash memory of the USB the standard firmware) and program it onto the flash memory of the USB
stick. The following should be run as your regular non-root user, but stick. Note that this will give a default Unique Device Secret. If you
want to personalize your TK1, see under Device personalization below
first.
The following should be run as your regular non-root user, but
the programming is currently done using `sudo` (so sudo is expected to the programming is currently done using `sudo` (so sudo is expected to
be set up for your user; the Makefile runs `sudo tillitis-iceprog …`). be set up for your user; the Makefile runs `sudo tillitis-iceprog …`).
@ -61,29 +72,29 @@ To learn more about the concepts and workings of the firmware, see:
[system_description/system_description.md](system_description/system_description.md) [system_description/system_description.md](system_description/system_description.md)
and [system_description/software.md](system_description/software.md). and [system_description/software.md](system_description/software.md).
# Device personalization ## Device personalization - setting Unique Device Secret (UDS)
To personalize Tillitis Key 1, you need to modify the hex file that To personalize Tillitis Key 1 you need to modify the Unique Device
contains the Unique Device Secret (UDS). You should also update the Secret (UDS) and, maybe, the Unique Device Identity (UDI).
Unique Device Identity (UDI). These hex files are located in
The simplest way to generate a new UDS is to:
```
$ cd tillitis-key1/hw/application_fpga
$ make secret
```
Then proceed with the `make prog_flash` as discussed above.
In detail: You need to modify the hex file that contains the Unique
Device Secret (UDS). You might also want to update the Unique Device
Identity (UDI). These hex files are located in
`hw/application_fpga/data/`. Note that after modify the files in this `hw/application_fpga/data/`. Note that after modify the files in this
directory, you need to rebuild and program the device again (as directory, you need to rebuild and program the device again (as
above). above).
To make this easier there is a tool that can generate these files. The To make this easier there is a tool that can generate these files. The
tool can be found in `hw/application_fpga/tools/tpt`. The tool allow tool can be found in `hw/application_fpga/tools/tpt`. The tool by
you to supply a secret used as part of the UDS generation. The tool default allow you to supply a secret used as part of the UDS
can be run interactively, or by suppling inputs on the command line: generation and only generates a new `uds.hex`. See `--help` for more
flags.
```
usage: tpt.py [-h] [-v] [--ent ENT] [--vid VID] [--pid PID] [--rev REV] [--serial SERIAL]
options:
-h, --help show this help message and exit
-v, --verbose Verbose operation
--ent ENT User supplied entropy
--vid VID Vendor id (0 - 65535)
--pid PID Product id (0 - 2555
--rev REV Revision number (0 - 15)
--serial SERIAL Serial number (0 - (2**31 - 1))
```

8
hw/application_fpga/Makefile
View File

@ -104,6 +104,14 @@ all: application_fpga.bin
phony_explicit: phony_explicit:
.PHONY: phony_explicit .PHONY: phony_explicit
#-------------------------------------------------------------------
# Personalization of the TK1
#-------------------------------------------------------------------
secret:
cd data;../tools/tpt/tpt.py
.PHONY: secret
#------------------------------------------------------------------- #-------------------------------------------------------------------
# Firmware generation. # Firmware generation.
# Included in the bitstream. # Included in the bitstream.