Struct probe_rs::Core

pub struct Core { /* fields omitted */ }

Methods

impl Core

pub fn new(core: impl CoreInterface + 'static) -> Self

pub fn auto_attach(target: impl Into<TargetSelector>) -> Result<Core, Error>

pub fn wait_for_core_halted(&self) -> 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(&self) -> Result<bool, Error>

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

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

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

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

pub fn reset(&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(&self) -> Result<CoreInformation, Error>

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

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

Steps one instruction and then enters halted state again.

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

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

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

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

pub fn memory(&self) -> Memory

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

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

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

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

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

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

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

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

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>

Trait Implementations

impl MemoryInterface for Core

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

Read a 32bit word of at addr.

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

Read an 8bit word of at addr.

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

Read a block of 32bit words at addr.

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

Read a block of 8bit words at addr.

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

Write a 32bit word at addr.

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

Write an 8bit word at addr.

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

Write a block of 32bit words at addr.

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

Write a block of 8bit words at addr.