badline 0.11.1 → 0.12.1

data/lib/badline/c128.rb

@@ -4,11 +4,15 @@ require "badline/c128/model"
 require "badline/c128/mmu"
 require "badline/c128/vdc"
 require "badline/c128/mmu_pages"
+require "badline/c128/io_pages"
+require "badline/c128/z80_pages"
 require "badline/c128/color_lines"
 require "badline/c128/banks"
 require "badline/c128/bus_state"
 require "badline/c128/bus"
 require "badline/c128/cpu"
+require "badline/c128/z80"
+require "badline/c128/z80_turns"
 require "badline/c128/saved_state"
 require "badline/c128/keys"
 require "badline/c128/modes"
@@ -21,11 +25,12 @@ module Badline
   # the VDC and its 80 column display, and 128K of RAM, which the 8722 MMU
   # maps (C128::Bus).
   #
-  # Built for C128 mode, it runs BASIC 7.0 and the C128 KERNAL from reset.
-  # The C128's Z80 runs first and hands the bus to the 8502, but here the
-  # 8502 starts at its reset vector, with the MMU as the Z80 leaves it.
-  # The KERNAL goes to C64 mode as on the C128, with C= held at reset, a
-  # C64 cartridge or GO64.
+  # Built for C128 mode, it powers on as the C128 does: the Z80 runs the
+  # boot code in its BIOS and hands the bus to the 8502, which then runs
+  # its reset vector into BASIC 7.0 and the C128 KERNAL. The KERNAL goes
+  # to C64 mode as on the C128, with C= held at reset, a C64 cartridge or
+  # GO64. MCR bit 0 hands the bus back and forth from then on, and the
+  # Z80 runs 2 T-states in each cycle the VIC leaves it the bus.
   #
   # Built for C64 mode, the default, it powers on in C64 mode, the state
   # the C128 KERNAL reaches when C= is held at power-on, and a reset comes
@@ -39,12 +44,15 @@ module Badline
   class C128
     include IntegerHelper
     include KeyboardBuffer
+    include Machine::Clocking
+    include Computer::Common
     include Computer::Attachments
     include Computer::KernalTraps
     include Keys
     include Modes
     include Drives
     include FastSerial
+    include Z80Turns
 
     # The C64's 8x8 matrix and the three rows K0-K2 select, in port B
     # column order.
@@ -65,10 +73,6 @@ module Badline
 
     attr_reader :cpu, :cycles, :drive1541, :model, :init_threshold
 
-    # The path of the disk or directory device 8 serves through the traps
-    # (Computer::Attachments), or an empty one.
-    def mounted_path = @drive.nil? ? "" : @drive.path
-
     def family = :c128
 
     def address_bus = @bus
@@ -116,6 +120,7 @@ module Badline
       @holding_commodore = false
       @bus = Bus.new(@model, sid_model: sid_model || @model.sid_model, mode:)
       @cpu = CPU.new(@bus, debug:)
+      build_z80
       @vic = @bus.vic
       @vic.open_bus = -> { @bus.ram.peek(@cpu.program_counter) }
       @cia1 = @bus.cia1
@@ -141,6 +146,8 @@ module Badline
     # mode the CPU runs in both halves of the cycle (#clock_fast), and the
     # TEST bit steps the raster counter in every cycle.
     def cycle!
+      return z80_cycle! if @z80_turn
+
       handle_init if @cycles == @init_threshold
       feed_keyboard if @pending_keys
 
@@ -164,36 +171,6 @@ module Badline
       @cycles += 1
     end
 
-    # Runs `count` cycles, one #cycle! after another.
-    def run_cycles(count)
-      i = 0
-      while i < count
-        cycle!
-        i += 1
-      end
-    end
-
-    # Runs cycles until the block returns true or the cycle count passes
-    # `limit`, checking before each cycle.
-    def run_until(limit)
-      cycle! until yield || @cycles > limit
-    end
-
-    def on_init(&block)
-      if @cycles < init_threshold
-        @init_handlers << block
-      else
-        block.call
-      end
-    end
-
-    # The clock, the raster and the crop of the VIC-IIe's region.
-    def timing
-      region = @bus.region
-      Timing.new(clock_hz: region.clock_hz, cycles_per_line: region.cycles_per_line,
-                 lines_per_frame: region.lines_per_frame, crop: region.crop, pixel_width: 1)
-    end
-
     # The chip whose #display a front end shows: the VIC-IIe, or with
     # :vdc the VDC, whose display paints only while its #render is on.
     def video(chip = :vic) = chip == :vdc ? @vdc : @vic
@@ -208,12 +185,6 @@ module Badline
     # The chip a front end records the machine's sound from.
     def sound_source = @sid
 
-    def load_prg(data)
-      uint16(data[0], data[1]).tap do |load_addr|
-        ram.write(load_addr, data[2..])
-      end
-    end
-
     # A cartridge goes in with the power off.
     def attach_cartridge(cartridge)
       connect_cartridge(cartridge)
@@ -241,23 +212,16 @@ module Badline
       @drive&.reset!
       @drive1541&.reset!
       @drive1571&.reset!
+      @drive1581&.reset!
       @nmi_asserted = false
-      @cpu.reset!
-    end
-
-    # CHROUT is at $FFD2 in both KERNALs, and the trap follows the mode.
-    def capture_output
-      @capture_output ||= ChroutTrap.new(cpu:, bus: @bus, layout: trap_layout).tap do |trap|
-        cpu.install_trap(ChroutTrap::ADDRESS) { trap.call }
-      end
-    end
-
-    def inspect
-      "#<#{self.class.name} cycles=#{@cycles} cpu=(#{@cpu.inspect})>"
+      reset_z80
     end
 
     private
 
+    # The bus the KERNAL traps read and write through.
+    def trap_bus = @bus
+
     # The C128 KERNAL leaves $D02F at $FF, every extra keyboard row
     # deselected, before it jumps to the C64's reset.
     def enter_c64_mode
@@ -265,15 +229,6 @@ module Badline
       @bus.control_ports.extra_rows = 0xff
     end
 
-    # The NMI line is wired-OR between CIA 2, the cartridge and RESTORE,
-    # and the CPU takes an interrupt on its falling edge.
-    def drive_nmi
-      nmi = @cia2.interrupted? || @cartridge_nmi || @restore_pulse
-      @restore_pulse = false
-      @cpu.nmi = true if nmi && !@nmi_asserted
-      @nmi_asserted = nmi
-    end
-
     # BA halts the CPU on a read cycle.
     def clock_cpu
       @cpu.pending_write? || !@vic.ba_low? ? @cpu.cycle! : @cpu.stall!
@@ -301,22 +256,5 @@ module Badline
       @cpu.cycle!
       @vic.take_cpu_bus(phi1, @bus.data, @bus.vic_access?)
     end
-
-    def handle_init
-      @init_handlers.each(&:call)
-    end
-
-    # The keyboard buffer of the KERNAL the machine runs: the C64's, or in
-    # C128 mode BASIC 7.0's.
-    def feed_keyboard
-      c64 = mode == :c64
-      count = c64 ? KeyboardBuffer::COUNT : C128_KEYBOARD_COUNT
-      return unless ram.peek(count).zero?
-
-      chunk = @pending_keys.shift(KeyboardBuffer::CAPACITY)
-      ram.write(c64 ? KeyboardBuffer::ADDRESS : C128_KEYBOARD_BUFFER, chunk)
-      ram.poke(count, chunk.length)
-      @pending_keys = nil if @pending_keys.empty?
-    end
   end
 end

data/lib/badline/cartridge/action_replay.rb

@@ -65,12 +65,12 @@ module Badline
       private
 
       def save_mapper(out)
-        save_windows(out, windows)
+        super
         out.int(window_index(@rom, windows)).boolean(@active).boolean(@io2_ram).blob(@ram_data)
       end
 
       def load_mapper(input)
-        load_windows(input, windows)
+        super
         @rom = window_at(input.int, windows)
         @active = input.boolean?
         @io2_ram = input.boolean?

data/lib/badline/cartridge/comal80.rb

@@ -33,13 +33,7 @@ module Badline
 
       private
 
-      def save_mapper(out)
-        save_windows(out, [*@roml_banks, *@romh_banks, EMPTY_BANK])
-      end
-
-      def load_mapper(input)
-        load_windows(input, [*@roml_banks, *@romh_banks, EMPTY_BANK])
-      end
+      def windows = [*@roml_banks, *@romh_banks, EMPTY_BANK]
 
       def select(number, mode)
         @roml = bank(@roml_banks, number)

data/lib/badline/cartridge/dinamic.rb

@@ -24,14 +24,6 @@ module Badline
 
       private
 
-      def save_mapper(out)
-        save_windows(out, [*@banks, EMPTY_BANK])
-      end
-
-      def load_mapper(input)
-        load_windows(input, [*@banks, EMPTY_BANK])
-      end
-
       def install_chips(chips)
         @banks = banks_from(chips).first
         self.mode = :rom8k

data/lib/badline/cartridge/final_cartridge3.rb

@@ -49,31 +49,31 @@ module Badline
         @phi1_ultimax = false
         self.nmi = false
         select(0)
-        self.mode = :rom16k
-        changed!
+        select_mode(:rom16k)
       end
 
       def freeze!
         @register_visible = true
         @phi1_ultimax = false
-        self.mode = :ultimax
-        changed!
+        select_mode(:ultimax)
       end
 
       private
 
       def save_mapper(out)
-        save_windows(out, [*@roml_banks, *@romh_banks, EMPTY_BANK])
+        super
         out.boolean(@register_visible).boolean(@phi1_ultimax)
       end
 
       def load_mapper(input)
-        load_windows(input, [*@roml_banks, *@romh_banks, EMPTY_BANK])
+        super
         @io_bank = @roml
         @register_visible = input.boolean?
         @phi1_ultimax = input.boolean?
       end
 
+      def windows = [*@roml_banks, *@romh_banks, EMPTY_BANK]
+
       def select(number)
         @io_bank = @roml = bank(@roml_banks, number)
         @romh = bank(@romh_banks, number)

data/lib/badline/cartridge/fun_play.rb

@@ -28,14 +28,6 @@ module Badline
 
       private
 
-      def save_mapper(out)
-        save_windows(out, [*@banks, EMPTY_BANK])
-      end
-
-      def load_mapper(input)
-        load_windows(input, [*@banks, EMPTY_BANK])
-      end
-
       def install_chips(chips)
         @banks = []
         chips.each { |chip| @banks[self.class.bank_number(chip.bank)] = rom_bank(chip.data) }

data/lib/badline/cartridge/game_system.rb

@@ -25,14 +25,6 @@ module Badline
 
       private
 
-      def save_mapper(out)
-        save_windows(out, [*@banks, EMPTY_BANK])
-      end
-
-      def load_mapper(input)
-        load_windows(input, [*@banks, EMPTY_BANK])
-      end
-
       def select(addr)
         @roml = bank(@banks, addr & 0x3f)
         changed!

data/lib/badline/cartridge/kcs_power.rb

@@ -26,7 +26,7 @@ module Badline
 
       def peek(addr)
         if addr < 0xdf00
-          switch(addr.anybits?(0x02) ? :off : :rom8k)
+          select_mode(addr.anybits?(0x02) ? :off : :rom8k)
           @roml.peek(IO1_ROM_PAGE | (addr & 0xff))
         elsif addr.anybits?(0x80)
           (@exrom << 7) | (@game << 6) | (open_bus(addr) & 0x3f)
@@ -37,7 +37,7 @@ module Badline
 
       def poke(addr, value)
         if addr < 0xdf00
-          switch(addr.anybits?(0x02) ? :ultimax : :rom16k)
+          select_mode(addr.anybits?(0x02) ? :ultimax : :rom16k)
         elsif addr.nobits?(0x80)
           @io_ram[addr & 0x7f] = value
         end
@@ -45,19 +45,22 @@ module Badline
 
       def reset
         self.nmi = false
-        switch(:rom16k)
+        select_mode(:rom16k)
       end
 
       def freeze!
         self.nmi = false
-        switch(:ultimax)
+        select_mode(:ultimax)
       end
 
       private
 
-      def switch(mode)
-        self.mode = mode
-        changed!
+      def save_mapper(out)
+        out.blob(@io_ram)
+      end
+
+      def load_mapper(input)
+        input.blob_into(@io_ram)
       end
 
       def install_chips(chips)

data/lib/badline/cartridge/mach5.rb

@@ -14,13 +14,11 @@ module Badline
       end
 
       def poke(addr, _value)
-        self.mode = addr < 0xdf00 ? :rom8k : :off
-        changed!
+        select_mode(addr < 0xdf00 ? :rom8k : :off)
       end
 
       def reset
-        self.mode = :rom8k
-        changed!
+        select_mode(:rom8k)
       end
 
       private

data/lib/badline/cartridge/magic_desk.rb

@@ -20,14 +20,6 @@ module Badline
 
       private
 
-      def save_mapper(out)
-        save_windows(out, [*@banks, EMPTY_BANK])
-      end
-
-      def load_mapper(input)
-        load_windows(input, [*@banks, EMPTY_BANK])
-      end
-
       def install_chips(chips)
         @banks = banks_from(chips).first
         @bank_mask = (bank_mask(@banks) | 0x03) & 0x7f

data/lib/badline/cartridge/ocean.rb

@@ -19,14 +19,6 @@ module Badline
 
       private
 
-      def save_mapper(out)
-        save_windows(out, [*@banks, EMPTY_BANK])
-      end
-
-      def load_mapper(input)
-        load_windows(input, [*@banks, EMPTY_BANK])
-      end
-
       # In 16K mode the selected bank shows through ROMH as well.
       def select_bank(number)
         @roml = bank(@banks, number)

data/lib/badline/cartridge/pagefox.rb

@@ -30,12 +30,12 @@ module Badline
       private
 
       def save_mapper(out)
-        save_windows(out, windows)
+        super
         @ram_banks.each { |ram| out.blob(ram.data) }
       end
 
       def load_mapper(input)
-        load_windows(input, windows)
+        super
         @ram_banks.each { |ram| input.blob_into(ram.data) }
       end
 

data/lib/badline/cartridge/retro_replay.rb

@@ -90,6 +90,11 @@ module Badline
 
       attr_reader :flash
 
+      def self.from_jumpers(crt, input)
+        input.boolean?
+        new(crt, flash_jumper: input.boolean?, bank_jumper: input.boolean?)
+      end
+
       def initialize(crt, flash_jumper: false, bank_jumper: false)
         @nordic = crt.subtype == 1
         @flash_jumper = flash_jumper
@@ -131,9 +136,7 @@ module Badline
         end
       end
 
-      def phi1_ultimax?
-        @phi1_ultimax
-      end
+      def phi1_ultimax? = @phi1_ultimax
 
       def ultimax_a000
         @isolated[ram_view_bank] if @nordic && @ram_at_a000 && @frozen
@@ -157,9 +160,7 @@ module Badline
 
       private
 
-      def freeze_allowed?
-        !@no_freeze && !@flash_jumper
-      end
+      def freeze_allowed? = !@no_freeze && !@flash_jumper
 
       def status
         ((@bank & 0x03) << 3) | ((@bank & 0x04) << 5) | ((@bank & 0x08) << 2) | (@flash_jumper ? 0x01 : 0) |

data/lib/badline/cartridge/rex_utility.rb

@@ -10,16 +10,12 @@ module Badline
       end
 
       def peek(addr)
-        if addr >= 0xdf00
-          self.mode = (addr & 0xff) < 0xc0 ? :off : :rom8k
-          changed!
-        end
+        select_mode((addr & 0xff) < 0xc0 ? :off : :rom8k) if addr >= 0xdf00
         open_bus(addr)
       end
 
       def reset
-        self.mode = :rom8k
-        changed!
+        select_mode(:rom8k)
       end
 
       private

data/lib/badline/cartridge/rgcd.rb

@@ -29,12 +29,12 @@ module Badline
       private
 
       def save_mapper(out)
-        save_windows(out, [*@banks, EMPTY_BANK])
+        super
         out.boolean(@disabled)
       end
 
       def load_mapper(input)
-        load_windows(input, [*@banks, EMPTY_BANK])
+        super
         @disabled = input.boolean?
       end
 

data/lib/badline/cartridge/simons_basic.rb

@@ -24,11 +24,6 @@ module Badline
 
       private
 
-      def select_mode(mode)
-        self.mode = mode
-        changed!
-      end
-
       def install_chips(chips)
         roml, romh = banks_from(chips)
         @roml = bank(roml, 0)

data/lib/badline/cartridge/super_games.rb

@@ -21,15 +21,17 @@ module Badline
       private
 
       def save_mapper(out)
-        save_windows(out, [*@roml_banks, *@romh_banks, EMPTY_BANK])
+        super
         out.boolean(@locked)
       end
 
       def load_mapper(input)
-        load_windows(input, [*@roml_banks, *@romh_banks, EMPTY_BANK])
+        super
         @locked = input.boolean?
       end
 
+      def windows = [*@roml_banks, *@romh_banks, EMPTY_BANK]
+
       def select(value)
         @roml = bank(@roml_banks, value & 0x03)
         @romh = bank(@romh_banks, value & 0x03)

data/lib/badline/cartridge/westermann.rb

@@ -9,16 +9,12 @@ module Badline
       end
 
       def peek(addr)
-        if addr >= 0xdf00
-          self.mode = :rom8k
-          changed!
-        end
+        select_mode(:rom8k) if addr >= 0xdf00
         open_bus(addr)
       end
 
       def reset
-        self.mode = :rom16k
-        changed!
+        select_mode(:rom16k)
       end
 
       private

data/lib/badline/cartridge.rb

@@ -63,11 +63,7 @@ module Badline
       end
 
       def from_crt(crt, **)
-        mapper = HARDWARE_TYPES.fetch(crt.hardware_type) do
-          raise UnsupportedTypeError,
-                "Unsupported cartridge hardware type #{crt.hardware_type}"
-        end
-        mapper.new(crt, **)
+        mapper_for(crt).new(crt, **)
       end
 
       # A cartridge built afresh from what save_setup wrote, before
@@ -76,9 +72,21 @@ module Badline
         return GeoRAM.new(size: input.int) if input.int == GEO_RAM_SETUP
 
         crt = Storage::CRTFile.new(bytes: input.string)
-        return RetroReplay.new(crt, flash_jumper: input.boolean?, bank_jumper: input.boolean?) if input.boolean?
+        mapper_for(crt).from_jumpers(crt, input)
+      end
 
-        from_crt(crt)
+      # A cartridge from its image and what save_jumpers wrote: whether
+      # there are jumpers, then their settings on a mapper that has them.
+      def from_jumpers(crt, input)
+        input.boolean?
+        new(crt)
+      end
+
+      def mapper_for(crt)
+        HARDWARE_TYPES.fetch(crt.hardware_type) do
+          raise UnsupportedTypeError,
+                "Unsupported cartridge hardware type #{crt.hardware_type}"
+        end
       end
     end
 
@@ -95,6 +103,7 @@ module Badline
       @exrom = crt.exrom
       @game = crt.game
       @roml = @romh = nil
+      @banks = nil
       @on_change = nil
       @on_nmi_change = nil
       @nmi = false
@@ -193,9 +202,22 @@ module Badline
       out.boolean(false)
     end
 
-    def save_mapper(_out); end
+    # The mapper's own state: where its windows point, for a mapper that
+    # moves them, and whatever a mapper adds after calling super.
+    def save_mapper(out)
+      save_windows(out, windows) if windows
+    end
 
-    def load_mapper(_input); end
+    def load_mapper(input)
+      load_windows(input, windows) if windows
+    end
+
+    # The banks and views ROML and ROMH can point at, which a snapshot
+    # names them by: the mapper's banks, or nothing for a mapper whose
+    # windows stay where install_chips put them.
+    def windows
+      [*@banks, EMPTY_BANK] if @banks
+    end
 
     # Where the ROML and ROMH windows point, as their places in `windows`,
     # the banks and views the mapper picks them from, or -1 for none.
@@ -232,6 +254,12 @@ module Badline
       @exrom, @game = MODES.fetch(mode)
     end
 
+    # Sets the lines and tells the machine to map the cartridge again.
+    def select_mode(mode)
+      self.mode = mode
+      changed!
+    end
+
     def open_bus(addr)
       @open_bus ? @open_bus.peek(addr) : 0xff
     end

data/lib/badline/cia/fast_forward.rb

@@ -4,6 +4,9 @@ module Badline
   class CIA
     # Running a CIA a stretch of cycles at once, for Drive::Idle.
     module FastForward
+      # quiet_cycles for a CIA whose counters will never set a flag.
+      QUIET = 1 << 40
+
       # Whether fast_forward can run the CIA: timer B stopped with nothing
       # in its pipeline, no interrupt or acknowledge on its way, CNT where it
       # was, the TOD clock stopped, and timer A either stopped, or free
@@ -16,11 +19,24 @@ module Badline
         @ta.idle? ? @serial.idle : timer_a_free_running?
       end
 
-      # Runs +cycles+ cycles at once while quiet?, as cycle! would: timer A's
-      # underflows flag in the ICR, and reach the serial port's underflow
-      # line.
+      # How many cycles the CIA can run with nothing but its counters
+      # moving: as quiet? allows, but with timer B free running too, up to
+      # the cycle before it underflows. The 1581's DOS leaves timer B
+      # interrupting every 10 ms.
+      def quiet_cycles
+        return 0 unless @icr.quiet && @tod.quiet? && cnt_steady? && timer_a_quiet?
+        return QUIET if @tb.idle?
+        return 0 unless @tb.free_running? && @control_b.value.nobits?(0x60)
+
+        @tb.counter - 1
+      end
+
+      # Runs +cycles+ cycles at once while quiet? or for quiet_cycles, as
+      # cycle! would: timer A's underflows flag in the ICR, and reach the
+      # serial port's underflow line.
       def fast_forward(cycles)
         @tod.fast_forward(cycles)
+        @tb.fast_forward(cycles) unless @tb.idle?
         return if @ta.idle?
 
         @icr.flag(:timer_a) if @ta.fast_forward(cycles).positive?
@@ -29,6 +45,8 @@ module Badline
 
       private
 
+      def timer_a_quiet? = @ta.idle? ? @serial.idle : timer_a_free_running?
+
       # Timer A free running with its interrupt masked, and the serial port
       # an idle input it only clocks.
       def timer_a_free_running?