aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorgatecat <gatecat@ds0.me>2021-04-28 15:43:02 +0100
committergatecat <gatecat@ds0.me>2021-05-06 11:47:07 +0100
commit14863bc04e062e306e783f2f05232c6e922a3b8f (patch)
treeeaa379edbf8bf307dbb22a182cdc93d3b1f5a237 /docs
parent6a3eacddd60713d9c0d470d13a54a0c42f7d87c9 (diff)
downloadnextpnr-14863bc04e062e306e783f2f05232c6e922a3b8f.tar.gz
nextpnr-14863bc04e062e306e783f2f05232c6e922a3b8f.tar.bz2
nextpnr-14863bc04e062e306e783f2f05232c6e922a3b8f.zip
Update placers to use new cluster APIs
Signed-off-by: gatecat <gatecat@ds0.me>
Diffstat (limited to 'docs')
-rw-r--r--docs/archapi.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index 45d77007..6d17f01a 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -736,13 +736,13 @@ Gets the root cell of a cluster, which is used as a datum point when placing the
Gets an approximate bounding box of the cluster. This is intended for area allocation in the placer and is permitted to occasionally give incorrect estimates, for example due to irregularities in the fabric depending on cluster placement. `getClusterPlacement` should always be used to get exact locations.
-### Loc getClusterOffset(CellInfo \*cell) const
+### Loc getClusterOffset(const CellInfo \*cell) const
Gets the approximate offset of a cell within its cluster, relative to the root cell. This is intended for global placement usage and is permitted to occasionally give incorrect estimates, for example due to irregularities in the fabric depending on cluster placement. `getClusterPlacement` should always be used to get exact locations.
The returned x and y coordinates, when added to the root location of the cluster, should give an approximate location where `cell` will end up placed at.
-### bool isClusterStrict(CellInfo *cell) const
+### bool isClusterStrict(const CellInfo *cell) const
Returns `true` if the cell **must** be placed according to the cluster; for example typical carry chains, and dedicated IO routing. Returns `false` if the cell can be split from the cluster if placement desires, at the expense of a less optimal result (for example dedicated LUT-FF paths where general routing can also be used).