aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKeith Rothman <537074+litghost@users.noreply.github.com>2021-01-28 16:48:22 -0800
committerKeith Rothman <537074+litghost@users.noreply.github.com>2021-02-02 07:34:56 -0800
commitb4160c228e789639dc9f434100976c5eb1f95d8d (patch)
tree7a17215b2435a7a9531f1436bffc9b518e91f752 /docs
parentf3a7c691a317fafd48b9142ff0c688e75bbb6424 (diff)
downloadnextpnr-b4160c228e789639dc9f434100976c5eb1f95d8d.tar.gz
nextpnr-b4160c228e789639dc9f434100976c5eb1f95d8d.tar.bz2
nextpnr-b4160c228e789639dc9f434100976c5eb1f95d8d.zip
Add archcheck for partition methods.
Signed-off-by: Keith Rothman <537074+litghost@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/archapi.md23
1 files changed, 20 insertions, 3 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index 3a0efcce..53132bd9 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -88,6 +88,14 @@ Get Z dimension for the specified tile for bels. All bels with at specified X an
Get Z dimension for the specified tile for pips. All pips with at specified X and Y coordinates must have a Z coordinate in the range `0 .. getTileDimZ(X,Y)-1` (inclusive).
+Cell Methods
+-----------
+
+### const\_range\<IdString\> getCellTypes() const
+
+Get list of cell types that this architecture accepts.
+
+
Bel Methods
-----------
@@ -478,8 +486,8 @@ information for all edges. `index` must be in [0, clockInfoCount), behaviour is
Partition Methods
-----------------
-Partitions are used by analytic placement to seperate types of BELs during
-placement. Typical partitions are:
+Partitions are subsets of BelIds and cell types used by analytic placement to
+seperate types of BELs during placement. Typical partitions are:
- All LUT BELs
- All FF BELs
- All multipliers BELs
@@ -487,7 +495,8 @@ placement. Typical partitions are:
- etc.
The general rule here is to include all BELs that are roughly interchangable
-during placement.
+during placement. Partitions should form an exact cover over all BelIds and
+cell types.
### const\_range\<PartitionId\> getPartitions() const
@@ -497,8 +506,16 @@ Return a list of all partitions on the device.
Return the name of the partition.
+### PartitionId getPartitionByName(IdString partition\_name) const
+
+Return the partition for the specified partition name.
+
### PartitionId getPartitionForBel(BelId bel) const
+Returns the partition for a particular BEL.
+
+### PartitionId getPartitionForCell(IdString cell\_type) const
+
Returns the partition for a particular cell type.
### const\_range\<BelId\> getBelsForPartition(PartitionId partition) const