aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/archapi.md6
-rw-r--r--docs/viaduct.md2
2 files changed, 6 insertions, 2 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
diff --git a/docs/viaduct.md b/docs/viaduct.md
index a59310f1..88398a05 100644
--- a/docs/viaduct.md
+++ b/docs/viaduct.md
@@ -64,7 +64,7 @@ X(F)
```c++
bool checkBelAvail(BelId bel) const;
bool isValidBelForCellType(IdString cell_type, BelId bel) const;
-bool isBelLocationValid(BelId bel) const;
+bool isBelLocationValid(BelId bel, bool explain_invalid = false) const;
bool checkWireAvail(WireId wire) const;
bool checkPipAvail(PipId pip) const;
bool checkPipAvailForNet(PipId pip, NetInfo *net) const;