Register frontend: C header generation by da-gazzi · Pull Request #158 · pulp-platform/iDMA

da-gazzi · 2026-07-13T08:13:17Z

Add make target idma_sw_all to generate target/sw/idma_reg{32,64}_${N}d_[raw_]regs.h for each generated register frontend.
2 headers are generated: the one without raw in the name uses the PeakRDL c-header plugin to create a struct-based header, the one with raw is generated with the raw-header plugin. The raw version is (with the current version of raw-header) somewhat incomplete as the masks for sub-register bitfields have to be generated/hardcoded externally.
The deploy CI job calls this target and deploy.py is amended to edit the appropriate .gitignore; C headers are also checked into deploy branches
uv.lock and pyproject.toml amended so the c-header plugin is part of the environment

- This target generates C headers in `target/sw` with both the `raw-header` and `c-header` PeakRDL plugins - Also added to `deploy` CI job

DanielKellerM

Thank you for your contribution. Could you check the comments / changes I requested?

DanielKellerM · 2026-07-30T11:40:16Z

+	$(PEAKRDL) c-header $(IDMA_FE_DIR)/reg/idma_reg.rdl -i -o $@ \
+	  -P SysAddrWidth=$(call regwidth,$*) \
+	  -P NumDims=$(call dimension,$*) \
+	  -P Log2NumDims=$(call log2dimension,$(call dimension,$*))


Use the rename to keep compatibility with other IPs that consume the sw.

Drop -i since we dont need a fixed absolute address.

Prepend the SPDX header via sed (c-header has no --license_str).

Suggested change

$(PEAKRDL) c-header $(IDMA_FE_DIR)/reg/idma_reg.rdl -i -o $@ \

-P SysAddrWidth=$(call regwidth,$*) \

-P NumDims=$(call dimension,$*) \

-P Log2NumDims=$(call log2dimension,$(call dimension,$*))

$(PEAKRDL) c-header $(IDMA_FE_DIR)/reg/idma_reg.rdl -o $@ \

-b ltoh --type-style hier --rename idma_reg$*d \

-P SysAddrWidth=$(call regwidth,$*) \

-P NumDims=$(call dimension,$*) \

-P Log2NumDims=$(call log2dimension,$(call dimension,$*))

sed -i '1i$(IDMA_C_HDR_LIC)' $@

DanielKellerM · 2026-07-30T11:44:32Z

 $(IDMA_HTML_DIR)/regs/idma_desc64_reg/index.html:
 	$(PEAKRDL) html $(IDMA_FE_DIR)/desc64/idma_desc64_reg.rdl -o $(IDMA_HTML_DIR)/regs/idma_desc64_reg

+# C header


Adding license to generated files

Suggested change

# C header

# C header

IDMA_LICENSE := Copyright 2026 ETH Zurich and University of Bologna.\nSolderpad Hardware License, Version 0.51, see LICENSE for details.\nSPDX-License-Identifier: SHL-0.51

IDMA_C_HDR_LIC := // $(subst \n,\n// ,$(IDMA_LICENSE))\n

DanielKellerM · 2026-07-30T11:46:08Z

+	$(PEAKRDL) raw-header $(IDMA_FE_DIR)/reg/idma_reg.rdl -o $@ \
+	  --format c \


Add licensing to the raw header too.

Suggested change

$(PEAKRDL) raw-header $(IDMA_FE_DIR)/reg/idma_reg.rdl -o $@ \

--format c \

$(PEAKRDL) raw-header $(IDMA_FE_DIR)/reg/idma_reg.rdl -o $@ \

--format c \

--license_str="$(IDMA_LICENSE)" \

DanielKellerM · 2026-07-30T11:52:12Z

+IDMA_SW_ALL      += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_regs.h)
+IDMA_SW_ALL      += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_regs_unpacked.h)


Extend SW generation to descriptor based frontend:

Suggested change

IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_regs.h)

IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_regs_unpacked.h)

IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_REGS),$(IDMA_SW_DIR)/idma_$Y_regs.h)

IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_REGS),$(IDMA_SW_DIR)/idma_$Y_regs_unpacked.h)

DanielKellerM · 2026-07-30T11:52:32Z

+IDMA_SW_ALL      += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_regs_unpacked.h)
+
+# C headers with the "raw-header" plugin
+IDMA_SW_ALL      += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_raw_regs.h)


Same SW for descriptro based frontend

Suggested change

IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_raw_regs.h)

IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_REGS),$(IDMA_SW_DIR)/idma_$Y_raw_regs.h)

DanielKellerM · 2026-07-30T11:53:22Z

+	  -P SysAddrWidth=$(call regwidth,$*) \
+	  -P NumDims=$(call dimension,$*) \
+	  -P Log2NumDims=$(call log2dimension,$(call dimension,$*))
+


Add the desc64 rules

Suggested change

$(IDMA_SW_DIR)/idma_desc64_regs.h:

$(PEAKRDL) c-header $(IDMA_FE_DIR)/desc64/idma_desc64_reg.rdl -o $@ \

-b ltoh --type-style hier --rename idma_desc64

sed -i '1i$(IDMA_C_HDR_LIC)' $@

$(IDMA_SW_DIR)/idma_desc64_regs_unpacked.h: $(IDMA_SW_DIR)/idma_desc64_regs.h

sed -e "s/__attribute__ ((__packed__)) //" $< > $@

$(IDMA_SW_DIR)/idma_desc64_raw_regs.h:

$(PEAKRDL) raw-header $(IDMA_FE_DIR)/desc64/idma_desc64_reg.rdl -o $@ \

--format c --base_name idma_desc64 \

--license_str="$(IDMA_LICENSE)"

- the PeakRDL `c-header` plugin generates structs with `__attribute__((__packed__))` which ensures proper packing of fields but can also cause the compiler to emit byte loads/stores to access 32-bit registers, which is definitely not what we want. The `unpacked` version of the C header has the attribute removed. - The `idma_sw_clean` target had a typo and didn't actually clean anything, this is fixed now.

da-gazzi · 2026-07-30T14:54:08Z

Implemented, thanks a lot for reviewing!

DanielKellerM

Feedback addressed (rename/type-style/ltoh, SPDX, desc64). Thanks!

Regs: Add make_sw_all target to make C regfile headers

7d80045

- This target generates C headers in `target/sw` with both the `raw-header` and `c-header` PeakRDL plugins - Also added to `deploy` CI job

da-gazzi requested review from DanielKellerM, micprog and thommythomaso as code owners July 13, 2026 08:13

da-gazzi changed the base branch from master to devel July 13, 2026 08:31

DanielKellerM requested changes Jul 30, 2026

View reviewed changes

da-gazzi force-pushed the pr/c-headers branch from c06f0db to 21f089c Compare July 30, 2026 14:34

SW: Implement PR feedback

935314e

DanielKellerM approved these changes Jul 31, 2026

View reviewed changes

DanielKellerM merged commit 56c4a83 into pulp-platform:devel Jul 31, 2026
12 checks passed

DanielKellerM pushed a commit that referenced this pull request Jul 31, 2026

Regs: Add SW C register header generation (#158)

7b45c8e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Register frontend: C header generation - #158

Register frontend: C header generation#158
DanielKellerM merged 3 commits into
pulp-platform:develfrom
mosaic-soc:pr/c-headers

da-gazzi commented Jul 13, 2026

Uh oh!

DanielKellerM left a comment

Uh oh!

DanielKellerM Jul 30, 2026 •

edited

Loading

Uh oh!

DanielKellerM Jul 30, 2026

Uh oh!

DanielKellerM Jul 30, 2026 •

edited

Loading

Uh oh!

DanielKellerM Jul 30, 2026

Uh oh!

DanielKellerM Jul 30, 2026

Uh oh!

DanielKellerM Jul 30, 2026 •

edited

Loading

Uh oh!

da-gazzi commented Jul 30, 2026

Uh oh!

DanielKellerM left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		$(PEAKRDL) raw-header $(IDMA_FE_DIR)/reg/idma_reg.rdl -o $@ \
		--format c \

		IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_regs.h)
		IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_regs_unpacked.h)

	IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_IDS),$(IDMA_SW_DIR)/idma_$Y_raw_regs.h)
	IDMA_SW_ALL += $(foreach Y,$(IDMA_FE_REGS),$(IDMA_SW_DIR)/idma_$Y_raw_regs.h)

+$(IDMA_SW_DIR)/idma_desc64_regs.h:
+	$(PEAKRDL) c-header $(IDMA_FE_DIR)/desc64/idma_desc64_reg.rdl -o $@ \
+	  -b ltoh --type-style hier --rename idma_desc64
+	sed -i '1i$(IDMA_C_HDR_LIC)' $@
+$(IDMA_SW_DIR)/idma_desc64_regs_unpacked.h: $(IDMA_SW_DIR)/idma_desc64_regs.h
+	sed -e "s/__attribute__ ((__packed__)) //" $< > $@
+$(IDMA_SW_DIR)/idma_desc64_raw_regs.h:
+	$(PEAKRDL) raw-header $(IDMA_FE_DIR)/desc64/idma_desc64_reg.rdl -o $@ \
+	  --format c --base_name idma_desc64 \
+	  --license_str="$(IDMA_LICENSE)"

Uh oh!

Conversation

da-gazzi commented Jul 13, 2026

Uh oh!

DanielKellerM left a comment

Choose a reason for hiding this comment

Uh oh!

DanielKellerM Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanielKellerM Jul 30, 2026

Choose a reason for hiding this comment

Uh oh!

DanielKellerM Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanielKellerM Jul 30, 2026

Choose a reason for hiding this comment

Uh oh!

DanielKellerM Jul 30, 2026

Choose a reason for hiding this comment

Uh oh!

DanielKellerM Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

da-gazzi commented Jul 30, 2026

Uh oh!

DanielKellerM left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

DanielKellerM Jul 30, 2026 •

edited

Loading

DanielKellerM Jul 30, 2026 •

edited

Loading

DanielKellerM Jul 30, 2026 •

edited

Loading