# trholding/shrike-gen architecture

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

- Interactive diagram: https://gitdiagram.com/trholding/shrike-gen
- Repository: https://github.com/trholding/shrike-gen

## Overview

shrike-gen scaffolds Verilog or experimental VHDL projects for the SLG47910V and provides a Make-driven path from HDL and pin constraints to programming bitstreams, with optional flashing to Shrike boards. Project creation renders templates and generates initial project metadata; project builds update metadata, synthesize, place and route, and convert AXI output into MCU, OTP, and FLASH_MEM formats. The README documents the Make-driven stages, but the Makefile itself was not sampled, so some build wiring is shown as unverified.

Main entry points: [`Makefile`](https://github.com/trholding/shrike-gen/blob/master/Makefile) (Project build workflow), [`shrike_gen/shrike-gen.py`](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/shrike-gen.py) (Project scaffolder), [`shrike_gen/gen_ffpga.py`](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_ffpga.py) (Project XML generator), [`shrike_gen/gen_bitstreams.py`](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_bitstreams.py) (Bitstream converter)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_project["Project setup"]
  node_cli["Project scaffolder<br/>[shrike-gen.py]"]
  node_hdl_template["HDL templates<br/>[main.v]"]
  node_pcf_template["Constraint template<br/>[io_map.pcf]"]
  node_hdl["Verilog / VHDL design"]
  node_constraints["Pin constraints"]
end

subgraph group_metadata["Project metadata"]
  node_ffpga["Project XML generator<br/>[gen_ffpga.py]"]
  node_io_spec["IO constraint mapper<br/>[gen_io_spec.py]"]
end

subgraph group_build["FPGA build"]
  node_make["Project build workflow"]
  node_synthesis["HDL lint and synthesis"]
  node_placer_args["PNR argument encoder<br/>[gen_fpga_data.py]"]
  node_placer["Place and route"]
  node_axi_log["AXI bitstream log"]
end

subgraph group_program["Programming"]
  node_bitstreams["Bitstream converter<br/>[gen_bitstreams.py]"]
  node_outputs["MCU / OTP / FLASH_MEM"]
  node_flash["Flash target"]
  node_board(("Shrike board"))
end

node_user(("Designer"))

node_user -->|"creates project"| node_cli
node_cli -->|"renders"| node_hdl_template
node_cli -->|"renders"| node_pcf_template
node_user -->|"writes design"| node_hdl
node_user -->|"edits pins"| node_constraints
node_cli -->|"generates metadata"| node_ffpga
node_cli -->|"generates IO spec"| node_io_spec
node_ffpga -->|"uses mapper"| node_io_spec
node_user -->|"runs make"| node_make
node_make -.->|"updates project XML"| node_ffpga
node_make -.->|"updates IO spec"| node_io_spec
node_make -.->|"runs lint and synth"| node_synthesis
node_make -.->|"prepares PNR args"| node_placer_args
node_placer_args -->|"encodes arguments"| node_placer
node_placer -->|"writes AXI log"| node_axi_log
node_make -.->|"collects bitstreams"| node_bitstreams
node_axi_log -->|"converts log"| node_bitstreams
node_bitstreams -->|"writes formats"| node_outputs
node_user -->|"requests flash"| node_flash
node_flash -->|"copies bitstream"| node_board

click node_cli "https://github.com/trholding/shrike-gen/blob/master/shrike_gen/shrike-gen.py"
click node_hdl_template "https://github.com/trholding/shrike-gen/blob/master/shrike_gen/templates/main.v"
click node_pcf_template "https://github.com/trholding/shrike-gen/blob/master/shrike_gen/templates/io_map.pcf"
click node_make "https://github.com/trholding/shrike-gen/blob/master/Makefile"
click node_ffpga "https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_ffpga.py"
click node_io_spec "https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_io_spec.py"
click node_placer_args "https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_fpga_data.py"
click node_bitstreams "https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_bitstreams.py"

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_cli,node_hdl_template,node_pcf_template,node_hdl,node_constraints toneBlue
class node_ffpga,node_io_spec toneAmber
class node_make,node_synthesis,node_placer_args,node_placer,node_axi_log toneMint
class node_bitstreams,node_outputs,node_flash,node_board toneRose
class node_user toneIndigo
```

## Components

### Project setup

- [Project scaffolder](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/shrike-gen.py): `shrike_gen/shrike-gen.py`
- [HDL templates](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/templates/main.v): `shrike_gen/templates/main.v`
- [Constraint template](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/templates/io_map.pcf): `shrike_gen/templates/io_map.pcf`
- **Verilog / VHDL design**
- **Pin constraints**

### Project metadata

- [Project XML generator](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_ffpga.py): `shrike_gen/gen_ffpga.py`
- [IO constraint mapper](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_io_spec.py): `shrike_gen/gen_io_spec.py`

### FPGA build

- [Project build workflow](https://github.com/trholding/shrike-gen/blob/master/Makefile): `Makefile`
- **HDL lint and synthesis**
- [PNR argument encoder](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_fpga_data.py): `shrike_gen/gen_fpga_data.py`
- **Place and route**
- **AXI bitstream log**

### Programming

- [Bitstream converter](https://github.com/trholding/shrike-gen/blob/master/shrike_gen/gen_bitstreams.py): `shrike_gen/gen_bitstreams.py`
- **MCU / OTP / FLASH_MEM**
- **Flash target**
- **Shrike board**

### Other components

- **Designer**

## Connections

- Designer → Project scaffolder: creates project (evidence: `README.md`)
- Project scaffolder → HDL templates: renders (evidence: `shrike_gen/shrike-gen.py`)
- Project scaffolder → Constraint template: renders (evidence: `shrike_gen/shrike-gen.py`)
- Designer → Verilog / VHDL design: writes design (evidence: `README.md`)
- Designer → Pin constraints: edits pins (evidence: `README.md`)
- Project scaffolder → Project XML generator: generates metadata (evidence: `shrike_gen/shrike-gen.py`)
- Project scaffolder → IO constraint mapper: generates IO spec (evidence: `shrike_gen/shrike-gen.py`)
- Project XML generator → IO constraint mapper: uses mapper (evidence: `shrike_gen/gen_ffpga.py`)
- Designer → Project build workflow: runs make (evidence: `README.md`)
- Project build workflow → Project XML generator: updates project XML
- Project build workflow → IO constraint mapper: updates IO spec
- Project build workflow → HDL lint and synthesis: runs lint and synth
- Project build workflow → PNR argument encoder: prepares PNR args
- PNR argument encoder → Place and route: encodes arguments (evidence: `shrike_gen/gen_fpga_data.py`)
- Place and route → AXI bitstream log: writes AXI log
- Project build workflow → Bitstream converter: collects bitstreams
- AXI bitstream log → Bitstream converter: converts log (evidence: `shrike_gen/gen_bitstreams.py`)
- Bitstream converter → MCU / OTP / FLASH_MEM: writes formats (evidence: `shrike_gen/gen_bitstreams.py`)
- Designer → Flash target: requests flash (evidence: `README.md`)
- Flash target → Shrike board: copies bitstream (evidence: `README.md`)
