Skip to content

Commit

Permalink
[topgen/pinmux/doc] Autogen target pinout / pinmux connectivity tables
Browse files Browse the repository at this point in the history
This adds a top-level doc generation function which currently
generates pinout and pinmux connectivity tables for all targets (ASIC,
CW310 etc) of a specific top-level.

More documentation generation functions can be added in the future, if
needed.

Signed-off-by: Michael Schaffner <[email protected]>
  • Loading branch information
msfschaffner committed Aug 4, 2021
1 parent 9e21a32 commit b63a8b5
Show file tree
Hide file tree
Showing 9 changed files with 904 additions and 4 deletions.
6 changes: 5 additions & 1 deletion hw/ip/pinmux/doc/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,11 @@ A typical programming sequence for the wakeup detectors looks as follows:

## Pinout and Pinmux Mapping

**TODO: generate tables for top-earlgrey**
The tables below summarize the pinout and pinmux connectivity for certain top-level designs.

### Top Earlgrey

{{< snippet "./targets.md" >}}

## Register Table

Expand Down
12 changes: 12 additions & 0 deletions hw/ip/pinmux/doc/targets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!--
DO NOT EDIT THIS FILE DIRECTLY.
It has been generated with the following command:
util/topgen.py -t hw/top_earlgrey/data/top_earlgrey.hjson -o hw/top_earlgrey/
-->

| Target Name | #IO Banks | #Muxed Pads | #Direct Pads | #Manual Pads | #Total Pads | Pinout / Pinmux Tables |
|:-------------:|:-----------:|:-------------:|:--------------:|:--------------:|:-------------:|:----------------------------------------------------------------------------------------:|
| ASIC | 4 | 47 | 14 | 9 | 70 | [Pinout Table](../../../top_earlgrey/ip/pinmux/doc/autogen/pinout_asic/index.html) |
| CW310 | 4 | 29 | 4 | 16 | 49 | [Pinout Table](../../../top_earlgrey/ip/pinmux/doc/autogen/pinout_cw310/index.html) |
| NEXYSVIDEO | 4 | 29 | 4 | 16 | 49 | [Pinout Table](../../../top_earlgrey/ip/pinmux/doc/autogen/pinout_nexysvideo/index.html) |
Loading

0 comments on commit b63a8b5

Please sign in to comment.