RouteRTL Documentation
This index mirrors the documentation navigation. Use the left pane to move between the same sections shown here: reference material, tutorials and guides, and simulation APIs.
Reference
| Document | Scope |
|---|---|
| Dependency Resolver | Source ordering, hierarchy resolution, and dependency graph behavior. |
| FAQ | Common RouteRTL usage questions and short answers. |
| FPGA-Friendly RTL Rule Catalog | Lint profiles and hardware-oriented rule families. |
| IP Manifest Reference | ip.yml fields for local IPs, packaged IP, simulation, and synthesis. |
| JSON Output Contract | Machine-readable output contracts for agent and CI integrations. |
| Linter Pipeline | Smart linter phases, cached artifacts, and diagnostic flow. |
| Pre-Commit Quality Gate | How pre-commit decides which lint and simulation checks to run. |
| project.yml Reference | Project and target YAML fields consumed by rr. |
| Reference Design Manifest | ref_design.yml structure for published reference projects. |
| SDK Behavior Contract | Expected behavior for core SDK commands and compatibility paths. |
| SDK User Guide | Broad command guide for project, simulation, synthesis, Docker, and reporting flows. |
| Simulator Backends | Simulator lifecycle, process handling, and backend details. |
| Three-Register Architecture | Registry model for IPs, rules, and reference designs. |
| Troubleshooting | Failure modes, diagnostics, and recovery commands. |
Start here
| Document | Scope |
|---|---|
| Contract-first verification | Protocol contracts, the install-to-gate workflow, and MCP tools. |
Tutorials & Guides
| Document | Scope |
|---|---|
| Assert Quality | Requirement tagging and assertion coverage quality. |
| cocotb Quickstart | First cocotb tests under the RouteRTL simulation runner. |
| Conformance Monitor Hunt | Monitor-driven verification workflow. |
| Contract-First Walkthrough | Requirements, generated tests, coverage mapping, and IP-level checks. |
| Docker Workflow | Docker-backed EDA environments and command execution. |
| Driver Cookbook | Practical driver recipes for common bus and peripheral tests. |
| Existing Project Migration | Bringing an existing FPGA project under RouteRTL. |
| First Steps Tutorial | Guided first project from install through simulation. |
| Formal Properties | PSL/SVA usage and contract-oriented formal checks. |
| Hook Authoring | Project hooks around vendor project generation. |
| Project Initialization | rr init options, templates, and generated project layout. |
| Installation | Platform setup, Python requirements, completion, and tool checks. |
| Package Quality | Publish requirements, semver rules, and registry metadata signals. |
| Packaging VHDL-2019 IP | Wrapper strategy for VHDL-2019 IP packaging constraints. |
| JTAG Cable Confinement | Hardware lease confinement and cable safety. |
| MCP Server | Installing and using the RouteRTL MCP server with coding agents. |
| Migration from RapidRTL | Legacy migration notes and command replacements. |
| Migration Workflow | rr migrate flow for vendor project imports. |
| Plugin Development | Extending the routertl command surface through plugins. |
| Pre-Commit Guide | Local hook setup and project-level quality checks. |
| Reference Designs | Template and reference-design entry points. |
| Strict BFM Monitors | Monitor discipline for verification agents. |
| Guide Library | Compact index for guide-oriented docs. |
API Reference
| Document | Scope |
|---|---|
| API Overview | Simulation API entry points. |
| Testbench Environment | TbEnv clock, reset, logging, and monitor helpers. |
| Run Simulation | run_simulation() reference. |
| Avalon-MM Driver | Avalon memory-mapped test driver. |
| AXI-Lite Driver | AXI-Lite master/slave driver. |
| AXI4 Driver | AXI4 full-interface driver. |
| I2C Driver | I2C master test driver. |
| Native Memory Driver | Direct native memory interface. |
| SPI Driver | SPI master driver. |
| UART Driver | UART transmitter and receiver helpers. |