Skip to content

Commit

Permalink
docs: Update introduction chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
tmichalak committed Nov 27, 2023
1 parent 4ed1030 commit 2a2d3c9
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 11 deletions.
Binary file modified docs/source/img/ipconnect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/img/pwm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/img/wrapper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 5 additions & 11 deletions docs/source/introduction.md
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).

0 comments on commit 2a2d3c9

Please sign in to comment.