docs: добавь поясняющие комментарии к модулям и инструментам

This commit is contained in:
2026-10-02 16:46:19 +03:00
parent 6cbce6c360
commit 427fc70100
488 changed files with 2877 additions and 1 deletions
+4
View File
@@ -1,3 +1,7 @@
# Сборка библиотеки spi_nor. Состав исходников и публичные include-пути задают подключение к
# проекту потребителя. Файл также собирает и регистрирует хостовые проверки; запускать их
# следует через CTest из каталога сборки.
cmake_minimum_required(VERSION 3.13)
project(spi_nor C)
add_library(spi_nor STATIC Src/spi_nor.c)
@@ -1,3 +1,9 @@
/*
* Ограниченный диагностический сервис коротких команд SPI NOR. Допускаются только чтение
* данных, статуса и JEDEC ID; allowlist не позволяет использовать этот интерфейс как
* произвольную командную консоль Flash.
*/
#ifndef SPI_NOR_COMMAND_SERVICE_H
#define SPI_NOR_COMMAND_SERVICE_H
@@ -1,3 +1,9 @@
/*
* Диагностическое чтение SPI NOR с явной ёмкостью памяти и обратным вызовом чтения. Интерфейс
* не содержит операций программирования и стирания; диапазон запроса проверяется до доступа к
* памяти.
*/
#ifndef SPI_NOR_READ_SERVICE_H
#define SPI_NOR_READ_SERVICE_H
@@ -1,3 +1,9 @@
/*
* Ограниченный диагностический сервис коротких команд SPI NOR. Допускаются только чтение
* данных, статуса и JEDEC ID; allowlist не позволяет использовать этот интерфейс как
* произвольную командную консоль Flash.
*/
#include "spi_nor_command_service.h"
#include <string.h>
@@ -1,3 +1,9 @@
/*
* Диагностическое чтение SPI NOR с явной ёмкостью памяти и обратным вызовом чтения. Интерфейс
* не содержит операций программирования и стирания; диапазон запроса проверяется до доступа к
* памяти.
*/
#include "spi_nor_read_service.h"
#include <string.h>
+6
View File
@@ -1,3 +1,9 @@
/*
* Команды SPI NOR через обратные вызовы порта: определение устройства, чтение, запись и
* стирание. Ограничения страницы, сектора и состояния BUSY относятся к микросхеме; GPIO и
* SPI-периферию настраивает приложение.
*/
#ifndef PORTABLE_SPI_NOR_H
#define PORTABLE_SPI_NOR_H
+6
View File
@@ -1,3 +1,9 @@
/*
* Команды SPI NOR через обратные вызовы порта: определение устройства, чтение, запись и
* стирание. Ограничения страницы, сектора и состояния BUSY относятся к микросхеме; GPIO и
* SPI-периферию настраивает приложение.
*/
#include "spi_nor.h"
#include <string.h>
+6
View File
@@ -1,3 +1,9 @@
/*
* Проверки spi_nor: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "spi_nor.h"
#include <stdio.h>
@@ -1,3 +1,10 @@
/*
* Проверки spi_nor_command_service: фиксируют ожидаемое поведение на воспроизводимых входных
* данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "spi_nor_command_service.h"
#include <stdio.h>
@@ -1,3 +1,10 @@
/*
* Проверки spi_nor_read_service: фиксируют ожидаемое поведение на воспроизводимых входных
* данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "spi_nor_read_service.h"
#include <stdio.h>