# ucb-bar/chipyard architecture

> Architecture diagram of the GitHub repository ucb-bar/chipyard, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ucb-bar/chipyard
- Repository: https://github.com/ucb-bar/chipyard

## Overview

Chipyard is a Chisel-based framework for configuring and generating RISC-V SoCs, with supporting FPGA harnesses, FireSim simulation, and tapeout memory-macro compilation. The main workflow is configuration into a generated chip/system, then binding its ports and clocks to a simulation or FPGA harness. The README documents additional cores, accelerators, memory systems, and hardware flows, represented here at subsystem level where source was not sampled. Edges are limited to relationships shown in excerpts or documented in the README; unsampled subsystem wiring is not inferred.

Main entry points: [`generators/chipyard/src/main/scala/harness/HasHarnessInstantiators.scala`](https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/harness/HasHarnessInstantiators.scala) (Harness Instantiation), [`tools/tapeout/src/main/scala/macros/MacroCompiler.scala`](https://github.com/ucb-bar/chipyard/blob/main/tools/tapeout/src/main/scala/macros/MacroCompiler.scala) (Macro Compiler), [`generators/chipyard/src/main/scala/ChipTop.scala`](https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/ChipTop.scala) (Chip Top), [`generators/firechip/chip/src/main/scala/FireSim.scala`](https://github.com/ucb-bar/chipyard/blob/main/generators/firechip/chip/src/main/scala/FireSim.scala) (FireSim Harness)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_generation["SoC Generation"]
  node_configs["SoC Configurations"]
  node_cores_accels["Cores &amp; Accelerators"]
  node_system["Digital System<br/>[DigitalTop.scala]"]
  node_chip_top["Chip Top<br/>[ChipTop.scala]"]
  node_clocking["Clocking &amp; Reset"]
end

subgraph group_interfaces["Chip Interfaces"]
  node_io_binders["IO Binders<br/>[IOBinders.scala]"]
  node_io_cells["IO Cells<br/>[IOCell.scala]"]
  node_harness_inst["Harness Instantiation"]
  node_harness_binders["Harness Binders"]
end

subgraph group_simulation["FireSim"]
  node_firesim["FireSim Harness<br/>[FireSim.scala]"]
  node_bridge_interfaces["Bridge Interfaces<br/>[TileTraceIO.scala]"]
  node_bridge_stubs["Host Bridge Stubs<br/>[simplenic.cc]"]
  node_tsi_host["TSI Host Transport<br/>[firesim_tsi.cc]"]
end

subgraph group_fpga["FPGA Harnesses"]
  node_fpga_boards["FPGA Harnesses"]
  node_vc707_harness["VC707 Harness<br/>[TestHarness.scala]"]
  node_zcu104_harness["ZCU104 Harness<br/>[TestHarness.scala]"]
  node_board_binders["Board Binders"]
  node_sdboot["SD Boot Firmware<br/>[sd.c]"]
end

subgraph group_tapeout["Tapeout Macros"]
  node_macro_compiler["Macro Compiler"]
  node_cost_metric["Macro Cost Metrics<br/>[CostMetric.scala]"]
  node_synflops["Flop Mapping<br/>[SynFlopsPass.scala]"]
  node_macro_library["Memory Macro Library<br/>[SRAM.scala]"]
end

node_engineer(("SoC Designer"))
node_external_flows["Simulation &amp; VLSI Flows"]

node_engineer -->|"selects"| node_configs
node_configs -.->|"configures"| node_cores_accels
node_chip_top -->|"instantiates"| node_system
node_harness_inst -->|"builds"| node_chip_top
node_chip_top -->|"uses clock schemes"| node_clocking
node_io_binders -->|"generates cells"| node_io_cells
node_harness_inst -->|"applies binders"| node_harness_binders
node_firesim -->|"uses harness"| node_harness_inst
node_firesim -.->|"exposes bridges"| node_bridge_interfaces
node_bridge_stubs -->|"supports simulation"| node_external_flows
node_tsi_host -->|"supports simulation"| node_external_flows
node_fpga_boards -->|"supports FPGA simulation"| node_external_flows
node_vc707_harness -->|"instantiates chips"| node_harness_inst
node_zcu104_harness -->|"instantiates chips"| node_harness_inst
node_board_binders -->|"binds harness ports"| node_harness_inst
node_sdboot -.->|"boots board"| node_fpga_boards
node_macro_compiler -->|"uses cost metric"| node_cost_metric
node_macro_compiler -->|"runs mapping pass"| node_synflops
node_macro_compiler -.->|"compiles against"| node_macro_library
node_macro_compiler -->|"supports VLSI flow"| node_external_flows

click node_configs "https://github.com/ucb-bar/chipyard/tree/main/generators/chipyard/src/main/scala/config"
click node_cores_accels "https://github.com/ucb-bar/chipyard/tree/main/generators/chipyard/src/main/scala/config"
click node_system "https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/DigitalTop.scala"
click node_chip_top "https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/ChipTop.scala"
click node_clocking "https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/clocking/HasChipyardPRCI.scala"
click node_io_binders "https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/iobinders/IOBinders.scala"
click node_io_cells "https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/iocell/IOCell.scala"
click node_harness_inst "https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/harness/HasHarnessInstantiators.scala"
click node_harness_binders "https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/harness/HarnessBinders.scala"
click node_firesim "https://github.com/ucb-bar/chipyard/blob/main/generators/firechip/chip/src/main/scala/FireSim.scala"
click node_bridge_interfaces "https://github.com/ucb-bar/chipyard/blob/main/generators/firechip/bridgeinterfaces/src/main/scala/TileTraceIO.scala"
click node_bridge_stubs "https://github.com/ucb-bar/chipyard/blob/main/generators/firechip/bridgestubs/src/main/cc/bridges/simplenic.cc"
click node_tsi_host "https://github.com/ucb-bar/chipyard/blob/main/generators/firechip/bridgestubs/src/main/cc/fesvr/firesim_tsi.cc"
click node_fpga_boards "https://github.com/ucb-bar/chipyard/tree/main/fpga/src/main/scala"
click node_vc707_harness "https://github.com/ucb-bar/chipyard/blob/main/fpga/src/main/scala/vc707/TestHarness.scala"
click node_zcu104_harness "https://github.com/ucb-bar/chipyard/blob/main/fpga/src/main/scala/zcu104/TestHarness.scala"
click node_board_binders "https://github.com/ucb-bar/chipyard/blob/main/fpga/src/main/scala/arty100t/HarnessBinders.scala"
click node_sdboot "https://github.com/ucb-bar/chipyard/blob/main/fpga/src/main/resources/vcu118/sdboot/sd.c"
click node_macro_compiler "https://github.com/ucb-bar/chipyard/blob/main/tools/tapeout/src/main/scala/macros/MacroCompiler.scala"
click node_cost_metric "https://github.com/ucb-bar/chipyard/blob/main/tools/tapeout/src/main/scala/macros/CostMetric.scala"
click node_synflops "https://github.com/ucb-bar/chipyard/blob/main/tools/tapeout/src/main/scala/macros/SynFlopsPass.scala"
click node_macro_library "https://github.com/ucb-bar/chipyard/blob/main/tools/tapeout/src/main/scala/macrolib/SRAM.scala"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_configs,node_cores_accels,node_system,node_chip_top,node_clocking toneBlue
class node_io_binders,node_io_cells,node_harness_inst,node_harness_binders toneAmber
class node_firesim,node_bridge_interfaces,node_bridge_stubs,node_tsi_host toneMint
class node_fpga_boards,node_vc707_harness,node_zcu104_harness,node_board_binders,node_sdboot toneRose
class node_macro_compiler,node_cost_metric,node_synflops,node_macro_library,node_engineer,node_external_flows toneIndigo
```

## Components

### SoC Generation

- [SoC Configurations](https://github.com/ucb-bar/chipyard/tree/main/generators/chipyard/src/main/scala/config): `generators/chipyard/src/main/scala/config`
- [Cores & Accelerators](https://github.com/ucb-bar/chipyard/tree/main/generators/chipyard/src/main/scala/config): `generators/chipyard/src/main/scala/config`
- [Digital System](https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/DigitalTop.scala): `generators/chipyard/src/main/scala/DigitalTop.scala`
- [Chip Top](https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/ChipTop.scala): `generators/chipyard/src/main/scala/ChipTop.scala`
- [Clocking & Reset](https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/clocking/HasChipyardPRCI.scala): `generators/chipyard/src/main/scala/clocking/HasChipyardPRCI.scala`

### Chip Interfaces

- [IO Binders](https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/iobinders/IOBinders.scala): `generators/chipyard/src/main/scala/iobinders/IOBinders.scala`
- [IO Cells](https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/iocell/IOCell.scala): `generators/chipyard/src/main/scala/iocell/IOCell.scala`
- [Harness Instantiation](https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/harness/HasHarnessInstantiators.scala): `generators/chipyard/src/main/scala/harness/HasHarnessInstantiators.scala`
- [Harness Binders](https://github.com/ucb-bar/chipyard/blob/main/generators/chipyard/src/main/scala/harness/HarnessBinders.scala): `generators/chipyard/src/main/scala/harness/HarnessBinders.scala`

### FireSim

- [FireSim Harness](https://github.com/ucb-bar/chipyard/blob/main/generators/firechip/chip/src/main/scala/FireSim.scala): `generators/firechip/chip/src/main/scala/FireSim.scala`
- [Bridge Interfaces](https://github.com/ucb-bar/chipyard/blob/main/generators/firechip/bridgeinterfaces/src/main/scala/TileTraceIO.scala): `generators/firechip/bridgeinterfaces/src/main/scala/TileTraceIO.scala`
- [Host Bridge Stubs](https://github.com/ucb-bar/chipyard/blob/main/generators/firechip/bridgestubs/src/main/cc/bridges/simplenic.cc): `generators/firechip/bridgestubs/src/main/cc/bridges/simplenic.cc`
- [TSI Host Transport](https://github.com/ucb-bar/chipyard/blob/main/generators/firechip/bridgestubs/src/main/cc/fesvr/firesim_tsi.cc): `generators/firechip/bridgestubs/src/main/cc/fesvr/firesim_tsi.cc`

### FPGA Harnesses

- [FPGA Harnesses](https://github.com/ucb-bar/chipyard/tree/main/fpga/src/main/scala): `fpga/src/main/scala`
- [VC707 Harness](https://github.com/ucb-bar/chipyard/blob/main/fpga/src/main/scala/vc707/TestHarness.scala): `fpga/src/main/scala/vc707/TestHarness.scala`
- [ZCU104 Harness](https://github.com/ucb-bar/chipyard/blob/main/fpga/src/main/scala/zcu104/TestHarness.scala): `fpga/src/main/scala/zcu104/TestHarness.scala`
- [Board Binders](https://github.com/ucb-bar/chipyard/blob/main/fpga/src/main/scala/arty100t/HarnessBinders.scala): `fpga/src/main/scala/arty100t/HarnessBinders.scala`
- [SD Boot Firmware](https://github.com/ucb-bar/chipyard/blob/main/fpga/src/main/resources/vcu118/sdboot/sd.c): `fpga/src/main/resources/vcu118/sdboot/sd.c`

### Tapeout Macros

- [Macro Compiler](https://github.com/ucb-bar/chipyard/blob/main/tools/tapeout/src/main/scala/macros/MacroCompiler.scala): `tools/tapeout/src/main/scala/macros/MacroCompiler.scala`
- [Macro Cost Metrics](https://github.com/ucb-bar/chipyard/blob/main/tools/tapeout/src/main/scala/macros/CostMetric.scala): `tools/tapeout/src/main/scala/macros/CostMetric.scala`
- [Flop Mapping](https://github.com/ucb-bar/chipyard/blob/main/tools/tapeout/src/main/scala/macros/SynFlopsPass.scala): `tools/tapeout/src/main/scala/macros/SynFlopsPass.scala`
- [Memory Macro Library](https://github.com/ucb-bar/chipyard/blob/main/tools/tapeout/src/main/scala/macrolib/SRAM.scala): `tools/tapeout/src/main/scala/macrolib/SRAM.scala`

### Other components

- **SoC Designer**
- **Simulation & VLSI Flows**

## Connections

- SoC Designer → SoC Configurations: selects (evidence: `README.md`)
- SoC Configurations → Cores & Accelerators: configures
- Chip Top → Digital System: instantiates (evidence: `generators/chipyard/src/main/scala/ChipTop.scala`)
- Harness Instantiation → Chip Top: builds (evidence: `generators/chipyard/src/main/scala/harness/HasHarnessInstantiators.scala`)
- Chip Top → Clocking & Reset: uses clock schemes (evidence: `generators/chipyard/src/main/scala/ChipTop.scala`)
- IO Binders → IO Cells: generates cells (evidence: `generators/chipyard/src/main/scala/iobinders/IOBinders.scala`)
- Harness Instantiation → Harness Binders: applies binders (evidence: `generators/chipyard/src/main/scala/harness/HasHarnessInstantiators.scala`)
- FireSim Harness → Harness Instantiation: uses harness (evidence: `generators/firechip/chip/src/main/scala/FireSim.scala`)
- FireSim Harness → Bridge Interfaces: exposes bridges
- Host Bridge Stubs → Simulation & VLSI Flows: supports simulation (evidence: `README.md`)
- TSI Host Transport → Simulation & VLSI Flows: supports simulation (evidence: `README.md`)
- FPGA Harnesses → Simulation & VLSI Flows: supports FPGA simulation (evidence: `README.md`)
- VC707 Harness → Harness Instantiation: instantiates chips (evidence: `fpga/src/main/scala/vc707/TestHarness.scala`)
- ZCU104 Harness → Harness Instantiation: instantiates chips (evidence: `fpga/src/main/scala/zcu104/TestHarness.scala`)
- Board Binders → Harness Instantiation: binds harness ports (evidence: `fpga/src/main/scala/arty100t/HarnessBinders.scala`)
- SD Boot Firmware → FPGA Harnesses: boots board
- Macro Compiler → Macro Cost Metrics: uses cost metric (evidence: `tools/tapeout/src/main/scala/macros/MacroCompiler.scala`)
- Macro Compiler → Flop Mapping: runs mapping pass (evidence: `tools/tapeout/src/main/scala/macros/MacroCompiler.scala`)
- Macro Compiler → Memory Macro Library: compiles against
- Macro Compiler → Simulation & VLSI Flows: supports VLSI flow (evidence: `README.md`)
