oxidecomputer / oxidecomputer/hubris

Consider a way to build bitfields during FPGA register codegen

Open
#2,103 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
3.6k
Forks
239
Avg merge
1d 12h
Merged PRs (30d)
23

Description

Today we can generate Rust enums from enums encoded in the RDL. For registers which are just collections of single bit indicators, it would be nice to have a type that could be easily added to a ringbuf which would display the name of a bit and its status.

I am thinking something like the following RDL:

reg {
  name = "Example";

  field {
    desc = "Bit 1";
  } BIT1[1:1] = 0;

  field {
    desc = "Bit 0";
  } BIT0[0:0] = 0;
} EXAMPLE;

It would be nice to be able to get an Example type in the generated rust which could then be pretty-printed, e.g.: Example { Bit0: false, Bit1: false }

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the RDL register code-generation entry point and the generated Rust types. Compare the single-bit field example with existing enum generation, then define how the generated type should represent and pretty-print each bit's name and status for ringbuf use.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
embedded-iot, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.