culvert-async 0.2.0

Async 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
32
33
34
35

//! Async typed access to the HDMI 2.1 SCDC (Status and Control Data Channel) register map.
//!
//! `culvert-async` is the async companion to [`culvert`]: [`culvert::Scdc`]'s methods as
//! `async fn`s over an [`hdmi_hal_async::scdc::ScdcTransport`]. The register map is
//! culvert's [`culvert::codec`]; this crate only performs the reads and writes, so the sync
//! and async clients always agree.
//!
//! All register types and error types are re-exported from `culvert` so that callers do not
//! need to depend on both crates, and the transport trait and its `Send` twin from
//! `hdmi-hal-async`. culvert's I/O-free encoders and decoders, [`culvert::codec`], are not
//! re-exported: code that needs them depends on culvert.
//!
//! # Features
//!
//! - **`plumbob-async`** — implements `plumbob_async::ScdcClient` for [`Scdc<T>`], connecting
//!   culvert-async to the async FRL link training state machine.

#![no_std]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![forbid(unsafe_code)]
#![deny(missing_docs)]

mod client;

pub use client::Scdc;
pub use culvert::{
    CedCount, CedCounters, ClearableUpdateFlags, Config0, FfeLevels, FrlConfig, FrlRate, LtpReq,
    LtpRequests, ProtocolError, RsCorrectionCount, ScdcError, ScramblerStatus, SourceTestConfig,
    StatusFlags, TmdsConfig, UpdateFlags,
};
/// The async transport `Scdc<T>` is generic over, re-exported from `hdmi-hal-async`.
pub use hdmi_hal_async::scdc::ScdcTransport;
/// The transport's `Send` twin, re-exported from `hdmi-hal-async`: bound generic code by it
/// to spawn work through `Scdc<T>` on a multi-threaded executor.
pub use hdmi_hal_async::scdc::SendScdcTransport;