Commit Graph

103 Commits

Author SHA1 Message Date
Michael Cardell Widerkrantz
bc99f370ce
doc: release notes
Fix typos and specify OCI image path.
2023-03-23 15:20:53 +01:00
Michael Cardell Widerkrantz
6613b7e695
docs: Update firmware docs and move memory map
Update firmware docs to reflect new state machine, the new stack in
FW_RAM, and new loading address for app. Remove superflous technical
details from the software description.

Move memory subsystem and memory map to system_description.md and
refer to it directly by subsection elsewhere.
2023-03-22 22:50:08 +01:00
Joachim Strömbergson
fddfd88db2
Major update of threat model including new release
Co-authored-by: Michael Cardell Widerkrantz <mc@tillitis.se>
Signed-off-by: Joachim Strömbergson <joachim@assured.se>, Michael Cardell Widerkrantz <mc@tillitis.se>
2023-03-22 22:26:13 +01:00
Joachim Strömbergson
4086911c3b
Add release notes for Bellatrix
Co-authored-by: Michael Cardell Widerkrantz <mc@tillitis.se>

Signed-off-by: Joachim Strömbergson <joachim@assured.se>, Michael Cardell Widerkrantz <mc@tillitis.se>
2023-03-22 21:19:27 +01:00
Joachim Strömbergson
dbb7e61509
Add description of exe monitor API
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2023-03-22 15:55:36 +01:00
Joachim Strömbergson
315f2f9d00
Adding description of new security features
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2023-03-22 15:54:43 +01:00
Joachim Strömbergson
7152bd55e1
Minor edits to update the system description to new release
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2023-03-22 15:08:39 +01:00
Joachim Strömbergson
1713d7c96b
Add note about tillitis-iceprog depending on libusb-1.0.0
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2023-03-22 09:29:15 +01:00
Matthew Mets
fe1e2254d2
Pipecleaning 2023-03-21 14:38:29 +01:00
Matthew Mets
3ac742d333
Add package dependencies for pico sdk 2023-03-21 14:38:29 +01:00
Matthew Mets
604bbdbd02
Add Pico SDK to docker image, for building tp1 firmware 2023-03-21 14:38:29 +01:00
Matthew Mets
17b8cb515b
Update toolchain for raw_usb dependencies
Addresses #82
2023-03-21 14:38:27 +01:00
Matthew Mets
7364cd75be
Add section on udev permissions to toolchain setup 2023-03-21 14:38:27 +01:00
Daniel Lublin
4afdc1cd1f
fw: Steady white led while waiting cmd; led off while loading app
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2023-03-14 10:25:03 +01:00
Daniel Lublin
7eb4d0304b
fw: load app at the start of RAM
Since app is always loaded at the start of RAM, the TK1_APP_ADDR define
is no longer needed.

Signed-off-by: Daniel Lublin <daniel@lublin.se>
2023-03-14 10:25:03 +01:00
Michael Cardell Widerkrantz
8edfdf9c36
fw: Remove state init_loading, introduce state fail
- We always assert on allowed commands in a state.
- We don't allow FW_CMD_LOAD_APP to be used twice.
- Enter fail state on read buffer overrun, header endpoint not for us,
  header parse error, and unknown firmware command.

Signed-off-by: Daniel Lublin <daniel@lublin.se>
2023-03-14 10:25:02 +01:00
Daniel Lublin
5f4f5c6584
Correct for new fw-ram size
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2023-03-08 12:34:34 +01:00
Daniel Lublin
8fd0fca967
Grow largest frame length to 512 bytes 2023-03-07 13:52:02 +01:00
Joachim Strömbergson
d075cc72c3
Manually merged changes for scrambling
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2023-03-07 10:42:59 +01:00
Joachim Strömbergson
3eb5b7879c Add API address to read out number of bytes in Rx FIFO
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2023-03-07 08:22:27 +01:00
Matthew Mets
e04b502833 Pin icestorm to a known-good version in setup doc 2023-03-02 12:03:33 +01:00
Matthew Mets
9d1708cf42
toolchain setup: link to CH552 build instructions (#78)
* Remove 'Optional' section from README, and update titles of
  sub-sections.
* Add link to sub-directory with CH552 setup instructions
* Fix line lengths in programmer board section
2023-02-15 11:45:42 +01:00
Daniel Lublin
9a6a790715
Add github action with basic CI that builds
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2023-02-03 14:28:56 +01:00
Joachim Strömbergson
b7d0698e1b
Improve wording and fix spelling nits
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2023-02-01 15:54:12 +01:00
Daniel Lublin
d5b5c6f91c
Update release notes
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2023-01-31 11:03:38 +01:00
Daniel Lublin
3c0828e51d Document using named timer_ctrl bits
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2023-01-30 15:48:57 +01:00
Joachim Strömbergson
6137b88fe0 Add separate start, stop bits and running status bit in API
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2023-01-30 15:48:57 +01:00
Daniel Lublin
08bde89b3d
Clarify toolchain use
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2023-01-09 10:38:20 +01:00
Daniel Lublin
f3c4e6c818
Revise UDI
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2023-01-05 14:34:32 +01:00
Daniel Lublin
dff768dd3b
Doc UDI lock-down 2022-12-20 12:06:07 +01:00
Daniel Lublin
9b9a125c66
Purge UDA; never implemented, now deprecated
Fixes #58

Signed-off-by: Daniel Lublin <daniel@lublin.se>
2022-12-19 14:32:01 +01:00
Joachim Strömbergson
a69b35ffff
Add documentation for the RGB LED
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-12-19 13:22:22 +01:00
Joachim Strömbergson
f09fcfadb8
Rephrase explanation of what the FW is
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-12-19 12:07:57 +01:00
Joachim Strömbergson
8a5a338473
Add documentation for the GPIOs
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-12-19 11:47:12 +01:00
Michael Cardell Widerkrantz
08e1438d1e
fw: Add support for blake2s MMIO
In firmware we store the address to firmware blake2s() function at
TK1_MMIO_TK1_BLAKE2S so app can use this firmware function sort of
like a system call but without context switch.
2022-12-15 12:59:52 +01:00
Michael Cardell Widerkrantz
65bc96a725
fw: Prefix all HTIF console I/O functions with htif_ 2022-12-02 15:09:10 +01:00
Daniel Lublin
49d4735f17
Use TKey name
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2022-12-02 08:03:06 +01:00
Michael Cardell Widerkrantz
8dca845bc1
Harmonize firmware description
The links to firmware.md disappeared earlier so this change
incorporates some of the the text there in under the Firmware heading
in software.md. Also changes the names of the commands in the state
machine to the same names as in the rest of software.md.

Mention the Zmmul extension and what it means and possible workarounds
for people developing with clang < version 15.
2022-12-02 07:45:53 +01:00
Michael Cardell Widerkrantz
dfdb2809e4
Update release notes
- we have no div, use Zmmul.
- the USS is no longer used if not supplied.

Signed-off-by: Daniel Lublin <daniel@lublin.se>
2022-12-02 07:44:05 +01:00
Daniel Lublin
70f5cbf22e
Include QEMU
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2022-12-01 19:11:42 +01:00
Daniel Lublin
80f518882c
Clarify commonly needed pkgs
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2022-12-01 19:10:46 +01:00
Daniel Lublin
726bbcd15c
Capitalize consistently
Signed-off-by: Daniel Lublin <daniel@lublin.se>
2022-11-30 14:23:44 +01:00
Joachim Strömbergson
97c0a2152e
Prepare for new official release, add initial context
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-11-30 14:12:35 +01:00
Joachim Strömbergson
00ebcb2186 Adding more info about the programmer, updating names to TKey-something
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-11-30 13:50:46 +01:00
Joachim Strömbergson
dfae0c1d90
Remove (stale) open question, todos
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-11-29 14:47:27 +01:00
Joachim Strömbergson
e0906a7da5
Add more info about the ROSC TRNG
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-11-29 14:43:35 +01:00
Joachim Strömbergson
d5aa1b3f1c Add link to SW for API descriptions
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-11-29 14:21:33 +01:00
Joachim Strömbergson
7d7a7eda23 Add information about the touch sensor core
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-11-29 14:21:33 +01:00
Joachim Strömbergson
405a18f6fa Update system description to match all changes
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-11-29 14:21:33 +01:00
Joachim Strömbergson
4915e1d54f Add a lot of content about the application FPGA
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
2022-11-29 14:21:33 +01:00