ビルド環境をセットアップする

GitHub でソースを見る

SiLabs
投稿者: Mason Tran
SiLabs からの寄稿者

自由でオープンな開発を促進するために、OpenThread はビルドツールチェーンでCMakeを使用します。現在、このツールチェーンは、OpenThread を新しいハードウェア プラットフォームに移植するために必要です。

他のビルド ツールチェーンは今後サポートされる可能性がありますが、この移行ガイドの範囲には含まれません。

新しいリポジトリを作成する

最初のステップは、ハードウェア プラットフォームの新しいホームをセットアップすることです。このガイドでは、プラットフォーム抽象化レイヤ、ハードウェア プラットフォームの SDK、いくつかの便利なスクリプトを含む ot-efr32 という新しいリポジトリを作成します。

この例では、GitHub に SiliconLabs/ot-efr32 リポジトリを作成し、~/repos/ot-efr32 にクローンを作成しました。

mkdir -p ~/repos
cd ~/repos
git clone git@github.com:SiliconLabs/ot-efr32.git
Cloning into 'ot-efr32'...
remote: Enumerating objects: 99, done.
remote: Counting objects: 100% (99/99), done.
remote: Compressing objects: 100% (60/60), done.
remote: Total 333 (delta 65), reused 39 (delta 39), pack-reused 234
Receiving objects: 100% (333/333), 170.78 KiB | 5.69 MiB/s, done.
Resolving deltas: 100% (194/194), done.
git status
On branch main
Your branch is up to date with 'origin/main'.

nothing to commit, working tree clean

リポジトリの構成

OpenThread GitHub 組織の既存のプラットフォーム リポジトリとの整合性を保つために、以下のようにリポジトリを構造化することをおすすめします。

tree -F -L 1 --dirsfirst
.
├── examples/
├── openthread/
├── script/
├── src/
├── third_party/
├── CMakeLists.txt
├── LICENSE
└── README.md
フォルダ 説明
examples 省略可 サンプル アプリケーション
openthread サブモジュールとしての openthread リポジトリ
script ビルド、テスト、lint チェックのスクリプト
src プラットフォーム抽象化レイヤの実装
third_party サードパーティのソースの場所

サブモジュールを追加する

次のステップでは、openthread とその他の必要なリポジトリをサブモジュールとして追加します。

git submodule add git@github.com:openthread/openthread.git
Cloning into '/home/user/repos/ot-efr32/openthread'...
remote: Enumerating objects: 78281, done.
remote: Counting objects: 100% (1056/1056), done.
remote: Compressing objects: 100% (488/488), done.
remote: Total 78281 (delta 639), reused 864 (delta 556), pack-reused 77225
Receiving objects: 100% (78281/78281), 76.62 MiB | 35.24 MiB/s, done.
Resolving deltas: 100% (61292/61292), done.

この例では、Silicon Labs Gecko SDK のライト バージョンをサブモジュールとして third_party に追加します。

cd third_party
git submodule add git@github.com:SiliconLabs/sdk_support.git
Cloning into '/home/user/repos/ot-efr32/third_party/sdk_support'...
remote: Enumerating objects: 32867, done.
remote: Counting objects: 100% (8181/8181), done.
remote: Compressing objects: 100% (3098/3098), done.
remote: Total 32867 (delta 4945), reused 7469 (delta 4732), pack-reused 24686
Receiving objects: 100% (32867/32867), 128.83 MiB | 30.91 MiB/s, done.
Resolving deltas: 100% (19797/19797), done.

スクリプト

一般的なタスクを簡単にするために、script フォルダにスクリプトをいくつか作成することをおすすめします。これには、ブートストラップ、ビルド、コードリンターの実行などのタスクのスクリプトや、GitHub CI チェック用のテスト スクリプトが含まれることがあります。

既存のプラットフォーム リポジトリのほとんどで標準的なスクリプトの例を以下に示します。

bootstrap

このスクリプトにより、お使いのハードウェア プラットフォームに必要なすべてのツールとパッケージがインストールされます。また、openthread のブートストラップ スクリプトを実行して、OpenThread スタックのビルドに必要なものがすべて揃っていることを確認する必要があります。

例については、ot-efr32 のブートストラップ スクリプトをご覧ください。

build

CMake ビルド スクリプトでは、ユーザーがプラットフォーム用の OpenThread スタックをビルドできるようにする必要があります。リポジトリ内のサンプル アプリケーションを定義する場合は、このスクリプトでもビルドする必要があります。このスクリプトには、プラットフォーム固有のマクロ定義を含め、基本的なシステム構成オプションが含まれている必要があります。

例については、ot-efr32 のビルド スクリプトをご覧ください。

test

テスト スクリプトは、定義済みのテストを使用してユーザーが変更をテストするのに便利です。サニティ チェックのビルドを実行するだけの簡単なものから、単体テストスイートの立ち上げのような複雑なものまで、多岐にわたります。

ot-efr32 では、このスクリプトは efr32 プラットフォームのサポート対象のボードごとに build スクリプトを実行します。

例については、ot-efr32 のテスト スクリプトをご覧ください。

make-pretty

一貫性のあるスタイルを維持するため、このスクリプトでは、コード、スクリプト、マークダウン ファイルをフォーマットする必要があります。

このスクリプトは自分で定義することもできますが、既存のプラットフォーム リポジトリで使用している make-pretty スクリプトを使用する方が簡単な場合もあります。このスクリプトは openthread のスタイル スクリプトを呼び出し、すべての OpenThread リポジトリで一貫したスタイルを確保します。

リンカー スクリプトの構成

GNU リンカー スクリプトは、入力ファイル内のすべてのセクション（GNU Compiler Collection（GCC）によって生成された .o オブジェクト）を最終出力ファイル（.elf など）にマッピングする方法について説明します。実行可能プログラムの各セグメントの保存場所とエントリ アドレスも決定します。プラットフォーム固有のリンカー スクリプトは、多くの場合、プラットフォームの BSP とともに提供されます。

src/CMakeLists.txt のプラットフォーム CMake ターゲットで target_link_libraries を使用して、プラットフォーム固有のリンカー スクリプトを指すように ld ツールを構成します。

set(LD_FILE "${CMAKE_CURRENT_SOURCE_DIR}/efr32mg12.ld")

target_link_libraries(openthread-efr32mg12
    PRIVATE
        ot-config
    PUBLIC
        -T${LD_FILE}
        -Wl,--gc-sections -Wl,-Map=$.map
)

ツールチェーンの起動コード

多くの場合、ツールチェーンの起動コードはプラットフォームの BSP とともに提供されます。通常、このコードは次のようになります。

  1. 実行可能プログラムのエントリ関数（Reset_Handler）を実装します。
  2. 割り込みベクトル テーブルを定義する
  3. ヒープとスタックを初期化する
  4. .data セクションを不揮発性メモリから RAM にコピーします。
  5. アプリケーション ロジックに移動してアプリケーション ロジックを実行する

起動コード（C またはアセンブリ ソースコード）は、プラットフォームの openthread-platform-name ライブラリに含める必要があります。追加しないと、リンカー スクリプトで使用される一部のキー変数を正しく引用符で囲めません。

  • src/CMakeLists.txt

例: ot-cc2538 の startup-gcc.c - src/CMakeLists.txt

add_library(openthread-cc2538
    alarm.c
...
    startup-gcc.c
...
    system.c
    logging.c
    uart.c
    $
)
前へ
概要
次へ
CMake ルールを定義する