Назад

Castlevania: Symphony of the Night, работающая нативно на ESP32-S3

Портативная консоль на XIAO ESP32S3, запускающая Castlevania: Symphony of the Night в Алхимической лаборатории

В статье про Metal Gear Solid я показал портативную консоль, которую собрал вокруг XIAO ESP32S3 Sense. Castlevania: Symphony of the Night (SOTN) — вторая игра для PlayStation, которую она запускает, и та, что появилась первой: она работала на 60 fps на отладочной плате Waveshare ESP32-S3 ещё до того, как появилась сама консоль, а позже переехала на неё.

Это стало возможным по той же причине, что и Metal Gear Solid. Декомпиляция SOTN сообществом собирается как переносимый C, поэтому игру можно скомпилировать для ESP32-S3 вместо эмуляции.

Геймплей на портативной консоли: смотрите на YouTube.

Эта статья рассказывает о том, как устроен порт, как игра помещается в память SoC, как программный растеризатор достиг 60 fps, какие баги скрывало оригинальное железо, и о портативной консоли, которую я собрал вокруг Seeed XIAO ESP32S3 Sense.

Почему нативный порт возможен

Эмуляция PlayStation на ESP32-S3 недостижима. Эмулятор должен интерпретировать MIPS-процессор и GPU инструкция за инструкцией, а для этого нужно в несколько раз больше производительности, чем есть у SoC.

Портирование — другое дело. Проект декомпиляции SOTN восстановил игру в виде исходников на C, которые компилируются в исполняемый файл для ПК. Игровая логика — это обычный C, и единственное, что привязывает её к консоли, — это SDK от Sony: библиотечные вызовы, которые рисуют полигоны, загружают текстуры, читают контроллер и воспроизводят звуки. Сборка для ПК заменяет это SDK на psyz — реимплементацию поверх SDL.

Таким образом, задача состоит из трёх частей:

  1. Скомпилировать игру для Xtensa.
  2. Заменить ПК-бэкенд psyz на бэкенд для SoC.
  3. Уместить всё.

Целевая SoC — ESP32-S3:

Архитектура

Слои, от игры до железа:

  1. Игра: декомпилированный движок, код игрока и оружия, уровни
  2. psyz: реимплементация SDK с PSYZ_RENDERER=soft
  3. Платформенный слой (esp32/main): VSync, root counters, ввод, файлы FAT, звук, вывод на LCD
  4. Железо ESP32-S3: ядра LX7, SRAM, PSRAM, флеш, SPI LCD

Слои порта и два ядра: игра и растеризатор на ядре 0, вывод на LCD и звук на ядре 1, а панель и microSD делят SPI2 на портативной консоли

Два проектных решения определили всё остальное.

VRAM остаётся собственным буфером игры. У PlayStation 1 МБ видеопамяти, 1024×512 пикселей 16-битного цвета. Декомпиляция уже моделирует её как обычный массив. Растеризатор рисует прямо в неё (в PSRAM), и LCD питается из неё. Нет теневых копий и нет преобразований формата, кроме финального в RGB565 для панели.

Уровни линкуются статически. На ПК каждая область замка — это DLL, загружаемая по требованию. У ESP32-S3 нет динамического линкера, поэтому каждая область компилируется в прошивку, а небольшая таблица сопоставляет имя уровня с его функцией инициализации. Это решение дважды создало проблемы, как описано ниже в разделах «Баги, которые прощает PlayStation» и «Добавление уровня».

Как уместить игру для PlayStation в 512 КБ

Алукард рядом с одной из статуй лаборатории

Первая линковка не прошла из-за нехватки 3.34 МБ внутренней RAM. Большая часть этого не была виной игры:

У последнего есть ловушка: некоторые «только для чтения» данные записываются. SDK обновляет заголовки звуковых банков на месте при открытии банка. Объявленные const, они живут во флеш-памяти, а запись во флеш через кэш — это аппаратная ошибка («Dbus write to cache»). Работающий паттерн — держать const-оригинал во флеше, скопировать его в буфер в PSRAM при запуске и позволить игре писать в копию.

После 28 раундов линковки цифры были такими:

Программный растеризатор и достижение 60 fps

Пламя лаборатории: полупрозрачные эффекты, нарисованные программным растеризатором

SOTN — это 2D-игра, и набор её примитивов невелик: текстурированные и Gouraud-квады, спрайты 16×16 для тайловых слоёв, прямоугольники и линии. Здесь нет 3D и нет движка геометрических преобразований, что сделало программный растеризатор реалистичным.

Растеризатор бит-в-бит совпадает с эталонной сборкой на GPU. Я сравнивал контрольные суммы кадров между сборкой для ПК и платой после каждой оптимизации.

Большая часть времени кадра уходила на доступ к памяти. Каждый текстурированный пиксель читает тексель и запись палитры из PSRAM и записывает пиксель в PSRAM. Все оптимизации, которые имели значение, сокращают этот трафик:

ШагРезультат
Пошаговое вычисление рёбер треугольников: деления, затем 64-битные аккумуляторы, затем 32-битные 16.1664-битные были медленнее на 32-битном ядре; 16.16 пошло в релиз
Вывод перенесён на ядро 1, управляется через notifyИгра никогда не ждёт SPI
Кэш палитры во внутренней RAM, циклы растеризации в IRAMWarp Room на 31 fps
Быстрый путь для тайлового слоя: 4 текселя за чтение, пары пикселей как 32-битные записиС 10.4 мс до 6.1 мс на кадр
Вывод из буфера, который игра только что закончила рисоватьБез копирования, на один кадр меньше задержки
PSRAM и флеш с 80 до 120 МГцС 19.4 мс до 16.4 мс на кадр: 60 fps

Я также попробовал кэш строк текстуры в растеризаторе треугольников и откатил его. Он ничего не дал, потому что GCC уже вынес загрузки.

Изменение вывода из готового буфера требует пояснения. Очевидный источник для дисплея — текущая область отображения SDK, но она отстаёт на один кадр: на VSync она указывает на буфер, в который игра собирается рисовать. Вывод из неё означал, что DMA и растеризатор сражались за одну и ту же половину VRAM в течение всего кадра. Чтение начала области отображения из собственной структуры буфера игры заставляет их по построению работать с противоположными половинами.

Баги, которые PlayStation прощает

В PlayStation нет защиты памяти. Случайное чтение возвращает то, что там лежит, а случайная запись попадает в память, которую зачастую никто не проверяет. Сборка для ПК тоже в основном скрывает эти баги, потому что её статические данные велики и снисходительны. У ESP32-S3 есть MMU, жёсткие ограничения по памяти и соседи, которые имеют значение, поэтому портирование на неё оказалось очень хорошим способом найти скрытые баги.

Бой в лаборатории алхимии на портативной консоли

Как я их нашёл

Панический бэктрейс называет жертву, а не виновника. Инструментом, который сработал, был OpenOCD через встроенный USB-JTAG SoC, вместе с GDB:

  1. Сбросить и остановить SoC через OpenOCD.
  2. Установить точку останова на обработчике паники.
  3. Когда она сработает, декодировать реальный PC из панического фрейма.
  4. Всегда декодировать по тому самому ELF, который был прошит, потому что адреса смещаются при каждой пересборке.

Анимация палитры за пределами допустимого

Лаборатория алхимии запрашивает анимацию палитры (tileset & 0xFF) + 0x7FFF | 0x4000, что индексирует запись 2 в таблице палитр уровня. В таблице одна запись. Чтение за пределами допустимого попало на соседнюю таблицу спрайтовых банков, которая затем была зарегистрирована как дескриптор анимации палитры и записывалась каждый кадр.

Исправление отклоняет дескрипторы, размер которых превышает буфер палитры. То же неопределённое поведение существует и в оригинале; ПК поглощает его в большом BSS.

Два уровня, один HitDetection

При статически слинкованных уровнях 122 глобальных символа были определены более чем на одном уровне. Общие заголовки реализуют такие вещи, как коллизии и обновления сущностей, а на PlayStation всегда загружался только один уровень. Статические архивы позволяют линкеру молча разрешить каждое имя в одно определение. Лаборатория алхимии запускала HitDetection из Warp Room против своих собственных таблиц сущностей, и повреждение проявлялось на слой позже.

Исправление — это сгенерированный список всех символов, общих для двух уровней, переименованных для каждого уровня с помощью -D-определений.

Комнаты, которые мутируют свою собственную карту

Двери и разрушаемые стены пишут в тайловую карту комнаты. С сгенерированными картами во флеш-памяти первая же дверь обрушила игру. Исправление — это единая точка, где передний слой активной комнаты копируется в записываемый буфер в PSRAM.

Имя врага

Окно с именем врага внизу экрана, нарисованное тем же кодом BottomCornerText, который раньше переполнял стек

С реликвией Faerie Scroll игра выводит имя врага, по которому вы попали. BottomCornerText сканирует строку в поисках терминатора FF 00 от PlayStation. Строки на ПК — это обычные C-строки, поэтому сканирование вышло за конец и перезаписало 64-байтовый буфер стека. Симптом был «игра зависает, как только я касаюсь врага». Исправление ограничивает сканирование.

Гонка, которой не было на PlayStation

Аудио работает на втором ядре, и аудиопоток продвигал корневые счётчики. Эти счётчики запускают обработчик VSync игры, загрузки текстур и колбэки очереди GPU. На PlayStation это прерывания на том же CPU. Здесь они выполнялись параллельно с игрой на другом ядре.

Исправление накапливает тики счётчиков на ядре 1 и запускает обработчики в игровом потоке.

Ввод, который так и не пришёл

Сообщение было «я не могу прыгнуть». Сложились три бага:

Портативная консоль: запуск железа на XIAO ESP32S3 Sense

Готовая портативная консоль сверху: панель ILI9341, стик от дрона-гимбала, кнопки и XIAO на макетной плате

Задняя сторона портативной консоли: проводной монтаж на макетной плате и собственный слот SD панели (не используется). Снятый модуль камеры XIAO лежит рядом

Передняя сторона портативной консоли рядом с модулем камеры XIAO, который порт не использует и который был снят

Целью была портативная консоль. Это то же железо, на котором позже запустилась Metal Gear Solid: SOTN была первой игрой на нём. Компоненты:

У XIAO одиннадцать доступных пинов. Панели нужно пять (SCK, MOSI, MISO, CS, DC) плюс линия сброса, а стику — два пина ADC. Остаётся три на восемь кнопок.

Шесть кнопок делят один пин ADC через резисторную лестницу: подтягивающий резистор на 10k и, для каждой кнопки, резистор на землю (0 Ω, 2k2, 4k7, 10k, 22k, 47k). Каждая кнопка даёт разное напряжение. Ограничение в том, что две кнопки, нажатые вместе, читаются как нижняя. Паре, которую каждая игра удерживает вместе (атака и прыжок в SOTN), достаются два оставшихся выделенных пина.

Полная схема подключения, список компонентов и карта кнопок — в руководстве по железу в репозитории.

Схема подключения портативной консоли, нарисованная с использованием графики компонентов Velxio: XIAO ESP32S3 Sense, панель ILI9341, аналоговый стик, резисторная лестница на шесть кнопок и две прямые кнопки

Запуск железа — это отдельный список уроков. Прежде чем трогать игру, я написал отдельную проверочную прошивку, которая рисует цветные полосы и показывает на экране каждую кнопку и стик:

Портативная консоль: дисплей, ввод и краш, пойманный точкой останова по данным

Всё на SD-карте

8 МБ флеш-памяти не могут вместить приложение на 3 МБ рядом с 3,7 МБ игровых данных, поэтому на портативной консоли все данные берутся с microSD-карты. Эта карта делит шину SPI с панелью, что позже привело к отдельному крашу (см. «Общая шина SPI» ниже).

Две ловушки, специфичные для этой платы

GPIO43 — это одновременно пин data/command панели и UART0 TX. Код Waveshare устанавливал драйвер UART для своей последовательной консоли. Это молча возвращает пин обратно UART, и панель перестаёт различать команды и пиксели. В портативной консоли для консоли используется только нативный USB.

printf через нативный USB блокируется, когда никто не читает. С подключённым ПК вы этого никогда не заметите. Без него буфер передачи заполняется за несколько секунд, и игра останавливается внутри printf — на устройстве, которое предназначено для работы без подключения. Весь вывод, включая собственное логирование ESP-IDF, теперь идёт через обёртку, которая пишет с нулевым таймаутом и отбрасывает то, что никто не читает.

Мерцание, затем скользящие прямоугольники

Первая сборка мерцала. Я предположил, что тактовая частота SPI слишком низкая, и поднял её с 40 до 80 МГц. Это немного помогло, но инструментирование сканирования показало, что происходило на самом деле:

Таймлайн: игра рисует кадр каждые 16,7 мс в буферы A и B, пока панель принимает один кадр около 24 мс, поэтому игра перерисовывает буфер, который DMA всё ещё отправляет

Это была проблема когерентности буферов. Решением стал путь копирования, который порт Waveshare сохранил как страховку: скопировать готовый кадр, затем отправить копию. В моей первой версии было две ошибки:

Даже после обоих исправлений прямоугольники остались. Снижение тактовой частоты SPI обратно до 40 МГц заставило их исчезнуть: соединительные провода не выдерживали 80 МГц, а сдвиг на один байт смещает целую полосу из 8 строк. Тактовая частота SPI у S3 делит источник 80 МГц, поэтому возможны только 80 и 40 МГц, ничего между ними.

Когда провода стали узким местом, оставался вариант отправлять меньше данных. Каждая полоса из 8 строк получает отпечаток при преобразовании в RGB565, и полосы, идентичные тому, что панель уже показывает, пропускаются. Доля пропущенных кадров упала примерно с 40% до 6%. Это даёт примерно 55 fps на экране, когда камера неподвижна, при этом игровая логика работает на полной скорости.

Краш, пойманный аппаратной точкой останова по данным

Следующий отчёт был «Я нажал START, и устройство перезагрузилось». Ранее был ещё один: «появился текст, потом экран стал белым, потом устройство перезапустилось».

Паника происходила в ClearOTag, вызываемой из главного цикла с указателем таблицы упорядочивания 0x4b8. Главный цикл продвигается через g_CurrentBuffer = g_CurrentBuffer->next, поэтому, двигаясь назад, что-то записало 0x44 в ссылку next одного из двух буферов GPU.

У ESP32-S3 есть две аппаратные точки останова по данным. Я вооружил обе, по одной на поле next каждого буфера, через две секунды после загрузки, уже после единственной легитимной записи. Нажатие START остановило CPU на записи виновника:

Debug exception reason: Watchpoint 1 triggered
AddPrim ← MenuDrawImg ← MenuDrawChar ← MenuDrawStr ← MenuDrawStats ← MenuDraw

Меню паузы берёт следующий свободный спрайт через &g_CurrentBuffer->sprite[g_GpuUsage.sp] и никогда не проверяет границу. sprite[] — последнее поле буфера GPU, а второй буфер начинается сразу после него, начинаясь с его ссылки next. Отрисовка текста статистики вышла за 512 спрайтов, и AddPrim записал заголовок примитива поверх ссылки. Та же игра в других местах проверяет g_GpuUsage.sp < MAX_SPRT_COUNT, но меню этого не делало. Две строки это исправили.

Два буфера GPU расположены в памяти вплотную друг за другом; 513-й спрайт меню паузы попадает на ссылку next следующего буфера, что и поймала аппаратная точка останова по данным

Общая шина SPI

Сразу после этого появился другой краш при загрузке уровней: утверждение в драйвере SPI, running_cmd == 0. Карта начала команду, пока передача DMA панели всё ещё шла по шине. На плате Waveshare карта только стримила опциональную музыку; на портативной консоли она несёт всё.

Решение — мьютекс:

Инструментирование без самообмана

Два урока из этого отрезка:

Запуск каждой сборки без прошивки платы

После нескольких часов проб и ошибок прошивка платы после каждого изменения была самой медленной частью цикла: записать образ по USB, дождаться перезагрузки, переподключить последовательный порт, не сбросив плату снова, прочитать лог, повторить. Поэтому для запуска и проверки каждой сборки я использовал velxio-cli, клиент командной строки Velxio. Он принимает тот же .bin, который создал мой тулчейн, запускает его на симулированном ESP32-S3 в Velxio на фиксированное количество симулированного времени и возвращает последовательный вывод, так что я мог читать счётчики и тайминги, не трогая железо. Плата получала новый образ только тогда, когда сборка того стоила.

# velxio.toml, next to the build: board = "xiao-esp32-s3", firmware = the merged .bin
velxio-cli run --timeout 5000 --timeout-exit-code 0 --serial-log-file serial.log .

Установка и первый запуск занимают несколько минут: см. быстрый старт velxio-cli.

Добавление уровня: снова бюджет памяти

Выход из Alchemy Lab ведёт к Castle Entrance (NP3). Его добавление переполнило внутреннюю RAM на 160 КБ. Сжатая графика уровня, палитры, карты тайлов и таблицы спрайтов были объявлены как записываемые, поэтому при загрузке они копировались в RAM. Пометка их const переместила их во флеш-память. В апстрим-порте для ПК NP3 уже был добавлен, и тот коммит применился чисто.

Ещё два открытия:

Сгенерированные файлы создаются заново из диска каждого пользователя, поэтому изменения const живут в скрипте (esp32/const_stage_tables.py), а не в сгенерированных исходниках.

Советы для похожего порта

Статус и дальнейшие шаги

Ещё одна схватка в Алхимической лаборатории, на портативной консоли

Код доступен на GitHub по адресу davidmonterocrespo24/sotn-decomp (ветка esp32-port). Схема подключения и список деталей находятся в руководстве по аппаратному обеспечению. Вам нужна собственная копия игры; репозиторий не содержит игровых данных.

Спасибо участникам декомпиляции SOTN и Xeeynamo за psyz. Этот проект построен на их работе.


Поделиться:
David Montero

Автор

David Montero

Creator of Velxio, the open-source circuit and Arduino simulator.

GitHub velxio.dev

Похожие статьи


Предыдущая статья
Raspberry Pi 4 и 5 в браузере: базовый режим и режим Linux, шаг за шагом
Следующая статья
Metal Gear Solid, работающая нативно на ESP32-S3