caiyu/nextpnr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update archapi.md with IdStringList

Browse Source 
Signed-off-by: D. Shah <dave@ds0.me>
This commit is contained in:
D. Shah 2021-01-29 13:03:11 +00:00
parent 9388df19d3
commit 9614d37229
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/archapi.md
View File

@ -106,11 +106,11 @@ Get list of cell types that this architecture accepts.
Bel Methods Bel Methods
----------- -----------
### BelId getBelByName(IdString name) const ### BelId getBelByName(IdStringList name) const
Lookup a bel by its name. Lookup a bel by its name, which is a list of IdStrings joined by `getNameDelimiter()`.
### IdString getBelName(BelId bel) const ### IdStringList getBelName(BelId bel) const
Get the name for a bel. (Bel names must be unique.) Get the name for a bel. (Bel names must be unique.)
@ -186,11 +186,11 @@ Return a list of all pins on that bel.
Wire Methods Wire Methods
------------ ------------
### WireId getWireByName(IdString name) const ### WireId getWireByName(IdStringList name) const
Lookup a wire by its name. Lookup a wire by its name, which is a list of IdStrings joined by `getNameDelimiter()`.
### IdString getWireName(WireId wire) const ### IdStringList getWireName(WireId wire) const
Get the name for a wire. (Wire names must be unique.) Get the name for a wire. (Wire names must be unique.)
@ -262,11 +262,11 @@ of the bounds is almost always better than an under-estimate.
Pip Methods Pip Methods
----------- -----------
### PipId getPipByName(IdString name) const ### PipId getPipByName(IdStringList name) const
Lookup a pip by its name. Lookup a pip by its name, which is a list of IdStrings joined by `getNameDelimiter()`.
### IdString getPipName(PipId pip) const ### IdStringList getPipName(PipId pip) const
Get the name for a pip. (Pip names must be unique.) Get the name for a pip. (Pip names must be unique.)
@ -353,11 +353,11 @@ Get all pips uphill of a wire, i.e. pips that use this wire as destination wire.
Group Methods Group Methods
------------- -------------
### GroupId getGroupByName(IdString name) const ### GroupId getGroupByName(IdStringList name) const
Lookup a group by its name. Lookup a group by its name, which is a list of IdStrings joined by `getNameDelimiter()`.
### IdString getGroupName(GroupId group) const ### IdStringList getGroupName(GroupId group) const
Get the name for a group. (Group names must be unique.) Get the name for a group. (Group names must be unique.)