badline 0.8.0 → 0.10.0

data/lib/badline/vic20.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require "badline/vic20/attachments"
+require "badline/vic20/bus"
+require "badline/vic20/cpu"
+require "badline/vic20/keyboard_via_ports"
+require "badline/vic20/port_wiring"
+require "badline/vic20/user_via_ports"
+require "badline/vic20/vic"
+require "badline/vic20/sound"
+require "badline/vic20/saved_state"
+
+module Badline
+  # The Commodore VIC-20 with the PAL 6561: a 6502 at the VIC's clock, the
+  # VIC-I and two 6522 VIAs. VIA 1, at $9110, pulls NMI, and VIA 2, at
+  # $9120, pulls IRQ. Nothing else interrupts the CPU, and nothing halts
+  # it: the VIC fetches in the half of the cycle the CPU leaves alone.
+  #
+  # It runs in the window, as `badline vic20`, with the VIC's picture and
+  # sound. The keyboard, the joystick and RESTORE reach the VIAs, the
+  # datasette and the serial bus hang off them (PortWiring), and device 8
+  # serves disks through the KERNAL traps or a true 1541.
+  class Vic20
+    include IntegerHelper
+    include KeyboardBuffer
+    include Attachments
+    include PortWiring
+    include SavedState
+
+    attr_reader :bus, :cpu, :vic, :via1, :via2, :keyboard, :joystick1, :cycles, :init_threshold, :sound,
+                :drive1541, :iec_bus, :datasette
+
+    # The RAM expansion it was built with, a key of Bus::RAM_CONFIGURATIONS.
+    attr_reader :ram_configuration
+
+    # The path of the disk or directory device 8 serves through the traps
+    # (Attachments), or an empty one.
+    def mounted_path = @drive.nil? ? "" : @drive.path
+
+    def ram = @bus.ram
+
+    def family = :vic20
+
+    # The one control port's joystick, which the front end's second
+    # joystick drives too.
+    def joystick2 = @joystick1
+
+    # No pot device plugs in yet.
+    def control_ports = nil
+
+    # +ram+ names the RAM expansion, one of Bus::RAM_CONFIGURATIONS.
+    def initialize(ram: :unexpanded, debug: false)
+      @ram_configuration = ram
+      @vic = VIC.new
+      @keyboard = Keyboard.new(matrix: KeyboardVIAPorts::MATRIX)
+      @joystick1 = Joystick.new
+      @iec_bus = IECBus.new
+      @datasette = Datasette.new
+      @via1 = VIA.new(start: 0x9000, peripheral: UserVIAPorts.new(joystick: @joystick1, serial_bus: @iec_bus,
+                                                                  datasette: @datasette))
+      keyboard_ports = KeyboardVIAPorts.new(keyboard: @keyboard, joystick: @joystick1)
+      @via2 = VIA.new(start: 0x9000, peripheral: keyboard_ports)
+      keyboard_ports.connect(@via2)
+      @bus = Bus.new(vic: @vic, via1: @via1, via2: @via2, blocks: Bus::RAM_CONFIGURATIONS.fetch(ram))
+      @vic.connect(@bus)
+      @cpu = CPU.new(@bus, debug:)
+      @cycles = 0
+      @sound = Sound.new(self, @vic.profile.clock_hz)
+      @vic.sound = @sound
+      @nmi_asserted = false
+      @init_handlers = []
+      @pending_keys = nil
+      @drive = nil
+      @serial_trap = nil
+      @save_trap = nil
+      @capture_output = nil
+      @drive1541 = nil
+      @init_threshold = boot_cycles
+      wire_ports
+    end
+
+    # The VIC and the VIAs clock ahead of the CPU, as the C64's chips do,
+    # so a register write lands on the cycle after the one it was issued
+    # on.
+    def cycle!
+      handle_init if @cycles == @init_threshold
+      feed_keyboard if @pending_keys
+
+      @vic.cycle!
+      @via1.cycle!
+      @via2.cycle!
+      @datasette.cycle!
+      @cpu.irq = @via2.irq?
+      drive_nmi
+      @cpu.cycle!
+      @drive1541&.host_cycle!
+
+      @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
+
+    # Runs the block once the KERNAL has booted (see init_threshold), or
+    # now if it has.
+    def on_init(&block)
+      if @cycles < @init_threshold
+        @init_handlers << block
+      else
+        block.call
+      end
+    end
+
+    # The chip whose #display a front end shows.
+    def video = @vic
+
+    # What a front end plays: the VIC's sound, which answers #record and
+    # #drain_samples.
+    def sound_source = @sound
+
+    # The PAL clock and raster, and the part of the display xvic shows: all
+    # 284 pixels of a line, from line 28, below the VIC's vertical blank.
+    # The VIC draws 4 pixels a cycle, half as many as the C64's VIC-II on
+    # about the same clock, so each pixel shows two window pixels wide, as
+    # xvic draws them.
+    def timing
+      profile = @vic.profile
+      width = profile.cycles_per_line * VIC::PIXELS_PER_CYCLE
+      blanked = profile.blanked_lines
+      Timing.new(clock_hz: profile.clock_hz, cycles_per_line: profile.cycles_per_line,
+                 lines_per_frame: profile.lines_per_frame,
+                 crop: [0, blanked, width, profile.lines_per_frame - blanked], pixel_width: 2)
+    end
+
+    # The RESTORE key pulls VIA 1's CA1 low while it is held. The KERNAL
+    # sets CA1 to interrupt on that falling edge, and its NMI handler
+    # ($FEAD) warm-starts BASIC if RUN/STOP is down too.
+    def press_restore
+      @via1.ca1 = false
+    end
+
+    def release_restore
+      @via1.ca1 = true
+    end
+
+    # Calls the block with the exit code a VICE testprog writes to $910F.
+    def install_debug_register(&) = @bus.install_debug_register(&)
+
+    # Stores a PRG's bytes from its load address on, as the CPU would, so
+    # bytes for an empty block go nowhere, and returns that address.
+    def load_prg(data)
+      load_addr = uint16(data[0], data[1])
+      bytes = data[2..] || []
+      bytes = bytes[0, 0x10000 - load_addr] if load_addr + bytes.length > 0x10000
+      bytes.each_with_index { |byte, i| @bus.poke(load_addr + i, byte) }
+      load_addr
+    end
+
+    # The RES line reaches the CPU and both VIAs, and through the serial
+    # bus's RESET line, the drive. The VIC has no reset pin.
+    def reset!
+      @via1.reset!
+      @via2.reset!
+      via_written
+      @drive&.reset!
+      @drive1541&.reset!
+      @nmi_asserted = false
+      @cpu.reset!
+    end
+
+    # Switches the machine off and on: RAM and the VIC start from their
+    # power-on state, and the RES line resets everything else.
+    def power_cycle!
+      @bus.power_on!
+      @vic.power_on!
+      @sound.power_on!
+      reset!
+    end
+
+    def inspect
+      "#<#{self.class.name} cycles=#{@cycles} cpu=(#{@cpu.inspect})>"
+    end
+
+    private
+
+    # The cycle by which the KERNAL has booted and BASIC printed READY,
+    # with a margin. The KERNAL's RAM test takes most of it, and runs up
+    # from $1000 until it finds no RAM, so each 8K block on from BLK1
+    # adds about 615,000 cycles. Unexpanded, READY is up by about 557,000.
+    def boot_cycles
+      tested = 0
+      tested += 1 while tested < 3 && @bus.ram?(%i[blk1 blk2 blk3][tested])
+      700_000 + (650_000 * tested)
+    end
+
+    # VIA 1's IRQ output drives NMI, and the CPU takes an interrupt on its
+    # falling edge.
+    def drive_nmi
+      nmi = @via1.irq?
+      @cpu.nmi = true if nmi && !@nmi_asserted
+      @nmi_asserted = nmi
+    end
+
+    def handle_init
+      @init_handlers.each(&:call)
+    end
+  end
+end

data/lib/badline.rb

@@ -1,43 +1,7 @@
 # frozen_string_literal: true
 
-require "badline/version"
+require "badline/core"
 require "badline/options"
-require "badline/integer_helper"
-require "badline/region"
-require "badline/addressable"
-require "badline/memory"
-require "badline/color_memory"
-require "badline/rom"
-require "badline/ram_expansion"
-require "badline/address_bus"
-require "badline/instruction"
-require "badline/instruction_set"
-require "badline/status"
-require "badline/keyboard"
-require "badline/joystick"
-require "badline/control_ports"
-require "badline/input"
-require "badline/cycleable"
-require "badline/datasette"
-require "badline/time_of_day"
-require "badline/cia"
-require "badline/via"
-require "badline/sid"
-require "badline/debug_register"
-require "badline/reu"
-require "badline/interrupts"
-require "badline/traps"
-require "badline/cpu"
-require "badline/vic"
-require "badline/keyboard_buffer"
-require "badline/iec_bus"
-require "badline/drive1541"
-require "badline/computer"
-require "badline/checkpoint"
-require "badline/storage"
-require "badline/cartridge"
-require "badline/kernal_trap"
-require "badline/chrout_trap"
-require "badline/media"
+require "badline/data_path"
 require "badline/snapshot"
 require "badline/audio"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: badline
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Inge Jørgensen
@@ -50,13 +50,15 @@ files:
 - lib/badline.rb
 - lib/badline/address_bus.rb
 - lib/badline/address_bus/extra_sids.rb
+- lib/badline/address_bus/pla.rb
+- lib/badline/address_bus/roms.rb
 - lib/badline/address_bus/saved_state.rb
 - lib/badline/address_bus/sid_slots.rb
-- lib/badline/address_bus/ultimax_pages.rb
 - lib/badline/addressable.rb
 - lib/badline/audio.rb
 - lib/badline/audio/aiff.rb
 - lib/badline/audio/bare_player.rb
+- lib/badline/audio/checkpoints.rb
 - lib/badline/audio/cli.rb
 - lib/badline/audio/console.rb
 - lib/badline/audio/jukebox.rb
@@ -108,6 +110,7 @@ files:
 - lib/badline/computer/attachments.rb
 - lib/badline/computer/saved_state.rb
 - lib/badline/control_ports.rb
+- lib/badline/core.rb
 - lib/badline/cpu.rb
 - lib/badline/cpu/addressing.rb
 - lib/badline/cpu/boundary.rb
@@ -117,6 +120,7 @@ files:
 - lib/badline/cpu/saved_state.rb
 - lib/badline/cpu/stack_operations.rb
 - lib/badline/cycleable.rb
+- lib/badline/data_path.rb
 - lib/badline/datasette.rb
 - lib/badline/debug_register.rb
 - lib/badline/drive1541.rb
@@ -151,9 +155,12 @@ files:
 - lib/badline/frontend/gamepads.rb
 - lib/badline/frontend/info_view.rb
 - lib/badline/frontend/keys.rb
+- lib/badline/frontend/machine_window.rb
 - lib/badline/frontend/menu_dialogs.rb
 - lib/badline/frontend/menu_media.rb
 - lib/badline/frontend/menu_pages.rb
+- lib/badline/frontend/menu_ports.rb
+- lib/badline/frontend/name_field.rb
 - lib/badline/frontend/pacer.rb
 - lib/badline/frontend/pad_port.rb
 - lib/badline/frontend/painter.rb
@@ -201,17 +208,24 @@ files:
 - lib/badline/kernal_trap/drive/write_file.rb
 - lib/badline/kernal_trap/drive/writes.rb
 - lib/badline/kernal_trap/file.rb
+- lib/badline/kernal_trap/layout.rb
 - lib/badline/kernal_trap/load.rb
 - lib/badline/kernal_trap/routine.rb
 - lib/badline/kernal_trap/save.rb
 - lib/badline/kernal_trap/serial.rb
 - lib/badline/keyboard.rb
 - lib/badline/keyboard_buffer.rb
+- lib/badline/machine.rb
 - lib/badline/media.rb
+- lib/badline/media/disk_list.rb
 - lib/badline/media/disk_set.rb
 - lib/badline/media/queue.rb
 - lib/badline/media/true_drive.rb
+- lib/badline/media/vic20_basic.rb
+- lib/badline/media/vic20_cartridge.rb
+- lib/badline/media/vic20_media.rb
 - lib/badline/memory.rb
+- lib/badline/model.rb
 - lib/badline/options.rb
 - lib/badline/options/event.rb
 - lib/badline/options/help.rb
@@ -238,7 +252,12 @@ files:
 - lib/badline/roms/eapi/LICENSE.md
 - lib/badline/roms/eapi/README
 - lib/badline/roms/eapi/eapi-am29f040-14
+- lib/badline/roms/kernal-sx64.rom
 - lib/badline/roms/kernal.rom
+- lib/badline/roms/vic20/basic.rom
+- lib/badline/roms/vic20/character.rom
+- lib/badline/roms/vic20/kernal-ntsc.rom
+- lib/badline/roms/vic20/kernal-pal.rom
 - lib/badline/sdl.rb
 - lib/badline/sid.rb
 - lib/badline/sid/catch_up.rb
@@ -266,6 +285,7 @@ files:
 - lib/badline/snapshot/vice/main_cpu.rb
 - lib/badline/snapshot/vice/peripherals.rb
 - lib/badline/snapshot/vice/restore.rb
+- lib/badline/snapshot/vice/reu1764.rb
 - lib/badline/snapshot/vice/sid_extended.rb
 - lib/badline/snapshot/vice/sid_registers.rb
 - lib/badline/snapshot/vice/vicii.rb
@@ -294,6 +314,7 @@ files:
 - lib/badline/storage/tap.rb
 - lib/badline/storage/unavailable.rb
 - lib/badline/time_of_day.rb
+- lib/badline/timing.rb
 - lib/badline/traps.rb
 - lib/badline/version.rb
 - lib/badline/via.rb
@@ -324,6 +345,20 @@ files:
 - lib/badline/vic/sprite/timing.rb
 - lib/badline/vic/sprites.rb
 - lib/badline/vic/sprites_state.rb
+- lib/badline/vic20.rb
+- lib/badline/vic20/attachments.rb
+- lib/badline/vic20/bus.rb
+- lib/badline/vic20/cpu.rb
+- lib/badline/vic20/keyboard_via_ports.rb
+- lib/badline/vic20/port_wiring.rb
+- lib/badline/vic20/saved_state.rb
+- lib/badline/vic20/sound.rb
+- lib/badline/vic20/sound/output.rb
+- lib/badline/vic20/user_via_ports.rb
+- lib/badline/vic20/vic.rb
+- lib/badline/vic20/vic/painter.rb
+- lib/badline/vic20/vic/saved_state.rb
+- lib/badline/vic20/vic/text_window.rb
 - packaging/homebrew/badline.rb
 homepage: https://github.com/elektronaut/badline
 licenses:

data/lib/badline/address_bus/ultimax_pages.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Badline
-  class AddressBus
-    # The page tables of an Ultimax cartridge, which AddressBus lays out
-    # in place of the $01 banking while the cartridge holds GAME low and
-    # EXROM high.
-    module UltimaxPages
-      private
-
-      # Ultimax cartridges ignore the $01 lines: 4K of RAM, ROML/ROMH windows,
-      # I/O always visible and open address space everywhere else. The ROML
-      # and ROMH selects fire on writes as well, so cartridge RAM or flash in
-      # either window takes the writes there.
-      def map_ultimax_pages
-        @read_pages.fill(@open_bus, 0x10, 0xf0)
-        @write_pages.fill(@open_bus, 0x10, 0xf0)
-        @read_pages.fill(@cartridge.roml, 0x80, 0x20) if @cartridge.roml
-        map_ultimax_writes(@cartridge.roml, 0x80)
-        @read_pages.fill(@cartridge.romh, 0xe0, 0x20) if @cartridge.romh
-        map_ultimax_writes(@cartridge.romh, 0xe0)
-        map_ultimax_a000
-        map_io_pages
-      end
-
-      def map_ultimax_writes(bank, first_page)
-        @write_pages.fill(bank, first_page, 0x20) if bank.respond_to?(:poke)
-      end
-
-      def map_ultimax_a000
-        return unless (window = @cartridge.ultimax_a000)
-
-        @read_pages.fill(window, 0xa0, 0x20)
-        @write_pages.fill(window, 0xa0, 0x20)
-      end
-    end
-  end
-end