aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKeith Rothman <537074+litghost@users.noreply.github.com>2021-03-18 16:31:40 -0700
committerKeith Rothman <537074+litghost@users.noreply.github.com>2021-03-22 09:17:55 -0700
commite7d81913a48bffd970f7a92acc44eb36d9f996f7 (patch)
tree93704cb3edc4497651e23adfb7d6541eab1bb907 /docs
parent53ed6979a964f3eaaabc0d97399eec9b4c3347f9 (diff)
downloadnextpnr-e7d81913a48bffd970f7a92acc44eb36d9f996f7.tar.gz
nextpnr-e7d81913a48bffd970f7a92acc44eb36d9f996f7.tar.bz2
nextpnr-e7d81913a48bffd970f7a92acc44eb36d9f996f7.zip
Add "checkPipAvailForNet" to Arch API.
This is important for distiguishing valid pseudo pips in the FPGA interchange arch. This also avoids a double or triple lookup of pip->net map. Signed-off-by: Keith Rothman <537074+litghost@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/archapi.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index 3131ae64..d164e61c 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -398,6 +398,13 @@ pip to a net.
*BaseArch default: returns `getBoundPipNet(pip) == nullptr`*
+### bool checkPipAvailForNet(PipId pip, NetInfo *net) const
+
+Returns true if the given pip is available to be bound to a net, or if the
+pip is already bound to that net.
+
+*BaseArch default: returns `getBoundPipNet(pip) == nullptr || getBoundPipNet(pip) == net`*
+
### NetInfo \*getBoundPipNet(PipId pip) const
Return the net this pip is bound to.