Each architecture must implement the following types and APIs.
The syntax const_range<T> is used to denote anything that has a begin() and end() method that return const forward iterators. This can be a std::list<T>, std::vector<T>, a (const) reference to those, or anything else that behaves in a similar way.
The architecture-specific archdefs.h must define the following types.
With the exception of ArchNetInfo and ArchCellInfo, the following types should be "lightweight" enough so that passing them by value is sensible.
A scalar type that is used to represent delays. May be an integer or float type.
A struct representing the delay across a timing arc. Must provide a + operator for getting the combined delay of two arcs, and the following methods to access concrete timings:
delay_t minRaiseDelay() const { return delay; }
delay_t maxRaiseDelay() const { return delay; }
delay_t minFallDelay() const { return delay; }
delay_t maxFallDelay() const { return delay; }
delay_t minDelay() const { return delay; }
delay_t maxDelay() const { return delay; }
A type representing a bel name. BelId() must construct a unique null-value. Must provide ==, !=, and < operators and a specialization for std::hash<BelId>.
A type representing a wire name. WireId() must construct a unique null-value. Must provide ==, !=, and < operators and a specialization for std::hash<WireId>.
A type representing a pip name. PipId() must construct a unique null-value. Must provide ==, !=, and < operators and a specialization for std::hash<PipId>.
A type representing a group name. GroupId() must construct a unique null-value. Must provide == and != operators and a specialization for std::hash<GroupId>.
A type representing a reference to a graphical decal. DecalId() must construct a unique null-value. Must provide == and != operators and a specialization for std::hash<DecalId>.
The global NetInfo type derives from this one. Can be used to add arch-specific data (caches of information derived from wire attributes, bound wires and pips, and other net state). Must be declared as empty struct if unused.
The global CellInfo type derives from this one. Can be used to add arch-specific data (caches of information derived from cell attributes and parameters, bound bel, and other cell state). Must be declared as empty struct if unused.
Each architecture must provide their own implementation of the Arch struct in arch.h. Arch must derive from BaseCtx and must provide the following methods:
Constructor. ArchArgs is a architecture-specific type (usually a struct also defined in arch.h).
Return a string representation of the ArchArgs that was used to construct this object.
Get grid X dimension. All bels and pips must have Y coordinates in the range 0 .. getGridDimX()-1 (inclusive).
Get grid Y dimension. All bels and pips must have Y coordinates in the range 0 .. getGridDimY()-1 (inclusive).
Get Z dimension for the specified tile for bels. All bels with at specified X and Y coordinates must have a Z coordinate in the range 0 .. getTileDimZ(X,Y)-1 (inclusive).
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).
Lookup a bel by its name.
Get the name for a bel. (Bel names must be unique.)
Get the X/Y/Z location of a given bel. Each bel must have a unique X/Y/Z location.
Lookup a bel by its X/Y/Z location.
Return a list of all bels at the give X/Y location.
Returns true if the given bel is a global buffer. A global buffer does not "pull in" other cells it drives to be close to the location of the global buffer.
Return a (preferably unique) number that represents this bel. This is used in design state checksum calculations.
Bind a given bel to a given cell with the given strength.
This method must also update cell->bel and cell->belStrength.
Unbind a bel.
This method must also update CellInfo::bel and CellInfo::belStrength.
Returns true if the bel is available. A bel can be unavailable because it is bound, or because it is exclusive to some other resource that is bound.
Return the cell the given bel is bound to, or nullptr if the bel is not bound.
If the bel is unavailable, and unbinding a single cell would make it available, then this method must return that cell.
Return a list of all bels on the device.
Return the type of a given bel.
Return the attributes for that bel. Bel attributes are only informal. They are displayed by the GUI but are otherwise unused. An implementation may simply return an empty range.
Return the wire connected to the given bel pin.
Return the type (input/output/inout) of the given bel pin.
Return a list of all pins on that bel.
Lookup a wire by its name.
Get the name for a wire. (Wire names must be unique.)
Get the type of a wire. The wire type is purely informal and
isn't used by any of the core algorithms. Implementations may
simply return IdString().
Return the attributes for that wire. Wire attributes are only informal. They are displayed by the GUI but are otherwise unused. An implementation may simply return an empty range.
Return a (preferably unique) number that represents this wire. This is used in design state checksum calculations.
Bind a wire to a net. This method must be used when binding a wire that is driven by a bel pin. Use binPip()
when binding a wire that is driven by a pip.
This method must also update net->wires.
Unbind a wire. For wires that are driven by a pip, this will also unbind the driving pip.
This method must also update NetInfo::wires.
Return true if the wire is available, i.e. can be bound to a net.
Return the net a wire is bound to.
If this returns a non-WireId(), then unbinding that wire will make the given wire available.
If this returns a non-nullptr, then unbinding that entire net will make the given wire available.
Get the delay for a wire.
Get a list of all wires on the device.
Get a list of all bel pins attached to a given wire.
Lookup a pip by its name.
Get the name for a pip. (Pip names must be unique.)
Get the type of a pip. Pip types are purely informal and
implementations may simply return IdString().
Return the attributes for that pip. Pip attributes are only informal. They are displayed by the GUI but are otherwise unused. An implementation may simply return an empty range.
Get the X/Y/Z location of a given pip. Pip locations do not need to be unique, and in most cases they aren't. So for pips a X/Y/Z location refers to a group of pips, not an individual pip.
Return a (preferably unique) number that represents this pip. This is used in design state checksum calculations.
Bid a pip to a net. This also bind the destination wire of that pip.
This method must also update net->wires.
Unbind a pip and the wire driven by that pip.
This method must also update NetInfo::wires.
Returns true if the given pip is available to be bound to a net.
Users must also check if the pip destination wire is available
with checkWireAvail(getPipDstWire(pip)) before binding the
pip to a net.
Return the net this pip is bound to.
If this returns a non-WireId(), then unbinding that wire will make the given pip available.
If this returns a non-nullptr, then unbinding that entire net will make the given pip available.
Return a list of all pips on the device.
Get the source wire for a pip.
Get the destination wire for a pip.
Bi-directional switches (transfer gates) are modelled using two antiparallel pips.
Get the delay for a pip.
Get all pips downhill of a wire, i.e. pips that use this wire as source wire.
Get all pips uphill of a wire, i.e. pips that use this wire as destination wire.
Get all alias pips downhill of a wire.
There is no api for getting the alias pips uphill of a wire.
Alias pips come in antiparallel pairs if a signal can be injected on either side of the alias pip.
Lookup a group by its name.
Get the name for a group. (Group names must be unique.)
Get a list of all groups on the device.
Get a list of all bels within a group.
Get a list of all wires within a group.
Get a list of all pips within a group.
Get a list of all groups within a group.
Return a rough estimate for the total maxDelay() delay from the given src wire to
the given dst wire.
This should return a low upper bound for the fastest route from src to dst.
Or in other words it should assume an otherwise unused chip (thus "fastest route"). But it only produces an estimate for that fastest route, not an exact result, and for that estimate it is considered more accaptable to return a slightly too high result and it is considered less accaptable to return a too low result (thus "low upper bound").
Return a reasonably good estimate for the total maxDelay() delay for the
given arc. This should return a low upper bound for the fastest route for that arc.
Return a small delay value that can be used as small epsilon during routing. The router will for example not re-calculate cached routing data if faster routes are found when the difference is smaller than this value.
The base penality when calculating delay penalty for ripping up routed nets. The actual penalty used is a multiple of this value (i.e. a weighted version of this value).
Convert an delay_t to an actual real-world delay in nanoseconds.
Convert a real-world delay in nanoseconds to a DelayInfo with equal min/max rising/falling values.
Convert a delay_t to an integer for checksum calculations.
Overwrite or modify (in-place) the timing budget for a given arc. Returns a bool to indicate whether this was done.
Run the packer.
Run the placer.
run the router.
Return the graphic elements that make up a decal.
The same decal must always produce the same list. If the graphics for a design element changes, that element must return another decal.
Return the decal and X/Y position for the graphics representing a bel.
Return the decal and X/Y position for the graphics representing a wire.
Return the decal and X/Y position for the graphics representing a pip.
Return the decal and X/Y position for the graphics representing a group.
Returns the delay for the specified path through a cell in the &delay argument. The method returns
false if there is no timing relationship from fromPort to toPort.
Return the timing port class of a port. This can be a register or combinational input or output; clock input or output; general startpoint or endpoint; or a port ignored for timing purposes. For register ports, clockInfoCount is set to the number of associated clock edges that can be queried by getPortClockingInfo.
Return the clocking info (including port name of clock, clock polarity and setup/hold/clock-to-out times) of a
port. Where ports have more than one clock edge associated with them (such as DDR outputs), index can be used to obtain
information for all edges. index must be in [0, clockInfoCount), behaviour is undefined otherwise.
Returns true if the given cell can be bound to the given bel, considering other bound resources. For example, this can be used if there is only a certain number of different clock signals allowed for a group of bels.
Returns true if a bell in the current configuration is valid, i.e. if
isValidBelForCell() would return true for the current mapping.
Name of the default placement algorithm for the architecture, if
--placer isn't specified on the command line.
Name of available placer algorithms for the architecture, used
to provide help for and validate --placer.