culvert 0.2.0

Typed access to the HDMI 2.1 SCDC register map
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

//! Typed access to the HDMI 2.1 SCDC (Status and Control Data Channel) register map.
//!
//! Culvert sits on top of [`hdmi_hal::scdc::ScdcTransport`] and provides named structs,
//! bitfield types, and typed operations for scrambling control, FRL training primitives,
//! and CED (Character Error Detection) reporting.
//!
//! The central type is [`Scdc`], a thin stateless client that wraps a transport
//! and exposes one typed method per register group. Sequencing of register operations —
//! rate selection, timeout handling, retry logic — belongs in the link training crate
//! above.
//!
//! The register map itself — addresses and per-register encoding and decoding — is the
//! I/O-free [`codec`] module, which `Scdc` and `culvert-async`'s client share.
#![no_std]
#![forbid(unsafe_code)]
#![deny(missing_docs)]

mod client;
pub mod codec;
mod error;
mod register;

pub use client::Scdc;
pub use error::{ProtocolError, ScdcError};
/// The transport `Scdc<T>` is generic over, re-exported from `hdmi-hal`.
pub use hdmi_hal::scdc::ScdcTransport;
pub use register::{
    CedCount, CedCounters, ClearableUpdateFlags, Config0, FfeLevels, FrlConfig, FrlRate, LtpReq,
    LtpRequests, RsCorrectionCount, ScramblerStatus, SourceTestConfig, StatusFlags, TmdsConfig,
    UpdateFlags,
};