Trait DebugProbe

Source

pub trait DebugProbe:
    Any
    + Send
    + Debug {
Show 22 methods    // Required methods
    fn get_name(&self) -> &str;
    fn speed_khz(&self) -> u32;
    fn set_speed(&mut self, speed_khz: u32) -> Result<u32, DebugProbeError>;
    fn attach(&mut self) -> Result<(), DebugProbeError>;
    fn detach(&mut self) -> Result<(), Error>;
    fn target_reset(&mut self) -> Result<(), DebugProbeError>;
    fn target_reset_assert(&mut self) -> Result<(), DebugProbeError>;
    fn target_reset_deassert(&mut self) -> Result<(), DebugProbeError>;
    fn select_protocol(
        &mut self,
        protocol: WireProtocol,
    ) -> Result<(), DebugProbeError>;
    fn active_protocol(&self) -> Option<WireProtocol>;
    fn into_probe(self: Box<Self>) -> Box<dyn DebugProbe>;

    // Provided methods
    fn has_arm_interface(&self) -> bool { ... }
    fn try_as_jtag_probe(&mut self) -> Option<&mut dyn JtagAccess> { ... }
    fn try_get_arm_debug_interface<'probe>(
        self: Box<Self>,
        _sequence: Arc<dyn ArmDebugSequence>,
    ) -> Result<Box<dyn ArmDebugInterface + 'probe>, (Box<dyn DebugProbe>, ArmError)> { ... }
    fn try_get_riscv_interface_builder<'probe>(
        &'probe mut self,
    ) -> Result<Box<dyn RiscvInterfaceBuilder<'probe> + 'probe>, RiscvError> { ... }
    fn has_riscv_interface(&self) -> bool { ... }
    fn try_get_xtensa_interface<'probe>(
        &'probe mut self,
        _state: &'probe mut XtensaDebugInterfaceState,
    ) -> Result<XtensaCommunicationInterface<'probe>, XtensaError> { ... }
    fn has_xtensa_interface(&self) -> bool { ... }
    fn get_swo_interface(&self) -> Option<&dyn SwoAccess> { ... }
    fn get_swo_interface_mut(&mut self) -> Option<&mut dyn SwoAccess> { ... }
    fn try_as_dap_probe(&mut self) -> Option<&mut dyn DapProbe> { ... }
    fn get_target_voltage(&mut self) -> Result<Option<f32>, DebugProbeError> { ... }
}

Expand description

An abstraction over a general debug probe.

This trait has to be implemented by ever debug probe driver.

Required Methods§

Source

fn get_name(&self) -> &str

Get human readable name for the probe.

Source

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.

Source

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

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

The desired speed might not be supported by the probe. If the desired speed is not directly supported, a lower speed will be selected if possible.

If possible, the actual speed used is returned by the function. Some probes cannot report this, so the value may be inaccurate.

If the requested speed is not supported, DebugProbeError::UnsupportedSpeed will be returned.

Source

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

Attach to the chip.

This should run all the necessary protocol init routines.

Source

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

Detach from the chip.

This should run all the necessary protocol deinit routines.

If the probe uses batched commands, this will also cause all remaining commands to be executed. If an error occurs during this execution, the probe might remain in the attached state.

Source