oreboot / oreboot/oreboot

guidelines for register blocks, registers, structs...

Open
#743 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.8k
Forks
113
PR merge metrics
No merged PRs in 30d

Description

There are lots of crates for handling various kinds of binary structures:

In addition, Kaitai has partial Rust support.

We often need to parse/write vendor specific payload headers (xtask/), access special access registers (RISC-V CSRs, Intel MSRs), or deal with peripheral blocks. The latter is covered by Rust Embedded HAL/PAC semantics. That code is not as modular though, while in reality, different SoCs often share the same peripherals from the same supplier (Cadence Denali and Synopsis Designware) and/or the same or related cores (T-Head and SiFive on RISC-V, Arm based ones, etc).

We should provide guidelines and a way to go to keep our code consistent.
This if anything is the central point of a firmware monorepo, making up a framework.

Contributor guide

No contributing guide indexed for this repository

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 surveying the existing register, struct, and vendor-payload handling under xtask/, then compare it with the linked crates and embedded HAL/PAC guidance. Done would require an agreed, documented set of guidelines and a consistent way to apply them across the firmware monorepo; the issue does not identify specific files or tests.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.