Raspberry Pi Debug ProbeでPicoをデバッグする

こんにちは、ENGかぴです。

Raspberry Pi Debug Probeを使用するとソースコードの１行ごとにブレークポイントを張って動作確認ができるため、効率の良い開発が行えます。Pico SDKを使用したDebug Probeを使い方の例をまとめました。

下記記事のソースコードを使ってDebug Probeのデバッグ方法を説明しています。

Raspberry Pi Pico（以下Picoとする）と拡張基板のGrove Shield for Pi Picoを使用しています。

VSCodeのダウンロードとインストールの方法やVSCodeにPicoの開発環境を追加する方法は下記記事を参考にしてください。

Picoを使用してArduino IDEやVSCodeで動作確認したことをまとめています。

Debug Probeを使用する

Debug Probeの説明や接続例は下記リンクに記載されていますが、ここではデバッグするソフトに合わせた回路図にDebug Probeを接続した例を示しています。

Debug Probeの接続方法はPicoのDEBUGピンを使用しますが、シリアルモニターを使用する場合はUART Port（UARTを使用）を追加することができます。

基本的にデバッグはDEBUGピン（SWCLK・SWDIO・GNDの３ピン）を使いますが、シリアルモニターからデータを送信/受信してデバッグを行う場合は、UART portをPicoのUARTのピン（例ではUART0に配線）を使用します。

デバッグ（以下ではPico SDKに倣ってPico Debugと表記）の目的はソースコードを一時的にストップするブレークポイントを張って１行ずつステップ実行しながら演算の結果や変数・レジスタの値を確認し、想定通りの動作になっているかの確認することです。

シリアルモニターにprint()関数を使って表示しながらデバッグする方法もありますが、確認のためにコンパイルとソフトの書き込みを繰り返す必要があり面倒です。

Pico Debugを使用するとブレークポイントを張ってピンポイントでバグの調査ができるのがメリットです。

本記事では、シリアルモニターを外部機器と想定して電文を送信し、ブレークポイントを張って受信したデータを確認します。

VSCodeの左の欄に「実行とデバッグ」のアイコンがあるのでクリックすると実行とデバッグを行う方式が選択できます。デフォルトでPico Debug(Cortex-Debug)が選択されています。

Debug ProbeはOpenOCDを起動した環境下で動作するように設計されていますが、VSCodeの拡張機能がOpenOCDを起動するためデフォルトの設定でデバッグすることができます。

Pico Debug(Cortex-Debug with external OpenOCD)は自分でインストールしたOpenOCDを起動して使用する方式でVSCodeに設定を追加する必要がありますが、OpenOCDの設定を調整できるなど上級者向けの設定です。

OpenOCDの詳細設定しなくても手軽にデバッグができるため、デフォルトのPico Debug(Cortex-Debug)を使用することを推奨します。

デバッグの方式を選択した後、横の▷ボタンをクリックしてデバッグを開始します。デバッグはコンパイルに成功するとスタートします。コンパイルエラーの場合はデバッグを開始することができません。

デバッグを開始するとデバッグツールが表示されます。デバッグツールはCPUのリセット、ステップイン、ステップオーバーなどのアイコンが表示されています。

デバッグを開始するとmain()関数の先頭にカーソルが移動しているので続行を選択すると処理がスタートします。ブレークポイントを張っていない場合は、通常の動作になります。デバッグツールの内容は以下の通りです。

項目	内容	ショートカット
Reset Device	DEBUGピンを使ってCPUの初期化する。	なし
続行	ブレークポイントまで処理を進める。	F5
停止	続行を一時停止する。	F6
ステップイン	関数の内部に入って１行ずつ処理する。	F11
ステップオーバー	関数の処理を飛び越えて次の行に進む。	F10
ステップアウト	ステップインやブレークポイントで関数内に入った後、関数を抜けるまで処理を進めて次の行に進む。	Shift+F10
再起動	電源の入/切によって再起動する。（BOOTモードに遷移できる）	Ctrl+Shift+F5
停止	デバッカーの接続を切断する。	Shift+F5