Struct probe_rs::Core

pub struct Core<'probe> { /* fields omitted */ }

Implementations

impl<'probe> Core<'probe>

pub fn new(
    core: impl CoreInterface + 'probe,
    state: &'probe mut CoreState
) -> Core<'probe>

pub fn create_state(id: usize) -> CoreState

pub fn id(&self) -> usize

pub fn wait_for_core_halted(&mut self, timeout: Duration) -> Result<(), Error>

Wait until the core is halted. If the core does not halt on its own, a DebugProbeError::Timeout error will be returned.

pub fn core_halted(&mut self) -> Result<bool, Error>

Check if the core is halted. If the core does not halt on its own, a DebugProbeError::Timeout error will be returned.

pub fn halt(&mut self, timeout: Duration) -> Result<CoreInformation, Error>

Try to halt the core. This function ensures the core is actually halted, and returns a DebugProbeError::Timeout otherwise.

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

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

Reset the core, and then continue to execute instructions. If the core should be halted after reset, use the reset_and_halt function.

pub fn reset_and_halt(
    &mut self,
    timeout: Duration
) -> Result<CoreInformation, Error>

Reset the core, and then immediately halt. To continue execution after reset, use the reset function.

pub fn step(&mut self) -> Result<CoreInformation, Error>

Steps one instruction and then enters halted state again.

pub fn status(&mut self) -> Result<CoreStatus, Error>

pub fn read_core_reg(
    &mut self,
    address: impl Into<CoreRegisterAddress>
) -> Result<u32, Error>

pub fn write_core_reg(
    &mut self,
    address: CoreRegisterAddress,
    value: u32
) -> Result<(), Error>

pub fn get_available_breakpoint_units(&mut self) -> Result<u32, Error>

pub fn registers(&self) -> &'static RegisterFile

pub fn set_hw_breakpoint(&mut self, address: u32) -> Result<(), Error>

Set a hardware breakpoint

This function will try to set a hardware breakpoint. The amount of hardware breakpoints which are supported is chip specific, and can be queried using the get_available_breakpoint_units function.

pub fn clear_hw_breakpoint(&mut self, address: u32) -> Result<(), Error>

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

Clear all hardware breakpoints

This function will clear all HW breakpoints which are configured on the target, regardless if they are set by probe-rs, AND regardless if they are enabled or not. Also used as a helper function in Session::drop.

pub fn architecture(&self) -> Architecture

Trait Implementations

impl<'probe> MemoryInterface for Core<'probe>

fn read_word_32(&mut self, address: u32) -> Result<u32, Error>

Read a 32bit word of at address.

fn read_word_8(&mut self, address: u32) -> Result<u8, Error>

Read an 8bit word of at address.

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

Read a block of 32bit words at address.

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

Read a block of 8bit words at address.

fn write_word_32(&mut self, addr: u32, data: u32) -> Result<(), Error>

Write a 32bit word at address.

fn write_word_8(&mut self, addr: u32, data: u8) -> Result<(), Error>

Write an 8bit word at address.

fn write_32(&mut self, addr: u32, data: &[u32]) -> Result<(), Error>

Write a block of 32bit words at address.

fn write_8(&mut self, addr: u32, data: &[u8]) -> Result<(), Error>

Write a block of 8bit words at address.

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

Flush any outstanding operations.

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

Reads bytes using 32 bit memory access. Address must be 32 bit aligned and data must be an exact multiple of 4.

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

Read a block of 8bit words at address. May use 32 bit memory access, so should only be used if reading memory locations that don’t have side effects. Generally faster than read_8.