[Feature] add dtgen device tree compile-time code generator#40
Open
LuisRuisinger wants to merge 3 commits intomainfrom
Open
[Feature] add dtgen device tree compile-time code generator#40LuisRuisinger wants to merge 3 commits intomainfrom
LuisRuisinger wants to merge 3 commits intomainfrom
Conversation
LCOV of commit
|
There was a problem hiding this comment.
Pull request overview
Adds a new dtgen xtask crate that compiles a .dts into a .dtb, parses the DTB into an IR, and generates a static Rust source file exposing topology/peripheral data plus a small query API for use via include!().
Changes:
- Introduce
dtgenlibrary + CLI, including a DTB parser and Rust code generator. - Add IR types (
DeviceTree,Node,PropValue) and generated query helpers (peripheral lookups, aliases). - Add documentation and workspace lockfile updates for the new crate/dependencies.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| xtasks/crates/dtgen/src/parser.rs | Runs cpp/dtc and walks the DTB via fdt into an in-memory DeviceTree. |
| xtasks/crates/dtgen/src/ir.rs | Defines the IR and convenience query helpers like model() / stdout_compat(). |
| xtasks/crates/dtgen/src/codegen.rs | Emits Rust source for static node/peripheral arrays and query functions. |
| xtasks/crates/dtgen/src/lib.rs | Provides the dtgen::run() entrypoint. |
| xtasks/crates/dtgen/src/main.rs | Adds a clap-based CLI wrapper around dtgen::run(). |
| xtasks/crates/dtgen/README.md | Documents generated types and query API usage. |
| xtasks/crates/dtgen/Cargo.toml | Defines the new crate and its dependencies. |
| xtasks/crates/dtgen/Cargo.lock | Adds a per-crate lockfile for dtgen’s dependencies. |
| Cargo.lock | Adds dtgen and fdt to the workspace lockfile. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+20
to
+28
| fn emit_header(out: &mut String) { | ||
| out.push_str( | ||
| r#"// ================================ | ||
| // GENERATED BY dtgen — DO NOT EDIT | ||
| // ================================ | ||
|
|
||
| #![allow(dead_code)] | ||
|
|
||
| "#, |
Comment on lines
+306
to
+311
| r#"/// Find the first enabled peripheral whose compatible list exactly matches `c`. | ||
| pub fn peripheral_by_compatible(c: &str) -> Option<&'static Peripheral> { | ||
| PERIPHERALS.iter().find(|p| p.is_compatible(c) && p.is_enabled()) | ||
| } | ||
|
|
||
| /// Iterate all enabled peripherals whose compatible list exactly matches `c`. |
Comment on lines
+139
to
+141
| let path = path.split(':').next()?; | ||
| // match by last path component | ||
| let name = path.split('/').last()?; |
| [package] | ||
| name = "dtgen" | ||
| version = "0.1.0" | ||
| edition = "2021" |
Comment on lines
+12
to
+14
| let preprocessed_path = dts_path.with_extension("preprocessed.dts"); | ||
| let dtb_path = dts_path.with_extension("dtb"); | ||
|
|
Comment on lines
+107
to
+108
| .chunks(4) | ||
| .map(|b| u32::from_be_bytes(b.try_into().unwrap())) |
| if let Some(ph) = phandle { | ||
| tree.by_phandle.insert(ph, idx); | ||
| } | ||
| tree.by_name.insert(name, idx); |
Comment on lines
+182
to
+188
| ## `chosen` submodule | ||
|
|
||
| ```rust | ||
| // resolves /chosen stdout-path to the target Peripheral | ||
| chosen::stdout_path() // Option<&'static Peripheral> | ||
| ``` | ||
|
|
Author
There was a problem hiding this comment.
This is an inconsistency between intended design and actual design. Further commits will address the intended design to access chosen-node attributes through the chosen module.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds dtgen, a code generator for that parses device tree (.dts) files and emits a typed, queryable rust file to be used during building.
dtgen has been added to the xtasks, however further usage and integration must be discussed.
xtasks/crates/dtgen/README.md provides deeper insights in usage, ir, types.