diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/archapi.md | 8 | ||||
| -rw-r--r-- | docs/netlist.md | 1 |
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/archapi.md b/docs/archapi.md index 2a38502c..0f0e6181 100644 --- a/docs/archapi.md +++ b/docs/archapi.md @@ -226,6 +226,12 @@ Return a list of all bels on the device. Return the type of a given bel. +### bool getBelHidden(BelId bel) const + +Should this bel be hidden from utilities? + +*BaseArch default: returns false* + ### BelAttrsRangeT getBelAttrs(BelId bel) const Return the attributes for that bel. Bel attributes are only informal. They are displayed by the GUI but are otherwise @@ -574,7 +580,7 @@ Return the graphic elements that make up a decal. The same decal must always produce the same list. If the graphics for a design element changes, that element must return another decal. -*BaseArch default: asserts false as unreachable due to there being no decals* +*BaseArch default: returns default-constructed range* ### DecalXY getBelDecal(BelId bel) const 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. |