Настройка среды сборки

Посмотреть исходный код на GitHub

Чтобы продвигать бесплатную и открытую разработку, OpenThread использует CMake в цепочке инструментов сборки. В настоящее время этот набор инструментов требуется для переноса OpenThread на новую аппаратную платформу.

Другие цепочки инструментов сборки могут поддерживаться в будущем, но они не входят в рамки этого руководства по переносу.

Создать новый репозиторий

Первый шаг — настроить новый дом для вашей аппаратной платформы. В этом руководстве мы создадим новый репозиторий с именем ot-efr32 , который содержит уровень абстракции платформы, SDK аппаратной платформы и несколько полезных скриптов.

В этом примере мы создали репозиторий SiliconLabs/ot-efr32 на GitHub и клонировали его в ~/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.

В этом примере мы добавим облегченную версию 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 сценарий просто выполняет сценарий build для каждой поддерживаемой платы на каждой из платформ efr32.

В качестве примера см. тестовый сценарий в ot-efr32 .

make-pretty

Чтобы поддерживать единообразный стиль, этот сценарий должен форматировать код, сценарии и файлы уценки.

Вы можете определить этот сценарий самостоятельно, но может быть проще всего использовать сценарий make-pretty , который используют существующие репозитории платформы. Сценарий вызывает сценарии стиля openthread и помогает обеспечить согласованный стиль во всех репозиториях OpenThread.

Конфигурация скрипта компоновщика

Сценарий компоновщика GNU описывает, как сопоставить все разделы входных файлов ( .o "объектные" файлы, сгенерированные GNU Compiler Collection (GCC)) с окончательным выходным файлом (например, .elf ). Он также определяет место хранения каждого сегмента исполняемой программы, а также адрес входа. Сценарий компоновщика для конкретной платформы часто предоставляется вместе с BSP платформы.

Настройте инструмент ld , чтобы он указывал на сценарий компоновщика для конкретной платформы, используя target_link_libraries на цели CMake вашей платформы в src/CMakeLists.txt :

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
)

Код запуска цепочки инструментов

Код запуска Toolchain часто предоставляется вместе с BSP платформы. Этот код обычно:

  1. Реализует функцию входа ( Reset_Handler ) исполняемой программы
  2. Определяет таблицу векторов прерываний
  3. Инициализирует кучу и стек
  4. Копирует раздел .data из энергонезависимой памяти в оперативную память
  5. Переход к основной функции приложения для выполнения логики приложения.

Код запуска (исходный код C или ассемблера) должен быть включен в библиотеку openthread- platform-name вашей платформы, в противном случае некоторые ключевые переменные, используемые в скрипте компоновщика, не могут быть правильно указаны в кавычках:

  • src/CMakeLists.txt

Пример : startup-gcc.c в ot-cc2538src/CMakeLists.txt

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