Files
CoCo3_Plus_MiSTer/tests/ssc_mister_system_tb.sv
T
bholman cb40fed3b9 Introduce Coco 3 Plus for MiSTer
Add original-firmware Sound & Speech, four configurable Multi-Pak sockets,
bounded per-slot ROM allocation and a nine-page menu organized around devices
and media. Repair inherited clock/reset/CPU-memory/video paths and add explicit
conditional external-I/O timing contracts. Preserve native Main startup-file
ordering, saved layouts, stock-core separation and the coco3plus media profile.

Provide native Windows tool downloads, pinned ToolShed ROM assembly, fresh
Quartus builds, functional and fitted timing checks, reviewed release packaging
and passwordless SSH installation with backups. Retain original component
notices, document contribution copyright and keep SSC ROM inputs outside Git.

Validation: Quartus17.0.2 Build602 seed5, zero errors; 15 functional jobs,
368 both-corner timing scopes and eight tooling-integrity checks pass.
The renamed build reaches Disk BASIC, PRINT1+1 returns2 and SSC loads ready.
Physical cold power cycling and conditional board-delay assumptions remain
separate. Full original upstream histories are preserved before this single
consolidated implementation commit.
2026-11-18 16:00:45 -07:00

93 lines
5.3 KiB
Systemverilog

`timescale 1ns/1ps
module ssc_mister_system_tb;
reg clk=0,pll_lock=0,cpu_ready=0,mode=1,commit=0,rnw=1;
wire power_reset;
actual_ssc_power_reset power_release(clk,pll_lock,power_reset);
always #5 clk=~clk;
reg [15:0] address=16'hff7e;
reg [7:0] data=0,index=0,file_data=0;
reg [24:0] file_address=0;
reg download=0,wr=0;
reg [11:0] mpi_layout={3'd2,3'd1,3'd3,3'd6};
wire ready,fault,read_valid,palette_owner;
wire [7:0] read_data;
wire [15:0] left,right;
actual_ssc_mister_system dut(.clk_sys(clk),.SSC_POWER_RESET(power_reset),.RESET_POS_N(cpu_ready),
.SSC_MODE(mode),.MPI_LAYOUT(mpi_layout),.PH_2(commit),.RW_N(rnw),.ADDRESS(address),.DATA_OUT(data),
.ioctl_download(download),.ioctl_wr(wr),.ioctl_index({8'd0,index}),.ioctl_addr(file_address),.ioctl_data(file_data),
.SOUND_EN(1'b1),.SEL(2'd2),.ORCH_LEFT(8'd128),.ORCH_RIGHT(8'd128),.SOUND(8'd0),
.SSC_READY(ready),.SSC_FAULT(fault),.SOUND_LEFT(left),.SOUND_RIGHT(right),
.READ_VALID(read_valid),.READ_DATA(read_data),.PALETTE_OWNER(palette_owner));
reg [7:0] pic[0:4095],voice[0:2047];
string pic_path,voice_path;
integer fd,n,i,phi=0,commands=0,host_reads=0,audio_changes=0,previous_audio=0,voice_nonzero=0;
always @(posedge clk)if(!power_reset)begin
if(dut.ssc.phi_ce)begin
phi=phi+1;if(phi%50000==0)begin $display("PROGRESS actual MiSTer bindings phi=%0d commands=%0d",phi,commands);$fflush();end
end
if(fault)$fatal(1,"actual MiSTer binding cartridge fault PC=%04x",dut.ssc_debug_pc);
if(dut.ssc.command_read)host_reads=host_reads+1;
if(dut.ssc.speech_valid&&dut.ssc.speech_sample!=0)voice_nonzero=voice_nonzero+1;
if(dut.ssc_audio_valid)begin if(left!=previous_audio)audio_changes=audio_changes+1;previous_audio=left;end
end
task wait_phi(input integer ticks);
integer target;
begin target=phi+ticks;while(phi<target)begin @(posedge clk);#1;end end
endtask
task load(input [7:0] kind,input integer length);
begin
@(negedge clk);#1;index=kind;download=1;
for(i=0;i<length;i=i+1)begin
wr=1;file_address=i;file_data=kind[5:0]==4?pic[i]:voice[i];
@(posedge clk);#1;@(negedge clk);#1;
end
download=0;wr=0;repeat(4)begin @(posedge clk);#1;end
end
endtask
task send(input [7:0] value);
integer deadline;
begin
address=16'hff7e;rnw=1;deadline=phi+89489;
while((!read_valid||!read_data[7])&&phi<deadline)begin @(posedge clk);#1;end
if(!read_valid||!read_data[7])$fatal(1,"actual MiSTer busy timeout command=%0d",commands);
@(posedge clk);#1;address=16'hff7e;data=value;commit=1;rnw=0;
@(negedge clk);#1;@(posedge clk);#1;commit=0;rnw=1;commands=commands+1;
@(negedge clk);#1;
end
endtask
initial begin
if(!$value$plusargs("PIC_PATH=%s",pic_path)||!$value$plusargs("SPEECH_PATH=%s",voice_path))$fatal(1,"missing original ROM paths");
fd=$fopen(pic_path,"rb");n=$fread(pic,fd);$fclose(fd);if(n!=4096)$fatal(1,"PIC length");
fd=$fopen(voice_path,"rb");n=$fread(voice,fd);$fclose(fd);if(n!=2048)$fatal(1,"voice length");
repeat(4)@(posedge clk);@(negedge clk);#1;
if(!power_reset)$fatal(1,"SSC power reset released without PLL lock");
pll_lock=1;@(posedge clk);#1;if(!power_reset)$fatal(1,"SSC power reset released too soon");
@(posedge clk);#1;if(power_reset)$fatal(1,"SSC power reset did not release after two clock edges");
load(8'h44,4096);load(8'h05,2048);
if(!dut.ssc_files_valid||read_data[7])$fatal(1,"MiSTer original-ROM files/reset guard failed");
cpu_ready=1;wait_phi(27000);
if(ready!==1'b1||read_valid!==1'b1||read_data[7]!==1'b1||palette_owner!==1'b0)$fatal(1,"MiSTer boot/read ownership failed");
$display("BOOT actual MiSTer bindings PASS phi=%0d",phi);$fflush();
send(8'h98);send(8'h0f);send(0);send(8'hfa);send(2);send(0);send(0);send(8'hfa);send(0);send(8'hff);send(8'hd8);
wait_phi(45000);
if(audio_changes<20||dut.ssc.ay.registers[8][3:0]==0)$fatal(1,"actual MiSTer tone/audio bindings failed changes=%0d volume=%h left=%h orch=%b mode=%b",audio_changes,dut.ssc.ay.registers[8],left,dut.mpi_orchestra_present,dut.ssc_mode_active);
send("A");send(" ");send(13);
n=phi+268466;
while(voice_nonzero<100&&phi<n)begin @(posedge clk);#1;end
if(voice_nonzero<100||host_reads!=14)$fatal(1,"actual MiSTer speech/command bindings failed reads=%0d speech=%0d",host_reads,voice_nonzero);
@(posedge clk);#1;mode=0;@(negedge clk);#1;
if(read_valid||!palette_owner||left!=16'h8080||right!=16'h8080)$fatal(1,"actual MiSTer palette/legacy-audio restore failed");
repeat(4)begin @(posedge clk);#1;end
if(!dut.ssc_files_valid)$fatal(1,"actual MiSTer mode switch lost ROMs");
// Removing the device restores palette ownership even with the old SSC mode
// bit retained. Reinsert in a different socket; firmware ROMs stay available.
mode=1;mpi_layout=12'd0;repeat(4)begin @(posedge clk);#1;end
if(ready!==1'b0||read_valid!==1'b0||palette_owner!==1'b1)$fatal(1,"Removed SSC still responds");
mpi_layout={3'd4,3'd0,3'd0,3'd5};wait_phi(27000);
if(ready!==1'b1||read_valid!==1'b1||palette_owner!==1'b0||dut.ssc_files_valid!==1'b1)$fatal(1,"Moved SSC did not reboot from retained ROMs");
$display("RESULT {\"passed\":true,\"phi\":%0d,\"host_bytes\":%0d,\"host_reads\":%0d,\"audio_changes\":%0d,\"speech_nonzero\":%0d}",phi,commands,host_reads,audio_changes,voice_nonzero);
$display("PASS actual MiSTer SSC bindings: original HPS ROM files, reset guard, negative-edge CPU writes/status, real RTL tone/speech and legacy ownership/audio restore");$finish;
end
initial begin #400000000;$fatal(1,"actual MiSTer SSC binding watchdog");end
endmodule