Struct probe_rs::Probe

pub struct Probe { /* fields omitted */ }

The Probe struct is a generic wrapper over the different probes supported.

Examples

Open the first probe found

The list_all and from_probe_info functions can be used to create a new Probe:

use probe_rs::Probe;

let probe_list = Probe::list_all();
let probe = Probe::open(&probe_list[0]);

Implementations

impl Probe

pub fn new(probe: impl DebugProbe + 'static) -> Self

pub fn from_specific_probe(probe: Box<dyn DebugProbe>) -> Self

pub fn list_all() -> Vec<DebugProbeInfo>

Get a list of all debug probes found. This can be used to select the debug probe which should be used.

pub fn open(
    selector: impl Into<DebugProbeSelector> + Clone
) -> Result<Self, DebugProbeError>

Create a Probe from DebugProbeInfo. Use the Probe::list_all() function to get the information about all probes available.

pub fn get_name(&self) -> String

Get human readable name for the probe

pub fn attach(self, target: impl Into<TargetSelector>) -> Result<Session, Error>

Attach to the chip.

This runs all the necessary protocol init routines.

If this doesn’t work, you might want to try attach_under_reset

pub fn attach_to_unspecified(&mut self) -> Result<(), Error>

pub fn attach_to_unspecified_under_reset(&mut self) -> Result<(), Error>

pub fn attach_under_reset(
    self,
    target: impl Into<TargetSelector>
) -> Result<Session, Error>

Attach to the chip under hard-reset.

This asserts the reset pin via the probe, plays the protocol init routines and deasserts the pin. This is necessary if the chip is not responding to the SWD reset sequence. For example this can happen if the chip has the SWDIO pin remapped.

pub fn select_protocol(
    &mut self,
    protocol: WireProtocol
) -> Result<(), DebugProbeError>

Selects the transport protocol to be used by the debug probe.

pub fn detach(&mut self) -> Result<(), DebugProbeError>

Leave debug mode

pub fn target_reset(&mut self) -> Result<(), DebugProbeError>

Resets the target device.

pub fn target_reset_deassert(&mut self) -> Result<(), DebugProbeError>

pub fn set_speed(&mut self, speed_khz: u32) -> Result<u32, DebugProbeError>

Configure protocol speed to use in kHz

pub fn speed_khz(&self) -> u32

Configured protocol speed in kHz

pub fn has_arm_interface(&self) -> bool

Check if the probe has an interface to debug ARM chips.

pub fn try_into_arm_interface<'probe>(
    self
) -> Result<Box<dyn UninitializedArmProbe + 'probe>, (Self, DebugProbeError)>

Try to get a trait object implementing UninitializedArmProbe, which can can be used to communicate with chips using the ARM architecture.

If an error occurs while trying to connect, the probe is returned.

pub fn has_riscv_interface(&self) -> bool

Check if the probe has an interface to debug RISCV chips.

pub fn try_into_riscv_interface(
    self
) -> Result<RiscvCommunicationInterface, (Self, DebugProbeError)>

Try to get a RiscvCommunicationInterface, which can can be used to communicate with chips using the RISCV architecture.

If an error occurs while trying to connect, the probe is returned.

pub fn get_swo_interface(&self) -> Option<&dyn SwoAccess>

pub fn get_swo_interface_mut(&mut self) -> Option<&mut dyn SwoAccess>

pub fn try_as_dap_probe(&mut self) -> Option<&mut dyn DapProbe>

Trait Implementations

impl Debug for Probe

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.