probe-rs/probe-rs
Probe Rs
probe-rs is an embedded debugging toolset used for flashing, debugging, and inspecting microcontrollers via hardware debug probes. It functions as an embedded firmware flasher, a memory manager for reading and writing to processor registers, and a server implementing the Debug Adapter Protocol to connect hardware debugging to various code editors.
The project includes a CMSIS-Pack target parser to extract device metadata and flash configurations from industry-standard definition files. It provides a driver-based probe abstraction to interact with various hardware debug probes regardless of the underlying transport protocol.
The toolset covers processor execution management, including the ability to halt, run, or step through code and manage hardware breakpoints. It supports real-time target monitoring through high-speed data streaming and log capture via ringbuffers. Additional capabilities include hosting a GDB server and exporting data channels through network sockets for external analysis.
Features
- Firmware Flashing - Downloads and executes compiled binary firmware on target microcontrollers using debug probes and flash algorithms.
- Embedded Systems Debugging - Provides a comprehensive toolset for flashing, debugging, and inspecting embedded microcontrollers via hardware debug probes.
- Device Metadata Definitions - Parses metadata files to resolve device-specific memory maps, flash algorithms, and processor core details.
- Debug Adapter Protocol Implementations - Implements a server that provides the Debug Adapter Protocol to allow various code editors to control hardware debugging.
- Breakpoint Debugging - Provides the ability to halt, run, and step through code on a target core using hardware breakpoints.
- Register and Variable Monitors - Allows real-time monitoring and modification of core registers and program variables during execution.
- Microcontroller Flashers - Uploads compiled binary firmware to target microcontrollers using device-specific flash algorithms.
- RAM-Based Flash Algorithms - Executes device-specific RAM programs on the target to write binary data into non-volatile flash memory.
- Direct Memory Access - Provides direct read and write access to the raw memory addresses of a target microcontroller.
- Execution Flow Control - Enables stepping through code at instruction levels and managing hardware breakpoints to analyze program flow.
- Register State Inspectors - Provides utilities to inspect and manipulate CPU register values to track and control program state.
- Target Memory Managers - Provides a system for reading and writing to the memory and registers of a target processor.
- Debug Probe Interfaces - Provides a driver-based abstraction layer to interface with various hardware debug probes.
- Hardware Configuration Extraction - Parses device configuration files to generate simplified descriptions containing critical metadata and binary data.
- GDB Server Implementations - Hosts a network interface that allows external GDB debuggers to control target hardware and inspect internal state.
- CMSIS-Pack Parsers - Extracts device metadata and flash configurations from industry-standard CMSIS-Pack target definition files.
- Debug Probe Abstractions - Provides a mechanism to connect to microcontrollers using standard probe drivers or custom hardware logic.
- Device Support Configurations - Provides the capability to create new device support configurations using standard device packs or custom flash algorithms.
- Embedded Data Streaming - Implements a high-speed duplex communication mechanism using ringbuffers for transferring data between host and target.
- Real-Time Target Monitoring - Streams logs and data channels from a microcontroller to a host computer for live system observation.
- Debug Data Streams - Uses ringbuffers for high-speed duplex streaming of real-time debug logs and telemetry between host and target.
- Real-Time Application Log Monitoring - Streams data from target logging channels (RTT) to a terminal for real-time system monitoring.
- Embedded Log Capture - Retrieves execution logs and stack traces from a target device using standardized logging protocols.
- Development Tools - Modern debugging toolkit for embedded hardware.
- Embedded Development - Toolkit for flashing and debugging ARM/RISC-V microcontrollers.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
