Trait probe_rs::DebugProbe[−][src]

pub trait DebugProbe: Send + Debug {

Show 19 methods    fn new_from_selector(
        selector: impl Into<DebugProbeSelector>
    ) -> Result<Box<Self>, DebugProbeError>
    where
        Self: Sized;

    fn get_name(&self) -> &str;

    fn speed(&self) -> u32;

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

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

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

    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 into_probe(self: Box<Self>) -> Box<dyn DebugProbe>;

    fn has_arm_interface(&self) -> bool { ... }

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

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

    fn has_riscv_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> { ... }

}

Required methods

Get human readable name for the probe

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.

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.

Attach to the chip.

This should run all the necessary protocol init routines.

Detach from the chip.

This should run all the necessary protocol deinit routines.

This should hard reset the target device.

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

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

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

Provided methods

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

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

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

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

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

Implementors