Windows10対応軽量シンプルな環境でARMマイコンをInsightとOpenOCDを使ってデバッグする(2020年度版)

20230711追記！！！
GCC12でビルドされたelfファイルは下記のinsightを使った
方法ではスムーズにデバッグできません！！
現在GDB+CodeLiteによる新しい時代に即したデバッグ
手順を作成しておりますので完成まで今しばらく、
いましばらくお待ちくださいませ！！！１１！！



OpenOCD for Windows is HERE!
↑ねむいさんは自前ビルドのOpenOCDバイナリ公開してます。
　解説はこのバイナリを基にすすめますので4649!



この記事は前回からの続きです。前回のものよりちょっと内容が難しくなってます。
前回の内容を基に環境を構築していることが前提で話を進めさせていただきます。
今回はOpenOCDを使用し実際にARMマイコンにJTAG/SWD経由でフラッシュ書き込み
そしてデバッグを行うところまでいきます。
もちろん今回も軽量動作,NO-Eclipse,NO-Cygwinです。

※今回の記事も時代に合わせて適宜加筆修正していきます。


●必要なもの
　1.ARMマイコンが実装されたターゲットボード
　　凡例として、STM32F4シリーズであるSTM32F4Discoveryを使用します。
　　私が配布しているSTM32F4向けのFatFs移植例は、デフォルトのターゲットボードが
　　STM32F4Discovery、デバッガハードウエアがSTLink/V2となっています。
　　Nucleo系板や2015年以降発売のDiscovery系板はSTLink/V2-1に変ってます。
　　
↑とりあえず何も編集しなくてもよくなってます。

　2.JTAG/SWDデバッガハードウエア
　　上記のCortex-M4はデバッグユニットとしてJTAGとSWDという接続方式の両方を
　　サポートしています。ARM7TDMIはJTAGインターフェースのみでした。

　　現在、ホビーユーザーが手軽に利用できるものとしてFT2232系を使ったJTAG
　　デバイスが主流です。
　　以後の解説はそれを利用したJTAGKey2互換の"JTAGKey2 Compatible"
　　を使用しJTAG接続にて解説していきます。
　　JTAGKey2 Comatibleを自作される方はこちらの解説を参考に。

　　SWD接続についてはCMSIS-DAPが現在の主流となっています。
　　NxP系の評価ボードにはmbed版としてデフォルトで搭載されているので
　　もはやおなじみだと思います。
　　その他の品種ではVersaloonや上記のJTAGKey2CompatibleでもSWD接続可能に
　　なっています。
　　
　　2023年現在はCortex-M系マイコンが主流となり、SWD接続がデファクト・
　　スタンダードなっております。
　　

　3.OpenOCD
　　OpenOCDはターゲットMCU(ARMマイコン)と後述するgdb/insightの仲介役を
　　果たすフラッシュ書き込み機能を持ったサーバープログラムです。
　　ねむいさん謹製のビルド済みバイナリを用意しておりますので、
　　OpenOCDのWindowsバイナリはこちらからダウンロードしてください。

　　注意すべきはデバッガハードウエアに対するドライバで、上記リンクに
　　あるOpenOCDバイナリは下記のデバイスとドライバをサポートしています。
　　*JTAGKey2をはじめとしたFT2232系デバイス:(WinUSB)
　　*Versaloon:(WinUSB)
　　*STLink/v2:(STMicro純正/WinUSB)
　　*TI-ICDI(Stellaris Launchpad):(TI純正/WinUSB)
　　*J-Link(WinUSB)
　　*J-Link On LPCLink2(WinUSB)
　　*CMSIS-DAP(HIDとしてドライバレスだがmbed版はVCPドライバ必須)
　　*STLink/V2-1(VCPドライバ必須)


　　各ドライバのインストールは以前は、PID/VID調べてINFファイルを作って
　　…と非常にめんどくさかったのですが、現在はWinUSB向けのGUIな汎用
　　インストーラのzadigを使用することによりインストールが大幅に簡略化され、
　　手軽になりましたのでzadigでインストールを行ってください。
　　公式のサイトにはインストール手順も英文で懇切丁寧に書かれていますが
　　見る必要も無いくらい簡単にWinUSBが導入可能です。

　　注：このOpenOCDは32bit版ですが64bit版Windows環境でも問題なく動作します。
　　　　　64bit版OpenOCDと比べて速度的な面で大差はないです。

　　ARMは新旧の情報がweb上のいたるところで倒錯しすぎて何が正しい組み合わせか
　　分からないと思います。Windows環境でOpenOCDを使われる方は私のぶろぐを
　　しっかり見ていただければ途方に暮れることだけは避けられるかと思います。


　４．Insight(gdb-gui)
　　InsightはgdbのGUI版です。また、純粋なフロントエンドではなく内部にGDB
　　そのものが取り込まれているので別途gdb.exeを用意する必要はありません。
　　当ぶろぐではこれを使用しソースコードレベルのデバッグを行います。
　　これも詳細は後述しますがバイナリが配布されていますのでビルドする必要は
　　ありません。



●下準備
　１．OpenOCDの準備
　　かつてWindows環境にてMSYS/MinGWを用いた手順を公開しておりましたが、
　　OpnOCD0.8.0以降はビルドするまでの手順が大幅に煩雑になり慣れてない
　　人にはビルドがほぼ不可能になってしまいましたので公開を廃止しました。
　　代わりとしましてビルド済のWindowsバイナリを公開しております。
　　ご利用ください。インストール箇所は前回のビルド環境構築手順に倣い、　　
　　C:/devz/arm/ocdにあるものとします。


　２．Insightの準備
　　SourceForgeにあるNetXのページのかなり下のほうにある
　　"arm-none-eabi-insight-7.4.50.20111222-cvs-mingw32-netx.0.7z"を
　　ダウンロードし、任意のフォルダに展開してください。
　　こちらもC:/devz/arm/insight/binにあるものとします。


●ターゲットデバイスにプログラムをダウンロード
　　前回の手順を参考にSTM32F4-Discovery用のmain.elfが作成されたものとします。
　　デバッグ時は最適化オプションを必ず"-O0"にしてビルドしてください。

　１．makeファイルの編集
　　前回も解説しましたが、makefileにあるOpenOCDとInsightがインストール
　　されているパスを指定してください。
　　
　　Insightの引数は下図下段の要領で"--eval-command"で渡すように記述します。
　　Insight起動後のTargetの設定は一切不要です。引数の内訳は以下の通り
　　　--eval-command="target remote localhost:3333"
　　　　-> TCP3333番ポートに接続
　　　--eval-command="tbreak main"　　　　　　　　　
　　　　-> 接続後main関数の先頭で一時停止
　　　-nx　　　　　　　　　　　　　　　　　　　　　　
　　　　-> .gdbinitを作成しない&内容無視
　　

　２．PN2の設定
　　PN2の"TOOL"から呼び出すことが出来るように前回と同じ要領で引数つきで登録し
　　てください。登録するのは"program"と"debug"です。

　３．書き込み
　　"TOOL"から"make program"を呼び出し、OpenOCDからSTM32のフラッシュ
　　書き込みスクリプトを呼び出しターゲットデバイスに"main.elf"を
　　ダウンロードします。
　　OpenOCDのcfgファイルのパスの指定が間違っているとエラーが出ますので
　　各自の環境に合わせてパスを修正してください。
　　

　４．フラッシュ書き込み用のコマンドについて補足
　　makefile内では以下のように記述されています。
　　1.OpenOCDをJTAG・SWDデバイスのcfgファイル・ターゲットMCUのcfg
　　　ファイルを"-f"コマンドで指定して起動する。
　　2.同時に-cのコマンドでターゲットMCUのcfgに記述されているproc(関数)
　　　を呼び出す。
　　3.procに記載されている順にコマンドが実行されフラッシュ書き込みを行う。

　　上記一連の動作にてgdbやtelnetからの回りくどい操作は一切要せず、簡単に
　　フラッシュの書き込み動作が可能です。

●ターゲットデバイスをInsightを使用しデバッグ
　１．makeファイルの編集
　　正しくプログラムが書き込まれたことを確認したら次はデバッグです。
　　makeでOpenOCDとInsightを同時起動するためにちょっと工夫を凝らしています。
　　先に定義したディレクトリパスやコマンドを下記のように配置して、
　　クリック一発で呼び出しできるようにします。
　　

　２．OpenOCD・Insightの起動と接続
　　"TOOL"から"make debug"を呼び出すと、OpenOCDがターゲットMCUに接続、
　　その後Insightが起動します。
　　さらにOpenOCDとInsightのTCP接続まで一気に進み画像のようになれば成功です。
　　

　　ここで注意ですがWin10ではInsightのメニューにあるTarget Settings関連を
　　いじるとInsightが固まってしまい動作不能になるため絶対に
　　触らないでください！

　　この状態で"Continue"を押すとmain関数の最初の行、一時的にmain()に張った
　　ブレークポイント(main()の最初の行)に飛びます。このブレークポイントは
　　一時的なものですぐに消えるのでリソースの無駄にもなりません。
　　
　　
　　ここまできたらあとはInsight上でステップインとかステップアウトとか
　　ブレークポイント張って停止させたりレジスタとかメモリとか(条件付で)
　　I/Oレジスタの値読み出したり自由自在です！

　　また、デバッグ時の重大な注意ですが、Win10ではInsightのレジスタ
　　ウインドウを開くと100%落ちてしまいますので面倒くさいですがコマンド
　　ウインドウから"monitor reg"でMCUの各レジスタを参照するようにしてください。
　　

　３．デバッグの終了
　　終了する時はTools->Stop Toolsで終了させたいところですがが、PN2では
　　ひとつのプログラムしか終了できず、Insightだけが終了してOpenOCDが
　　終了してくれません。
　　私は下記の要領で強制的にタスクを殺すwindowsのtaskkillコマンドを使った
　　バッチファイルを作成してこれを呼び出して"確実に"終了させています。
　　↓この呪文をバッチファイルにしてwindowsフォルダに突っ込んで
　　　おきましょう。
　　taskkill /F /IM openocd.exe
　　taskkill /F /IM arm-none-eabi-insight.exe
　　

Comments

STM32F407ZGT6_FatFS_DISP_20120425
ではコンパイルできましたが、
STM32F407xGT6_FatFS_DISP_20120520
では、
MSGECHO = "echo.exe"
に変更された影響で止まります。

DEVTOOL = LAUNCHPAD
で試しました。


  • 寝太郎
  • 2012/06/07 6:11 PM

寝太郎様、はじめまして。
ねむいです。


2012年5月中旬以降に公開している私のコードはビルド時に
Windows内部コマンド｢ECHO｣と競合するのを防ぐため、Unix
ライクツールの｢echo.exe｣を明示して使用(ダブルクォー
テーションでくくる)を行うようにしています。

それ故にecho.exeまでのパスが通っていないとエラーで
止まります(パスはmakefile内で設定しています)。


nemuisan.blog.bai.ne.jp/?eid=188089
↑のURLの手順を正しく踏まれた上でまだエラーで止まる
のであればこちらの説明に手落ちがある可能性があります
ので、再現確認のために下記の詳細を教えてください。
1.使用しているOS(Win7の場合は32bitか64bitか)
2.上記URLで指定しているサポートツールはCoreutils
　とWinAVRのutilsのどちらを使用しているか
2.ARM以外の開発環境を使用しているか
3.環境変数PATHの設定に2.の環境があるディレクトリ
　が含まれているか

先の2つのバージョンは同一環境で実行しています。

/usr/bin/sh: -c: line 1: unexpected EOF while looking for matching `"'
/usr/bin/sh: -c: line 2: syntax error: unexpected end of file
make: *** [clean] Error 258

とのエラーを見て
nemuisan.blog.bai.ne.jp/?eid=188089
を読んで
>MSGECHO = "echo.exe"　<-ダブルクォーテーションでくくる

の経緯があったことを知り、ダブルクォートを外したら
コンパイルは通ってくれましたので、前回のコメントを
書きました。

1.WindowsXP 32bit
2.WinAVR
　　　MAKEDIR = C:/WinAVR-20100110/utils/bin
3.含まれています。
　　コマンドプロンプトで試すと
　　>echo.exe hoge
　　>.exe hoge　　　　内部コマンドのECHOが呼ばれている様子
　　>"echo.exe" hoge
　　>hoge
　　となり、パスは通っており、ファイル検索でも他に
　　echo.exeは見つかりませんでした。

以上、遅くなりましたが報告させて頂きます。

  • 寝太郎
  • 2012/06/29 12:50 PM

寝太郎様こんばんは、ねむいです。

ご連絡ありがとうございます。寝太郎様の情報をもとにこちらでも
試してみましたが、WinAVR(20100110版)のインストール時に環境変数PATH
にWinAVRのパスを追加を選んだ場合、問題が再現しました。PATHを追加
しない場合は発生しないのでPATHに追加されたWinAVRのパスが原因です。

WinAVRのインストーラはPATHの一番頭に自身のパスをねじ込んでくるので、
複数環境持ちだとちょっと面倒なことになります。
…とはいえAVRToolchainに変った今でもWinAVRを愛用されてる方は多数い
ますので、次回の更新時からはmakefileを見直してダブルクォーテーション
を含まないecho.exeでも表示が崩れないようにちょっと工夫してみますね。

同じく私が公開しているビルド手順もサポートツールをWinAVR付属のutils
ではなくCoreutilsの使用を推奨するようにシフトする予定です。

ねむい様、はじめまして。imenihsと申します。
秋月のSTM32F4 Discoveryを購入して、制限なしコンパイル環境を構築しようとねむい様のこちらのページを参考にさせていただいています。
その過程で、私が2つ引っかかったことがありましたので、こちらに報告させて頂きます。
Insightを使ったデバッグを行うため、make debugメニュー（こちらのページの作業で追加したもの）からInsightを起動して、Insightのメニュー File->Targetsettingsをクリックしても、その後無反応になります。
Insight+OpenOCDを強制終了後のち、再度起動させてRunなどいろいろ実行させても同様に無反応になります。
この回避方法は、arm-none-eabi-insight.exe本体のexeを右クリックし、プロパティから互換性タブを選択し、Windows98/ME互換モードで動作させると良いようです。
更に、ねむい様の作成されたstm32f4用のmakefileの、Insight呼び出しの引数も、
$(WSHELL) /c start /B $(INSIGHT) $(TARGET).elf target_cmd=remote/tcp localhost:3333
と変更すると、remote/tcpで接続されるようです。（変更以前はlocalhost:3333の引数が無効とメッセージを吐いていました。）
もしかしたら、初歩的な誰でも知っている事かもしれませんが・・・。
ちなみに、私のPCのOSはWindows7 HomePremium 64bitです。
長文失礼しました。

imenihs様
はじめまして、ねむいです。

Insightはgdbtk.iniという設定ファイルをログイン下ユーザーフォルダ
(Windows7だとC:¥ユーザー¥(ユーザー名)に相当する)に作り、次回の
起動で最後に動かした時のgdbtk.iniの設定を反映させます。ここで設定に
誤りがあるとパケット待ちによりフリーズしたように見えるので注意
してください。

ということでmakefileのtarget_cmd...の部分は全く不必要です(無視されます)。
STM32やFM3向けのプログラムでmakefileに書いてあったのは検証用に
残していて削除するの忘れてましたすみません。次回mp3再生機能を追加
して更新しますのでmakefileの余計な記述は消しておきますね。

初めまして...です(私の方からはということで)
最近コメント整理をしておらず、ご本人からコメントをいただいていたとは気が付かず、失礼しましたm(__)m
PN2からMake出来なかったあと、Eclipseでなんとかなったので、その後は他のことにかまけて(トランジスタのペア取りとか)ARMはお休みしていました

多分ご指摘のミスだったと思うので(消してしまいましたが)、再度追試をしてこちらの環境も是非使わせていただきたいと思います
何か始めるときは環境構築が一番面倒なので、ついお仕着せで済ませてしまうのですが、こちらのようの丁寧に説明していただくと非常に助かります
今後とも参考にさせていただきます、今回はこちらの方こそお手数をおかけしてすいませんでした(決して批判がましいつもりではなく、自分の作業メモのつもりだったので...)

Sabotenboy様こんばんは、ねむいです。

私も抜けている所が少々どころか多々ありますので、他の方の"ここが分からない"
"上手くいかない"というご意見はフィードバックして修正する際に非常に
大切であると感じております。今後ともよろしくお願いいたします。

ねむい様、はじめまして。555と申します。
Interface2012年6月号の付録基板MB9BF618Tを用いてWindows7環境でこちらのブログを参考にさせて頂いて、MB9BF618T_Simple_20130103を使用して、開発環境を整えています。

しかし、make programでデバイスに書き込もうとする段階で
Error: unable to open ftdi device: device not found
とエラーが出てしまい困っています。
USB-Blasterを接続していなくても同じメッセージがでますので、OpenOCDがUSB-Blasterを認識できていないようです。
(デバイスマネージャやAlteraのQuartusには認識されているようです。）

最近はじめたばかりでmakefileの記述なども分からないことばかりなのですが、
USB-Blasterを使用する場合の変更点はmakefile中の、

��21行目の MPSSE = ftdi をコメントにして、22行目の MPSSE = のコメントを解除する。
��58行目の読み込むinterfaceのcfgファイルをjtagkey2.cfg からaltera-usb-blaster.cfgに変更する。
(-f interface/$(MPSSE)/altera-usb-blaster.cfg とする。)
の２点のみで正しいでしょうか？
それとも他の変更または、makefileの変更以外のなんらかの操作が必要になるのでしょうか?

  • 555
  • 2013/01/11 1:16 PM

555様はじめまして、ねむいです。

ご質問いただいた件ですが、私のぶろぐ上にて公開している
デバッグ手順は既にプロプラのftd2xxからLibUsb/WinUSBに
ドライバを移行しております。USB-BlasterにおいてはWinUSB
にはまだ対応しておらずLibUSBをドライバとして使用する
必要があります。LibUSBのドライバとしてインストールする
際はzadigを使用すれば簡単です。

…と言いたいところですがUSB-BlasterのOpenOCD側のコードが
まだごく原始的な段階で全く使い物にならない状態です。
私てっきり下記URLの大幅修正がコミットされたかと思い込んで
ましたが、ステータスがレビュー段階で止まったままなんですよね…
ttp://openocd.zylin.com/#/c/467/

ということで申し訳ありませんがUSB-Blasterを使うのはまだ
お勧めできません。

  • 261
  • 2013/01/11 6:11 PM

ねむい様、お返事ありがとうございます。
USB-Blasterが使えないのは残念です。
情報は参考になりました。ありがとうございます。

  • 555
  • 2013/01/12 8:03 PM

はじめまして。さかなです。

自宅に眠らせたままになっていた(-_-;)
STM32F4 Discoveryボードをようやく触り始めたところで、
まずはこちらのサイトの手順でまずは環境を構築してみました。

当方の環境（Windows10 Pro 64bit)でも、
STM32F4向けの液晶表示プログラムのビルドが成功し、
評価ボード上で動作できることが確認できました。
ありがとうございます。
（・・・といっても、液晶パネルを持っていないので、
main関数冒頭にあるLチカの部分での確認ですが・・・）

これで、ビルド可能な環境が準備できたので、
少しずついろいろ触ってみたいと思います。

ところで、ねむいさんの環境は、
Programmers Notepad2(PN2)をポータブル版にすれば、
USBメモリでビルド環境を一式持ち歩けそうですね。
帰省するときなどには重宝しそうです。

  • さかな
  • 2015/10/13 2:04 AM

さかな様はじめまして、ねむいです。

Win10環境下の動作報告ありがとうございます。
これで私の開発環境でもあと10年はゆうに戦えそうですね･･･！

はじめまして、ダークロンと申します。

STM32F7マイコンの開発環境を構築したいと思いまして、こちらのサイトを見させて頂きました。
無事、ビルドが成功し、STM32F7 discovery board にてねむいさんのプログラムの動作を確認しました。

また、STM32F746VGT6を使った自作のマイコン基板にて、LED点滅プログラムが動作しました。

ありがとうございます。

  • ダークロン
  • 2016/01/16 2:38 PM

ダークロンさまはじめまして、ねむいです。
返信が大幅に遅れ申し訳ありません。

少しだけ時間に余裕が出てきましたので今後も記事の
充実を進めて行かせてもらいます！

デバッグ手順をWin10向けに完全対応させました。
当分はこれで頑張れます！

Post a Comment








Go to top of page