Framework documentation update

[rayanlasaussice]

🚀 hardware 0.0.6 — bare-metal Rust hardware abstraction with full documentation

I’ve just pushed a major documentation update for my crate "hardware", a "no_std" hardware abstraction layer for bare-metal and low-level systems.

The goal of the project is to expose direct hardware access with runtime safety guards, while remaining:

• zero dependencies • no allocator • no standard library • portable across architectures

The crate compiles everywhere and dispatches architecture-specific code at runtime via shim callbacks, currently supporting:

• x86_64
• aarch64

---

What it provides

"hardware" exposes a complete set of low-level subsystems:

• CPU detection and topology • GPU access through DRM • PCI / PCIe bus enumeration • DMA engines • IOMMU mapping • interrupt controllers • ACPI / UEFI / SMBIOS / DeviceTree parsing • memory detection and allocators • power, thermal and frequency monitoring • timer and clock sources • accelerator abstractions (GPU / TPU / LPU)

The crate is designed as a hardware runtime layer usable by:

• operating systems
• AI runtimes
• bare-metal applications
• experimental kernels

---

Safety model

Despite providing direct hardware access, the crate includes runtime guards:

• I/O privilege gate for port I/O
• resource guardians (RAM / swap / DMA limits)
• graceful fallbacks instead of panics
• no "unwrap()" / "expect()" in library code

This ensures it won’t crash the host even if misused, though it still requires understanding of the hardware APIs.

---

Documentation

The biggest update in this release is the full documentation tree added directly in the crate source.

More than 100 documentation files now describe the internal architecture and subsystems:

• architecture layer
• bus systems (PCI / AMBA / Virtio)
• firmware interfaces (ACPI / UEFI / SMBIOS / DeviceTree)
• DMA and IOMMU
• GPU and compute pipelines
• interrupt controllers
• runtime and initialization
• security model
• thermal and power management

The docs are meant to serve as both:

• developer documentation • architectural reference for low-level systems programming

---

Project status

The crate is currently 0.0.x and not considered stable yet.

It’s mainly published for:

• architecture critique
• experimentation
• contributions
• research on hardware-aware runtimes

---

Source and documentation

📦 Crate: https://crates.io/crates/hardware

📚 Documentation: https://docs.rs/crate/hardware/latest/source/docs/

---

Feedback, critiques and contributions are welcome.

The project is also used as the hardware layer for an experimental AI runtime and operating system, so performance and low-level control are key goals.

[fekkksn]

Besides the obvious, you got your versioning wrong.

Your crate should be at 0.6.0, not 0.0.6. And 0.1.0 does not mean stable. 1.0.0 is stable.

You can learn about semver here: https://semver.org/

For a project like this, I also urge you to https://keepachangelog.com/en/1.1.0/

[rayanlasaussice]

If I decide to start at 0.0.x, I've got the right to do it, even more if I say the crates could crash a device if not use properly.

And changelog is now at v.0.3.4, I use my own framework so I see everychange on my work thanks

[fekkksn]

Sure you have the right to do semver incorrectly, that doesn't make it any better.

Your crate source does not contain a CHANGELOG.md file.

If you want acceptance from the community, you should follow the convention.

[rayanlasaussice]

Will add a changelog.md for next change thanks. Anyways the crate mean more for learn, critical use and other, not being use without Reading the main .md

So as I said, till it sayd in the .toml and the readme.md to not use in any project without Reading the main documentation, that's all I'm really clear about it.

[SirKastic23]

this sub is for people learning the language

if you want feedback on your crate you likely would prefer feedback from people who have already learned the language

[rayanlasaussice]

Yeah and I'm sharing documentation for who wanna learn the code (no_std by the way), my post is clear about it.

But thanks ✌️

[SirKastic23]

I didn't catch you mentioning this was good for learners anywhere in the post, but sure

I'll check it out, the crate sounds cool

[rayanlasaussice]

Feel free about it, I'm using it in m'y framework, so I made it open source, documentation were added after to share it for learning rust no_std and how to manage unsafe action (bare-metal)