hdmi-hal

Hardware abstraction traits for the HDMI stack.

hdmi-hal defines the behavioral contracts between protocol logic and hardware. It is a traits-only crate: no implementations live here. Every trait expresses an I/O boundary that multiple crates in the stack need to cross in a compatible way — raw SCDC register access over DDC/I²C, and PHY lane configuration for HDMI 2.1.

Usage

cargo add hdmi-hal

Implement a trait against your hardware backend:

use hdmi_hal::scdc::ScdcTransport;

struct MyI2cBackend { /* ... */ }

impl ScdcTransport for MyI2cBackend {
    type Error = MyError;

    fn read(&mut self, reg: u8) -> Result<u8, MyError> { /* ... */ }
    fn write(&mut self, reg: u8, value: u8) -> Result<(), MyError> { /* ... */ }
}

Accept a trait bound in consumer code:

use hdmi_hal::scdc::ScdcTransport;

fn configure_frl<T: ScdcTransport>(transport: &mut T) -> Result<(), T::Error> {
    transport.write(0x31, 0x01)?; // initiate FRL
    Ok(())
}

For a complete worked example of both traits with a simulated backend, see examples/simulate.

Stack position

hdmi-hal sits between the platform backends and the protocol logic crates. It has no dependency on the rest of the stack; protocol crates depend on it, not the reverse.

flowchart LR
    dt["display-types"]
    hal["hdmi-hal"]
    scdc["scdc"]
    frl["frl-training"]
    be["platform backends"]

    dt --> hal
    hal --> scdc
    hal --> frl
    hal --> be

Async variants of both traits live in the companion crate hdmi-hal-async, following the same split as embedded-hal / embedded-hal-async.

Out of scope

• Protocol logic — SCDC register semantics, typed register wrappers, and the FRL link training state machine belong in the crates that consume ScdcTransport.
• Implementations — concrete platform backends (kernel I²C drivers, simulator harnesses, test doubles) live in the crates that use these traits.
• PHY vendor backends — hardware-specific register sequences belong in platform crates that implement HdmiPhy.
• CEC or eARC protocol logic — only the wire-access primitive will belong here; protocol state machines are in their own crates.

Documentation

• doc/architecture.md — trait surfaces, design principles, async story, and stack position
• doc/roadmap.md — planned features and future work

Verifying releases

Each release is built on GitHub Actions and attested with SLSA Build Level 2 provenance. To verify a release .crate against its signed provenance, install the GitHub CLI and run:

gh attestation verify hdmi-hal-X.Y.Z.crate --repo DracoWhitefire/hdmi-hal

The attested .crate is attached to each GitHub release.

License

Licensed under the Mozilla Public License 2.0.