aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClifford Wolf <clifford@clifford.at>2018-11-11 11:34:38 +0100
committerClifford Wolf <clifford@clifford.at>2018-11-11 11:34:38 +0100
commitd2bdb670c0be9e18722f79c170fc99d7f41768f1 (patch)
treec699864e888a9755e6a3f1aa958b8953e638e5f3 /docs
parent285bffeac5ace1679489c2d23c8c5dc4b06f0bfc (diff)
downloadnextpnr-d2bdb670c0be9e18722f79c170fc99d7f41768f1.tar.gz
nextpnr-d2bdb670c0be9e18722f79c170fc99d7f41768f1.tar.bz2
nextpnr-d2bdb670c0be9e18722f79c170fc99d7f41768f1.zip
Add getConflictingPipWire() arch API, router1 improvements
Signed-off-by: Clifford Wolf <clifford@clifford.at>
Diffstat (limited to 'docs')
-rw-r--r--docs/archapi.md24
1 files changed, 17 insertions, 7 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index 73443c15..1bfb7c5c 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -217,12 +217,12 @@ Return the net a wire is bound to.
### NetInfo \*getConflictingWireNet(WireId wire) const
-If this returns a non-nullptr, then unbinding that net
+If this returns a non-nullptr, then unbinding the wire from that net
will make the given wire available.
This returns nullptr if the wire is already available,
-or if there is no single net that can be unbound to make this
-wire available.
+or if there is no net that can be unbound from the wire to make it
+available.
### DelayInfo getWireDelay(WireId wire) const
@@ -289,11 +289,21 @@ Return the net this pip is bound to.
### NetInfo \*getConflictingPipNet(PipId pip) const
Return the net that needs to be unbound in order to make this
-pip available.
+pip available. Note that it may be neccessary to unroute that
+entire net to make the pip available.
-This does not need to (but may) return the conflicting wire if the conflict is
-limited to the conflicting wire being bound to the destination wire for this
-pip.
+This returns nullptr if the pip is already available,
+or if there is no single net that can be unrouted to make
+the pip available.
+
+### WireId getConflictingPipWire(PipId pip) const
+
+Return the single wire that needs to be unbound in order to make this pip
+available.
+
+This returns WireId() if the pip is already available,
+or if there is no single wire that can be unbound to make
+the pip available.
### const\_range\<PipId\> getPips() const