CMake ルールを定義する

GitHub でソースを表示

執筆者 Mason Tran

SiLabs 寄稿者

CMake ビルドシステムは、ビルド ターゲットを定義する CMakeLists.txt ファイルに依存します。リポジトリのルートにある CMakeLists.txt はビルドツリーの最上位であり、ビルドプロセスで使用されるさまざまなターゲット、オプション、マクロの定義を始めるのに適しています。

最初に定義する値は、プロジェクト名とサポートされるプラットフォームです。

この例では、プロジェクト名を ot-efr32 に設定し、バージョン 0.0.1 を指定します。また、変数 EFR32_PLATFORM_VALUES を定義します。これは、ot-efr32 でサポートされている efr32 プラットフォームのリストです。この例では、複数のプラットフォームを定義しましたが、_PLATFORM_VALUES 変数のプラットフォームを 1 つにしても問題ありません。

cmake_minimum_required(VERSION 3.10.2)
project(ot-efr32 VERSION 0.0.1)

set(EFR32_PLATFORM_VALUES
    "efr32mg1"
    "efr32mg12"
    "efr32mg13"
    "efr32mg21"
)

CMakeLists.txt ファイルには、サポートされていないプラットフォームで起動されたビルドを中止するチェックが含まれています。

set_property(CACHE EFR32_PLATFORM PROPERTY STRINGS ${EFR32_PLATFORM_VALUES})
if(NOT EFR32_PLATFORM IN_LIST EFR32_PLATFORM_VALUES)
    message(FATAL_ERROR "Please select a supported platform: ${EFR32_PLATFORM_VALUES}")
endif()

次に定義する必要がある変数は OT_PLATFORM_LIB です。この変数は、OpenThread サンプル アプリケーションがプラットフォームにリンクするために使用します。

set(OT_PLATFORM_LIB "openthread-${EFR32_PLATFORM}")

OpenThread CMake オプション

CMake 変数を定義することで、OpenThread のさまざまな機能を有効または無効にできます。

ot-efr32 プラットフォームでは、外部の mbedTLS ライブラリ silabs-mbedtls が使用されます。

set(OT_BUILTIN_MBEDTLS_MANAGEMENT OFF CACHE BOOL "disable builtin mbedtls management" FORCE)
set(OT_EXTERNAL_MBEDTLS "silabs-mbedtls" CACHE STRING "use silabs mbedtls" FORCE)
set(OT_MBEDTLS ${OT_EXTERNAL_MBEDTLS})

出力ディレクトリを定義する

さまざまなターゲット ファイルの出力ディレクトリは、以下の変数を使用して構成できます。

set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin)

OpenThread をビルドツリーに追加する

ビルドツリーに openthread サブモジュールを含めるには:

add_subdirectory(openthread)

ビルド プロパティを OpenThread に渡す

このファイルの最後のセクションでは、openthread ビルドツリーやプラットフォーム ライブラリに追加するビルド プロパティ（定義、オプション、インクルード ディレクトリなど）を定義できます。

これらの定義を簡単に追加するには、ot-config ターゲットを使用します。このターゲットは、構成を定義する目的にのみ使用される偽のターゲットであり、openthread 内のほぼすべての CMake ターゲットによってリンクされます。

# Define config filename macros
target_compile_definitions(ot-config INTERFACE
    OPENTHREAD_CONFIG_FILE="openthread-core-efr32-config.h"
    OPENTHREAD_PROJECT_CORE_CONFIG_FILE="openthread-core-efr32-config.h"
    OPENTHREAD_CORE_CONFIG_PLATFORM_CHECK_FILE="openthread-core-efr32-config-check.h"
)

# Disable -Wshadow and -Wpedantic
target_compile_options(ot-config INTERFACE
    -Wno-shadow
    -Wno-pedantic
)

# Add platform dirs to "include" dirs
target_include_directories(ot-config INTERFACE
    ${PROJECT_SOURCE_DIR}/src/src
    ${PROJECT_SOURCE_DIR}/src/${EFR32_PLATFORM}
    ${PROJECT_SOURCE_DIR}/src/${EFR32_PLATFORM}/crypto
)

ビルドツリーにサブディレクトリを追加する

トップレベル構成を定義したので、いよいよビルドツリーに他のサブディレクトリを追加します。

src フォルダは、プラットフォーム抽象化レイヤのソースコードがある場所です。third_party フォルダにはサードパーティのコードが含まれています。

リポジトリにサンプル アプリケーションを含める場合は、examples フォルダを作成してビルドツリーにも追加します。

add_subdirectory(src)
add_subdirectory(third_party)

# Optional
add_subdirectory(examples)

src ディレクトリ

これはリポジトリの中心であり、プラットフォーム抽象化レイヤが実装される場所です。また、他にも必要なファイルがいくつか含まれています。

src/arm-none-eabi.cmake

これは、CMake がビルドプロセスで使用する変数を定義するツールチェーン ファイルです。手始めに、このファイルの ot-efr32 バージョンをコピーして、ご使用のプラットフォームに合わせて変更することをおすすめします。

src/CMakeLists.txt

ここで、ソースファイル、インクルード パス、プラットフォーム ライブラリのコンパイラ フラグを定義します。1 つのプラットフォームのみをサポートするリポジトリのこのファイルの良い例としては、ot-cc2538 が挙げられます。

単一のリポジトリで複数のプラットフォームをサポートでき、複数のプラットフォーム リポジトリを参照として使用することもできます。ot-efr32 と ot-nrf528xx をご覧ください。