Struct probe_rs::probe::Probe

pub struct Probe { /* private fields */ }

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::{Probe, list::Lister};

let lister = Lister::new();

let probe_list = lister.list_all();
let probe = probe_list[0].open();

Implementations

impl Probe

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

Create a new probe from a more specific probe driver.

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

Same as Probe::new but without automatic boxing in case you already have a box.

pub fn get_name(&self) -> String

Get the human readable name for the probe.

pub fn attach( self, target: impl Into<TargetSelector>, permissions: Permissions ) -> 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 Probe::attach_under_reset

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

Attach to a target without knowing what target you have at hand. This can be used for automatic device discovery or performing operations on an unspecified target.

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

A combination of Probe::attach_to_unspecified and Probe::attach_under_reset.

pub fn attach_under_reset( self, target: impl Into<TargetSelector>, permissions: Permissions ) -> 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 protocol(&self) -> Option<WireProtocol>

Get the currently selected protocol

Depending on the probe, this might not be available.

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

Leave debug mode

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

Resets the target device.

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

Asserts the reset of the target. This is always the hard reset which means the reset wire has to be connected to work.

This is not supported on all probes.

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

Deasserts the reset of the target. This is always the hard reset which means the reset wire has to be connected to work.

This is not supported on all probes.

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

Configure protocol speed to use in kHz

pub fn set_scan_chain( &mut self, scan_chain: Vec<ScanChainElement> ) -> Result<(), DebugProbeError>

Configure the scan chain to use for the attached target.

See DebugProbe::set_scan_chain for more information and usage

pub fn scan_chain(&self) -> Result<&[ScanChainElement], DebugProbeError>

Returns the JTAG scan chain

pub fn select_jtag_tap(&mut self, index: usize) -> Result<(), DebugProbeError>

Selects the JTAG TAP to be used for communication.

pub fn speed_khz(&self) -> u32

Get the currently used maximum speed for the debug protocol in kHz.

Not all probes report which speed is used, meaning this value is not always the actual speed used. However, the speed should not be any higher than this value.

pub fn has_xtensa_interface(&self) -> bool

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

pub fn try_get_xtensa_interface<'probe>( &'probe mut self, state: &'probe mut XtensaDebugInterfaceState ) -> Result<XtensaCommunicationInterface<'probe>, DebugProbeError>

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

The user is responsible for creating and managing the XtensaDebugInterfaceState state object.

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

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 RISC-V chips.

pub fn try_get_riscv_interface_builder<'probe>( &'probe mut self ) -> Result<Box<dyn RiscvInterfaceBuilder<'probe> + 'probe>, DebugProbeError>

Try to get a RiscvInterfaceBuilder object, which can be used to set up a communication interface with chips using the RISC-V architecture.

The returned object can be used to create the interface state, which is required to attach to the RISC-V target. The user is responsible for managing this state object.

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

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

Gets a SWO interface from the debug probe.

This does not work on all probes.

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

Gets a mutable SWO interface from the debug probe.

This does not work on all probes.

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

Gets a DAP interface from the debug probe.

This does not work on all probes.

pub fn get_target_voltage(&mut self) -> Result<Option<f32>, DebugProbeError>

Try reading the target voltage of via the connected voltage pin.

This does not work on all probes.

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

Try to get a J-Link interface from the debug probe.

Trait Implementations

impl Debug for Probe

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

Formats the value using the given formatter.