264. Прерывание NMI в CPU

Реализовать механику прерывания NMI со стороны CPU.

Урок 264 из 356 · tests/chapter_04_ppu_timing_and_vblank/test_264_cpu_interrupt_nmi.py

Справочные материалы

https://www.nesdev.org/wiki/CPU_interrupts
https://www.nesdev.org/wiki/PPU_registers#Vblank_NMI

Файлы для обновления

emulator/cpu/cpu.py

Зачем нужен этот шаг

PPU уже умеет вырабатывать сигнал nmi_requested. Прежде чем подключать этот сигнал к CPU через координатор системы/консоли, CPU должен знать, как самостоятельно выполнить последовательность NMI.

Что такое NMI? NMI означает Non-Maskable Interrupt (немаскируемое прерывание). На NES PPU может запросить NMI при VBlank, чтобы игровой код мог выполнить свой обработчик вертикального гашения.

Интуитивная модель

NMI похож на аппаратный аварийный переход. CPU приостанавливает текущий путь выполнения, сохраняет достаточно состояния, чтобы вернуться позже, и переходит по адресу, хранящемуся в векторе NMI.

Механистическая модель

Когда NMI принимается, CPU выполняет следующую последовательность

1. Push PC high byte
2. Push PC low byte
3. Push status with:
       ONE_FLAG set
       B_FLAG clear
4. Set INTERRUPT_FLAG in CPU status
5. Read low byte from $FFFA
6. Read high byte from $FFFB
7. Set PC = high << 8 | low

Важное различие

NMI не выполняет запись в $FFFA/$FFFB. CPU читает эти адреса. В настоящем ROM байты вектора уже существуют в PRG ROM. В этих тестах FakeROM позволяет подготовить эти байты как часть настройки теста.

Пример реализации

NMI_VECTOR_LOW = 0xFFFA
NMI_VECTOR_HIGH = 0xFFFB

class CPU:
    ...

    def interrupt_nmi(self) -> None:
        # Save the current PC so RTI can restore it later.
        pc_high = (self.pc >> 8) & 0xFF
        pc_low = self.pc & 0xFF
        self.push_stack(pc_high)
        self.push_stack(pc_low)

        # Hardware interrupts push status with B clear and bit 5 set.
        status_to_push = self.p | ONE_FLAG
        status_to_push &= ~B_FLAG
        self.push_stack(status_to_push)

        # After accepting an interrupt, set the interrupt-disable flag.
        self.p |= INTERRUPT_FLAG

        # NMI vector bytes are read from PRG space. NMI does not write them.
        low = self.bus.read(NMI_VECTOR_LOW)
        high = self.bus.read(NMI_VECTOR_HIGH)
        self.pc = low | (high << 8)

Конкретный пример выполнения

FakeROM setup:
    $FFFA = $00
    $FFFB = $C0

CPU before NMI:
    PC = $8123
    S  = $FD

CPU.interrupt_nmi()

CPU after NMI:
    stack contains return PC/status
    PC = $C000

Пример стека при S = $FD и PC = $8123:

write $81 to $01FD, S becomes $FC
write $23 to $01FC, S becomes $FB
write status to $01FB, S becomes $FA

Распространённое заблуждение

Флаг B не устанавливается при аппаратных прерываниях. BRK/PHP заносит регистр состояния с установленным флагом B, а NMI заносит регистр состояния со сброшенным B. Бит 5, ONE_FLAG, в заносимом байте состояния всё равно установлен.

Выходит за рамки

вызов CPU.interrupt_nmi() со стороны PPU
сброс ppu.nmi_requested
точная задержка и число тактов прерывания
прерывания IRQ/APU/маппера
поведение RTI, которое тестировалось ранее в главе о CPU

Запустить этот урок

uv run pytest tests/chapter_04_ppu_timing_and_vblank/test_264_cpu_interrupt_nmi.py -v

Пример реализации

NMI_VECTOR_LOW = 0xFFFA
NMI_VECTOR_HIGH = 0xFFFB

class CPU:
    ...

    def interrupt_nmi(self) -> None:
        # Save the current PC so RTI can restore it later.
        pc_high = (self.pc >> 8) & 0xFF
        pc_low = self.pc & 0xFF
        self.push_stack(pc_high)
        self.push_stack(pc_low)

        # Hardware interrupts push status with B clear and bit 5 set.
        status_to_push = self.p | ONE_FLAG
        status_to_push &= ~B_FLAG
        self.push_stack(status_to_push)

        # After accepting an interrupt, set the interrupt-disable flag.
        self.p |= INTERRUPT_FLAG

        # NMI vector bytes are read from PRG space. NMI does not write them.
        low = self.bus.read(NMI_VECTOR_LOW)
        high = self.bus.read(NMI_VECTOR_HIGH)
        self.pc = low | (high << 8)

Конкретный пример выполнения

FakeROM setup:
    $FFFA = $00
    $FFFB = $C0

CPU before NMI:
    PC = $8123
    S  = $FD

CPU.interrupt_nmi()

CPU after NMI:
    stack contains return PC/status
    PC = $C000

Показать код тестаtest_264_cpu_interrupt_nmi.py

from emulator.cpu import cpu as cpu_module
from emulator.cpu.flags_handler import (
    B_FLAG,
    CARRY_FLAG,
    DECIMAL_FLAG,
    INTERRUPT_FLAG,
    NEGATIVE_FLAG,
    ONE_FLAG,
    ZERO_FLAG,
)
from tests.helpers import make_cpu_with_rom


def write_nmi_vector(rom, addr: int) -> None:
    """
    Install the NMI vector in FakeROM.

    CPU address $FFFA maps to FakeROM offset $7FFA because CpuBus maps
    $8000-$FFFF to program_rom offsets $0000-$7FFF.
    """
    rom.write(0x7FFA, addr & 0xFF)
    rom.write(0x7FFB, (addr >> 8) & 0xFF)


def test_cpu_declares_nmi_vector_constants():
    """
    Objective:
    Name the NMI vector addresses used by CPU.interrupt_nmi().
    """
    assert cpu_module.NMI_VECTOR_LOW == 0xFFFA
    assert cpu_module.NMI_VECTOR_HIGH == 0xFFFB


def test_interrupt_nmi_loads_pc_from_nmi_vector():
    """
    Objective:
    CPU.interrupt_nmi() reads $FFFA/$FFFB and jumps to that address.

    Example:
        $FFFA = $00
        $FFFB = $C0
        PC becomes $C000
    """
    cpu, _bus, rom = make_cpu_with_rom()
    write_nmi_vector(rom, 0xC000)
    cpu.pc = 0x8123
    cpu.s = 0xFD

    cpu.interrupt_nmi()

    assert cpu.pc == 0xC000


def test_interrupt_nmi_pushes_current_pc_high_then_low_to_stack():
    """
    Objective:
    NMI saves the current PC on the stack before jumping to the vector target.

    With PC=$8123 and S=$FD:
        $01FD receives $81
        $01FC receives $23
    """
    cpu, bus, rom = make_cpu_with_rom()
    write_nmi_vector(rom, 0xC000)
    cpu.pc = 0x8123
    cpu.s = 0xFD

    cpu.interrupt_nmi()

    assert bus.read(0x01FD) == 0x81
    assert bus.read(0x01FC) == 0x23


def test_interrupt_nmi_pushes_status_with_one_set_and_break_clear():
    """
    Objective:
    Hardware interrupts push a status byte with ONE_FLAG set and B_FLAG clear.

    This differs from BRK/PHP, which push B_FLAG set.
    """
    cpu, bus, rom = make_cpu_with_rom()
    write_nmi_vector(rom, 0xC000)
    cpu.pc = 0x8123
    cpu.s = 0xFD

    cpu.p = CARRY_FLAG | ZERO_FLAG | DECIMAL_FLAG | B_FLAG | NEGATIVE_FLAG

    cpu.interrupt_nmi()

    pushed_status = bus.read(0x01FB)

    assert pushed_status & CARRY_FLAG
    assert pushed_status & ZERO_FLAG
    assert pushed_status & DECIMAL_FLAG
    assert pushed_status & NEGATIVE_FLAG
    assert pushed_status & ONE_FLAG
    assert not (pushed_status & B_FLAG)


def test_interrupt_nmi_sets_interrupt_disable_flag_in_cpu_status():
    """
    Objective:
    After accepting NMI, the CPU sets the interrupt-disable flag in its live status
    register.
    """
    cpu, _bus, rom = make_cpu_with_rom()
    write_nmi_vector(rom, 0xC000)
    cpu.pc = 0x8123
    cpu.s = 0xFD
    cpu.p = 0x00

    cpu.interrupt_nmi()

    assert cpu.p & INTERRUPT_FLAG


def test_interrupt_nmi_consumes_three_stack_bytes():
    """
    Objective:
    NMI pushes PC high, PC low, and status. That consumes exactly three stack
    bytes.

    Example:
        S starts at $FD
        after three pushes, S is $FA
    """
    cpu, _bus, rom = make_cpu_with_rom()
    write_nmi_vector(rom, 0xC000)
    cpu.pc = 0x8123
    cpu.s = 0xFD

    cpu.interrupt_nmi()

    assert cpu.s == 0xFA


def test_interrupt_nmi_full_stack_layout_example():
    """
    Objective:
    Validate the complete NMI stack layout in one readable example.

    Given:
        PC = $ABCD
        S  = $80
        P  = ZERO_FLAG | B_FLAG

    Expected pushes:
        $0180 = $AB
        $017F = $CD
        $017E = status with ZERO_FLAG set, ONE_FLAG set, B_FLAG clear
    """
    cpu, bus, rom = make_cpu_with_rom()
    write_nmi_vector(rom, 0x9000)
    cpu.pc = 0xABCD
    cpu.s = 0x80
    cpu.p = ZERO_FLAG | B_FLAG

    cpu.interrupt_nmi()

    assert bus.read(0x0180) == 0xAB
    assert bus.read(0x017F) == 0xCD

    pushed_status = bus.read(0x017E)
    assert pushed_status & ZERO_FLAG
    assert pushed_status & ONE_FLAG
    assert not (pushed_status & B_FLAG)

    assert cpu.s == 0x7D
    assert cpu.pc == 0x9000
    assert cpu.p & INTERRUPT_FLAG

Тестовые функции (7)

test_cpu_declares_nmi_vector_constants
test_interrupt_nmi_loads_pc_from_nmi_vector
test_interrupt_nmi_pushes_current_pc_high_then_low_to_stack
test_interrupt_nmi_pushes_status_with_one_set_and_break_clear
test_interrupt_nmi_sets_interrupt_disable_flag_in_cpu_status
test_interrupt_nmi_consumes_three_stack_bytes
test_interrupt_nmi_full_stack_layout_example