lowRISC / lowRISC/opentitan

[util] reggen enhancement for enums

Open
#9,336 1 comment 1 reaction 0 assignees View on GitHub
Component:Tooling Earlgrey-PROD Triaged Priority:P3 Type:Enhancement
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

Enhance reggen such that it can automatically create enums when a particular field is defined that way.
This will prevent the designer from needing to create a second version inside a package file somewhere, and will also ensure the documentation and the design stay in sync.

Contributor guide

Open the contributing guide

Research direction

Start by locating the reggen utility and how field definitions are represented. Trace where package-file enums and generated documentation are currently handled, then determine the expected enum-generation behavior. Done means reggen creates enums from fields defined that way without requiring a second package-file version, keeping documentation and design synchronized.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.