# Простое подключение контроля прошивки к ISE

1. Запустите **`INSTALL_ISE.bat` из этого каталога** и вставьте путь к вашему
   `.xise`. Можно просто перетащить `.xise` на этот BAT.
2. Установщик сам прочитает кристалл, язык, имя `.bit` и рабочий каталог
   из проекта, скопирует локальные команды и создаст настройки.
3. Один раз подключите паспорт к шине проекта по созданному файлу
   `firmware_identity_instance.txt`: адрес слова — `word_addr[3:0]`,
   данные — `word_data[15:0]`. Без использования выхода паспорт удалит синтезатор.
4. Для сборки запускайте **`build_firmware.bat` рядом с `.xise`**.
   Для проверки настройки без сборки — `build_firmware.bat --check`.

Автоматически создаются:

| Файл | Назначение |
|---|---|
| `build_firmware.bat`, `firmware_build.py` | Локальная команда сборки |
| `firmware_build.json` | Найденные пути проекта, библиотеки templates, `.bit` и окружения ISE |
| `firmware_identity.json` | Изделие, кристалл и сохраняемый счётчик версии |
| `firmware_identity_instance.txt` | Заготовка подключения для Verilog или VHDL |
| `FIRMWARE_SETUP.md` | Памятка внутри проекта |
| `build/ise/generated/` | Предварительно созданный HDL-паспорт; обновляется перед каждой сборкой |

Нужен Python 3.9+ через `py -3` или `python`. Окружение ISE ищется в PATH
и стандартных каталогах Xilinx. Для нестандартной установки один раз задайте
`ise_settings` в `firmware_build.json` — полный путь к `settings64.bat`
или `settings32.bat`.

Общие инструменты используются из вашей библиотеки templates; вручную
копировать её внутрь проекта не требуется. Если библиотека переехала,
исправьте поле `templates` в `firmware_build.json`.

Первая сборка получает **0.1.1**. Установка и `--check` номер не расходуют;
неудачная попытка синтеза расходует. Повторная установка сохраняет существующие
JSON и версию; чужие BAT с тем же именем не перезаписывает.

Готовый `.bit`, manifest, SHA-256, HDL и метаданные сохраняются в
`build/ise/firmware/HASH_ДАТА_ВРЕМЯ_UTC+3/`. После загрузки на плату сравните
12 слов паспорта с `fpga.register_words` в manifest.

Установщик предназначен для FPGA-проектов с результатом `.bit`; CPLD с `.jed`
требует отдельного шаблона. [Подробности паспорта и прямая Tcl-сборка](README.md).