IAR Embedded WorkbenchでCppUTestを試す

テストフレームワークの一つであるCppUTestを実機（STM32F4DISCOVERY）で動作させてみる。

#準備

##ターゲットとサンプル
ターゲットはCortex-M4コアのSTMicro社製マイクロコントローラSTM32F407VGを搭載した「STM32F4DISCOVERY」とする。ターゲット基板の詳細は[この辺り](http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/PF252419)に記載されている。このページ下部にある「Related Tools and Software」という項目があり、そこにあるファームウェアパッケージ[STSW-STM32068](http://www.st.com/web/en/catalog/tools/PF257904)をベースにして進める事とする。クリックしてリンクを進むとドキュメント[AN3983: STM32F4DISCOVERY peripheral firmware examples](http://www.st.com/st-web-ui/static/active/en/fragment/website_building_block/site_media/icon/pdf_icon.gif)とサンプル（Part Number : STSW-STM32068）をダウンロードするボタンがあるので、クリックして「stsw-stm32068.zip」をダウンロードする。
ダウンロードしたファイルを全て解凍しても良いが、ここでは次のディレクトリ（☆マークのあるディレクトリ以下全て）のみ解凍したものとして進める。なお、解凍場所は任意のディレクトリで良いが、ここでは便宜的にsample_rootに解凍したものとする。

```
sample_root
├─Libraries
│  ├─CMSIS
│  │  ├─Include ☆
│  │  ├─Lib ☆
│  │  └─ST ☆
│  ├─STM32F4xx_StdPeriph_Driver ☆
│  ├─STM32_USB_Device_Library ☆
│  └─STM32_USB_OTG_Driver ☆
├─Project
│  ├─Demonstration ☆
│  ├─Master_Workspace
│  │  └─EWARM ☆
│  └─Peripheral_Examples
│      └─IO_Toggle ☆
└─Utilities
    └─STM32F4-Discovery ☆
```

##開発環境
今回、開発環境はIAR社のEmbedded Workbenchを使用し、まずはコード制限付きの評価版で可能かどうか検証してみる。Embedded Workbench ver.6.6 for ARM（以下、EWARM）を[この辺り](http://www.iar.com/jp/)からダウンロードしてきて、IAR社からライセンスを取得する。インストール及びライセンスの取得に関する部分は[この辺り](http://kowaimononantenai.blogspot.jp/2012/10/stm32f4-discovery-ewarm.html)や[この辺り](https://sites.google.com/site/stm32datasheet/home/dev-tools/iar-dev-tool)が参考になる。

##ワークス－ペース
マスターワークスペースを開く。インストールが完了している場合、エクスプローラ等から次のファイルを開けばEWARMが起動する。
`sample_root/Project/Master_Workspace/EWARM/STM32F4-Discovery.eww`
解凍しなかったファイルある場合は警告表示が出るので全てOKで切り抜ける。成功すると次のようなプロジェクトが登録されているのをみる事ができる。
 ![image001.png](https://qiita-image-store.s3.amazonaws.com/0/21786/0a54d764-0ced-4d0e-65b0-d9d1b80acf50.png)
プロジェクト「STM32F4-Discovery_Demo」は工場出荷時に書き込まれているものと同じである（と思う）。最後に元に戻しておくために組み込んでいる。今回、ベースにするのはプロジェクト「IO_Toggle」で、LEDをON/OFFするだけの単純なものである。ここでそれぞれプロジェクトを右クリックからmakeを実行しビルドが成功することを確認しておくと良い。

#ライブラリの生成

##ライブラリプロジェクトの作成
Project ⇒ Create New Projectを選んで新規のプロジェクトを生成する。
 ![image003.png](https://qiita-image-store.s3.amazonaws.com/0/21786/5c325045-3a81-53ff-84b6-230a146e4bb3.png)
ツールチェーンはARM、テンプレートは **Empty project** を選んでOKボタンを押下し、空のプロジェクトを作成する。
 ![image005.png](https://qiita-image-store.s3.amazonaws.com/0/21786/525ce65c-c001-6fc4-8959-638c142d9ba1.png)
プロジェクトファイルの格納場所を聞いてくるが、ディレクトリ構造は自動的に決定されないので自力でディレクトリ構造を構築する必要がある。フォルダの作成等を駆使しつつ次のようにディレクトリ構造を構築し、プロジェクトファイルを決めて確定する。
続いて、ファイルをCppUTestからコピーする。

```
├─include
│  ├─CppUTest
│  │      CommandLineArguments.h
│  │      CommandLineTestRunner.h
│  │      JUnitTestOutput.h
│  │      MemoryLeakAllocator.h
│  │      MemoryLeakDetector.h
│  │      MemoryLeakDetectorMallocMacros.h
│  │      MemoryLeakDetectorNewMacros.h
│  │      MemoryLeakWarningPlugin.h
│  │      PlatformSpecificFunctions.h
│  │      SimpleString.h
│  │      TestFailure.h
│  │      TestHarness.h
│  │      TestHarness_c.h
│  │      TestOutput.h
│  │      TestPlugin.h
│  │      TestRegistry.h
│  │      TestResult.h
│  │      TestTestingFixture.h
│  │      Utest.h
│  │      UtestMacros.h
│  │      VirtualCall.h
│  └─Platforms
│      └─Gcc
│              Platform.h
└─src
    ├─CppUTest
    │      CommandLineArguments.cpp
    │      CommandLineTestRunner.cpp
    │      JUnitTestOutput.cpp
    │      MemoryLeakAllocator.cpp
    │      MemoryLeakDetector.cpp
    │      MemoryLeakWarningPlugin.cpp
    │      SimpleString.cpp
    │      TestFailure.cpp
    │      TestHarness_c.cpp
    │      TestOutput.cpp
    │      TestPlugin.cpp
    │      TestRegistry.cpp
    │      TestResult.cpp
    │      Utest.cpp
    └─Platforms
        └─Iar
                UtestPlatform.cpp
```

##ファイルの追加
分かりやすいようにGroupを追加しておく。プロジェクトを右クリックからコンテキストメニューを開き、Add⇒Add Groupを選ぶ。
 ![image007.png](https://qiita-image-store.s3.amazonaws.com/0/21786/af45de42-f671-6c54-9c0d-add8daabcb7b.png)
ここではグループ名を **Src** とした。OKボタンを押下して確定する。
 ![image009.png](https://qiita-image-store.s3.amazonaws.com/0/21786/a34d6d09-eea5-46b5-bd35-7fc76a95b08b.png)
続いて追加したグループを右クリックからコンテキストメニューを開き、Add⇒Add Filesでファイル選択ダイアログを開く。
 ![image011.png](https://qiita-image-store.s3.amazonaws.com/0/21786/c282310d-2aa7-4677-2f4b-b844df4ff47f.png)
先ほどコピーしたファイルからソースコードを選択して追加する。
 ![image013.png](https://qiita-image-store.s3.amazonaws.com/0/21786/76228d1d-14bb-c0c1-3096-a48e93b75333.png)
プラットフォーム固有のソースコードも追加する。
 ![image015.png](https://qiita-image-store.s3.amazonaws.com/0/21786/50fb9fca-9d8a-89fb-add2-a5b4126797fb.png)
バージョンなどの違いによりtolower()関数が定義されているヘッダファイルが異なっているので、プロジェクトのsrc/Platforms/Iar/UtestPlatform.cppを開き、インクルードファイルにctype.hを追加する。

```c:UtestPlatform.cpp
#include <ctype.h>
```

##プロジェクトの設定
プロジェクトを右クリックからoptionを選ぶ。先ずはGeneral Optionsから設定していく。Processor variantはDeviceを選択し、右のボタン押下でコンテキストメニューを開き、ST ⇒ STM32F407 ⇒ ST STM32F407VGと選択する。
 ![image017.png](https://qiita-image-store.s3.amazonaws.com/0/21786/47430b47-2b75-09a9-5e23-6753362fc1ad.png)
Output fileは **Library** を選択する。
 ![image019.png](https://qiita-image-store.s3.amazonaws.com/0/21786/93f5cc95-569b-8f24-5b69-058027fd4ec6.png)
Use CMSISにチェックを入れる。
 ![image021.png](https://qiita-image-store.s3.amazonaws.com/0/21786/f4102b65-7631-f848-94d5-2190b61965e2.png)
CategoryでC/C++ Compilerを選び、Languageを **C++** 、C++ dialectで **C++** を選択する。
 ![image023.png](https://qiita-image-store.s3.amazonaws.com/0/21786/ef47bcf5-c43b-ecbb-a58c-610df3fe9094.png)
Enable multibyte supportはチェックマークが外れていることを確認。
![image025.png](https://qiita-image-store.s3.amazonaws.com/0/21786/62cd3c1f-26e1-395e-d47a-4005f925c39e.png)
Optimizationではサイズ制限評価版を使っているので可能な限りコードサイズを小さくするため、Levelを **High** にして **Size** 優先を選択しておく。
 ![image027.png](https://qiita-image-store.s3.amazonaws.com/0/21786/ef0b3fe3-7b60-fcbf-a636-1f1605bcf6b6.png)
インクルードパスに `$PROJ_DIR$\include` を通しておく。OKボタンを押下して設定内容を確定する。
 ![image029.png](https://qiita-image-store.s3.amazonaws.com/0/21786/76051076-4f1a-7cb4-a8e1-5273a51d762e.png)
プロジェクトを右クリックからmakeを起動するとライブラリが生成される。30個くらい警告が出るが今回は無視した。
![image031.png](https://qiita-image-store.s3.amazonaws.com/0/21786/fa03b043-dbf0-2140-a3f2-0c11202696a2.png)

#テストケースの作成
IO_Toggleプロジェクトをアクティブに切り替える。
C++でコンパイルするため、プロジェクトに含まれるmain.cをmain.cppに変更する。実際にはRemoveして名前を変更してからAddする。

##プロジェクトの設定
コンパイラの指定を **C++** に変更する。
 ![image033.png](https://qiita-image-store.s3.amazonaws.com/0/21786/0714a9db-0cf9-c043-1385-15ab08606a9b.png)
インクルードパスに `$PROJ_DIR$\..\..\..\Test_Framework\CppUTest\include` を追加。
 ![image035.png](https://qiita-image-store.s3.amazonaws.com/0/21786/896a8c3d-2d0c-842f-775e-d91d51e968b2.png)
Linkerの設定でLinker configuration fileをプロジェクトのファイルでオーバーライドして個別設定する。Editボタンを押下してLinker configuration file editorを開く。
![image037.png](https://qiita-image-store.s3.amazonaws.com/0/21786/f6a20d92-cb83-f5fa-5a92-533400073f02.png)
デフォルトのヒープサイズでは不足するのでここでは **0x2000** 確保している。Saveボタンを押下し、configuration fileに書き込む。
![image039.png](https://qiita-image-store.s3.amazonaws.com/0/21786/451b1acb-2675-9dcd-dac2-ab0caa30e311.png)
追加のライブラリに `$PROJ_DIR$\..\..\..\Test_Framework\CppUTest\Debug\Exe\CppUTest.a` を加える。
 ![image037.png](https://qiita-image-store.s3.amazonaws.com/0/21786/ab23a567-4e33-d49d-bd75-4f4763f2bfca.png)
STM32F4xx_StdPeriph_Driverにある **stm32f4xx_usart.c** を追加。
![image039.png](https://qiita-image-store.s3.amazonaws.com/0/21786/fd55233b-c523-7cef-3976-7941b6845029.png)

##出力先をシリアルにする
シリアルへの接続[この辺り](http://amarkham.com/?p=45)を参考に組み込む。
[この辺り](http://eliaselectronics.com/stm32f4-discovery-usart-example/)にも情報がある。

```cpp:main.cpp
#include <stdio.h>
#include <CppUTest/CommandLineTestRunner.h>

USART_InitTypeDef USART_InitStructure;

void USART_Configuration(void){
  // sort out clocks
  RCC_AHB1PeriphClockCmd( RCC_AHB1Periph_GPIOA, ENABLE);
  RCC_APB1PeriphClockCmd(RCC_APB1Periph_USART2, ENABLE);
  /* Configure USART2 Tx (PA.02) as alternate function push-pull */
  GPIO_InitStructure.GPIO_Pin = GPIO_Pin_2;
  GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;
  GPIO_InitStructure.GPIO_Mode = GPIO_Mode_AF;
  GPIO_InitStructure.GPIO_OType = GPIO_OType_PP;
  GPIO_InitStructure.GPIO_PuPd = GPIO_PuPd_UP;
  GPIO_Init(GPIOA, &GPIO_InitStructure);
  // Map USART2 to A.02
  GPIO_PinAFConfig(GPIOA, GPIO_PinSource2, GPIO_AF_USART2);
  // Initialize USART
  USART_InitStructure.USART_BaudRate = 9600;
  USART_InitStructure.USART_WordLength = USART_WordLength_8b;
  USART_InitStructure.USART_StopBits = USART_StopBits_1;
  USART_InitStructure.USART_Parity = USART_Parity_No;
  USART_InitStructure.USART_HardwareFlowControl = USART_HardwareFlowControl_None;
  USART_InitStructure.USART_Mode = USART_Mode_Tx;
  /* Configure USART */
  USART_Init(USART2, &USART_InitStructure);
  /* Enable the USART */
  USART_Cmd(USART2, ENABLE);
}

/**
* @brief Function that printf uses to push characters to serial port
* @param ch: ascii character
* @retval character
*/
int putcharx(int ch)
{
  while (USART_GetFlagStatus(USART2, USART_FLAG_TXE) == RESET);
  USART_SendData(USART2, (uint8_t)ch);
  return ch;
}

int main(void)
{
  USART_Configuration();

  static char *argv[] = { "main" };
  CommandLineTestRunner::RunAllTests(sizeof(argv)/sizeof(*argv), argv);
}
```

##テストケースの記述
プロジェクトにtest.cppを追加し、テストケースを記述する。

```cpp:test.cpp
#include <CppUTest/TestHarness.h>

int hoge(void)
{
	return 3;
}

int hoge(int a)
{
	return a+1;
}

TEST_GROUP(TestSuiteHoge)
{};

TEST(TestSuiteHoge, TestCaseHoge)
{
	LONGS_EQUAL(3, hoge());
}

TEST(TestSuiteHoge, TestCaseHoge2)
{
	LONGS_EQUAL(3, hoge(2));
}
```

#ビルドと実行

##ビルド
プロジェクトのコンテキストメニューからMakeを選んでビルドする。ビルドに成功すればIO_Toggle.outが生成される。

##デバッグ実行
USBポートにSTM32F4 DISCOVERYを接続する。初めて接続した場合や、接続するUSBポートを変更した場合はST-Linkドライバのセットアップが必要になる。ST-Linkドライバのセットアップに関しては[この辺り](http://kowaimononantenai.blogspot.jp/2012/10/stm32f4-discovery-ewarm.html)が参考になる。今回のセットアップ環境では C:\Program Files\IAR Systems\Embedded Workbench 6.5\arm\drivers\ST-Link\ST-Link_V2_USBdriver.exe を実行した。
正常にデバイスが使用できるようになったら、IO_Toggleプロジェクトを選択しProject⇒Download and Debug（Ctrl+D）を選択する。自動的にダウンロードされmain関数で一時停止する。
![image047.png](https://qiita-image-store.s3.amazonaws.com/0/21786/4d421322-abb6-5ece-9e2e-b29359b27886.png)
テスト結果を表示させるため、View⇒Terminal I/OでTerminal I/Oビューを表示しておく。
![image049.png](https://qiita-image-store.s3.amazonaws.com/0/21786/b76a33a2-5d11-c047-4d1f-c5cdb8e8efcd.png)
Debug⇒Go（F5）で実行すると、次のようにTerminal I/Oにテスト結果が表示される。
![image053.png](https://qiita-image-store.s3.amazonaws.com/0/21786/34c3aa68-2aaf-aae7-c069-d6ab50565c9a.png)

##コードサイズ
ちなみに今回の実装でコードサイズは28.5KB程度となった。コードサイズ限定版を使っている場合は、コードサイズが32KB以下にならないとビルドできないようになっているため、残り3.5KB程度となっている。

```
  29,163 bytes of readonly  code memory
   6,073 bytes of readonly  data memory
  19,136 bytes of readwrite data memory
```