-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
5 additions
and
11 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,16 @@ | ||
# Introduction | ||
|
||
Topwrap is a generator for HDL wrappers and top modules. | ||
Topwrap is a tool for generating HDL wrappers for simple blocks as well as digital systems and can be used for creating complex SoCs from single blocks contained in wrappers. | ||
|
||
Wrappers are used to standardize names of ports that belong to an interfaces (e.g. UART, AXI etc.) | ||
|
||
## Wrappers | ||
These wrappers standardize names of ports that belong to an interfaces (e.g. UART, AXI etc.) | ||
|
||
```{image} img/wrapper.png | ||
``` | ||
|
||
## Top module | ||
Top modules connect IPs and/or Wrappers by either ports\` names or interfaces\` names to ease connecting multi-wire interfaces without the need to connect each wire separately. | ||
|
||
```{image} img/ipconnect.png | ||
``` | ||
|
||
## Amaranth | ||
|
||
Topwrap uses Amaranth to generate HDLs. It's a toolbox for building complex digital hardware. | ||
See [Amaranth Github](https://github.com/amaranth-lang/amaranth) for more information. | ||
|
||
## FuseSoC | ||
|
||
FuseSoC is used as build abstraction tool. It automates Vivado project generation and runs Vivado pipelines to generate bitstream and program FPGAs. It can be installed using `pip`. For more information visit [FuseSoC Github](https://github.com/olofk/fusesoc). |