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
73
74
75
76
77
78
79

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

//! External synchronization section in general protocol defined by TCAT for ASICs of DICE.
//!
//! The module includes structure, enumeration, and trait and its implementation for external
//! synchronization section in general protocol defined by TCAT for ASICs of DICE.

use super::{global_section::*, *};

pub struct ExtSyncBlock(Vec<u8>);

impl ExtSyncBlock {
    const SIZE: usize = 0x10;

    const SYNC_SRC_OFFSET: usize = 0x00;
    const SYNC_LOCKED_OFFSET: usize = 0x04;
    const SYNC_RATE_OFFSET: usize = 0x08;
    const SYNC_ADAT_DATA_BITS: usize = 0x0c;

    const ADAT_USER_DATA_MASK: u32 = 0x0f;
    const ADAT_USER_DATA_UNAVAIL: u32 = 0x10;

    pub fn get_sync_src(&self) -> ClockSource {
        let mut quadlet = [0; 4];
        quadlet.copy_from_slice(&self.0[Self::SYNC_SRC_OFFSET..(Self::SYNC_SRC_OFFSET + 4)]);
        ClockSource::from(u32::from_be_bytes(quadlet) as u8)
    }

    pub fn get_sync_src_locked(&self) -> bool {
        let mut quadlet = [0; 4];
        quadlet.copy_from_slice(&self.0[Self::SYNC_LOCKED_OFFSET..(Self::SYNC_LOCKED_OFFSET + 4)]);
        u32::from_be_bytes(quadlet) > 0
    }

    pub fn get_sync_src_rate(&self) -> ClockRate {
        let mut quadlet = [0; 4];
        quadlet.copy_from_slice(&self.0[Self::SYNC_RATE_OFFSET..(Self::SYNC_RATE_OFFSET + 4)]);
        ClockRate::from(u32::from_be_bytes(quadlet) as u8)
    }

    pub fn get_sync_src_adat_user_data(&self) -> Option<u8> {
        let mut quadlet = [0; 4];
        quadlet
            .copy_from_slice(&self.0[Self::SYNC_ADAT_DATA_BITS..(Self::SYNC_ADAT_DATA_BITS + 4)]);
        let val = u32::from_be_bytes(quadlet);
        if val & Self::ADAT_USER_DATA_UNAVAIL > 0 {
            None
        } else {
            Some((val & Self::ADAT_USER_DATA_MASK) as u8)
        }
    }
}

/// Protocol implementaion of external synchronization section.
#[derive(Default)]
pub struct ExtSyncSectionProtocol;

impl ExtSyncSectionProtocol {
    pub fn read_block(
        req: &mut FwReq,
        node: &mut FwNode,
        sections: &GeneralSections,
        timeout_ms: u32,
    ) -> Result<ExtSyncBlock, Error> {
        if sections.ext_sync.size < ExtSyncBlock::SIZE {
            let msg = format!(
                "Ext sync section has {} less size than {} expected",
                sections.ext_sync.size,
                ExtSyncBlock::SIZE
            );
            Err(Error::new(FileError::Nxio, &msg))
        } else {
            let mut data = vec![0; sections.ext_sync.size];
            GeneralProtocol::read(req, node, sections.ext_sync.offset, &mut data, timeout_ms)
                .map(|_| ExtSyncBlock(data))
        }
    }
}