badline 0.11.1 → 0.12.0

data/lib/badline/media/boot_disk.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Badline
+  module Media
+    # A C128 boot disk. At power-on the C128 KERNAL reads track 1, sector 0
+    # of the disk in device 8 and runs it when it starts with "CBM", as boot
+    # games have it. The 1581's DOS first loads and runs a USR file named
+    # COPYRIGHT CBM 86 when the disk has one, which is how CP/M's 1581 disks
+    # hand the KERNAL their boot sector, so a .d81 with that file boots too.
+    #
+    # On a C128 in C128 mode a boot disk goes in a true drive, a 1581 for a
+    # .d81 and the C128D's 1571 otherwise, and nothing is typed, so the
+    # KERNAL boots it. Other disks, and other machines, keep the traps and
+    # the autostart.
+    module BootDisk
+      SIGNATURE = "CBM".bytes.freeze
+      AUTO_BOOT = "copyright cbm 86"
+      TYPES = %w[.d64 .d71 .d81].freeze
+
+      class << self
+        def takes?(computer, path)
+          computer.family == :c128 && computer.mode == :c128 && boot?(path)
+        end
+
+        # Puts a disk that boots on the computer in a true drive as device
+        # 8, write-protected with `disk: { read_only: true }`, for the KERNAL
+        # to boot at power-on, and says so. Nil for any other disk.
+        def attach(computer, path, disk: {}, **)
+          return unless takes?(computer, path)
+
+          read_only = disk.fetch(:read_only, false)
+          "#{TrueDrive.insert(computer, path, read_only:)}, to boot at power-on"
+        end
+
+        # Whether the disk image at path boots: its boot sector, or on a
+        # .d81 the 1581's auto-boot file.
+        def boot?(path)
+          type = File.extname(path).downcase
+          return false unless TYPES.include?(type) && File.file?(path)
+
+          image = MOUNT_TYPES.fetch(type).new(path, read_only: true)
+          block = image.read_block(1, 0)
+          return true if block && block[0, 3] == SIGNATURE
+
+          type == ".d81" && !image.read_file(AUTO_BOOT, type: :usr).nil?
+        end
+      end
+    end
+  end
+end

data/lib/badline/media/not_disk.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Badline
+  module Media
+    # A file that goes in device 8 but isn't a disk image or a directory.
+    class NotDisk < ArgumentError; end
+  end
+end

data/lib/badline/media/true_drive.rb

@@ -3,13 +3,15 @@
 module Badline
   module Media
     # Device 8 as a true drive instead of the KERNAL traps: a 1541, or on
-    # the C128 its 1571. Once a true drive is plugged in as device 8, disk
-    # media go into it rather than into the traps, so a LOAD runs the DOS
-    # and every byte crosses the serial bus. A .g64 holds the disk's raw
-    # GCR, which only a true drive reads, so it plugs one in when there's
-    # none yet. The 1541 reads only .d64 and .g64 images, and the 1571
-    # .d71 and .g71 as well, so the traps' other disk media, a .d81 or
-    # .t64 or a host directory, raise Error.
+    # the C128 its 1571, or a 1581. Once a true drive is plugged in as
+    # device 8, disk media go into it rather than into the traps, so a LOAD
+    # runs the DOS and every byte crosses the serial bus. A .g64 holds the
+    # disk's raw GCR, which only a true drive reads, so it plugs one in
+    # when there's none yet. The 1541 reads only .d64 and .g64 images, the
+    # 1571 .d71 and .g71 as well, and the 1581 only .d81, so a .d81 swaps
+    # the drive on device 8 for a 1581 (Drive1581::Slot), and another disk
+    # image swaps a 1581 back for the machine's own drive. The traps' other
+    # disk media, a .t64 or a host directory, raise Error.
     module TrueDrive
       class Error < ArgumentError; end
 
@@ -35,22 +37,40 @@ module Badline
           !drive(computer).nil? && (File.directory?(path) || MOUNT_TYPES.key?(File.extname(path).downcase))
         end
 
-        # Puts the image in the drive on device 8, plugging one in when
-        # there's none, and takes out what was mounted through the traps,
-        # so LOAD and SAVE reach the drive too. `read_only` puts it in
-        # write-protected.
+        # Puts the image in the drive on device 8, plugging one in that
+        # reads it when the drive there doesn't, and takes out what was
+        # mounted through the traps, so LOAD and SAVE reach the drive too.
+        # `read_only` puts it in write-protected.
         def insert(computer, path, read_only: false)
-          name = drive(computer)&.model_name || (computer.family == :c128 ? "1571" : "1541")
+          return insert_d81(computer, path, read_only) if File.extname(path).casecmp?(".d81")
+
+          drive = own_drive(computer)
+          name = drive&.model_name || (computer.family == :c128 ? "1571" : "1541")
           types = name == "1571" ? %w[.d64 .g64 .d71 .g71] : %w[.d64 .g64]
           unless types.include?(File.extname(path).downcase)
-            raise Error, "#{path} is not a #{types[0..-2].join(', ')} or #{types.last} image, which the #{name} reads"
+            raise Error, "#{path} is not a #{types.join(', ')} or .d81 image, which the #{name} and the 1581 read"
           end
 
-          disk = Drive1541::Disk.open(path, read_only:)
+          (drive || computer.plug_true_drive).insert_image(path, read_only:)
           computer.unmount
-          plug(computer).insert(disk)
           "Inserted #{path} in the #{name} as device 8"
         end
+
+        private
+
+        # The drive on device 8 unless it's a 1581.
+        def own_drive(computer)
+          drive = drive(computer)
+          drive unless drive&.model_name == "1581"
+        end
+
+        def insert_d81(computer, path, read_only)
+          drive = drive(computer)
+          drive = computer.plug_drive1581 unless drive&.model_name == "1581"
+          drive.insert_image(path, read_only:)
+          computer.unmount
+          "Inserted #{path} in the 1581 as device 8"
+        end
       end
     end
   end

data/lib/badline/media.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "badline/media/true_drive"
+require "badline/media/boot_disk"
+require "badline/media/not_disk"
 require "badline/media/queue"
 require "badline/media/disk_set"
 require "badline/media/disk_list"
@@ -32,6 +34,9 @@ module Badline
       # there, a .d64 goes into it instead of the KERNAL traps too. The
       # autostart then loads through it.
       #
+      # On a C128 in C128 mode, a boot disk goes in a true drive for the
+      # KERNAL to boot at power-on, with nothing typed (BootDisk).
+      #
       # An .m3u or .vfl list of disks attaches the first disk it lists
       # (DiskList). The VIC-20 takes its own media (Vic20Media), and the
       # C128 in C64 mode a C64's.
@@ -39,7 +44,7 @@ module Badline
         path = DiskList.disk(path)
         return Vic20Media.attach(computer, path, autostart:, **) if computer.family == :vic20
 
-        attach_c64(computer, path, autostart:, subtune:, **)
+        BootDisk.attach(computer, path, **) || attach_c64(computer, path, autostart:, subtune:, **)
       end
 
       # Swaps the disk in device 8 for a disk image or a host directory,
@@ -50,11 +55,12 @@ module Badline
       # A .g64 goes in a true 1541, which is plugged in as device 8 when
       # there's none yet (TrueDrive). Once a true 1541 is device 8, a .d64
       # goes in its drive as well, and other disks, which a 1541 can't
-      # read, raise TrueDrive::Error, an ArgumentError.
+      # read, raise TrueDrive::Error, an ArgumentError. Anything else
+      # raises NotDisk.
       def insert_disk(computer, path, read_only: false)
         return TrueDrive.insert(computer, path, read_only:) if TrueDrive.takes?(computer, path)
 
-        raise ArgumentError, "#{path} is not a disk image or a directory" unless disk?(path)
+        raise NotDisk, "#{path} is not a disk image or a directory" unless disk?(path)
 
         computer.mount(open_storage(path, { read_only: }))
         "Inserted #{path} in device 8"

data/lib/badline/options/event.rb

@@ -23,7 +23,7 @@ module Badline
 
       # What insert takes: disk images, tapes and cartridges, or an .m3u
       # or .vfl list of disks or a directory to mount as device 8.
-      INSERTABLE = %w[.d64 .d71 .d81 .g64 .t64 .tap .crt].freeze
+      INSERTABLE = %w[.d64 .d71 .d81 .g64 .t64 .tap .crt .m3u .vfl].freeze
 
       attr_reader :frame, :action, :argument
 
@@ -95,7 +95,7 @@ module Badline
       def self.insertable?(path)
         return true if File.directory?(path)
 
-        File.exist?(path) && (INSERTABLE.include?(File.extname(path).downcase) || Media::DiskList.list?(path))
+        File.exist?(path) && INSERTABLE.include?(File.extname(path).downcase)
       end
     end
   end

data/lib/badline/options/family.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "badline/storage/p00"
+
 module Badline
   class Options
     # The machine family: the subcommand that names it, or else the media,
@@ -37,15 +39,7 @@ module Badline
         return if @family_named || @sid_command || @media_path.nil?
         return unless %w[.prg .p00].include?(File.extname(@media_path).downcase) && File.file?(@media_path)
 
-        @family = :c128 if load_address(@media_path) == C128_BASIC_START
-      end
-
-      # The load address of a .prg, or of the program a .p00 wraps after its
-      # 26-byte header.
-      def load_address(path)
-        offset = File.extname(path).casecmp?(".p00") ? 26 : 0
-        bytes = File.binread(path).bytes
-        bytes.size >= offset + 2 ? bytes[offset] | (bytes[offset + 1] << 8) : -1
+        @family = :c128 if Storage::P00.load_address(@media_path) == C128_BASIC_START
       end
     end
   end

data/lib/badline/options/help.rb

@@ -61,7 +61,8 @@ module Badline
         pause menu loads. Device 8 answers through traps on the KERNAL's
         disk routines, unless --true-drive puts an emulated 1541 there,
         which runs its own DOS and reads .d64 and .g64 images only, or on
-        the C128 the C128D's 1571, which reads .d71 and .g71 too. A .sid
+        the C128 the C128D's 1571, which reads .d71 and .g71 too. A .d81
+        then goes in an emulated 1581 in its place. A .sid
         tune opens in the SID player, as `sid` plays it, unless an option
         of the emulator's window asks for the machine.
 

data/lib/badline/roms/README

@@ -70,6 +70,15 @@ Downloaded from
 https://www.zimmers.net/anonftp/pub/cbm/firmware/drives/new/1571/1571-rom.310654-05.bin
 SHA-1 f1be619c106641a685f6609e4d43d6fc9eac1e70.
 
+dos1581.rom
+-----------
+The 1581 disk drive's DOS, 318045-02, 32 KB for $8000-$FFFF.
+Drive1581 loads it.
+
+Downloaded from
+https://www.zimmers.net/anonftp/pub/cbm/firmware/drives/new/1581/1581-rom.318045-02.bin
+SHA-1 01228eae6f066bd9b7b2b6a7fa3f667e41dad393.
+
 Commodore VIC-20 ROMs
 =====================
 

data/lib/badline/sdl.rb

@@ -59,23 +59,6 @@ module Badline
     ffi_func :SDL_PushEvent, [:ptr], :int
     ffi_func :SDL_GetKeyName, [:int], :str
 
-    ffi_buffer :event, 56
-    ffi_read_u32 :event_type, 0
-    ffi_read_u8 :event_repeat, 13
-    ffi_read_i32 :event_scancode, 16
-    ffi_read_i32 :event_sym, 20
-    ffi_read_u16 :event_mod, 24
-    # SDL_MouseMotionEvent's xrel and yrel, and SDL_MouseButtonEvent's
-    # button.
-    ffi_read_i32 :event_xrel, 28
-    ffi_read_i32 :event_yrel, 32
-    ffi_read_u8 :event_button, 16
-    # Where the pointer is, in a motion or button event.
-    ffi_read_i32 :event_x, 20
-    ffi_read_i32 :event_y, 24
-    # SDL_DropEvent's file, which the receiver frees.
-    ffi_read_ptr :event_file, 8
-
     ffi_buffer :rect, 16
     ffi_write_i32 :rect_x, 0
     ffi_write_i32 :rect_y, 4
@@ -115,19 +98,53 @@ module Badline
     ffi_const :PIXELFORMAT_ARGB8888, 0x16362004
     ffi_const :BLENDMODE_BLEND, 0x01
     ffi_const :TEXTUREACCESS_STREAMING, 1
+    ffi_const :AUDIO_S16LSB, 0x8010
+    ffi_const :ALLOW_FREQUENCY_CHANGE, 0x01
+  end
+
+  # The events: the SDL_Event that SDL_PollEvent fills, the fields the
+  # front end reads from it, the event types, the key modifier and
+  # keycodes, and the dropped file's path.
+  module SDL
+    ffi_buffer :event, 56
+    ffi_read_u32 :event_type, 0
+    ffi_read_u8 :event_repeat, 13
+    ffi_read_i32 :event_scancode, 16
+    ffi_read_i32 :event_sym, 20
+    ffi_read_u16 :event_mod, 24
+    # SDL_MouseMotionEvent's xrel and yrel, and SDL_MouseButtonEvent's
+    # button.
+    ffi_read_i32 :event_xrel, 28
+    ffi_read_i32 :event_yrel, 32
+    ffi_read_u8 :event_button, 16
+    # Where the pointer is, in a motion or button event.
+    ffi_read_i32 :event_x, 20
+    ffi_read_i32 :event_y, 24
+    # SDL_DropEvent's file, which the receiver frees.
+    ffi_read_ptr :event_file, 8
+
     ffi_const :QUIT, 0x100
     ffi_const :KEYDOWN, 0x300
     ffi_const :KEYUP, 0x301
     ffi_const :MOUSEMOTION, 0x400
     ffi_const :MOUSEBUTTONDOWN, 0x401
     ffi_const :MOUSEBUTTONUP, 0x402
-    ffi_const :KMOD_SHIFT, 0x0003
+    ffi_const :MOUSEWHEEL, 0x403
     ffi_const :CONTROLLERDEVICEADDED, 0x653
     ffi_const :CONTROLLERDEVICEREMOVED, 0x654
-    ffi_const :AUDIO_S16LSB, 0x8010
-    ffi_const :ALLOW_FREQUENCY_CHANGE, 0x01
+    ffi_const :DROPFILE, 0x1000
+    ffi_const :KMOD_SHIFT, 0x0003
     ffi_const :KEY_TAB, 0x09
     ffi_const :KEY_F10, 0x4000_0043
+
+    # The path of the file the DROPFILE event in SDL.event carries, as a
+    # String, freeing SDL's copy.
+    def self.dropped_file
+      file = SDL.event_file(SDL.event)
+      path = LibC.strstr(file, "")
+      LibC.free(file)
+      path
+    end
   end
 
   # The few C library calls the native front end makes.

data/lib/badline/snapshot/state.rb

@@ -15,10 +15,11 @@ module Badline
       # save_state writes something else, so a State in another layout
       # fails before anything is read into a machine. Layout 3, without the
       # KERNAL and datasette in the setup, layout 4, without the VIA shift
-      # register's clock delay, and layout 5, without the board in the
-      # setup, still read.
-      SCHEMA = 6
-      READABLE = [3, 4, 5, SCHEMA].freeze
+      # register's clock delay, layout 5, without the board in the setup,
+      # layout 6, without the C128's Z80, and layout 7, without a 1581 on the
+      # serial bus, still read.
+      SCHEMA = 8
+      READABLE = [3, 4, 5, 6, 7, SCHEMA].freeze
 
       attr_reader :values, :strings
 

data/lib/badline/storage/p00.rb

@@ -18,6 +18,14 @@ module Badline
         def data(bytes)
           bytes[HEADER_SIZE..]
         end
+
+        # The load address of the program in a .prg file, or wrapped in a
+        # .p00 one, or -1 when the file is too short to have one.
+        def load_address(path)
+          bytes = File.binread(path).bytes
+          offset = wraps?(bytes) ? HEADER_SIZE : 0
+          bytes.size >= offset + 2 ? bytes[offset] | (bytes[offset + 1] << 8) : -1
+        end
       end
     end
   end

data/lib/badline/time_of_day.rb

@@ -52,9 +52,9 @@ module Badline
       @latch = input.boolean? ? FIELDS.to_h { |field| [field, input.int] } : nil
     end
 
-    # Whether the clock is stopped with no alarm to raise, so its cycles
-    # move only the divider's phase.
-    def quiet? = @stopped && !@alarm_pending
+    # Whether the clock is stopped, or gets no pulses on its pin, with no
+    # alarm to raise, so its cycles move only the divider's phase.
+    def quiet? = (@stopped || @mains_hz.zero?) && !@alarm_pending
 
     # Runs +cycles+ quiet cycles at once.
     def fast_forward(cycles)

data/lib/badline/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Badline
-  VERSION = "0.11.1"
+  VERSION = "0.12.0"
 end

data/lib/badline/vic20/attachments.rb

@@ -4,8 +4,10 @@ module Badline
   class Vic20
     # What plugs into the VIC-20 besides its chips: cartridge ROM in the
     # expansion blocks, the disk device 8 serves through the KERNAL traps,
-    # and a true 1541 on the serial bus.
+    # and a true 1541 or 1581 on the serial bus.
     module Attachments
+      include Drive1581::Slot
+
       # The cycle by which a 1541 switched on with the machine has run its
       # DOS's reset, the RAM test and the ROM checksum, and waits on the
       # bus, with a margin: about 1.1 million of the VIC-20's cycles.
@@ -48,7 +50,7 @@ module Badline
 
         cpu.remove_trap(KernalTrap::VIC20_LAYOUT.load)
         cpu.remove_trap(KernalTrap::VIC20_LAYOUT.save)
-        @serial_trap.device = nil
+        @serial_trap.uninstall
         @serial_trap = nil
         @save_trap = nil
         @drive = nil
@@ -75,11 +77,16 @@ module Badline
         @serial_trap&.device = serial_trap_device
       end
 
-      # The true drive on the serial bus: the Drive1541, or nil.
-      def true_drive = @drive1541
+      # The true drive on the serial bus: the Drive1581 ahead of the
+      # Drive1541, or nil.
+      def true_drive = @drive1581 || @drive1541
 
-      # Plugs a Drive1541 in as device 8, and returns it.
-      def plug_true_drive = Drive1541.new.tap { |drive| attach_drive1541(drive) }
+      # Plugs a Drive1541 in as device 8, in place of a 1581 there, and
+      # returns it.
+      def plug_true_drive
+        detach_drive1581 if drive1581_on_device8?
+        Drive1541.new.tap { |drive| attach_drive1541(drive) }
+      end
 
       # Unplugs the Drive1541, leaving the serial bus with nothing on it.
       def detach_drive1541
@@ -102,7 +109,14 @@ module Badline
       # The device number the serial traps answer: device 8, unless a true
       # drive is on the bus as device 8.
       def serial_trap_device
-        @drive1541&.device == KernalTrap::Routine::DEVICE ? nil : KernalTrap::Routine::DEVICE
+        device = KernalTrap::Routine::DEVICE
+        @drive1541&.device == device || drive1581_on_device8? ? nil : device
+      end
+
+      # A 1581 plugged in, as a 1541 does, holds the machine's on_init
+      # handlers back until its DOS has booted.
+      def drive1581_attached
+        @init_threshold = [@init_threshold, Drive1581::BOOT_CYCLES].max if @cycles < @init_threshold
       end
     end
   end

data/lib/badline/vic20/saved_state.rb

@@ -78,6 +78,7 @@ module Badline
         @datasette.save_state(out)
         save_trap_drive(out)
         save_drive1541(out)
+        save_drive1581(out)
       end
 
       def load_state(input)
@@ -99,6 +100,7 @@ module Badline
         @datasette.load_state(input)
         load_trap_drive(input)
         load_drive1541(input)
+        load_drive1581(input)
       end
 
       private

data/lib/badline/vic20.rb

@@ -75,6 +75,7 @@ module Badline
       @save_trap = nil
       @capture_output = nil
       @drive1541 = nil
+      @drive1581 = nil
       @init_threshold = boot_cycles
       wire_ports
     end
@@ -94,6 +95,7 @@ module Badline
       drive_nmi
       @cpu.cycle!
       @drive1541&.host_cycle!
+      @drive1581&.host_cycle!
 
       @cycles += 1
     end
@@ -176,6 +178,7 @@ module Badline
       via_written
       @drive&.reset!
       @drive1541&.reset!
+      @drive1581&.reset!
       @nmi_asserted = false
       @cpu.reset!
     end

data/lib/badline/z80/core.rb

@@ -14,6 +14,7 @@ require "badline/z80/extended_page"
 require "badline/z80/block_transfers"
 require "badline/z80/block_io"
 require "badline/z80/interrupt_acceptance"
+require "badline/z80/saved_state"
 
 module Badline
   class Z80
@@ -42,6 +43,7 @@ module Badline
       include BlockTransfers
       include BlockIO
       include InterruptAcceptance
+      include SavedState
 
       attr_reader :bus, :cycles, :nmi
       attr_accessor :int

data/lib/badline/z80/saved_state.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Badline
+  class Z80
+    # The registers, the T-state count and the interrupt latches for a
+    # snapshot, taken between instructions.
+    module SavedState
+      def save_state(out)
+        out.marker("Z80")
+        out.int(@a).int(@f).int(@b).int(@c).int(@d).int(@e).int(@h).int(@l)
+        out.int(@af_alt).int(@bc_alt).int(@de_alt).int(@hl_alt)
+        out.int(@i).int(@r).int(@pc).int(@sp).int(@ix).int(@iy).int(@wz).int(@q).int(@last_q).int(@im)
+        out.int(@cycles)
+        out.boolean(@iff1).boolean(@iff2).boolean(@halted).boolean(@after_ei).boolean(@after_ld_a_ir)
+        out.boolean(@int).boolean(@nmi).boolean(@nmi_pending)
+      end
+
+      def load_state(input)
+        input.marker("Z80")
+        load_main_registers(input)
+        @af_alt = input.int
+        @bc_alt = input.int
+        @de_alt = input.int
+        @hl_alt = input.int
+        load_special_registers(input)
+        @cycles = input.int
+        load_latches(input)
+        @prefix = 0
+      end
+
+      private
+
+      def load_main_registers(input)
+        @a = input.int
+        @f = input.int
+        @b = input.int
+        @c = input.int
+        @d = input.int
+        @e = input.int
+        @h = input.int
+        @l = input.int
+      end
+
+      def load_special_registers(input)
+        @i = input.int
+        @r = input.int
+        @pc = input.int
+        @sp = input.int
+        @ix = input.int
+        @iy = input.int
+        @wz = input.int
+        @q = input.int
+        @last_q = input.int
+        @im = input.int
+      end
+
+      def load_latches(input)
+        @iff1 = input.boolean?
+        @iff2 = input.boolean?
+        @halted = input.boolean?
+        @after_ei = input.boolean?
+        @after_ld_a_ir = input.boolean?
+        @int = input.boolean?
+        @nmi = input.boolean?
+        @nmi_pending = input.boolean?
+      end
+    end
+  end
+end