aboutsummaryrefslogtreecommitdiffstats
path: root/docs/archapi.md
diff options
context:
space:
mode:
authorDavid Shah <davey1576@gmail.com>2018-08-08 17:58:25 +0200
committerDavid Shah <davey1576@gmail.com>2018-08-08 17:58:25 +0200
commit674cabb6bea05032c8bd7e638684ac7f6e448a6b (patch)
tree65d78e44d5dcf300120b8a9c865b2b43a216011f /docs/archapi.md
parent3e11ba8afb332909ee40760a222b2d2b56bc3232 (diff)
downloadnextpnr-674cabb6bea05032c8bd7e638684ac7f6e448a6b.tar.gz
nextpnr-674cabb6bea05032c8bd7e638684ac7f6e448a6b.tar.bz2
nextpnr-674cabb6bea05032c8bd7e638684ac7f6e448a6b.zip
docs: Update Arch API Cell Timing docs
Signed-off-by: David Shah <davey1576@gmail.com>
Diffstat (limited to 'docs/archapi.md')
-rw-r--r--docs/archapi.md10
1 files changed, 4 insertions, 6 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index 222b9f78..3a2b5efb 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -455,13 +455,11 @@ Cell Delay Methods
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`.
-### IdString getPortClock(const CellInfo \*cell, IdString port) const
+### TimingPortClass getPortTimingClass(const CellInfo *cell, IdString port, IdString &clockPort) const
-Returns the clock input port for the specified output port.
-
-### bool isClockPort(const CellInfo \*cell, IdString port) const
-
-Returns true if the specified port is a clock input.
+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, clockPort is set
+to the associated clock port.
Placer Methods
--------------