diff options
| author | Clifford Wolf <clifford@clifford.at> | 2018-08-08 19:36:05 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-08-08 19:36:05 +0200 |
| commit | b326b03a5261a824f428fe0811a5376c8758b929 (patch) | |
| tree | a13673a636ddbea3b5fd5585e3bb109b56b69435 /docs | |
| parent | cd4e761bb799ca99f02d3aa177961af28a93f2d8 (diff) | |
| parent | f6189e4677c7bdaeaa5b9b796a67d750e6c7d49d (diff) | |
| download | nextpnr-b326b03a5261a824f428fe0811a5376c8758b929.tar.gz nextpnr-b326b03a5261a824f428fe0811a5376c8758b929.tar.bz2 nextpnr-b326b03a5261a824f428fe0811a5376c8758b929.zip | |
Merge pull request #45 from YosysHQ/constids
Get rid of PortPin and BelType
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/archapi.md | 32 |
1 files changed, 4 insertions, 28 deletions
diff --git a/docs/archapi.md b/docs/archapi.md index 3a2b5efb..df2bc468 100644 --- a/docs/archapi.md +++ b/docs/archapi.md @@ -28,14 +28,6 @@ delay_t minDelay() const { return delay; } delay_t maxDelay() const { return delay; } ``` -### BelType - -A type representing a bel type name. `BelType()` must construct a unique null-value. Must provide `==` and `!=` operators and a specialization for `std::hash<BelType>`. - -### PortPin - -A type representing a port or pin name. `PortPin()` must construct a unique null-value. Must provide `==` and `!=` operators and a specialization for `std::hash<PortPin>`. - ### BelId A type representing a bel name. `BelId()` must construct a unique null-value. Must provide `==` and `!=` operators and a specialization for `std::hash<BelId>`. @@ -80,22 +72,6 @@ Constructor. ArchArgs is a architecture-specific type (usually a struct also def Return a string representation of the ArchArgs that was used to construct this object. -### IdString belTypeToId(BelType type) const - -Convert a `BelType` to an `IdString`. - -### IdString portPinToId(PortPin type) const - -Convert a `PortPin` to an `IdString`. - -### BelType belTypeFromId(IdString id) const - -Convert `IdString` to `BelType`. - -### PortPin portPinFromId(IdString id) const - -Convert `IdString` to `PortPin`. - ### int getGridDimX() const Get grid X dimension. All bels must have Y coordinates in the range `0 .. getGridDimX()-1` (inclusive). @@ -167,19 +143,19 @@ If the bel is unavailable, and unbinding a single cell would make it available, Return a list of all bels on the device. -### BelType getBelType(BelId bel) const +### IdString getBelType(BelId bel) const Return the type of a given bel. -### WireId getBelPinWire(BelId bel, PortPin pin) const +### WireId getBelPinWire(BelId bel, IdString pin) const Return the wire connected to the given bel pin. -### PortType getBelPinType(BelId bel, PortPin pin) const +### PortType getBelPinType(BelId bel, IdString pin) const Return the type (input/output/inout) of the given bel pin. -### const\_range\<PortPin\> getBelPins(BelId bel) const +### const\_range\<IdString\> getBelPins(BelId bel) const Return a list of all pins on that bel. |