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

GitHub でソースを見る

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

他のビルド ツールチェーンは今後サポートされる可能性がありますが、この移植ガイドの対象外です。

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

まず、ハードウェア プラットフォームの新しいホームを設定します。このガイドでは、ot-efr32 という名前の新しいリポジトリを作成します。このリポジトリには、プラットフォーム抽象化レイヤ、ハードウェア プラットフォームの SDK、いくつかの便利なスクリプトが含まれます。

この例では、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 ビルド、テスト、リンティング用のスクリプト
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.

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

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 コンパイラ コレクション(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-cc2538startup-gcc.c - src/CMakeLists.txt

add_library(openthread-cc2538
    alarm.c
...
    startup-gcc.c
...
    system.c
    logging.c
    uart.c
    $
)