probe-rs 0.31.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

use crate::probe::DebugProbeInfo;
use crate::probe::stlink::StLinkFactory;
use nusb::MaybeFuture;

use super::usb_interface::USB_PID_EP_MAP;
use super::usb_interface::USB_VID;
use std::fmt::Write;

pub(super) fn is_stlink_device(device: &nusb::DeviceInfo) -> bool {
    // Check the VID/PID.
    (device.vendor_id() == USB_VID) && (USB_PID_EP_MAP.contains_key(&device.product_id()))
}

#[tracing::instrument(skip_all)]
pub(super) fn list_stlink_devices() -> Vec<DebugProbeInfo> {
    let devices = match nusb::list_devices().wait() {
        Ok(d) => d,
        Err(e) => {
            tracing::warn!("listing stlink devices failed: {e}");
            return vec![];
        }
    };

    devices
        .filter(is_stlink_device)
        .map(|device| {
            DebugProbeInfo::new(
                format!(
                    "STLink {}",
                    &USB_PID_EP_MAP[&device.product_id()].version_name
                ),
                device.vendor_id(),
                device.product_id(),
                read_serial_number(&device),
                &StLinkFactory,
                None,
                false,
            )
        })
        .collect()
}

/// Try to read the serial number of a USB device.
pub(super) fn read_serial_number(device: &nusb::DeviceInfo) -> Option<String> {
    device.serial_number().map(|s| {
        if s.len() < 24 {
            // Some STLink (especially V2) have their serial number stored as a 12 bytes binary string
            // containing non printable characters, so convert to a hex string to make them printable.
            s.as_bytes().iter().fold(String::new(), |mut s, b| {
                let _ = write!(s, "{b:02X}"); // Writing a String never fails
                s
            })
        } else {
            // Other STlink (especially V2-1) have their serial number already stored as a 24 characters
            // hex string so they don't need to be converted
            s.to_string()
        }
    })
}