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

Update the UART README with info about the core and its API

Browse Source 
Signed-off-by: Joachim Strömbergson <joachim@assured.se>
This commit is contained in:
Joachim Strömbergson 2023-05-08 14:50:10 +02:00 committed by dehanj
parent 704d67c8ab
commit 97e3e25d98
No known key found for this signature in database
GPG Key ID: 3707A9DBF4BB8F1A
1 changed files with 36 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
hw/application_fpga/core/uart/README.md
View File

@ -2,8 +2,41 @@ uart
====
A simple universal asynchronous receiver/transmitter (UART) core
implemented in Verilog.
implemented in Verilog. The core is completed and has been used in
several FPGA designs.
# Status
The core is completed and has been used in several FPGA designs.
## Introduction
The UART core is used as main communication channel between the TKey
device System on Chip (SoC) and the TKey client. The UART contains a
512 byte receive buffer, allowing the SW running on the SoC to not
have to wait for bytes and poll them as soon as they are received. The
number of bytes in the FIFO is also exposed to the SW through the
ADDR_RX_BYTES address.
The number of data and data bits can be set by SW. The default is
eight data bits and one stop bit.
The default bit rate is based on target clock frequency divided by the
bit rate times in order to hit the center of the bits. I.e. Clock: 18
MHz, 62500 bps Divisor = 18E6 / 62500 = 288
## API
```
ADDR_BIT_RATE: 0x10
ADDR_DATA_BITS: 0x11
ADDR_STOP_BITS: 0x12
ADDR_RX_STATUS: 0x20
ADDR_RX_DATA: 0x21
ADDR_RX_BYTES: 0x22
ADDR_TX_STATUS: 0x40
ADDR_TX_DATA: 0x41
```
## Implementation notes.
The FIFO allocates a single block RAM (EBR).