doc: Link to firmware docs from TKey hardware design

This commit is contained in:
Michael Cardell Widerkrantz 2025-05-20 17:28:01 +02:00
parent 4ec58ce04c
commit 69940d2c64
No known key found for this signature in database
GPG key ID: D3DB3DDF57E704E5

View file

@ -1,4 +1,4 @@
# TKey hardware design ## TKey hardware design
![The Application FPGA block diagram](../../doc/images/application_fpga_block_diagram.png) ![The Application FPGA block diagram](../../doc/images/application_fpga_block_diagram.png)
@ -16,8 +16,9 @@ firmware, application and system call. Each mode give access to a
different set of resources. Where app mode is the most restrictive and different set of resources. Where app mode is the most restrictive and
firmware mode is the least restrictive. firmware mode is the least restrictive.
The rest of the components are under `cores`. They typically have The rest of the components are under `cores`, except the firmware,
their own `README.md` file documenting them and their API in detail. which is under `fw/tk1`. They typically have their own `README.md`
file documenting them and their API in detail.
Hardware functions with APIs, assets, and input/output are memory Hardware functions with APIs, assets, and input/output are memory
mapped starting at base address `0xc000_0000`. For specific offsets mapped starting at base address `0xc000_0000`. For specific offsets
@ -38,6 +39,11 @@ Rough memory map:
| Syscall | 0xe1 | | Syscall | 0xe1 |
| TK1 | 0xff | | TK1 | 0xff |
## Firmware
Firmware is kept in ROM. See the [Firmware implementation
notes](fw/README.md).
## `clk_reset_gen` ## `clk_reset_gen`
Generator for system clock and system reset. Generator for system clock and system reset.