STM32CubeMXの使い方

STM32マイコンのソフト開発を早く効率的にするのが、STM32CubeMXです。コード生成ツールのSTM32CubeMXの概要、使い方を示します。

STM32CubeMXの使い方ビデオ

STMが提供するSTM32CubeMX解説ビデオは、このページの右に2つあります。STM32CubeMX – Overview (6:44)とGetting Start with STM32CubeMX (9:12)です。Overviewを見ると概要が、Getting Startを見ると、5つの使いこなしポイントが判る(かも?)という内容です。STM32CubeMXのマニュアルUM1718もページ下にあります。

この2ビデオとUM1718、その他の関連資料から、私なりにSTM32CubeMXの要点、使い方を纏めましたので以下に示します。

STM32CubeMXのウイザード

STM32CubeMXは、4IDE(SW4STM32ほか3種IDE、前回記事参照)へプロジェクトファイルと初期設定(クロック設定と周辺回路)Cソースコードを自動生成します。この生成の基になるのがPinout、Clock Tree、Peripheral & Middlewareの3ウイザードです。

Power Consumptionウイザードは、生成時の消費電力を評価する計算ツールです(使用例はコチラを参照)。

STM32CubeMX Four Wizard
STM32CubeMX Four Wizard

STM32CubeMXの3ウイザード設定後、コード生成(Ctrl + Shift + G)実行で指定先へプロジェクトファイルが出力され、これをSW4STM32でImportすれば、初期設定コード付きのプロジェクトが得られます。

従って、残りのユーザ処理をプロジェクトへ追加していけば、アプリ完成という段取りです。

STM32CubeMXの2種ドライバライブラリ

注意点は、デフォルトでSTM32CubeMXが生成するのは、HALドライバライブラリを使ったプロジェクトだということです。勿論LLドライバライブラリでの生成も可能ですが、この場合は、初期設定ソースコードが自動生成されません。LLライブラリ利用の場合は、ユーザが初期設定コードも書く必要があります。

つまり、STM32CubeMXでLLドライバを使うと、SW4STM32で、初期設定とユーザ処理の両方をプロジェクトに追記しなければならず、しかも、各LLドライバ分解能はHALに比べて低いので、より多くのLL APIを使った追記が必要です。

HALとLLは、UM1749(全1466ページ)に詳しい説明があります。
HAL: Hardware Abstraction Layerとは、文字通りハードウエアを抽象化し、より簡単に周辺回路制御ができるAPIをユーザ側へ提供します。
一方、LL: Low Layerは、速度優先でエキスパート向けのAPIですので、高速ですが移植性や可読性はHALよりも低くなります。

HALとLLのAPIを相対比較した表が下記です。

STM32CubeMX HAL and LL APIs Comparison
STM32CubeMX HAL and LL APIs Comparison

追記コードはHALの方が少なくても、実際はHALの方が抽象化オーバーヘッドの分だけコンパイル後のコードサイズは大きくなります。プログラムにもよりますが、その差は60~80%だそうです。LLを使うとこのサイズが小さい分だけ高速処理が可能ということです。

STM32CubeMXでLLを使って生成するプロジェクトファイルは、本当の意味でフレームワークのみです。

Peripheralウイザード設定の目的は、SW4STM32のAPI入力支援機能を活用するためです。例えばコード記述中、LL_DAC_まで入力後、Ctrl + spaceを押すと、可能性があるLL APIがリストで選べます(HAL APIも下記のように同様)。Visual StudioのIntellisence機能のマイコン版に相当します。

Intellisence (Ctrl + Space) and USER CODE BEGIN to END
Intellisence (Ctrl + Space) and USER CODE BEGIN to END

このIntellisenceが表示するAPIは、当該周辺回路の全てのAPIを示すと思います。全てのAPIから使えるAPIを選ぶには、Peripherals & Middlewareウイザードの設定意味が解っている必要があるでしょう。

再度STM32CubeMXでコード生成し、プロジェクトファイルを作り直しImportしても、ユーザ追記部分を残すためには、USER CODE BEGINからUSER CODE ENDまでのコメント間に記述します。これは、Runesas CS+のコード生成と同じです。

STM32マイコンテンプレートはHALドライバライブラリを使用

使用するドライバライブラリは、60~80%の高速性か、ポータビリティかの選択です。STM32マイコンは、ROM/RAMが大容量なこと、コア速度も速いこと、STM32CubeMXもデフォルトでHAL使用することから、STM32マイコンテンプレート開発にも、HALライブラリを使います。

これにより、当初の目的であった機種特定を避けCortex-M0/M0+コアのSTM32F0/L0や、Cortex-M3のSTM32F1などのSTM32マイコン全てに使えるベアメタルマイコンテンプレートを開発します。

*  *  *

ここまでが、STM32CubeMXコード生成の使い方です。使用ライブラリにHALを選べば、初期設定Cソースコード付きのSW4STM32プロジェクトが作れます。

ビデオや各種資料もここで終わるものが多いのですが、ソースにユーザ処理の追加が残っています。このユーザ処理の参考にすべきなのが、STM32CubeMXのRepositoryフォルダで提供される周辺回路毎のサンプルソフトです。

STM32CubeMXサンプルソフトの使い方

前回記事Figure4に示したExampleで提供されるのが、HALライブラリ使用のサンプルソフトです。Example_LLはLLライブラリ利用サンプル、Example_MIXは、HALとLLの混合サンプルを示します。

いずれのサンプルも、4IDEで使える構成になっているのは、前回記事の通りです。

サンプルソフトがSTM32CubeMXを使って作られたものなら、そのまま利用できるのでBestですが、残念ながら専門家、人が開発したプロジェクトです。しかし有力なサンプルであることに違いはありません。

従って、使う周辺回路が決まったら先ずこのExampleで使用例を大体でも知ったうえで、コード生成するのが本来のSTM32CubeMXの使い方手順だと思います。この前処理抜きでPinout、Clock Tree、Peripheral & Middlewareの3ウイザードを正しく設定できれば別ですが、分厚いマニュアルを読むよりは効率的だと思います。

まとめ

私は、STM32CubeMXは、コード生成とRepository内のサンプルソフトの両方を、車の両輪のように同時に使うことでSTM32マイコンのソフト開発が早く効率的になると思います。

効率的なSTM32CubeMXの使い方は以下です。

1) Repositoryフォルダから使用する周辺回路とライブラリに応じたサンプルソフトを探し、おおよその利用法、特にユーザ処理を知る(サンプルソフトファースト)
2)コード生成Pinout、Clock Tree、Peripheral & Middleware各ウイザードを出来るならサンプルソフトと同じ設定にし、コード生成を実行(デフォルトはHALライブラリを使うことに注意)
3)生成されたプロジェクトをIDEにImportし、ユーザ処理を1)のサンプルソフトを参考にUSER CODE BEGIN~ENDの間に追記し、デバッグ
4)再度コード生成しても3)で追記したユーザ処理は残る(但し、ヘッダーファイルは完全に上書きされるので注意)

STM32マイコンテンプレートは、STM32CubeMXのHALドライバを使い、MCUコア依存性が少ないベアメタルテンプレート開発にする方針を立てました。STM32マイコンテンプレートの目的を知りたい方は、弊社マイコンテンプレートサイトをご覧ください。

STM32マイコン統合開発環境:SW4STM32の構築

STM32マイコンの統合開発環境: IDEは、EWARM、MDK-ARM、TrueSTUDIO、SW4STM32の4種類から選びます。

EWARM:IAR社Embedded Workbench for ARM。汎用IDE。無償版32KBコードサイズまで。
MDK-ARM:Keil社Microcontroller Development Kit for ARM。汎用IDE。無償版32KBコードサイズまで。
TrueSTUDIO:Atollic社Eclipse ベースSTM32専用IDE。無償版コードサイズ制限なし。
SW4STM32:仏)AC6社マルチOS EclipseベースSTM32専用IDE。無償版コードサイズ制限なし。本ブログはWindows版で説明。

STM資料は、これら4種IDEを併記していますので、英文量が増えます。4IDE同時に使う人はいませんので、自分が使うIDEの説明箇所のみを拾い読めば十分です。4IDE併記は、全てのSTM資料に共通ですので覚えておくと良いと思います。

また、コード生成ツールSTM32CubeMXも、4IDE対応で作られておりIDE名称を知らないとフォルダ名に戸惑うことになります(後で示すFigure3や4参照)。

今回は、これら資料の特徴を知ったうえで、SW4STM32へコード生成ツールSTM32CubeMXをプラグインしたSTM32マイコンテンプレート統合開発環境の構築と、評価ボードを使った構築環境の検証までを示します。

SW4STM32統合開発環境構築手順

前回記事に示したように、STM32テンプレート開発環境は、IDEにSW4STM32、評価ボードにNUCLEO STM32F072RBを使います。

1) SW4STM32インストールとUpdate
2) STM32CubeMXプラグインとUpdate
3) STM32CubeMXへ評価ボードMCUコアのライブラリダウンロード
4) ライブラリ(サンプルソフトとドライバ)のファイル構成確認
5) 評価ボードデモソフト説明と構築環境の動作検証

1)~5)がこの開発環境の構築手順です。上手く構築できたかどうかを、評価ボードデモソフトに変更を加え検証します。手順の内容を示します。

1)SW4STM32インストールとUpdate

最新版SW4STM32は、OpenSTM32 Communityページ中頃のdownload areaからダウンロードします(要ログイン)。旧版ではUpdateで最新版へ更新できる場合とできない場合がありますので、最新版のダウンロードをお勧めします。最新版へ更新できない時は、その旨の親切なメッセージが、Update実行後に出力されます。

SW4STM32のインストールは、ダウンロードインストーラの実行だけですので、特に問題ないと思います。忘れてはいけないのは、最新版(今日現在v2.0)でもインスト後、Updateが必要な事です。トラブル回避の為にも、SW4STM32のHelp>Check for UpdatesでIDE更新を実行後、次の手順へ進むようにしてください。

2)STM32CubeMXプラグインとUpdate

STM32開発で使うコード生成ツールSTM32CubeMXのプラグインインストール方法は、UM1718の3.3を参照してください。これも記載手順で行えば、問題なくできます。インストール後、3.4.3と3.5~3.5.1を参照し、STM32CubeMXのUpdateを行います。

3)STM32CubeMXへ評価ボードMCUコアのライブラリダウンロード

評価ボードMCUコアは、ARM Cortex-M0です。これをSTMは、STM32F0シリーズと呼びます。MainstreamのFx: x=0/1/2/3/4/7シリーズがCortex-M0/M3/M4/M7、ultra-Low-powerのLx: x=0/1/4シリーズがCortex-M0+/M3/M4コアを使います。F3≠M3なので注意してください。

UM1718の3.5.2のライブラリ選択で、STM32CubeF0の1.8.0版を選択し、Install Nowでサンプルソフトとドライバ等がIDEへインストールされます。最新版(STM32CubeF0の場合1.8.0)インストールで旧版分も含むので最新版のみでOKです。

今日現在は、1.8.0のパッチパッケージは無いので、以上の手順で、SW4STM32とSTM32CubeMXプラグイン設定が完了し、統合開発環境:IDEの構築は完成です。後は、UM1718の6~10に使用例がありますので、これらを習得すればSTM32開発ができます。

4)ライブラリ(サンプルソフト)の構成確認

3でインストールしたサンプルソフトやドライバは、デフォルトではドキュメントフォルダではなく、下記STM32Cubeフォルダになります。

C:\Users\ユーザ名\STM32Cube\Repository

ドキュメントフォルダ等へ変更したい方は、STM32CubeMXのUpdater Settingsで場所を変更してください。

STM32CubeMX Update Setting
STM32CubeMX Update Setting

このRepository内に、ダウンロードしたSTM32F0シリーズのZipファイルとこれを展開したファイルが同居しています。STM32CubeF0_V1.1.0の展開ファイル例が下記です。

STM32CubeF0 Firmware Structure
STM32CubeF0 Firmware Structure
STM32CubeF0 Example Overview
STM32CubeF0 Example Overview

Figure 4は、Figure 3のProjects/STM32F072RB-Nucleo下の構成を示します。Figure 3のドライバ(=Drivers)やFigure 4のサンプルソフト(=Examples)を活用すれば、アプリケーションの早期開発ができます。弊社STMテンプレートもこれらを使います。

注意点として、評価ボードNUCLEO STM32F072RB 以外のボードや、SW4STM32以外のIDE、つまりEWARMやMDK-ARMやTrueSTUDIOのUtilities等も含まれていることです。これらは、NUCLEO STM32F072RB(STM32F072RB-NucleoとFigure3表記)とSW4STM32を使う限りは不要です。
※STM資料もそうでしたが、STMソフトもまた4つのIDEや動作する全評価ボードに1ソフトで対応するように作られているので、上記のように使わないものが含まれています。

サンプルソフトの使い方は、UM1779の4.1にSW4STM32の記載があります。

5)評価ボードデモソフト説明と構築環境の動作検証

評価ボード購入直後、電源を入れると収納ケース裏GETTING STARTED記載の緑LED LD2が点滅し、その点滅間隔がB1ボタンを押す度に50/100/500msと変わるデモソフトが起動します。このデモソフトソースが、Figure 4のDemonstrations内にあります。そこで、このデモソフトを構築した環境へImportし、点滅間隔を変えることで環境が正しく構築されたかを検証します。

UM1787: STM32CubeF0 Nucleo demonstration firmwareにデモソフトの詳細が示されています。評価ボードに下図Arduinoシールドを装着すると、ジョイスティックやLCD表示も可能です。

Adafruit 1.8” TFT shield
Adafruit 1.8” TFT shield

デモソフト緑LED LD2の点滅箇所を抜粋したソースを示します。

LED Blink Routine
LED Blink Routine

簡単に説明すると、シールド未実装の場合はLED2_Blink()が実行され、BSP_PB_Init()で設定された割込みでHAL_GPIO_EXTI_Callback()が実行されBlinkSpeedをインクリメント、HAL_Delay()で点滅間隔が変わる、となります。

そこで、main.cのL574のHAL_Delay(500)をHAL_Delay(1000)などへ変更し、ビルド→デバッグでLD2の点滅間隔が変われば、構築した開発環境が正しく構築できたことを、評価ボードを使って検証できます。perspectiveをデバッグに切換えた画面を示します。

Debug Perspective View
Debug Perspective View

デバッガ接続に万一トラブルが発生した場合には、Run>Debug Configurations…で、STM32F072B0-Nuclei.elfを見つけてください。他の設定は、デフォルトで問題ありません。

Debug Configurations
Debug Configurations

デバッグ中は、評価ボードST-Link部実装の2色LED(赤緑)がキラキラして眩しいです。

SW4STM32の使い勝手は、画面切り替えにperspectiveクリックが必要など、NXPのMCUXpressoと比較すると、やや劣る操作性です。素のEclipse IDEに近いのだと思います。

さいごに

STMマイコンは、他社比ROM/RAM容量が大きいわりに低価格です。CMSISやHALを使うと、これぐらいの大きさが必要になるのだと思います。CMSISやRTOSが普及し始めると、Cortex M系コア性能に依存しないソフト開発ができるので、既に第5位ですが更に脚光を浴び始めるベンダかもしれません。

mbedでも使える評価ボードの入手性も良いので、今のうちに個人レベルで習得すると、慌てずに済むお勧めMCUです。

STM32評価ボードNUCLEO-F072RB選定理由

STM32マイコンテンプレートを開発するにあたり、秋月電子さん販売中の多くのSTM32評価ボードのうち、Cortex-M0のNUCLEO-F072RBとCortex-M3のNUCLEO-F103RBを選びました。今回は、この選定理由を示します。

STM Evaluation Boards and MCUs Performance
STM Evaluation Boards and MCUs Performance

NUCLEO-F072RB選定の理由(ARM Cortex-M0)

STMサイトに散りばめられたSTM32 MCU情報から、NUCLEO-F072RB選定の決め手となった資料が下記4つです。UM: User Manual、AN: Application Noteです。

1) UM1779          Getting started with STM32CubeF0 for STM32F0 Series
2) AN4735           STM32Cube firmware examples for STM32F0 Series
3) UM1718          STM32CubeMX for STM32 configuration and initialization C code generation
4) UM1727          Getting started with STM32 Nucleo board software development tools

1)はボード毎に提供されるサンプルソフト数を記載し、STM32F072RBが134個と断トツに多いことが判ります。STM32F072RBとは、NUCLEO-F072RB実装MCUです。MCU/ボードの混在表記なので注意が必要です。2)は、1)のサンプルソフト詳細内容が示されています。

3)は、2)のサンプルソフトを生成するコード生成ツールSTM32CubeMXのユーザマニュアルで、スタンドアロンやEclipse IDEプラグインなどの3動作モードと使用法が書かれています。4)は、STM32MCU開発に使える4IDEの紹介です。

これら資料から、STM32マイコンテンプレートの開発環境を以下としました。

・評価ボード: NUCLEO-F072RB(64ピンSTM32F072RBT6実装、ROM 128KB/RAM 16MB、DAC/CAN/USB等)
・統合開発環境:SW4STM32(無償版コード生成サイズ制限なし)+STM32CubeMxプラグイン

※KeilのuVision(MDK-Lite)は、STM32F0/L0専用ライセンスを使うとコードサイズ256KBまで利用可能です。しかし、F0/L0専用となりSTM32F1開発(NUCLEO-F103RB選定理由参照)には残念ながら使えませんのでやめました。F0/L0のみ開発をする方は、2018年2月までの期間限定のようですが、無料で全機能使えます(少し使ってみた感想はエディタが貧弱ですがまあまあという感じです)。

数種類の評価ボードが簡単に入手できても、STM提供サンプルソフト数が少ないものもあります。弊社マイコンテンプレートは、これらサンプルソフトが簡単に組込めることを特徴としますので、サンプル数の多さは、テンプレート活用機会も多くします。

以上のことから、STM32マイコンテンプレート開発環境を決めました。

STM32 Template Development Environment
STM32 Template Development Environment

STM32マイコンテンプレート開発方針

これら4つ以外にも、様々な有用資料(例えばAN4617:Migrating between STM32F0 and STM32L0 microcontrollersなど)がサイト内に散りばめられていて、ハッキリ言ってCypressサイトなどと比較すると、平面的で資料が見つけにくいサイト構成です。応答速度も遅いです。
しかし、掲載資料は、いずれも優秀なエンジニアが書いたものと思われ、英文量は多いものの中身は良好です。

STM32マイコンテンプレート開発では、このSTMサイトリンクもブログ記事に積極的に掲載しようと思います。私の下手なブログ記事を読むより、STMサイトへ直接アクセスする方が良い読者も多いと思うからです。その結果、2016年マイコン売上5位の実力を持つSTM MCUを使う弊社STMマイコンテンプレートのご購入者が増えることも期待もしております。

NUCLEO-F103RB選定の理由(ARM Cortex-M3)

これまで弊社テンプレート対象MCUは、Cortex-M0/M0+クラスでした。しかし、前回記事に記載したようにRTOSやCMSIS普及を考慮すると、このクラスに拘る必要が薄くなってきました。

MCU価格では、Cortex-M4のSTM32F303K8T6が410円、Cortex-M0のSTM32F042K6T6が250円とややM4が高いものの、ここで使うM0/M3評価ボード価格は、どちらも1500円で同じです(2017年5月秋月販売価格)。

製品の大きさが許せば、評価ボードをそのまま製品へ実装するというのは、いつも私が考える製品構想です。評価ボードが同価格なので、コア性能が不足しても、ホードごと載せ替え可能で安心です。STM32評価ボードは、UM1724: STM32 Nucleo-64 boardで詳細が解ります。

しかも、STM32ソフトウエアスタック(UM1779掲載)から、コアクラスの依存性が低いテンプレート作りも可能だと思います。つまり、LL: Low Layerの代わりにHAL: Hardware Abstraction Layerを使ってテンプレート開発すれば、STM32F0(Cortex-M0)以外にSTM32F1(Cortex-M3)、他のコアへも適用できると考えるからです。

STM32CubeMx Software Stack
STM32CubeMx Software Stack

この可能性を検証するために選んだCortex-M3評価ボードが、NUCLEO-F103RB(64ピンSTM32F103RBT6実装、ROM 128KB/RAM 20MB、CAN/USB等)です。勿論、LLの方が高速処理可能でしょうが、HALの移植性の高さも捨てがたい利点があります。

NUCLEO-F103RB
NUCLEO-F103RB

そこで、STM32マイコンテンプレートでは、あえてF0やF1などと対象コアを明記せず、両方に対応できる(と今は思っている)HAL版テンプレートと、速度重視のLL版テンプレートの両方を開発する予定です。HALで共通化できない場合には、LL版のみをリリースします。この開発経緯などもブログに記載していきます。

*  *  *

STMのMCUが、2016年マイコン売上5位というのは驚きでした。少なくとも私の周りにはSTMマイコンを使う人がいなかったからです。入手性も良く評価ボードも低価格です。STMサイトの情報がもう少し解り易く整理されれば、日本でも人気がでるMCUだと思います。また、HALやCMSIS対応も他社に比べて早そうなので、今後の発展性も期待できます。

まとめると、STM評価ボードは、サンプル数の多さからCortex-M0のNUCLEO-F072RBを選び、M0/M0+とM3とのテンプレート共通化検証のためCortex-M3のNUCLEO-F103RBを選びました。IDEは、Eclipse IDEベースのSW4STM32へSTM32CubeMXをプラグインしてテンプレート開発に使います。

私は、STMサイト構成が、平面的、網羅的で情報検索しにくいと思うので、ブログに関連資料などへのリンクを掲載し、テンプレート開発経緯を記載していきます。