badline 0.15.1 → 0.16.1

data/doc/snapshot-format.md

@@ -22,11 +22,11 @@ key only some of them have names them.
 
 ## BL-MACHINE
 
-Written by the C64, VIC-20, C128, Plus/4.
+Written by the C64, VIC-20, C128, Plus/4, PET.
 
 | Key | Type | Default |
 | --- | --- | --- |
-| `family` | text: c64 vic20 c128 plus4 | "c64" |
+| `family` | text: c64 vic20 c128 plus4 pet | "c64" |
 | `region` | text: pal ntsc ntscold drean | C64: "pal" |
 | `vic_model` | text: mos6569 mos8565 mos8566 mos8564 | C64: "mos6569" |
 | `cia_model` | text: mos6526 mos6526a | C64: "mos6526" |
@@ -49,7 +49,7 @@ Written by the C64, VIC-20, C128, Plus/4.
 | `ram` | text: unexpanded 3k 8k 16k 24k 32k all | VIC-20: "unexpanded" |
 | `bus.data` | byte | VIC-20: 253; C128: 255 |
 | `bus.video_data` | byte | VIC-20: 0 |
-| `model` | text: c128 c128ntsc c128dcr c128dcrntsc | C128: "c128"; Plus/4: "plus4" |
+| `model` | text: c128 c128ntsc c128dcr c128dcrntsc | C128: "c128"; Plus/4: "plus4"; PET: "8032" |
 | `mode` | text: c64 c128 | C128: "c64" |
 | `bus.address` | word | C128: 65533 |
 | `clock_bits` | int | C128: 0 |
@@ -61,22 +61,34 @@ Written by the C64, VIC-20, C128, Plus/4.
 | `host.typist.code` | int, optional | C128: absent |
 | `host.typist.wait` | int | C128: 0 |
 | `host.typist.typing` | bool | C128: false |
-| `ram_kb` | int | Plus/4: 64 or 16 |
+| `ram_kb` | int | Plus/4: 64 or 16; PET: 32 or 8 |
 | `sid_card` | text: none mos6581 mos8580 | Plus/4: "none" |
 | `tcbm` | bool | Plus/4: false |
 | `sid_card_address` | int | Plus/4: 64832 |
+| `host.true_drive_model` | text: 1541 1551 | Plus/4: "1551" |
+| `refresh_hz` | int | PET: 50 or 60 |
+| `rom.basic` | text | PET: "pet/basic4.rom" or "pet/basic1.rom" |
+| `rom.editor` | text | PET: "pet/editor4-80-b-50hz.rom" or "pet/editor1.rom" or "pet/editor4-80-b-50hz-8296.rom" |
+| `rom.kernal` | text | PET: "pet/kernal4.rom" or "pet/kernal1.rom" |
+| `rom.characters` | text | PET: "pet/characters2.rom" or "pet/characters1.rom" |
+| `jumpers` | text | PET: "" |
+| `vertical_drive` | bool | PET: true |
 
 ## BL-RAM
 
-Written by the C64, VIC-20, C128, Plus/4.
+Written by the C64, VIC-20, C128, Plus/4, PET.
 
 | Key | Type | Default |
 | --- | --- | --- |
-| `ram` | bytes | C64: 65536 values; VIC-20: 49152 values; C128: 131072 values; Plus/4: 65536 × 0 or 16384 × 0 |
+| `ram` | bytes | C64: 65536 values; VIC-20: 49152 values; C128: 131072 values; Plus/4: 65536 × 0 or 16384 × 0; PET: 32768 × 0 or 8192 × 0 |
 | `bus.low_bank` | int & 0x3 | Plus/4: 0 |
 | `bus.high_bank` | int & 0x3 | Plus/4: 0 |
 | `bus.rom_selected` | bool | Plus/4: true |
-| `bus.data` | byte | Plus/4: 255 |
+| `bus.data` | byte | Plus/4: 255; PET: 253 |
+| `screen` | bytes | PET: 2048 × 0 or 1024 × 0 or 32768 × 0 |
+| `expansion.control` | byte | PET: 0 |
+| `expansion.ram` | bytes | PET: 65536 × 0 |
+| `expansion.user_port` | int | PET: 7 |
 
 ## BL-COLORRAM
 
@@ -89,14 +101,14 @@ Written by the C64, VIC-20, C128.
 
 ## BL-CPU
 
-Written by the C64, C128, Plus/4, VIC-20.
+Written by the C64, C128, Plus/4, VIC-20, PET.
 
 | Key | Type | Default |
 | --- | --- | --- |
 | `port.ddr` | byte | C64: 0; C128: 0; Plus/4: 0 |
 | `port.data` | byte | C64: 0; C128: 0; Plus/4: 0 |
 | `port.floating` | byte | C64: 0; C128: 0 |
-| `pc` | word | C64: 64738; VIC-20: 64802; C128: 65341; Plus/4: 65526 |
+| `pc` | word | C64: 64738; VIC-20: 64802; C128: 65341; Plus/4: 65526; PET: 64790 or 64824 |
 | `sp` | byte | 255 |
 | `a` | byte | 0 |
 | `x` | byte | 0 |
@@ -532,6 +544,7 @@ Written by the C64, VIC-20, Plus/4.
 | `active` | bool | C64: true |
 | `ram` | bytes | C64: 8192 × 0 |
 | `ram<N>.data` | bytes | C64: 8192 × 0 |
+| `name` | text | VIC-20: "" |
 | `roms` | int | VIC-20: 0 |
 | `rom0.bytes` | bytes | VIC-20: [] |
 | `rom0.start` | word | VIC-20: 0 |
@@ -542,11 +555,11 @@ Written by the C64, VIC-20, Plus/4.
 
 ## BL-TRAPDOS
 
-Written by the C64.
+Written by the C64, PET.
 
 | Key | Type | Default |
 | --- | --- | --- |
-| `storage.kind` | text: directory d64 d71 d81 t64 | "directory" |
+| `storage.kind` | text: directory d64 d71 d81 t64 d80 d82 | "directory" |
 | `storage.path` | text | "" |
 | `storage.bytes` | bytes | [] |
 | `storage.read_only` | bool | false |
@@ -562,13 +575,19 @@ Written by the C64.
 | `status.error` | ints | [] |
 | `status.bytes` | bytes | [] |
 | `channels` | ints | [] |
-| `serial.listening` | bool | false |
-| `serial.talking` | bool | false |
-| `serial.listen_channel` | int, optional | absent |
-| `serial.talk_channel` | int, optional | absent |
-| `serial.frame` | int | 240 |
-| `serial.buffer` | bytes | [] |
-| `save.saving` | bool | false |
+| `serial.listening` | bool | C64: false |
+| `serial.talking` | bool | C64: false |
+| `serial.listen_channel` | int, optional | C64: absent |
+| `serial.talk_channel` | int, optional | C64: absent |
+| `serial.frame` | int | C64: 240 |
+| `serial.buffer` | bytes | C64: [] |
+| `save.saving` | bool | C64: false |
+| `ieee.listening` | bool | PET: false |
+| `ieee.talking` | bool | PET: false |
+| `ieee.listen_channel` | int, optional | PET: absent |
+| `ieee.talk_channel` | int, optional | PET: absent |
+| `ieee.frame` | int | PET: 240 |
+| `ieee.buffer` | bytes | PET: [] |
 
 ## BL-D8
 
@@ -1243,3 +1262,181 @@ Written by the Plus/4.
 | `ports` | ints | [0, 0, 0] |
 | `directions` | ints | [0, 0, 0] |
 | `inputs` | ints | [255, 3, 192] |
+
+## BL-PIA1
+
+Written by the PET.
+
+| Key | Type | Default |
+| --- | --- | --- |
+| `ora` | byte | 0 |
+| `orb` | byte | 0 |
+| `ddra` | byte | 0 |
+| `ddrb` | byte | 0 |
+| `ca.control` | int & 0x3f | 0 |
+| `ca.c1_high` | bool | true |
+| `ca.c2_high` | bool | true |
+| `ca.c1_flag` | bool | false |
+| `ca.c2_flag` | bool | false |
+| `ca.handshake_low` | bool | false |
+| `ca.pulse` | int & 0x3 | 0 |
+| `cb.control` | int & 0x3f | 0 |
+| `cb.c1_high` | bool | true |
+| `cb.c2_high` | bool | true |
+| `cb.c1_flag` | bool | false |
+| `cb.c2_flag` | bool | false |
+| `cb.handshake_low` | bool | false |
+| `cb.pulse` | int & 0x3 | 0 |
+
+## BL-PIA2
+
+Written by the PET.
+
+| Key | Type | Default |
+| --- | --- | --- |
+| `ora` | byte | 0 |
+| `orb` | byte | 0 |
+| `ddra` | byte | 0 |
+| `ddrb` | byte | 0 |
+| `ca.control` | int & 0x3f | 0 |
+| `ca.c1_high` | bool | true |
+| `ca.c2_high` | bool | true |
+| `ca.c1_flag` | bool | false |
+| `ca.c2_flag` | bool | false |
+| `ca.handshake_low` | bool | false |
+| `ca.pulse` | int & 0x3 | 0 |
+| `cb.control` | int & 0x3f | 0 |
+| `cb.c1_high` | bool | true |
+| `cb.c2_high` | bool | true |
+| `cb.c1_flag` | bool | false |
+| `cb.c2_flag` | bool | false |
+| `cb.handshake_low` | bool | false |
+| `cb.pulse` | int & 0x3 | 0 |
+
+## BL-VIA
+
+Written by the PET.
+
+| Key | Type | Default |
+| --- | --- | --- |
+| `ora` | byte | 0 |
+| `orb` | byte | 0 |
+| `ddra` | byte | 0 |
+| `ddrb` | byte | 0 |
+| `latch_a` | byte | 255 |
+| `latch_b` | byte | 255 |
+| `acr` | byte | 0 |
+| `pcr` | byte | 0 |
+| `pb6_high` | bool | true |
+| `t<N>.counter` | word | 65535 |
+| `t1.latch` | word | 65535 |
+| `t<N>.hold` | bool | false |
+| `t1.reload` | bool | false |
+| `t<N>.armed` | bool | false |
+| `t1.pb7` | bool | true |
+| `t2.latch_low` | byte | 255 |
+| `t2.low_reload` | bool | false |
+| `t2.low_underflowed` | bool | false |
+| `t2.count_pulses` | bool | false |
+| `t2.counting_pulses` | bool | false |
+| `sr.mode` | int & 0x7 | 0 |
+| `sr.data` | byte | 0 |
+| `sr.bits` | int | 0 |
+| `sr.delay` | int | 0 |
+| `sr.clock` | bool | true |
+| `sr.cb2` | bool | true |
+| `sr.cb2_input` | bool | true |
+| `ifr.flags` | int & 0x7f | 0 |
+| `ifr.enable` | int & 0x7f | 0 |
+| `ca.control` | int & 0xf | 0 |
+| `ca.c1_high` | bool | true |
+| `ca.c2_high` | bool | true |
+| `ca.handshake_low` | bool | false |
+| `ca.pulse` | int | 0 |
+| `ca.c2_output` | bool | true |
+| `cb.control` | int & 0xf | 0 |
+| `cb.c1_high` | bool | true |
+| `cb.c2_high` | bool | true |
+| `cb.handshake_low` | bool | false |
+| `cb.pulse` | int | 0 |
+| `cb.c2_output` | bool | true |
+
+## BL-CRTC
+
+Written by the PET.
+
+| Key | Type | Default |
+| --- | --- | --- |
+| `registers` | bytes | 18 × 0 |
+| `selected` | int & 0x1f | 0 |
+| `column` | byte | 0 |
+| `since_hsync` | int | 0 |
+| `line` | int & 0x1f | 0 |
+| `row` | int & 0x7f | 0 |
+| `vsync_lines` | int | 16 |
+| `adjusting` | bool | false |
+| `row_display` | bool | false |
+| `column_display` | bool | true |
+| `row_start` | int & 0x3fff | 0 |
+| `address` | int & 0x3fff | 0 |
+
+## BL-VIDEO
+
+Written by the PET.
+
+| Key | Type | Default |
+| --- | --- | --- |
+| `displayed` | int | 0 |
+| `frame_displayed` | int | 0 |
+| `line_shown` | bool | false |
+| `y` | int | 136 |
+| `from_y` | int | 136 |
+| `to_y` | int | 136 |
+| `shown_from` | int | 36 |
+| `shown_to` | int | 37 |
+| `on_canvas` | bool | true |
+| `origin` | int | 336 |
+| `from` | int | 704 |
+| `to` | int | -704 |
+| `canvas.dots` | bytes | 192192 × 0 or 83328 × 0 |
+| `canvas.painted` | ints | 48048 × 0 or 20832 × 0 |
+| `canvas.span_from` | ints | 273 × 0 or 217 × 0 |
+| `canvas.span_to` | ints | 273 × 0 or 217 × 0 |
+| `column` | int | 0 |
+| `line` | int | 0 |
+
+## BL-TAPE1
+
+Written by the PET.
+
+| Key | Type | Default |
+| --- | --- | --- |
+| `playing` | bool | false |
+| `motor` | bool | false |
+| `countdown` | int | 0 |
+| `recording` | bool | false |
+| `since` | int | 0 |
+| `write_high` | bool | true |
+| `rise_at` | int | 0 |
+| `low_recorded` | bool | false |
+| `tape.bytes` | bytes | [] |
+| `tape.path` | text | "" |
+| `tape.position` | int | 0 |
+
+## BL-TAPE2
+
+Written by the PET.
+
+| Key | Type | Default |
+| --- | --- | --- |
+| `playing` | bool | false |
+| `motor` | bool | false |
+| `countdown` | int | 0 |
+| `recording` | bool | false |
+| `since` | int | 0 |
+| `write_high` | bool | true |
+| `rise_at` | int | 0 |
+| `low_recorded` | bool | false |
+| `tape.bytes` | bytes | [] |
+| `tape.path` | text | "" |
+| `tape.position` | int | 0 |

data/doc/snapshots.md

@@ -140,6 +140,61 @@ KERNAL and function ROMs come with the model. Its file names its machine
 doesn't open it, and badline doesn't open xplus4's. `--vice` and
 `computer.export_snapshot(path)` refuse a Plus/4.
 
+## The PET
+
+Every PET and CBM model saves and restores the same way. A snapshot of
+one holds its RAM, the screen RAM, or on an 8296 all 32K from `$8000`,
+an 8096's or 8296's 64K board with its control register and the user
+port lines the 8296's RAM follows, both PIAs, the VIA, the CPU, the
+CRTC on the boards that have one, the picture with where the video is
+in its frame, the tapes in both datasettes with their places on them,
+and the disk or directory device 8 serves through the IEEE-488 traps.
+It restores into a machine of the same model with the same RAM, the
+same editor frame rate, the same ROMs, which come with the model, and
+an 8296's same jumpers. Its file names its machine `PET`, as xpet's do,
+and holds only badline's modules, so xpet doesn't open it unless it is
+saved with `--vice` (see [xpet](#xpet)).
+
+### xpet
+
+A PET snapshot saved with `--vice`, or `computer.export_snapshot(path)`,
+also holds xpet's modules for the CPU, the RAM with the screen RAM, or
+an 8296's 32K from `$8000`, an 8096's or 8296's board and its control
+register, the CRTC, both PIAs and the VIA, and the ones xpet 3.10 needs
+to open the file, with nothing open on the file system drive and
+nothing on the user port. The CRTC module carries the discrete boards'
+video too, in xpet's terms. The file says it is in VICE's snapshot
+format 1.0, the only one xpet reads.
+
+xpet 3.10 opens those snapshots as long as its model and editor match:
+`-model 2001`, `3032`, `3032B`, `4032`, `8032`, `8096` or `8296`, and
+for a badline editor other than xpet's own, `-editor` naming badline's
+ROM. xpet's 8296 runs the 8032's editor, 901474-04 dated 0283, so an
+8296 saved for it has to run that editor (`--editor 4-80-b-50hz-0283`),
+and xpet takes the 8296's jumpers from its own settings. It keeps its
+own drives and datasettes and leaves out badline's tapes and disk. Its
+CRTC loses a few lines on opening any snapshot, its own too, so a
+program it runs on from one finds the vertical sync a few hundred
+cycles later than one it ran without stopping.
+
+Snapshots xpet saves open in badline through the same modules: the CPU
+at its instruction boundary, the RAM, the screen RAM, an 8096's or
+8296's board, the CRTC's registers and beam, both PIAs' registers and
+flags, and the VIA's registers, timers and shift register. A program
+badline runs on from xpet's snapshot finds the vertical sync on the
+cycle xpet does, so the two run on alike, cycle for cycle. The picture
+starts again with the next frame. xpet doesn't save its ROMs, which
+keyboard it has or an 8296's jumpers, so the board, the RAM and the
+CRTC's frame build the machine: a 2001, a 3032 for any other discrete
+board, a 4032, an 8032, an 8096 or an 8296 with none of its jumpers
+fitted, at 50 or 60 Hz, and an 8032, 8096 or 8296 whose CRTC lines are
+64 cycles long runs xpet's own 50 Hz editor, 901474-04 dated 0283. A
+SuperPET's snapshot fails. It reports the modules it leaves out, such
+as the drives, the datasettes and the keyboard, and carries on without
+them. Restored into a running PET, an xpet snapshot fails for a PET
+built another way, such as a 3032B, and otherwise switches the machine
+off and on, keeping its tapes and the disk device 8 serves.
+
 ## VICE
 
 Snapshots use VICE's `.vsf` format, and badline's own modules are named

data/lib/badline/c64/common.rb

@@ -10,7 +10,7 @@ module Badline
       def timing
         region = address_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)
+                   lines_per_frame: region.lines_per_frame, crop: region.crop, pixel_width: 1, dots: 1)
       end
 
       def load_prg(data)

data/lib/badline/chips/crtc/keyed_state.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Badline
+  module Chips
+    class CRTC
+      # The CRTC's fields in a keyed snapshot module (Snapshot::Keyed): the
+      # registers, the one selected, and the counters: the character, the
+      # characters since horizontal sync, the line, the row, the lines of
+      # vertical sync left, whether the frame is in its vertical adjust,
+      # whether the row and the character show, and the memory address with
+      # the row's start. The output restores its own state.
+      module KeyedState
+        def save_fields(out)
+          out.bytes("registers", @registers).int("selected", @selected).int("column", @column)
+          out.int("since_hsync", @since_hsync).int("line", @line).int("row", @row).int("vsync_lines", @vsync_lines)
+          out.bool("adjusting", @adjusting).bool("row_display", @row_display).bool("column_display", @column_display)
+          out.int("row_start", @row_start).int("address", @address)
+        end
+
+        def load_fields(input)
+          input.bytes_into("registers", @registers)
+          MASKS.each_with_index { |mask, index| @registers[index] &= mask }
+          @selected = input.masked("selected", @selected, 0x1f)
+          @column = input.byte("column", @column)
+          @since_hsync = input.int("since_hsync", @since_hsync)
+          @line = input.masked("line", @line, 0x1f)
+          @row = input.masked("row", @row, 0x7f)
+          @vsync_lines = input.int("vsync_lines", @vsync_lines)
+          load_flag_fields(input)
+          @row_start = input.masked("row_start", @row_start, 0x3fff)
+          @address = input.masked("address", @address, 0x3fff)
+        end
+
+        private
+
+        def load_flag_fields(input)
+          @adjusting = input.bool("adjusting", @adjusting)
+          @row_display = input.bool("row_display", @row_display)
+          @column_display = input.bool("column_display", @column_display)
+        end
+      end
+
+      include KeyedState
+    end
+  end
+end

data/lib/badline/chips/crtc.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require "badline/chips/crtc/keyed_state"
+
+module Badline
+  module Chips
+    # The MOS 6545 CRTC, as the later PETs drive their screens with: an
+    # address register at even addresses selects one of eighteen registers,
+    # which the odd addresses write. Of them only the light pen's, R16 and
+    # R17, and the cursor address, R14 and R15, read back; every other read
+    # finds 0.
+    #
+    # Its counters run one character a cycle, and compare with the
+    # registers as they stand that cycle, so a write lands from the next
+    # character on:
+    #
+    # - The character counter runs from 0 to R0, then a line ends. The
+    #   display shows from character 0 until the counter equals R1, and
+    #   horizontal sync starts where it equals R2. A compare the counter has
+    #   already passed doesn't happen that line: the display then runs on
+    #   to the line's end.
+    # - The line counter (RA, five bits) counts a character row's lines. A
+    #   row ends after the line where it equals R9; past R9 it runs on to
+    #   31 and wraps.
+    # - The row counter (seven bits) counts rows to R4. R5 more lines of
+    #   vertical adjust follow, then the frame starts again. The display
+    #   stops at the start of the row the counter equals R6, and comes back
+    #   at the next frame; vertical sync starts with row R7 and lasts
+    #   VSYNC_LINES lines.
+    # - The memory address (MA, fourteen bits) starts each frame at
+    #   R12:R13 and counts one a character. Each line starts again from its
+    #   row's start, which the last line of a row moves on to the address
+    #   where the counter equals R1.
+    #
+    # Each displayed character goes to the output's #character with MA, RA
+    # and the characters since horizontal sync last started; the output
+    # also hears of each #hsync as it starts, each #line_end, the
+    # #rows_end where the display stops for the rest of the frame, and each
+    # #frame_start.
+    class CRTC
+      # The bits each register keeps.
+      MASKS = [0xff, 0xff, 0xff, 0xff, 0x7f, 0x1f, 0x7f, 0x7f, 0xff, 0x1f, 0x7f, 0x1f,
+               0x3f, 0xff, 0x3f, 0xff, 0x3f, 0xff].freeze
+
+      VSYNC_LINES = 16
+
+      attr_reader :registers, :column, :line, :row, :address
+
+      # The characters since horizontal sync last started.
+      attr_reader :since_hsync
+
+      # +registers+ is the register file, which the output may read too.
+      def initialize(output, registers: Array.new(MASKS.length, 0))
+        @output = output
+        @registers = registers
+        reset!
+      end
+
+      # The RES pin stops the counters at the start of a frame. The
+      # registers keep their values.
+      def reset!
+        @selected = 0
+        @column = 0
+        @since_hsync = 0
+        @vsync_lines = 0
+        start_frame
+      end
+
+      # Whether vertical sync is on.
+      def vsync? = @vsync_lines.positive?
+
+      # Whether the display shows the character the counters are at.
+      def display? = @row_display && @column_display
+
+      def peek(addr)
+        return 0 if addr.nobits?(0x01) || @selected < 14 || @selected >= MASKS.length
+
+        @registers[@selected]
+      end
+
+      def poke(addr, value)
+        if addr.nobits?(0x01)
+          @selected = value & 0x1f
+        elsif @selected < MASKS.length
+          @registers[@selected] = value & MASKS[@selected]
+        end
+      end
+
+      def cycle!
+        regs = @registers
+        column = @column
+        if column == regs[1]
+          @column_display = false
+          @row_start = @address if @line == regs[9]
+        end
+        @output.character(@address, @line, @since_hsync) if @column_display && @row_display
+        if column == regs[2]
+          @since_hsync = 1
+          @output.hsync
+        else
+          @since_hsync += 1
+        end
+        @address = (@address + 1) & 0x3fff
+        if column == regs[0]
+          @column = 0
+          end_line
+        else
+          @column = (column + 1) & 0xff
+        end
+      end
+
+      private
+
+      def end_line
+        @output.line_end
+        @vsync_lines -= 1 if @vsync_lines.positive?
+        @column_display = true
+        if @adjusting
+          @line += 1
+          @line >= @registers[5] ? start_frame : @address = @row_start
+        elsif @line == @registers[9]
+          end_row
+        else
+          @line = (@line + 1) & 0x1f
+          @address = @row_start
+        end
+      end
+
+      def end_row
+        @line = 0
+        if @row == @registers[4]
+          return start_frame if @registers[5].zero?
+
+          @adjusting = true
+        else
+          @row = (@row + 1) & 0x7f
+          start_row
+        end
+        @address = @row_start
+      end
+
+      def start_frame
+        @line = 0
+        @row = 0
+        @adjusting = false
+        @row_display = true
+        @column_display = true
+        @row_start = ((@registers[12] << 8) | @registers[13]) & 0x3fff
+        @address = @row_start
+        start_row
+        @output.frame_start
+      end
+
+      def start_row
+        if @row == @registers[6] && @row_display
+          @row_display = false
+          @output.rows_end
+        end
+        @vsync_lines = VSYNC_LINES if @row == @registers[7]
+      end
+    end
+  end
+end