ac6502 1.2.0 → 1.4.0

package/src/index.ts

@@ -2,14 +2,17 @@
 
 import figlet from 'figlet'
 import { Machine } from './components/Machine'
-import { Command } from 'commander'
+import { Command, Option } from 'commander'
 import { SerialPort } from 'serialport'
-import { VideoCard } from './components/IO/VideoCard'
-import { StorageCard } from './components/IO/StorageCard'
-import { SoundCard } from './components/IO/SoundCard'
+import { Video } from './components/IO/Video'
+import { Terminal } from './components/IO/Terminal'
+import { Storage } from './components/IO/Storage'
+import { Sound } from './components/IO/Sound'
 import sdl from '@kmamal/sdl'
+import { readFile, writeFile } from 'fs/promises'
+import { existsSync } from 'fs'
 
-const VERSION = '1.2.0'
+const VERSION = '1.4.0'
 const WIDTH = 320
 const HEIGHT = 240
 
@@ -19,7 +22,7 @@ const AUDIO_CHANNELS = 1
 const AUDIO_FORMAT = 'f32'
 const AUDIO_BUFFERED = 2048
 
-// Joystick button bit masks (matching GPIOJoystickAttachment)
+// Joystick button bit masks (matching JoystickAttachment)
 const BUTTON_UP = 0x01
 const BUTTON_DOWN = 0x02
 const BUTTON_LEFT = 0x04
@@ -43,7 +46,7 @@ interface EmulatorOptions {
   stopbits?: string
   port?: string
   storage?: string
-  kim?: boolean
+  target?: string
 }
 
 class Emulator {
@@ -58,7 +61,7 @@ class Emulator {
 
   constructor(options: EmulatorOptions) {
     this.options = options
-    this.machine = new Machine(options.kim ?? false)
+    this.machine = new Machine(options.target ?? 'cob')
     this.controllers = new Map()
     this.joystickButtonStateA = 0x00
     this.joystickButtonStateB = 0x00
@@ -91,21 +94,30 @@ class Emulator {
 
   private async loadBinaries(): Promise<void> {
     if (this.options.rom) {
-      await this.machine.loadROM(this.options.rom)
+      const romData = await readFile(this.options.rom)
+      this.machine.loadROM(new Uint8Array(romData))
       console.log(`Loaded ROM: ${this.options.rom}`)
     } else {
       console.log('Loaded ROM: NONE')
     }
 
     if (this.options.cart) {
-      await this.machine.loadCart(this.options.cart)
+      const cartData = await readFile(this.options.cart)
+      this.machine.loadCart(new Uint8Array(cartData))
       console.log(`Loaded Cart: ${this.options.cart}`)
     } else {
       console.log('Loaded Cart: NONE')
     }
 
-    if (this.options.storage && !this.options.kim) {
-      await (this.machine.io4 as StorageCard).loadFromFile(this.options.storage)
+    if (this.options.storage && this.options.target !== 'kim') {
+      if (existsSync(this.options.storage)) {
+        const storageData = await readFile(this.options.storage)
+        ;(this.machine.io4 as Storage).loadData(new Uint8Array(storageData))
+      } else {
+        console.log(`Storage file not found: ${this.options.storage}`)
+        console.log('A new storage file will be created on exit.')
+        ;(this.machine.io4 as Storage).loadData(null)
+      }
     }
   }
 
@@ -183,7 +195,7 @@ class Emulator {
   }
 
   private setupAudio(): void {
-    if (this.options.kim) return
+    if (this.options.target === 'kim' || this.options.target === 'dev') return
     try {
       this.audioDevice = sdl.audio.openDevice({ type: 'playback' }, {
         channels: AUDIO_CHANNELS as 1,
@@ -192,11 +204,11 @@ class Emulator {
         buffered: AUDIO_BUFFERED,
       })
 
-      // Configure SoundCard sample rate to match audio device
-      ;(this.machine.io7 as SoundCard).sampleRate = this.audioDevice.frequency
+      // Configure Sound sample rate to match audio device
+      ;(this.machine.io7 as Sound).sampleRate = this.audioDevice.frequency
 
       // Connect the Machine's audio callback to the SDL audio device
-      this.machine.pushAudioSamples = (samples: Float32Array) => {
+      this.machine.play = (samples: Float32Array) => {
         if (!this.audioDevice || this.audioDevice.closed) return
 
         const { channels, bytesPerSample } = this.audioDevice
@@ -218,7 +230,7 @@ class Emulator {
   }
 
   private setupWindow(): void {
-    const isKIM = this.options.kim ?? false
+    const isKIM = this.options.target === 'kim'
     const lcd = this.machine.lcdAttachment
 
     // LCD dot-matrix rendering constants
@@ -238,7 +250,7 @@ class Emulator {
     }
 
     this.window = sdl.video.createWindow({
-      title: isKIM ? "6502 Emulator (KIM)" : "6502 Emulator",
+      title: `6502 Emulator (${(this.options.target ?? 'cob').toUpperCase()})`,
       width: windowWidth * this.machine.scale,
       height: windowHeight * this.machine.scale,
       accelerated: true,
@@ -320,11 +332,27 @@ class Emulator {
 
         this.window.render(renderWidth, renderHeight, renderWidth * 4, 'rgba32', rgbaBuffer)
       }
-    } else {
-      const videoCard = this.machine.io8 as VideoCard
+    } else if (this.options.target === 'cob' || this.options.target === 'vcs') {
+      const Video = this.machine.io8 as Video
+      this.machine.render = () => {
+        if (!this.window) { return }
+        this.window.render(WIDTH, HEIGHT, WIDTH * 4, 'rgba32', Video.buffer)
+      }
+    } else if (this.options.target === 'dev') {
+      const devBoard = this.machine.io8 as Terminal
+      const rgbaBuffer = Buffer.alloc(WIDTH * HEIGHT * 4)
       this.machine.render = () => {
         if (!this.window) { return }
-        this.window.render(WIDTH, HEIGHT, WIDTH * 4, 'rgba32', videoCard.buffer)
+        const src = devBoard.vtac.buffer
+        for (let i = 0; i < WIDTH * HEIGHT; i++) {
+          const v = src[i]
+          const off = i * 4
+          rgbaBuffer[off]     = v
+          rgbaBuffer[off + 1] = v
+          rgbaBuffer[off + 2] = v
+          rgbaBuffer[off + 3] = 0xFF
+        }
+        this.window.render(WIDTH, HEIGHT, WIDTH * 4, 'rgba32', rgbaBuffer)
       }
     }
 
@@ -337,7 +365,7 @@ class Emulator {
   }
 
   private setupControllers(): void {
-    if (this.options.kim) return
+    if (this.options.target === 'kim') return
     // Controller device add/remove handlers
     (sdl.controller as any).on('deviceAdd', (device: any) => {
       console.log(`Controller added: ${device.name || device.id}`)
@@ -499,7 +527,6 @@ class Emulator {
         }
       })
     }
-    this.machine.end()
 
     const uptime = Date.now() - this.machine.startTime
 
@@ -513,10 +540,13 @@ class Emulator {
     })
     
     // Save storage data if path was provided
-    if (this.options.storage && !this.options.kim) {
-      (this.machine.io4 as StorageCard).saveToFile(this.options.storage).then(() => {
+    if (this.options.storage && this.options.target !== 'kim') {
+      const storageData = (this.machine.io4 as Storage).getData()
+      writeFile(this.options.storage, storageData).then(() => {
+        console.log(`Storage saved to: ${this.options.storage}`)
         process.exit(0)
-      }).catch(() => {
+      }).catch((error) => {
+        console.error('Error saving storage file:', error)
         process.exit(1)
       })
     } else {
@@ -524,8 +554,8 @@ class Emulator {
     }
   }
 
-  start(): void {
-    this.machine.start()
+  run(): void {
+    this.machine.run()
   }
 }
 
@@ -536,17 +566,17 @@ program
   .description('Emulator for the A.C. Wright 6502 project.')
   .version(VERSION, '-v, --version', 'Output the current emulator version')
   .helpOption('-h, --help', 'Output help / options')
+  .option('-a, --parity <parity>', 'Parity (odd | even | none)', 'none')
+  .option('-b, --baudrate <baudrate>', 'Baud Rate', '9600')
   .option('-c, --cart <path>', 'Path to 32K Cart binary file')
+  .option('-d, --databits <databits>', 'Data Bits (5 | 6 | 7 | 8)', '8')
   .option('-f, --freq <freq>', 'Set the clock frequency in Hz', '1000000')
+  .option('-p, --port <port>', 'Path to the serial port (e.g., /dev/ttyUSB0)')
   .option('-r, --rom <path>', 'Path to 32K ROM binary file')
   .option('-s, --scale <scale>', 'Set the emulator scale', '2')
-  .option('-b, --baudrate <baudrate>', 'Baud Rate', '9600')
-  .option('-a, --parity <parity>', 'Parity (odd | even | none)', 'none')
-  .option('-d, --databits <databits>', 'Data Bits (5 | 6 | 7 | 8)', '8')
-  .option('-t, --stopbits <stopbits>', 'Stop Bits (1 | 1.5 | 2)', '1')
-  .option('-p, --port <port>', 'Path to the serial port (e.g., /dev/ttyUSB0)')
   .option('-S, --storage <path>', 'Path to storage data file for Compact Flash card persistence')
-  .option('-K, --kim', 'Configure IO for the KIM system target', false)
+  .option('-t, --stopbits <stopbits>', 'Stop Bits (1 | 1.5 | 2)', '1')
+  .addOption(new Option('-T, --target <target>', 'System target').choices(['cob', 'vcs', 'kim', 'dev']).default('cob'))
   .addHelpText('beforeAll', figlet.textSync('6502 Emulator', { font: 'cricket' }) + '\n' + `Version: ${VERSION} | A.C. Wright Design\n`)
   .parse(process.argv)
 
@@ -556,7 +586,7 @@ const options = program.opts()
 async function main() {
   const emulator = new Emulator(options)
   await emulator.initialize()
-  emulator.start()
+  emulator.run()
 }
 
 // Run the main function

package/src/lib.ts

@@ -0,0 +1,27 @@
+// Core components
+export { Machine } from './components/Machine'
+export { CPU } from './components/CPU'
+export { RAM } from './components/RAM'
+export { ROM } from './components/ROM'
+export { Cart } from './components/Cart'
+export type { IO } from './components/IO'
+
+// IO cards
+export { Empty } from './components/IO/Empty'
+export { VIA } from './components/IO/VIA'
+export { RAMBank } from './components/IO/RAMBank'
+export { RTC } from './components/IO/RTC'
+export { ACIA } from './components/IO/ACIA'
+export { SIDVoice, Sound } from './components/IO/Sound'
+export { Storage } from './components/IO/Storage'
+export { Video } from './components/IO/Video'
+export { Terminal } from './components/IO/Terminal'
+
+// GPIO attachments
+export type { Attachment } from './components/IO/Attachments/Attachment'
+export { AttachmentBase } from './components/IO/Attachments/Attachment'
+export { JoystickAttachment } from './components/IO/Attachments/JoystickAttachment'
+export { KeyboardEncoderAttachment } from './components/IO/Attachments/KeyboardEncoderAttachment'
+export { KeyboardMatrixAttachment } from './components/IO/Attachments/KeyboardMatrixAttachment'
+export { KeypadAttachment } from './components/IO/Attachments/KeypadAttachment'
+export { LCDAttachment } from './components/IO/Attachments/LCDAttachment'

package/src/tests/IO/{SerialCard.test.ts → ACIA.test.ts}

@@ -1,10 +1,10 @@
-import { SerialCard } from '../../components/IO/SerialCard'
+import { ACIA } from '../../components/IO/ACIA'
 
-describe('SerialCard (6551 ACIA)', () => {
-  let serialCard: SerialCard
+describe('ACIA (6551 ACIA)', () => {
+  let serialCard: ACIA
 
   beforeEach(() => {
-    serialCard = new SerialCard()
+    serialCard = new ACIA()
   })
 
   describe('Initialization', () => {
@@ -399,7 +399,7 @@ describe('SerialCard (6551 ACIA)', () => {
       ]
 
       baudRates.forEach(([code, rate]) => {
-        const card = new SerialCard()
+        const card = new ACIA()
         card.write(0x03, code as number) // Control register with baud rate code
         // Baud rate affects tick timing - verify no errors occur
       })

package/src/tests/IO/{GPIOAttachments/GPIOAttachment.test.ts → Attachments/Attachment.test.ts}

@@ -1,9 +1,9 @@
-import { GPIOAttachment, GPIOAttachmentBase } from '../../../components/IO/GPIOAttachments/GPIOAttachment'
+import { Attachment, AttachmentBase } from '../../../components/IO/Attachments/Attachment'
 
 /**
- * Concrete implementation of GPIOAttachmentBase for testing
+ * Concrete implementation of AttachmentBase for testing
  */
-class TestGPIOAttachment extends GPIOAttachmentBase {
+class TestAttachment extends AttachmentBase {
   public portAValue: number = 0xFF
   public portBValue: number = 0xFF
   public tickCount: number = 0
@@ -62,11 +62,11 @@ class TestGPIOAttachment extends GPIOAttachmentBase {
   }
 }
 
-describe('GPIOAttachmentBase', () => {
-  let attachment: TestGPIOAttachment
+describe('AttachmentBase', () => {
+  let attachment: TestAttachment
 
   beforeEach(() => {
-    attachment = new TestGPIOAttachment()
+    attachment = new TestAttachment()
   })
 
   describe('Initialization', () => {
@@ -75,7 +75,7 @@ describe('GPIOAttachmentBase', () => {
     })
 
     it('should initialize with custom priority', () => {
-      const customAttachment = new TestGPIOAttachment(5)
+      const customAttachment = new TestAttachment(5)
       expect(customAttachment.getPriority()).toBe(5)
     })
 
@@ -91,7 +91,7 @@ describe('GPIOAttachmentBase', () => {
     })
 
     it('should initialize with specified interrupt states', () => {
-      const interruptAttachment = new TestGPIOAttachment(0, true, true, true, true)
+      const interruptAttachment = new TestAttachment(0, true, true, true, true)
       expect(interruptAttachment.hasCA1Interrupt()).toBe(true)
       expect(interruptAttachment.hasCA2Interrupt()).toBe(true)
       expect(interruptAttachment.hasCB1Interrupt()).toBe(true)
@@ -121,7 +121,7 @@ describe('GPIOAttachmentBase', () => {
     })
 
     it('should maintain priority after reset', () => {
-      const priorityAttachment = new TestGPIOAttachment(10)
+      const priorityAttachment = new TestAttachment(10)
       priorityAttachment.reset()
       expect(priorityAttachment.getPriority()).toBe(10)
     })
@@ -129,15 +129,15 @@ describe('GPIOAttachmentBase', () => {
 
   describe('Priority', () => {
     it('should return correct priority value', () => {
-      const lowPriority = new TestGPIOAttachment(0)
-      const highPriority = new TestGPIOAttachment(10)
+      const lowPriority = new TestAttachment(0)
+      const highPriority = new TestAttachment(10)
 
       expect(lowPriority.getPriority()).toBe(0)
       expect(highPriority.getPriority()).toBe(10)
     })
 
     it('should support negative priority values', () => {
-      const negativePriority = new TestGPIOAttachment(-5)
+      const negativePriority = new TestAttachment(-5)
       expect(negativePriority.getPriority()).toBe(-5)
     })
   })

package/src/tests/IO/{GPIOAttachments/GPIOJoystickAttachment.test.ts → Attachments/JoystickAttachment.test.ts}

@@ -1,10 +1,10 @@
-import { GPIOJoystickAttachment } from '../../../components/IO/GPIOAttachments/GPIOJoystickAttachment'
+import { JoystickAttachment } from '../../../components/IO/Attachments/JoystickAttachment'
 
-describe('GPIOJoystickAttachment', () => {
-  let joystick: GPIOJoystickAttachment
+describe('JoystickAttachment', () => {
+  let joystick: JoystickAttachment
 
   beforeEach(() => {
-    joystick = new GPIOJoystickAttachment(true, 0)
+    joystick = new JoystickAttachment(true, 0)
   })
 
   describe('constructor and reset', () => {
@@ -26,20 +26,20 @@ describe('GPIOJoystickAttachment', () => {
     })
 
     it('should check if button is pressed', () => {
-      joystick.pressButton(GPIOJoystickAttachment.BUTTON_A)
-      expect(joystick.isButtonPressed(GPIOJoystickAttachment.BUTTON_A)).toBe(true)
-      expect(joystick.isButtonPressed(GPIOJoystickAttachment.BUTTON_B)).toBe(false)
+      joystick.pressButton(JoystickAttachment.BUTTON_A)
+      expect(joystick.isButtonPressed(JoystickAttachment.BUTTON_A)).toBe(true)
+      expect(joystick.isButtonPressed(JoystickAttachment.BUTTON_B)).toBe(false)
     })
 
     it('should press a button', () => {
-      joystick.pressButton(GPIOJoystickAttachment.BUTTON_START)
-      expect(joystick.getButtonState()).toBe(GPIOJoystickAttachment.BUTTON_START)
+      joystick.pressButton(JoystickAttachment.BUTTON_START)
+      expect(joystick.getButtonState()).toBe(JoystickAttachment.BUTTON_START)
     })
 
     it('should release a button', () => {
       joystick.updateJoystick(0xFF)
-      joystick.releaseButton(GPIOJoystickAttachment.BUTTON_A)
-      expect(joystick.getButtonState()).toBe(0xFF & ~GPIOJoystickAttachment.BUTTON_A)
+      joystick.releaseButton(JoystickAttachment.BUTTON_A)
+      expect(joystick.getButtonState()).toBe(0xFF & ~JoystickAttachment.BUTTON_A)
     })
 
     it('should release all buttons', () => {
@@ -51,7 +51,7 @@ describe('GPIOJoystickAttachment', () => {
 
   describe('port reading - Port A', () => {
     beforeEach(() => {
-      joystick = new GPIOJoystickAttachment(true, 0) // Attach to Port A
+      joystick = new JoystickAttachment(true, 0) // Attach to Port A
     })
 
     it('should return inverted button state on Port A when attached', () => {
@@ -70,7 +70,7 @@ describe('GPIOJoystickAttachment', () => {
     })
 
     it('should handle individual button presses correctly', () => {
-      joystick.updateJoystick(GPIOJoystickAttachment.BUTTON_UP)
+      joystick.updateJoystick(JoystickAttachment.BUTTON_UP)
       const result = joystick.readPortA(0x00, 0x00)
       expect(result & 0x01).toBe(0x00) // UP button bit should be low (pressed)
       expect(result & 0xFE).toBe(0xFE) // Other bits should be high (not pressed)
@@ -79,7 +79,7 @@ describe('GPIOJoystickAttachment', () => {
 
   describe('port reading - Port B', () => {
     beforeEach(() => {
-      joystick = new GPIOJoystickAttachment(false, 0) // Attach to Port B
+      joystick = new JoystickAttachment(false, 0) // Attach to Port B
     })
 
     it('should return inverted button state on Port B when attached', () => {
@@ -100,20 +100,20 @@ describe('GPIOJoystickAttachment', () => {
 
   describe('button constants', () => {
     it('should have correct button bit values', () => {
-      expect(GPIOJoystickAttachment.BUTTON_UP).toBe(0x01)
-      expect(GPIOJoystickAttachment.BUTTON_DOWN).toBe(0x02)
-      expect(GPIOJoystickAttachment.BUTTON_LEFT).toBe(0x04)
-      expect(GPIOJoystickAttachment.BUTTON_RIGHT).toBe(0x08)
-      expect(GPIOJoystickAttachment.BUTTON_A).toBe(0x10)
-      expect(GPIOJoystickAttachment.BUTTON_B).toBe(0x20)
-      expect(GPIOJoystickAttachment.BUTTON_SELECT).toBe(0x40)
-      expect(GPIOJoystickAttachment.BUTTON_START).toBe(0x80)
+      expect(JoystickAttachment.BUTTON_UP).toBe(0x01)
+      expect(JoystickAttachment.BUTTON_DOWN).toBe(0x02)
+      expect(JoystickAttachment.BUTTON_LEFT).toBe(0x04)
+      expect(JoystickAttachment.BUTTON_RIGHT).toBe(0x08)
+      expect(JoystickAttachment.BUTTON_A).toBe(0x10)
+      expect(JoystickAttachment.BUTTON_B).toBe(0x20)
+      expect(JoystickAttachment.BUTTON_SELECT).toBe(0x40)
+      expect(JoystickAttachment.BUTTON_START).toBe(0x80)
     })
   })
 
   describe('priority and enabled', () => {
     it('should return correct priority', () => {
-      const j = new GPIOJoystickAttachment(true, 5)
+      const j = new JoystickAttachment(true, 5)
       expect(j.getPriority()).toBe(5)
     })
 

package/src/tests/IO/{GPIOAttachments/GPIOKeyboardEncoderAttachment.test.ts → Attachments/KeyboardEncoderAttachment.test.ts}

@@ -1,10 +1,10 @@
-import { GPIOKeyboardEncoderAttachment } from '../../../components/IO/GPIOAttachments/GPIOKeyboardEncoderAttachment'
+import { KeyboardEncoderAttachment } from '../../../components/IO/Attachments/KeyboardEncoderAttachment'
 
-describe('GPIOKeyboardEncoderAttachment', () => {
-  let encoder: GPIOKeyboardEncoderAttachment
+describe('KeyboardEncoderAttachment', () => {
+  let encoder: KeyboardEncoderAttachment
 
   beforeEach(() => {
-    encoder = new GPIOKeyboardEncoderAttachment(5)
+    encoder = new KeyboardEncoderAttachment(5)
   })
 
   describe('Initialization', () => {

package/src/tests/IO/{GPIOAttachments/GPIOKeyboardMatrixAttachment.test.ts → Attachments/KeyboardMatrixAttachment.test.ts}

@@ -1,10 +1,10 @@
-import { GPIOKeyboardMatrixAttachment } from '../../../components/IO/GPIOAttachments/GPIOKeyboardMatrixAttachment'
+import { KeyboardMatrixAttachment } from '../../../components/IO/Attachments/KeyboardMatrixAttachment'
 
-describe('GPIOKeyboardMatrixAttachment', () => {
-  let keyboard: GPIOKeyboardMatrixAttachment
+describe('KeyboardMatrixAttachment', () => {
+  let keyboard: KeyboardMatrixAttachment
 
   beforeEach(() => {
-    keyboard = new GPIOKeyboardMatrixAttachment(0)
+    keyboard = new KeyboardMatrixAttachment(0)
   })
 
   describe('Initialization', () => {
@@ -22,7 +22,7 @@ describe('GPIOKeyboardMatrixAttachment', () => {
     })
 
     it('should have correct priority', () => {
-      const kb = new GPIOKeyboardMatrixAttachment(5)
+      const kb = new KeyboardMatrixAttachment(5)
       expect(kb.getPriority()).toBe(5)
     })
   })