tillitis / dev-tillitis Goto Github PK

A developer of device apps can't rely on the memory map as described by the Dev Handbook.

The memory map is misleading, has hints to a developer that have little to do with the real hardware, and doesn't document the real hardware behaviour.

We want to have correct information in the memory map.

Hello!

Could you please add information about the license of this repository — is it allowed to copy, change and use the documentation in any purpose?
It would be great to see any popular open source license.

This issue relates to several improvements related to the HW aspects of the Tkey:

1. In the introducton, add an image of the Tkey PCB (without the case) that identifies major components such as the FPGA, the CH552, Flash, sensor.
2. In the introduction, add a block diagram for the SoC in the FPGA
3. Add a list with brief info about the cores in the block diagram
4. Order the corers in the HW description alphabetically
5. Update text about CDI. Point out that CDI is a base for key derivation (KDF), not a key material. Possibly add pointer to function i tkey-libs
6. Update text about TRNG. Order API into a list. Add more emphasis in non security usage. Add reference to DRBG solutions

We package our Windows binaries into winget packages, yet suggest the use of the chocolatey package manager in our handbook.

If all packages are available with winget instead I suggest we change into using winget in the handbook as well.

In the build bitstream section in the Dev Handbook we exhort people to use the tkey-builder image for building but don't mention the make targets under contrib, like run-make. We probably should mention them.

Perhaps we also could change the quickstart things in tillitis-key1 to mention this?