Create rtl/ directory skeleton with chipyard.hash placeholder and module stubs #40

New issue

Closed

opened 2026-05-25 09:05:59 -03:00 by navigator · 2 comments

navigator commented

2026-05-25 09:05:59 -03:00

Owner

Goal

Bootstrap the rtl/ directory referenced repeatedly in PLAN.md Sections 6, 8.2, and 12 so Phase 1 RTL work has a place to land. This is pure scaffolding — no actual Chisel code, no Chipyard clone. Only the directory structure, a chipyard.hash placeholder file, and SPEC.md stubs for each future module.

Files to create:

rtl/README.md — explains structure, references PLAN.md Section 8.2
rtl/chipyard.hash — placeholder file with comment # TODO: pin Chipyard 1.13.0 hash here (Phase 1 Week 4)
rtl/src/pop/.gitkeep
One SPEC.md stub per future module under rtl/src/pop/specs/:
- PopRoCCRouter.SPEC.md
- InterGemminiXbar.SPEC.md
- InterChipFabric.SPEC.md
- PCIeHostBridge.SPEC.md
- MultiGemminiCluster.SPEC.md
- FluidPopSoC.SPEC.md
- PopSoCConfig.SPEC.md
- PopLinkPHY_Behavioral.SPEC.md (from Section 13.3)

Each SPEC.md stub: H1 title, Status: Stub, one-line purpose paraphrased from PLAN.md, empty sections for Interface, Behavior, Invariants, Coverage targets (referencing Section 12.3 thresholds).

Acceptance criteria

rtl/ directory exists with files listed above
rtl/chipyard.hash is a placeholder, NOT a real hash (Chipyard install is a separate already-open issue)
Each SPEC.md stub names the file from Section 8.2 / 13.3 and references the per-module verification requirements from Section 12.3
No Scala/Chisel source files created — only SPEC.md stubs and README
rtl/README.md cross-references PLAN.md Section 8.2 and notes that actual Chipyard clone happens via the toolchain install issue

Plan refs

Section 6 (Week 4 Chipyard pin), Section 8.2 (custom module list), Section 12.3 (per-module requirements), Section 13.3 (PHY behavioral model)

Notes

Does NOT clone Chipyard, does NOT write Chisel. Pure path/file scaffolding so future RTL issues have well-known destinations. Marcos must approve before any real custom RTL is written (per Section 18 step 17), so this stays at SPEC-stub level only.

## Goal Bootstrap the `rtl/` directory referenced repeatedly in PLAN.md Sections 6, 8.2, and 12 so Phase 1 RTL work has a place to land. This is pure scaffolding — no actual Chisel code, no Chipyard clone. Only the directory structure, a `chipyard.hash` placeholder file, and SPEC.md stubs for each future module. Files to create: - `rtl/README.md` — explains structure, references PLAN.md Section 8.2 - `rtl/chipyard.hash` — placeholder file with comment `# TODO: pin Chipyard 1.13.0 hash here (Phase 1 Week 4)` - `rtl/src/pop/.gitkeep` - One `SPEC.md` stub per future module under `rtl/src/pop/specs/`: - `PopRoCCRouter.SPEC.md` - `InterGemminiXbar.SPEC.md` - `InterChipFabric.SPEC.md` - `PCIeHostBridge.SPEC.md` - `MultiGemminiCluster.SPEC.md` - `FluidPopSoC.SPEC.md` - `PopSoCConfig.SPEC.md` - `PopLinkPHY_Behavioral.SPEC.md` (from Section 13.3) Each SPEC.md stub: H1 title, `Status: Stub`, one-line purpose paraphrased from PLAN.md, empty sections for Interface, Behavior, Invariants, Coverage targets (referencing Section 12.3 thresholds). ## Acceptance criteria - [ ] `rtl/` directory exists with files listed above - [ ] `rtl/chipyard.hash` is a placeholder, NOT a real hash (Chipyard install is a separate already-open issue) - [ ] Each SPEC.md stub names the file from Section 8.2 / 13.3 and references the per-module verification requirements from Section 12.3 - [ ] No Scala/Chisel source files created — only SPEC.md stubs and README - [ ] `rtl/README.md` cross-references PLAN.md Section 8.2 and notes that actual Chipyard clone happens via the toolchain install issue ## Plan refs Section 6 (Week 4 Chipyard pin), Section 8.2 (custom module list), Section 12.3 (per-module requirements), Section 13.3 (PHY behavioral model) ## Notes Does NOT clone Chipyard, does NOT write Chisel. Pure path/file scaffolding so future RTL issues have well-known destinations. Marcos must approve before any real custom RTL is written (per Section 18 step 17), so this stays at SPEC-stub level only.