From d2007a386c1a2db7917d7048ea6206ae1218d141 Mon Sep 17 00:00:00 2001
From: gatecat <gatecat@ds0.me>
Date: Thu, 29 Jul 2021 12:52:33 +0100
Subject: common: Add JSON timing and utilisation report

Signed-off-by: gatecat <gatecat@ds0.me>
---
 docs/report.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 docs/report.md

(limited to 'docs')

diff --git a/docs/report.md b/docs/report.md
new file mode 100644
index 00000000..a766bb3d
--- /dev/null
+++ b/docs/report.md
@@ -0,0 +1,22 @@
+# JSON Reports
+
+nextpnr can write a JSON report using `--report` post-place-and-route for integration with other build systems. It contains information on post-pack utilization and maximum achieved frequency for each clock domain, and is of the following format:
+
+```
+{
+    "utilization": {
+        <beltype>: {
+            "used": <number of bels used in design>,
+            "available": <total number of bels available in device>
+        }, 
+        ...
+    },
+    "fmax": {
+        <clock domain>: {
+            "achieved": <computed Fmax of routed design for clock in MHz>,
+            "constraint": <constraint for clock in MHz>
+        },
+        ...
+    }
+}
+```
-- 
cgit v1.2.3