Trait ScdcClient

Source

pub trait ScdcClient {
    type Error;

    // Required methods
    async fn read_flt_ready(&mut self) -> Result<bool, Self::Error>;
    async fn read_update_flags(&mut self) -> Result<UpdateFlags, Self::Error>;
    async fn clear_update_flags(
        &mut self,
        flags: ClearableUpdateFlags,
    ) -> Result<(), Self::Error>;
    async fn read_ltp_requests(&mut self) -> Result<LtpRequests, Self::Error>;
    async fn read_source_test_config(
        &mut self,
    ) -> Result<SourceTestConfig, Self::Error>;
    async fn write_config_0_defaults(&mut self) -> Result<(), Self::Error>;
    async fn write_frl_config(
        &mut self,
        config: FrlConfig,
    ) -> Result<(), Self::Error>;
    async fn read_ced(&mut self) -> Result<CedCounters, Self::Error>;
}

Expand description

Async typed SCDC interface required by the FRL training state machine.

This is the async counterpart to plumbob::ScdcClient: the same methods with the same meaning, each an async fn. See that trait for what implementations must guarantee, including where the poll interval belongs (inside the polled methods; an async implementation can await a timer there) and how to stop training early (“Stopping early”): for a deadline or a cancel signal, return one error of your own from a polled read and let every later call through. Training then ends through LTS:L, and train returns TrainingError::Scdc with that error; unlike a dropped train future, this leaves both ends in TMDS (unless exit_to_tmds_on_error is off or the sink sets FLT_no_timeout). Never fail a read made after LTS:L has begun (after a write_frl_config with NotSupported), until a write_frl_config with an FRL rate starts training again. culvert-async implements it for its Scdc<T>.