STM32CubeIDEでprintf【SWO編】

STM32CubeIDEでprintfを使う時、UARTを採用することが多いと思いますが、いつもUARTが余っているとは限りません。実はSWOでもprintfを利用することができます。本記事では、SWOを使ってprintfする方法をわかりやすく解説します。

はじめに下記の画像をご覧になってください。デバッグ実行中の画面をキャプチャしてものです。printf出力が画面下部のコンソールに出力されているのがわかると思います。

SWO出力を使うことでSWDの線だけでこれを実現することができます。

SWOを使ってIDEにprintf出力

SWDとかSWOとかよくわからないですか？その場合は、ST-Linkが繋がってればprintfが使えるようになる、とだけ認識してくれれば大丈夫ですよ。

それでは具体的にその実現方法を解説していきます。

１．前提条件
- ２－１．プロジェクトの作成
２．printfの準備
３．デバッグ時にprintf出力を行う
４．非デバッグ時にprintf出力を行う
- ４－１．プログラムの書き込み
- ４－２．Printf via SWO Viewerで確認
５．おわりに

１．前提条件

今回は下記の環境を前提に話を進めます。STLinkはNUCLEO-F401REに実装されているものをそのまま使いました。

STM32CubeIDE ver.1.00
NUCLEO-F401RE

もし、自前の基板を使っている場合は別途ST-Linkを用意してください。ST-Linkを用意する方法は2通りありますので、お好きな方法で選んでください。

ST-Link
- 素直にST-Linkを用意する方法です。
- 配線方法は公式のマニュアルを参照してください。V2のマニュアルはこちら。
- 非公式のST-LinkだとSWO線がないものがあるようなので、よく確認してください
NUCLEOボードをST-Linkとして使う
- NUCLEOボードをST-Linkとして使うことができます
- 配線方法は公式のマニュアルを参照してください。NUCLEO-F401REのマニュアルはこちら。

２－１．プロジェクトの作成

まずは適当にプロジェクトを作成してください。Device Configuration Tool（CubeMX）で特別な設定は必要ありません。

２．printfの準備

２－２．printfの実装

printfを実装してSWOに出力するようにしてあげましょう。下記のコードをコピペしてください。

main.c

/* USER CODE BEGIN 4 */
int _write(int file, char *ptr, int len)
{
  int DataIdx;
  for(DataIdx=0; DataIdx<len; DataIdx++)
  {
    ITM_SendChar(*ptr++);
  }
  return len;
}
/* USER CODE END 4 */

２－３．stdio.hのインクルード

stdio.hのインクルードは忘れずに入れておきましょう。

main.c

/* USER CODE BEGIN Includes */
#include <stdio.h>
/* USER CODE END Includes */

２－４．printfの追加

とりあえず今回は定期的に『Hello World!!』を出力するようなプログラムを書きました。

main.c

/* USER CODE BEGIN WHILE */
while (1)
{
  /* USER CODE END WHILE */
    printf("Hello World!!\r\n");
    HAL_Delay(1000);
  /* USER CODE BEGIN 3 */
}
/* USER CODE END 3 */

３．デバッグ時にprintf出力を行う

プログラム側の準備はできたので、ここからは実際にprintf出力をしてみましょう。デバッグ中と非デバッグ中でprintfの確認方法が異なるので、まずはデバッグ中での方法を解説します。

下記の画像が使用イメージです。SWV（Serial Wire Viewer）という機能を使ってprintf出力を確認します。

SWOでデバッグ中にprintfするシステム構成

３－１．デバッグの設定

SWVを使うにはデバッグの設定を適切に行う必要があります。

プロジェクトを右クリック→Debug as→STM32 C/C++ Application
デバッガタブ→シリアルワイヤビューワ(SWV)の有効にチェックを入れてください
Clock Settings→Core Clockにマイコンのクロック数を入力してください
Debugボタンを押してデバッグを開始してください
main関数の先頭でデバッグが止まりますが、まだそのままにしてください

SWOデバッグ設定

３－２．SWVの起動

printf出力を表示するためのコンソールを起動します。

メニュー→Window→Show View→Others…
SWV→SWV ITM Data Consoleを開いてください
開いたら設定ボタンを押して、SWVの設定ウィンドウを開いてください
画面下部のチェックボックスの一番右の1つだけチェックを入れてください

SWV設定

これでprintf出力用のコンソールの準備ができました。

３－３．動作確認をする

それでは実際に表示させてみましょう。

SWVのスタートボタン（赤い丸）を押して受信を開始してください
デバッグの再開ボタンを押してデバッグを実行してください

SWVスタート

SWVに『Hello World!!』が追加されていくはずです。確認してみてください。

SWOを使ってIDEにprintf出力

表示されてますね！お疲れ様です！

なお、デバッグの開始後にSWVのスタートボタンは毎回押す必要があります。ちょっと面倒ではありますが忘れないようにしてくださいね。

もし、表示されない場合は、SWOのピンを別の機能でアサインしているのかもしれません。設定をよく確認してみてください。あるいは、Device Configuration Toolを開いて、System Core ->SYS->Mode->Debugを「Serial Wire」から「Trace Asynchronous Sw」にしてください。SWOのピンをSWO専用としてくれます。（このピンはSWO以外の用途には使えなくなります）