aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKeith Rothman <537074+litghost@users.noreply.github.com>2021-02-12 08:07:09 -0800
committerKeith Rothman <537074+litghost@users.noreply.github.com>2021-02-12 08:07:09 -0800
commite28dedbbe3eb8743d9351634dc7e44a1576c06c4 (patch)
treee5904f95c6d3d822b3d04cc45dfaeb4352272690 /docs
parent73710416b4764a13357b4e8602df8dc89684fbd8 (diff)
downloadnextpnr-e28dedbbe3eb8743d9351634dc7e44a1576c06c4.tar.gz
nextpnr-e28dedbbe3eb8743d9351634dc7e44a1576c06c4.tar.bz2
nextpnr-e28dedbbe3eb8743d9351634dc7e44a1576c06c4.zip
Update docs.
Signed-off-by: Keith Rothman <537074+litghost@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/netlist.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/netlist.md b/docs/netlist.md
index 763f7d40..2e989a33 100644
--- a/docs/netlist.md
+++ b/docs/netlist.md
@@ -52,6 +52,7 @@ Relevant fields from a netlist point of view are:
- `nets` is a map from net name to a `unique_ptr<NetInfo>` containing net data
- `net_aliases` maps every alias for a net to its canonical name (i.e. index into `nets`) - net aliases often occur when a net has a name both inside a submodule and higher level module
- `ports` is a list of top level ports, primarily used during JSON export (e.g. to produce a useful post-PnR simulation model). Unlike other ports, top level ports are _not_ added to the driver or users of any connected net. In this sense, nets connected to top-level ports are _dangling_. However, top level ports _can_ still see their connected net as part of their `PortInfo`.
+ - `port_cells` is a map of top level port cells. This is a subset of the `cells` maps containing only ports.
Context also has a method `check()` that ensures all of the contracts met above are satisfied. It is strongly suggested to run this after any pass that may modify the netlist.