firewire-dice-protocols 0.1.1

Implementation of protocols defined by TC Applied Technologies for ASICs of Digital Interface Communication Engine (DICE) as well as hardware vendors.
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

// SPDX-License-Identifier: LGPL-3.0-or-later
// Copyright (c) 2020 Takashi Sakamoto

//! Current configuration section in protocol extension defined by TCAT for ASICs of DICE.
//!
//! The module includes structure, enumeration, and trait and its implementation for current
//! configuration section in protocol extension defined by TCAT for ASICs of DICE.

use super::{
    router_entry::*,
    stream_format_entry::*,
    {caps_section::*, cmd_section::*, *},
};

/// Protocol implementation of current configuration section.
#[derive(Default)]
pub struct CurrentConfigSectionProtocol;

impl CurrentConfigSectionProtocol {
    const LOW_ROUTER_CONFIG_OFFSET: usize = 0x0000;
    const LOW_STREAM_CONFIG_OFFSET: usize = 0x1000;
    const MID_ROUTER_CONFIG_OFFSET: usize = 0x2000;
    const MID_STREAM_CONFIG_OFFSET: usize = 0x3000;
    const HIGH_ROUTER_CONFIG_OFFSET: usize = 0x4000;
    const HIGH_STREAM_CONFIG_OFFSET: usize = 0x5000;

    pub fn read_current_router_entries(
        req: &mut FwReq,
        node: &mut FwNode,
        sections: &ExtensionSections,
        caps: &ExtensionCaps,
        mode: RateMode,
        timeout_ms: u32,
    ) -> Result<Vec<RouterEntry>, Error> {
        let offset = match mode {
            RateMode::Low => Self::LOW_ROUTER_CONFIG_OFFSET,
            RateMode::Middle => Self::MID_ROUTER_CONFIG_OFFSET,
            RateMode::High => Self::HIGH_ROUTER_CONFIG_OFFSET,
        };

        let mut data = [0; 4];
        let offset = sections.current_config.offset + offset;
        extension_read(req, node, offset, &mut data, timeout_ms)
            .map_err(|e| Error::new(ProtocolExtensionError::CurrentConfig, &e.to_string()))?;

        let entry_count = std::cmp::min(
            u32::from_be_bytes(data) as usize,
            caps.router.maximum_entry_count as usize,
        );

        read_router_entries(req, node, caps, offset + 4, entry_count, timeout_ms)
            .map_err(|e| Error::new(ProtocolExtensionError::CurrentConfig, &e.to_string()))
    }

    pub fn read_current_stream_format_entries(
        req: &mut FwReq,
        node: &mut FwNode,
        sections: &ExtensionSections,
        caps: &ExtensionCaps,
        mode: RateMode,
        timeout_ms: u32,
    ) -> Result<(Vec<FormatEntry>, Vec<FormatEntry>), Error> {
        let offset = match mode {
            RateMode::Low => Self::LOW_STREAM_CONFIG_OFFSET,
            RateMode::Middle => Self::MID_STREAM_CONFIG_OFFSET,
            RateMode::High => Self::HIGH_STREAM_CONFIG_OFFSET,
        };
        let offset = sections.current_config.offset + offset;
        read_stream_format_entries(req, node, caps, offset, timeout_ms)
            .map_err(|e| Error::new(ProtocolExtensionError::CurrentConfig, &e.to_string()))
    }
}