firewire_dice_protocols::focusrite::spro40

Struct SPro40Protocol

pub struct SPro40Protocol;

Expand description

Protocol implementation specific to Saffire Pro 40.

Trait Implementations§

impl Debug for SPro40Protocol

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for SPro40Protocol

fn default() -> SPro40Protocol

Returns the “default value” for a type. Read more

impl SaffireproIoParamsSpecification for SPro40Protocol

const AESEBU_IS_SUPPORTED: bool = false

Whether to support AES/EBU signal in optical interface.

const MIC_PREAMP_TRANSFORMER_IS_SUPPORTED: bool = false

Whether to support transformer function for microphone pre-amplifier.

impl SaffireproOutGroupSpecification for SPro40Protocol

const OUT_GROUP_STATE_OFFSET: usize = 12usize

Offset of output group state.

const ENTRY_COUNT: usize = 10usize

The number of outputs to be controlled.

const HAS_VOL_HWCTL: bool = true

Support hardware knob to control volume.

const SRC_NOTICE: u32 = 1u32

Software notification for source of output group.

const DIM_MUTE_NOTICE: u32 = 2u32

Software notification for dim and mute of output group.

const VOL_MIN: i8 = 0i8

The minimum value of volume.

const VOL_MAX: i8 = 127i8

The maximum value of volume.

fn create_out_group_state() -> OutGroupState

Instantiate structure for output group state.

impl SaffireproSwNoticeOperation for SPro40Protocol

const SW_NOTICE_OFFSET: usize = 104usize

fn write_sw_notice( req: &FwReq, node: &FwNode, sections: &ExtensionSections, notice: u32, timeout_ms: u32, ) -> Result<(), Error>

impl TcatExtensionOperation for SPro40Protocol

fn read_extension( req: &FwReq, node: &FwNode, section: &Section, offset: usize, frames: &mut [u8], timeout_ms: u32, ) -> Result<(), Error>

Initiate read transaction to offset in specific address space and finish it.

fn write_extension( req: &FwReq, node: &FwNode, section: &Section, offset: usize, frames: &mut [u8], timeout_ms: u32, ) -> Result<(), Error>

Initiate write transaction to offset in specific address space and finish it.

fn read_extension_sections( req: &FwReq, node: &FwNode, sections: &mut ExtensionSections, timeout_ms: u32, ) -> Result<(), Error>

Read section layout.

impl TcatGlobalSectionSpecification for SPro40Protocol

const AVAILABLE_CLOCK_SOURCE_OVERRIDE: Option<&'static [ClockSource]> = None

Some models report invalid list for signal source of sampling clock.

const CLOCK_SOURCE_LABEL_TABLE: &'static [ClockSource] = _

Some models report list of labels for signal source of sampling clock with unexpected position.

impl TcatOperation for SPro40Protocol

fn read( req: &FwReq, node: &FwNode, offset: usize, frames: &mut [u8], timeout_ms: u32, ) -> Result<(), Error>

Initiate read transaction to offset in specific address space and finish it.

fn write( req: &FwReq, node: &FwNode, offset: usize, frames: &mut [u8], timeout_ms: u32, ) -> Result<(), Error>

Initiate write transaction to offset in specific address space and finish it.

fn read_general_sections( req: &FwReq, node: &FwNode, sections: &mut GeneralSections, timeout_ms: u32, ) -> Result<(), Error>

Read section layout.

impl Tcd22xxSpecification for SPro40Protocol

const INPUTS: &'static [Input]

Physical input ports.

const OUTPUTS: &'static [Output]

Physical output ports.

const FIXED: &'static [SrcBlk]

Ports with fixed position in router entries; e.g. target ports for meter display.

const MIXER_OUT_PORTS: [u8; 3] = _

The number of mixer outputs at specification of TCD22xx.

const MIXER_IN_PORTS: [(DstBlkId, u8); 2] = _

The number of mixer inputs at specification of TCD22xx.

const ADAT_CHANNELS: [u8; 3] = _

The number of ADAT channels at specification of ADAT/SMUX.

fn adat_channel_count(rate_mode: RateMode) -> u8

Compute the number of ADAT channels.

fn mixer_out_port_count(rate_mode: RateMode) -> u8

Compute the number of mixer outputs.

fn mixer_in_port_count() -> u8

Compute the number of mixer inputs.

fn compute_avail_real_blk_pair( rate_mode: RateMode, ) -> (Vec<SrcBlk>, Vec<DstBlk>)

Compute available destination and source blocks for physical ports.

fn compute_avail_stream_blk_pair( tx_entries: &[FormatEntry], rx_entries: &[FormatEntry], ) -> (Vec<SrcBlk>, Vec<DstBlk>)

Compute available destination and source blocks for Tx/Rx streams.

fn compute_avail_mixer_blk_pair( caps: &ExtensionCaps, rate_mode: RateMode, ) -> (Vec<SrcBlk>, Vec<DstBlk>)

Compute available destination and source blocks for mixer inputs and outputs.

fn refine_router_entries( entries: &mut Vec<RouterEntry>, avail_blocks: &Tcd22xxAvailableBlocks, )

Refine router entries by defined descriptors.

Auto Trait Implementations§

impl Freeze for SPro40Protocol

impl RefUnwindSafe for SPro40Protocol

impl Send for SPro40Protocol

impl Sync for SPro40Protocol

impl Unpin for SPro40Protocol

impl UnwindSafe for SPro40Protocol

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<O> TcatExtensionCapsSectionOperation for O
where O: TcatExtensionOperation,

fn read_extension_caps( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &mut ExtensionCaps, timeout_ms: u32, ) -> Result<(), Error>

Read capabilities.

impl<O> TcatExtensionCommandSectionOperation for O
where O: TcatExtensionOperation,

fn initiate( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, opcode: Opcode, timeout_ms: u32, ) -> Result<u32, Error>

Initiate command and wait for its completion.

impl<O> TcatExtensionSectionNotifiedParamsOperation<OutGroupState> for O
where O: TcatExtensionOperation + SaffireproOutGroupSpecification,

fn cache_extension_notified_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &mut OutGroupState, msg: u32, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for notified parameters.

impl<O> TcatExtensionSectionParamsOperation<CurrentRouterParams> for O
where O: TcatExtensionOperation,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &mut CurrentRouterParams, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionParamsOperation<CurrentStreamFormatParams> for O
where O: TcatExtensionOperation,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &mut CurrentStreamFormatParams, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionParamsOperation<MixerCoefficientParams> for O
where O: TcatExtensionOperation,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &mut MixerCoefficientParams, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionParamsOperation<MixerSaturationParams> for O
where O: TcatExtensionOperation,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &mut MixerSaturationParams, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionParamsOperation<OutGroupState> for O
where O: TcatExtensionOperation + SaffireproOutGroupSpecification,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, _: &ExtensionCaps, params: &mut OutGroupState, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionParamsOperation<PeakParams> for O
where O: TcatExtensionOperation,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &mut PeakParams, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionParamsOperation<RouterParams> for O
where O: TcatExtensionOperation,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &mut RouterParams, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionParamsOperation<SaffireproIoParams> for O
where O: TcatExtensionOperation + SaffireproIoParamsSpecification,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, _: &ExtensionCaps, params: &mut SaffireproIoParams, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionParamsOperation<StandaloneParameters> for O
where O: TcatExtensionOperation,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, _: &ExtensionCaps, params: &mut StandaloneParameters, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionParamsOperation<StreamFormatParams> for O
where O: TcatExtensionOperation,

fn cache_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &mut StreamFormatParams, timeout_ms: u32, ) -> Result<(), Error>

Cache state of hardware for whole parameters.

impl<O> TcatExtensionSectionPartialMutableParamsOperation<MixerCoefficientParams> for O
where O: TcatExtensionOperation,

fn update_extension_partial_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &MixerCoefficientParams, prev: &mut MixerCoefficientParams, timeout_ms: u32, ) -> Result<(), Error>

Update state of hardware for partial parameters.

impl<O> TcatExtensionSectionPartialMutableParamsOperation<OutGroupState> for O
where O: TcatExtensionOperation + SaffireproOutGroupSpecification,

fn update_extension_partial_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, _: &ExtensionCaps, params: &OutGroupState, prev: &mut OutGroupState, timeout_ms: u32, ) -> Result<(), Error>

Update state of hardware for partial parameters.

impl<O> TcatExtensionSectionPartialMutableParamsOperation<SaffireproIoParams> for O
where O: TcatExtensionOperation + SaffireproIoParamsSpecification,

fn update_extension_partial_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, _: &ExtensionCaps, params: &SaffireproIoParams, prev: &mut SaffireproIoParams, timeout_ms: u32, ) -> Result<(), Error>

Update state of hardware for partial parameters.

impl<O> TcatExtensionSectionPartialMutableParamsOperation<StandaloneParameters> for O
where O: TcatExtensionOperation,

fn update_extension_partial_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, _: &ExtensionCaps, params: &StandaloneParameters, prev: &mut StandaloneParameters, timeout_ms: u32, ) -> Result<(), Error>

Update state of hardware for partial parameters.

impl<O> TcatExtensionSectionWholeMutableParamsOperation<RouterParams> for O
where O: TcatExtensionOperation,

fn update_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &RouterParams, timeout_ms: u32, ) -> Result<(), Error>

Update state of hardware for whole parameters.

impl<O> TcatExtensionSectionWholeMutableParamsOperation<StreamFormatParams> for O
where O: TcatExtensionOperation,

fn update_extension_whole_params( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, params: &StreamFormatParams, timeout_ms: u32, ) -> Result<(), Error>

Update state of hardware for whole parameters.

impl<O> TcatFluctuatedSectionOperation<GlobalParameters> for O
where O: TcatSectionOperation<GlobalParameters>,

const FLUCTUATED_OFFSETS: &'static [usize] = const FLUCTUATED_OFFSETS: &'static [usize] = &[88];

The set of address offsets in which any value is changed apart from software operation; e.g. hardware metering.

fn partial_cache( req: &FwReq, node: &FwNode, section: &Section, params: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Cache part of section for fluctuated values, then deserialize for parameters.

impl<O> TcatMutableSectionOperation<GlobalParameters> for O
where O: TcatOperation + TcatSectionSerdes<GlobalParameters>,

fn whole_update( req: &FwReq, node: &FwNode, section: &Section, params: &T, timeout_ms: u32, ) -> Result<(), Error>

Update whole section by the parameters.

fn partial_update( req: &FwReq, node: &FwNode, section: &Section, params: &T, prev: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Update part of section for any change at the parameters.

impl<O> TcatMutableSectionOperation<RxStreamFormatParameters> for O
where O: TcatSectionOperation<RxStreamFormatParameters>,

fn whole_update( req: &FwReq, node: &FwNode, section: &Section, params: &T, timeout_ms: u32, ) -> Result<(), Error>

Update whole section by the parameters.

fn partial_update( req: &FwReq, node: &FwNode, section: &Section, params: &T, prev: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Update part of section for any change at the parameters.

impl<O> TcatMutableSectionOperation<TxStreamFormatParameters> for O
where O: TcatSectionOperation<TxStreamFormatParameters>,

fn whole_update( req: &FwReq, node: &FwNode, section: &Section, params: &T, timeout_ms: u32, ) -> Result<(), Error>

Update whole section by the parameters.

fn partial_update( req: &FwReq, node: &FwNode, section: &Section, params: &T, prev: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Update part of section for any change at the parameters.

impl<O> TcatNotifiedSectionOperation<GlobalParameters> for O
where O: TcatSectionOperation<GlobalParameters>,

const NOTIFY_FLAG: u32 = 112u32

Flag in message notified for any change in section.

fn notified(_: &T, msg: u32) -> bool

Check message to be notified or not.

impl<O> TcatNotifiedSectionOperation<RxStreamFormatParameters> for O
where O: TcatSectionOperation<RxStreamFormatParameters>,

const NOTIFY_FLAG: u32 = 1u32

Flag in message notified for any change in section.

fn notified(_: &T, msg: u32) -> bool

Check message to be notified or not.

impl<O> TcatNotifiedSectionOperation<TxStreamFormatParameters> for O
where O: TcatSectionOperation<TxStreamFormatParameters>,

const NOTIFY_FLAG: u32 = 2u32

Flag in message notified for any change in section.

fn notified(_: &T, msg: u32) -> bool

Check message to be notified or not.

impl<O> TcatSectionOperation<ExtendedSyncParameters> for O
where O: TcatOperation,

fn whole_cache( req: &FwReq, node: &FwNode, section: &Section, params: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Cache whole section and deserialize for parameters.

impl<O> TcatSectionOperation<GlobalParameters> for O
where O: TcatOperation + TcatSectionSerdes<GlobalParameters>,

fn whole_cache( req: &FwReq, node: &FwNode, section: &Section, params: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Cache whole section and deserialize for parameters.

impl<O> TcatSectionOperation<RxStreamFormatParameters> for O
where O: TcatOperation,

fn whole_cache( req: &FwReq, node: &FwNode, section: &Section, params: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Cache whole section and deserialize for parameters.

impl<O> TcatSectionOperation<TxStreamFormatParameters> for O
where O: TcatOperation,

fn whole_cache( req: &FwReq, node: &FwNode, section: &Section, params: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Cache whole section and deserialize for parameters.

impl<O> TcatSectionSerdes<ExtendedSyncParameters> for O
where O: TcatOperation,

const MIN_SIZE: usize = 16usize

Minimum size of section for parameters.

const ERROR_TYPE: GeneralProtocolError = const ERROR_TYPE: GeneralProtocolError = GeneralProtocolError::ExtendedSync;

The type of error.

fn serialize(_: &ExtendedSyncParameters, _: &mut [u8]) -> Result<(), String>

Serialize parameters for section.

fn deserialize( params: &mut ExtendedSyncParameters, raw: &[u8], ) -> Result<(), String>

Deserialize section for parameters.

impl<O> TcatSectionSerdes<GlobalParameters> for O
where O: TcatOperation + TcatGlobalSectionSpecification,

const MIN_SIZE: usize = 96usize

Minimum size of section for parameters.

const ERROR_TYPE: GeneralProtocolError = const ERROR_TYPE: GeneralProtocolError = GeneralProtocolError::Global;

The type of error.

fn serialize(params: &GlobalParameters, raw: &mut [u8]) -> Result<(), String>

Serialize parameters for section.

fn deserialize(params: &mut GlobalParameters, raw: &[u8]) -> Result<(), String>

Deserialize section for parameters.

impl<O> TcatSectionSerdes<RxStreamFormatParameters> for O
where O: TcatOperation,

const MIN_SIZE: usize = 8usize

Minimum size of section for parameters.

const ERROR_TYPE: GeneralProtocolError = const ERROR_TYPE: GeneralProtocolError = GeneralProtocolError::RxStreamFormat;

The type of error.

fn serialize( params: &RxStreamFormatParameters, raw: &mut [u8], ) -> Result<(), String>

Serialize parameters for section.

fn deserialize( params: &mut RxStreamFormatParameters, raw: &[u8], ) -> Result<(), String>

Deserialize section for parameters.

impl<O> TcatSectionSerdes<TxStreamFormatParameters> for O
where O: TcatOperation,

const MIN_SIZE: usize = 8usize

Minimum size of section for parameters.

const ERROR_TYPE: GeneralProtocolError = const ERROR_TYPE: GeneralProtocolError = GeneralProtocolError::TxStreamFormat;

The type of error.

fn serialize( params: &TxStreamFormatParameters, raw: &mut [u8], ) -> Result<(), String>

Serialize parameters for section.

fn deserialize( params: &mut TxStreamFormatParameters, raw: &[u8], ) -> Result<(), String>

Deserialize section for parameters.

impl<O> Tcd22xxOperation for O
where O: Tcd22xxSpecification + TcatExtensionCommandSectionOperation + TcatExtensionSectionParamsOperation<CurrentStreamFormatParams> + TcatExtensionSectionWholeMutableParamsOperation<RouterParams>,

fn detect_available_blocks( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, rate_mode: RateMode, avail_blocks: &mut Tcd22xxAvailableBlocks, timeout_ms: u32, ) -> Result<(), Error>

Detect available source and destination blocks at given rate mode.

fn update_router_entries( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, rate_mode: RateMode, avail_blocks: &Tcd22xxAvailableBlocks, params: &mut RouterParams, timeout_ms: u32, ) -> Result<(), Error>

Update router entries.

fn load_configuration( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, timeout_ms: u32, ) -> Result<(), Error>

Load configuration from on-board flash memory, including parameters in application section.

fn store_configuration( req: &FwReq, node: &FwNode, sections: &ExtensionSections, caps: &ExtensionCaps, timeout_ms: u32, ) -> Result<(), Error>

Store configuration to on-board flash memory, including parameters in application section.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.