From 603b60da8dcadf23eec8609ffc128f8f191c1122 Mon Sep 17 00:00:00 2001 From: gatecat Date: Wed, 7 Dec 2022 10:27:58 +0100 Subject: api: add explain_invalid option to isBelLocationValid Signed-off-by: gatecat --- docs/archapi.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'docs/archapi.md') 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 -- cgit v1.2.3