Struct StLink

pub struct StLink<D: StLinkUsb> { /* private fields */ }

An ST-Link debugger and programmer.

Implementations

impl<D: StLinkUsb> StLink<D>

pub fn set_swd_frequency( &mut self, frequency: SwdFrequencyToDelayCount, ) -> Result<(), DebugProbeError>

sets the SWD frequency.

pub fn set_jtag_frequency( &mut self, frequency: JTagFrequencyToDivider, ) -> Result<(), DebugProbeError>

Sets the JTAG frequency.

pub fn start_trace_reception( &mut self, config: &SwoConfig, ) -> Result<(), DebugProbeError>

Starts reading SWO trace data.

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

Stops reading SWO trace data.

Trait Implementations

impl<D: Debug + StLinkUsb> Debug for StLink<D>

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

Formats the value using the given formatter.

impl DebugProbe for StLink<StLinkUsbDevice>

fn get_name(&self) -> &str

Get human readable name for the probe.

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 set_scan_chain( &mut self, scan_chain: Vec<ScanChainElement>, ) -> Result<(), DebugProbeError>

Set the JTAG scan chain information for the target under debug.

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

Returns the JTAG scan chain

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

Attach to the chip.

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

Detach from the chip.

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

This should hard reset the target device.

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 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 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 has_arm_interface(&self) -> bool

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

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 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.

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

Selects the JTAG TAP to be used for communication.

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.

fn has_riscv_interface(&self) -> bool

Check if the probe offers an interface to debug RISC-V chips.

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

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

fn has_xtensa_interface(&self) -> bool

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

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

Try creating a DAP interface for the given probe.

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

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

impl<D: StLinkUsb> Drop for StLink<D>

fn drop(&mut self)

Executes the destructor for this type.

impl<D: StLinkUsb> SwoAccess for StLink<D>

fn enable_swo(&mut self, config: &SwoConfig) -> Result<(), ArmError>

Configure a SwoAccess interface for reading SWO data.

fn disable_swo(&mut self) -> Result<(), ArmError>

Disable SWO reading on this SwoAccess interface.

fn read_swo_timeout(&mut self, timeout: Duration) -> Result<Vec<u8>, ArmError>

Read SWO data for up to timeout duration.

fn read_swo(&mut self) -> Result<Vec<u8>, ArmError>

Read any available SWO data without waiting.

fn swo_poll_interval_hint(&mut self, config: &SwoConfig) -> Option<Duration>

Request an estimated best time to wait between polls of read_swo.

fn swo_buffer_size(&mut self) -> Option<usize>

Request the probe SWO buffer size, if known.