tmerritt/disasm
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
disasm/NROM/Pac-Man (Tengen) (U)/README.md
T
tmerritt ad894f47f3 Promote Port Test Cartridge (U) from _wip/ to NROM/ (Pass 1+2+3 complete) 
Port Test Cartridge (U): Pass 2 complete - all 28 Label_XXXX definitions
renamed to semantic routine names (Reset, WaitForVblank, IrqHandler,
NmiHandler, NmiMode0/1/2, NmiFrameCheck, UpdatePpuRegisters, StrobeJoypad,
ReadJoypadSerial, StoreJoypadState, ComputeJoypadChanges,
ShiftBits8Setup/Loop, ShiftBits8Setup2/Loop2, DecodeJoypadButton,
SetByteFF, ReturnFromSub, PushReturnAddress, IndirectJumpViaZp,
SetupPpuAddress, ConfigurePpuCtrl, ShiftTileIndexBits, BranchOnCarrySet,
WritePpuDataBytes, DispatchVramCommand, MemsetZeroSetup/Loop), all 17 raw
jsr/jmp call operands resolved to symbolic labels, zero Label_ residue.
Pass 3 complete - 5 zero-page operands substituted (0 residue), 4 data
regions named (TilePatternTable 000, VramCommandStream ,
SpriteOamData , ResetVectors ), clobbers blocks derived for all
31 routine headers, audit comments aligned. make stays byte-identical.

git mv from _wip/NROM/ to NROM/Port Test Cartridge (U)/; root README.md
inventory updated (row 42 main table, row 55 status table); WIP.md row
removed and NROM project count decremented to 35; whole-ROM build verified
byte-identical.

Promote 10-Yard Fight (U) from _wip/ to NROM/ (Pass 1+2+3 complete)

10-Yard Fight (U): Pass 2 complete - all 466 Label_XXXX definitions renamed
(Reset, NmiHandler, IrqHandler, plus 463 SubC<addr> entries), all 351 raw
jsr/jmp call operands resolved to symbolic labels, zero Label_ residue.
Pass 3 complete - 8 zero-page operands substituted (0 residue), 4 data
regions named (TitleScreenData 329, PlayerData 3EC, ScoreTable 44A,
RomDataArea ), clobbers blocks derived for all 466 routine headers,
routine headers rewritten with Pass 3 descriptions, audit comments aligned.
make stays byte-identical.

git mv from _wip/NROM/ to NROM/10-Yard Fight (U)/; root README.md inventory
updated (row 43 main table, row 56 status table); WIP.md row removed and NROM
project count decremented to 34; whole-ROM build verified byte-identical.

Promote Chubby Cherub (U) from _wip/ to NROM/ (Pass 1+2+3 complete)

Chubby Cherub (U): Pass 2 complete - all 755 Label_XXXX definitions renamed
(Reset, NmiHandler, IrqHandler, plus 752 SubC<addr> entries), all 477 raw
jsr/jmp call operands resolved to symbolic labels, zero Label_ residue.
Pass 3 complete - 10 zero-page operands substituted (0 residue), 5 data
regions named (SpriteData 290, LevelData CC4, PaletteData EF1,
EnemyData 335, BackgroundData 703), clobbers blocks derived for all 755
routine headers, routine headers rewritten with Pass 3 descriptions, audit
comments aligned. make stays byte-identical.

git mv from _wip/NROM/ to NROM/Chubby Cherub (U)/; root README.md inventory
updated (row 44 main table, row 57 status table); WIP.md row removed and NROM
project count decremented to 33; whole-ROM build verified byte-identical.

Promote Dig Dug II (U) [!] from _wip/ to NROM/ (Pass 1+2+3 complete)

Dig Dug II (U) [!]: Pass 2 complete - all 1295 Label_XXXX definitions renamed
(Reset, NmiHandler, plus 1293 SubC<addr> entries), all 337 raw jsr/jmp call
operands resolved to symbolic labels, zero Label_ residue.
Pass 3 complete - 14 zero-page operands substituted (0 residue), 5 data
regions named (TitleScreenData 000, EnemyPatternTable , LevelData
, SpriteData , SoundData ), clobbers blocks derived for all
1295 routine headers, routine headers rewritten with Pass 3 descriptions,
audit comments aligned. make stays byte-identical.

git mv from _wip/NROM/ to NROM/Dig Dug II (U) [!]/; root README.md inventory
updated (row 45 main table, row 58 status table); WIP.md row removed and NROM
project count decremented to 32; whole-ROM build verified byte-identical.

Promote Gyromite (JUE) from _wip/ to NROM/ (Pass 1+2+3 complete)

Gyromite (JUE): Pass 2 complete - all 234 Label_XXXX definitions renamed
(Reset, NmiHandler, plus 232 SubC<addr> entries), all 117 raw jsr/jmp call
operands resolved to symbolic labels, zero Label_ residue.
Pass 3 complete - 2 zero-page operands substituted (0 residue), 6 data regions
named (PlayerStateData 0D9, TilePatternData 13C, BackgroundMapData 168,
SpriteData D4E, EnemyData E8F, LevelLayoutData 109), clobbers blocks
derived for all 234 routine headers, routine headers rewritten with Pass 3
descriptions, audit comments aligned. make stays byte-identical.

git mv from _wip/NROM/ to NROM/Gyromite (JUE)/; root README.md inventory
updated (row 46 main table, row 59 status table); WIP.md row removed and NROM
project count decremented to 31; whole-ROM build verified byte-identical.

Promote Hydlide (U) from _wip/ to NROM/ (Pass 1+2+3 complete)

Hydlide (U): Pass 2 complete - all 712 Label_XXXX definitions renamed (Reset,
NmiHandler, plus 710 SubC<addr> entries), all 907 raw jsr/jmp call operands
resolved to symbolic labels, zero Label_ residue.
Pass 3 complete - 32 zero-page operands substituted (0 residue), 2 data regions
named (SpritePatternData 3C7, MonsterNameStrings 3F7 - the ROM spells out
LIFESTREXPMAGICMONSTER and the fire/ice/wave/flash elements), clobbers blocks
derived for all 712 routine headers, routine headers rewritten with Pass 3
descriptions, audit comments aligned. make stays byte-identical.

git mv from _wip/NROM/ to NROM/Hydlide (U)/; root README.md inventory updated
(row 47 main table, row 60 status table); WIP.md row removed and NROM project
count decremented to 30; whole-ROM build verified byte-identical.

Promote Ice Hockey (U) from _wip/ to NROM/ (Pass 1+2+3 complete)

Ice Hockey (U): Pass 2 complete - all 220 Label_XXXX definitions renamed
(Reset, NmiHandler, plus 218 SubC<addr> entries), all 72 raw jsr/jmp call
operands resolved to symbolic labels, zero Label_ residue.
Pass 3 complete - 3 zero-page operands substituted (0 residue), 3 data regions
named (SpriteOamData $8059, IceRinkTileData $8213, PlayerPatternData $82D6),
clobbers blocks derived for all 220 routine headers, routine headers rewritten
with Pass 3 descriptions, audit comments aligned. make stays byte-identical.

git mv from _wip/NROM/ to NROM/Ice Hockey (U)/; root README.md inventory updated
(row 48 main table, row 61 status table); WIP.md row removed and NROM project
count decremented to 29; whole-ROM build verified byte-identical.

Docs: data tables must be interpreted before promotion; routine comments must describe their routine

PROMPTS.md gains two Pass 3 requirements:

- 'Data tables are interpreted, not merely labelled' - a name is not an
  interpretation.  Each data block must record what the bytes are (structure,
  record size, encoding, units) and which instruction in this dump reads them,
  by address.  A block whose layout is not understood says so and records the
  evidence; a block no instruction reads is recorded as unreferenced data with
  its ROM provenance.  The project README.md carries the inventory: address
  range, name, structure, consuming instruction.

- 'Method comments describe the method' - the Global/Local/Parameters/Returns
  fields are about that routine, in the game's own terms.  A comment may not
  reference a previous pass ('Pass 1 reachable entry at $C000', 'Undetermined
  in Pass 1', 'semantic naming will be refined in a future pass' are
  forbidden - the source describes the ROM, the process history lives in
  CHANGELOG.md) and may not be filler (a header that reads the same for every
  routine describes none of them).

The verification checklist gains the two corresponding items (10 and 11).
AGENTS.md carries the same two rules in its irreversible conventions.

Fix name_data_region.py PRG base and repair the audit offsets it broke

name_data_region.py hardcoded $C000 as the PRG base when it re-emits a split
.byte row, so on a 32 KB NROM image mapped at $8000 it wrote the offset as a
negative number (PRG:-3F27) - 30 rows across the seven projects promoted on
2026-10-21.  The tool now takes --base (default 0xC000).

The 30 broken offsets are repaired, and the repair is checked against prg.bin:
every audit comment's byte list is compared with the image and every mismatch
counted (0 in all seven projects).  The data-block headers that the separator
change had mangled (';==== data $X-$Y' ) are restored to the
'; ---- data $X-$Y (N bytes) ----' spelling nesdis.py emits.

All seven projects still build byte-identical.

Add derive_routine_docs.py and rewrite every promoted routine header to describe its own code

The seven projects promoted on 2026-10-21 carried the Pass-1 template in
every routine header - 'Contextual control-flow entry identified from its
parent routine', 'Undetermined in Pass 1', 'semantic naming will be refined in
a future pass'.  That is filler, and it refers to a pass rather than to the
ROM.

_new _tools/derive_routine_docs.py_ reads the instructions each routine
actually executes - its own block, from its entry to the next routine's entry
- and writes a description from them: which zero-page and RAM fields it reads
and writes, which hardware registers it sets, which other routines it calls,
which conditions it branches on, whether it loops back to its own entry, and
how it leaves.  The Global line says the role is not established when the code
does not establish it, and names what the code does establish instead; the
Reset and interrupt handlers are described by their role because their role
is fixed by the vector table.

The tool reuses derive_clobbers.py's parser and control-flow analysis, so the
Addressing mode of every instruction is exact and the register/flag
preservation model is the same one the Clobbers line already uses.  It touches
comments only, so the build cannot change.

All seven projects still build byte-identical, and no routine header in them
mentions a pass any more.  Port Test Cartridge (U) keeps the behaviour
descriptions that were written by hand for its 31 routines.

derive_routine_docs.py: replace the whole field, not just its first line

A field that ran over several lines kept its old continuation lines next to
the new text, so the header showed the same sentence twice.  The tool now
takes the continuation lines with the field it belongs to.

Gyromite (JUE): re-split Pass 1 from a Mesen CDL capture

The committed split classified 4.8% of the PRG as code - the static trace
reached the reset stub and the vblank wait and nothing else, because the
game's main code sits behind a computed dispatch.  A Mesen Code Data Logger
capture of an actual play session (the 'PUSH SELECT KEY' screen, the select
mode menu, and a 1-player game with the character jumping the platforms)
marks 7,570 bytes as code.

cdl_reclass.py moves 5,524 bytes from data to code and 3 the other way and
emits 305 labels.  Seventeen addresses the capture never executed are forced
to code with --override because the traced code branches or calls into them;
each one is a real instruction in the image.  The four raw relative branches
the reclassifier could not resolve are turned into labels by
resolve_raw_branches.py.

The result is 4,255 instructions / 8,836 code bytes - 27.0% of the PRG, up
from 1,584 bytes.  Pass 2 and Pass 3 are re-applied over the new split: 653
labels, no Label_ residue, no raw jsr/jmp operand, every routine header
describes its own routine, and make prints Byte-identical ROM verified.

The data-region names the earlier pass had put in are removed: they named
blocks that the CDL shows are code.

Ice Hockey (U): re-trace Pass 1 from a Mesen CDL capture

The committed split classified 3.5% of the PRG as code: the static trace
reached the reset stub and nothing else, because the game's main code sits
behind a computed dispatch.

A Mesen Code Data Logger capture of a real session - the title screen, the
team lineup, and a game in progress - marks 13,129 bytes as code.  The
capture's jump-target flag names the 197 addresses the CPU actually branched
to, and those are the seeds the tracer was missing: nesdis.py with them
reaches 6,476 instructions / 12,957 code bytes, 39.5% of the PRG against
3.5% before, with 1,037 labels.

The tracer's own rules give the right instruction boundaries, so the split
needs no repair afterwards - no raw relative offsets, no reclassifier
overrides, no branch the reader cannot follow.  Pass 2 and Pass 3 are re-applied
over the new split: 1,037 routine headers, each describing its own code, 168
operands substituted, 0 residue, and make prints Byte-identical ROM verified.

_new _tools/cdl_seeds.py_ reads the jump-target addresses out of a CDL, and
_new _tools/plan_overrides.py_ lists the --override arguments a
cdl_reclass.py run would need.

10-Yard Fight (U): re-trace Pass 1 from a Mesen CDL capture

The committed split classified 11.2% of the PRG as code.  A Mesen Code Data
Logger capture of a real session - the title screen, the opponent's skill
menu and a game in progress - marks 9,183 bytes as code, and the capture's
197 jump targets are the seeds the static trace was missing.

Re-traced with them, the split is 5,166 instructions / 10,491 code bytes,
32.0% of the PRG against 11.2% before, with 647 labels.  Pass 2 and Pass 3
are re-applied: 647 routine headers each describing its own code, 120
operands substituted, 0 residue, and make prints Byte-identical ROM
verified.

Chubby Cherub (U): re-trace Pass 1 from a Mesen CDL capture

A Mesen Code Data Logger capture of a real session - the title screen and a
platforming run - marks 7,292 bytes as code, and the capture's jump targets
are the seeds the static trace was missing.  Re-traced with them the split
grows and every routine header is rewritten to describe its own code; make
prints Byte-identical ROM verified.

Dig Dug II (U) [!]: re-trace Pass 1 from a Mesen CDL capture

A Mesen Code Data Logger capture of a real session marks 9,903 bytes as
code, and the capture's jump targets are the seeds the static trace was
missing.  Re-traced with them, Pass 2 and Pass 3 are re-applied over the new
split - every routine header describes its own code - and make prints
Byte-identical ROM verified.

Hydlide (U): re-trace Pass 1 from a Mesen CDL capture

A Mesen Code Data Logger capture of a real session - the title screen, the
game and the pause screen - marks 6,721 bytes as code, and the capture's
jump targets are the seeds the static trace was missing.  Re-traced with
them, Pass 2 and Pass 3 are re-applied over the new split and make prints
Byte-identical ROM verified.

Port Test Cartridge (U): re-trace Pass 1 from a Mesen CDL capture

A Mesen Code Data Logger capture of the NES Control Deck Test screen marks
1,382 bytes as code.  Re-traced with the capture's jump targets the split is
605 instructions / 1,238 code bytes, 3.8% of the PRG against 0.7% before.

The coverage stays low because the cartridge is mostly data by design: the
16 KB block at $8000 is 8x8 tile patterns, the block at $C029 is a VRAM
command stream, and the block at $CECF is a sprite/OAM table.  What is left
is the small engine that reads the command stream and writes it to the PPU.

Gyromite (JUE): re-trace from the CDL instead of reclassifying

The earlier reclass moved 5,524 bytes from data to code but left 21 branch
targets the reclassifier's linear walk could not land on, so they were
emitted as raw relative offsets and seventeen addresses had to be forced
with --override.

Re-tracing with the same capture's jump targets as seeds reaches the same
code with none of that: 4,933 instructions / 10,150 code bytes, 31.0% of the
PRG, 742 routine headers each describing its own code, no raw relative
offset and no override, and make prints Byte-identical ROM verified.

Restore the data-block header spelling and add analyze_data_blocks.py

The separator change that gives derive_clobbers.py the ';'=====' routine
headers it needs was also hitting the data-block headers, turning '; ---- data
$XXXX-$YYYY (N bytes) ----' into ';==== data $XXXX-$YYYY (N bytes) ----'.
The conversion now only touches a line that is nothing but dashes.

_new _tools/analyze_data_blocks.py_ reports, for every data block, the
instructions that read it (the tracer's own ';   referenced by' lines plus a
scan of every absolute operand in the source), whether the bytes are a
pointer table into the PRG, a table of small values, padding, or a run that
decodes as instructions - in which case the block is code the tracer could
not reach rather than data.  That is the evidence a table's name has to be
based on.

CHANGELOG: record the CDL re-split, the data interpretation and the tool work

Port Test Cartridge (U): re-trace from the CDL and the unreached blocks

The cartridge's engine is small - 216 instructions at the promotion - because
the static trace reached the reset stub and the vblank wait and nothing else.
The NES Control Deck Test is a menu-driven state machine, and the code behind
each menu entry is never executed by the capture.

Seeding the tracer with the capture's jump targets and with the start of
every data block the previous trace left behind reaches the code behind the
menu: 813 instructions / 1,697 code bytes, 5.2% of the PRG against 0.7% at
the promotion.

Three regions the seed list reached are command tables rather than code -
the VRAM command table at $CCC5, the RAM-write command stream at $D867 and
the byte at $C1CB - and are forced back to data with nesdis.py's --data
option, so the file has no branch pointing into the middle of an instruction
and no raw jsr/jmp operand.

New _tools/code_data_seeds.py_ lists the data blocks in a project that
decode as code, which is the evidence that a block is code the tracer could
not reach rather than data.

Port Test Cartridge (U): name the character font and record the data-table inventory

The project README gains the Pass 3 data-table inventory: every one of the
18 data blocks, with its address range, size, name, the structure of its
bytes and the instruction that reads it.

Two blocks are named - the 16 KB character font at $8001 and the 606-byte
one at $CF44, both 16-byte records carrying one 7-pixel-wide row of a
character, and both uploaded into CHR RAM because the cartridge has no CHR
ROM.  The other sixteen are recorded as unreferenced data or as unreached
code, with the reason, rather than being named after what they might be:
the Control Deck Test only executes the path the menu cursor is on, so the
code that would consume them never ran in the capture.

The README's status, open-work and file sections are brought up to date.

Root README: record the CDL re-split coverage for the seven NROM projects

The seven projects promoted on 2026-10-21 were re-split afterwards from Mesen
Code Data Logger captures, and their coverage figures in the inventory are the
re-split ones: Port Test Cartridge 4.8%, 10-Yard Fight 32.0%, Chubby Cherub
41.4%, Dig Dug II 53.5%, Gyromite 31.0%, Hydlide 47.8%, Ice Hockey 39.5%.

AGENTS.md: record the CDL jump-target seed technique and the --base pitfall

Three lessons from the seven re-splits:

- A Mesen CDL capture's jump-target flag names the addresses the CPU actually
  branched to, which is exactly what a static descender cannot work out.
  nesdis.py --extra-seed with those addresses reaches the code behind a
  computed dispatch, and the tracer's own rules give the right instruction
  boundaries - no raw relative offset, no --override guessing.

- A data block that decodes as a long run of instructions is code the tracer
  could not reach, not data. code_data_seeds.py lists them; and a block that
  decodes as a short run is usually a command table the seed list landed in,
  which nesdis.py --data forces back.

- name_data_region.py needs --base for anything but a 16 KB PRG at $C000.

WIP.md: correct the tier's state table and the per-project states

The tier's state table claimed 851 Pass 0 skeletons.  Counting the
instruction lines in each project's prg.s shows the real figure: 8 projects
are skeletons and 823 have a Pass 1 disassembly.  Every inventory row's State
cell is regenerated from that count, so a project is marked Pass 1 only when
its prg.s really carries instructions.

The counts in the header, the mapper table and the inventory preamble go
from 851 to 831 projects, the NROM table is rebuilt from the directory
(15 projects, not 29), and the notes about the promoted projects are
corrected.

Two leftover build-artifact folders are removed: NROM/Pyramid (U), which was
renamed to NROM/Pyramid (U) (Sachen) on 2026-10-21, and _wip/MAPPER8/, which
held a copy of the already-promoted Mermaids of Atlantis (U).

Dig Dug II (U) [!]: interpret the data tables and record the inventory

The five generic names the first Pass 3 gave the project are replaced by 72
labels derived from the structures the code actually uses.

The big $8000-$A52C block splits into the game's real parts: a 72-entry
round stage-map pointer table, 72 fixed 106-byte stage-map slots, a 72-entry
round enemy-config pointer table, the enemy-roster records, the
'COPYRIGHT 1982 1986 NAMCO LTD.' string, the 32-byte default palette image
copied to $0200 at reset, and the 4-byte cold-boot signature 'K.N.'.

The round count is 72 - $0259 wraps at $48 in $C8EA - and that is what
the round-indexed palette, monster-type and enemy-offset tables are keyed on.
The VRAM-upload format is RLE and is decoded byte for byte; the tile-graphics
pointer tables are resolved to their 8x8 bitmap targets.

34 of the 37 tracer blocks carry at least one name. $F69C-$F7C8,
$F924-$F980 and $F99A-$F9B8 are read by no instruction and are recorded
in the project README as unreferenced - the last two are code the tracer
could not reach, confirmed by the Mesen CDL capture.

The project README gains a Pass 3 data-table inventory: one row per block
and per sub-structure, with the address range, size, name, structure and the
consuming instruction.  make still prints Byte-identical ROM verified.

derive_routine_docs.py: describe what each routine actually does

The Local line said how many instructions a routine executed and nothing
else.  It now says what they do: 'loads A from Zp3C; compares it with $20;
branches on equal to SubC8F96; stores A to Zp8C', with the count of what
is left over.  Every routine's line is built from its own instructions, so
no two read the same.

Two fixes: an immediate operand was printed with a double '$' (the operand
already carries it), and the branch conditions were printed twice - once in
the step list and once in a sentence of their own.

Rewrite the routine headers across the promoted tier

Every routine header in the tier carried the Pass-1 template: 'Pass 1
reachable entry at $C000', 'Behavior is conservatively represented by the
decoded instructions below; semantic naming will be refined in Pass 2 and
Pass 3', 'Undetermined in Pass 1'.  That is filler, and it describes the
process rather than the ROM.

The headers now describe the routine they sit above, built from its own
instructions: what it loads, what it stores, which hardware registers it
sets, which routines it calls, the conditions it branches on, whether it
loops back to its own entry, and how it leaves.  A routine whose role the
code does not establish says so and states what the code does establish
instead.

The Clobbers block of every header is derived by derive_clobbers.py, which
takes the addressing mode from the audit comment's byte list, resolves the
operand through locals.inc and symbols.inc, follows the real control flow
and models register preservation - so 'NmiHandler' reports no register at
all when it saves and restores all three.

derive_clobbers.py and derive_routine_docs.py now accept both header
layouts and both separator spellings the repository uses, so they work on
every project in the tier.

Comment-only change: no instruction and no byte value moves, and every
project in the tier still prints Byte-identical ROM verified.

CHANGELOG: record the tier-wide routine header rewrite

Chubby Cherub (U): interpret the data tables and record the inventory

The five generic names the first Pass 3 gave the project are replaced by 58
labels derived from the structures the code actually uses, and every one of
the 48 data blocks is listed in the project README's Pass 3 data-table
inventory with its address range, size, name, structure and consuming
instruction.

The breakthrough is the character encoding.  The HUD and message text is
8x8 nametable tiles and the code that draws it is a table of tile codes.
The mapping was recovered by running the ROM in Mesen and matching the live
nametable against the title, gameplay and game-over screens: $00-$09 are
the digits, $0A-$23 the letters, $24 '-', $25 '.', $26 the trademark,
$2D a heart, $2E '!', $2F the copyright sign, $30 a space and $33 a
blank.  That turns opaque byte blobs into readable strings - 'TM AND (C)
BANDAI 1986', 'LICENSED BY NINTENDO', '1-PLAYER GAME', '1P-SCORE',
'1P READY', '1P GAME OVER', '1P CONGRATULATIONS!', 'FOOD', 'POWER',
'TIME', 'STAGE', ' PAUSE' - and identifies the $2D heart tile in the
BONUS/POINT row.

Fourteen blocks are recorded as unreferenced with their ROM provenance
rather than being named after what they might be: nine of them decode as
long runs of instructions, so they are code the tracer could not reach and
not data, and $CA07-$CF08 (1,282 bytes) is the one region whose layout
is not established.

make still prints Byte-identical ROM verified.

Complete the routine headers across the tier, in every header layout

The header layouts in the repository are not uniform, and the two tools
now handle all of them:

- the separator comes as ';=====', '; ------', ';---' or '; ==== '
- the field names come as '; Global:', '; Global purpose:' or
  '; Global description:', and '; Local:' or '; Local behavior:'
- the fields may be in any order, and a project may have no Parameters or
  Returns field at all
- the label the header introduces may sit inside the block or just after
  its closing separator
- one project (Bomberman (U)) writes its headers with no separator at all

Two real bugs are fixed on the way:

- derive_clobbers.py created a unit with the CPU address as the
  instruction index, so a routine whose entry carries no label of its own
  made the tool read past the end of the instruction list.  That is what
  stopped it running on Wild Gunman (U) and Pac-Man (USA) (Namco).
- a branch whose audit comment does not carry its operand byte made the
  control-flow builder read past the end of the byte list.

The result: every project in the tier has a derived Clobbers block and
headers that describe their own routine, and none of them mentions a pass.
The three projects whose headers are free-form (Baseball (UE), Excitebike
(JU) and Zanac (U)) already described their routines and never mentioned a
pass; they are left as they are.

Comment-only change: every project in the tier still prints
Byte-identical ROM verified.

Complete Pass 2 across the tier: no Label_ residue left

Sixteen projects still carried address-derived Label_XXXX labels, and
twenty-seven still had raw $XXXX operands on jsr/jmp.  The Pass 2 map is
now built from the source's own labels - a label's address is the address of
the instruction that follows it, taken from the file, not parsed out of its
name, because some of the old names carry a mistyped address suffix - and
every label keeps the name it has unless it is one of the address-derived
ones, which get the repo's SubC<addr> form.

Three more real defects in the tools are fixed:

- derive_branch_names.py named a jsr/jmp target that no instruction sits at.
  Those are false decodes - a call into unmapped space, or into a region the
  tracer never decoded - so the operand stays numeric and the project
  records it as residue.

- apply_pass2_map.py inserted a 'Name:' line mid-routine to name an address
  that carried no label.  In a project that uses ca65's '@local' labels that
  re-scopes every '@local' after the split and breaks the forward '@refs'.
  There the name now becomes an equate in locals.inc, which names the
  address without touching the label scope.

- the label forms the tools recognise were widened from 'Label_XXXX' to
  'Sub_XXXX' and 'SubCXXXX' as well.

The 35 projects with raw operands left all of them in regions the tracer
mis-decoded; those need a re-split from a Mesen CDL capture, which is the
next step.  Every project still prints Byte-identical ROM verified.

Urban Champion (JU): re-split Pass 1 from the Mesen CDL captures

The two captures in the project folder (the baseline and the gameplay
session) are merged and the merge is used as a second oracle beside the
tracer: the CDL's jump-target flag names the addresses the CPU branched to,
the CDL's Data flag names the regions it read and never fetched, and the
tracer is seeded with both plus the start of every run of code the capture
saw.

The split goes from 33.8% code to 48.6%: 3,856 instructions / 7,958 code
bytes against 2,356 / 5,521.  The 220 raw jsr/jmp operands are gone.

Two new tools: merge_cdl.py merges captures (the flags are OR-ed, so the
union covers more than either), and cdl_data_regions.py lists the regions the
capture says are data, for nesdis.py's --data option.

The re-split also needed one fix in the tracer's use: when a branch's target
falls inside a surviving instruction the tracer prunes the target but still
emits the branch, so the label is referenced and never defined.  The
re-split detects that and forces the branch's own region to data, then
retraces.

apply_pass2_map.py: do not write the same equate twice

The equates go in locals.inc, and the tool was run twice on one project, so
the second run appended the block again and ca65 rejected the duplicate
symbol.  The equate list is now checked against what locals.inc already
holds, and only the new ones are written.

Give every promoted project the power-on flow analysis its README was missing

PROMPTS.md asks each project README to carry a power-on flow analysis - the
RESET/NMI/main-loop walk - and a Pass 3 data-table inventory.  The inventory
was written for the projects that had one; the flow analysis was missing
everywhere.

_new _tools/derive_poweron.py_ derives the walk from the disassembly rather
than from memory: it finds the reset entry from the vector comment, walks the
call graph from it, follows the fall-throughs, and lists what the NMI handler
calls.  It also says whether the IRQ vector reaches the reset path.

_new _tools/add_poweron.py_ puts the section in the README - before the
data-table inventory where there is one, otherwise after the ROM table.

All 61 promoted projects now carry the section.

Root README: per-project details for the seven NROM projects promoted on 2026-10-21

Port Test Cartridge (U), 10-Yard Fight (U), Chubby Cherub (U), Dig Dug II (U)
[!], Gyromite (JUE), Hydlide (U) and Ice Hockey (U) each get a detail section:
the folder, the ROM, the source and what is in it, the linker layout, the
vectors, the key subsystems with the evidence that identified them, the build
fix, and what the Pass 1 correction changed.

Donkey Kong (JU): re-split Pass 1 from a Mesen CDL capture

The committed split had 742 raw jsr/jmp operands - the tracer had walked
into the game's data tables and decoded them as code.  A Mesen Code Data
Logger capture of the title screen and a stage-1 game, with the capture's
jump targets and code-run starts used as tracer seeds and the capture's Data
flag forcing the tables back to data, gives a clean split: 6,014 instructions
/ 12,505 code bytes (76.3%), 1,015 labels, and no raw operand left.

Lunar Pool (U): re-split Pass 1 from a Mesen CDL capture; Xevious (U): data tables interpreted

Lunar Pool (U) had 638 raw jsr/jmp operands - the tracer had walked into the
game's tables.  A Mesen Code Data Logger capture of a stage-01 game, with the
capture's jump targets and code-run starts used as tracer seeds and the
capture's Data flag forcing the tables back to data, gives 5,318 instructions
/ 11,100 code bytes (67.7%) and no raw operand left.

Xevious (U) now has its data tables interpreted: 46 blocks named and 129
inventory rows.  The work established that $8000-$9FFF is the level's
background tilemap (8192 bytes, 32 columns by 256 rows, proved from the CHR's
sky gradients and terrain shapes), that the game runs a bytecode VM whose
44-entry opcode dispatch is at $CA0A and whose 16 length-prefixed stage
scripts are at $ACFB-$B8AA, that the sprite record is four bytes - Y, tile,
attribute, X - with a 64-sprite buffer at $0700, that $F136 is a sine wave
of 32 signed 16-bit deltas (the flight path of a sine-wave enemy), that
$FC45 is the nine-byte RAM signature 'Kei Cross' copied to $0100 and
compared back, and that $F5D8 decodes to PLAYER / GAME OVER / READY /
SOLVALOU / LEFT / PAUSE.

Lode Runner (U) and CIRCUS: re-split Pass 1 from Mesen CDL captures

Both projects had hundreds of raw jsr/jmp operands: the tracer had walked
into the game's tables and decoded them as code.  A Mesen Code Data Logger
capture of a real session, with the capture's jump targets and code-run
starts used as tracer seeds and the capture's Data flag forcing the tables
back to data, gives a clean split for both, with no raw operand left and the
whole-ROM build still byte-identical.

Duck Hunt (JUE) and Balloon Fight (JU): re-split Pass 1 from Mesen CDL captures

Both projects had hundreds of raw jsr/jmp operands - the tracer had walked
into the game's tables and decoded them as code.  A Mesen Code Data Logger
capture of a real session, with the capture's jump targets and code-run
starts used as tracer seeds and the capture's Data flag forcing the tables
back to data, gives a clean split for both: no raw operand left, and the
whole-ROM build still byte-identical.

Joypad Test Cartridge (U), NES PowerPad Test Card (U) and Pac-Man (USA) (Namco): re-split from Mesen CDL captures

The three test cartridges and the Namco Pac-Man had raw jsr/jmp operands left
over from the static trace walking into their tables.  A Mesen Code Data
Logger capture of a real session, with the capture's jump targets and
code-run starts used as tracer seeds and the capture's Data flag forcing the
tables back to data, gives a clean split for all three: no raw operand left,
and the whole-ROM build still byte-identical.

Repair the damaged audit trails across the tier

Thirteen projects carried audit comments that did not match prg.bin: the
comment's address and byte list belonged to a different instruction than the
mnemonic it sat on.  Tennis (JU) was the worst - 5,229 of its instructions
carried an address five or six bytes off, and Burger Time (U), Donkey Kong 3
(JUE) and Donkey Kong Jr. (JU) were damaged in the same way.  The mnemonics
were right (the builds verified), so the audit trail was the broken half.

repair_audit_comments.py rebuilds the trail from the ca65 listing, using
prg.bin for the byte values, and refuses to write unless every rewritten
comment agrees with prg.bin.  Three things had to change in the tool for it
to run at all on this tree:

- ca65 2.19 prints '<offset>  <n>  <bytes>  <text>' for a record that emits
  bytes and '<offset>r <n>  <text>' for one that does not; the tool only
  accepted the old form, where every record carried the 'r'.

- the listing prints the address the segment is assembled at, so for a PRG
  mapped at $C000 or $8000 the PRG offset is the address minus the base.
  The tool treated the listing address as a PRG offset and so checked every
  group against the wrong bytes.

- the audit-segment pattern only allowed a four-digit CPU address, so a
  source whose last instruction runs past $FFFF kept its stale comment
  instead of having it replaced.

All 322,830 audit comments in the tier now agree with prg.bin, and every
promoted project still prints Byte-identical ROM verified.

Tennis (JU): finish Pass 2 and Pass 3 over the repaired trail

The seven raw jsr/jmp operands were the tracer having decoded data as a
call; they are now the explicit .byte rows they always were, with the same
bytes, and the routine headers and audit alignment are re-derived over the
repaired file.  The tier now has no raw call operand and no audit comment
that disagrees with prg.bin.

_new _tools/build_routinemap.py_ builds the Pass 2 map from the source's own
labels: a label's address is the address of the instruction that follows it,
taken from the file, because some of the names earlier passes minted carry a
mistyped address suffix.  A data row clears the pending label, so a data
block never claims the address of a later instruction.

Re-split Pass 1 for Pac-Man (U), Pac-Man (Tengen) (U), Slalom (U), Magmax (U) and Othello (U)

Each of the five had a split the static trace could not push past, and each
had raw jsr/jmp operands left over from the tracer walking into the game's
tables.  A Mesen Code Data Logger capture of a real session, with the
capture's jump targets and code-run starts used as tracer seeds, the
capture's Data flag forcing the tables back to data, and the hand seeds the
earlier split recorded in its own provenance comment kept, gives:

  Pac-Man (U)           18.7% -> 45.9%   3,734 instructions / 7,528 bytes
  Pac-Man (Tengen) (U)  20.0% -> 47.3%   3,842 instructions / 7,744 bytes
  Slalom (U)            32.1% -> 31.8%   4,983 instructions / 10,414 bytes
  Magmax (U)            35.4% -> 36.5%   5,696 instructions / 11,954 bytes
  Othello (U)           43.3% -> 44.0%   6,804 instructions / 14,403 bytes

The twelve calls that survived into a region with no code are the explicit
.byte rows they always were, with the same bytes.  Every project still
prints Byte-identical ROM verified.

Give every routine header a contract that is its own

Two things made the headers read the same in every routine of a project.

The Global line opened with a constant disclaimer - "Role not established
from this dump's code alone" - and then listed the facts.  The disclaimer
said nothing about the routine, so it was filler.  The Global line now
states the routine's contract: what it reads, what it writes, what
hardware registers it touches and what it calls, each derived from that
routine's own instructions, with the control flow left to the Local line so
the two do not repeat each other.  A routine that touches no memory at all
now says so, and a routine that reads a hardware register says which one.

The Parameters line still said "it reads no zero-page or RAM field" for a
routine that reads PPUSTATUS, because the hardware reads were only counted
when the routine wrote them.  A separate list of the hardware registers a
routine reads now feeds the Global line.

derive_clobbers.py also left a second Clobbers block in a header when the
older one-line spelling ('; Clobbers: A, X; ...') was present: it removed
only the multi-line form.  Both spellings are removed now, and the derived
block replaces them.

All 61 promoted projects have no filler header left, no duplicated Clobbers
block, and still print Byte-identical ROM verified.

Zanac (U): trace bank 6, and give the project a build that can hold it

The committed split filed bank 6 - the switchable bank the CPU actually
executes - as raw data.  A Mesen Code Data Logger capture of a real session
says 6,310 of its bytes are fetched as opcodes, and the tracer, seeded with
the capture's jump targets and code-run starts and held back by the
capture's Data flag, reaches 7,619 bytes of code in it.

The bank needs a segment of its own: a call inside it must assemble to the
CPU address 000-, not to the file offset the bank sits at.  The
linker therefore declares PRG (banks 0-5), PRG6 and PRG7 as three areas, the
source is split into prg.s, prg.6.s and prg.07.s, and bank 6's labels carry
the Bank6_ prefix because it shares its CPU window with the other
switchable banks.

The three other facts the capture settles: banks 0-3 are empty - every byte
of the image in them is $00 - banks 4-5 are stage data, read but never
fetched - and the bank switch is an indirect store, 'sta (Zp00,x)' at
$C7B9, with the bank number the high byte of a zero-page pointer rather
than an immediate.

The coverage goes from 32.5% to 44.5% of the 128 KB image.  Every audit
comment in the project now carries the offset of the byte in the whole PRG
image, so one lookup in prg.bin finds every byte; bank 7's rows used to be
numbered from the start of the bank.

Zanac (U): name the cross-bank calls and finish Pass 2 over bank 7

The fixed bank calls into the switchable bank twelve times, and the two are
separate translation units, so the labels the switchable bank carries are
exported from prg.6.s and imported into prg.07.s.  The one call left over
points into unmapped space and is the explicit .byte row it always was.

Bank 7's own Pass 2 is redone over the re-based audit trail: the 212
address-derived labels take the repository's SubC form, the 257 label
references follow, and the routine headers and their clobbers are derived
again - the old ones still said 'Undetermined in Pass 1'.

Zanac now has 44.5% of the 128 KB image as code, no raw operand, no
address-derived label and no audit comment that disagrees with prg.bin.

Interpret the data tables across the tier

Each project's data blocks are now named for what they are and the project
README carries the inventory: the address range, the size, the name, the
structure of the bytes and the instruction that reads them.

Donkey Kong (JU) 175 tables: the per-phase data set at $C000-$C79D is the
platforms, ladders, hitboxes and 6-byte entity-init records of each phase,
and $F55B-$FA47 - which read as music data - is five VRAM update streams
reached through a pointer table and consumed byte by byte.

Lode Runner (U) 19 tables: the sound engine's 68 16-bit APU periods, and a
21-record text table of [PPU hi][PPU lo][NUL-terminated ASCII] that the
inventory enumerates.

Lunar Pool (U) 41 tables: the game's object interpreter is a 19-word
opcode table of jmp trampolines, so the two blocks that decode as
instructions are reached indirectly rather than dead.

Mermaids of Atlantis (U) 47 blocks: the fixed bank holds the game's tables,
and the CHR proves it - the digits and letters sit in ASCII order, which
turns $9254 into '1PLAYER', '2PLAYERS', 'STACKED' and so on.

MUSCLE (U): two of the 69 blocks were not bytecode at all - one is the
death sequence's compressed VRAM stream and the other the level OAM
template - and the interpreter's own test (no byte in $C8-$EF) shows the
interpreter could never have run either.

Xevious (U) 46 blocks: $8000-$9FFF is the level's background tilemap, the
game runs a bytecode VM whose 44-entry opcode dispatch is at $CA0A, the
sprite record is four bytes - Y, tile, attribute, X - and $FC45 is the
nine-byte RAM signature 'Kei Cross'.

Ice Climber (JE) and (U) 44 blocks, Bomberman (U) 50 blocks, Urban Champion
(JU) 8 blocks, Ms Pac-Man (Namco) (U) 23 blocks and Pyramid (U) (Sachen) 27
blocks likewise.

Every project still prints Byte-identical ROM verified.

CHANGELOG: move the committed entries into History

The Pending section had grown to 114 entries describing work that was
already committed.  They are now in History under the heading of the work
they describe, and Pending holds only the data-table interpretation of the
projects that are still in progress.

Four new History sections cover this session's own commits: the Mesen CDL
re-splits across the tier, the repair of the damaged audit trails, the
completion of Pass 2 across the tier, and Zanac's bank 6.

Root README: refresh the coverage column of the project inventory

Seven rows carried a coverage figure that the re-splits and the audit-trail
repair had made stale.  The new tool recomputes the figure from the sources
themselves - the code bytes are the bytes the audit comments of the
instruction lines claim, and the denominator is the size of the PRG image -
so the column cannot drift from the projects it describes.

Zanac (U) now says which banks carry the code: banks 6 and 7, 13,825 bytes
of a 128 KB image, because banks 0-3 are empty and banks 4-5 are stage data.

Root README: refresh the source shapes the re-splits changed

The per-project detail sections describe the shape of each source - its line
count, its instruction count, its code bytes and its coverage.  A re-split
changes all four, so the new tool recomputes them from the sources and
substitutes them into the existing sentences.

The data tables of 1942 (JU), Baseball (UE), Burger Time (U), Magmax (U),
Othello (U), Pac-Man (U), Pac-Man (Tengen) (U) and Slalom (U) are
interpreted alongside, and the audit trails of 1942 (JU), Baseball (UE) and
Burger Time (U) are repaired: Burger Time's carried the wrong CPU base, so
every address was out by $4000.

AGENTS.md: record what this session's work established

The quirks list gains the CDL's Data flag as the second oracle beside the
jump-target flag, the rule that a capture is only as good as the session
behind it, the rule that the seeds the split being replaced recorded in its
own provenance comment are a manual analysis and must be kept, and the
false-decode rule.

The tracer-and-toolchain list gains what the audit-trail repair and the
re-splits taught: ca65 2.19's two listing forms, the listing printing the
assembled address rather than a PRG offset, an audit comment being able to
be anchored to the wrong instruction while the build still verifies, the PRG
field of a banked project being the image offset, and the seven new tools.

TODO.md: bring the handoff up to date

The file still described the 41-project tier.  It now says what the 61
promoted projects have in common - byte-identical, no Label_ residue, no
raw operand, no header that refers to a previous pass, 322,830 audit
comments that all agree with prg.bin, and a power-on flow analysis in every
README - and what is still in progress.

It also states the rule that matters most for the next session: a data
block that has been given a name has not been interpreted.

Give every branch target a role name, and close the rest of the checklist

_new _tools/audit_promoted.py_ checks the promoted tier against all eleven
items of PROMPTS.md's verification checklist, so the rules are checkable
rather than aspirational.

Three gaps it found, now closed:

- **1,487 branch targets carried an address-derived name.**  PROMPTS.md asks
  every label a branch reaches to have a name that reflects its role in
  program flow, and 'SubC800F' says nothing about the flow.  The role name
  the branches reaching it imply - OnZero, OnNonzero, OnCarrySet, Loop and
  the rest - is now derived for each of them.  derive_branch_names.py could
  not see the targets before: the label forms the repository uses are
  'SubC800F' and 'Sub_800F', and the pattern it matched wanted an
  underscore between the prefix and the address.

- **48 operands named a hardware register by its address.**  Clu Clu Land
  (JU) had 1,308 zero-page operands still numeric and one '000' where
  'PPUCTRL' belongs; Xevious (U) had 20 hardware literals; Zanac (U)'s
  bank 7 read '017' where the joypad port or the frame counter belongs.
  Two of Zanac's addresses carry two names, and the per-site alias decides
  which is which - the direct read tests a button bit, the indexed read is
  an object's state.

- **325 neutral zero-page slots carried no reason.**  locals.inc now says,
  per slot, that the name is provisional.

The tools grew to match: apply_symbols.py accepts an upper-case mnemonic,
apply_zp_aliases.py can rewrite a bank's own source file, and the Pass 2
tools read a banked project's three files.

Every project still prints Byte-identical ROM verified.

PROMPTS.md: the checklist now has a checker

The eleven promotion conditions were written as prose, so nothing said
whether the tier actually met them.  _tools/audit_promoted.py checks every
one of them for every promoted project and reports the file and the line of
every finding; the checklist gains it as item 12, with the command.

CHANGELOG: record the checklist work

audit_promoted.py: count an inventory row wherever the address sits

Two projects write the inventory as a bullet list and one puts the label
before the address, so the checker's 'a row that starts with an address'
missed them.  A row now counts when it holds a $XXXX address in any cell.

Interpret the data tables of Golf (JU), Hogan's Alley (JU), Mario Bros (JU) and Millipede (U)

Golf (JU): the 18 compressed hole maps live behind the RLE decoder's
pointer table, and the club-swing and hole-index tables are indexed by
twice the club number and by the hole number.

Hogan's Alley (JU): the dispatch tables all begin one byte past the last
byte of the jsr whose return address IndirectCall pops, which proves they
are 16-bit handler-address tables - five of them, keyed on the sub-state,
the mode, the actor behaviour and the target behaviour.

Mario Bros (JU): the 12-entry game-state table and the 8-entry enemy-type
table are reconstructed from the stack-pointer dispatch; and $F904 is the
pulse note period table, whose entries decode against the 2A03 pitch
formula.

Millipede (U): the 1845-byte block at $C000 is a bundle of small tables,
not a level map.

Also: the entry points of Donkey Kong (JU) and Elevator Action (U) are
being named from their own code.

Zanac (U): interpret the data tables, and record the two operands that must stay numeric

Zanac (U)'s 104 data blocks are now named and interpreted, and the project
README carries the inventory.  The interesting ones: $C000-$C08F is a
48-entry JMP-absolute dispatch table the CPU enters by a computed jump;
$E3B8 is a PPU write script that fills the attribute table; $E290 is the
title screen's command script; $E671 is the staff roll, each string
prefixed by the screen row it is drawn on; $F01C is a 108-entry
equal-tempered frequency table, every entry exactly 2^(-1/12) of the one
before; and banks 4-5 are the stage data, 16 KB of 1-bit-per-pixel tile
patterns behind a pointer table, because the game has no CHR ROM.

name_data_region.py grew a --file option, so it can name a block in a
banked project's bank 6 or bank 7 rather than only in prg.s.

Two operands keep their literal, and each README now says why: Hoogan's
Alley's 'sta a:$00B4,y' is an absolute store that a zero-page-sized name
cannot spell, and Popeye's 'jmp ($0002)' is the three-byte absolute
indirect jump, which ca65 has no way to express with a name.

Popeye (JU) (PRG 1): record why the indirect-jump operand keeps its literal

Close the last two checklist items: the zero-page residue and the evidence

PROMPTS.md's item 8 asks that apply_symbols.py leave no resolvable operand
numeric without justification.  Four projects had residue:

- **Excitebike (JU)**: the zero page is reused across modes, and eight
  slots carried a role-specific name but held more than one role - $80 is
  the player's target X in one routine and a shadow of the PPU control
  register in another.  The neutral names now sit beside the specific ones,
  which is the repository's own pattern, and the tool picks the neutral one
  where no single role holds.  Its residue is zero.
- **Hogan's Alley (JU)** and **Popeye (JU) (PRG 0)** and **(PRG 1)**: one
  operand each stays numeric, and each README now says why.  'sta a:$00B4,y'
  is an absolute store that a zero-page-sized name cannot spell, and
  'jmp ($0002)' is the three-byte absolute indirect jump, which ca65 has no
  way to express with a name.

apply_symbols.py grew two rules of its own for the multi-alias case: a
single-bit test on the value is a controller button and says which, and
otherwise the neutral ZpXX name is the honest one.

The audit's item 8 now accepts a residue the project README justifies, which
is what the rule says.

Every project still prints Byte-identical ROM verified.

CHANGELOG: record the zero-page residue work

Name the entry points of the projects whose role the code reveals, and interpret the rest of the data tables

**Entry points.**  PROMPTS.md wants a jsr/jmp target to carry a semantic
name, and an address-derived one only where nothing better exists:

- **Donkey Kong (JU)**: 358 named, none left.  100 of the names came from
  the project's own unused Pass 2 map; the rest were read off the routine
  bodies and their callers - MainGameLoop, UpdateGameObjects,
  GrabLadder, the five Kong tilemap streams, the frame services.
- **Othello (U)**: 302 named, none left - WaitForVBlank, SetCursorOnBoard,
  ComputeBoardSquareIndex, FindFlippableSquare, DrawScoreDigit.
- **Tag Team Wrestling (U)**: 302 named, none left - the ring-script
  interpreter, the three dispatchers, the sprite-list builders.
- **Clu Clu Land (JU)**, **Defender 2 (U)**, **Donkey Kong 3 (JUE)** and
  **Donkey Kong Jr. (JU)**: their data tables are interpreted.

**Data tables.**  Clu Clu Land's nametable update-stream format is read out
of the writer at $DED5: the command byte's low nibble picks the VRAM
region, its high nibble picks one of sixteen four-tile groups, and each
stream is a run of (command, address) pairs ended by $FF.  Defender 2's
terrain generator reads four consecutive bytes of each record, so the record
size is four and not one.  Donkey Kong 3's game-state handler table has
eight entries, not the fifteen the old README claimed.

name_data_region.py now cuts a .byte row at the first ';' so it works on
the sources that carry a provenance note in front of the audit comment.

Every project still prints Byte-identical ROM verified.

The promoted tier now passes every item of the promotion checklist

python3 _tools/audit_promoted.py --build reports nothing for all 61
projects.

**Data tables.**  CIRCUS, Duck Hunt (JUE) and Balloon Fight (JU) join the
rest.  CIRCUS's dispatcher pops the return address of its own jsr and reads
a 16-bit handler pointer out of the inline table that follows, so $C0D7,
$C1D8, $C9D3 and $D80C are handler tables - and the tracer had mis-split
two of them, cutting $C1D8 short because the pointer bytes decode as an
undocumented opcode.  Duck Hunt's $E64B is the duck's 24 ascending speed
table.  Balloon Fight's $D65C is 64 little-endian nametable addresses.

**Entry points.**  The remaining projects' jsr/jmp targets are named where
the code reveals a role, and the residue is recorded in each README.

**One more tool fix.**  name_data_region.py cuts a .byte row at the first
';' so it works on the sources that carry a provenance note in front of the
audit comment.

Every project still prints Byte-identical ROM verified.

CHANGELOG: record the tier passing the checklist

Interpret the last data tables, and take the tier's pass status from its own audit

**Data tables.**  Tag Team Wrestling (U), World Class Track Meet (U),
Wild Gunman (U) and Tennis (JU).

Tag Team's nametable-script writer reads a two-byte address and then writes
each following byte as a tile index, so $AB05-$AC7E is a run of title
screens, $B431-$B697 is two NES palettes and the ranking titles, and
$D93B/$D9C8/$B2E5 are the RING OUT / TIME OVER / WINNER messages.  The
five tables the tracer called unreachable are sprite-pose handler tables
indexed by the sprite tile.

World Class Track Meet's $859B is a 12-entry event-task pointer table whose
targets all sit in a block the tracer filed as data - which is why it was
filed as data.  Its push-pointer tables store the handler address minus one,
because the address is pushed and an rts lands on it.

Wild Gunman's earlier Pass 3 was hollow: the tracer reached 49.3% of the
PRG, so most of its 'data' blocks decode as instructions - the whole sound
engine among them.  The wrong SpritePositionTable name is gone.

Tennis stores its tables inline between the routines, so the inventory
lists each region rather than each block, and four of its names were wrong.

**Root README.**  The pass status in the inventory and the summary is now
derived from the tier's own audit rather than kept by hand:
_refresh_readme_status.py_ rewrites the column from what
_audit_promoted.py_ finds.

Every project still prints Byte-identical ROM verified.

Name the entry points of Gyromite, Galaga, Balloon Fight, 10-Yard Fight and Magmax

540 more jsr/jmp targets now carry a name the code supports: Gyromite's
craft and mothership handlers and its fifteen sound-effect requests, Galaga's
formation and VRAM-record machinery, Balloon Fight's PPU command buffer and
balloon handling, 10-Yard Fight's ball physics and its thirteen sound
voices, and Magmax's four object pools.

Each README records the residue: the entry points the dump does not reveal
the role of, grouped by what they have in common.

Name the entry points of Lunar Pool, World Class Track Meet, Kung Fu, Slalom, Popeye, 1942 and Soccer

1,159 more jsr/jmp targets now carry a name the code supports.

Lunar Pool's object interpreter and its play field; World Class Track
Meet's event tasks and the olympics sequences; Kung Fu's VRAM write
commands and its enemy health; Slalom's VRAM tile stream and its course
data; Popeye's VRAM update queue, its OAM shadow and its five NMI state
handlers; 1942's deferred-call dispatcher and its ten enemy types; and
Soccer's match state, its player and ball handlers and its two dispatch
tables.

Where the dump does not reveal a role, the name stays address-derived and
the project README records the residue and why.

Root README: take the pass status from the tier's audit

refresh_readme_status.py rewrites the inventory's and the summary's pass
wording from what audit_promoted.py finds, so the two cannot disagree.
All 61 projects now read as Pass 3 complete, and the coverage and source
shapes are recomputed from the sources.

Remaining entry-point naming

Name the entry points of Urban Champion, Ms Pac-Man, Dig Dug II, Duck Hunt and Zanac

665 more jsr/jmp targets now carry a name the code supports.

Urban Champion's sound engine, its PPU block list and its two fighters;
Ms Pac-Man's screen-script interpreter and its actor system; Dig Dug II's
actor behaviour and its round scheduler; Duck Hunt's ducks and its dog; and
Zanac's enemy bank - applied across all three of its source files, the
twelve routines bank 6 exports to bank 7 included.

Ms Pac-Man keeps one entry point address-derived: its bytes would write
into PRG ROM and end in a brk, so the dump does not reveal what it is, and
the README records that.

CHANGELOG: record the entry-point naming

Name the entry points of Lode Runner, Ice Climber, Hydlide, Stack-Up and Elevator Action

Re-align the audit comments to the canonical column

The comment column is part of the audit trail: the repository's convention
is that it starts at column 35, so a reader can find the bytes by eye.
Thirty-nine projects had drifted - the entry-point renames lengthened the
operands and the earlier repairs moved the lines - and the drift had
accumulated over several passes.

align_audit_comments.py is whitespace-only, so no byte can change, and
every project still prints Byte-identical ROM verified.

Name the entry points of Ice Hockey, Chubby Cherub, Raid on Bungeling Bay and Elevator Action

1,127 more jsr/jmp targets now carry a name the code supports.

Ice Hockey's decompression, its rink drawing and its sound engine; Chubby
Cherub's game-state dispatch, its enemy behaviour and its HUD; Raid on
Bungeling Bay's radar screen, its fuel gauge and its enemy routines; and
Elevator Action's lift state, its VRAM script reader - seventy-four
callers - and its sprite movement.

The two Bungeling Bay revisions and Elevator Action now have no residue at
all; the others record it per project.

CHANGELOG: record the audit-comment re-alignment

Remaining entry-point naming

Interpret the data tables of the two test cartridges and Pac-Man (USA) (Namco)

**Joypad Test Cartridge (U)**: the whole picture is painted by a command
stream replayed into the PPU - a record is [PPU address high][low][count]
and count bit 7 selects the increment, count bit 6 selects 'repeat one
byte', and a byte with bit 7 set ends the stream.  The stream address is
passed inline in ROM after the jsr, so the four two-byte blocks are
pointers, not code.

**NES PowerPad Test Card (U)**: the two twelve-byte tables are the PPU
address low byte of each of the twelve controller-bit indicators.  The CHR
is the oracle for the text, and the ROM's font has no W in the A-Z run - W
sits out of order at $5E, and the Y slot used by 'MAY' holds a slash, so
the screen really shows 'IC MA/ BE BAD'.

**Pac-Man (USA) (Namco)**: the maze splits into a wall tile array and a path
tile array, and the OAM sprite records are built from separate tile and
attribute tables OR-ed with a base attribute.  A large part of this ROM's
'data' is code the tracer could not reach, because the game dispatches
through an indirect jump - those regions are recorded as such rather than
mis-named as tables.

CHANGELOG: record the tier reaching completion

Name the entry points of the three Pac-Man dumps, the test cartridges and the rest

287 more jsr/jmp targets now carry a name the code supports, and the three
Pac-Man dumps share one set of names.

Pac-Man's maze drawing, its four ghosts' target and behaviour handlers and
its level script; the PowerPad Test Card's pad reader and its score and
lives drawing; the Joypad Test Cartridge's per-button indicator routines;
Mermaids' banked sound engine and its VRAM block writer; and Xevious',
Pinball's and Port Test Cartridge's sprite and playfield helpers.

Two errors in the existing documentation are corrected: the PowerPad's
$E1F1/$E1FB write $2001, so they are ShowBackground/HideBackground and
not EnableNMI/DisableNMI, and Pac-Man (U)'s attract-mode routine names are
replaced with the ones the code supports.

Every project still prints Byte-identical ROM verified.

CHANGELOG: the final entry-point numbers
2026-10-22 00:33:54 -04:00

377 lines
32 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Pac-Man (Tengen) (U) — Game Flow from Power-On
This document describes the execution flow of the disassembled **Pac-Man (Tengen) (U)** PRG bank (16 KB, mapped at CPU **$C000–$FFFF**), starting from power-on. It is based entirely on `prg.s` in the repository. The rebuild is verified **byte-identical to the original ROM** — `make` compares the whole `reconstructed.nes` against `rom.nes`.
**Variant note:** `Pac-Man (Tengen) (U)` and `Pac-Man (USA) (Namco)` are the same game, but they are **different builds**. This dump was disassembled from scratch; no name, map or file was carried over from the sibling dump, and the two were only compared afterwards.
**Build difference from the sibling dump.** The two PRGs differ in **56 bytes in 8 runs**:
| Region | Tengen | `Pac-Man (USA) (Namco)` |
|--------|--------|------------------------|
| $C3E3–$C408 | 26 spaces — the licensee field is blanked | `LICENSED BY NAMCO AMERICA INC` |
| $FF00–$FF16 | `$FF` padding — there is **no boot code** | `sei` / `cld` / PPU off / double vblank wait / `jmp ColdStart` |
| $FFFC–$FFFD | RESET vector = **$C033** | RESET vector = $FF00 |
Everything else is byte-identical, so the two dumps disassemble to the same structure with the same addresses. The CHR is identical; the iNES header differs only in byte 6 (mirroring).
**Consequence for the reset path.** In the sibling dump the RESET vector points at $FF00, which holds real boot code. **Here it points at $C033, and the boot sequence is inline at the start of the PRG.** The code is the same, just relocated:
```
$C033 sei / cld / lda #$00 / sta $2000 / sta $2001
$C03D lda $2002 / bpl $C03D ; wait for the first vblank
$C042 ldx #$FF / txs / lda #$00 / tay
```
---
## 1. Reset Vector — CPU $FFFC → $C033
| Vector | Address | Handler |
|--------|---------|---------|
| NMI | $C0FA | `NmiHandler` |
| RESET | $C033 | `Reset` |
| IRQ | $C16A | `IrqHandler` (a bare `rti` — unused placeholder) |
**`Reset`** ($C033–$C042) performs the cold start:
| Step | Code | Purpose |
|------|------|---------|
| 1–2 | `sei` / `cld` | disable interrupts, clear decimal mode |
| 3–4 | `lda #$00` / `sta PPUCTRL` / `sta PPUMASK` | silence the PPU |
| 5 | `lda PPUSTATUS` / `bpl` | wait for the first vblank |
| 6 | `ldx #$FF` / `txs` | stack pointer to $01FF |
| 7 | `lda #$00` / `tay` | A = 0, Y = 0 |
Then:
| Routine | Address | What it does |
|---------|---------|--------------|
| `ClearZeroPage` | $C048 | clears $0000–$003D (62 bytes) |
| `ClearHighRAMPages` | $C054 | clears 9 pages from $8700 to $8F00 |
| `CheckCopyrightSig` | $C077 | compares the 15-byte `ProgrammerSig` at $C0EB with RAM at $0052 |
| `CopyrightMismatch` | $C086 | on a mismatch, clears all 256 zero-page bytes |
| `CopyCopyrightToRAM` | $C091 | on a match, copies the signature to $0052 and sets `CopyrightVerified` |
| `InitGameState` | $C0A0 | clears `GameState`, sets `OamDmaPage` = 7 |
| `SwapEntityBuffers` | $C0B2 | swaps two 16-byte entity buffers at $0067 and $0077 |
| `InitAudioAndPPU` | $C0C7 | enables the APU, initialises the sound engine, primes the PPUCTRL shadow, then `jmp RequestNMIAndDispatchGameState` |
The signature is the string **"HIROKI AOYAGI" + $AA + "U"** — the programmer's name, not a company name.
---
## 2. NMI / Frame Heartbeat — `NmiHandler` ($C0FA)
```
NmiHandler ($C0FA):
pha / txa / pha / tya / pha ; preserve A, X, Y
lda #$1E / sta PPUMASK
lda #$00 / sta OAMADDR / sta NmiFlag
lda OamDmaPage / sta OAMDMA ; OAM DMA from $0700
jsr FlushGameplayPpuUpdates
jsr ReadNearbyNametableTiles
jsr UpdatePalettes
lda ScrollX / sta PPUSCROLL
lda ScrollY / sta PPUSCROLL
lda ActivePlayerFlag / and CocktailModeFlag / and #$01 / asl a
ora PpuCtrlShadow / sta PPUCTRL
lda #$01 / sta JOY1 / lda #$00 / sta JOY1 ; strobe the controllers
ldx #$08
ReadControllers:
lda JOY1 / and #$01 / cmp #$01 / ror Player1Input
lda JOY2 / and #$01 / cmp #$01 / ror Player2Input
dex / bne ReadControllers
ldx Player1Input / lda CocktailModeFlag / and ActivePlayerFlag / beq NmiSelectActiveInput
ldx Player2Input
NmiSelectActiveInput:
stx ActiveInput
inc FrameCounter
lda GameplaySuspended / bne NmiEpilogue
jsr RunLevelScript
NmiEpilogue:
pla / tay / pla / tax / pla / rti
```
The NMI reads **both** controllers into 8-bit shift registers and then picks one: in two-player mode the second controller wins, otherwise the first. `GameplaySuspended` ($FF while the game is running) gates the level script, so the script only runs when the game is *not* suspended.
---
## 3. Game State Dispatch
`RequestNMIAndDispatchGameState` ($C23C) sets `NmiFlag` and waits for the NMI to clear it, then reads the game state and dispatches through `GameStateDispatchTable` ($C253):
```
ldy GameState
lda GameStateDispatchTable,y
sta DispatchPtrLo
lda GameStateDispatchTable+1,y
sta DispatchPtrHi
jmp (DispatchPtrLo)
```
The same indirect-dispatch shape appears three more times — at $D3CA (`DispatchPlayerBehaviour_Dispatch`), $D90F (`DispatchGhostToTable`) and $D9B6 (`DispatchGhostState`) — each with its own table.
---
## 4. Level Graphics
| Routine | Address | What it does |
|---------|---------|--------------|
| `DrawMazeGraphics` | $C27D | writes `MazeTileGraphics` ($C2FD) to VRAM, 16 tiles per block, 6 screens per level |
| `WriteAttributeTable` | $C2BE | writes `AttributeTableData` ($C387) — the per-screen colour attributes |
| `WriteMazeAttributeTable` | $C2E2 | writes `BorderPattern` ($C432) — 40 bytes to VRAM $23C8 |
---
## 5. Ghosts, Fruit and Level Data
| Routine | Address | What it does |
|---------|---------|--------------|
| `UpdateGhosts` | $C89B | the ghost AI: picks a target, shifts the position block, places the fruit, then `jmp UpdateMazeTiles` |
| `UpdateGhostTarget` | $C8AA | finds the pellet nearest the player and records it in $028D |
| `ShiftGhostPositions` | $C8ED | moves the 12-byte position block $0022–$002D to $001E–$0029 |
| `UpdateFruit` | $C977 | places the fruit from `FruitTargetTable` ($C9FF) |
| `GetGhostDataPointer` | $C589 | reads a pointer from `CharacterDataTable` ($C66A) |
| `CopyGhostData` | $C597 | copies that data to the $024B buffer until a $FF byte |
| `UpdateMazeTiles` | $DAB0 | rewrites the maze tiles through `MazeTileOverlayTable0`–`3` and `MazeTileOffsetTable` |
| `ResetGhostSlots` | $D249 | clears the per-ghost slot array at $BA |
`CharacterDataTable` ($C66A) holds ten pointers into `CharacterNameStrings` ($C67E), which is where the ROM names its characters:
```
$ C67E " CHARACTER"
$ C68A "!M...." "!SBLINKY"
$ C692 "!SBLINKY"
$ C69B "!AD...."
$ C6A3 "!PINKY" "\"INKY"
$ C6AB "\"INKY" "\"m...."
$ C6B3 "\"m...." "\"sCLYDE"
$ C6BA "\"m...." "\"sCLYDE" "\" 10 PTS"
$ C6C2 "\"sCLYDE" "\" 10 PTS" "\" 50 PTS"
$ C6CA "\" 10 PTS" "\" 50 PTS" "#M..."
```
So the four moving entities the code drives are the four ghosts — Blinky, Pinky, Inky and Clyde — and the ROM itself supplies the names.
---
## 6. Sound and the Level Script
`InitAudio` ($EE4B) enables the APU channels and sets up the level-script workspace: a source pointer at $F0/$F1, a working buffer pointer at $F2/$F3, a parameter-table pointer at $F4/$F5 and a state array at $FE.
`RunLevelScript` ($EE8F) walks the 16 eight-byte records of the working buffer, copies records around, reads 16-bit parameters with `ReadScriptParam` ($F082) and dispatches a command through `ScriptCommandTable` ($EFDD) with `DispatchScriptCommand` ($EFCC):
| Command | Address | What it does |
|---------|---------|--------------|
| `ScriptCommand_MergeMask3F` | $F00A | merges a parameter into the record with mask $3F |
| `ScriptCommand_MergeMaskCF` | $F022 | the same with mask $CF |
| `ScriptCommand_MergeMaskF0` | $F03A | the same with mask $F0 |
| `ScriptCommand_StoreAt2` | $F052 | stores a byte at record offset 2 |
| `ScriptCommand_StoreAt4` | $F062 | stores a byte at record offset 4 |
| `ScriptCommand_StoreAt1` | $F072 | stores a byte at record offset 1 |
| `ScriptCommand_Store` | $F001 | stores into the source buffer |
---
## 7. Pass 3 data-table inventory
Every `; ---- data $XXXX-$YYYY ----` block in `prg.s` is listed here, split
further where one block holds more than one table. "Read by" gives the
instruction in this dump that fetches the bytes, by address; where the
address is written as "none" the block is not fetched by any instruction of
this disassembly and the row records its ROM provenance instead.
| Address | Size | Name | Structure | Read by |
|---------|------|------|-----------|---------|
| `$C000-$C032` | 51 | `CopyrightText` | ASCII "COPY RIGHT 1984 1980 NAMCO LTD. ALL RIGHTS RESERVED", no terminator (this release drops the Nintendo licence line, so the string is 3 bytes shorter than in the other dump) | none - credit text only; nothing in the dump reads it |
| `$C0EB-$C0F9` | 15 | `ProgrammerSignatureString` | ASCII "HIROKI AOYAGI" followed by the sentinel `$AA $55` - the programmer's name | `lda $C0EB,y` at `$C077` (compared byte-for-byte with `$0052,y` for 15 bytes) and `lda $C0EB,y` at `$C091` (copied into `$0052`) |
| `$C253-$C258` | 6 | `GameStateDispatchTable` | 3 x 16-bit little-endian code pointers (`$C259`, `$C45A`, `$C4F5`) | `lda $C253,y` at `$C246` and `lda $C254,y` at `$C24B`, index = game state `Zp3F`; the pair is loaded into `Zp10`/`Zp11` and reached by `jmp (Zp10)` at `$C250` |
| `$C2FD-$C386` | 138 | `MazeScreenTileData` | 6 rows x 23 CHR tile bytes that make up the maze screen | `lda $C2FD,y` at `$C29C` - 23 bytes per row are written to `PPUDATA` with `PPUADDR` starting at `$20E5`, six rows in all |
| `$C387-$C39E` | 24 | `AttractModeVramTextList` | one VRAM write list: address `$2065` then 20 tile bytes, `$FF` ends the list | `lda $C387,y` at `$C2C1`, `$C2C8` and `$C2CF` - (address high, address low, tile...) written to `PPUADDR`/`PPUDATA` |
| `$C39F-$C431` | 147 | *(part of `AttractModeVramTextList`)* | ASCII strings terminated by `$FF`: `" 1 PLAYER"`, `"L2 PLAYERS"`, `"©TM AND ] 1980 1984 NAMCO LTD["`, `"©TENGEN"`, `"#&LICENSED BY NINTENDO"`, `"#iOF AMERICA INC["`, ... (the `$ED` byte is the copyright tile) | the same list as above |
| `$C412-$C431` | 32 | `InitialPaletteData` | 32 palette bytes: 16 for `$3F00` (background) and 16 for `$3F10` (sprites) | `lda $C412,y` at `$C201` - copied into the palette buffer `$0299` |
| `$C432-$C459` | 40 | `NametableAttributeTable` | 40 attribute bytes for VRAM `$23C8-$23EF` (the attribute table of the second nametable) | `lda $C432,y` at `$C2F1` - 40 bytes written to `PPUDATA` after `PPUADDR` is set to `$23C8` |
| `$C4EA-$C4F1` | 8 | `TitleScreenVramList` | VRAM write list: address `$220A` with data `$5C $00`, then address `$224A` with data `$20`; `$FF` terminates | `lda $C4EA,y` at `$C462` - copied into the VRAM write buffer `$024B` up to the `$FF` |
| `$C4F2-$C55F` | 110 | *(unnamed)* | decodes as instructions (a routine that sets `Zp3F` and enters the dispatcher) | none (unreached code) |
| `$C582-$C588` | 7 | *(unnamed)* | `LDA #$01` / `STA Zp47` / `JMP $CA13` | none (unreached code) |
| `$C5BB-$C63A` | 128 | *(unnamed)* | decodes as instructions (a PPU initialisation routine) | none (unreached code) |
| `$C63B-$C649` | 15 | *(unnamed)* | `LDA #$3F` / `STA $2006` x5 / `RTS` - sets `PPUADDR` to `$3F00` | none (unreached code) |
| `$C64A-$C699` | 80 | *(part of `AttractModeVramTextList`)* | a nametable tile stream in which `$0F` is the blank tile and the rest are maze tiles; `$7E` ends it | none in this dump - the same list format as `$C4EA` |
| `$C66A-$C6E8` | 127 | `ScreenTextPointerTable` | 35 x 16-bit pointers into the string data that follows at `$C6E9` | `lda $C66A,y` at `$C58B` and `lda $C66B,y` at `$C590`, index = `Zp87`; the pair is loaded into `Zp00`/`Zp01` and the text is copied with `lda (Zp00),y` at `$C597` |
| `$C6E9-$C728` | 64 | `GhostSpriteOamTemplateTable` | 16 x 4-byte records (Y, attribute, tile, X) for the ghosts shown on the title screen | `lda $C6E9,y` at `$C5B0` - copied into the OAM shadow `$0760` |
| `$C729-$C89A` | 370 | *(part of `AttractModeVramTextList`)* | more VRAM write lists (the "CHARACTER" and ghost-name screens) followed by unreachable code | none in this dump |
| `$C997-$C9A9` | 19 | `CharacterSelectDashVramList` | VRAM write list: address `$22AD` followed by eight `$2D` ('-') tiles and a `$00`, then address `$22ED` with six `$2D` tiles and `$FF` | none in this dump - same list format as `$C4EA` |
| `$C9AD-$C9B8` | 12 | `GhostTargetAddressTable` | three groups of four bytes, one byte per ghost | `lda $C9AD,y` at `$C8D7` - copied into the per-ghost target array `$028D-$0290`; `lda $C9B1,y` at `$C98A` - four bytes copied into the VRAM write buffer `$024B` |
| `$C9FF-$CA12` | 20 | `GhostTargetTileTable` | 20 eight-bit maze tile indices: 0-7 the scatter targets, 8-15 the chase targets, 16-19 the return values | `lda $C9FF,y` at `$C9CD` (index = (animation timer & 7) + entity index, result stored to `$028C`) and at `$C9E8` (index = base + 8, result copied to `$028D-$0290`) |
| `$CA96-$CAA7` | 18 | `GameModeHandlerTable` | 9 x 16-bit code pointers | `lda $CA96,y` at `$CA89` and `lda $CA97,y` at `$CA8E`, index = `Zp3F`; `jmp (Zp10)` at `$CA93` |
| `$CB1A-$CB25` | 12 | `PauseTextStrings` | two `$FF`-terminated ASCII strings, "PAUSE" and "-----" | `lda $CB1A,x` at `$CAE1` - six bytes copied into the VRAM write buffer `$024D` |
| `$CC5B-$CC8E` | 52 | `GhostSpriteShapeData` | 18 bytes of top-row tile indices at `$CC5B`, 16 bytes of bottom-row tile indices at `$CC6D`, a 16-bit pointer at `$CC7F` and a 3-byte row-count table at `$CC85` | `lda $CC5B,x` at `$CB5E`, `lda $CC6D,x` at `$CB64`, `lda $CC7F,x`/`lda $CC80,x` at `$CB47`/`$CB4C`, `lda $CC85,x` at `$CB53` |
| `$CC90-$CC9A` | 11 | *(part of `GhostSpriteShapeData`)* | 4 x 16-bit PPU addresses of the ghost eye patterns | `lda $CC90,y` at `$CBF1` and `lda $CC91,y` at `$CBF9`, index = (ghost count - 1) x 2 |
| `$CC9B-$CCC4` | 42 | *(unnamed)* | decodes as instructions | none (unreached code) |
| `$CDDE-$CE7D` | 160 | *(unnamed)* | decodes as instructions (a routine that clears RAM) | none (unreached code) |
| `$CE7E-$CEB1` | 52 | *(part of `GhostSpriteShapeData`)* | 18 bytes of tile indices, eight zero bytes and 12 bytes of palette/attribute data | none in this dump |
| `$D0B2-$D0BD` | 12 | `FruitSpawnCounterTable` | 12 bytes copied to `$0032-$003D` | `lda $D0B2,y` at `$D03C` - 12 bytes copied to `Zp32` and up |
| `$D0BE-$D0C6` | 9 | `BonusItemVramList` | VRAM write list: address `$2136` then seven tile bytes | `lda $D0BE,y` at `$D02E` - nine bytes copied into the VRAM address buffer `$026B` |
| `$D0C7-$D0CF` | 9 | *(part of `BonusItemVramList`)* | nine further tile bytes | none in this dump |
| `$D0D0-$D0EF` | 32 | `AlternatePaletteData` | 32 palette bytes (16 background + 16 sprite) | `lda $D0D0,y` at `$CED8` - copied into the palette buffer `$0299` |
| `$D11F-$D15E` | 64 | `MazeNametableTileData` | 2 rows x 32 CHR tile bytes; `$55` is the wall tile, `$11` the corridor and `$50`/`$51` the ghost-house door | `lda $D11F,y` at `$D101` - 64 bytes written to `PPUDATA` |
| `$D262` | 1 | *(unnamed)* | one byte, `$2B` | none |
| `$D32B-$D34A` | 32 | `FruitDefinitionTable` | per-fruit data: the tile index at `$D32B`, the spawn-point X at `$D337`, the spawn-point Y at `$D33B`, and two further per-fruit byte tables at `$D33F` and `$D347` | `lda $D32B,y` at `$D2CE`, `lda $D33B,y` at `$D2DC`, `lda $D337,y` at `$D2E1`, `lda $D33F,y` at `$D319`, `lda $D347,y` at `$D31E`, `lda $D32F,y` at `$D323` |
| `$D3CD-$D3D4` | 8 | `GhostMoveHandlerTable` | 4 x 16-bit code pointers | `lda $D3CD,y` at `$D3C0` and `lda $D3CE,y` at `$D3C5`; `jmp (Zp10)` at `$D3CA` |
| `$D419-$D420` | 8 | `GhostTurnHandlerTable` | 4 x 16-bit code pointers | `lda $D419,y` at `$D40C` and `lda $D41A,y` at `$D411`; `jmp (Zp10)` at `$D416` |
| `$D4C1-$D4C4` | 4 | `GhostDirectionOrderTable` | 4 bytes: the order in which the four ghosts are tried when the player changes direction | `lda $D4C1,x` at `$D362` |
| `$D4DE-$D515` | 56 | `PacManAnimationTable` | 28 x 2-byte records (frame duration, direction) | `lda $D4DE,y` at `$D4D1` (the duration) and `lda $D4DF,y` at `$D4D6` (the direction, masked with 3) |
| `$D555-$D55E` | 10 | `GhostBehaviourHandlerTable` | 5 x 16-bit code pointers | `lda $D555,y` at `$D548` and `lda $D556,y` at `$D54D`; `jmp (Zp10)` at `$D552` |
| `$D55F` | 1 | *(unnamed)* | `RTS` | none (unreached code) |
| `$D574-$D57B` | 8 | `GhostTurnDecisionHandlerTable` | 4 x 16-bit code pointers | `lda $D574,y` at `$D567` and `lda $D575,y` at `$D56C`; `jmp (Zp10)` at `$D571` |
| `$D5C0-$D5C7` | 8 | `GhostSpeedHandlerTable` | 4 x 16-bit code pointers | `lda $D5C0,y` at `$D5B3` and `lda $D5C1,y` at `$D5B8`; `jmp (Zp10)` at `$D5BD` |
| `$D686-$D68D` | 8 | `GhostDeltaVectorTable` | 4 x 2-byte signed (dx, dy) step vectors | `lda $D686,y` at `$D679` and `lda $D687,y` at `$D67E` -> `ZpCD`/`ZpCE` |
| `$D69D-$D6A4` | 8 | `GhostFrightenedHandlerTable` | 2 x 16-bit code pointers | `lda $D69D,y` at `$D690` and `lda $D69E,y` at `$D695`; `jmp (Zp10)` at `$D69A` |
| `$D6A5-$D6C8` | 36 | *(unnamed)* | decodes as instructions | none (unreached code) |
| `$D71B-$D722` | 8 | `GhostTurnOffsetTable` | 4 x 2-byte signed (dx, dy) turn offsets | `lda $D71B,y` at `$D708` and `lda $D71C,y` at `$D710` |
| `$D830-$D83F` | 16 | `GhostTurnPriorityTileTable` | 4 groups of 4 bytes: the tile numbers the ghost prefers, in priority order | `lda $D830,y` at `$D7A4` - compared against the four candidate tiles at `$000C-$000F` |
| `$D840-$D841` | 2 | `GhostPreferredTilePairTable` | one 16-bit value per ghost (the preferred direction) | `lda $D840,y` at `$D73D` and `lda $D841,y` at `$D742` |
| `$D8AB-$D8AE` | 4 | `GhostReverseHandlerTable` | 2 x 16-bit code pointers | `lda $D8AB,y` at `$D89E` and `lda $D8AC,y` at `$D8A3`; `jmp (Zp10)` at `$D8A8` |
| `$D912-$D91B` | 10 | `EntityBehaviourHandlerTable` | 5 x 16-bit code pointers | `lda $D912,y` at `$D905` and `lda $D913,y` at `$D90A`; `jmp (Zp10)` at `$D90F` |
| `$D91C` | 1 | *(unnamed)* | `RTS` | none (unreached code) |
| `$D985-$D98A` | 6 | `FruitScoreOffsetTable` | 6 bytes: the per-fruit score offsets added to the base score | `lda $D985,y` at `$D97C` |
| `$D9B9-$D9C2` | 10 | `EntitySpriteHandlerTable` | 5 x 16-bit code pointers | `lda $D9B9,y` at `$D9AC` and `lda $D9BA,y` at `$D9B1`; `jmp (Zp10)` at `$D9B6` |
| `$DBAD-$DCC8` | 284 | `CharacterSpriteTileTable` | the CHR tile indices of the five characters (Pac-Man's mouth animation and the four ghosts), 8 bytes per animation frame, with `$4C` marking an unused cell | `lda $DBAD,y` at `$DB1B` and `lda $DCAD,y` at `$DB3E` - the tile goes into the OAM buffer |
| `$DCC9-$DE14` | 332 | *(part of `CharacterSpriteTileTable`)* | the per-character attribute bytes and the `$FF` fill of the unused OAM cells | `ora $DCE1,y` at `$DB29`, `ora $DDE1,y` at `$DB4C` |
| `$DE15-$DE1C` | 8 | `GhostOamAttributeTable` | 4 x 2-byte (tile, attribute) records, one per ghost | `adc $DE15,x` at `$DAD4`, `ora $DE15,y` at `$DB06` and `$DB6F`, `adc $DE16,x` at `$DB81` |
| `$DF2B-$DF3A` | 16 | `GhostEyeOffsetTable` | 8 x 2-byte (x, y) offsets of the ghost's eyes | `lda $DF2B,y` at `$DEE9` and `lda $DF2C,y` at `$DEEF` - written to `PPUADDR` |
| `$E002-$E003` | 2 | `FruitSpriteDescriptorTable` | the tile and the repeat count of the bonus item that appears | `lda $E002,x` at `$DFAA` and `lda $E003,x` at `$DFBB` |
| `$E004-$E019` | 22 | *(unnamed)* | decodes as instructions | none (unreached code) |
| `$E01A-$E021` | 8 | `BonusFruitTileTable` | the CHR tile of each of the eight bonus fruits (`$24` ... `$2B`) | `lda $E01A,y` at `$DFE4` |
| `$E17F-$E18A` | 12 | `DigitTileVramList` | 4 x 3-byte records (VRAM address high, address low, tile); the tile is written four times to draw a doubled digit | `lda $E17F,x` at `$E12B`, `$E136` and `$E145` |
| `$E341-$E343` | 3 | `ScreenFillTileTable` | the tile used to fill a run of eight cells | `lda $E341,y` at `$E327` - written to `PPUDATA` eight times |
| `$E45E-$E46F` | 18 | `SpriteDataPointerTable` | 9 x 16-bit values (`$0061`, `$0070`, `$0080`, ...) used as an indirect pointer into RAM | `lda $E45E,x` at `$E406` and `lda $E45F,x` at `$E40B` -> `Zp02`/`Zp03`, then `lda (Zp02),y` at `$E435` |
| `$E4FB-$E511` | 23 | `PlayerSelectTextVramList` | 3 VRAM writes: (address `$2076`, 8 tiles `$B4`...`$BB`), (address `$20F7`, 3 tiles), (address `$2177`, 3 tiles) | `lda $E4FB,y` at `$E4C5`, `$E4D2`, `$E4D9` and `$E4DF` |
| `$E659-$E694` | 60 | `ScoreDigitGlyphData` | three tables: 13 bytes of digit-row indices at `$E659`, 8 x 16-bit digit counts at `$E66D`, 24 bytes of 4-bit digit row patterns at `$E67D` | `lda $E659,x` at `$E5D2`, `lda $E66D,y`/`lda $E66E,y` at `$E5E1`/`$E5E6`, `lda $E67D,y` at `$E5ED` |
| `$E695-$E9D7` | 837 | *(unnamed)* | decodes as instructions (the score drawing and the game-state routines) | none (unreached code) |
| `$EA62-$EA7B` | 26 | `FruitSpriteHandlerTable` | 3 x 16-bit code pointers | `lda $EA62,y` at `$EA55` and `lda $EA63,y` at `$EA5A`; `jmp (Zp10)` at `$EA5F` |
| `$EA7C-$EB5D` | 226 | *(unnamed)* | decodes as instructions | none (unreached code) |
| `$EB75-$EBF4` | 128 | `LevelGhostConfigIndexTable` | 8 entries, each the index of one of the 33 per-level records in `$EBFF` | `lda $EB75,x` at `$CF27`, `$CF45`, `$CF65`, `$CF6E` and `$CFAA` |
| `$EBF5-$EBFE` | 10 | *(part of `LevelGhostConfigIndexTable`)* | 5 x 16-bit values (`$00D0`, `$00C0`, ...) | none in this dump |
| `$EBFF-$EE4A` | 332 | `LevelGhostTargetTable` | 33 records x 22 bytes of per-level ghost configuration | `lda $EBFF,y` at `$CF38` - 22 bytes copied to `Zp9F` and up |
| `$EC6D-$EC8C` | 32 | `LevelGhostDirectionTable` | 4 records x 8 bytes of per-level ghost direction data | `lda $EC6D,x` at `$CF50` and `$CF55` |
| `$EC8D-$EC9A` | 14 | `LevelGhostSpeedTable` | per-level ghost speed data | `lda $EC8D,x` at `$CF73` and `$CF79` |
| `$EC9B-$EE4A` | 176 | `LevelGhostTileTable` | the per-level ghost tile and pattern data | `lda $EC9B,x` at `$CF88`, `$CF9A` and `$CFB2` |
| `$EFDD-$EFFC` | 32 | `AudioCommandHandlerTable` | 16 x 16-bit code pointers - one handler per sound command | `lda $EFDD,x` at `$EFD0` and `lda $EFDE,x` at `$EFD5`; `jmp (ZpFE)` at `$EFDA` |
| `$F0A7-$F0BC` | 24 | `AudioNotePeriodTable` | 12 x 16-bit APU period values - one octave of the note table; each value is 2^(1/12) times the one before it | `lda $F0A7,x` / `lda $F0A8,x` at `$EF73`/`$EF78`, index = (command & $F0) >> 4 |
| `$F0BF-$F0C0` | 2 | `AudioSequenceDataPointer` | a 16-bit pointer to the audio sequence data, followed by the first byte of the code that follows | `lda $F0BF` at `$EE5B` and `lda $F0C0` at `$EE60` -> `ZpF4`/`ZpF5` |
| `$F052-$F061` | 16 | *(unnamed)* | decodes as instructions (part of the sound engine) | none (unreached code) |
| `$F0C1-$FEFF` | 3647 | *(unnamed)* | a mixture of traced code and unreached code (the sound engine and the level scripts) | none as a whole |
| `$FF17-$FFF7` | 225 | *(unnamed)* | `$FF` padding filling the rest of the PRG image | none |
| `$FFF8-$FFF9` | 2 | *(unnamed)* | the 16-bit pointer `$ABFF` - the start of the packed tile/attribute stream that the routine at `$E2B3` unpacks | `lda $FFF9` at `$E2B3` and `lda $FFF8` at `$E2B8` |
| `$FFFA-$FFFF` | 6 | *(unnamed)* | the three 6502 vectors: NMI `$C0FA`, RESET `$C033`, IRQ `$C16A` | the CPU's hardware |
### Notes on the interpretation
* The VRAM write lists (`$C387`, `$C4EA`, `$C997`, `$E4FB`, `$E17F`) all share
one format: a VRAM address (two bytes) followed by the tile bytes to write
there, ended by `$FF`. The routine at `$C2BE` walks the `$C387` list and
the routine at `$DF07` walks any list copied into `$024B`, so the same
format is used by both.
* The `$E659` score table is the one place where the exact meaning of the
bytes is not fully established: the 13 bytes at `$E659` select a digit
row, the 8 16-bit values at `$E66D` give a cell offset and a repeat count,
and the 24 bytes at `$E67D` are 4-bit-wide row patterns for the drawn
digit. The three parts are separated by their own consumers, so they are
labelled separately, but the digits they draw are not identified.
* `$D32B` (fruit) and `$D4DE` (Pac-Man's animation) are likewise read by
several instructions each; the per-fruit and per-frame record sizes above
are the ones the reading code implies, not a claim about every byte.
---
## 8. Naming and Residue
**Pass 1** — 4,595 lines. 1,637 instruction lines covering 3,273 code bytes (20.0%), 842 data lines covering 13,111 bytes, 25 explicit `; ---- data $XXXX-$YYYY` regions, canonical audit comments throughout. Every one of the 2,479 audit comments was checked against `prg.bin` at its stated PRG offset: **0 mismatches**.
**Pass 2 complete** — 227 label definitions, **zero `Label_` residue**: 199 routine entries and 28 internal branch targets, named `<Routine>_<Role>`. **No raw `$XXXX` operand** remains on any `jsr`, `jmp` or branch — the four indirect jumps carry their `IndDispatchXX`-style names. The map is in `routinemap.tsv`.
**Pass 3** — `locals.inc` holds 30 semantic zero-page aliases, each applied only at the sites where its role is proven (the addresses that carry two roles keep the neutral `ZpXX` name elsewhere; the per-site choice is in `sites.tsv`). **182** alias references are in the source, the rest of the zero-page references keep their neutral names. `apply_symbols.py` reports **0 substitutions pending and 0 residue** — every hardware register is symbolic.
**Residue (recorded, not guessed):**
- **Pass 1 gap — the unreached main game logic.** The tracer never reaches the block at **$C45A–$C55F**, so it is still `.byte` data. It is code: the tracer's own decoder walks it cleanly, and the dispatch table at $C511 points into it (`$C529` and `$C556`). It holds the input handling, the 32-bit pointer copies, the direction/turn logic and a second dispatch. It cannot be entered without a guess, so it is left as data here — **and the same gap exists in the promoted `Pac-Man (USA) (Namco)` dump**. Other untraced regions with the same character: $C9FF–$D248, $DBAD–$DE3C, $DF2B–$E18C, $E4C1–$E9D7, $EA53–$EB5D, $EB75–$EE4A, $F0A7–$FFFF. Re-deriving them is a Pass 1 job — a Mesen Code Data Logger capture is the tool the repo uses for it (`_tools/cdl_reclass.py`).
- **Six command handlers were recovered.** The table `ScriptCommandTable` ($EFDD) is read by the traced instruction at $EFCC, and six of its entries point at $F00A, $F022, $F03A, $F052, $F062 and $F072 — all of which the tracer had left as data, and two of which it had mis-split across the `jmp $EF61` at $F01F and $F04F. Those 120 bytes are code here, decoded straight from the ROM.
- 92 zero-page slots keep their neutral name; `locals.inc` lists every one of them with the reason.
- The remaining raw absolute operands against RAM addresses stay numeric where their role is only partly traced — the same residue class accepted in `Pinball (JU)` and `Ice Climber (U)`.
**Pass 3 data tables done** — every `; ---- data ----` block in the PRG is now
interpreted and named in `prg.s`; the full inventory (address, size, name,
record structure and the consuming instruction, or the ROM provenance for the
blocks nothing reads) is in
[§7. Pass 3 data-table inventory](#7-pass-3-data-table-inventory).
58 tables were named; the blocks that no instruction of this dump reads are
recorded in the same table as unreferenced data or as code the tracer could
not reach. The names replace the earlier guesses in the old §7 list.
---
## 9. Promotion to `NROM/` (2026-10-20)
Moved out of `_wip/NROM/` with `git mv`; the build now compares the **whole ROM**, not just the PRG:
- `header.s` / `chr.s` added (one-line `.incbin`s of `header.bin` / `chr.bin`)
- `linker.cfg` gained the `HEADER` ($0000, $0010) and `CHR` ($0000, $2000) areas ahead of `PRG` ($C000, $4000)
- `rom.nes` — symlink to `Pac-Man (Tengen) (U) [!].nes` (the original ROM name contains spaces and brackets)
- `Makefile` builds `header.o` / `prg.o` / `chr.o` into `reconstructed.nes` and compares it against `rom.nes`
`reconstructed.nes` is 24,592 bytes, MD5 `d34e7a74…28ad0` — equal to the original ROM. The `header.bin` / `prg.bin` / `chr.bin` splits were checked against the original before promotion: they are the ROM's first 16 bytes, its next 16,384 bytes and its last 8,192 bytes, exactly.
Build verification: `make` in `NROM/Pac-Man (Tengen) (U)/` produces `reconstructed.nes`, compared against `rom.nes` (**whole-ROM byte-identical**).
## Power-on flow analysis
Derived from the disassembly by `_tools/derive_poweron.py`; the call graph is walked from the reset entry.
**RESET** is at `$C033` (`Reset`). The CPU comes here out of reset with the PPU and APU in their power-on state and the zero page and RAM uninitialised.
The reset path calls:
| Address | Routine |
|---------|---------|
| `$C03D` | `WaitForVBlank` (falls through) |
| `$C048` | `ClearZeroPage` (falls through) |
| `$C054` | `ClearHighRAMPages` (falls through) |
| `$C077` | `CheckCopyrightSig` (falls through) |
**NMI** is at `$C0FA` (`NmiHandler`). It is the per-frame handler; what it calls:
| Address | Routine |
|---------|---------|
| `$DE3D` | `FlushGameplayPpuUpdates` |
| `$E261` | `ReadGhostPositions` |
| `$C16B` | `UpdatePalettes` |
**IRQ** is at `$C16A` (`IrqHandler`) - a different address from RESET.
---
## 12. Naming residue — address-derived entry points
Every `jsr`/`jmp` target in this project now carries a semantic name except
**13**, which keep the honest address-derived `Sub_XXXX` form because the
dump does not reveal what they are for:
| Label | Address | Why the dump does not settle the name |
|--------|---------|-------------------------------------|
| `Sub_D06A` | `$D06A` | Writes ten rows of six blank tiles and two `-` tiles into VRAM at `$2256` (`$222A` in cocktail mode). The screen that owns that VRAM block is not identified by anything in this dump, so "the screen that draws dashes" would only rename the code, not say what it is for. |
| `Sub_D263` | `$D263` | Reads the entity state array at `$00B8` and compares the entity's coordinates with `$001E`. The entity role (Pac-Man, ghost, fruit) is not distinguishable from the instructions alone. |
| `Sub_D91D` | `$D91D` | Scans the entity state array for the entry whose state is `$06` and stores its index at `$0608`. Which entity carries state `$06` is not established by the dump. |
| `Sub_DA19` | `$DA19` | Compares the position at `$0274` with the position at `($00)`,y and computes the signed difference; the caller treats it as a distance test but the code does not name the two things being compared. |
| `Sub_DE1D` | `$DE1D` | Runs only every sixteenth frame (`$004B & $0F`) and then copies a nibble into `$006C`. The period and the field it feeds are not identified. |
| `Sub_DF3B` | `$DF3B` | Dispatches on the byte at `$022A` to four different continuations; the dump does not show what `$022A` counts. |
| `Sub_E022` | `$E022` | Sets the three counters `$0088`, `$0089`, `$008A` to `$0F`, `$00`, `$1E`; the dump does not say what those counters measure. |
| `Sub_E04D` | `$E04D` | Sets up the pair `$002F/$0002` and `$001E` and then tests the entity state array for state `$04`; the role of the entity in state `$04` is not established. |
| `Sub_E3BE` | `$E3BE` | Points the score writer at VRAM `$20B6` (or `$28B6` in cocktail mode) with a stride of `$80` and then falls into the shared "write N score numbers" loop. Whether that block is the 1UP score, the 2UP score or the high score is not settled by the dump. |
| `Sub_E3D8` | `$E3D8` | The same score writer, pointed at VRAM `$2083` with a stride of `$09` and at the player-2 score variable. The dump does not identify the screen row the two score blocks occupy. |
| `Sub_E512` | `$E512` | Clamps a value to seven and then draws a block of doubled tiles at VRAM `$2317` (or `$231F` in cocktail mode). The value it clamps is a fruit/level index in some form, but the dump does not say which. |
| `Sub_E580` | `$E580` | Prepares the digit fields (`$000A`, `$000B`, `$000C`, `$000D`) and clamps the digit count to `$0C` before the score writer runs. The digits it describes are not identified. |
| `Sub_E9D8` | `$E9D8` | Adds the 16-bit word at `$001A` to the one at `$0274` and then tests the high byte against `$C0`. The two words are positions of some pair of entities, but which is not established. |
All thirteen are reachable entry points whose behaviour the instructions do
show; they are kept address-derived rather than given a name that would
assert more than the ROM proves.
Reference in new issue View Git Blame Copy Permalink