intel_fw 0.1.2

Parsing and editing library for Intel firmware images
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

#![doc = include_str!("../README.md")]

use log::{info, warn};
use serde::{Deserialize, Serialize};

pub mod dir;
pub mod fit;
pub mod ifd;
pub mod me;
pub mod meta;
pub mod part;
pub mod ver;

use fit::{Fit, FitError};
use ifd::{IFD, IfdError};
use me::ME;

// An empty byte in a NOR flash is all-1's.
pub const EMPTY: u8 = 0xff;

/// Common method for anything that has removable parts, such as directories.
pub trait Removables {
    /// Get removable ranges relative to the start of a section or directory.
    /// The respective section/directory needs to know its own offset.
    fn removables(&self, retention_list: &[String]) -> Vec<core::ops::Range<usize>>;
}

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Firmware {
    pub ifd: Result<IFD, IfdError>,
    pub me: Option<Result<ME, String>>,
    pub fit: Result<Fit, FitError>,
}

impl Firmware {
    pub fn parse(data: &[u8], debug: bool) -> Self {
        let ifd = IFD::parse(data);
        let me = match &ifd {
            Ok(ifd) => {
                let me_region = ifd.regions.me_range();
                let b = me_region.start;
                info!("ME region start @ {b:08x}");
                ME::parse(&data[me_region], b, debug)
            }
            Err(e) => {
                warn!("Not a full image: {e:?}");
                ME::parse(data, 0, debug)
            }
        };
        let fit = Fit::new(data);
        Self { ifd, me, fit }
    }

    pub fn scan(data: &[u8], debug: bool) -> Self {
        let ifd = IFD::parse(data);
        let me = ME::scan(data, debug);
        let fit = Fit::new(data);
        Self { ifd, me, fit }
    }
}

/// Dump first 48 bytes of a slice. Meant solely for debugging.
/// Tip: If you need context to investigate data, pass a reference to
/// `data[offset-16..]` instead of `data[offset..]`.
pub(crate) fn dump48(data: &[u8]) {
    println!("Here are 48 bytes:");
    println!(" {:02x?}", &data[0x00..0x10]);
    println!(" {:02x?}", &data[0x10..0x20]);
    println!(" {:02x?}", &data[0x20..0x30]);
}