Skip to content

Commit 01d943f

Browse files
committed
update README
1 parent 2fdc45b commit 01d943f

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This project aims to provide synthesizable RTL VHDL models for Lattice ispMACH40
44

55
## Overview
66

7-
Code design generation is based on the reverse engineered fusemap definitions from [re4k](https://github.com/bcrist/re4k/). A python script assembles the core design from these building blocks:
7+
Core design generation is based on the reverse engineered fusemap definitions from [re4k](https://github.com/bcrist/re4k/). A python script reads [re4k's S-Expressions](https://github.com/bcrist/re4k/tree/main#s-expression-files) and assembles the toplevel design from parametrizable building blocks:
88

99
* Pins
1010
* Global routing pool (GRP)
@@ -13,7 +13,7 @@ Code design generation is based on the reverse engineered fusemap definitions fr
1313
* Macrocells
1414
* Output routing pools (ORP)
1515

16-
The result is a VHDL design per device type that accepts the fusemap as generic parameter.
16+
The result is a VHDL design hierarchy per device type that accepts the fusemap as generic parameter.
1717

1818
Tests are provided to check equivalence between the original (golden) design and the generated LC4K core parametrized by the fusemap.
1919

@@ -93,7 +93,7 @@ There are several approaches for how to integrate the core design and provide th
9393

9494
#### JEDEC conversion
9595

96-
Each core design requires that the generic parameter `g_fusemap` is provided with a `std_logic_vector` of appropriate length and corresponds 1:1 to the contents of the JEDEC fusemap. In case of LC4032ZC_TQFP48, the vector contains 17200 bits.
96+
Each core design requires that the generic parameter `g_fusemap` is provided with a `std_logic_vector` of appropriate length that corresponds 1:1 to the contents of the JEDEC fusemap. In case of LC4032ZC_TQFP48, the vector contains 17200 bits.
9797

9898
Use `jed2vhdl.py` to convert a JEDEC file to a fusemap parameter:
9999

@@ -102,11 +102,11 @@ $ python3 python/jed2vhdl.py <jedec file> <width> [-b] > vector
102102
```
103103

104104
* `<width>` specifies how many bits shall be put into a single line of output. Just use the device's column width (172 in the example above), but any number should work
105-
* `-b` optionally instructs the converter to omit `"&` characters. The result is a file containing only 0 and 1
105+
* `-b` optionally instructs the converter to omit `"&` characters. The result is a file containing only 1s and 0s
106106

107107
#### By wrapper design
108108

109-
The lc*_core entity is instantiated in a wrapper that narrows down I/Os and sets the generic parameter `g_fusemap`.
109+
The lc*_core entity is instantiated in a wrapper that narrows down I/Os and sets the generic parameter `g_fusemap`. The value for the generic parameter is the output of `jed2vhdl.py` (without `-b`).
110110

111111
Examples for this approach can be found in the `tests/` folder.
112112

0 commit comments

Comments
 (0)