aboutsummaryrefslogtreecommitdiffstats
path: root/docs/archapi.md
diff options
context:
space:
mode:
authorClifford Wolf <clifford@clifford.at>2018-08-01 11:38:41 +0200
committerClifford Wolf <clifford@clifford.at>2018-08-01 11:38:41 +0200
commitad8dc2e00123d9c651a1b9fa2ee7cc8ceeb470a1 (patch)
tree30c03eb7ecfbaceccbadead07cf2f2d5ecfd18e3 /docs/archapi.md
parent0038fe268e042fd6af0180a67bf1b584063b99bd (diff)
downloadnextpnr-ad8dc2e00123d9c651a1b9fa2ee7cc8ceeb470a1.tar.gz
nextpnr-ad8dc2e00123d9c651a1b9fa2ee7cc8ceeb470a1.tar.bz2
nextpnr-ad8dc2e00123d9c651a1b9fa2ee7cc8ceeb470a1.zip
Update archapi.md
Signed-off-by: Clifford Wolf <clifford@clifford.at>
Diffstat (limited to 'docs/archapi.md')
-rw-r--r--docs/archapi.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index 869903e0..0d910f9e 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -367,7 +367,7 @@ Delay Methods
### delay\_t estimateDelay(WireId src, WireId dst) const
-Return an estimate for the total `maxDelay()` delay from the given src wire to
+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`.
@@ -378,6 +378,11 @@ 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").
+### delay\_t predictDelay(const NetInfo \*net\_info, const PortRef &sink) const
+
+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.
+
### delay\_t getDelayEpsilon() const
Return a small delay value that can be used as small epsilon during routing.
@@ -397,6 +402,10 @@ Convert an `delay_t` to an actual real-world delay in nanoseconds.
Convert a `delay_t` to an integer for checksum calculations.
+### delay\_t getBudgetOverride(const NetInfo \*net\_info, const PortRef &sink, delay\_t budget) const
+
+Overwrite or modify the timing budget for a given arc. Returns the new budget.
+
Flow Methods
------------