base on A debugging toolset and library for debugging embedded ARM and RISC-V targets on a separate host # probe-rs a modern, embedded debugging toolkit, written in Rust [](https://crates.io/crates/probe-rs) [](https://docs.rs/probe-rs) [](https://github.com/probe-rs/probe-rs/actions) [](https://matrix.to/#/#probe-rs:matrix.org)  The goal of this library is to provide a toolkit to interact with a variety of embedded MCUs and debug probes and provides a direct interface to the debug probe, which then enables other software to use its debug functionality. Additionally the project offers a variety of tools to be used directly for flashing and debugging, such as cargo extensions, a VS Code extension, a GDB server and a standalone CLI. ## Functionality As of version 0.27.0 this library can: - Connect to a DAPLink, STLink, JLink, FTDI probes, ESP32 devices with USB JTAG, WLink and the Blackmagic probe. - Talk to ARM, Risc-V and Xtensa cores via SWD or JTAG. - Read and write arbitrary memory of the target. - Halt, run, step and step any core, operate breakpoints, enable trace functionality and much more. - Download ELF, BIN and IHEX binaries using standard CMSIS-Pack flash algorithms. - Debug a target via the CLI, VSCode (MS-DAP) and GDB. To see what new functionality gets added every release, have a look at the [CHANGELOG](CHANGELOG.md) ## Support If you think probe-rs makes your embedded journey more enjoyable or even earns you money, please consider supporting the project on [Github Sponsors](https://github.com/sponsors/probe-rs/) for better support and more features. ## Tools In addition to being a library, probe-rs also includes a suite of tools which can be used for flashing and debugging. ### Installation The recommended way to install the tools is to download a precompiled version, using one of the methods below. See <https://probe.rs/docs/getting-started/installation> for a more detailed guide. ### cargo-flash The `cargo-flash` utility can be used as a cargo subcommand to download a compiled Rust program onto a target device. It can also be used to download arbitrary ELF files that might come out of a C/C++ compiler. Have a look at [cargo-flash](https://probe.rs/docs/tools/cargo-flash) for more information. ### cargo-embed If you are looking for a more extended debugging experience, please have a look at [cargo-embed](https://probe.rs/docs/tools/cargo-embed) which provides support for GDB, RTT, and config files. ### Editors and IDEs We have implemented the [Microsoft Debug Adapter Protocol (DAP)](https://microsoft.github.io/debug-adapter-protocol/). This makes embedded debugging via probe-rs available in modern code editors implementing the standard, such as VSCode. The DAP website includes [a list of editors and IDEs which support DAP](https://microsoft.github.io/debug-adapter-protocol/implementors/tools/). #### VSCode The probe-rs website includes [VSCode configuration instructions](https://probe.rs/docs/tools/debugger). ## Usage Examples ### Halting the attached chip ```rust,no_run use probe_rs::probe::{list::Lister, Probe}; use probe_rs::Permissions; fn main() -> Result<(), probe_rs::Error> { // Get a list of all available debug probes. let lister = Lister::new(); let probes = async_io::block_on(lister.list_all()); // Use the first probe found. let mut probe = probes[0].open()?; // Attach to a chip. let mut session = probe.attach("nRF52840_xxAA", Permissions::default())?; // Select a core. let mut core = session.core(0)?; // Halt the attached core. core.halt(std::time::Duration::from_millis(10))?; Ok(()) } ``` ### Reading from RAM ```rust,no_run use probe_rs::{MemoryInterface, Permissions, Session, SessionConfig}; use probe_rs::probe::WireProtocol; fn main() -> Result<(), probe_rs::Error> { // Attach to a chip. let speed = Some(5500); let protocol = Some(WireProtocol::Swd); let session_config = SessionConfig { speed, protocol, ..Default::default() }; let mut session = async_io::block_on(Session::auto_attach("nRF52840_xxAA", session_config))?; // Select a core. let mut core = session.core(0)?; // Read a block of 50 32 bit words. let mut buff = [0u32; 50]; core.read_32(0x2000_0000, &mut buff)?; // Read a single 32 bit word. let word = core.read_word_32(0x2000_0000)?; // Writing is just as simple. let buff = [0u32; 50]; core.write_32(0x2000_0000, &buff)?; // of course we can also write 8bit words. let buff = [0u8; 50]; core.write_8(0x2000_0000, &buff)?; Ok(()) } ``` ## FAQ ### I need help! Don't hesitate to [file an issue](https://github.com/probe-rs/probe-rs/issues/new), ask questions on [Matrix](https://matrix.to/#/#probe-rs:matrix.org), or contact [@Yatekii](https://github.com/Yatekii) via e-mail. There is also a [troubleshooting section](https://probe.rs/docs/knowledge-base/troubleshooting) on the [project page](https://probe.rs/). ### How can I help? Please have a look at the issues or open one if you feel that something is needed. Any contributions are very welcome! Also have a look at [CONTRIBUTING.md](CONTRIBUTING.md). ### Our company needs feature X and would pay for its development Please reach out to [@Yatekii](https://github.com/Yatekii) ### Building Building requires Rust and Cargo which can be installed [using rustup](https://rustup.rs/). On Linux these can be installed with your package manager: ```console # Ubuntu > sudo apt install -y libudev-dev # Fedora > sudo dnf install -y libudev-devel ``` ### Adding Targets Target files are generated using [target-gen](https://github.com/probe-rs/probe-rs/tree/master/target-gen) from CMSIS packs provided [here](https://developer.arm.com/tools-and-software/embedded/cmsis/cmsis-search). Generated files are then placed in `probe-rs/targets` for inclusion in the probe-rs project. ### Updating STM32 targets STM32 memory region data has been proven unreliable on multiple occasions. We now rely on [stm32-data](https://github.com/embassy-rs/stm32-data/tree/main) for the correct values. Use target-gen to update the list of devices and their flash algorithms, then use the https://github.com/bugadani/stm-probers tool to regenerate memory maps for all STM32 devices. ### Writing new flash algorithms If there is no CMSIS-Pack with a flash algorithm available, it is necessary to write a target definition and a flash algorithm by oneself. You can use our [template](https://github.com/probe-rs/flash-algorithm-template) for writing an algorithm. Please follow the instructions in the `README.md` in that repo. ## Acknowledgements In early stages of this library, we profited invaluably from the pyOCD code to understand how flashing works. Also it's always a good reference to cross check how ARM specific things work. So, a big thank you to the team behind pyOCD! ## License Licensed under either of - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. ## Contributing Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. ", Assign "at most 3 tags" to the expected json: {"id":"12541","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"