probe-rs 0.32.0

A collection of on chip debugging tools to communicate with microchips.
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

//! # Extract metadata from an object file

use tracing::warn;

use object::Object;
use object::ObjectSection;

/// Contains probe-rs-meta information. This information gives hints about how the binary
/// should be run, and other information specified with the `probe_rs_meta` crate.
#[derive(Clone, Debug, Default)]
pub struct ElfMetadata {
    /// `probe_rs_meta crate version`
    pub version: String,
    /// `probe_rs_meta::chip`
    pub chip: Option<String>,
    /// `probe_rs_meta::timeout`
    pub timeout: Option<u64>,
}

impl ElfMetadata {
    /// Construct probe-rs-meta information from unparsed bytes
    pub fn from_elf(elf: &[u8]) -> Result<Self, object::Error> {
        let file = object::File::parse(elf)?;

        Self::from_object(&file)
    }

    /// Construct probe-rs-meta information from a parsed object
    pub fn from_object(file: &object::File) -> Result<Self, object::Error> {
        let mut version = String::default();
        let mut chip = None;
        let mut timeout = None;

        if let Some(section) = file.section_by_name(".probe-rs.version") {
            let data = section.data()?;
            if !data.is_empty() {
                match String::from_utf8(data.to_vec()) {
                    Ok(s) => version = s,
                    Err(_) => warn!(".probe-rs.version contents are not a valid utf8 string."),
                }
            }
        }

        if let Some(section) = file.section_by_name(".probe-rs.chip") {
            let data = section.data()?;
            if !data.is_empty() {
                match String::from_utf8(data.to_vec()) {
                    Ok(s) => chip = Some(s),
                    Err(_) => warn!(".probe-rs.chip contents are not a valid utf8 string."),
                }
            }
        }

        if let Some(section) = file.section_by_name(".probe-rs.timeout") {
            let data = section.data()?;
            if data.len() == 4 {
                timeout = Some(u32::from_le_bytes(data.try_into().unwrap()) as u64)
            } else {
                warn!(".probe-rs.timeout contents are not a valid u32.")
            }
        }

        Ok(Self {
            version,
            chip,
            timeout,
        })
    }
}