pcics 0.3.2

PCI configuration space access library
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

/*!
# Vital Product Data

Vital Product Data (VPD) is the information that uniquely defines items such as the hardware,
software, and microcode elements of a system.

## Struct diagram
[VitalProductData]

## Examples

```rust
# use pcics::capabilities::vital_product_data::*;
let data = [0x03, 0x58, 0x8c, 0x81, 0x00, 0x00, 0x00, 0x78,];
let result = data[2..].try_into().unwrap();
let sample = VitalProductData {
    vpd_address: 0x018c,
    transfer_completed: true,
    vpd_data: 0x78000000,
};
assert_eq!(sample, result);
```
*/

use heterob::{bit_numbering::Lsb, endianness::Le, Seq, P2};

use super::CapabilityDataError;

/// Vital Product Data
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct VitalProductData {
    /// DWORD-aligned byte address of the VPD to be accessed
    pub vpd_address: u16,
    /// Indicate when the transfer of data between the VPD Data register and the storage component
    /// is completed
    pub transfer_completed: bool,
    /// VPD Data
    pub vpd_data: u32,
}
impl TryFrom<&[u8]> for VitalProductData {
    type Error = CapabilityDataError;

    fn try_from(slice: &[u8]) -> Result<Self, Self::Error> {
        let Seq {
            head: Le((word, vpd_data)),
            ..
        } = P2(slice).try_into().map_err(|_| CapabilityDataError {
            name: "Vital Product Data",
            size: 6,
        })?;
        let Lsb((vpd_address, transfer_completed)) = P2::<u16, 15, 1>(word).into();
        Ok(Self {
            vpd_address,
            transfer_completed,
            vpd_data,
        })
    }
}