Skip to content

Commit de3769d

Browse files
authored
Update README.md
1 parent dfb67b6 commit de3769d

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The UART controller was simulated and tested in hardware.
1010

1111
### Generics:
1212

13-
```
13+
```vhdl
1414
CLK_FREQ : integer := 50e6; -- system clock frequency in Hz
1515
BAUD_RATE : integer := 115200; -- baud rate value
1616
PARITY_BIT : string := "none"; -- type of parity: "none", "even", "odd", "mark", "space"
@@ -19,7 +19,7 @@ USE_DEBOUNCER : boolean := True -- enable/disable debouncer
1919

2020
### Inputs and outputs ports:
2121

22-
```
22+
```vhdl
2323
-- CLOCK AND RESET
2424
CLK : in std_logic; -- system clock
2525
RST : in std_logic; -- high active synchronous reset
@@ -50,10 +50,10 @@ Example of receiving data on the user interface of the UART controller. The last
5050
### Table of resource usage summary:
5151

5252
Parity type | LE | FF | M9k | Fmax
53-
:---:|:---:|:---:|:---:|:---:
54-
none | 77 | 56 | 0 | 305.5 MHz
55-
even/odd | 84 | 60 | 0 | 289.4 MHz
56-
mark/space | 82 | 60 | 0 | 290.7 MHz
53+
------------|----|----|-----|-----------
54+
none | 77 | 56 | 0 | 305.5 MHz
55+
even/odd | 84 | 60 | 0 | 289.4 MHz
56+
mark/space | 82 | 60 | 0 | 290.7 MHz
5757

5858
*Implementation was performed using Quartus Prime Lite Edition 20.1.0 for Intel Cyclone 10 FPGA (10CL025YU256C8G). Setting of some generics: USE_DEBOUNCER = True, BAUD_RATE = 115200, CLK_FREQ = 50e6.*
5959

@@ -64,6 +64,13 @@ A simulation is prepared in the repository. You can use the prepared TCL script
6464
vsim -do sim/sim.tcl
6565
```
6666

67+
Or it is possible to run the simulation using the [GHDL tool](https://github.com/ghdl/ghdl). Linux users can use the prepared bash script (in ```sim/``` folder) to run the simulation in GHDL:
68+
```
69+
./sim_ghdl_run.sh
70+
```
71+
72+
I also use the GHDL tool for CI: automated VHDL simulations in the GitHub Actions environment ([setup-ghdl-ci](https://github.com/ghdl/setup-ghdl-ci)).
73+
6774
## Examples:
6875

6976
The repository also includes several UART example designs. I use it on my [FPGA board CYC1000](https://shop.trenz-electronic.de/en/TEI0003-02-CYC1000-with-Cyclone-10-FPGA-8-MByte-SDRAM) with Intel Cyclone 10 FPGA (10CL025YU256C8G) and FTDI USB to UART Bridge. Here you can find [the documentation of the CYC1000 board](https://www.trenz-electronic.de/fileadmin/docs/Trenz_Electronic/Modules_and_Module_Carriers/2.5x6.15/TEI0003/REV02/Documents/CYC1000%20User%20Guide.pdf).

0 commit comments

Comments
 (0)