CMake-Regeln definieren

Quelle auf GitHub ansehen

Das CMake-Build-System verwendet CMakeLists.txt-Dateien, die Build-Ziele definieren. Das CMakeLists.txt im Stammverzeichnis Ihres Repositorys befindet sich oben im Build-Baum und ist ein guter Ausgangspunkt, um die verschiedenen Ziele, Optionen und Makros zu definieren, die im Build-Prozess verwendet werden.

Als Erstes legen Sie den Projektnamen und die unterstützten Plattformen fest.

In diesem Beispiel setzen wir den Projektnamen auf ot-efr32 mit der Version 0.0.1. Wir definieren auch eine Variable EFR32_PLATFORM_VALUES, die eine Liste von efr32-Plattformen ist, die von ot-efr32 unterstützt werden. Für dieses Beispiel haben wir mehrere Plattformen definiert, aber es ist auch kein Problem, eine einzige Plattform für die Variable _PLATFORM_VALUES zu haben.

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

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

Die Datei CMakeLists.txt enthält eine Prüfung zum Abbruch von Builds, die für nicht unterstützte Plattformen gestartet wurden.

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()

Die nächste Variable, die definiert werden muss, ist OT_PLATFORM_LIB. Diese Variable wird von den OpenThread-Beispielanwendungen verwendet, um eine Verknüpfung zu Ihrer Plattform herzustellen.

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

OpenThread CMake-Optionen

Verschiedene Funktionen in OpenThread können durch Definition von CMake-Variablen aktiviert/deaktiviert/konfiguriert werden.

Auf der Plattform ot-efr32 wird eine externe mbedTLS-Bibliothek silabs-mbedtls verwendet.

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})

Ausgabeverzeichnisse definieren

Das Ausgabeverzeichnis für verschiedene Zieldateien kann mithilfe der folgenden Variablen konfiguriert werden.

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 zum Build-Baum hinzufügen

So schließen Sie das Submodul openthread in die Build-Struktur ein:

add_subdirectory(openthread)

Build-Attribute an OpenThread übergeben

Im letzten Abschnitt dieser Datei kannst du Build-Attribute wie Definitionen, Optionen und Verzeichnisse angeben, die du dem Build-Baum openthread und deinen Plattformbibliotheken hinzufügen möchtest.

Diese Definitionen können Sie ganz einfach mithilfe des Ziels ot-config hinzufügen. Dieses Ziel ist ein gefälschtes Ziel, das ausschließlich zum Definieren der Konfiguration verwendet wird. Es ist mit fast allen CMake-Zielen in openthread verknüpft.

# 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
)

Unterverzeichnisse in die Build-Struktur einfügen

Nachdem Sie nun die oberste Ebene der Konfiguration definiert haben, sollten Sie der Build-Struktur weitere Unterverzeichnisse hinzufügen.

Im Ordner src befindet sich der Quellcode der Plattformabstufung. Der Ordner third_party enthält beliebigen Drittanbietercode.

Wenn Sie Beispielanwendungen in das Repository aufnehmen möchten, erstellen Sie einen examples-Ordner und fügen diesen ebenfalls dem Build-Baum hinzu.

add_subdirectory(src)
add_subdirectory(third_party)

# Optional
add_subdirectory(examples)

Verzeichnis src

Dies ist das Herzstück des Repositorys, in dem die Plattformabstraktionsebene implementiert ist. Es enthält auch einige weitere erforderliche Dateien.

src/arm-none-eabi.cmake

Dies ist eine Toolchain-Datei, die einige Variablen definiert, die CMake im Build-Prozess verwendet. Ein guter Ausgangspunkt ist, die ot-efr32-Version dieser Datei zu kopieren und an die Plattform anzupassen.

src/CMakeLists.txt

Hier definieren Sie die Quelldateien, fügen Pfade und Compiler-Flags für Ihre Plattformbibliothek hinzu. Ein gutes Beispiel für diese Datei für ein Repository, das nur eine einzige Plattform unterstützt, ist ot-cc2538.

Es können mehrere Plattformen in einem einzelnen Repository unterstützt werden und mehrere Plattform-Repositories können als Referenz verwendet werden. Weitere Informationen finden Sie unter ot-efr32 und ot-nrf528xx.