devpath 1.0.1

UEFI Device Path parsing 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
59
60

//! Baseboard Management Controller Device Path
//!
//! This module implements the BMC device path node as defined in UEFI 2.11 specification
//! section 10.3.1.6. This device path describes a BMC (Baseboard Management Controller)
//! device and the method to access it.

use crate::parser::{ByteOrder, Invalid, Parser};
use crate::{Error, Head};

/// BMC interface types as defined in the UEFI specification
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum Type {
    /// Unknown BMC interface type
    Unknown,

    /// Keyboard Controller Style BMC interface
    KeyboardControllerStyle,

    /// Server Management Interface Chip BMC interface  
    ServerManagementInterfaceChip,

    /// Block Transfer BMC interface
    BlockTransfer,
}

impl Parser<Type> for &[u8] {
    type Arg = ();

    fn parse(&mut self, arg: Self::Arg) -> Result<Type, Invalid> {
        match self.parse(arg)? {
            0x00u8 => Ok(Type::Unknown),
            0x01u8 => Ok(Type::KeyboardControllerStyle),
            0x02u8 => Ok(Type::ServerManagementInterfaceChip),
            0x03u8 => Ok(Type::BlockTransfer),
            _ => Err(Invalid),
        }
    }
}

/// BMC Device Path (SubType 0x06)
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Bmc {
    /// The type of BMC interface
    pub kind: Type,

    /// Base address of the BMC interface
    pub addr: u64,
}

impl<'a> TryFrom<Head<'a>> for Bmc {
    type Error = Error;

    fn try_from(mut node: Head<'a>) -> Result<Self, Self::Error> {
        Ok(Self {
            kind: node.data.parse(())?,
            addr: node.data.finish(ByteOrder::Little)?,
        })
    }
}