Перенести паспорт и проверку прошивки из 167 в 166
Добавить неизменяемое окно firmware-info v1 0x1200 из 12 слов для FC03 и служебного CAN, запретить запись. Сохранить текущую технологическую карту и логгер v4 с записью 12 слов. Подключить общий генератор версии 1.0.0 для Balsam-166-PM35, prebuild CCS и локальный выпуск BIN с manifest и SHA-256. Проверять соответствие встроенных слов манифесту до публикации; старый OUT без паспорта отклонять. Проверка: реальные обработчики RS/CAN и CRC под GCC O3, прежний тест логгера, анализатор установленного SetGUI, полная сборка TI C2000 22.6.0.LTS. BIN 30248 байт при границе параметров 32508 байт. Аппаратная проверка требует установки нового образа и перезапуска платы.
This commit is contained in:
File diff suppressed because one or more lines are too long
@@ -16,14 +16,47 @@
|
||||
Файл `28335_RAM_lnk.cmd`, как и в 167, исключён из сборки.
|
||||
|
||||
Результаты сборки находятся в `166/Bin`: `UKSSTMS320F28335.out`,
|
||||
`UKSSTMS320F28335.hex` (Intel HEX) и `UKSSTMS320F28335_<commit>.bin`,
|
||||
где `<commit>` — короткий хеш текущего коммита Git (не менее 8 символов).
|
||||
BIN создаётся скриптом `build_bin.bat`; Git должен быть доступен в `PATH`
|
||||
процесса CCS. Если определить коммит не удалось, сборка завершается ошибкой.
|
||||
При наличии незакоммиченных правок хеш обозначает HEAD и не описывает эти правки.
|
||||
Post-build использует имеющийся `166/Bin/hex2000.exe` с параметрами
|
||||
`-boot -sci8`, как в 167. Карта линковки находится в корне 166, карта
|
||||
преобразования загрузочного образа — в `166/Bin`.
|
||||
`UKSSTMS320F28335.hex` (Intel HEX) и `UKSSTMS320F28335_<build_id>.bin`.
|
||||
Рядом с BIN создаются `<имя>.bin.manifest.json` и `<имя>.bin.sha256`.
|
||||
Build ID содержит восемь символов: восемь цифр ревизии либо семь цифр и `+`
|
||||
при изменённых исходниках или общей библиотеке. При недоступном Git общий
|
||||
контракт 167 использует `NOGIT000`; для выпуска следует проверить ревизии
|
||||
`source` и `templates` в манифесте. Время паспорта хранится в UTC.
|
||||
|
||||
Prebuild `prepare_identity.py` использует тот же генератор firmware-info,
|
||||
что 167, но product равен `Balsam-166-PM35`. Единственный источник версии —
|
||||
`firmware_version.h`; первый выпуск с паспортом имеет версию **1.0.0**.
|
||||
Обязательный `generated/firmware_identity.h` создаётся до компиляции.
|
||||
Postbuild `build_identity.py` использует hex2000 из выбранного компилятора
|
||||
CCS, общий манифест и SHA-256, затем независимо проверяет наличие ровно
|
||||
одного соответствующего 12-словного паспорта в SCI8. Старый OUT без паспорта
|
||||
или BIN с чужими полями не публикуется. Превышение границы параметров EEPROM
|
||||
**32508 байт** также останавливает выпуск. Архивы сохраняются локально в
|
||||
`UKSSTMS320F28335/Debug/firmware`; записи в репозиторий GUI нет.
|
||||
|
||||
`build_bin.bat` сохраняет ручную точку входа для уже скомпилированного OUT,
|
||||
но теперь также требует его совпадения с паспортом соответствующего prebuild.
|
||||
Простая конверсия старой прошивки не может создать ей достоверную версию.
|
||||
Карта линковки остаётся в корне 166, карта конверсии — в `166/Bin`.
|
||||
|
||||
## Проверка прошивки в SetGUI
|
||||
|
||||
Из 167 точечно перенесён контракт firmware-info v1: FC03, адрес **0x1200**,
|
||||
**12 регистров**, версия, дата UTC и Build ID. Чтение доступно также через
|
||||
существующий служебный CAN; запись в паспорт запрещена. Технологическая
|
||||
карта, логгер v4 с записью 12 слов, управление и CAN ID не меняются.
|
||||
|
||||
В GUI выберите модель **«Бальзам-166 · ПМ35»**, новый BIN и оставьте рядом
|
||||
его `.bin.manifest.json`. После записи EEPROM перезапустите плату и нажмите
|
||||
чтение версии: продолжающая работать старая прошивка ещё не имеет окна
|
||||
0x1200 и отвечает `Modbus 2`. Надпись CRC OK при записи подтверждает запись
|
||||
EEPROM, а версия начнёт читаться после запуска нового образа. Сравнение
|
||||
версий и SHA-256 манифеста не является измерением SHA всей памяти платы.
|
||||
|
||||
`python tests/firmware_identity/run_test.py` проверяет реальные обработчики
|
||||
RS/CAN, все слова паспорта, CRC, частичные чтения, границы, запрет записи,
|
||||
сохранность старой карты и логгера. Отдельно проверяются устаревшие и
|
||||
повреждённые SCI8, предел EEPROM и действующий анализатор манифеста SetGUI.
|
||||
|
||||
Проверено: импорт и полная сборка **Debug** в CCS **12.7.1** с компилятором
|
||||
**22.6.1.LTS**, включая генерацию HEX/BIN, завершились без ошибок.
|
||||
@@ -31,5 +64,12 @@ Post-build использует имеющийся `166/Bin/hex2000.exe` с па
|
||||
(преобразование знака, выход результата за диапазон и отсутствие перевода
|
||||
строки в конце файла). Проверка на устройстве не выполнялась.
|
||||
|
||||
Перенос паспорта дополнительно проверен полной пересборкой и линковкой
|
||||
TI C2000 **22.6.0.LTS** и host-тестами под GCC с оптимизацией O3. Проверенный
|
||||
SCI8 BIN занимает **30248 байт**, запас до параметров EEPROM — **2260 байт**.
|
||||
Совпадение встроенного паспорта, манифеста и результата штатного анализатора
|
||||
SetGUI проверено программно; обмен новой прошивки с физической платой
|
||||
требует её установки и перезапуска.
|
||||
|
||||
Конфигурация **Release** перенесена из 167 без изменений и не проверялась;
|
||||
для сборки прошивки используйте **Debug**.
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
"""Выпускает BIN 166 с проверяемым паспортом и SHA-256 по той же схеме, что 167.""" # Генерация версии выполняется отдельно до компиляции.
|
||||
import argparse # Разбирает пути текущей конфигурации CCS и компилятора TI.
|
||||
from datetime import datetime # Преобразует время UTC паспорта в те же шесть компонентов, что firmware-info v1.
|
||||
import json # Читает именно паспорт завершившейся компиляции.
|
||||
from pathlib import Path # Привязывает настройки и результаты к текущему проекту.
|
||||
import shutil # Находит компилятор и копирует только полностью проверенный выпуск.
|
||||
import struct # Проверяет 16-битные слова загрузочного SCI8 без исполнения кода прошивки.
|
||||
import sys # Подключает общий postbuild вместо копии конвертера из 167.
|
||||
import tempfile # Не публикует результаты конверсии, пока встроенный паспорт не прошёл проверку.
|
||||
ROOT = Path(__file__).resolve().parents[1] # Корень 166 содержит существующие Source и Bin.
|
||||
PROJECT = Path(__file__).resolve().parent # Конфигурации Debug/Release и заголовок версии находятся рядом со сценарием.
|
||||
TEMPLATES = ROOT.parent / "newProject/templates" # Использует ту же общую библиотеку firmware-info, что проект 167.
|
||||
def verify_embedded(image, metadata): # Не позволяет выдать новый манифест за паспорт старого OUT без встроенной версии.
|
||||
data = image.read_bytes() # Проверяет точные октеты, которые будут отправлены в плату.
|
||||
if data[:2] != b"\xaa\x08" or not 24 <= len(data) <= 32508: # SCI8 имеет ключ 0x08AA; граница параметров 166 равна (0x3FFF - 129) * 2 = 32508 байт.
|
||||
raise ValueError("SCI8 is invalid or overlaps the 166 parameter area at byte 32508") # Не допускает повреждения существующих параметров EEPROM.
|
||||
stamp = datetime.fromisoformat(metadata["built_at_utc"]) # Использует исходное время prebuild без подмены временем конверсии BIN.
|
||||
build_id = metadata["build_id"] # Ровно восемь ASCII-символов совпадают с четырьмя регистрами firmware-info v1.
|
||||
words = [1, *metadata["version"], stamp.year, stamp.month * 256 + stamp.day, stamp.hour * 256 + stamp.minute, stamp.second] # Восстанавливает первые восемь регистров независимо от C-упаковщика.
|
||||
words += [ord(build_id[i]) * 256 + ord(build_id[i + 1]) for i in range(0, 8, 2)] # Восстанавливает четыре слова Build ID в сетевом порядке символов.
|
||||
expected = struct.pack("<12H", *words) # Загрузочная таблица SCI8 хранит 16-битные слова C28x младшим октетом вперёд.
|
||||
offset, found = 22, 0 # Первые 22 октета заняты ключом, настройками и аппаратной точкой входа.
|
||||
while offset + 2 <= len(data): # Каждый шаг потребляет заголовок либо завершает конечный файл; ожидания аппаратуры нет.
|
||||
count, = struct.unpack_from("<H", data, offset) # Размер очередной секции задан в 16-битных словах C28x.
|
||||
offset += 2 # Переходит к адресу секции либо концу таблицы при нулевом размере.
|
||||
if not count: break # Нулевая секция завершает SCI8 и не содержит адреса назначения.
|
||||
end = offset + 4 + count * 2 # Четыре октета адреса не входят в проверяемую полезную нагрузку секции.
|
||||
if end > len(data): raise ValueError("Truncated SCI8 section") # Останавливает выпуск при выходе секции за фактический размер файла.
|
||||
payload = data[offset + 4:end] # Рассматривает загружаемые слова, а не случайное совпадение в заголовке.
|
||||
found += sum(payload[i:i + 24] == expected for i in range(0, len(payload) - 23, 2)) # Паспорт должен присутствовать один раз на границе слова C28x.
|
||||
offset = end # Переходит к следующей непересекающейся секции таблицы.
|
||||
if offset != len(data) or count or found != 1: # Запрещает хвосты, отсутствующий терминатор и манифест от другой компиляции.
|
||||
raise ValueError(f"SCI8 does not contain exactly one matching prebuild identity: {found}") # Требует полноценную пересборку вместо фиктивного подписания старого BIN.
|
||||
def find_compiler(): # Сохраняет возможность ручного запуска build_bin.bat без жёсткой привязки к одной версии CCS.
|
||||
executable = shutil.which("cl2000") or shutil.which("cl2000.exe") # Предпочитает компилятор среды текущего проекта, а не старый hex2000 рядом с BIN.
|
||||
if executable: return Path(executable).resolve().parents[1] # Возвращает корень toolchain с каталогом bin/hex2000.exe.
|
||||
installed = sorted(Path("C:/ti").glob("ccs*/ccs/tools/compiler/ti-cgt-c2000_*")) # Для установленного CCS использует только штатные каталоги TI.
|
||||
installed = [path for path in installed if (path / "bin/hex2000.exe").is_file()] # Не принимает неполную установку за пригодный конвертер.
|
||||
if not installed: raise FileNotFoundError("Pass --compiler with the C2000 toolchain root") # Явно останавливает ручной запуск без инструментов.
|
||||
return installed[-1] # Выбирает последнюю найденную установленную цепочку только при отсутствии заданной CCS версии.
|
||||
def build(compiler, build_dir, artifact): # Выполняет общий postbuild и локальную публикацию после проверки встроенной версии.
|
||||
sys.path.insert(0, str(TEMPLATES / "c/firmware-info/tools")) # Открывает общие identity.py и c2000_postbuild.py из той же зависимости, что 167.
|
||||
from c2000_postbuild import postbuild # Не копирует формат манифеста, архивирование и вычисление SHA-256.
|
||||
metadata_path = build_dir / "generated/firmware_identity.json" # Отсутствующий prebuild должен остановить выпуск вместо использования произвольной версии.
|
||||
metadata = json.loads(metadata_path.read_text(encoding="utf-8")) # Читает JSON, по которому компилятор получил firmware_identity.h.
|
||||
if metadata.get("product") != "Balsam-166-PM35" or metadata.get("target") != "TMS320F28335": raise ValueError("Run the 166 prebuild before publishing this image") # Старый generated от ветки 167 не должен выдавать её product за паспорт 166.
|
||||
output = build_dir / "firmware" # Сохраняет прежнюю для 167 структуру локального каталога выпусков.
|
||||
with tempfile.TemporaryDirectory(prefix=".identity-release-", dir=build_dir) as directory: # Непроверенные BIN и manifest существуют только во временном каталоге текущего вызова.
|
||||
stage = Path(directory); staged_image = postbuild(compiler, build_dir, artifact, metadata_path, stage) # Общий код создаёт HEX, BIN, SHA-256 и архив, пока не доступные как готовый выпуск.
|
||||
verify_embedded(staged_image, metadata) # Не переносит в firmware или Bin результаты от старого OUT либо другой компиляции.
|
||||
output.mkdir(parents=True, exist_ok=True) # Создаёт каталог публикации только после успешной проверки.
|
||||
for item in stage.iterdir(): # Сохраняет только результаты этого вызова, не сканируя старые выпуски.
|
||||
if item.is_dir(): shutil.copytree(item, output / item.name, dirs_exist_ok=True) # Публикует полный архив проверенной сборки.
|
||||
else: shutil.copy2(item, output / item.name) # Переносит плоские HEX/BIN и контрольные файлы без подмены других исходников.
|
||||
image = output / staged_image.name # После удаления временного каталога возвращает постоянный путь проверенного BIN.
|
||||
for file in (image, image.with_suffix(".bin.manifest.json"), image.with_suffix(".bin.sha256"), image.parent / (image.stem.rsplit("_", 1)[0] + ".hex")): # Сохраняет рядом проверенный BIN, его контрольные файлы и прежний Intel HEX для CCS.
|
||||
shutil.copy2(file, ROOT / "Bin" / file.name) # Основной каталог получает только результат успешной текущей сборки.
|
||||
shutil.copy2(image.parent / (image.stem.rsplit("_", 1)[0] + ".hex.map"), ROOT / "Bin/UKSSTMS320F28335.map") # Согласовывает прежнюю основную карту конверсии с новым HEX и OUT.
|
||||
print(ROOT / "Bin" / image.name) # Показывает конкретный BIN, который нужно выбрать в SetGUI вместе с лежащим рядом манифестом.
|
||||
return image # Позволяет тестам проверить результат без поиска случайного старого файла.
|
||||
if __name__ == "__main__": # Импорт проверки SCI8 не выполняет сборку или публикацию файлов.
|
||||
parser = argparse.ArgumentParser(description=__doc__) # Описывает контракт запуска из CCS и build_bin.bat.
|
||||
parser.add_argument("--compiler", type=Path) # CCS передаёт CG_TOOL_ROOT; ручной вызов может использовать обнаружение установленного компилятора.
|
||||
parser.add_argument("--build-dir", type=Path, default=PROJECT / "Debug") # Изолирует паспорт и архив выбранной конфигурации.
|
||||
parser.add_argument("--artifact", default=str(ROOT / "Bin/UKSSTMS320F28335")) # Общий postbuild ожидает полный путь OUT без расширения.
|
||||
args = parser.parse_args() # Проверяет параметры до выполнения конверсии.
|
||||
build((args.compiler or find_compiler()).resolve(), args.build_dir.resolve(), args.artifact) # Публикует только образ, соответствующий своему встроенному паспорту.
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"product": "Balsam-166-PM35",
|
||||
"target": "TMS320F28335"
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
#ifndef BALSAM_FIRMWARE_VERSION_H /* Защищает единственный источник версии продукта 166 от повторного включения. */
|
||||
#define BALSAM_FIRMWARE_VERSION_H /* Отделяет номер версии приложения от версии логгера и контракта паспорта. */
|
||||
#define FIRMWARE_VERSION_MAJOR 1U /* Первая версия 166 с читаемым паспортом; это версия продукта, а не заимствованный номер прошивки 167. */
|
||||
#define FIRMWARE_VERSION_MINOR 0U /* Нулевая минорная версия начинает самостоятельную линию выпусков Balsam-166-PM35. */
|
||||
#define FIRMWARE_VERSION_PATCH 0U /* Нулевой номер исправления меняется при следующем выпуске продукта. */
|
||||
#endif /* Генератор читает эти три определения перед компиляцией и помещает их в паспорт BIN. */
|
||||
@@ -1,33 +1,8 @@
|
||||
@rem Совместимая точка входа старых make-файлов Debug после подключения паспорта прошивки.
|
||||
@echo off
|
||||
rem Сохраняет локальность настроек процесса конвертации.
|
||||
setlocal
|
||||
|
||||
for %%I in ("%~dp0..") do set "SRC_ROOT=%%~fI"
|
||||
|
||||
:process_arg
|
||||
if "%1"=="" goto end_process_arg
|
||||
set name=%1
|
||||
set value=
|
||||
|
||||
:process_arg_value
|
||||
if NOT "%value%"=="" set value=%value% %2
|
||||
if "%value%"=="" set value=%2
|
||||
shift
|
||||
if "%2"=="!" goto set_arg
|
||||
if "%2"=="" goto set_arg
|
||||
goto process_arg_value
|
||||
|
||||
:set_arg
|
||||
set %name%=%value%
|
||||
shift
|
||||
shift
|
||||
goto process_arg
|
||||
:end_process_arg
|
||||
|
||||
pushd "%SRC_ROOT%\Bin" || exit /b 1
|
||||
hex2000.exe UKSSTMS320F28335.out -boot -sci8 -map UKSSTMS320F28335.map -o UKSSTMS320F28335.hex -i
|
||||
set "BUILD_RESULT=%errorlevel%"
|
||||
popd
|
||||
if not "%BUILD_RESULT%"=="0" exit /b %BUILD_RESULT%
|
||||
|
||||
call "%SRC_ROOT%\build_bin.bat"
|
||||
rem Сценарий сам находит Debug и проверяет его generated/firmware_identity.json; старые служебные аргументы CCS здесь не нужны.
|
||||
python "%~dp0build_identity.py"
|
||||
rem Возвращает ошибку при старом OUT, отсутствующем паспорте либо превышении области параметров.
|
||||
exit /b %errorlevel%
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
"""Подготавливает паспорт 166 тем же генератором firmware-info, что используется в 167.""" # Версия, время UTC и ревизии фиксируются до компиляции.
|
||||
import argparse # Разбирает одинаковые с проектом 167 пути prebuild.
|
||||
import importlib.util # Подключает общую реализацию без копирования генератора в прошивку.
|
||||
import json # Объединяет идентификаторы продукта с версией из C-заголовка.
|
||||
from pathlib import Path # Нормализует пути независимо от рабочего каталога CCS.
|
||||
import re # Проверяет единственное допустимое целое определение каждого компонента версии.
|
||||
import tempfile # Хранит объединённые настройки только на время вызова общего генератора.
|
||||
def read_version(header): # Сохраняет правила исходного адаптера 167 и ограничения firmware-info v1.
|
||||
text = re.sub(r"/\*.*?\*/|//[^\n]*", "", header.read_text(encoding="utf-8-sig"), flags=re.S) # Не принимает комментарии или примеры за действующую версию.
|
||||
result = [] # Накапливает major, minor и patch в порядке регистров контракта.
|
||||
for part, limit in (("MAJOR", 255), ("MINOR", 255), ("PATCH", 999)): # Два первых компонента ограничены октетом, исправление допускает 0..999.
|
||||
name = "FIRMWARE_VERSION_" + part # Использует тот же интерфейс заголовка версии, что 167.
|
||||
definitions = re.findall(r"^\s*#\s*define\s+" + name + r"\b([^\n]*)", text, re.M) # Требует единственного определения без условных альтернатив.
|
||||
if len(definitions) != 1 or not re.fullmatch(r"(?:0|[1-9][0-9]*)[uU]?", definitions[0].strip()): # Не допускает выражений, шестнадцатеричных литералов и неоднозначной версии.
|
||||
raise ValueError(f"{header}: define {name} exactly once as a decimal integer") # Останавливает сборку вместо выпуска ложного паспорта.
|
||||
value = int(definitions[0].strip().rstrip("uU")) # Суффикс C не является частью десятичного числа Python.
|
||||
if value > limit: # Проверяет границы до записи какого-либо заголовка сборки.
|
||||
raise ValueError(f"{name} must be in 0..{limit}") # Сохраняет ограничения отображения и Modbus-контракта 167.
|
||||
result.append(value) # Записывает проверенную компоненту в правильное поле паспорта.
|
||||
return result # Номер версии формируется только из firmware_version.h.
|
||||
def prepare(project, templates, output): # Генерирует заголовок и JSON для одной конкретной конфигурации CCS.
|
||||
settings = json.loads((project / "firmware_identity.json").read_text(encoding="utf-8-sig")) # Сохраняет собственный product 166 и тот же target TMS320F28335.
|
||||
settings["version"] = read_version(project / "firmware_version.h") # Не дублирует SemVer в двух редактируемых файлах.
|
||||
spec = importlib.util.spec_from_file_location("shared_firmware_identity", templates / "c/firmware-info/tools/identity.py") # Берёт проверенную общую реализацию из той же зависимости, что 167.
|
||||
identity = importlib.util.module_from_spec(spec) # Создаёт изолированный модуль генератора без изменения системного Python.
|
||||
spec.loader.exec_module(identity) # Загружает формат заголовка, UTC и правила формирования Build ID.
|
||||
with tempfile.TemporaryDirectory(prefix="balsam166-identity-") as directory: # Удаляет только временные объединённые настройки этого вызова.
|
||||
config = Path(directory) / "settings.json" # Настройки не записываются в исходники и не попадают в историю Git.
|
||||
config.write_text(json.dumps(settings), encoding="utf-8") # Передаёт общему генератору проверенную версию и product.
|
||||
return identity.prepare(project, templates, config, output) # Создаёт обязательные generated/firmware_identity.h и JSON до компиляции.
|
||||
if __name__ == "__main__": # Импорт из теста не запускает изменение файлов сборки.
|
||||
parser = argparse.ArgumentParser(description=__doc__) # Объясняет назначение prebuild при ручном вызове.
|
||||
for name in ("project", "templates", "output"): parser.add_argument("--" + name, type=Path, required=True) # Совместим с параметрами prebuild исходного проекта 167.
|
||||
args = parser.parse_args() # Проверяет обязательные каталоги перед генерацией.
|
||||
print(json.dumps(prepare(args.project.resolve(), args.templates.resolve(), args.output.resolve()))) # Показывает фактическую идентичность текущей сборки.
|
||||
Reference in New Issue
Block a user