docs: добавь поясняющие комментарии к модулям и инструментам
This commit is contained in:
@@ -1,3 +1,7 @@
|
||||
# Сборка библиотеки protocan_boot. Состав исходников и публичные include-пути задают
|
||||
# подключение к проекту потребителя. Файл также собирает и регистрирует хостовые проверки;
|
||||
# запускать их следует через CTest из каталога сборки.
|
||||
|
||||
cmake_minimum_required(VERSION 3.13)
|
||||
project(protocan_boot C)
|
||||
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Автомат адресной загрузки прошивки по ProtoCAN с сессией, контрольной суммой и A/B-слотами.
|
||||
* Приём блоков, проверка образа и активация разделены на этапы; операции Flash и метаданные
|
||||
* слотов предоставляет платформа.
|
||||
*/
|
||||
|
||||
#ifndef PCAN_BOOT_H
|
||||
#define PCAN_BOOT_H
|
||||
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Автомат адресной загрузки прошивки по ProtoCAN с сессией, контрольной суммой и A/B-слотами.
|
||||
* Приём блоков, проверка образа и активация разделены на этапы; операции Flash и метаданные
|
||||
* слотов предоставляет платформа.
|
||||
*/
|
||||
|
||||
#include "pcan_boot.h"
|
||||
|
||||
#include <string.h>
|
||||
|
||||
@@ -1,3 +1,16 @@
|
||||
/*
|
||||
* Проверки pcan_boot: фиксируют ожидаемое поведение на воспроизводимых входных данных.
|
||||
* Сценарии для навигации по файлу:
|
||||
* test_id_layout
|
||||
* test_crc32_reference
|
||||
* test_complete_update
|
||||
* test_rejects_wrong_address_and_sequence
|
||||
* test_rejects_wrong_session_and_compatibility
|
||||
* test_single_slot_update
|
||||
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
|
||||
* настройками рабочего устройства.
|
||||
*/
|
||||
|
||||
#include "pcan_boot.h"
|
||||
|
||||
#include <assert.h>
|
||||
|
||||
Reference in New Issue
Block a user