Skip to main content

FieldSafeArm

Struct FieldSafeArm 

Source
pub struct FieldSafeArm {
    probe: Box<FieldSafeProbe>,
    table: Option<DapTable>,
}
Expand description

The ARM debug interface over a FieldSafeProbe.

Serves DP/AP register traffic from a DapTable and memory through the base’s 32-bit memory commands (via FieldSafeMemory). Only the default debug port and AP0 exist.

Fields§

§probe: Box<FieldSafeProbe>

The probe, owned while the interface is in use and handed back by [ArmDebugInterface::close].

§table: Option<DapTable>

The DAP answers for the part, chosen on first use from its chip ID.

Implementations§

Source§

impl FieldSafeArm

Source

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

The DAP table for the connected part: L4 or U3 by DBGMCU IDCODE, read with the debug-register command every base supports.

Cached after the first success, so the part is identified once per session.

§Errors

[ArmError::Probe] with “chip identification” if neither IDCODE address reads plausibly (no tag, an unpowered tag, or another part).

Source

fn read_words(&mut self, address: u32, data: &mut [u32]) -> Result<(), ArmError>

Reads data.len() words at address with READMEM_32BIT, in chunks of at most CHUNK bytes.

address must be word-aligned, as probe-rs guarantees for 32-bit accesses. The core is not halted for the read.

§Errors

[ArmError::Probe] (“memory read”) if any chunk fails, e.g. on a bus fault; data is then left unchanged.

Source

fn write_words(&mut self, address: u32, data: &[u32]) -> Result<(), ArmError>

Writes data at address with WRITEMEM_32BIT, in chunks of at most CHUNK bytes.

address must be word-aligned.

§Errors

[ArmError::Probe] (“memory write”) if any chunk fails; earlier chunks have then already been written.

Source

fn read_bytes(&mut self, address: u32, data: &mut [u8]) -> Result<(), ArmError>

Reads data.len() bytes at any alignment with whole-word reads.

Reads the enclosing aligned words and copies out the bytes asked for, so up to 3 bytes either side are also read from the target.

§Errors

As read_words.

Source

fn write_bytes(&mut self, address: u32, data: &[u8]) -> Result<(), ArmError>

Writes bytes at any alignment by read-modify-write of whole words.

The bytes either side of data within the edge words are written back with the values just read. That is not atomic: anything the target changes in those bytes between the read and the write is lost, so this is only safe for memory the core is not using (probe-rs uses it for halted-core SRAM and flash-algorithm buffers), never for peripheral registers.

§Errors

As read_words and write_words.

Trait Implementations§

Source§

impl ArmDebugInterface for FieldSafeArm

Source§

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

Does nothing: the DAP state is the table’s, and the base keeps the link up itself.

Source§

fn access_ports( &mut self, _dp: DpAddress, ) -> Result<BTreeSet<FullyQualifiedApAddress>, ArmError>

Returns AP0 on the default DP, the only access port these parts use.

Source§

fn close(self: Box<Self>) -> Probe

Hands the FieldSafeProbe back as an unattached probe-rs [Probe].

The base stays in SWD mode; the probe is only ever dropped afterwards, which detaches it.

Source§

fn select_debug_port(&mut self, dp: DpAddress) -> Result<(), ArmError>

Accepts only the default DP; multidrop SWD is not supported.

Source§

fn current_debug_port(&self) -> Option<DpAddress>

Always the default DP.

Source§

fn memory_interface( &mut self, access_port: &FullyQualifiedApAddress, ) -> Result<Box<dyn ArmMemoryInterface + '_>, ArmError>

Returns a FieldSafeMemory for AP0; any other AP is refused.

Source§

impl DapAccess for FieldSafeArm

Source§

fn read_raw_dp_register( &mut self, _dp: DpAddress, address: DpRegisterAddress, ) -> Result<u32, ArmError>

Answers DP register reads from the DapTable without touching the wire.

DPIDR gets the part’s value; CTRL/STAT (bank 0) reports debug and system power-up requested and acknowledged, which ends probe-rs’s power-up handshake; everything else reads 0. The bases’ own READ_DAP_REG cannot be used: old firmware returns stale data for it.

Source§

fn write_raw_dp_register( &mut self, _dp: DpAddress, _address: DpRegisterAddress, _value: u32, ) -> Result<(), ArmError>

Accepts and ignores DP register writes; the base powers up and selects the DAP itself on SWD entry.

Source§

fn read_raw_ap_register( &mut self, ap: &FullyQualifiedApAddress, address: u64, ) -> Result<u32, ArmError>

Answers AP register reads from the DapTable without touching the wire.

AP0 reports its CSW, BASE and IDR; other registers read 0. Any AP other than AP0 reads 0 throughout, which probe-rs takes as “no AP”.

Source§

fn write_raw_ap_register( &mut self, _ap: &FullyQualifiedApAddress, _address: u64, _value: u32, ) -> Result<(), ArmError>

Accepts and ignores AP register writes: memory never goes through TAR/DRW, and the base’s memory commands set CSW themselves.

Source§

fn try_dap_probe(&self) -> Option<&dyn DapProbe>

Returns None: there is no raw DAP access to offer.

Source§

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

Returns None: there is no raw DAP access to offer.

§

fn read_raw_ap_register_repeated( &mut self, ap: &FullyQualifiedApAddress, addr: u64, values: &mut [u32], ) -> Result<(), ArmError>

Read multiple values from the same Access Port register. Read more
§

fn write_raw_ap_register_repeated( &mut self, ap: &FullyQualifiedApAddress, addr: u64, values: &[u32], ) -> Result<(), ArmError>

Write multiple values to the same Access Port register. Read more
§

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

Flush any outstanding operations. Read more
Source§

impl Debug for FieldSafeArm

Source§

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

Formats the value using the given formatter. Read more
Source§

impl SwdSequence for FieldSafeArm

Source§

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

Refuses raw SWJ bit sequences (line resets, JTAG-to-SWD switches); the base performs those itself on SWD entry.

Source§

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

Drives nRST when that is the only pin selected; refuses any other pin.

probe-rs’s reset sequences use this to assert and release reset. Returns pin_out as the pin state read back; pin_wait is ignored.

Source§

impl SwoAccess for FieldSafeArm

Source§

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

Refuses: the bases do not capture SWO.

Source§

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

Does nothing; SWO is never enabled.

Source§

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

Refuses: the bases do not capture SWO.

§

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

Read any available SWO data without waiting. Read more
§

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

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

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

Request the probe SWO buffer size, if known.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ApAccess for T
where T: DapAccess,

§

fn read_ap_register<PORT, R>(&mut self, port: &PORT) -> Result<R, ArmError>
where PORT: AccessPortType + ApRegAccess<R> + ?Sized, R: ApRegister,

Read a register of the access port.
§

fn write_ap_register<PORT, R>( &mut self, port: &PORT, register: R, ) -> Result<(), ArmError>
where PORT: AccessPortType + ApRegAccess<R> + ?Sized, R: ApRegister,

Write a register of the access port.
§

fn write_ap_register_repeated<PORT, R>( &mut self, port: &PORT, values: &[u32], ) -> Result<(), ArmError>
where PORT: AccessPortType + ApRegAccess<R> + ?Sized, R: ApRegister,

Write a register of the access port using a block transfer. This can be used to write multiple values to the same register.
§

fn read_ap_register_repeated<PORT, R>( &mut self, port: &PORT, values: &mut [u32], ) -> Result<(), ArmError>
where PORT: AccessPortType + ApRegAccess<R> + ?Sized, R: ApRegister,

Read a register of the access port using a block transfer. This can be used to read multiple values from the same register.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> DpAccess for T
where T: DapAccess + ?Sized,

§

fn read_dp_register<R>(&mut self, dp: DpAddress) -> Result<R, ArmError>
where R: DpRegister,

Reads a debug port register. Read more
§

fn write_dp_register<R>( &mut self, dp: DpAddress, register: R, ) -> Result<(), ArmError>
where R: DpRegister,

Write a debug port register. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more