diff options
author | William D. Jones <thor0505@comcast.net> | 2020-11-24 14:30:30 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-24 14:30:30 -0500 |
commit | 996b4100b9f33696e8c2771b62dab591efd171de (patch) | |
tree | ae851375354139adc7d039984bd082553413f3ee /docs | |
parent | 6514471a3bec65a45822cb2715022fc0bd80c452 (diff) | |
download | nextpnr-996b4100b9f33696e8c2771b62dab591efd171de.tar.gz nextpnr-996b4100b9f33696e8c2771b62dab591efd171de.tar.bz2 nextpnr-996b4100b9f33696e8c2771b62dab591efd171de.zip |
Update netlist.md
Add information about how top-level ports and connected nets differ from other ports and nets.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/netlist.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/netlist.md b/docs/netlist.md index 3953241e..763f7d40 100644 --- a/docs/netlist.md +++ b/docs/netlist.md @@ -51,7 +51,7 @@ Relevant fields from a netlist point of view are: - `cells` is a map from cell name to a `unique_ptr<CellInfo>` containing cell data - `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) + - `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`. 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. |