framework_lib 0.6.2

Library to control Framework Computer systems
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

//! Parse content of UEFI capsule binaries
//!
//! Specific to those used by Framework. The UEFI specification does not
//! specify the structure of a capsule's content.
//use core::prelude::rust_2021::derive;

use crate::alloc::string::ToString;
use alloc::string::String;
use core::convert::TryInto;

use crate::ccgx::binary::{CCG5_PD_LEN, CCG6_PD_LEN, CCG8_PD_LEN};
use crate::ec_binary::EC_LEN;
use crate::util;

pub fn find_retimer_version(data: &[u8]) -> Option<u16> {
    let needle = b"$_RETIMER_PARAM_";
    let found = util::find_sequence(data, needle)?;
    let offset = found + 0x8 + needle.len();
    let bytes = &data[offset..offset + 2];
    Some(u16::from_le_bytes(bytes.try_into().ok()?))
}

pub struct BiosCapsule {
    pub platform: String,
    pub version: String,
}

pub fn find_bios_version(data: &[u8]) -> Option<BiosCapsule> {
    let needle = b"$BVDT";
    let found = util::find_sequence(data, needle)?;

    // One of: GFW30, HFW3T, HFW30, IFR30, KFM30, JFP30, LFK30, IFGA3, IFGP6, LFR20, LFSP0
    let platform_offset = found + 0xA + needle.len() - 1;
    let platform = std::str::from_utf8(&data[platform_offset..platform_offset + 5])
        .map(|x| x.to_string())
        .ok()?;

    let ver_offset = found + 0x10 + needle.len() - 1;
    let version = std::str::from_utf8(&data[ver_offset..ver_offset + 5])
        .map(|x| x.to_string())
        .ok()?;

    Some(BiosCapsule { platform, version })
}

pub fn find_ec_in_bios_cap(data: &[u8]) -> Option<&[u8]> {
    let needle = b"$_IFLASH_EC_IMG_";
    let found = util::find_sequence(data, needle)?;
    let ec_offset = found + 0x9 + needle.len() - 1;
    Some(&data[ec_offset..ec_offset + EC_LEN])
}

pub fn find_pd_in_bios_cap(data: &[u8]) -> Option<&[u8]> {
    // Just search for the first couple of bytes in PD binaries
    // TODO: There's a second one but unless the capsule is bad, we can assume
    // they're the same version
    let ccg5_needle = &[0x00, 0x20, 0x00, 0x20, 0x11, 0x00];
    let ccg6_needle = &[0x00, 0x40, 0x00, 0x20, 0x11, 0x00];
    let ccg8_needle = &[0x00, 0x80, 0x00, 0x20, 0xAD, 0x0C];
    if let Some(found_pd1) = util::find_sequence(data, ccg5_needle) {
        Some(&data[found_pd1..found_pd1 + CCG5_PD_LEN])
    } else if let Some(found_pd1) = util::find_sequence(data, ccg6_needle) {
        Some(&data[found_pd1..found_pd1 + CCG6_PD_LEN])
    } else if let Some(found_pd1) = util::find_sequence(data, ccg8_needle) {
        Some(&data[found_pd1..found_pd1 + CCG8_PD_LEN])
    } else {
        None
    }
}