aboutsummaryrefslogtreecommitdiffstats
path: root/docs/archapi.md
diff options
context:
space:
mode:
authormyrtle <gatecat@ds0.me>2022-12-07 16:19:55 +0100
committerGitHub <noreply@github.com>2022-12-07 16:19:55 +0100
commit0eb53d59d84ea1c46de7d9e25eb5a9901544202d (patch)
treeaa7203b5b1064f327b863e7d4cb025b6292c55e4 /docs/archapi.md
parent519011533a3b7582b984226536cb424d462d1599 (diff)
parentdf99b4ff6c5ce88ce1a731dc8682ab1875b8c237 (diff)
downloadnextpnr-0eb53d59d84ea1c46de7d9e25eb5a9901544202d.tar.gz
nextpnr-0eb53d59d84ea1c46de7d9e25eb5a9901544202d.tar.bz2
nextpnr-0eb53d59d84ea1c46de7d9e25eb5a9901544202d.zip
Merge pull request #1059 from YosysHQ/gatecat/validity-errors
Add new option for verbose validity errors, use for ice40
Diffstat (limited to 'docs/archapi.md')
-rw-r--r--docs/archapi.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index 39b2a6a9..3a7994de 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -698,11 +698,15 @@ return the same value regardless if other cells are placed within the fabric.
*BaseArch default: returns `cell_type == getBelType(bel)`*
-### bool isBelLocationValid(BelId bel) const
+### bool isBelLocationValid(BelId bel, bool explain_invalid = false) const
Returns true if a bel in the current configuration is legal (for example,
a flipflop's clock signal is correctly shared with all bels in a slice.)
+If and only if `explain_invalid` is set to true, then a message using
+`log_nonfatal_error` should be printed explaining why the placement is invalid
+to the end user.
+
*BaseArch default: returns true*
### static const std::string defaultPlacer