aboutsummaryrefslogtreecommitdiffstats
path: root/docs/archapi.md
diff options
context:
space:
mode:
authorD. Shah <dave@ds0.me>2021-02-05 18:41:35 +0000
committerD. Shah <dave@ds0.me>2021-02-05 19:19:17 +0000
commit3e631fe2f415adeb0205eff866aaea74b8ef3ed8 (patch)
tree70ef50fa3499ebdbfcd30515c2b889f556084774 /docs/archapi.md
parent6575bfac3ec6cbf38f4525f997f07ccbaaa043f9 (diff)
downloadnextpnr-3e631fe2f415adeb0205eff866aaea74b8ef3ed8.tar.gz
nextpnr-3e631fe2f415adeb0205eff866aaea74b8ef3ed8.tar.bz2
nextpnr-3e631fe2f415adeb0205eff866aaea74b8ef3ed8.zip
Add archArgs and archArgsToId to Arch API
Signed-off-by: D. Shah <dave@ds0.me>
Diffstat (limited to 'docs/archapi.md')
-rw-r--r--docs/archapi.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index e3c06efd..0cd6632c 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -74,7 +74,15 @@ Constructor. ArchArgs is a architecture-specific type (usually a struct also def
### std::string getChipName() const
-Return a string representation of the ArchArgs that was used to construct this object.
+Return a user-friendly string representation of the ArchArgs that was used to construct this object.
+
+### ArchArgs archArgs() const
+
+Return the `ArchArgs` used to construct this object.
+
+### IdString archArgsToId(ArchArgs args) const
+
+Return an internal IdString representation of the ArchArgs that was used to construct this object.
### int getGridDimX() const