From d74cf645aebed0bb063a34b7dca385f1ae0c66a1 Mon Sep 17 00:00:00 2001 From: Marian Buschsieweke Date: Tue, 20 Jul 2021 22:07:00 +0200 Subject: [PATCH] boards/rpi-pico: improve doc - Add note about the OpenOCD version to be used - Make use of proper Doxygen commands --- boards/rpi-pico/doc.txt | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/boards/rpi-pico/doc.txt b/boards/rpi-pico/doc.txt index 57a4dc1686..956f592d06 100644 --- a/boards/rpi-pico/doc.txt +++ b/boards/rpi-pico/doc.txt @@ -79,8 +79,13 @@ the Raspberry Pi Pico showing up as CMSIS-DAP debugger. Afterwards run: make BOARD=rpi-pico flash ``` -***Beware:*** The `rpi-pico` virtual debugger is not persistent and needs to be "flashed" into RAM -again after each cold boot. +@warning The `rpi-pico` virtual debugger is not persistent and needs to be "flashed" into RAM + again after each cold boot. + +@note As of July 2021, the latest stable release of OpenOCD does not yet support the RP2040 + MCU. Instead, compile the current `master` branch from the upstream OpenOCD source. + The OpenOCD fork of the Raspberry Pi foundation is incompatible with OpenOCD + configuration provided, so please stick with upstream OpenOCD. ### Flashing the Board Using the Bootloader