probe-rs 0.31.0

A collection of on chip debugging tools to communicate with microchips.
Documentation
//! Target specific configuration
//!
//! For debugging and flashing different chips, called *target* in probe-rs, some
//! target specific configuration is required. This includes the architecture of
//! the chip, e.g. RISC-V or ARM, and information about the memory map of the target,
//! which can be used together with a flash algorithm to program the flash memory
//! of a target.
//!
//!
//! ## Built-in targets
//!
//! The built-in targets are added at build-time, from the `build.rs` script.
//! They are generated from the target files in the `targets/` subfolder of this
//! crate.
//!
//! The built-in targets can be disabled by not including the `builtin-targets` feature.
//!
//! ## Adding targets at runtime
//!
//! Targets are collected in a [`Registry`] in families. A registry with the built-in
//! targets can be created via the [`Registry::from_builtin_families`] function.
//! To add a target at runtime, use [Registry::add_target_family]. The target family
//! is a [`ChipFamily`] struct, usually read from a target description YAML file.

mod chip_info;
pub(crate) mod registry;
mod target;

pub use probe_rs_target::{
    Chip, ChipFamily, Core, CoreType, Endian, FlashProperties, GenericRegion, InstructionSet,
    MemoryAccess, MemoryRange, MemoryRegion, NvmRegion, PageInfo, RamRegion, RawFlashAlgorithm,
    ScanChainElement, SectorDescription, SectorInfo, TargetDescriptionSource,
};

pub use registry::{Registry, RegistryError};
pub use target::{DebugSequence, Target, TargetSelector};

// Crate-internal API
pub(crate) use chip_info::ChipInfo;
pub(crate) use target::CoreExt;