Struct probe_rs::FakeProbe

pub struct FakeProbe { /* private fields */ }

This is a mock probe which can be used for mocking things in tests or for dry runs.

Implementations

impl FakeProbe

pub fn new() -> Self

Creates a new FakeProbe for mocking.

pub fn set_dap_register_read_handler(
    &mut self,
    handler: Box<dyn Fn(PortType, u8) -> Result<u32, DebugProbeError> + Send>
)

This sets the read handler for DAP register reads. Can be used to hook into the read.

pub fn set_dap_register_write_handler(
    &mut self,
    handler: Box<dyn Fn(PortType, u8, u32) -> Result<(), DebugProbeError> + Send>
)

This sets the write handler for DAP register writes. Can be used to hook into the write.

pub fn into_probe(self) -> Probe

Makes a generic probe out of the FakeProbe

Trait Implementations

impl Debug for FakeProbe

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

Formats the value using the given formatter.

impl DebugProbe for FakeProbe

fn get_name(&self) -> &str

Get human readable name for the probe

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

Leave debug mode

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

Resets the target device.

fn new_from_selector(
    _selector: impl Into<DebugProbeSelector>
) -> Result<Box<Self>, DebugProbeError> where
    Self: Sized, 

Creates a new boxed DebugProbe from a given DebugProbeSelector. This will be called for all available debug drivers when discovering probes. When opening, it will open the first probe which succeds during this call.

fn speed_khz(&self) -> u32

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

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

Set the speed in kHz used for communication with the target device.

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

Attach to the chip.

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

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

fn active_protocol(&self) -> Option<WireProtocol>

Get the transport protocol currently in active use by the debug probe.

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

This should assert the reset pin of the target via debug probe.

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

This should deassert the reset pin of the target via debug probe.

fn into_probe(self: Box<Self>) -> Box<dyn DebugProbe>

Boxes itself.

fn try_get_arm_interface<'probe>(
    self: Box<Self>
) -> Result<Box<dyn UninitializedArmProbe + 'probe>, (Box<dyn DebugProbe>, DebugProbeError)>

Get the dedicated interface to debug ARM chips. To check that the probe actually supports this, call DebugProbe::has_arm_interface first.

fn has_arm_interface(&self) -> bool

Check if the proble offers an interface to debug ARM chips.

fn try_get_riscv_interface(
    self: Box<Self>
) -> Result<RiscvCommunicationInterface, (Box<dyn DebugProbe>, DebugProbeError)>

Get the dedicated interface to debug RISCV chips. Ensure that the probe actually supports this by calling DebugProbe::has_riscv_interface first.

fn has_riscv_interface(&self) -> bool

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

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

Get a SWO interface from the debug probe.

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

Get a mutable SWO interface from the debug probe.

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

Try creating a DAP interface for the given probe.

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

Reads the target voltage in Volts, if possible. Returns Ok(None) if the probe doesn’t support reading the target voltage.

impl Default for FakeProbe

fn default() -> Self

Returns the “default value” for a type.

impl RawDapAccess for FakeProbe

fn raw_read_register(
    &mut self,
    port: PortType,
    addr: u8
) -> Result<u32, DebugProbeError>

Reads the DAP register on the specified port and address

fn raw_write_register(
    &mut self,
    port: PortType,
    addr: u8,
    value: u32
) -> Result<(), DebugProbeError>

Writes a value to the DAP register on the specified port and address

fn select_dp(&mut self, _dp: DpAddress) -> Result<(), DebugProbeError>

Select the debug port to operate on.

fn swj_sequence(
    &mut self,
    _bit_len: u8,
    _bits: u64
) -> Result<(), DebugProbeError>

Send a specific output sequence over JTAG or SWD.

fn swj_pins(
    &mut self,
    _pin_out: u32,
    _pin_select: u32,
    _pin_wait: u32
) -> Result<u32, DebugProbeError>

Set the state of debugger output pins directly.

fn into_probe(self: Box<Self>) -> Box<dyn DebugProbe>

Cast this interface into a generic DebugProbe.

fn raw_read_block(
    &mut self,
    port: PortType,
    addr: u8,
    values: &mut [u32]
) -> Result<(), DebugProbeError>

Read multiple values from the same DAP register.

fn raw_write_block(
    &mut self,
    port: PortType,
    addr: u8,
    values: &[u32]
) -> Result<(), DebugProbeError>

Write multiple values to the same DAP register.

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

Flush any outstanding writes.