Skip to content

Commit 9b24467

Browse files
oharboeclaude
andcommitted
docs: update bazel-orfs.md with metric update and eqy sections
Add documentation for updating metric thresholds via _update targets and the EQUIVALENCE_CHECK/RUN_EQY separation. Update status to reflect all 8 asap7 designs passing. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
1 parent 2e6abbf commit 9b24467

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

bazel-orfs.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is an early integration of [bazel-orfs](https://github.com/The-OpenROAD-Pro
44
into OpenROAD-flow-scripts. It lets you build ORFS designs with Bazel
55
using the same `config.mk` files you already have.
66

7-
**Status**: beta -- a handful of simple designs work end-to-end.
7+
**Status**: beta -- all 8 asap7 designs build and pass QoR tests.
88
The full patch set lives out-of-tree in `bazel-orfs/orfs/` to minimize
99
churn; this PR wires up the minimum needed for developers to kick the
1010
tires.
@@ -158,6 +158,27 @@ local_path_override(
158158
- **Parallel**: Independent designs build in parallel automatically.
159159
- **Reproducible**: Same inputs always produce the same outputs.
160160

161+
## Updating Metric Thresholds
162+
163+
When OpenROAD or flow scripts change, metric thresholds in
164+
`rules-base.json` may go stale. To update them for a specific design:
165+
166+
```bash
167+
# Rebuilds the design and writes updated thresholds back to source
168+
bazelisk run //flow/designs/asap7/aes-block:aes_cipher_top_update
169+
```
170+
171+
The target name follows the pattern `<design_name>_update` where
172+
`<design_name>` comes from `DESIGN_NAME` in `config.mk`.
173+
174+
## Equivalence Checking (eqy)
175+
176+
Some designs (e.g. `aes`) set `EQUIVALENCE_CHECK=1` in their
177+
`config.mk` to enable equivalence checking of repair_timing. The
178+
actual `eqy` tool invocation is gated by a separate `RUN_EQY`
179+
variable (default 0), so builds don't fail when eqy is not installed.
180+
CI sets `RUN_EQY=1` when eqy is available.
181+
161182
## Known Limitations
162183

163184
- Only asap7 and sky130hd PDKs are wired up (others can be added to

0 commit comments

Comments
 (0)