docs: добавь поясняющие комментарии к модулям и инструментам
This commit is contained in:
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Конфигурация set-protocol для порта stm32f407-usb-boot. Макросы задают параметры сборки и
|
||||
* ограничения, используемые исходниками этого модуля. Это образец для проекта: значения
|
||||
* выводов, размеров памяти и параметров устройства необходимо согласовать с целевой платой.
|
||||
*/
|
||||
|
||||
#ifndef F407_BOOT_CONFIG_H
|
||||
#define F407_BOOT_CONFIG_H
|
||||
/* Copy to the board include directory as boot_config.h.
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Аппаратные операции Flash односекционного USB-загрузчика: стирание, запись, проверка и
|
||||
* фиксация образа. Геометрия разделов берётся из конфигурации платы; признак завершения нельзя
|
||||
* записывать до успешной проверки данных.
|
||||
*/
|
||||
|
||||
/* Flash geometry and jump sequence derived from climate's F407 bootloader.
|
||||
* Sector 3 is a durable commit record; sectors 4..7 hold the application.
|
||||
* Reset checks vectors like climate; USB END always verifies Flash. */
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Проверки образа перед передачей управления приложению. Адрес стека и вектор сброса должны
|
||||
* соответствовать памяти целевой платы; наличие байтов во Flash само по себе не означает
|
||||
* готовность образа к запуску.
|
||||
*/
|
||||
|
||||
#ifndef F407_BOOT_IMAGE_H
|
||||
#define F407_BOOT_IMAGE_H
|
||||
#include "boot_port.h"
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Старт USB-загрузчика и выбор между обслуживанием обновления и запуском приложения. Здесь
|
||||
* настраиваются аппаратные часы и цикл обслуживания; код выполняется в окружении конкретного
|
||||
* MCU.
|
||||
*/
|
||||
|
||||
#include "stm32f4xx_hal.h"
|
||||
#include "boot_config.h"
|
||||
#include "usb_cdc.h"
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Контракт аппаратного USB-загрузчика: доступ к образу, запрос перезапуска и операции Flash.
|
||||
* Его реализация зависит от семейства MCU, тогда как последовательность обновления задаётся
|
||||
* общим set_boot.
|
||||
*/
|
||||
|
||||
#ifndef F407_BOOT_PORT_H
|
||||
#define F407_BOOT_PORT_H
|
||||
#include "set_boot.h"
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
/*
|
||||
* Передача запроса входа в загрузчик через backup-состояние и отложенный сброс. Флаг должен
|
||||
* пережить перезапуск, чтобы загрузчик отличил обновление от обычного старта приложения.
|
||||
*/
|
||||
|
||||
#include "boot_port.h"
|
||||
#include "stm32f4xx_hal.h"
|
||||
#define REQUEST_MAGIC 0x42555342UL
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Обслуживание SETProtocol v2 поверх USB CDC для загрузчика. Поток USB разбирается на полные
|
||||
* команды, после чего операции передаются общему автомату обновления; граница USB-пакета не
|
||||
* является границей SET-кадра.
|
||||
*/
|
||||
|
||||
#include "stm32f4xx_hal.h"
|
||||
#include "boot_port.h"
|
||||
#include "boot_config.h"
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Проверки boot_image: фиксируют ожидаемое поведение на воспроизводимых входных данных.
|
||||
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
|
||||
* настройками рабочего устройства.
|
||||
*/
|
||||
|
||||
#include "boot_image.h"
|
||||
#include <assert.h>
|
||||
#include <stdio.h>
|
||||
|
||||
Reference in New Issue
Block a user