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.
This commit is contained in:
bholman committed 2026-11-18 16:00:45 -07:00
1 parent 8b8cf72d1f
commit cb40fed3b9
126 files changed
+12609 -342

No files matched your search

+11
View File
@@ -0,0 +1,11 @@
# Preserve all imported RTL, firmware data and generated records byte-for-byte.
* -text
* whitespace=blank-at-eol,blank-at-eof,space-before-tab,cr-at-eol
*.md text eol=lf
*.py text eol=lf
*.ps1 text eol=lf
*.rbf -text -diff -merge
*.png -text -diff -merge
*.DSK -text -diff -merge
*.bin -text -diff -merge
*.rom -text -diff -merge
+18 -8
View File
@@ -1,13 +1,23 @@
db # Local tools, downloaded sources and generated build/install payloads.
incremental_db /.tools/
output_files /.deps/
/.cache/
/build/
/dist/
# Firmware is obtained separately. Never commit original SSC ROM inputs.
/roms/**
!/roms/README.md
__pycache__/
*.pyc
.DS_Store
Thumbs.db
# Quartus work products stay in build/ copies.
db/
incremental_db/
output_files/
build_id.v build_id.v
c5_pin_model_dump.txt c5_pin_model_dump.txt
jtag.cdf jtag.cdf
*.zip
*.bak *.bak
/*.qws /*.qws
greybox_tmp/cbx_args.txt greybox_tmp/
*/greybox_tmp/cbx_args.txt
changes.txt
rtl/config_inc.sv
+30
View File
@@ -0,0 +1,30 @@
# Coco 3 Plus MiSTer development
Read README.md and docs/VALIDATION.md first. Keep documentation of fixes,
commands, tool versions, artifact hashes and actual test results in the repository.
Distinguish source inspection, simulation, static timing and physical observations.
This repository is the authoritative MiSTer project. Original upstream history,
notices and baseline commit are preserved. Do not refresh snapshots over local
edits. Review upstream changes deliberately. The DE1 research port is separate.
Build in fresh ignored build/ copies with Quartus17.0.2 Build602. Add HDL through
files.qip and the maintained tools/project_inputs.json inventory. Do not upgrade generated IP, widen timing exceptions or change FPGA
source merely to make a test pass. Run meaningful regressions and both-corner
fitted timing checks for relevant changes. A pass under the conditional SDRAM
profile is not a universal electrical qualification.
Keep SSC ROMs and other local binary inputs ignored. Do not commit credentials,
device addresses, private conversations or build caches. Preserve existing
copyright/license notices and state unresolved provenance honestly. Do not claim
independent clean-room implementation after reading source references.
Keep a known-good core and user configuration on the target. Use distinct
bitstreams, checked installation manifests and rollback copies. Do not reimage
cards or program nonvolatile hardware incidentally during core testing. Save
guest work before resetting or reloading. Do not claim a build, installation,
listening check or cold power-cycle that was not observed.
Use native Windows and portable Python tools; do not assume Bash/WSL. Do not
spawn additional agents unless explicitly requested. Commit/push when instructed,
preserving unrelated work and reporting the resulting revision.
+23
View File
@@ -0,0 +1,23 @@
# Consolidated Plus implementation
Based on complete upstream history through
8b8cf72d1fb4de1d05345de8d5b92ec2d500fcd2.
- Added original-firmware Sound & Speech hardware, runtime chip-ROM loading,
readiness/error reporting and exclusive SSC/extended-palette register ownership.
- Added four configurable Multi-Pak sockets, independent routing/banks, singleton
built-in device moves and a bounded shared program-ROM pool.
- Reorganized controls into nine stable VCC Plus-inspired pages while preserving
floppy, SDC/OS9, cassette, audio, video, input, UART and machine functions.
- Repaired clock/reset/phase boundaries, CPU/SDRAM handshakes, video activation
timing and source-matched external-I/O constraints under the documented profile.
- Corrected early remembered-ROM loading and deferred status normalization for
saved non-default layouts with the unmodified MiSTer Main initialization order.
- Added independent Windows tool downloads, ToolShed ROM assembly, fresh native
Quartus builds, functional/fitted timing checks, copyable release overlays and
checked passwordless-SSH installation with rollback.
- Preserved original history/attribution and documented contribution licensing,
assumptions, ROM requirements, test results and remaining physical limits.
See docs/BUG_FIXES.md for causes/checks, docs/FEATURES.md for behavior,
docs/MENUS.md for the complete tree and docs/VALIDATION.md for acceptance scope.
+148
View File
@@ -0,0 +1,148 @@
# Copyright of Plus contributions
Copyright (c) 2026 Brian K. Holman. All rights reserved.
This notice identifies original Coco 3 Plus work and original modifications.
Those contributions are licensed under LICENSES/Coco3Plus-BSD-3-Clause.txt.
It does not claim ownership of inherited code, reference algorithms, extracted
third-party functions, ROMs, generated vendor IP or GNU license texts. Original
copyright and component licenses remain in force; see LICENSING.md and NOTICE.md.
For compiled source kept byte-identical to the qualified build, this file is
the accompanying contribution copyright notice. Existing source headers remain
intact. A file-level listing identifies the contribution scope without replacing
the original author's notice. Line-ending-only changes are not new authorship.
## Modified inherited files
The notice covers only original Plus modifications in these files:
- `.gitignore`
- `CoCo3.qsf`
- `CoCo3.sv`
- `README.md`
- `files.qip`
- `rtl/CoCo3FPGA.sdc`
- `rtl/EE_Cold_Bt.v`
- `rtl/UART_6551/6551rx.v`
- `rtl/UART_6551/uart_6551.v`
- `rtl/coco3fpga.sv`
- `rtl/fdc.sv`
- `rtl/mc6809glb/mc6809glb.v`
- `rtl/sdc.sv`
- `rtl/sdc_top.sv`
- `rtl/sdram/sdram2.sv`
- `sys/i2c.v`
- `sys/mcp23009.sv`
## New project files
The notice covers original Plus portions of the following new files. Derived
SSC algorithms retain the MAME component attribution in rtl/ssc/LICENSE;
references and third-party excerpts retain their own terms.
- `.gitattributes`
- `AGENTS.md`
- `CHANGELOG.md`
- `COPYRIGHT.md`
- `LICENSES/Coco3Plus-BSD-3-Clause.txt`
- `LICENSING.md`
- `NOTICE.md`
- `docs/BUG_FIXES.md`
- `docs/BUILD_WINDOWS.md`
- `docs/FEATURES.md`
- `docs/INSTALL.md`
- `docs/MENUS.md`
- `docs/SD_IMAGE.md`
- `docs/VALIDATION.md`
- `external-io.sdc`
- `reset-cpu.sdc`
- `roms/README.md`
- `rtl/bh_mpi_config.sv`
- `rtl/bh_mpi_rom.sv`
- `rtl/bh_mpi_router.sv`
- `rtl/cpu_sdram_bridge.sv`
- `rtl/ssc/LICENSE`
- `rtl/ssc/ssc_audio.sv`
- `rtl/ssc/ssc_ay8913.sv`
- `rtl/ssc/ssc_cartridge.sv`
- `rtl/ssc/ssc_glue.sv`
- `rtl/ssc/ssc_host.sv`
- `rtl/ssc/ssc_mister_bridge.sv`
- `rtl/ssc/ssc_sp0256.sv`
- `rtl/ssc/ssc_sp0256_memory.sv`
- `rtl/ssc/ssc_sp0256_tables.vh`
- `rtl/ssc/ssc_tms7000.sv`
- `rtl/ssc/ssc_tms7000_alu.sv`
- `rtl/ssc/ssc_tms7000_bcd.sv`
- `rtl/ssc/ssc_tms7000_decode.sv`
- `rtl/ssc/ssc_tms7000_defs.vh`
- `rtl/ssc/ssc_tms7000_exec.sv`
- `rtl/ssc/ssc_tms7000_io.sv`
- `rtl/ssc/ssc_tms7000_memory.sv`
- `rtl/ssc/ssc_tms7000_pacer.sv`
- `scripts/bh_mpi_timing.tcl`
- `scripts/coco3_bh_profile.py`
- `scripts/external_io_timing.tcl`
- `scripts/nmi_timing_paths.tcl`
- `scripts/reset_cpu_timing_paths.tcl`
- `scripts/rom_inputs.py`
- `scripts/run_regressions.py`
- `scripts/source_snapshot.py`
- `scripts/ssc_integrated_timing.tcl`
- `scripts/test_bh_menu.py`
- `scripts/test_bh_mpi.py`
- `scripts/test_bh_mpi_core.py`
- `scripts/test_coco3_bh_startup.py`
- `scripts/test_external_audio.py`
- `scripts/test_external_i2c.py`
- `scripts/test_external_pixel.py`
- `scripts/test_external_sdram.py`
- `scripts/test_external_sdram_commands.py`
- `scripts/test_keyboard_control_phase.py`
- `scripts/test_peripheral_phase.py`
- `scripts/test_registered_interfaces.py`
- `scripts/test_reset_domains.py`
- `scripts/test_ssc_mister_system.py`
- `scripts/test_video_sdram.py`
- `scripts/uart_timing_paths.tcl`
- `scripts/validation_common.py`
- `scripts/video_timing_paths.tcl`
- `tests/bh_mpi_core_tb.sv`
- `tests/bh_mpi_startup_tb.sv`
- `tests/bh_mpi_tb.sv`
- `tests/boot_control_tb.sv`
- `tests/bridge_protocol_tb.sv`
- `tests/completion_phase_tb.sv`
- `tests/cpu_sdram_bridge_tb.sv`
- `tests/disk_buffer_pipeline_tb.sv`
- `tests/external_audio_tb.sv`
- `tests/external_i2c_tb.sv`
- `tests/external_sdram_commands_tb.sv`
- `tests/keyboard_control_phase_tb.sv`
- `tests/peripheral_phase_tb.sv`
- `tests/reset_domains_tb.sv`
- `tests/ssc_mister_system_tb.sv`
- `tests/test_release_guards.py`
- `tests/test_tooling_guards.py`
- `tests/video_sdram_tb.sv`
- `tools/audit_timing.py`
- `tools/bootstrap.py`
- `tools/build_fpga.py`
- `tools/build_roms.py`
- `tools/cocoroms.json`
- `tools/install_mister.py`
- `tools/project_inputs.json`
- `tools/release.py`
- `tools/timing_coverage.py`
- `tools/toolchain.json`
- `uart-reset.sdc`
- `windows/Build-FPGA.ps1`
- `windows/Build-ROMs.ps1`
- `windows/Install-MiSTer.ps1`
- `windows/Package-Release.ps1`
- `windows/Setup-Tools.ps1`
- `windows/Test.ps1`
Copyright notices also accompany synthesized releases through NOTICE.md,
LICENSING.md, this inventory and the original component license texts.
+17 -2
View File
@@ -1,3 +1,5 @@
# Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
# Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
# -------------------------------------------------------------------------- # --------------------------------------------------------------------------
# #
# MiSTer project # MiSTer project
@@ -34,7 +36,7 @@ set_global_assignment -name QII_AUTO_PACKED_REGISTERS NORMAL
set_global_assignment -name ROUTER_LCELL_INSERTION_AND_LOGIC_DUPLICATION ON set_global_assignment -name ROUTER_LCELL_INSERTION_AND_LOGIC_DUPLICATION ON
set_global_assignment -name PHYSICAL_SYNTHESIS_COMBO_LOGIC ON set_global_assignment -name PHYSICAL_SYNTHESIS_COMBO_LOGIC ON
set_global_assignment -name PHYSICAL_SYNTHESIS_REGISTER_DUPLICATION ON set_global_assignment -name PHYSICAL_SYNTHESIS_REGISTER_DUPLICATION ON
set_global_assignment -name PHYSICAL_SYNTHESIS_REGISTER_RETIMING ON set_global_assignment -name PHYSICAL_SYNTHESIS_REGISTER_RETIMING OFF
set_global_assignment -name OPTIMIZATION_TECHNIQUE SPEED set_global_assignment -name OPTIMIZATION_TECHNIQUE SPEED
set_global_assignment -name MUX_RESTRUCTURE ON set_global_assignment -name MUX_RESTRUCTURE ON
set_global_assignment -name REMOVE_REDUNDANT_LOGIC_CELLS ON set_global_assignment -name REMOVE_REDUNDANT_LOGIC_CELLS ON
@@ -48,7 +50,8 @@ set_global_assignment -name ECO_OPTIMIZE_TIMING ON
set_global_assignment -name PERIPHERY_TO_CORE_PLACEMENT_AND_ROUTING_OPTIMIZATION ON set_global_assignment -name PERIPHERY_TO_CORE_PLACEMENT_AND_ROUTING_OPTIMIZATION ON
set_global_assignment -name PHYSICAL_SYNTHESIS_ASYNCHRONOUS_SIGNAL_PIPELINING ON set_global_assignment -name PHYSICAL_SYNTHESIS_ASYNCHRONOUS_SIGNAL_PIPELINING ON
set_global_assignment -name ALM_REGISTER_PACKING_EFFORT MEDIUM set_global_assignment -name ALM_REGISTER_PACKING_EFFORT MEDIUM
set_global_assignment -name SEED 1 # Reproducible SSC candidate placement; no timing exception or protocol change.
set_global_assignment -name SEED 5
#set_global_assignment -name VERILOG_MACRO "MISTER_FB=1" #set_global_assignment -name VERILOG_MACRO "MISTER_FB=1"
@@ -178,3 +181,15 @@ set_global_assignment -name SLD_NODE_PARAMETER_ASSIGNMENT "SLD_TRIGGER_LEVEL_PIP
set_global_assignment -name SLD_NODE_PARAMETER_ASSIGNMENT "SLD_ENABLE_ADVANCED_TRIGGER=0" -section_id Video1 set_global_assignment -name SLD_NODE_PARAMETER_ASSIGNMENT "SLD_ENABLE_ADVANCED_TRIGGER=0" -section_id Video1
set_global_assignment -name SLD_FILE db/Video1_auto_stripped.stp set_global_assignment -name SLD_FILE db/Video1_auto_stripped.stp
set_instance_assignment -name PARTITION_HIERARCHY root_partition -to | -section_id Top set_instance_assignment -name PARTITION_HIERARCHY root_partition -to | -section_id Top
set_global_assignment -name SDC_FILE uart-reset.sdc
# Research: low-skew routing for the high-fanout synchronous release.
set_instance_assignment -name GLOBAL_SIGNAL GLOBAL_CLOCK -to "emu|coco3|reset_main_release[1]"
set_instance_assignment -name MAX_FANOUT 8 -to "emu|cpu_memory_boundary|memory_req"
set_instance_assignment -name MAX_FANOUT 4 -to "emu|coco3|GLBCPU09|InstPage3"
set_global_assignment -name NUM_PARALLEL_PROCESSORS 1
set_global_assignment -name SDC_FILE reset-cpu.sdc
set_global_assignment -name SDC_FILE external-io.sdc
# Physical clock-output delay, not a timing waiver. Verify D5=16 in the fitted
# Delay Chain Summary and slow/fast read setup+hold before accepting an image.
set_instance_assignment -name D5_DELAY 16 -to SDRAM_CLK
+155 -83
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
//============================================================================ //============================================================================
// CoCo3 port to MiSTer // CoCo3 port to MiSTer
// Copyright (c) 2019 Alan Steremberg - alanswx, Stan Hodge - MasterS3263827 // Copyright (c) 2019 Alan Steremberg - alanswx, Stan Hodge - MasterS3263827
@@ -196,67 +198,77 @@ assign VIDEO_ARY = (!ar) ? 12'd3 : 12'd0;
`include "build_id_num.v" `include "build_id_num.v"
localparam CONF_STR = { localparam CONF_STR = {
"COCO3;UART19200:9600:4800:2400:1200:300;", "Coco 3 Plus;UART19200:9600:4800:2400:1200:300;",
"-;", // Native remembered-file records are deliberately independent of pages.
"OCD,Multi-Pak,(Slot 2) CoCoSDC,(Slot3) ECB /Cart,(Slot 4) Disk;", "H0FC1,CCCROMBIN,Legacy cartridge;",
"H3-;", "H4FC4,BINROM,Load SSC controller (4K);",
"H3S2,DSK,Load Disk Drive 0;", "H4FC5,BINROM,Load SSC voice (2K);",
"H3S3,DSK,Load Disk Drive 1;", "P1,Cartridges & Multi-Pak;",
"H3S4,DSK,Load Disk Drive 2;", "P1OCD,Startup slot,Slot 1,Slot 2,Slot 3,Slot 4;",
"H3S5,DSK,Load Disk Drive 3;", "P1-,Built-in devices move slots;",
"H2-;", "P1-,Changes restart the CoCo;",
"H2F1,CCC,Load Cartridge;", "P1oBD,Slot 1,Empty,ROM file,Floppy,CoCo SDC,Sound & Speech,Orchestra90,Audio expansions,RS232;",
"H1-;", "H8P1FC6,CCCROMBIN,Slot 1 ROM;",
"H1S0,DSKVHD,Load SDC Drive 0;", "P1oEG,Slot 2,Empty,ROM file,Floppy,CoCo SDC,Sound & Speech,Orchestra90,Audio expansions,RS232;",
"H1S1,DSKVHD,Load SDC Drive 1;", "H9P1FC7,CCCROMBIN,Slot 2 ROM;",
"H1-;", "P1oHJ,Slot 3,Empty,ROM file,Floppy,CoCo SDC,Sound & Speech,Orchestra90,Audio expansions,RS232;",
"H1S2,DSK,Load OS9 Floppy /d0;", "HAP1FC8,CCCROMBIN,Slot 3 ROM;",
"H1S3,DSK,Load OS9 Floppy /d1;", "P1oKM,Slot 4,Empty,ROM file,Floppy,CoCo SDC,Sound & Speech,Orchestra90,Audio expansions,RS232;",
"H1S4,DSK,Load OS9 Floppy /d3;", "HBP1FC9,CCCROMBIN,Slot 4 ROM;",
"H1S5,DSK,Load OS9 Floppy /d4;", "P1-,ROM pool: 256K total;",
"-;", "P1-,Max ROM: 128K per slot;",
"HCP1-,ROM load error: size/full;",
"F2,CAS,Load Cassette;", "P2,Floppy Disks;",
"TF,Stop & Rewind;", "P2-,Media follows controller;",
"OH,Monitor Tape Sound,No,Yes;", "D3P2S2,DSK,Drive 0;",
"-;", "D3P2S3,DSK,Drive 1;",
"S6,CAS,Save Cassette;", "D3P2S4,DSK,Drive 2;",
"OE,Cass Rwd=0 / Rec=1,0,1;", "D3P2S5,DSK,Drive 3;",
"-;", "P3,CoCo SDC;",
"D1P3S0,DSKVHD,SDC Drive 0;",
"P1,Video Settings;", "D1P3S1,DSKVHD,SDC Drive 1;",
"P1-;", "P3-,OS9 floppy mounts;",
"P1-, -= Video Settings =-;", "D1P3S2,DSK,OS9 Floppy /d0;",
"P1-;", "D1P3S3,DSK,OS9 Floppy /d1;",
"P1O89,Aspect ratio,Original,Full Screen,Wide,[ARC1];", "D1P3S4,DSK,OS9 Floppy /d3;",
"P1O35,Scandoubler Fx,None,HQ2x,CRT 25%,CRT 50%,CRT 75%;", "D1P3S5,DSK,OS9 Floppy /d4;",
"P1-;", "P4,Sound & Expansion;",
"P1OL,CoCo3 LC,Yes,No-(SG6=Yes);", "DDP4oA,Expansion,Extended palette,Sound & Speech;",
"P1-;", "hDP4-,Assign SSC in Multi-Pak;",
"P1o56,Artifact Type,MESS,Simple,NONE;", "H5P4-,Sound & Speech not ready;",
"P1OI,Artifact Color Set,0,1;", "H6P4-,Sound & Speech ready;",
"-;", "H7P4-,Sound & Speech error;",
"P2,Debug Menu;", "HFP4-,Orchestra90 stereo enabled;",
"P2-;", "P4-,Audio = SSC + Orchestra90;",
"P2-, -= Debug Menu =-;", "P5,Cassette;",
"P2-;", "P5F2,CAS,Load Cassette;",
"P2F3,BIN,Load COCO Font;", "P5TF,Stop & Rewind;",
"P2OG,Swap MiSTer Uart,RS CART,Default;", "P5OH,Monitor Tape Sound,No,Yes;",
"P2OU,Swap Uart to IO,RS IO,MiSTer;", "P5S6,CAS,Save Cassette;",
"P2OT,Display Debug,Off,On;", "P5OE,Transport,Playback / Rewind,Record;",
"-;", "P6,Machine;",
"ON,D-Pad Joystick emu,No,Yes;", "P6OPR,Memory Size,512K,1M,2M,16M;",
"O6,Swap Joysticks,Off,On;", "P6OO,Force Turbo,No,Yes;",
"OS,Use Mouse for Rt Joystk,Off,On;", "P6o02,Turbo Speed,CoCo Ctrl,0.89 MHz,1.78 MHz,2.86 MHz,3.58 MHz,7.16 MHz,9.54 MHz;",
"RA,Easter Egg;", "P6o89,Auto Run,Off,DOS,AUTO.BAS;",
"-;", "P6RM,Cold Boot;",
"OO,Force Turbo,No,Yes;", "P6R0,Reset;",
"o02,Turbo Speed,CoCo Ctrl, 0.89 Mhz,1.78 Mhz,2.86 Mhz, 3.58 Mhz,7.16 Mhz,9.54 Mhz;", "P7,Display;",
"OPR,Memory Size,512K,1M,2M,16M;", "P7O89,Aspect ratio,Original,Full Screen,Wide,[ARC1];",
"o89,Auto Run,No,DOS,AUTO.BAS;", "P7O35,Scandoubler Fx,None,HQ2x,CRT 25%,CRT 50%,CRT 75%;",
"-;", "P7OL,CoCo3 LC,Yes,No-(SG6=Yes);",
"RM,Cold Boot;", "P7o56,Artifact Type,MESS,Simple,NONE;",
"R0,Reset;", "P7OI,Artifact Color Set,0,1;",
"P8,Input;",
"P8ON,D-Pad Joystick emu,No,Yes;",
"P8O6,Swap Joysticks,Off,On;",
"P8OS,Mouse as right joystick,Off,On;",
"P9,Advanced;",
"P9F3,BIN,Load COCO Font;",
"P9OG,Swap MiSTer Uart,RS CART,Default;",
"P9OU,Swap Uart to IO,RS IO,MiSTer;",
"P9OT,Display Debug,Off,On;",
"P9RA,Easter Egg;",
"J,Button1,Button2;", "J,Button1,Button2;",
"jn,A,B;", "jn,A,B;",
"v,51;", "v,51;",
@@ -282,7 +294,7 @@ wire clk_sys;
assign clk_sys=CLK_57; assign clk_sys=CLK_57;
wire pll_locked, pll2_locked; wire pll2_locked;
wire CLK_114, CLK_57, CLK_28, CLK_14; wire CLK_114, CLK_57, CLK_28, CLK_14;
assign VGA_DISABLE = 1'b0; assign VGA_DISABLE = 1'b0;
@@ -298,10 +310,37 @@ pll pll
.locked(pll2_locked) .locked(pll2_locked)
); );
// Cartridge ROM validity is cleared only by loss of the actual core PLL lock.
// Release synchronously after two system-clock edges, independent of CoCo reset.
(* preserve, altera_attribute = "-name SYNCHRONIZER_IDENTIFICATION FORCED_IF_ASYNCHRONOUS" *)
reg [1:0] ssc_power_release = 2'b00;
always @(posedge clk_sys or negedge pll2_locked)
if(!pll2_locked) ssc_power_release <= 2'b00;
else ssc_power_release <= {ssc_power_release[0],1'b1};
wire ssc_power_reset = !ssc_power_release[1];
/////////////////////////////////////////////////// ///////////////////////////////////////////////////
wire [63:0] status; wire [63:0] status_raw;
wire [63:0] status_in = 63'd0; reg [63:0] status = 64'd0;
wire [63:0] status_accepted;
bh_mpi_config mpi_configuration(.clk(clk_sys),.reset(ssc_power_reset),
.requested(status_raw),.accepted(status_accepted),
.status_in(status_in),.status_set(status_set));
always @(negedge clk_sys) status <= status_accepted;
wire [11:0] mpi_layout=status[54:43];
wire [3:0] mpi_rom_fault;
wire mpi_rom_loading,mpi_rom_loaded;
wire [2:0] menu_rom_kind,menu_io_kind;
wire menu_ssc,menu_orchestra,menu_floppy,menu_sdc;
bh_mpi_router menu_devices(.layout(mpi_layout),.cts(status[13:12]),.scs(status[13:12]),
.rom_kind(menu_rom_kind),.io_kind(menu_io_kind),.floppy_io(),.sdc_io(),.rom_io(),.serial_io(),
.ssc_present(menu_ssc),.orchestra_present(menu_orchestra),
.floppy_present(menu_floppy),.sdc_present(menu_sdc));
function rom_picker_hidden(input [2:0] kind);
begin rom_picker_hidden=!(kind==1||kind==5||kind==6);end
endfunction
wire [63:0] status_in;
wire status_set; wire status_set;
wire [1:0] buttons; wire [1:0] buttons;
@@ -335,11 +374,18 @@ hps_io #(.CONF_STR(CONF_STR),.PS2DIV(2400), .VDNUM(7), .BLKSZ(2)) hps_io
.buttons(buttons), .buttons(buttons),
.status(status), .status(status_raw),
.status_in(status_in), .status_in(status_in),
.status_set(status_set), .status_set(status_set),
.status_menumask({ ~(mpi == 2'b11), ~(mpi == 2'b10),~(mpi == 2'b01), 1'b1}), .status_menumask({!menu_orchestra,1'b0,!menu_ssc,!(|mpi_rom_fault),
rom_picker_hidden(mpi_layout[11:9]),
rom_picker_hidden(mpi_layout[8:6]),
rom_picker_hidden(mpi_layout[5:3]),
rom_picker_hidden(mpi_layout[2:0]),
!status[42]||!ssc_fault,!status[42]||!ssc_ready,
!status[42]||ssc_ready,1'b1,
!menu_floppy,1'b0,!menu_sdc,1'b1}),
.forced_scandoubler(forced_scandoubler), .forced_scandoubler(forced_scandoubler),
.RTC(RTC), .RTC(RTC),
.gamma_bus(gamma_bus), .gamma_bus(gamma_bus),
@@ -411,11 +457,15 @@ wire [9:0] center_joystick_y2 = 8'd128 + joya2[15:8];
wire [9:0] center_joystick_x2 = 8'd128 + joya2[7:0]; wire [9:0] center_joystick_x2 = 8'd128 + joya2[7:0];
wire vclk; wire vclk;
wire [31:0] coco_joy1 = status[6] ? joy2 : joy1; reg [31:0] coco_joy1 = 0;
wire [31:0] coco_joy2 = status[6] ? joy1 : joy2; always @(negedge clk_sys) coco_joy1 <= status[6] ? joy2 : joy1;
reg [31:0] coco_joy2 = 0;
always @(negedge clk_sys) coco_joy2 <= status[6] ? joy1 : joy2;
wire [15:0] coco_ajoy1 = status[6] ? {center_joystick_x2[7:0],center_joystick_y2[7:0]} : {center_joystick_x1[7:0],center_joystick_y1[7:0]}; reg [15:0] coco_ajoy1 = 0;
wire [15:0] coco_ajoy2 = status[6] ? {center_joystick_x1[7:0],center_joystick_y1[7:0]} : {center_joystick_x2[7:0],center_joystick_y2[7:0]}; always @(negedge clk_sys) coco_ajoy1 <= status[6] ? {center_joystick_x2[7:0],center_joystick_y2[7:0]} : {center_joystick_x1[7:0],center_joystick_y1[7:0]};
reg [15:0] coco_ajoy2 = 0;
always @(negedge clk_sys) coco_ajoy2 <= status[6] ? {center_joystick_x1[7:0],center_joystick_y1[7:0]} : {center_joystick_x2[7:0],center_joystick_y2[7:0]};
@@ -478,6 +528,7 @@ EE_Cold_Bt COCO3_EE_Cold_Bt (
wire [15:0] audio_left; wire [15:0] audio_left;
wire ssc_ready,ssc_fault;
assign AUDIO_L = { audio_left[15:14], audio_left[13] ^ (status[17] ? casdout : 1'b0),audio_left[12:0]}; assign AUDIO_L = { audio_left[15:14], audio_left[13] ^ (status[17] ? casdout : 1'b0),audio_left[12:0]};
//assign AUDIO_R = AUDIO_L; //assign AUDIO_R = AUDIO_L;
assign AUDIO_S = 0; assign AUDIO_S = 0;
@@ -507,8 +558,15 @@ coco3fpga coco3 (
.CLK_28(CLK_28), .CLK_28(CLK_28),
.CLK_14(CLK_14), .CLK_14(CLK_14),
.SSC_POWER_RESET(ssc_power_reset),
.SSC_MODE(status[42]),
.MPI_LAYOUT(mpi_layout),.MPI_BOOT_LOADING(status[0]),.MPI_ROM_FAULT(mpi_rom_fault),
.MPI_ROM_LOADING(mpi_rom_loading),.MPI_ROM_LOADED(mpi_rom_loaded),
.SSC_READY(ssc_ready),
.SSC_FAULT(ssc_fault),
// Reset // Reset
.COCO_RESET_N((~reset & Programmed_RESET_N)), .COCO_RESET_N((~reset & Programmed_RESET_N) && !mpi_rom_loading),
.RED_O(r), .RED_O(r),
.GREEN_O(g), .GREEN_O(g),
@@ -577,7 +635,7 @@ coco3fpga coco3 (
.PROBE_O(probe_o), .PROBE_O(probe_o),
.PROBE_I(probe_i), .PROBE_I(probe_i),
.clk_Q_out(clk_Q_out), .clk_Q_out(clk_Q_out),
.casdout( casdout), .casdout( cassette_cpu_sample),
.cas_relay(cas_relay), .cas_relay(cas_relay),
// SDRAM // SDRAM
@@ -602,7 +660,7 @@ coco3fpga coco3 (
.RTC(RTC), .RTC(RTC),
.AMW_Trigger(coldboot | mpi_reset | mem_reset), .AMW_Trigger(coldboot | mpi_reset | mem_reset | mpi_rom_loaded),
// .AMW_Trigger(coldboot), // .AMW_Trigger(coldboot),
.AMW_ACK(AMW_ACK), .AMW_ACK(AMW_ACK),
@@ -623,7 +681,7 @@ coco3fpga coco3 (
.UART_DSR(UART_DSR) .UART_DSR(UART_DSR)
); );
assign status_set = 1'b0; // status_set is driven by the versioned layout/status normalizer.
//wire [5:0] cocosound; //wire [5:0] cocosound;
@@ -636,7 +694,7 @@ wire AMW_ACK;
//wire cpu_speed = status[11]; //wire cpu_speed = status[11];
wire [1:0] mpi = status[13:12] + 1'b1; wire [1:0] mpi = status[13:12];
//wire video=status[14]; //wire video=status[14];
wire CASS_REW_RECORD=status[14]; wire CASS_REW_RECORD=status[14];
wire rs_swap=status[16]; wire rs_swap=status[16];
@@ -652,16 +710,16 @@ wire SWAP_M_J = status[28];
wire display_debug = status[29]; wire display_debug = status[29];
wire UART_INPUT = status[30]; wire UART_INPUT = status[30];
wire digitalJoy = status[23]; wire digitalJoy = status[23];
reg [2:0] mpi_d = 2'b00; reg [13:0] mpi_d=14'd0;
reg first_mpi_chg = 1'b0; reg first_mpi_chg = 1'b0;
reg mpi_reset = 1'b0; reg mpi_reset = 1'b0;
always @ (negedge CLK_14) always @ (negedge CLK_14)
begin begin
mpi_d <= mpi; mpi_d <= {mpi_layout,mpi};
mpi_reset <= 1'b0; mpi_reset <= 1'b0;
if (~(mpi == mpi_d)) if (~({mpi_layout,mpi} == mpi_d))
if (~first_mpi_chg) if (~first_mpi_chg)
first_mpi_chg <= 1'b1; first_mpi_chg <= 1'b1;
else else
@@ -709,18 +767,30 @@ wire sdram_vid_ready;
wire sdram_busy; wire sdram_busy;
// Research: decoded request payload is captured before the fast controller.
wire [24:0] bridge_addr;
wire [7:0] bridge_din;
wire bridge_req, bridge_rnw, bridge_ack;
cpu_sdram_bridge cpu_memory_boundary (
.clk(clk_sys), .fast_clk(CLK_114), .reset(reset), .cpu_addr(sdram_cpu_addr),
.cpu_din(sdram_cpu_din), .cpu_req(sdram_cpu_req), .cpu_rnw(sdram_cpu_rnw),
.memory_ack(bridge_ack), .cpu_ack(sdram_cpu_ack),
.memory_addr(bridge_addr), .memory_din(bridge_din),
.memory_req(bridge_req), .memory_rnw(bridge_rnw)
);
sdram_32r8w coco3_sdram sdram_32r8w coco3_sdram
( (
.*, .*,
.init(reset), .init(reset),
.clk(CLK_114), .clk(CLK_114),
.sdram_cpu_addr(sdram_cpu_addr[24:0]), .sdram_cpu_addr(bridge_addr),
// .sdram_ldout(sdram_ldout), // .sdram_ldout(sdram_ldout),
.sdram_dout(sdram_dout), .sdram_dout(sdram_dout),
.sdram_cpu_din(sdram_cpu_din), .sdram_cpu_din(bridge_din),
.sdram_cpu_req(sdram_cpu_req), .sdram_cpu_req(bridge_req),
.sdram_cpu_rnw(sdram_cpu_rnw), .sdram_cpu_rnw(bridge_rnw),
.sdram_cpu_ack(sdram_cpu_ack), .sdram_cpu_ack(bridge_ack),
.sdram_cpu_ready(sdram_cpu_ready), .sdram_cpu_ready(sdram_cpu_ready),
.sdram_vid_addr(sdram_vid_addr[24:0]), .sdram_vid_addr(sdram_vid_addr[24:0]),
@@ -733,6 +803,8 @@ sdram_32r8w coco3_sdram
wire casdout; wire casdout;
reg cassette_cpu_sample = 1'b0;
always @(negedge clk_sys) cassette_cpu_sample <= casdout;
wire cas_relay; wire cas_relay;
wire load_tape = ioctl_index == 2; wire load_tape = ioctl_index == 2;
+28
View File
@@ -0,0 +1,28 @@
BSD 3-Clause License
Copyright (c) 2026 Brian K. Holman
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
+340
View File
@@ -0,0 +1,340 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
+674
View File
@@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+53
View File
@@ -0,0 +1,53 @@
# Component licenses and distribution
This is a mixed-license derivative. Original file notices remain authoritative;
this document does not relicense third-party code, ROMs or Intel/Altera IP.
New original Plus work and modifications are copyright (c) 2026 Brian K. Holman;
the precise scope is recorded in COPYRIGHT.md. Those original contributions are
available under LICENSES/Coco3Plus-BSD-3-Clause.txt, subject to the original
licenses of any combined or derived material.
## Inherited and derived source
| Component | Inspected source notice |
|---|---|
| Core/video and related Gary Becker material | BSD-style source and synthesized-form redistribution conditions, including notice/disclaimer retention and no endorsement. See individual headers. |
| MiSTer HPS interface, SDRAM controller and John Kent CPU variants | GPL version 3 or later in the applicable headers. SDRAM modifications also retain Stan Hodge/Sorgelig provenance. |
| Other MiSTer framework helpers | File-specific terms; some GPL version 2 or later. Keep each header, not a single inferred replacement license. |
| New SSC controller/speech/wiring derived from reference models | BSD-3-Clause; retain rtl/ssc/LICENSE and component attribution to Tim Lindner, Joseph Zbiciak and hap. |
| New MPI and original Plus helpers/tests/tooling | BSD-3-Clause for original contributions, with preserved reference-source terms where extracted code is involved. |
| Generated Intel/Altera IP and device primitives | Their original vendor notices/terms; a project-level BSD/GPL declaration does not replace these. |
| Greg Miller mc6809glb CPU | Original copyright-only header retained. No explicit upstream license grant found in that file. See assumption below. |
For a combined distribution containing GPL-covered material, retain the applicable
GPL terms and provide the corresponding source, build scripts and notices as
required by those licenses. A bitstream-only release must not omit the source
and license obligations that apply to its components. See the original
[GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.html),
[GNU GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) and file headers.
This repository's permissive contribution license is not a blanket assertion
that the complete synthesized design is BSD-only.
## Maintainer assumption: Greg Miller CPU
The Coco 3 Plus FPGA Maintainer currently proceeds on the assumption that Greg
Miller's original CPU implementation is public domain. This is a **maintainer
assumption, not a confirmed upstream dedication or permission grant**. The
original copyright notice remains in rtl/mc6809glb/mc6809glb.v. If contrary or
clarifying information is received, amend this notice and distribution practice.
New Plus modifications are identified separately; this assumption does not
erase another author's rights or claim their work as original Plus code.
## ROMs, software libraries and external tools
SSC ROMs are external user-supplied inputs and are ignored by Git. The public
setup script does not fetch them. ToolShed cocoroms assembly is downloaded at a
pinned revision with original source notices retained; reproducible assembly is
not proof of blanket ROM redistribution permission. Included diagnostic/game
media require their own terms. Do not publish a library or a locally complete
release overlay merely because it was useful for private validation.
LWTOOLS, OSS CAD Suite, Quartus and MiSTer Linux/Main/Mr. Fusion have separate
licenses. Downloading or invoking those tools does not transfer their copyright
to this project. A future standalone image must preserve its operating-system,
bootloader and image-builder notices/source obligations in addition to the core's.
+29
View File
@@ -0,0 +1,29 @@
# Attribution
Original Coco 3 Plus contributions and modifications:
**Copyright (c) 2026 Brian K. Holman.** See COPYRIGHT.md and LICENSING.md.
This project derives from MiSTer-devel/CoCo3_MiSTer, the MiSTer port of Gary
Becker's CoCo3FPGA by Stan Hodge, Gary Becker and Alan Steremberg. Original
histories and source notices are retained. CPU implementations credit Greg
Miller and John E. Kent in their respective source files. MiSTer framework work
retains attribution including Alexey Melnikov (Sorgelig), Till Harbaum and other
file-specific contributors.
The inherited extended-color/video implementation is credited to its existing
CoCo3FPGA/MiSTer authors and headers; no new invention claim is made for that
feature. The source also credits Brandan Donahe for the MESS artifact function.
Plus adds selectable ownership and integration while preserving the inherited
extended-palette logic.
SSC chip/wiring work uses the public algorithms and source models credited to
Tim Lindner, Joseph Zbiciak and hap through MAME and VCC Plus references. See
rtl/ssc/LICENSE and source headers. This is source-informed implementation,
not a claim of clean-room independence. Original firmware remains separately
supplied and owned by its respective rights holders.
ToolShed supplies the pinned CoCo ROM assembly recipe/sources. LWTOOLS supplies
the native 6809 assembler. MiSTer Main supplies the unmodified host environment
and the original parser functions used in isolated validation fixtures. No
affiliation or endorsement by these projects or original hardware vendors is
implied.
+43 -9
View File
@@ -1,19 +1,53 @@
# CoCo3 Mister # Coco 3 Plus for MiSTer
Coco 3 Plus extends [CoCo3_MiSTer](https://github.com/MiSTer-devel/CoCo3_MiSTer)
with a configurable four-slot Multi-Pak, an original-firmware Sound & Speech
implementation, a reorganized menu, and clock/reset/memory timing repairs.
The original upstream Git history is retained; the Plus implementation is one
consolidated commit on `main`. Other original branches and tags remain available.
## CoCo3FPGA port to MiSTer The Computer menu entry is **Coco 3 Plus**. Media lives in
`/media/fat/games/coco3plus`, independently of the stock CoCo3 core.
This targets a DE10-Nano MiSTer with the upstream-required **128 MB SDRAM module**.
The separate original DE1 port is outside this repository.
This is a port of Gary Becker's famous CoCo3 in an FPGA to the MiSTer platform by Stan Hodge, Gary Becker and Alan Steremberg. ## Build and install on Windows
## Roms Needed Install Git, Python 3.10+, and Quartus Prime Lite **17.0.2 Build 602** with
Cyclone V device support. From this checkout in PowerShell:
* boot0.rom - 32K coco3 rom ```powershell
* boot1.rom - 8K Disk extended color basic rom .\windows\Setup-Tools.ps1
.\windows\Build-ROMs.ps1
.\windows\Build-FPGA.ps1 -QuartusSh C:\intelFPGA_lite\17.0\quartus\bin64\quartus_sh.exe
# Place your separately obtained SSC ROMs in roms\ssc first.
.\windows\Install-MiSTer.ps1 -Load
```
Note: This core requires the external sdram memory module (128M) to function. The installer prompts for an IP address or hostname and uses your existing
passwordless SSH access. It preserves the stock core, existing games and saved
Plus configuration, and backs up replaced files. Save/quit the running guest
before installation: installation returns to the MiSTer menu.
Rename your roms, and place them in the games/CoCo3/ directory The ROM build downloads pinned ToolShed assembly and uses native Windows LWASM;
otherwise you will get a black screen it does not depend on another emulator checkout, Bash, WSL or CMOC. SSC's two chip
ROMs are separate inputs, ignored by Git and never downloaded by setup.
- [Windows toolchain and reproducible builds](docs/BUILD_WINDOWS.md)
- [Install, copy release files, first boot and rollback](docs/INSTALL.md)
- [Features and hardware behavior](docs/FEATURES.md)
- [Complete menu tree and operating notes](docs/MENUS.md)
- [Bug fixes: causes, implementation and checks](docs/BUG_FIXES.md)
- [Validation results and explicit limits](docs/VALIDATION.md)
- [Licenses and component provenance](LICENSING.md), [attribution](NOTICE.md)
- [Required ROM inputs](roms/README.md)
- [Standalone SD-image direction](docs/SD_IMAGE.md)
`Package-Release.ps1` produces a checked FAT-volume overlay for copying onto an
existing MiSTer card. The same payload is the basis for a future dedicated boot
image. An overlay alone is not a bootable image; MiSTer Linux and bootloader files
also reside on the SD card.
Timing results apply to the documented SDRAM/board-delay profile. Passing
simulation and static timing does not establish electrical compatibility with
every SDRAM module or validate every optional physical interface.
+98
View File
@@ -0,0 +1,98 @@
# Fixes and engineering changes
This inventory describes the delta from upstream commit
`8b8cf72d1fb4de1d05345de8d5b92ec2d500fcd2`. It distinguishes repairs to inherited
logic from new features and defects found while integrating those features.
The checks below establish their stated scopes; they do not turn source
inspection into a claim of a reproduced field failure.
## Inherited clock, reset and memory paths
| Area and problem | Change and relevant source | Verification and limits |
|---|---|---|
| FDC/SDC mount metadata used transfer events as clocks, leaving generated-clock and phase hazards. | Capture mount strobes/metadata synchronously, classify on a subsequent phase and present stable consumer inputs. `rtl/fdc.sv`, `rtl/sdc_top.sv`, `rtl/sdc.sv`, top-level bindings. | Interface/phase simulations and fitted setup/hold. A mounted DSK still needs guest-format compatibility checks. |
| UART timing used independently derived fabric clocks and incompletely coordinated resets. | Use source-clock enables and explicit global/software reset release; preserve UART bit rate and register behavior. `rtl/UART_6551/` and core serial bindings. | Serial/reset component regressions and UART fitted paths. Physical RS232/GPIO electrical routing is separate. |
| NMI pending/mask state used a generated sampling clock and asynchronous clear path. | Move pending sampling/clear into the master domain, preserve sample ordering and mask/shadow priority, clear pending state on warm reset. `rtl/mc6809glb/mc6809glb.v`. | CPU/NMI regressions and both-corner NMI paths. The S-register change heuristic is retained; this is not a claim of a new fully cycle-exact 6809. |
| Reset sequencing was timed through a signal treated as a clock, with high-fanout cross-phase release. | Separate reset requests from synchronized consumer releases at the 57/114 MHz and opposite-edge boundaries; preserve original startup counters and peripheral-before-CPU order. `rtl/coco3fpga.sv`, disk wrappers and SDC/WD logic. | Extracted actual reset chains, complete reset timing scopes, negative control for unsupported consecutive enables. No blanket false-path waiver replaces release timing. |
| CPU-to-SDRAM requests/completions crossed phase boundaries without explicit registered contracts. | Add `rtl/cpu_sdram_bridge.sv`; register request, address/data/control and completion observation in their proper phases. Preserve the proven nonconsecutive CPU-enable contract. | Protocol, actual-controller, boot-control and delayed-data benches; fitted bridge/control/CPU checks. Simulation adaptations preserve logic but do not model physical SDRAM pins. |
| Keyboard/control and CPU-visible peripheral values could be observed on the wrong consumer phase. | Capture keyboard flags and control/request boundaries, align data-ready observation and SDC CPU buffer access with actual inverted wrapper clocks. Keep the original WD direct read path. | Exhaustive keyboard decode/phase comparison, peripheral and disk-buffer tests with the real wrapper inversion. A passing leaf-only RAM test was insufficient and was replaced. |
| Video address arithmetic extended into the SDRAM ACTIVE decision, creating an inherited negative setup path. | Snapshot the video address before ACTIVE; retain the existing two-word read burst and wrap/guard semantics. `rtl/sdram/sdram2.sv`. | Original-versus-candidate fetch comparison and corrupted-address negative control, plus fitted snapshot/activation paths. No video-address false path is added. |
| SDRAM startup/refresh/return behavior lacked an explicit external timing contract. | Match refresh cadence, startup/precharge recovery and return capture to the documented controller/device profile; phase the forwarded clock through the configured DDIO path. | Command scheduler, delayed CPU/video data models and pin-level STA for the conditional Alliance -7 profile. Unknown module speed/PCB delay remains an assumption. |
| Pixel, audio and board-I2C boundaries were incompletely modeled in STA. | Add source-matched pixel/forwarded clocks and external input/output budgets; constrain both HDMI video clock modes, audio transport and MCP I2C. Preserve bounded I2C protocol timing. `external-io.sdc`, `CoCo3.sdc`, framework audio/I2C bindings. | Actual divider/duty negative control, audio serialization, delayed I2C and 48 substantive external scopes. Optional HPS/muxed/async pins are classified separately, not silently declared timed. |
CPU multicycle constraints are restricted to source-qualified register roles and
proven enables. Unqualified state remains single-cycle. Reset and SDRAM fixes
retain explicit phase/latency contracts; adding an extra return cycle merely to
improve fit is not acceptable.
## New SSC implementation and integration corrections
These are new hardware functions, not fixes to a pre-existing upstream SSC core.
`rtl/ssc/` implements the host bridge, cartridge glue, TMS7000-family controller,
AY-3-8913 and SP0256 speech path. `rtl/coco3fpga.sv` supplies CPU decode/audio;
`CoCo3.sv` supplies menu/runtime ROM input and actual-PLL reset wiring.
- **Runtime ROM lifetime:** guest reset originally risked clearing loaded ROM
validity. Tie cartridge power reset to the actual core PLL-lock release chain,
preserving valid firmware across guest reset/cold boot. Both original ROMs must
pass the strict complete-load contract before ready is asserted.
- **Shared-address ownership:** SSC must replace the inherited video-extension
register decode when selected. Gate both sides, qualify reads before the
ordinary bus mux, and disable SSC selection when no capable socket exists.
- **Command/CPU phase ordering:** latch host transactions and firmware-visible
transitions on explicit enables; preserve data/status ordering and reset/abort
recovery. Never interpret idle FF as a missing cartridge.
- **Original firmware execution:** instruction, immediate-operand, flag, stack,
timer/interrupt and peripheral semantics follow the actual firmware and chip
documentation/reference models. In particular FF operand handling is exercised
by dedicated regressions. The implementation runs the original bytes rather
than substituting host-side command responses.
- **Speech and audio completion:** integrate sequencer/ROM/LPC filtering and AY
tone/noise/envelope output into the legacy audio mix. Busy/readiness must return
to idle after normal completion or deliberate abort/reset. Mono SSC does not
replace Orchestra90's stereo route.
Original-firmware integration, chip/component fixtures, fitted live-chip path
audits and Sound Lab listening/transaction checks provide complementary evidence.
Human listening confirms audibility; it is not an automated waveform-equivalence
claim for all possible cartridge commands.
## Four-slot integration corrections
| Defect found during development | Final behavior and check |
|---|---|
| HPS decode/RAM allocation on opposing edges left an inadequate transfer path. | Register incoming transfer metadata/data before allocation/writes. Pool tests and fitted MPI paths check the full stage. |
| Removal/failure overlap could retain allocation or active autoload state. | Removed sockets free blocks; failed/new downloads cannot corrupt neighboring allocations. Concurrent removal/failure regression checks this explicitly. |
| Duplicate built-in assignment could create ambiguous routing. | Most recently edited socket wins; singleton devices move. Combined Audio can leave its other component in the old socket. Exhaustive router/config fixtures exercise deterministic normalization. |
| Main sends remembered files before restoring saved layout. | Stage early slot ROMs while Main holds reset, then accept against restored layout. Testing only a default layout missed the Slot4 case; native parser and composed startup fixtures now include non-default layouts. |
| Normalization acknowledgement could clear Main's initialization reset too early. | Defer publishing migration status until Main's final release. Staging files alone did not fix this second initialization ordering issue. The old behavior is a negative-control failure. |
| Long labels truncated the usable OSD rows. | Use short labels within the existing OSD width, retain nine stable pages and explicitly show pool limits, assignment requirements and readiness. Native Main menu parser checks every option's status-bit contract and conditional row visibility. |
The new router keeps CTS/SCS independent and qualifies read/IRQ/bank behavior
against the effective socket. Tests extract the actual top/core bindings rather
than checking only an isolated idealized router. Native menu/startup tests use
pinned original Main functions; no custom Main binary is required.
## Packaging and startup corrections
The launcher and embedded display identity are Coco 3 Plus; native MGL `setname` makes settings/media
use `coco3plus` consistently. Hidden RBF storage keeps the stock core separate.
Remembered-file records must use the canonical folder and accept the existing
absolute/relative Main path conventions. Old-prefix replacements must respect
folder boundaries, not accidentally rewrite a similarly named folder.
The installer passes raw structured SCP arguments. Embedding shell quote marks
inside a modern SFTP path can create literal quotes or fail a spaced launcher
upload; shell quoting is reserved for the remote shell script itself. It stages
and checks files before activation, preserves saved settings, and records rollback.
These are deployment fixes, not defects attributed to upstream FPGA/Main logic.
## Corrections that were test issues, not core bugs
Idle SSC status FF is expected. Disk BASIC direct-mode `INPUT#` raises ID
(illegal direct); stored-program reads succeed. A panic attempted after speech
already completed cannot prove active abort recovery. Mouse JOYSTK queries must
use the configured port and a progressing BASIC loop. These observations led to
corrected tests, not speculative RTL edits. An intermediate SDRAM candidate with
an unnecessary extra READY/return stage produced a green-@ startup failure; it
was rejected and the first-beat contract restored before qualification.
+129
View File
@@ -0,0 +1,129 @@
# Windows build and validation
## Required tools
Use 64-bit Windows, Git for Windows and Python **3.10 or newer**. Scripts use the
Python standard library. PowerShell wrappers accept `-Python <full-path>` when
`python` is not on PATH. All commands below run from the repository root.
Install **Quartus Prime Lite 17.0.2, Build 602**, including Cyclone V device files.
The device is **5CSEBA6U23I7**. The project originated in Quartus 17.0; its pinned
settings record 17.0.2. Install the 17.0 base package and matching device package,
then the 17.0 Update 2 package when using the separate installers. Check:
```powershell
& C:\intelFPGA_lite\17.0\quartus\bin64\quartus_sh.exe --version
```
Obtain installers through the [official Altera software download center](https://www.altera.com/downloads).
See also [MiSTer's compilation guidance](https://mister-devel.github.io/MkDocs_MiSTer/developer/compile/).
Setup does not silently install Quartus, accept its license or select a newer IP
generator. Other Quartus versions require separate baseline/timing validation.
## Download public build dependencies
```powershell
.\windows\Setup-Tools.ps1
```
This downloads native Windows x64 [LWTOOLS 4.25](https://www.lwtools.ca/releases/lwtools/),
eight pinned [ToolShed cocoroms](https://github.com/nitros9project/toolshed/tree/3667a41c9605b7fcb150eace29cc7f42d460be1a/cocoroms)
source files and four pinned MiSTer Main source files used only by parser tests.
Archives, extracted files and individual source files are checked against
`tools/toolchain.json` and `tools/cocoroms.json`. Existing changed downloads are
rejected, not silently replaced. `.cache`, `.tools` and `.deps` are ignored.
No SSC firmware, software library or emulator source is fetched.
## Assemble boot ROMs
```powershell
.\windows\Build-ROMs.ps1
```
The native LWASM recipe follows ToolShed's dependency order: BASIC 1.3,
`dumpcb_equates`, Extended BASIC 1.1, `dumpecb_equates`, Disk BASIC 1.1 with
`noindex0tonone`, then the CoCo3 ROM. Four output SHA-256 values must match before
`boot0.rom` and `boot1.rom` are staged in `build/roms`. The receipt records every
command and input/output identity. No C compiler or CMOC is required.
The assembly rebuild is reproducible; availability of source is not a blanket
permission to redistribute the resulting third-party ROMs. See LICENSING.md.
The ToolShed tree inspected contains SSC documentation but no original SSC
TMS7040 or SP0256 ROM source. Those chips cannot be reconstructed with this
6809 assembly recipe; supply their verified originals as described in roms/README.md.
## Compile the FPGA
```powershell
.\windows\Build-FPGA.ps1 -QuartusSh C:\intelFPGA_lite\17.0\quartus\bin64\quartus_sh.exe
```
This makes a fresh `build/fpga/project` copy, records individual source hashes,
uses the committed seed 5 and original build-ID flow, and invokes the native
Quartus compile. It leaves checked-in source/IP untouched. Logs, reports, bitstream
and `build.json` remain under `build/fpga`. Success requires a generated RBF,
nonnegative timing-summary slack and unchanged input hashes. Warning details
remain in the native log; success is not a claim that no warnings occurred.
Never compile in the source checkout or let the GUI replace HDL assignments.
New HDL belongs in `files.qip`; add it and any new source/IP/data dependencies to
the maintained `tools/project_inputs.json` inventory too. The builder rejects
unlisted HDL/constraint/IP inputs in the source directories before copying.
`validation/source-import.json` is historical provenance, not the build inventory.
The receipt derives the seed from the actual single QSF assignment.
Generated caches/IP upgrades stay in build copies.
Outputs are preserved: use `-Output build/fpga-next` for another build, with matching
`--build` arguments when packaging/auditing it, rather than deleting prior results.
## Functional and detailed timing checks
Optional HDL tooling can be downloaded with:
```powershell
.\windows\Setup-Tools.ps1 -IncludeSimulator
.\windows\Test.ps1
```
The pinned OSS CAD Suite supplies Icarus Verilog. The native Main parser fixtures
also need Visual Studio 2022 C++ Build Tools (MSVC and Windows SDK), or a native
C++17 compiler on macOS/Linux. These fixtures compile selected original parser
functions with mocked file/transport calls; they do not build or replace Main.
Supply an existing suite with `Test.ps1 -Suite <oss-cad-suite-folder>`.
`scripts/run_regressions.py` runs 15 independent jobs: MPI modules and actual core
bindings, original-firmware SSC integration, memory/reset/keyboard/peripheral
phase checks, SDRAM command/delayed-data tests, audio/pixel/I2C contracts, native
startup/menu parsing and original-versus-new video fetch. Several include
deliberately faulty negative controls. Complete repeat runs require a new
`--output build/<name>` directory. SSC integration requires the ignored chip ROMs.
After a full fit, run detailed path audits with:
```powershell
python tools/audit_timing.py --quartus C:\intelFPGA_lite\17.0\quartus\bin64\quartus_sta.exe
```
The audits inspect the fitted MPI, CPU/reset, NMI, UART, video, SSC and conditional
external-I/O profile at both timing corners. Empty reports are never treated as
substantive passes; synchronous-only recovery/removal reports may be empty where
explicitly documented. These checks do not remove the remaining physical-board
assumptions listed in docs/VALIDATION.md.
## Release/install
```powershell
.\windows\Package-Release.ps1
.\windows\Install-MiSTer.ps1 -Release dist\coco3plus -Load
```
Packaging verifies the RBF and boot/SSC ROM identities, writes a manifest and
SHA256SUMS, and creates a copyable `fat/` overlay. No files from build caches or
source-reference downloads are installed. Packaging requires reviewed changes
committed; corresponding source comes only from that committed Git tree, never
untracked local files. `-PublicPackage` omits all separately obtained/assembled ROMs
and produces a core/source distribution requiring user ROM preparation. It is
distinct from a complete local install package. Details: docs/INSTALL.md.
Portable Python entry points under tools/ support native macOS/Linux tooling
where available. Quartus itself has no native macOS build; use the Windows or
supported Linux toolchain. The automatic prebuilt-tool download is Windows x64.
+83
View File
@@ -0,0 +1,83 @@
# Features and implementation
## Four independently configured sockets
The new Multi-Pak configuration separates **what is installed**, **which socket
starts selected**, and **which media is mounted**. Each of four sockets can hold
Empty, ROM file, Floppy, CoCo SDC, Sound & Speech, Orchestra90, Audio expansions,
or RS232. Built-in controllers are singletons: assigning one elsewhere moves
that device rather than inventing another independent controller. The combined
Audio expansions entry preserves simultaneous legacy Orchestra90 and selectable
SSC behavior; it is a convenience combination, not an original physical cartridge.
The router follows independent guest CTS and SCS selectors, with device-qualified
read data, writes and interrupts. Four ROM sockets share a 256 KiB allocation
pool; a single image can use at most 128 KiB. Socket state and banking are private
to each socket. Removing a ROM frees its allocation and suppresses stale autoload.
An oversized/full-pool transfer reports a load error rather than overwriting a
neighbor. Floppy/SDC mounted images follow their controller when it moves slots.
Device changes deliberately cold-restart the guest; media selection does not.
Persisted legacy settings are migrated into a marked four-slot layout. MiSTer
Main's original remembered-file mechanism loads cartridge and SSC files without
custom host software. Early file transfers are staged while initialization holds
reset, then matched against the restored layout before the guest is released.
## Original-firmware Sound & Speech
The SSC implementation includes a TMS7000-family instruction/peripheral engine
for the cartridge's TMS7040 controller, the original 4 KiB controller firmware,
an AY-3-8913-compatible tone/noise/envelope path, an SP0256-compatible speech
sequencer/LPC path using the original 2 KiB AL2 ROM, host interface and cartridge
glue. The original ROM bytes are runtime inputs, not re-created firmware or an
emulator audio recording. Chip implementations are synchronous FPGA logic.
Host status/data behavior, firmware command handshakes, reset/ready transitions,
busy/abort/recovery, firmware instruction behavior and generated samples are
covered by component/integration testing and shared Sound Lab diagnostics.
Normal idle status is FF; it is not evidence of an absent card. No unsupported
cartridge IRQ is invented. Original SSC is mono; its signal is mixed into both
outputs alongside the legacy CoCo audio path. Orchestra90 remains stereo and
can coexist through Audio expansions or distinct assigned sockets.
SSC ROM validity belongs to FPGA power/configuration lifetime. A guest cold boot
or reset does not discard valid runtime ROMs; real core PLL-lock loss does. Strict
file length/address/loader completion checks prevent a partial load from being
reported ready. The OSD shows not ready, ready or error separately.
## SSC and extended-color register ownership
The inherited FPGA extended-color/video-DAC feature uses an address also occupied
by SSC cartridge registers. **Sound & Expansion → Expansion** selects Extended
palette or Sound & Speech. Only the selected implementation owns the shared
register decode. SSC mode also requires an SSC-capable socket assignment; the
menu disables the option and explains the missing assignment otherwise.
The extended palette is an FPGA-specific enhancement, not a claim that an
unmodified physical CoCo3 had that feature. Its original palette/video behavior
is preserved. Orchestra90 does not require enabling the extended-color mode.
Do not infer SSC presence merely from a loaded ROM filename; socket and expansion
ownership determine whether the guest can address it.
The inherited graphics extension provides 256 palette entries with 12-bit RGB
values (four bits per channel) and extended graphics decode. Its VDAC programming
write at FF7E conflicts with SSC; its color lookup and supported pixel-latch
geometry follow `rtl/VDAC.v`, `rtl/VDAC.mif` and `rtl/Mister_Video.v`. This is
preserved implementation, including source-specific low-resolution latch behavior,
not a newly invented standard display mode. Use the original source/manual for
register programming rather than assuming every extended mode is byte-per-pixel.
## Existing functions retained
- Four WD1793-style floppy image mounts and Disk BASIC.
- Two SDC image mounts accepting DSK/VHD plus the existing OS9 floppy mount rows.
- ROM/cartridge loading and banked access within the documented memory pool.
- Cassette CAS playback, rewind, monitoring and recording/export path.
- 512K/1M/2M/16M guest memory choices and existing turbo/autorun controls.
- Aspect ratios, scandoubler effects, artifact choices and CoCo3 LC option.
- USB joystick emulation, swap and mouse as right joystick.
- RS232/UART routing, font loading and debug/Easter Egg controls.
Retained source functionality is not a claim that every optional peripheral,
physical I/O route or large disk format has been tested on the development unit.
See VALIDATION.md for observed coverage and remaining work.
+105
View File
@@ -0,0 +1,105 @@
# Install and operate Coco 3 Plus
## Existing MiSTer, passwordless SSH
Have a working MiSTer installation and key-based SSH login before running the
installer. On Windows OpenSSH is available as an optional Windows feature. Test:
```powershell
ssh root@YOUR-MISTER
```
Establish the correct host fingerprint and public-key login through your normal
SSH setup. The installer uses `BatchMode=yes` and `StrictHostKeyChecking=yes`:
it does not request/store passwords or accept unknown host keys silently.
The default Unix user is root, as on standard MiSTer. Another account must already
have permission to write the FAT volume and issue MiSTer commands.
Build ROMs/FPGA per BUILD_WINDOWS.md. Put the two separately obtained chip ROMs
in `roms/ssc`; packaging checks their exact size and SHA-256 before remote writes.
They remain ignored by Git. Then save guest work, close files and stop disk
activity. Installation returns to MENU, so the current guest session is ended.
```powershell
.\windows\Install-MiSTer.ps1 -Load
# Or specify the address:
.\windows\Install-MiSTer.ps1 -HostName YOUR-MISTER -Load
```
If no address is given, the script prompts for one. It first validates every
local input, then checks remote access, stages files, verifies remote SHA-256,
returns to MENU, backs up replaced files, copies the overlay, checks installed
hashes, syncs the volume and optionally loads the launcher. A timestamped receipt
in ignored dist storage records the device and rollback path. It does not change
accounts, networking, Samba, the Linux installation or nonvolatile FPGA storage.
Only the Plus launcher, its uniquely addressed RBF, two boot ROMs and optional
SSC ROM/path records are installed. The stock core and other guest media remain.
Existing `coco3plus_v51.CFG` is kept. First installs get Audio expansions / SDC /
ROM / Floppy, startup Slot4, 512K, and Sound & Speech enabled when ROMs are supplied.
Existing users retain their own layout and expansion selection.
`-WithoutSSC` creates a base-only package without chip ROMs/path records. It does
not delete SSC files already installed on a device. Its
fresh configuration selects Extended palette. SSC remains unavailable until
valid ROMs are supplied and its cartridge/mode is selected.
## Files and copying instead of SSH
`Package-Release.ps1` writes `dist/coco3plus/fat` and the matching
`dist/coco3plus.zip` archive. The release also includes a corresponding-source
ZIP, file checksums, notices and manifest. The FAT overlay contains:
```text
fat/
_Computer/Coco 3 Plus.mgl
_Computer/.coco3plus/<RBF-hash-prefix>/coco3plus.rbf
games/coco3plus/boot0.rom
games/coco3plus/boot1.rom
games/coco3plus/pic-7040-510.bin (separate supplied input)
games/coco3plus/sp0256-al2.bin (separate supplied input)
config/coco3plus.f4, coco3plus.f5 (when SSC included)
config/coco3plus_v51.CFG (new installs only)
```
Power off MiSTer before removing its card. Copy the **contents** of fat/ to its
data-volume root, including `_Computer`'s hidden `.coco3plus` child. Back up collisions
and skip the supplied CFG when one already exists. Preserve the manifest next
to your release archive. Copying this folder onto an unprepared card does not
install Linux or make it bootable.
Guest `.DSK`, `.VHD`, `.CCC`, `.ROM`, `.BIN` and `.CAS` files belong in
`games/coco3plus` or subfolders. A software library is optional and is not silently
downloaded or redistributed by setup. Keep a pristine diagnostic disk and use
writable copies for saved results.
## Public source/core packages
Local complete packages can contain your own ROM inputs and must not be published
as though ignored files were automatically excluded from ZIPs. Use
`Package-Release.ps1 -PublicPackage -Output dist/coco3plus-public` for a source/core
artifact that omits all boot and SSC ROMs. Supply the required ROMs before manual
copy/launch. The SSH installer rejects this incomplete-ROM package and directs
you to make a complete local package from your own verified inputs.
## First launch and recovery
Choose Computer → Coco 3 Plus. It should reach Disk Extended Color BASIC.
`PRINT 1+1` should print 2. F12 → Sound & Expansion reports Sound & Speech ready
after its original ROMs load automatically. F12 → Cartridges & Multi-Pak controls
the four sockets and startup slot. F12 → Floppy Disks mounts images without
changing the layout. Changing socket devices restarts the guest.
The MGL uses native `setname=coco3plus`, so settings and remembered files use the
same canonical namespace. The RBF also identifies itself as **Coco 3 Plus**, so
welcome/help strings no longer expose the retired development name. The native
profile override remains `coco3plus`; changing the display identity does not
require abandoning the existing saved settings or media.
For rollback, return to MENU and restore `_Computer/Coco 3 Plus.mgl` from the
receipt's remote backup directory. Its previously addressed RBF remains in place.
Restore backed-up boot/SSC/path files if those inputs also need rollback. Existing
saved CFG was not overwritten. On a first installation, select the preserved
stock CoCo3 entry to use the original environment. Keep backup/staging folders
until physical cold-start and audio checks pass; failed installs retain their
staging evidence instead of deleting it automatically.
+105
View File
@@ -0,0 +1,105 @@
# Menu tree and operating guide
Select **Computer → Coco 3 Plus**, then press F12 for its core menu. Escape/F12
closes the OSD; Left returns from a page. MiSTer's own system menu supplies core
selection, configuration saving and other host-wide controls. The following tree
is the Plus `CONF_STR` organization; conditional rows depend on assigned devices.
```text
Coco 3 Plus
├─ Cartridges & Multi-Pak
│ ├─ Startup slot: Slot 1 / Slot 2 / Slot 3 / Slot 4
│ ├─ Slot 1: Empty / ROM file / Floppy / CoCo SDC / Sound & Speech /
│ │ Orchestra90 / Audio expansions / RS232
│ │ └─ Slot 1 ROM (when that socket provides program ROM)
│ ├─ Slot 2: same device choices; Slot 2 ROM
│ ├─ Slot 3: same device choices; Slot 3 ROM
│ ├─ Slot 4: same device choices; Slot 4 ROM
│ ├─ ROM pool: 256K total; Max ROM: 128K per slot
│ └─ ROM load error: size/full (only on error)
├─ Floppy Disks
│ ├─ Drive 0: DSK
│ ├─ Drive 1: DSK
│ ├─ Drive 2: DSK
│ └─ Drive 3: DSK
├─ CoCo SDC
│ ├─ SDC Drive 0: DSK / VHD
│ ├─ SDC Drive 1: DSK / VHD
│ └─ OS9 floppy mounts: /d0 / /d1 / /d3 / /d4 (DSK)
├─ Sound & Expansion
│ ├─ Expansion: Extended palette / Sound & Speech
│ ├─ Assign SSC in Multi-Pak (when no SSC-capable socket exists)
│ ├─ Sound & Speech not ready / ready / error
│ ├─ Orchestra90 stereo enabled (when assigned)
│ └─ Audio = SSC + Orchestra90 (explanation)
├─ Cassette
│ ├─ Load Cassette: CAS
│ ├─ Stop & Rewind
│ ├─ Monitor Tape Sound: No / Yes
│ ├─ Save Cassette: CAS
│ └─ Transport: Playback / Rewind / Record
├─ Machine
│ ├─ Memory Size: 512K / 1M / 2M / 16M
│ ├─ Force Turbo: No / Yes
│ ├─ Turbo Speed: CoCo Ctrl / 0.89 / 1.78 / 2.86 / 3.58 / 7.16 / 9.54 MHz
│ ├─ Auto Run: Off / DOS / AUTO.BAS
│ ├─ Cold Boot
│ └─ Reset
├─ Display
│ ├─ Aspect ratio: Original / Full Screen / Wide / [ARC1]
│ ├─ Scandoubler Fx: None / HQ2x / CRT 25% / CRT 50% / CRT 75%
│ ├─ CoCo3 LC: Yes / No-(SG6=Yes)
│ ├─ Artifact Type: MESS / Simple / NONE
│ └─ Artifact Color Set: 0 / 1
├─ Input
│ ├─ D-Pad Joystick emu: No / Yes
│ ├─ Swap Joysticks: Off / On
│ └─ Mouse as right joystick: Off / On
└─ Advanced
├─ Load COCO Font: BIN
├─ Swap MiSTer Uart: RS CART / Default
├─ Swap Uart to IO: RS IO / MiSTer
├─ Display Debug: Off / On
└─ Easter Egg
```
The root has nine stable pages. Hidden legacy cartridge and SSC firmware loaders
remain in the configuration string for native startup-file compatibility. They
are not additional top-level pages or everyday user setup steps.
## Choosing devices and disks
Built-in devices move sockets. Selecting a second Floppy, for example, moves the
existing controller and its mounted disks to the newly chosen socket. Assigning
Sound & Speech or Orchestra90 separately can split the corresponding portion out
of Audio expansions. Other instances are cleared deterministically, preserving
one instance of each real built-in controller. ROM files may occupy multiple
sockets simultaneously within the shared allocation limit.
Startup slot chooses the socket selected when the guest starts; it does not
rotate disk-controller types or change which disk image is mounted. The guest
can subsequently change its Multi-Pak selectors. Use Floppy Disks or CoCo SDC to
mount media for that controller. The rows are disabled when the corresponding
controller is absent. The OS9 mount names intentionally retain the upstream
/d0, /d1, /d3, /d4 conventions; they are not renumbered to imply new drive logic.
Changing a socket device restarts the CoCo. Mount media and save your MiSTer core
configuration after arranging the machine. On the next launch, remembered ROMs
are restored with the saved layout; no manual SSC chip-ROM loading is needed.
The installer preserves an existing Plus CFG rather than imposing a new layout.
## Sound and display
Assign an SSC-capable socket, select Sound & Speech on the expansion page and
check ready before running cartridge software. Extended palette and SSC share
register space, so this is an ownership selection. Audio expansions is a
compatibility convenience for SSC plus Orchestra90, not a third sound chip.
MiSTer supplies audio through its supported HDMI/analog configuration; a remote
video capture device may omit or mute HDMI audio even when core output works.
## Returning to MiSTer
Use MiSTer's OSD system/core-selection controls to choose another core without
a physical power switch. Save guest files first. Guest Reset/Cold Boot operate
on the CoCo environment; they are different from loading another RBF or turning
the whole MiSTer off.
+37
View File
@@ -0,0 +1,37 @@
# Two delivery forms, one core payload
The release design has two delivery targets:
1. **Existing MiSTer:** a checked FAT-volume overlay, copied directly or installed
over passwordless SSH. This is implemented by tools/release.py and
tools/install_mister.py.
2. **Dedicated Coco 3 Plus card:** a bootable image containing the standard
MiSTer system plus the same overlay, suitable for balenaEtcher. The image
builder and first-boot qualification are a separate delivery step; no bootable
Plus image is claimed by the core build or overlay packaging command.
MiSTer Linux and its boot files reside on the microSD card. It is not sufficient
to put a core RBF and games on a blank FAT32 card and rely on an onboard OS.
[Mr. Fusion](https://github.com/MiSTer-devel/mr-fusion) is the existing starter
system. Its compact image boots a small installer, expands/prepares the card,
installs MiSTer and reboots. Its documented image-writing tools include Etcher.
Using its existing release/system assets avoids building a new Linux distribution.
Its upstream full image builder currently uses a privileged Linux/Docker flow;
that is distinct from our native Windows FPGA/tool/ROM build.
For a dedicated release, pin the Mr. Fusion and MiSTer system versions and
checksums, preserve their licenses, then integrate the already verified Plus
overlay into the image's installation payload. Confirm exactly when the
installer consumes/deletes its staging partition before injecting files: copying
arbitrary assets beside Scripts is not a documented automatic full-root overlay
mechanism. Include only approved software-library content, no owner credentials,
SSH host keys or personal device configuration. Choose a dedicated startup
configuration deliberately while retaining a way back to MENU.
Qualification must include flashing a spare card, first-boot expansion on the
actual DE10-Nano, offline/online behavior, automatic SSC ROM availability when
legitimately supplied, readable/writable disks, saved settings and a cold power
cycle. Never replace an existing owner's primary card as an incidental test.
The same core/ROM/file manifest should identify both distribution forms so they
cannot drift into different products.
+132
View File
@@ -0,0 +1,132 @@
# Validation and acceptance scope
## Final named release, 2026-11-18
The final source embeds **Coco 3 Plus** as its display identity and retains
`coco3plus` as its native MGL profile. Original contribution copyright notices
are added without replacing upstream notices. A fresh native Quartus17.0.2
seed5 compile completes in **14:33**, **0 errors / 73 warnings**. It uses
**19,067 ALMs (45%)**, **495 RAM blocks (90%)** and produces a **3,946,736-byte** RBF:
```text
768ee9db2923bf7b7acf7f57473c6c56f92d14ffc6d6bd88719148f80c9a2d42
```
Minimum constrained slack: setup **+0.089 ns**, hold **+0.212 ns**, recovery
**+0.691 ns**, removal **+0.701 ns**, pulse width **+0.396 ns**. All 15 functional
jobs pass through the documented Windows entry point using the standalone
checkout's own verified/extracted simulator. The actual Main name-reader
fixture additionally confirms the spaced display name and unchanged canonical
profile override. All **368 fitted report scopes** pass, with remaining optional
pin contracts explicitly classified in validation/standalone.json. No timing
exceptions or physical delay assumptions were relaxed for the rename.
Release-tool review adds eight passing integrity tests: committed-only source
export excludes untracked notes and ROMs, public packages omit firmware, dirty
selected sources stop packaging, incomplete simulator setup stays unpublished,
and same-size binary corruption is detected. New HDL dependencies use a maintained
inventory; the build receipt reads the actual QSF seed. Resumed timing audits
require the original RBF, fitted netlist, input and Tcl-script identities. Older
unbound evidence is deliberately rejected; all 368 scopes were rerun with the
bound evidence format. These tooling corrections do not alter the fitted RTL.
This is a new bitstream, so previous extensive hardware observations below
belong to the earlier hash. Final deployment/startup observations are separately
recorded in validation/deployment.json. The shared logical implementation is
covered by the final-source regressions; no new human listening or cold-power
test is inferred merely from that relationship.
## First standalone reconstruction, 2026-11-18
The new repository was created from a complete upstream mirror, with no research
repository ancestry. The baseline is
`8b8cf72d1fb4de1d05345de8d5b92ec2d500fcd2`; original upstream refs are recorded in
validation/upstream-refs.json. The consolidated implementation is maintained on
main. Source-import hashes record the qualified implementation inputs and three
project-description comment rewrites; no private conversation/evidence archive
is required to build this project.
All public dependencies were freshly downloaded and hash-verified from the new
repository's scripts. Native Windows LWASM 4.25 assembled all four ToolShed ROMs
to the expected SHA-256 values. SSC original inputs were separately verified and
remain ignored. No VCC Plus checkout/build or private emulator binary was used
for this standalone build or these regressions.
The first standalone Quartus **17.0.2 Build 602** compile, seed 5, completed in
**14:38**, with **0 errors and 73 warnings**. Utilization is **19,098 ALMs (46%)**,
**495 RAM blocks (90%)** and 3,897,605 block-memory bits (69%). The RBF is
3,951,104 bytes, SHA-256:
```text
a4b6ef0b3641bbbc1b42de88502b677a1ec5e3809e2a17abf6f1e75c2a38451e
```
This first build is byte-identical to the previously qualified and hardware-tested
image. It still reported the retired COCO3-BH embedded identity, which the final
release changes to Coco 3 Plus. Its fit has minimum constrained setup **+0.069 ns**, hold **+0.252 ns**,
recovery **+0.692 ns**, removal **+0.742 ns**, pulse width **+0.396 ns** and summary
TNS zero. Generated build logs and exact source hashes remain under ignored build
storage; the sanitized reproducibility record is validation/standalone.json.
All **15 standalone functional jobs** pass: MPI allocation/config/router and actual
core bindings; original-ROM SSC system; registered interfaces; reset/buffer
domains; exhaustive keyboard phase; peripheral phase; SDRAM commands; delayed
CPU/video data; audio; pixel; I2C; original Main startup parser; original Main menu
parser; original/candidate video comparison. Negative controls include incorrect
buffer cadence, pixel duty/address corruption and old initialization behavior.
All seven native detailed timing audits pass **368 report scopes** at both slow
and fast corners. This includes 34 MPI reports, 144 live SSC path reports,
CPU/reset/NMI/UART/video scopes, and 48 substantive conditional external-I/O
reports. Explicitly empty synchronous-only recovery/removal subscopes are listed
as empty, not counted as an observed path with positive slack.
The first exported test run found missing dynamically named reset benches, a
canonical-name fixture mismatch, and a video-runner argument mismatch. These
were export-harness defects; corrected fixtures pass in a fresh output folder.
No RTL/timing exceptions were changed to satisfy the exported tests.
## Hardware evidence on these exact RBF bytes
Previous physical validation of the same image includes normal Disk BASIC startup,
saved non-default socket layout, Slot1/Slot4 ROM autoload, independent socket
banks/selectors, fresh configuration boot and Colour Lab grid/ramp/stripes/return.
Further autonomous checks include:
- 14 guided Sound Lab cases plus repeated/FF-operand cases: 20 transaction
records across seven validated saved reports. One deliberate active-speech
abort/reset returns to normal operation and completes the full greeting.
- Disk BASIC formatting of an authored scratch disk, writing and reading 256
exact numeric pairs across two granules; guest sums and host extraction agree.
- Supplied 512K RAM stress advancing pages for 135 seconds with no error display.
- Quadrapassel startup, keyboard movement, pause and quit.
- Mouse-as-right-joystick axes and button1 changes.
Human SSC audibility was confirmed during earlier integration checks. The later
autonomous report marks remain UNSURE/NOT_OBSERVED; no new listening score is
manufactured from screenshots or transaction completion. An earlier hardware
game check also confirmed USB joystick/game audio, with separate build attribution.
The initial standalone installer/path activation reached BASIC, `PRINT 1+1`
returned 2 and the OSD reported automatic Sound & Speech ready and Orchestra90
enabled. The saved CFG and stock RBF were preserved. Final renamed-image
activation is recorded separately in validation/deployment.json. Rebuilding identical bytes
does not itself prove a newly changed launcher/installer path works.
## Explicit remaining limits
The native external constraints use the controller's documented Alliance -7
SDRAM and bounded board-delay assumptions. The enclosed development module's
exact chip/speed suffix and PCB delays have not been independently measured.
This is conditional timing closure, not universal SDRAM-module or whole-board
electrical certification. Some HPS/muxed/asynchronous optional pins have separate
contracts outside these fabric STA budgets.
Cold power removal/reapplication remains a physical operator check. Longer memory
stress, every turbo/large-memory setting, all UART/serial electrical paths, every
SDC/VHD/OS9 and cassette-write format, all joystick types and exhaustive waveform
equivalence remain outside the enumerated acceptance scope. Firmware diagnostics
and human listening complement rather than replace timing/simulation evidence.
A dedicated bootable SD image requires separate first-boot/expansion/cold-start
qualification on a spare card; a verified core overlay is not that qualification.
+78
View File
@@ -0,0 +1,78 @@
# Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
# Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
# MiSTer board interface profile; see docs/experiments/EXTERNAL_IO_TIMING.md.
# Alliance AS4C32M16SB -7, CL3. External round trip <= 0.50 ns;
# data-to-clock PCB skew bounded by +/-0.25 ns (SDRAM writes and HDMI).
# These are explicit design bounds, NOT measured facts about an installed kit.
# A negative result must remain negative. Read hold is never waived.
set mem_clock {emu|pll|pll_inst|altera_pll_i|general[0].gpll~PLL_OUTPUT_COUNTER|divclk}
set sys_clock {emu|pll|pll_inst|altera_pll_i|general[1].gpll~PLL_OUTPUT_COUNTER|divclk}
set hd_clock {pll_hdmi|pll_hdmi_inst|altera_pll_i|cyclonev_pll|counter[0].output_counter|divclk}
foreach n [list $mem_clock $sys_clock $hd_clock] {
if {[get_collection_size [get_pins $n]] != 1} {error "Missing exact external-interface clock pin $n"}
}
set pixel [get_registers {*|MISTER_COCOVID|PIX_CLK}]
if {[get_collection_size $pixel] != 1} {error "Expected one divide-by-four pixel register"}
create_generated_clock -name coco_pixel -source [get_pins $sys_clock] -edges {3 7 11} $pixel
create_generated_clock -name sdram_forward -source [get_pins $mem_clock] -divide_by 1 -invert [get_ports SDRAM_CLK]
set dq [get_ports {SDRAM_DQ[*]}]
if {[get_collection_size $dq] != 16} {error "Expected sixteen SDRAM DQ pins"}
set_input_delay -clock sdram_forward -max 5.90 $dq
set_input_delay -clock sdram_forward -min 2.50 $dq
# This is the preceding output-launch beat: CL3 READ T4 -> launch T6,
# receive T7. READY retains its original alignment (READ_CAPTURE_EXTRA=0).
# A setup-only edge shift intentionally tightens hold by a cycle.
# Do NOT append the usual enable-multicycle hold compensation here.
set capture [get_registers {*|coco3_sdram|dq_reg[*]}]
if {[get_collection_size $capture] != 16} {error "Expected sixteen SDRAM capture registers"}
set_multicycle_path -setup 2 -from $dq -to $capture
set mem_outputs [get_ports {SDRAM_A[*] SDRAM_BA[*] SDRAM_n* SDRAM_DQM* SDRAM_DQ[*]}]
if {[get_collection_size $mem_outputs] != 37} {error "Expected 37 SDRAM output/bidirectional pins"}
set_output_delay -clock sdram_forward -max 1.75 $mem_outputs
set_output_delay -clock sdram_forward -min -1.05 $mem_outputs
create_generated_clock -name hdmi_scaled_forward -source [get_pins $hd_clock] -divide_by 1 -invert [get_ports HDMI_TX_CLK]
create_generated_clock -name hdmi_direct_forward -source [get_pins $sys_clock] -divide_by 1 -invert -add [get_ports HDMI_TX_CLK]
# Carry the existing platform clock groups through the newly named descendants.
# HDMI data registers are clocked by the same selected mux as their DDIO clock.
set_clock_groups -exclusive \
-group [get_clocks {*|pll|pll_inst|altera_pll_i|*[*].*|divclk coco_pixel sdram_forward hdmi_direct_forward}] \
-group [get_clocks {pll_hdmi|pll_hdmi_inst|altera_pll_i|*[0].*|divclk hdmi_scaled_forward}] \
-group [get_clocks {*|pll_audio_inst|altera_pll_i|*[0].*|divclk}] \
-group [get_clocks spi_sck] -group [get_clocks hdmi_sck] \
-group [get_clocks {*|h2f_user0_clk}] \
-group [get_clocks FPGA_CLK1_50] -group [get_clocks FPGA_CLK2_50] -group [get_clocks FPGA_CLK3_50]
set video [get_ports {HDMI_TX_D[*] HDMI_TX_DE HDMI_TX_HS HDMI_TX_VS}]
if {[get_collection_size $video] != 27} {error "Expected 27 HDMI video data/control pins"}
foreach clk {hdmi_scaled_forward hdmi_direct_forward} {
set_output_delay -clock $clk -max 2.05 -add_delay $video
set_output_delay -clock $clk -min -1.55 -add_delay $video
}
# The real CE/serializer is checked by scripts/test_external_audio.py at both
# 48/96 kHz and during live switches. Data/LRCLK setup >=5 audio fabric cycles,
# hold >=3. Bound each output's absolute arrival, INCLUDING clock insertion,
# to 0..40 ns. The 40.682 ns fabric period leaves >79 ns receiver hold margin
# even at opposite output extrema, after the 2 ns/0.25 ns external allowance.
set i2s_regs [get_registers {audio_out|i2s|sclk audio_out|i2s|lrclk audio_out|i2s|sdata}]
set i2s_ports [get_ports {HDMI_SCLK HDMI_LRCLK HDMI_I2S}]
if {[get_collection_size $i2s_regs] != 3 || [get_collection_size $i2s_ports] != 3} {error "Expected three actual I2S output registers and pins"}
set_max_delay 40.0 -from $i2s_regs -to $i2s_ports
set_min_delay 0.0 -from $i2s_regs -to $i2s_ports
# MCP23009 fast-mode profile: 250 kHz, >=2 us half-periods. The independent
# protocol checker covers 0/300 ns edge extrema. A 40 ns fabric propagation
# envelope leaves low >=1660 ns and high >=1660 ns, beyond 1300/600 ns minima.
# Slave tAA <=900 ns, SDA edge <=300 ns, SCL fall <=300 ns and two fabric
# envelopes <=80 ns leave >=420 ns before the next 2 us sample slot.
# No fictitious external synchronous clock.
set io_drive [get_registers {mcp23009|i2c|I2C_CLOCK mcp23009|i2c|SCLK mcp23009|i2c|SDO[19]}]
set io_sample [get_registers {mcp23009|i2c|ACK mcp23009|i2c|rdata[*]}]
# get_registers includes fitted physical duplicates of a logical register.
# Require every logical boundary, and constrain all returned clones as well.
foreach io_role {mcp23009|i2c|I2C_CLOCK mcp23009|i2c|SCLK mcp23009|i2c|SDO[19]} {
if {[get_collection_size [get_registers $io_role]] < 1} {error "Missing MCP I2C drive boundary $io_role"}
}
if {[get_collection_size $io_drive] < 3 || [get_collection_size $io_sample] < 6} {error "MCP I2C pin boundaries changed"}
set_max_delay 40.0 -from $io_drive -to [get_ports {IO_SDA IO_SCL}]
set_min_delay 0.0 -from $io_drive -to [get_ports {IO_SDA IO_SCL}]
set_max_delay 40.0 -from [get_ports IO_SDA] -to $io_sample
set_min_delay 0.0 -from [get_ports IO_SDA] -to $io_sample
derive_clock_uncertainty
+25
View File
@@ -1,3 +1,5 @@
# Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
# Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
set_global_assignment -name VHDL_FILE rtl/sram/coco_ram.vhd set_global_assignment -name VHDL_FILE rtl/sram/coco_ram.vhd
set_global_assignment -name VHDL_FILE rtl/rom/coco_rom_cart.vhd set_global_assignment -name VHDL_FILE rtl/rom/coco_rom_cart.vhd
set_global_assignment -name VHDL_FILE rtl/rom/coco3_char_rom.vhd set_global_assignment -name VHDL_FILE rtl/rom/coco3_char_rom.vhd
@@ -37,3 +39,26 @@ set_global_assignment -name VHDL_FILE rtl/rom/coco_rom_8K.vhd
set_global_assignment -name VHDL_FILE rtl/rom/coco_rom_16.vhd set_global_assignment -name VHDL_FILE rtl/rom/coco_rom_16.vhd
set_global_assignment -name VHDL_FILE rtl/OVO.vhd set_global_assignment -name VHDL_FILE rtl/OVO.vhd
set_global_assignment -name SDC_FILE rtl/CoCo3FPGA.sdc set_global_assignment -name SDC_FILE rtl/CoCo3FPGA.sdc
set_global_assignment -name SYSTEMVERILOG_FILE rtl/cpu_sdram_bridge.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_host.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_glue.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_ay8913.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_tms7000_alu.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_tms7000_bcd.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_tms7000_decode.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_tms7000_exec.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_tms7000_io.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_tms7000_memory.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_tms7000_pacer.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_tms7000.sv
set_global_assignment -name SEARCH_PATH rtl/ssc
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_sp0256_memory.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_sp0256.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_audio.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_cartridge.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/ssc/ssc_mister_bridge.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/bh_mpi_config.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/bh_mpi_router.sv
set_global_assignment -name SYSTEMVERILOG_FILE rtl/bh_mpi_rom.sv
+43
View File
@@ -0,0 +1,43 @@
# Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
# Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
# Proven only for this MiSTer wrapper: Q=E=cpu_cycle_ena cannot be consecutive.
# See scripts/check_cpu_enable.py (actual timing-loop induction + negative test).
# Only BOTH endpoints in the qualified CPU Q/E write processes get two cycles.
set cpu_ce_bases {CpuState DMABREQLatched DMABREQSample DMABREQSample2 FIRQSample FIRQSample2 FIRQLatched HALTLatched HALTSample HALTSample2 IRQSample IRQSample2 IRQLatched Inst1 Inst2 Inst3 InstPage2 InstPage3 IntType NMIClear NMISample NMISample2 NextState a addr b cc dp ea pc rnRESET s tmp u x y}
set cpu_ce [get_registers -nowarn __no_cpu_register__]
foreach_in_collection reg [get_registers {*GLBCPU09|*}] {
set name [get_register_info -name $reg]
if {![regexp {GLBCPU09\|([A-Za-z_][A-Za-z_0-9]*)} $name unused base]} {error "Unrecognized CPU register $name"}
if {[lsearch -exact $cpu_ce_bases $base] >= 0} {
set one [get_registers -no_duplicates [list $name]]
if {[get_collection_size $one] != 1} {error "Ambiguous CPU register $name"}
set cpu_ce [add_to_collection $cpu_ce $one]
}
}
# Unnamed fitter/retiming nodes and unconditional NMI state remain single-cycle.
if {[get_collection_size $cpu_ce] < 200} {error "Incomplete Q/E-qualified CPU register scope"}
puts "CPU_CE_REGISTER_COUNT [get_collection_size $cpu_ce]"
set_multicycle_path -setup -end 2 -from $cpu_ce -to $cpu_ce
set_multicycle_path -hold -end 1 -from $cpu_ce -to $cpu_ce
# Raw request reaches only the asynchronous pins of the two release stages.
# Internal stage-to-stage data and ALL downstream release paths stay timed.
set request [get_nets {*coco3|RESET_P}]
set release [get_registers {*coco3|reset_request_release[*]}]
if {[get_collection_size $request] != 1 || [get_collection_size $release] != 2} {error "Missing exact reset request synchronizer scope"}
set_false_path -through $request -to $release
# Optional local positive-edge WD1793 release chains: asynchronous entry only.
set wd_release [get_registers -nowarn {*coco_fdc|wd_reset_release[*] *coco_sdc_top|wd_reset_release[*]}]
if {[get_collection_size $wd_release] > 0} {
if {[get_collection_size $wd_release] != 4} {error "Expected two two-stage WD reset chains"}
set reset_root [get_registers -nowarn -no_duplicates {*coco3|RESET_N *coco3|reset_main_release[1]}]
if {[get_collection_size $reset_root] != 1} {error "Missing exact disk reset root"}
set_false_path -from $reset_root -to $wd_release
}
set phase_release [get_registers -nowarn {*coco3|reset_main_release[*] *coco3|reset_positive_release[*] *coco3|reset_fast_release[*]}]
if {[get_collection_size $phase_release] > 0} {
if {[get_collection_size $phase_release] != 6} {error "Expected exactly three two-stage consumer release chains"}
set_false_path -from [get_registers {*coco3|RESET_RAW_N}] -to $phase_release
}
+23
View File
@@ -0,0 +1,23 @@
# Local ROM inputs
Everything in this folder except this README is ignored by Git. Public build
downloads do not supply the Sound & Speech chip contents. Obtain your own copies
and place these original, unmodified files in `roms/ssc/`:
| File | Bytes | SHA-256 |
|---|---:|---|
| pic-7040-510.bin | 4096 | 0013cd78482cc5f2360fdf584e9ba51d34861e8ccd9d88247f1a54039c16c365 |
| sp0256-al2.bin | 2048 | 98c280fd082169c54081e503dfe7d7d9a6fd46d4ffcc973e199ea0e1d9bc1ac9 |
These are the controller firmware and SP0256-AL2 speech ROM identities used by
the implementation and original-firmware tests. The installer rejects changed
sizes/hashes. It copies their original bytes into games/coco3plus and writes
native MiSTer remembered-file records for automatic loading. No firmware is baked
into the RBF; a CoCo reset preserves valid loaded ROMs, while reconfiguring the
FPGA requires the files to be loaded again.
CoCo boot ROMs are assembled separately from pinned ToolShed sources by
tools/build_roms.py and staged under build/roms. Neither the source download nor
this repository grants permission to distribute third-party ROM content.
Local release overlays can contain your ROM inputs: review their redistribution
rights before sharing them. SSC can be omitted with `-WithoutSSC`.
+2 -8
View File
@@ -1,11 +1,5 @@
create_clock -period 1000.000 -name img_mounted[5] [get_nodes emu:emu|hps_io:hps_io|img_mounted[5]] # Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
create_clock -period 1000.000 -name img_mounted[4] [get_nodes emu:emu|hps_io:hps_io|img_mounted[4]] # Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
create_clock -period 1000.000 -name img_mounted[3] [get_nodes emu:emu|hps_io:hps_io|img_mounted[3]]
create_clock -period 1000.000 -name img_mounted[2] [get_nodes emu:emu|hps_io:hps_io|img_mounted[2]]
create_clock -period 1000.000 -name img_mounted[1] [get_nodes emu:emu|hps_io:hps_io|img_mounted[1]]
create_clock -period 1000.000 -name img_mounted[0] [get_nodes emu:emu|hps_io:hps_io|img_mounted[0]]
create_clock -period 1000.000 -name RESET_N [get_nodes emu:emu|coco3fpga:coco3|RESET_N]
create_clock -period 1000.000 -name NMISample2 [get_nodes emu:emu|coco3fpga:coco3|mc6809x:GLBCPU09|NMISample2]
#set_false_path -from [get_nodes sysmem_lite:sysmem|sysmem_HPS_fpga_interfaces:fpga_interfaces|clocks_resets~FF_4365] #set_false_path -from [get_nodes sysmem_lite:sysmem|sysmem_HPS_fpga_interfaces:fpga_interfaces|clocks_resets~FF_4365]
#create_clock -period 17.46 -name PH_2 [get_nodes emu:emu|coco3fpga:coco3|PH_2_RAW] #create_clock -period 17.46 -name PH_2 [get_nodes emu:emu|coco3fpga:coco3|PH_2_RAW]
#create_clock -period 1000.000 -name CLK_6551[4] [get_nodes emu:emu|coco3fpga:coco3|CLK_6551[4]] #create_clock -period 1000.000 -name CLK_6551[4] [get_nodes emu:emu|coco3fpga:coco3|CLK_6551[4]]
+18 -4
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Project Name: CoCo3FPGA Version 4.0 // Project Name: CoCo3FPGA Version 4.0
// File Name: EE_Cold_Bt.v // File Name: EE_Cold_Bt.v
@@ -66,6 +68,18 @@ output EE_to_COCO // Easter Egg to the coco3
); );
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Research: qualify slow-domain control before its program-decode logic.
(* preserve *) reg [1:0] boot_control_release = 2'b00;
(* preserve *) reg [1:0] display_control_release = 2'b00;
always @(posedge CLK or posedge RESET)
if (RESET) begin
boot_control_release <= 2'b00;
display_control_release <= 2'b00;
end else begin
boot_control_release <= {boot_control_release[0], Cold_Boot};
display_control_release <= {display_control_release[0], Display_EE};
end
reg Display_EE_D = 1'b0; reg Display_EE_D = 1'b0;
reg Cold_Boot_D = 1'b0; reg Cold_Boot_D = 1'b0;
wire Start_Display_EE, Start_Cold_Boot; wire Start_Display_EE, Start_Cold_Boot;
@@ -103,8 +117,8 @@ localparam inst_SHORT_TIMER = 4'd5;
localparam inst_LONG_TIMER = 4'd6; localparam inst_LONG_TIMER = 4'd6;
localparam inst_START = 4'd8; localparam inst_START = 4'd8;
assign Start_Display_EE = ((Display_EE == 1'b1) & (Display_EE_D == 1'b0)); assign Start_Display_EE = ((display_control_release[1] == 1'b1) & (Display_EE_D == 1'b0));
assign Start_Cold_Boot = ((Cold_Boot == 1'b1) & (Cold_Boot_D == 1'b0)); assign Start_Cold_Boot = ((boot_control_release[1] == 1'b1) & (Cold_Boot_D == 1'b0));
always @ (posedge CLK or posedge RESET) always @ (posedge CLK or posedge RESET)
@@ -121,8 +135,8 @@ begin
end end
else else
begin begin
Display_EE_D <= Display_EE; Display_EE_D <= display_control_release[1];
Cold_Boot_D <= Cold_Boot; Cold_Boot_D <= boot_control_release[1];
next_instruction <= 1'b0; next_instruction <= 1'b0;
+3
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Project Name: CoCo3FPGA Version 4.0 // Project Name: CoCo3FPGA Version 4.0
// File Name: 6551rx.v // File Name: 6551rx.v
@@ -167,6 +169,7 @@ begin
RX_DATA0 <= 1'b1; RX_DATA0 <= 1'b1;
RX_DATA1 <= 1'b1; RX_DATA1 <= 1'b1;
READY <= 1'b0; READY <= 1'b0;
PARITY_ERR <= 1'b0;
end end
else else
begin begin
+57 -10
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Project Name: CoCo3FPGA Version 4.0 // Project Name: CoCo3FPGA Version 4.0
// File Name: uart_6551.v // File Name: uart_6551.v
@@ -133,6 +135,7 @@ reg TX_START;
reg TDRE; reg TDRE;
reg RDRF; reg RDRF;
reg [10:0] TX_CLK_DIV; reg [10:0] TX_CLK_DIV;
reg [3:0] baud_select;
wire TX_CLK; wire TX_CLK;
wire RX_CLK; wire RX_CLK;
wire FRAME_BUF; wire FRAME_BUF;
@@ -151,6 +154,22 @@ reg [1:0] READ_STATE;
wire GOT_DATA; wire GOT_DATA;
reg READY0; reg READY0;
reg READY1; reg READY1;
// Research: independent async-assert, synchronous-release reset trees.
// CPU state consumes falling edges; release its reset on rising edges.
(* preserve *) reg [1:0] cpu_reset_release = 2'b00;
(* preserve *) reg [1:0] serial_reset_release = 2'b00;
wire CPU_RESET_N = cpu_reset_release[1];
wire SERIAL_RESET_N = serial_reset_release[1];
wire SOFTWARE_RESET = ({RW_N, CS, RS} == 5'b00101);
always @(posedge CLK or negedge RESET_N)
if (!RESET_N) cpu_reset_release <= 2'b00;
else cpu_reset_release <= {cpu_reset_release[0], 1'b1};
// Software reset request is held in the CPU domain until its next bus event.
// Only these synchronizer async inputs see the unsynchronized reset sources.
always @(posedge CLK or negedge RESET_X)
if (!RESET_X) serial_reset_release <= 2'b00;
else serial_reset_release <= {serial_reset_release[0], 1'b1};
/* /*
Baud rate divisors Baud rate divisors
(for toggle of baud clock bit) (for toggle of baud clock bit)
@@ -173,14 +192,21 @@ F 19200 3
//assign TX_CLK_REG = TX_CLK_REG_T & XTAL_CLK_IN; //assign TX_CLK_REG = TX_CLK_REG_T & XTAL_CLK_IN;
always @ (negedge CLK or negedge RESET_X) always @ (negedge CLK or negedge SERIAL_RESET_N)
begin begin
if(!RESET_X) if(!SERIAL_RESET_N)
begin begin
TX_CLK_DIV <= 11'h000; TX_CLK_DIV <= 11'h000;
baud_select <= 0;
TX_CLK_REG_T <= 1'b0; TX_CLK_REG_T <= 1'b0;
TX_CLK_REG <= 1'b0; TX_CLK_REG <= 1'b0;
end end
else if (baud_select != CTL_REG[3:0]) begin
baud_select <= CTL_REG[3:0];
TX_CLK_DIV <= 0;
TX_CLK_REG_T <= 0;
TX_CLK_REG <= 0;
end
else else
begin begin
TX_CLK_REG <= 1'b0; TX_CLK_REG <= 1'b0;
@@ -314,9 +340,10 @@ assign RX_CLK = (CTL_REG[4] == 1'b0) ? RX_CLK_IN:
assign RESET_X = RESET_NX ? 1'b0: assign RESET_X = RESET_NX ? 1'b0:
RESET_N; RESET_N;
always @ (negedge CLK) always @ (negedge CLK or negedge SERIAL_RESET_N)
begin begin
if (TX_CLK) if (!SERIAL_RESET_N) LOOPBACK <= 0;
else if (TX_CLK)
LOOPBACK <= {LOOPBACK[6:0], TX_DATA}; //half bit time FIFO LOOPBACK <= {LOOPBACK[6:0], TX_DATA}; //half bit time FIFO
end end
@@ -347,9 +374,9 @@ assign STOP = (CTL_REG[7] == 1'b0) ? 1'b0: // Stop = 1
assign PAR_DIS = ~CMD_REG[5]; assign PAR_DIS = ~CMD_REG[5];
assign WORD_SELECT = CTL_REG[6:5]; assign WORD_SELECT = CTL_REG[6:5];
always @ (negedge CLK or negedge RESET_N) always @ (negedge CLK or negedge CPU_RESET_N)
begin begin
if(!RESET_N) if(!CPU_RESET_N)
RESET_NX <= 1'b1; RESET_NX <= 1'b1;
else else
begin begin
@@ -361,9 +388,29 @@ begin
end end
end end
always @ (negedge CLK or negedge RESET_X) always @ (negedge CLK or negedge CPU_RESET_N)
begin begin
if(!RESET_X) if(!CPU_RESET_N)
begin
RDRF <= 1'b0;
READ_STATE <= 2'b00;
TX_BUFFER <= 8'h00;
CTL_REG <= 8'h00;
// Commador data sheet says reset value is 02
// but Apple will not work unless it is 00
CMD_REG <= 8'h00;
TDRE <= 1'b1;
TX_START <= 1'b0;
RX_REG <= 8'h00;
OVERRUN <= 1'b0;
FRAME <= 1'b0;
PARITY <= 1'b0;
TX_DONE1 <= 1'b1;
TX_DONE0 <= 1'b1;
READY0 <= 1'b0;
READY1 <= 1'b0;
end
else if (RESET_NX || (PH_2 && SOFTWARE_RESET))
begin begin
RDRF <= 1'b0; RDRF <= 1'b0;
READ_STATE <= 2'b00; READ_STATE <= 2'b00;
@@ -477,7 +524,7 @@ begin
end end
uart51_tx tx( uart51_tx tx(
.RESET_N(RESET_X), .RESET_N(SERIAL_RESET_N),
.CLK(CLK), .CLK(CLK),
.BAUD_CLK(TX_CLK), .BAUD_CLK(TX_CLK),
.TX_DATA(TX_DATA), .TX_DATA(TX_DATA),
@@ -492,7 +539,7 @@ uart51_tx tx(
); );
uart51_rx rx( uart51_rx rx(
.RESET_N(RESET_X), .RESET_N(SERIAL_RESET_N),
.CLK(CLK), .CLK(CLK),
.BAUD_CLK(RX_CLK), .BAUD_CLK(RX_CLK),
.RX_DATA(RX_DATA), .RX_DATA(RX_DATA),
+79
View File
@@ -0,0 +1,79 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Coco 3 Plus persistent four-slot layout. Main's normal status exchange owns
// storage; this module migrates old settings and moves singleton devices.
module bh_mpi_config(
input wire clk,reset,input wire [63:0] requested,
output reg [63:0] accepted=0,
output reg [63:0] status_in=0,output reg status_set=0);
// Each slot: 0 empty,1 ROM,2 floppy,3 SDC,4 SSC,5 Orchestra,6 legacy audio,
// 7 RS232. Audio is an explicitly named convenience combination preserving the old
// independent Orchestra plus switchable SSC, not a physical cartridge claim.
localparam [11:0] ORIGINAL={3'd2,3'd1,3'd3,3'd6};
reg [63:0] last_requested=~64'd0;
reg pending=0;
reg host_started=0;
reg [63:0] next_status;
reg [11:0] layout;
reg [4:0] used,mask,remaining;
reg [2:0] kind;
reg has_ssc;
integer i,j,primary,order;
function [4:0] devices(input [2:0] k);
begin case(k)
2:devices=1;3:devices=2;4:devices=4;5:devices=8;
6:devices=12;7:devices=16;default:devices=0;
endcase end
endfunction
always_comb begin
next_status=requested;
if(!requested[63])begin
next_status[63]=1;
next_status[13:12]=requested[13:12]+2'd1;
next_status[54:43]=ORIGINAL;
end
layout=next_status[54:43];primary=0;
// Most recently edited slot wins; a persisted multi-edit has a deterministic
// highest changed slot. Read-only/default fields never move devices.
for(i=0;i<4;i=i+1)
if(layout[i*3+:3]!=accepted[43+i*3+:3])primary=i;
used=0;
for(order=0;order<5;order=order+1)begin
j=(order==0)?primary:order-1;
if(order==0||j!=primary)begin
kind=layout[j*3+:3];mask=devices(kind);remaining=mask&~used;
if(mask!=0&&remaining!=mask)begin
if(kind==6&&remaining==4)kind=4;
else if(kind==6&&remaining==8)kind=5;
else kind=0;
end
layout[j*3+:3]=kind;used=used|devices(kind);
end
end
next_status[54:43]=layout;
has_ssc=0;
for(i=0;i<4;i=i+1)has_ssc=has_ssc||layout[i*3+:3]==4||layout[i*3+:3]==6;
if(!has_ssc)next_status[42]=0;
if(requested[63]&&layout[primary*3+:3]==4&&
accepted[43+primary*3+:3]!=4)next_status[42]=1;
end
always @(posedge clk)begin
status_set<=0;
if(reset)begin
accepted<=0;last_requested<=~64'd0;pending<=0;status_in<=0;host_started<=0;
end else begin
if(requested[0])host_started<=1;
// Main polls status requests after every FC transfer; acknowledgement clears
// bit0. Publishing default migration during initialization would prematurely
// end its reset-held ROM-loading phase. Wait for Main's own final release,
// and never publish a pending snapshot while a newer host value is arriving.
if(host_started&&!requested[0]&&requested==last_requested&&pending&&!status_set)
begin status_set<=1;pending<=0;end
if(requested!=last_requested)begin
last_requested<=requested;accepted<=next_status;
status_in<=next_status;pending<=requested!=next_status;
end
end
end
endmodule
+129
View File
@@ -0,0 +1,129 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Four private ROM address spaces, up to128 KiB each, sharing256 KiB of16 KiB
// blocks. Four full128 KiB memories exceed this core's fitted M10K budget.
// Same synchronous read edge as the previous COCO_ROM_CART. Loading one slot
// never overwrites another or the built-in disk ROM. Partial/oversized streams
// cannot expose stale bytes as a successfully loaded cartridge.
module bh_mpi_rom(
input wire clk,power_reset,input wire [1:0] read_slot,
input wire [16:0] read_address,output wire [7:0] read_data,
input wire download,wr,input wire [7:0] file_index,
input wire [24:0] address,input wire [7:0] data,
output wire loading,output reg [3:0] valid=0,fault=0,
output reg loaded_pulse=0,input wire [3:0] enabled);
reg [7:0] memory[0:262143];
reg [3:0] blocks[0:31];
reg [15:0] owned[0:3];
reg [15:0] used=0;
// HPS changes its bus on the opposite edge. Capture raw fields first; all
// allocation/validation/RAM write logic then has a full clock period rather
// than decoding HPS index and driving256 M10Ks in half a period.
reg p_download=0,p_wr=0;
reg [7:0] p_file_index=0,p_data=0;
reg [24:0] p_address=0;
reg [17:0] lengths[0:3];
reg [16:0] masks[0:3];
wire [5:0] index=p_file_index[5:0];
wire selected=index==1||index==6||index==7||index==8||index==9;
wire [1:0] target=index==6?0:index==7?1:index==9?3:2;
reg active=0;
reg [1:0] slot;
reg [5:0] saved_index;
reg [17:0] count;
reg malformed;
reg [7:0] sampled;
reg sampled_valid=0;
reg [16:0] next_mask;
reg [15:0] start_used;
reg [15:0] released;
reg [4:0] available_block;
integer n;
integer k;
wire [16:0] offset=read_address&masks[read_slot];
function [4:0] find_free(input [15:0] occupancy);
integer b;
begin find_free=16;
for(b=15;b>=0;b=b-1)if(!occupancy[b])find_free=b;
end
endfunction
always_comb begin
start_used=0;released=0;
for(k=0;k<4;k=k+1)begin
if(k!=target&&enabled[k])start_used=start_used|owned[k];
if(!enabled[k])released=released|owned[k];
end
end
wire raw_selected=file_index[5:0]==1||file_index[5:0]==6||
file_index[5:0]==7||file_index[5:0]==8||file_index[5:0]==9;
wire [1:0] raw_target=file_index[5:0]==6?0:file_index[5:0]==7?1:file_index[5:0]==9?3:2;
assign loading=(download&&raw_selected&&enabled[raw_target])||
(p_download&&selected&&enabled[target])||active;
assign read_data=sampled_valid?sampled:8'hff;
always @(posedge clk)begin
loaded_pulse<=0;
sampled<=memory[{blocks[{read_slot,offset[16:14]}],offset[13:0]}];
sampled_valid<=valid[read_slot]&&
({1'b0,(read_address&masks[read_slot])}<lengths[read_slot]);
if(power_reset)begin
p_download<=0;p_wr<=0;p_file_index<=0;p_address<=0;p_data<=0;
valid<=0;fault<=0;active<=0;sampled_valid<=0;count<=0;malformed<=0;
used<=0;
for(n=0;n<4;n=n+1)begin lengths[n]<=0;masks[n]<=0;owned[n]<=0;end
end else begin
p_download<=download;p_wr<=wr;p_file_index<=file_index;
p_address<=address;p_data<=data;
used<=used&~released;
for(n=0;n<4;n=n+1)if(!enabled[n])begin
valid[n]<=0;fault[n]<=0;owned[n]<=0;lengths[n]<=0;
end
if(active&&!enabled[slot])begin
active<=0;used<=used&~released;
end else if(p_download&&selected&&enabled[target]&&!active)begin
active<=1;slot<=target;saved_index<=index;count<=p_wr?1:0;
malformed<=p_wr&&p_address!=0;valid[target]<=0;fault[target]<=0;
used<=start_used;owned[target]<=0;
if(p_wr&&p_address==0)begin
available_block=find_free(start_used);
if(available_block==16)malformed<=1;
else begin
blocks[{target,3'd0}]<=available_block[3:0];
used<=start_used|(16'b1<<available_block);
owned[target]<=16'b1<<available_block;
memory[{available_block[3:0],14'd0}]<=p_data;
end
end
end else if(active&&p_download&&p_wr)begin
if(index!=saved_index||p_address!={7'd0,count}||count>=131072)
malformed<=1;
else if(!malformed)begin
if(p_address[13:0]==0)begin
available_block=find_free(used&~released);
if(available_block==16)malformed<=1;
else begin
blocks[{slot,p_address[16:14]}]<=available_block[3:0];
used<=(used&~released)|(16'b1<<available_block);
owned[slot]<=owned[slot]|(16'b1<<available_block);
memory[{available_block[3:0],14'd0}]<=p_data;
end
end else memory[{blocks[{slot,p_address[16:14]}],p_address[13:0]}]<=p_data;
end
if(count<131073)count<=count+1'd1;
end
if(active&&enabled[slot]&&!p_download)begin
active<=0;
if(!malformed&&count!=0&&count<=131072)begin
lengths[slot]<=count;next_mask=count-1'd1;
next_mask=next_mask|(next_mask>>1);next_mask=next_mask|(next_mask>>2);
next_mask=next_mask|(next_mask>>4);next_mask=next_mask|(next_mask>>8);
next_mask=next_mask|(next_mask>>16);
masks[slot]<=next_mask;valid[slot]<=1;loaded_pulse<=1;
end else begin
valid[slot]<=0;fault[slot]<=1;lengths[slot]<=0;
used<=(used&~released)&~owned[slot];owned[slot]<=0;
end
end
end
end
endmodule
+29
View File
@@ -0,0 +1,29 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// One shared engine per controller, independently placeable in four sockets.
// ROM and SCS selectors remain separate, software-addressable MPI fields.
module bh_mpi_router(
input wire [11:0] layout,input wire [1:0] cts,scs,
output wire [2:0] rom_kind,io_kind,
output wire floppy_io,sdc_io,rom_io,serial_io,
output reg ssc_present,orchestra_present,floppy_present,sdc_present);
assign rom_kind=layout[cts*3+:3];
assign io_kind=layout[scs*3+:3];
assign floppy_io=io_kind==2;
assign sdc_io=io_kind==3;
assign rom_io=io_kind==1||io_kind==5||io_kind==6;
// Legacy floppy/SDC setups include the existing RS232 endpoint. A separate
// RS232 device can also be assigned without requiring a storage controller.
assign serial_io=io_kind==2||io_kind==3||io_kind==7;
integer n;
always_comb begin
ssc_present=0;orchestra_present=0;floppy_present=0;sdc_present=0;
for(n=0;n<4;n=n+1)begin
ssc_present=ssc_present||(layout[n*3+:3]==4)||(layout[n*3+:3]==6);
orchestra_present=orchestra_present||(layout[n*3+:3]==5)||(layout[n*3+:3]==6);
floppy_present=floppy_present||(layout[n*3+:3]==2);
sdc_present=sdc_present||(layout[n*3+:3]==3);
end
end
endmodule
+206 -133
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Project Name: CoCo3FPGA Version 5.x.x // Project Name: CoCo3FPGA Version 5.x.x
// File Name: coco3fpga.sv // File Name: coco3fpga.sv
@@ -83,6 +85,17 @@ input CLK_57,
input CLK_28, input CLK_28,
input CLK_14, input CLK_14,
// Research cartridge extension; FPGA power reset is distinct from CoCo reset.
input SSC_POWER_RESET,
input SSC_MODE,
input [11:0] MPI_LAYOUT,
input MPI_BOOT_LOADING,
output [3:0] MPI_ROM_FAULT,
output MPI_ROM_LOADING,
output MPI_ROM_LOADED,
output SSC_READY,
output SSC_FAULT,
input COCO_RESET_N, input COCO_RESET_N,
// Video // Video
@@ -263,13 +276,28 @@ wire PH_2;
`ifndef CoCo3_CYC_ACC_6809 `ifndef CoCo3_CYC_ACC_6809
reg PH_2_RAW; reg PH_2_RAW;
`endif `endif
reg RESET_N; reg RESET_RAW_N;
(* preserve *) reg [1:0] reset_main_release = 2'b00;
(* preserve *) reg [1:0] reset_positive_release = 2'b00;
(* preserve *) reg [1:0] reset_fast_release = 2'b00;
wire RESET_N = reset_main_release[1];
wire RESET_POS_N = reset_positive_release[1];
wire RESET_FAST_N = reset_fast_release[1];
always @(negedge clk_sys or negedge RESET_RAW_N)
if (!RESET_RAW_N) reset_main_release <= 2'b00;
else reset_main_release <= {reset_main_release[0], 1'b1};
always @(posedge clk_sys or negedge RESET_RAW_N)
if (!RESET_RAW_N) reset_positive_release <= 2'b00;
else reset_positive_release <= {reset_positive_release[0], 1'b1};
always @(posedge CLK_114 or negedge RESET_RAW_N)
if (!RESET_RAW_N) reset_fast_release <= 2'b00;
else reset_fast_release <= {reset_fast_release[0], 1'b1};
reg [6:0] CPU_RESET_SM; reg [6:0] CPU_RESET_SM;
reg CPU_RESET; reg CPU_RESET;
wire RESET_INS; wire RESET_INS;
reg MUGS = 0; reg MUGS = 0;
wire RESET; wire RESET;
wire RESET_P; (* keep *) wire RESET_P;
wire [15:0] ADDRESS; wire [15:0] ADDRESS;
wire [11:0] BLOCK_ADDRESS; // 5:0 for 512kb wire [11:0] BLOCK_ADDRESS; // 5:0 for 512kb
wire RW_N; wire RW_N;
@@ -335,6 +363,29 @@ wire HDD_EN_DATA;
reg [1:0] MPI_SCS; // IO select reg [1:0] MPI_SCS; // IO select
reg [1:0] MPI_CTS; // ROM select reg [1:0] MPI_CTS; // ROM select
wire [2:0] mpi_rom_kind,mpi_io_kind;
wire mpi_floppy_io,mpi_sdc_io,mpi_rom_io,mpi_serial_io;
wire mpi_ssc_present,mpi_orchestra_present,mpi_floppy_present,mpi_sdc_present;
bh_mpi_router mpi_router(.layout(MPI_LAYOUT),.cts(MPI_CTS),.scs(MPI_SCS),
.rom_kind(mpi_rom_kind),.io_kind(mpi_io_kind),.floppy_io(mpi_floppy_io),
.sdc_io(mpi_sdc_io),.rom_io(mpi_rom_io),.serial_io(mpi_serial_io),
.ssc_present(mpi_ssc_present),.orchestra_present(mpi_orchestra_present),
.floppy_present(mpi_floppy_present),.sdc_present(mpi_sdc_present));
wire mpi_rom_selected=mpi_rom_kind==1||mpi_rom_kind==5||mpi_rom_kind==6;
wire [3:0] mpi_rom_valid;
wire [3:0] mpi_rom_enabled;
genvar mpi_rom_socket;
generate for(mpi_rom_socket=0;mpi_rom_socket<4;mpi_rom_socket=mpi_rom_socket+1)begin: rom_socket_enable
wire [2:0] device_kind=MPI_LAYOUT[mpi_rom_socket*3+:3];
// Main parses FC records before loading its saved status/configuration. Keep
// startup transfers until that reset-held phase ends, then discard sockets
// absent from the restored layout. Ordinary reset does not reload FC files.
assign mpi_rom_enabled[mpi_rom_socket]=MPI_BOOT_LOADING||device_kind==1||device_kind==5||device_kind==6;
end endgenerate
wire ssc_mode_active=SSC_MODE&&mpi_ssc_present;
wire [7:0] mpi_orch_left=mpi_orchestra_present?ORCH_LEFT:8'h80;
wire [7:0] mpi_orch_right=mpi_orchestra_present?ORCH_RIGHT:8'h80;
reg SBS; reg SBS;
reg [11:0] SAM00; // 8MB 5:0 for 512kb reg [11:0] SAM00; // 8MB 5:0 for 512kb
reg [11:0] SAM01; reg [11:0] SAM01;
@@ -415,7 +466,9 @@ wire [7:0] DATA_HDD;
wire RS232_EN; wire RS232_EN;
wire RX_CLK2; wire RX_CLK2;
wire [7:0] DATA_RS232; wire [7:0] DATA_RS232;
reg [2:0] ROM_BANK; reg [2:0] rom_banks[0:3];
wire [2:0] ROM_BANK=rom_banks[MPI_CTS];
integer rom_bank_index;
wire SLOT3_HW; wire SLOT3_HW;
reg TICK0; reg TICK0;
reg TICK1; reg TICK1;
@@ -570,6 +623,18 @@ reg ANALOG;
wire VDAC_EN; wire VDAC_EN;
wire [15:0] VDAC_OUT; wire [15:0] VDAC_OUT;
wire ssc_palette_owner,ssc_read_valid,ssc_files_valid,ssc_operational,ssc_chip_fault;
wire [7:0] ssc_read_data,ssc_host_data,ssc_chip_read_data,ssc_status;
wire [15:0] ssc_host_address,ssc_debug_pc;
wire ssc_host_read,ssc_host_write,ssc_cartridge_reset,ssc_chip_read_valid;
wire ssc_pic_begin,ssc_pic_write,ssc_speech_begin,ssc_speech_write;
wire [11:0] ssc_pic_address;
wire [10:0] ssc_speech_address;
wire [7:0] ssc_pic_data,ssc_speech_data;
wire ssc_pic_loaded,ssc_speech_loaded,ssc_audio_valid,ssc_standby,ssc_activity;
wire signed [15:0] ssc_audio;
wire [15:0] ssc_legacy_left,ssc_legacy_right;
wire CART_INT_N; wire CART_INT_N;
reg CART_INT_N_D; reg CART_INT_N_D;
wire VSYNC_INT_N; wire VSYNC_INT_N;
@@ -797,11 +862,8 @@ assign FLASH_ADDRESS = ENA_DSK ? {9'b000000000, ADDRESS[12:0]
//10 32 Internal //10 32 Internal
//11 32 External //11 32 External
assign FLASH_CE_S = ROM_SEL ? 1'b1: // Empty cartridge sockets read an open bus, not the internal system ROM.
ENA_DISK2 ? 1'b1: assign FLASH_CE_S = ROM_SEL || CART_SEL;
ENA_PAK ? 1'b1:
ENA_DSK ? 1'b1:
1'b0;
wire [7:0] COCO3_ROM_DATA; wire [7:0] COCO3_ROM_DATA;
wire [7:0] COCO3_DISK_ROM_DATA; wire [7:0] COCO3_DISK_ROM_DATA;
@@ -814,8 +876,9 @@ localparam [5:0] BOOT = 6'd0;
wire COCO3_ROM_WRITE = (ioctl_index[7:0] == {BOOT0, BOOT}) & ioctl_wr; wire COCO3_ROM_WRITE = (ioctl_index[7:0] == {BOOT0, BOOT}) & ioctl_wr;
wire COCO3_DISKROM_WRITE = (ioctl_index[7:0] == {BOOT1, BOOT}) & ioctl_wr; wire COCO3_DISKROM_WRITE = ((ioctl_index[7:0] == {BOOT1, BOOT}) ||
wire COCO3_CART_WRITE = (ioctl_index[5:0] == 6'd1) & ioctl_wr & !cart_lock; (ioctl_index[5:0] == 6'd10)) & ioctl_wr;
// Program-ROM streaming and validity are owned by bh_mpi_rom below.
reg rom_loaded = 1'b0; reg rom_loaded = 1'b0;
@@ -858,52 +921,34 @@ COCO_ROM_8K CC3_DISK_ROM(
); );
assign FLASH_DATA = ENA_PAK ? CART_DATA: assign FLASH_DATA = CART_SEL ?
(ENA_DSK || ENA_DISK2) ? COCO3_DISK_ROM_DATA: (mpi_rom_selected ? CART_DATA :
(mpi_rom_kind==2||mpi_rom_kind==3) ? COCO3_DISK_ROM_DATA : 8'hff) :
COCO3_ROM_DATA; COCO3_ROM_DATA;
bh_mpi_rom mpi_program_roms(.clk(~clk_sys),.power_reset(SSC_POWER_RESET),
COCO_ROM_CART CC3_ROM_CART( .read_slot(MPI_CTS),.read_address(FLASH_ADDRESS[16:0]),.read_data(CART_DATA),
.ADDR(FLASH_ADDRESS[16:0]), .download(ioctl_download),.wr(ioctl_wr),.file_index(ioctl_index[7:0]),
.DATA(CART_DATA), .address(ioctl_addr),.data(ioctl_data),.loading(MPI_ROM_LOADING),
.CLK(~clk_sys), .valid(mpi_rom_valid),.fault(MPI_ROM_FAULT),.loaded_pulse(MPI_ROM_LOADED),
.WR_ADDR(ioctl_addr[16:0]), .enabled(mpi_rom_enabled));
.WR_DATA(ioctl_data[7:0]),
.WRITE(COCO3_CART_WRITE)
);
wire SDC_EN_CS; wire SDC_EN_CS;
assign ENA_DISK2=CART_SEL&&mpi_rom_kind==3;
assign ENA_DISK2 = ({CART_SEL, MPI_CTS} == 3'b101) ? 1'b1: // Alternative Disk controller ROM up to 32K assign ENA_PAK=CART_SEL&&mpi_rom_selected;
1'b0; assign ENA_DSK=CART_SEL&&mpi_rom_kind==2;
assign ENA_PAK = ({CART_SEL, MPI_CTS} == 3'b110) ? 1'b1: // ROM SLOT 3
1'b0;
assign ENA_DSK = ({CART_SEL, MPI_CTS} == 3'b111) ? 1'b1: // Disk C000-DFFF Slot 4
1'b0;
`ifdef CoCo3_sdc_fix_os9_driver `ifdef CoCo3_sdc_fix_os9_driver
assign HDD_EN = ({ext_response, MPI_SCS, ADDRESS[15:5]} == 15'b01111111111010) ? 1'b1: // FF40-FF5F with MPI switch = 4 assign HDD_EN=mpi_floppy_io&&ADDRESS[15:5]==11'h7fa&&
1'b0; !(ext_response&&mpi_sdc_present);
assign SDC_EN_CS=(mpi_sdc_io||(ext_response&&mpi_sdc_present))&&
assign SDC_EN_CS = (({MPI_SCS, ADDRESS[15:5]} == 13'b0111111111010) | ADDRESS[15:5]==11'h7fa;
((ADDRESS[15:5] == 11'b11111111010) & ext_response)) ? 1'b1: // FF40-FF5F with MPI switch = 2
1'b0;
`else `else
assign HDD_EN = ({MPI_SCS, ADDRESS[15:5]} == 13'b1111111111010) ? 1'b1: // FF40-FF5F with MPI switch = 4 assign HDD_EN=mpi_floppy_io&&ADDRESS[15:5]==11'h7fa;
1'b0; assign SDC_EN_CS=mpi_sdc_io&&ADDRESS[15:5]==11'h7fa;
assign SDC_EN_CS = ({MPI_SCS, ADDRESS[15:5]} == 13'b0111111111010) ? 1'b1: // FF40-FF5F with MPI switch = 2
1'b0;
`endif `endif
assign RS232_EN=mpi_serial_io&&ADDRESS[15:2]==14'h3fda;
//assign RS232_EN = ({MPI_SCS, ADDRESS[15:2]} == 16'b0011111111011010) ? 1'b1: //FF68-FF6B - Now in slot 1 // Bank writes follow the independently selected I/O socket.
// 1'b0 ; assign SLOT3_HW=mpi_rom_io&&ADDRESS[15:5]==11'h7fa;
assign RS232_EN = ({MPI_SCS[0], ADDRESS[15:2]} == 15'b111111111011010) ? 1'b1: //FF68-FF6B - Now in slot 2 and 4
1'b0;
assign SLOT3_HW = ({SWITCH[2:1], ADDRESS[15:5]} == 13'b1011111111010) ? 1'b1: // FF40-FF5F Ensure this only appears in slot 3 PHYSICALLY
1'b0;
assign VDAC_EN = ({RW_N,ADDRESS[15:0]} == 17'H0FF7E) ? 1'b1: // FF7E assign VDAC_EN = ({RW_N,ADDRESS[15:0]} == 17'H0FF7E) ? 1'b1: // FF7E
1'b0; 1'b0;
@@ -917,7 +962,8 @@ always @(negedge clk_sys or negedge RESET_N)
begin begin
if(!RESET_N) if(!RESET_N)
begin begin
ROM_BANK <= 3'b000; for(rom_bank_index=0;rom_bank_index<4;rom_bank_index=rom_bank_index+1)
rom_banks[rom_bank_index] <= 3'b000;
end end
else else
begin begin
@@ -925,7 +971,7 @@ begin
case (ADDRESS[4:0]) case (ADDRESS[4:0])
5'h00: 5'h00:
begin begin
ROM_BANK <= DATA_OUT[2:0]; rom_banks[MPI_SCS] <= DATA_OUT[2:0];
end end
endcase endcase
end end
@@ -1067,13 +1113,14 @@ end
assign DATA_IN = assign DATA_IN =
ssc_read_valid ? ssc_read_data :
(sdram_BE_0) ? hold_data_L[7:0]: (sdram_BE_0) ? hold_data_L[7:0]:
(sdram_BE_1) ? hold_data_L[15:8]: (sdram_BE_1) ? hold_data_L[15:8]:
FLASH_CE_S ? FLASH_DATA: FLASH_CE_S ? FLASH_DATA:
SDC_EN_CS ? DATA_SDC: // needs priority due to nitros9 llcocosdc ddriver bug SDC_EN_CS ? DATA_SDC: // needs priority due to nitros9 llcocosdc ddriver bug
HDD_EN ? DATA_HDD: HDD_EN ? DATA_HDD:
RS232_EN ? DATA_RS232: RS232_EN ? DATA_RS232:
SLOT3_HW ? {5'b00000, ROM_BANK}: SLOT3_HW ? {5'b00000, rom_banks[MPI_SCS]}:
// FF00, FF04, FF08, FF0C, FF10, FF14, FF18, FF1C // FF00, FF04, FF08, FF0C, FF10, FF14, FF18, FF1C
({ADDRESS[15:5], ADDRESS[1:0]} == 13'b11111111000_00) ? DATA_REG1: ({ADDRESS[15:5], ADDRESS[1:0]} == 13'b11111111000_00) ? DATA_REG1:
// FF01, FF05, FF09, FF0D, FF11, FF15, FF19, FF1D // FF01, FF05, FF09, FF0D, FF11, FF15, FF19, FF1D
@@ -1205,10 +1252,20 @@ wire AMW_End;
assign AMW_ACK = AMW_End; assign AMW_ACK = AMW_End;
// A ROM transfer holds the system reset. Its short completion pulse cannot
// survive the143ms system-release delay; retain the cold-start request until
// the real AMW sequencer reaches its ready state and consumes the first write.
reg mpi_rom_cold_pending=0;
always @(negedge clk_sys)begin
if(SSC_POWER_RESET)mpi_rom_cold_pending<=0;
else if(MPI_ROM_LOADING)mpi_rom_cold_pending<=1;
else if(AMW_EN)mpi_rom_cold_pending<=0;
end
AMW coco_AMW ( AMW coco_AMW (
.CLK(clk_sys), .CLK(clk_sys),
.RESET_N(RESET_N), .RESET_N(RESET_N),
.Trigger(AMW_Trigger), .Trigger(AMW_Trigger || (mpi_rom_cold_pending && AMW_Ready)),
.Restart(1'b0), .Restart(1'b0),
.Cycle_Run(AMW_WR), .Cycle_Run(AMW_WR),
.AMW_Adrs(AMW_Adrs), .AMW_Adrs(AMW_Adrs),
@@ -1224,6 +1281,14 @@ reg [15:0] hold_data, hold_data_L;
reg RAM0_BE0_L, RAM0_BE1_L; reg RAM0_BE0_L, RAM0_BE1_L;
reg clear_data_ready, data_ready; reg clear_data_ready, data_ready;
// Research: matching fast-clock falling-edge observations of completion.
reg data_ready_phase;
reg [15:0] hold_data_phase;
always @(negedge CLK_114 or posedge clear_data_ready)
if (clear_data_ready) data_ready_phase <= 1'b0;
else data_ready_phase <= data_ready;
always @(negedge CLK_114) hold_data_phase <= hold_data;
always @(posedge CLK_114 or posedge clear_data_ready) always @(posedge CLK_114 or posedge clear_data_ready)
begin begin
if (clear_data_ready) if (clear_data_ready)
@@ -1314,14 +1379,14 @@ begin
// If we are in hold were done @ data_ready. // If we are in hold were done @ data_ready.
if (hold) if (hold)
begin begin
if (data_ready) if (data_ready_phase)
begin begin
// Hold states are done - kill hold and set end hold to drive data // Hold states are done - kill hold and set end hold to drive data
hold <= 1'b0; hold <= 1'b0;
end_hold <= 1'b1; end_hold <= 1'b1;
cpu_cycle_ena <= 1'b1; // Cycle at the end of a memory transaction cpu_cycle_ena <= 1'b1; // Cycle at the end of a memory transaction
clear_data_ready <= 1'b1; clear_data_ready <= 1'b1;
hold_data_L <= hold_data; hold_data_L <= hold_data_phase;
sdram_BE_0 <= RAM0_BE0_L; sdram_BE_0 <= RAM0_BE0_L;
sdram_BE_1 <= RAM0_BE1_L; sdram_BE_1 <= RAM0_BE1_L;
end end
@@ -1504,15 +1569,23 @@ begin
MUGS <= RESET_INS; //This is holding a <ctrl><alt><ins> across a reset to activate the Easter Egg MUGS <= RESET_INS; //This is holding a <ctrl><alt><ins> across a reset to activate the Easter Egg
end end
always @ (posedge clk_sys or posedge RESET_P) // Research: asynchronous request assertion, two-edge synchronized release.
(* preserve, altera_attribute = "-name SYNCHRONIZER_IDENTIFICATION FORCED_IF_ASYNCHRONOUS" *)
reg [1:0] reset_request_release = 2'b00;
always @(posedge clk_sys or posedge RESET_P)
if (RESET_P) reset_request_release <= 2'b00;
else reset_request_release <= {reset_request_release[0], 1'b1};
wire reset_request = !reset_request_release[1];
always @ (posedge clk_sys or posedge reset_request)
begin begin
reg [24:0] RESET_SM; reg [24:0] RESET_SM;
if(RESET_P) if(reset_request)
begin begin
RESET_SM <= 25'd0; RESET_SM <= 25'd0;
CPU_RESET <= 1'b1; CPU_RESET <= 1'b1;
RESET_N <= 1'b0; RESET_RAW_N <= 1'b0;
end end
else else
begin begin
@@ -1521,7 +1594,7 @@ begin
// Take away RESET_N // Take away RESET_N
// Leave CPU_RESET Asserted // Leave CPU_RESET Asserted
begin begin
RESET_N <= 1'b1; RESET_RAW_N <= 1'b1;
CPU_RESET <= 1'b1; CPU_RESET <= 1'b1;
RESET_SM <= RESET_SM + 1'b1; RESET_SM <= RESET_SM + 1'b1;
end end
@@ -1529,7 +1602,7 @@ begin
// Take away RESET_N & CPU_RESET // Take away RESET_N & CPU_RESET
// Stop RESET_SM count // Stop RESET_SM count
begin begin
RESET_N <= 1'b1; RESET_RAW_N <= 1'b1;
CPU_RESET <= 1'b0; CPU_RESET <= 1'b0;
end end
default: default:
@@ -1617,7 +1690,7 @@ wire BUFFER_WRITE;
coco_mem_fetch video_fetch( coco_mem_fetch video_fetch(
.fast_clk(CLK_114), .fast_clk(CLK_114),
.RESET_N(RESET_N), .RESET_N(RESET_FAST_N),
// Memory Controller I/O // Memory Controller I/O
.SDRAM_VID_REQ(sdram_vid_req), .SDRAM_VID_REQ(sdram_vid_req),
@@ -1780,57 +1853,14 @@ sdc_top coco_sdc_top(
); );
reg cart_firq_enable; // A loaded ROM drives the cartridge-present/autostart input only when CTS
// selects its socket. Serial IRQ retains its own selected-controller path.
reg firq_trig; always @(negedge clk_sys or negedge RESET_N)begin
reg cart_lock; if(!RESET_N)CART_INT_IN_N<=1;
else if(PH_2)begin
always @(negedge clk_sys or negedge RESET_N) CART_INT_IN_N <=
begin (mpi_rom_selected&&mpi_rom_valid[MPI_CTS] ? !CART_INT_IN_N : 1'b1) &
if(!RESET_N) (mpi_serial_io ? SER_IRQ : 1'b1);
begin
firq_trig <= 1'b0;
cart_firq_enable <= 1'b1;
cart_lock <= 1'b0;
end
else
begin
if ((ioctl_index[5:0] == 6'd1) & ioctl_download)
firq_trig <= 1'b1;
if (firq_trig)
if (!ioctl_download)
begin
cart_firq_enable <= 1'b0;
cart_lock <= 1'b1;
end
end
end
//***********************************************************************
// Interrupt Sources
//***********************************************************************
// Org FPGA code
always @(negedge clk_sys or negedge RESET_N)
begin
if(!RESET_N)
begin
CART_INT_IN_N <= 1'b1;
end
else
begin
if (PH_2)
case (MPI_SCS)
2'b00:
CART_INT_IN_N <= (SER_IRQ);
2'b01:
CART_INT_IN_N <= (SER_IRQ);
2'b10:
CART_INT_IN_N <= (!CART_INT_IN_N | cart_firq_enable);
2'b11:
CART_INT_IN_N <= (SER_IRQ);
endcase
end end
end end
@@ -3017,11 +3047,11 @@ begin
16'hFF7A: 16'hFF7A:
begin begin
ORCH_LEFT <= DATA_OUT; if(mpi_orchestra_present)ORCH_LEFT <= DATA_OUT;
end end
16'hFF7B: 16'hFF7B:
begin begin
ORCH_RIGHT <= DATA_OUT; if(mpi_orchestra_present)ORCH_RIGHT <= DATA_OUT;
end end
16'hFF7F: 16'hFF7F:
begin begin
@@ -3560,8 +3590,35 @@ end
assign SOUND = SOUND_EN ? {SOUND_DTOA, 2'b00}: assign SOUND = SOUND_EN ? {SOUND_DTOA, 2'b00}:
{SBS,SBS,SBS,SBS,SBS,SBS, 2'b00}; {SBS,SBS,SBS,SBS,SBS,SBS, 2'b00};
assign SOUND_LEFT = {ORCH_LEFT, ORCH_LEFT} + {SOUND, SOUND}; assign ssc_legacy_left = {mpi_orch_left,mpi_orch_left}+{SOUND,SOUND};
assign SOUND_RIGHT = {ORCH_RIGHT, ORCH_RIGHT} + {SOUND, SOUND}; assign ssc_legacy_right = {mpi_orch_right,mpi_orch_right}+{SOUND,SOUND};
ssc_mister_bridge ssc_bridge(
.clk(clk_sys),.reset(SSC_POWER_RESET),.cpu_reset(!RESET_POS_N),.mode(ssc_mode_active),
.cpu_commit(PH_2),.cpu_rnw(RW_N),.cpu_address(ADDRESS),.cpu_data(DATA_OUT),
.ioctl_download(ioctl_download),.ioctl_wr(ioctl_wr),.ioctl_index(ioctl_index[7:0]),
.ioctl_address(ioctl_addr),.ioctl_data(ioctl_data),
.cartridge_operational(ssc_operational),.cartridge_fault(ssc_chip_fault),
.cartridge_read_data(ssc_status),.cartridge_audio(ssc_audio),
.sound_enable(SOUND_EN),.sound_select(SEL),.orchestra_left(mpi_orch_left),.orchestra_right(mpi_orch_right),
.legacy_left(ssc_legacy_left),.legacy_right(ssc_legacy_right),
.cartridge_reset(ssc_cartridge_reset),.host_read(ssc_host_read),.host_write(ssc_host_write),
.host_address(ssc_host_address),.host_data(ssc_host_data),
.read_valid(ssc_read_valid),.read_data(ssc_read_data),.palette_owner(ssc_palette_owner),
.rom_files_valid(ssc_files_valid),.load_fault(SSC_FAULT),
.pic_begin(ssc_pic_begin),.pic_write(ssc_pic_write),.pic_address(ssc_pic_address),.pic_data(ssc_pic_data),
.speech_begin(ssc_speech_begin),.speech_write(ssc_speech_write),.speech_address(ssc_speech_address),.speech_data(ssc_speech_data),
.audio_left(SOUND_LEFT),.audio_right(SOUND_RIGHT));
assign SSC_READY=mpi_ssc_present&&ssc_files_valid&&ssc_operational;
ssc_cartridge #(.CLOCK_HZ(57272727)) ssc(
.clk(clk_sys),.reset(SSC_POWER_RESET),.cartridge_reset(ssc_cartridge_reset),.enable(ssc_mode_active),
.host_read(ssc_host_read),.host_write(ssc_host_write),.host_address(ssc_host_address),.host_data(ssc_host_data),
.host_read_valid(ssc_chip_read_valid),.host_read_data(ssc_chip_read_data),
.status(ssc_status),
.pic_rom_begin(ssc_pic_begin),.pic_rom_write(ssc_pic_write),.pic_rom_address(ssc_pic_address),.pic_rom_data(ssc_pic_data),
.speech_rom_begin(ssc_speech_begin),.speech_rom_write(ssc_speech_write),.speech_rom_address(ssc_speech_address),.speech_rom_data(ssc_speech_data),
.pic_loaded(ssc_pic_loaded),.speech_loaded(ssc_speech_loaded),.operational(ssc_operational),.fault(ssc_chip_fault),
.audio_sample(ssc_audio),.audio_valid(ssc_audio_valid),.speech_standby(ssc_standby),.sound_activity(ssc_activity),.debug_pc(ssc_debug_pc));
// the DAC isn't really a DAC but represents the DAC chip on the schematic. // the DAC isn't really a DAC but represents the DAC chip on the schematic.
@@ -3709,17 +3766,21 @@ assign KEYBOARD_IN[5] = !((!KEY_COLUMN[0] & KEY[40]) // 8
| (!KEY_COLUMN[6] & KEY[46]) // . | (!KEY_COLUMN[6] & KEY[46]) // .
| (!KEY_COLUMN[7] & KEY[47])); // / | (!KEY_COLUMN[7] & KEY[47])); // /
// Research: phase-match the remaining CPU keyboard control flags.
reg [3:0] keyboard_cpu_controls = 4'b1000;
always @(negedge clk_sys) keyboard_cpu_controls <= {EE_N, MUGS, SHIFT, SHIFT_OVERRIDE};
assign KEYBOARD_IN[6] = !((!KEY_COLUMN[0] & KEY[48]) // CR assign KEYBOARD_IN[6] = !((!KEY_COLUMN[0] & KEY[48]) // CR
| (!KEY_COLUMN[1] & KEY[49]) // TAB | (!KEY_COLUMN[1] & KEY[49]) // TAB
| (!KEY_COLUMN[2] & KEY[50]) // ESC | (!KEY_COLUMN[2] & KEY[50]) // ESC
| (!KEY_COLUMN[3] & KEY[51]) // ALT | (!KEY_COLUMN[3] & KEY[51]) // ALT
| (!KEY_COLUMN[3] & (!BUTTON_N[0] | MUGS)) // ALT (Easter Egg) | (!KEY_COLUMN[3] & (!keyboard_cpu_controls[3] | keyboard_cpu_controls[2])) // ALT (Easter Egg)
| (!KEY_COLUMN[4] & KEY[52]) // CTRL | (!KEY_COLUMN[4] & KEY[52]) // CTRL
| (!KEY_COLUMN[4] & (!BUTTON_N[0] | MUGS)) // CTRL (Easter Egg) | (!KEY_COLUMN[4] & (!keyboard_cpu_controls[3] | keyboard_cpu_controls[2])) // CTRL (Easter Egg)
| (!KEY_COLUMN[5] & KEY[53]) // F1 | (!KEY_COLUMN[5] & KEY[53]) // F1
| (!KEY_COLUMN[6] & KEY[54]) // F2 | (!KEY_COLUMN[6] & KEY[54]) // F2
| (!KEY_COLUMN[7] & KEY[55] & !SHIFT_OVERRIDE) // shift | (!KEY_COLUMN[7] & KEY[55] & !keyboard_cpu_controls[0]) // shift
| (!KEY_COLUMN[7] & SHIFT)); // Forced Shift | (!KEY_COLUMN[7] & keyboard_cpu_controls[1])); // Forced Shift
assign KEYBOARD_IN[7] = JSTICK; // Joystick input assign KEYBOARD_IN[7] = JSTICK; // Joystick input
@@ -3730,20 +3791,22 @@ COCOKEY coco_keyboard(
.SLO_CLK(V_SYNC_N), .SLO_CLK(V_SYNC_N),
.PS2_CLK(ps2_clk), .PS2_CLK(ps2_clk),
.PS2_DATA(ps2_data), .PS2_DATA(ps2_data),
.KEY(KEY_RCVD), .KEY(KEY_RAW),
.SHIFT(SHIFT), .SHIFT(SHIFT),
.SHIFT_OVERRIDE(SHIFT_OVERRIDE), .SHIFT_OVERRIDE(SHIFT_OVERRIDE),
.RESET(RESET), .RESET(RESET),
.RESET_INS(RESET_INS) .RESET_INS(RESET_INS)
); );
wire [72:0] KEY_RCVD; wire [72:0] KEY_RAW;
reg [72:0] KEY_RCVD = 73'd0;
always @(negedge clk_sys) KEY_RCVD <= KEY_RAW;
Auto_Run CoCo3_Auto_Run( Auto_Run CoCo3_Auto_Run(
.RESET_N(RESET_N), .RESET_N(RESET_N),
.CLK(clk_sys), .CLK(clk_sys),
.CLK_1_78(clk_1_78), .CLK_1_78(clk_1_78),
.MPI_SCS(SWITCH[2:1]), .MPI_SCS(MPI_LAYOUT[SWITCH[2:1]*3+:3]==3 ? 2'b01 : 2'b11),
.MODE(AUTO_MODE), .MODE(AUTO_MODE),
.AMW_ACK(AMW_ACK), .AMW_ACK(AMW_ACK),
.KEY_IN(KEY_RCVD), .KEY_IN(KEY_RCVD),
@@ -3776,12 +3839,12 @@ end
// Borrowed from MAC PLUS // Borrowed from MAC PLUS
wire ps2_x1, ps2_y1, ps2_x2, ps2_y2; wire ps2_x1, ps2_y1, ps2_x2, ps2_y2;
wire ps2_button; wire ps2_button, ps2_button_raw;
ps2_mouse coco_ps2_mouse( ps2_mouse coco_ps2_mouse(
.clk(clk_sys), .clk(clk_sys),
.ce(PH_2), .ce(PH_2),
.reset(~RESET_N), .reset(~RESET_POS_N),
.ps2_mouse(ps2_mouse), .ps2_mouse(ps2_mouse),
@@ -3789,7 +3852,7 @@ ps2_mouse coco_ps2_mouse(
.y1(ps2_y1), .y1(ps2_y1),
.x2(ps2_x2), .x2(ps2_x2),
.y2(ps2_y2), .y2(ps2_y2),
.button(ps2_button) .button(ps2_button_raw)
); );
// This code creates a virtual joystick based on mouse movements. // This code creates a virtual joystick based on mouse movements.
@@ -3797,14 +3860,18 @@ ps2_mouse coco_ps2_mouse(
// [note check of boundry before inc / dev] // [note check of boundry before inc / dev]
reg [7:0] mouse_x_pos, mouse_y_pos; reg [7:0] mouse_x_pos, mouse_y_pos;
wire [15:0] mouse_xy_pos = {mouse_x_pos, mouse_y_pos}; // Research: CPU-facing mouse sample, retaining the original position decoder.
reg [16:0] mouse_cpu_sample = 17'h18080;
always @(negedge clk_sys) mouse_cpu_sample <= {ps2_button_raw, mouse_x_pos, mouse_y_pos};
wire [15:0] mouse_xy_pos = mouse_cpu_sample[15:0];
assign ps2_button = mouse_cpu_sample[16];
reg [1:0] old_x, old_y; reg [1:0] old_x, old_y;
wire [1:0] x_mouse = {ps2_x1, ps2_x2}; wire [1:0] x_mouse = {ps2_x1, ps2_x2};
wire [1:0] y_mouse = {ps2_y1, ps2_y2}; wire [1:0] y_mouse = {ps2_y1, ps2_y2};
always @ (posedge clk_sys or negedge RESET_N) always @ (posedge clk_sys or negedge RESET_POS_N)
begin begin
if(!RESET_N) if(!RESET_POS_N)
begin begin
mouse_x_pos <= 8'h80; mouse_x_pos <= 8'h80;
mouse_y_pos <= 8'h80; mouse_y_pos <= 8'h80;
@@ -3962,8 +4029,8 @@ VDAC VDAC_inst (
// .rdclock ( PIX_CLK ), // .rdclock ( PIX_CLK ),
// KEY: 01/14/26 // KEY: 01/14/26
.wraddress ( DATA_OUT ), .wraddress ( DATA_OUT ),
.wrclock ( clk_sys ), .wrclock ( ~clk_sys ),
.wren ( VDAC_EN & PH_2 ), .wren ( VDAC_EN & PH_2 & ssc_palette_owner ),
.q ( VDAC_OUT ) .q ( VDAC_OUT )
); );
@@ -4190,14 +4257,20 @@ coco3_Char_ROM coco3_Char_ROM(
); );
// Research: reset the UART enable generator with synchronous release.
(* preserve *) reg [1:0] uart_tick_release = 2'b00;
wire uart_tick_reset_n = uart_tick_release[1];
always @(posedge clk_sys or negedge RESET_N)
if (!RESET_N) uart_tick_release <= 2'b00;
else uart_tick_release <= {uart_tick_release[0], 1'b1};
reg [4:0] CLK_6551; reg [4:0] CLK_6551;
// Targeting 1.8432 Mhz. // Targeting 1.8432 Mhz.
// 57.272727 Mhz / 31 = 1.8475 Mhz // 57.272727 Mhz / 31 = 1.8475 Mhz
reg CLK_6551_EN; reg CLK_6551_EN;
always @(negedge clk_sys or negedge RESET_N) always @(negedge clk_sys or negedge uart_tick_reset_n)
begin begin
if(!RESET_N) if(!uart_tick_reset_n)
begin begin
CLK_6551 <= 5'd0; CLK_6551 <= 5'd0;
CLK_6551_EN <= 1'b0; CLK_6551_EN <= 1'b0;
+31
View File
@@ -0,0 +1,31 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// Research request boundary for the MiSTer 57 MHz CPU / 114 MHz SDRAM interface.
// Captures the complete selected CPU/GART/AMW payload after the core raises req.
// The clocks are related PLL outputs; all crossings retain normal timing checks.
module cpu_sdram_bridge (
input clk, fast_clk, reset,
input [24:0] cpu_addr,
input [7:0] cpu_din,
input cpu_req, cpu_rnw, memory_ack,
output cpu_ack,
output reg [24:0] memory_addr,
output reg [7:0] memory_din,
output reg memory_rnw,
output reg memory_req = 1'b0
);
// A falling fast-clock observation avoids the coincident positive-fast /
// negative-system edge for ACK. Both half-period transfers remain timed.
reg ack_phase = 1'b0;
always @(negedge fast_clk) ack_phase <= reset ? 1'b0 : memory_ack;
assign cpu_ack = cpu_req && memory_req && ack_phase;
always @(negedge clk) begin
if (reset || !cpu_req) memory_req <= 1'b0;
else if (!memory_req && !ack_phase) begin
memory_addr <= cpu_addr;
memory_din <= cpu_din;
memory_rnw <= cpu_rnw;
memory_req <= 1'b1;
end
end
endmodule
+75 -24
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Project Name: COCO3 Targeting MISTer // Project Name: COCO3 Targeting MISTer
// File Name: fdc.sv // File Name: fdc.sv
@@ -107,6 +109,12 @@ wire [5:0] div_8mhz;
assign ena_8Mhz = (div_8mhz == 6'd5) ? 1'b1: 1'b0; assign ena_8Mhz = (div_8mhz == 6'd5) ? 1'b1: 1'b0;
// Research: local positive-edge reset release for the WD1793 banks.
(* preserve *) reg [1:0] wd_reset_release = 2'b00;
always @(posedge CLK or negedge RESET_N)
if (!RESET_N) wd_reset_release <= 2'b00;
else wd_reset_release <= {wd_reset_release[0], 1'b1};
always@(negedge CLK or negedge RESET_N) always@(negedge CLK or negedge RESET_N)
begin begin
if (~RESET_N) div_8mhz <= 6'd0; if (~RESET_N) div_8mhz <= 6'd0;
@@ -393,52 +401,95 @@ reg [23:0] drive_size[4];
// Reset of drive wp to a default of 1 removed because of persistance. // Reset of drive wp to a default of 1 removed because of persistance.
// Research: mount strobes are data from hps_io, not clock sources.
reg [3:0] img_mounted_d = 0;
always @(posedge CLK) img_mounted_d <= img_mounted;
reg [3:0] mount_pending = 0;
reg [3:0] mount_wp;
reg [3:0] mount_double_sided;
reg [23:0] mount_size[4];
always @(posedge CLK) mount_pending <= img_mounted_d & ~img_mounted;
// Drive 0 // Drive 0
always @(negedge img_mounted[0]) always @(posedge CLK)
begin begin
drive_wp[0] <= img_readonly; if (img_mounted_d[0] && !img_mounted[0])
drive_ready[0] <= 1'b1; begin
drive_size[0] <= {4'h0, img_size[19:0]}; //Size / 256 on [19:8] mount_wp[0] <= img_readonly;
double_sided[0]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640; mount_size[0] <= {4'h0, img_size[19:0]}; //Size / 256 on [19:8]
mount_double_sided[0]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640;
end
end end
// Drive 1 // Drive 1
always @(negedge img_mounted[1]) always @(posedge CLK)
begin begin
drive_wp[1] <= img_readonly; if (img_mounted_d[1] && !img_mounted[1])
drive_ready[1] <= 1'b1; begin
drive_size[1] <= {4'h0, img_size[19:0]}; //Size / 256 on [19:8] mount_wp[1] <= img_readonly;
double_sided[1]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640; mount_size[1] <= {4'h0, img_size[19:0]}; //Size / 256 on [19:8]
mount_double_sided[1]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640;
end
end end
// Drive 2 // Drive 2
always @(negedge img_mounted[2]) always @(posedge CLK)
begin begin
drive_wp[2] <= img_readonly; if (img_mounted_d[2] && !img_mounted[2])
drive_ready[2] <= 1'b1; begin
drive_size[2] <= {4'h0, img_size[19:0]}; //Size / 256 on [19:8] mount_wp[2] <= img_readonly;
double_sided[2]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640; mount_size[2] <= {4'h0, img_size[19:0]}; //Size / 256 on [19:8]
mount_double_sided[2]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640;
end
end end
// Drive 3 // Drive 3
always @(negedge img_mounted[3]) always @(posedge CLK)
begin begin
drive_wp[3] <= img_readonly; if (img_mounted_d[3] && !img_mounted[3])
drive_ready[3] <= 1'b1; begin
drive_size[3] <= {4'h0, img_size[19:0]}; //Size / 256 on [19:8] mount_wp[3] <= img_readonly;
//double_sided[3]<= img_size > 20'd368600;//20'd368640; mount_size[3] <= {4'h0, img_size[19:0]}; //Size / 256 on [19:8]
//mount_double_sided[3]<= img_size > 20'd368600;//20'd368640;
end
end end
// Research: commit metadata on consumer's falling phase after classification.
always @(negedge CLK) if (mount_pending[0]) begin
drive_wp[0] <= mount_wp[0];
drive_ready[0] <= 1'b1;
drive_size[0] <= mount_size[0];
double_sided[0] <= mount_double_sided[0];
end
always @(negedge CLK) if (mount_pending[1]) begin
drive_wp[1] <= mount_wp[1];
drive_ready[1] <= 1'b1;
drive_size[1] <= mount_size[1];
double_sided[1] <= mount_double_sided[1];
end
always @(negedge CLK) if (mount_pending[2]) begin
drive_wp[2] <= mount_wp[2];
drive_ready[2] <= 1'b1;
drive_size[2] <= mount_size[2];
double_sided[2] <= mount_double_sided[2];
end
always @(negedge CLK) if (mount_pending[3]) begin
drive_wp[3] <= mount_wp[3];
drive_ready[3] <= 1'b1;
drive_size[3] <= mount_size[3];
end
wd1793 #(1,0) coco_wd1793_0 wd1793 #(1,0) coco_wd1793_0
( (
.clk_sys(~CLK), .clk_sys(~CLK),
.ce(ena_8Mhz), .ce(ena_8Mhz),
.reset(~RESET_N), .reset(~wd_reset_release[1]),
.io_en(1'b1), .io_en(1'b1),
.rd(RD[0]), .rd(RD[0]),
.wr(WR[0]), .wr(WR[0]),
@@ -480,7 +531,7 @@ wd1793 #(1,0) coco_wd1793_1
( (
.clk_sys(~CLK), .clk_sys(~CLK),
.ce(ena_8Mhz), .ce(ena_8Mhz),
.reset(~RESET_N), .reset(~wd_reset_release[1]),
.io_en(1'b1), .io_en(1'b1),
.rd(RD[1]), .rd(RD[1]),
.wr(WR[1]), .wr(WR[1]),
@@ -522,7 +573,7 @@ wd1793 #(1,0) coco_wd1793_2
( (
.clk_sys(~CLK), .clk_sys(~CLK),
.ce(ena_8Mhz), .ce(ena_8Mhz),
.reset(~RESET_N), .reset(~wd_reset_release[1]),
.io_en(1'b1), .io_en(1'b1),
.rd(RD[2]), .rd(RD[2]),
.wr(WR[2]), .wr(WR[2]),
@@ -564,7 +615,7 @@ wd1793 #(1,0) coco_wd1793_3
( (
.clk_sys(~CLK), .clk_sys(~CLK),
.ce(ena_8Mhz), .ce(ena_8Mhz),
.reset(~RESET_N), .reset(~wd_reset_release[1]),
.io_en(1'b1), .io_en(1'b1),
.rd(RD[3]), .rd(RD[3]),
.wr(WR[3]), .wr(WR[3]),
+51 -14
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
`timescale 1ns / 1ns `timescale 1ns / 1ns
////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////
// Company: // Company:
@@ -191,14 +193,14 @@ reg [15:0] ea_p1;
// NMI is supposed to be masked - despite the name - until the 6809 loads a value into S. // NMI is supposed to be masked - despite the name - until the 6809 loads a value into S.
// Frankly, I'm cheating slightly. If someone does a LDS #$0, it won't disable the mask. Pretty much anything else // Frankly, I'm cheating slightly. If someone does a LDS #$0, it won't disable the mask. Pretty much anything else
// that changes the value of S from the default (which is currently $0) will clear the mask. A reset will set the mask again. // that changes the value of S from the default (which is currently $0) will clear the mask. A reset will set the mask again.
reg NMIMask; (* keep *) wire NMIMask;
reg NMILatched; (* keep *) wire NMILatched;
reg rnRESET=0; // The latched version of /RESET, useful 1 clock after it's latched
reg NMISample; reg NMISample;
reg NMISample2; reg NMISample2;
reg NMIClear; reg NMIClear;
reg NMIClear_nxt; reg NMIClear_nxt;
wire wNMIClear = NMIClear;
reg IRQLatched; reg IRQLatched;
@@ -534,14 +536,52 @@ endgenerate
/////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////
always @(negedge NMISample2 or posedge wNMIClear) // Research: registered observations replace event clocks and next-S logic.
// S and its prior master-cycle value expose the actual CPU register update,
// avoiding the long instruction/ALU -> s_nxt comparator in the NMI mask path.
reg [15:0] NMIStackPrevious;
reg NMIMaskStored = 1'b1;
reg NMIEdge = 1'b0;
reg NMIPending = 1'b0;
function NMIStackDiff;
input [15:0] previous_value, current_value;
begin
NMIStackDiff = 1'b0;
if (previous_value != current_value) NMIStackDiff = 1'b1;
end
endfunction
wire NMIStackChanged = NMIStackDiff(NMIStackPrevious, s);
assign NMIMask = NMIMaskStored && !NMIStackChanged;
reg NMIQualifiedEdge;
always @* begin
NMIQualifiedEdge = 1'b0;
if (NMIEdge)
if (NMIClear == 1'b1) NMIQualifiedEdge = 1'b0;
else if (NMIMask == 1'b0) NMIQualifiedEdge = 1'b1;
end
// The same-event view uses new registered mask/clear values after NBA updates.
// Pending state retains that view on the next master edge; CPU-visible timing
// therefore has no extra E-cycle, including back-to-back CPU enables.
reg NMIVisible;
always @* begin
NMIVisible = 1'b1;
if (NMIClear == 1'b1) NMIVisible = 1'b1;
else if (NMIPending || NMIQualifiedEdge) NMIVisible = 1'b0;
end
assign NMILatched = NMIVisible;
always @(negedge MASTER)
begin begin
if (wNMIClear == 1) NMIStackPrevious <= s;
NMILatched <= 1; if (!nRESET || !rnRESET) begin
else if (NMIMask == 0) NMIMaskStored <= 1'b1;
NMILatched <= 0; NMIEdge <= 1'b0;
else NMIPending <= 1'b0;
NMILatched <= 1; end else begin
NMIEdge <= E && NMISample2 && !NMISample;
if (NMIStackChanged) NMIMaskStored <= 1'b0;
if (NMIClear == 1'b1) NMIPending <= 1'b0;
else if (NMIQualifiedEdge) NMIPending <= 1'b1;
end
end end
// //
@@ -579,7 +619,6 @@ begin
end end
end end
reg rnRESET=0; // The latched version of /RESET, useful 1 clock after it's latched
always @(negedge MASTER) always @(negedge MASTER)
begin begin
if (E) if (E)
@@ -635,13 +674,11 @@ begin
IntType <= IntType_nxt; IntType <= IntType_nxt;
if (s != s_nxt) // Once S changes at all (default is '0'), release the NMI Mask.
NMIMask <= 1'b0;
end end
else else
begin begin
CpuState <= CPUSTATE_RESET; CpuState <= CPUSTATE_RESET;
NMIMask <= 1'b1; // Mask NMI until S is loaded.
NMIClear <= 1'b0; // Mark us as not having serviced NMI NMIClear <= 1'b0; // Mark us as not having serviced NMI
end end
end end
+4 -1
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Project Name: COCO3 Targeting MISTer // Project Name: COCO3 Targeting MISTer
// File Name: sdc.sv // File Name: sdc.sv
@@ -505,7 +507,8 @@ always_ff@(posedge clock) begin
end end
end end
always_ff@(posedge clock) begin // CPU port shares the CPU-consuming edge; host port A stays positive.
always_ff@(negedge clock) begin
if(wren_b) begin if(wren_b) begin
ram[address_b] <= data_b; ram[address_b] <= data_b;
q_b <= data_b; q_b <= data_b;
+48 -12
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Project Name: COCO3 Targeting MISTer // Project Name: COCO3 Targeting MISTer
// File Name: sdc_top.sv // File Name: sdc_top.sv
@@ -115,6 +117,12 @@ wire [5:0] div_8mhz;
assign ena_8Mhz = (div_8mhz == 6'd5) ? 1'b1: 1'b0; assign ena_8Mhz = (div_8mhz == 6'd5) ? 1'b1: 1'b0;
// Research: local positive-edge reset release for the WD1793 banks.
(* preserve *) reg [1:0] wd_reset_release = 2'b00;
always @(posedge CLK or negedge RESET_N)
if (!RESET_N) wd_reset_release <= 2'b00;
else wd_reset_release <= {wd_reset_release[0], 1'b1};
always@(negedge CLK or negedge RESET_N) always@(negedge CLK or negedge RESET_N)
begin begin
if (~RESET_N) div_8mhz <= 6'd0; if (~RESET_N) div_8mhz <= 6'd0;
@@ -443,32 +451,60 @@ reg [31:0] drive_size[2];
// Reset of drive wp to a default of 1 removed because of persistance. // Reset of drive wp to a default of 1 removed because of persistance.
// Research: mount strobes are data from hps_io, not clock sources.
reg [1:0] img_mounted_d = 0;
always @(posedge CLK) img_mounted_d <= img_mounted;
reg [1:0] mount_pending = 0;
reg [1:0] mount_wp;
reg [1:0] mount_double_sided;
reg [31:0] mount_size[2];
always @(posedge CLK) mount_pending <= img_mounted_d & ~img_mounted;
// Drive 0 // Drive 0
always @(negedge img_mounted[0]) always @(posedge CLK)
begin begin
drive_wp[0] <= img_readonly; if (img_mounted_d[0] && !img_mounted[0])
drive_ready[0] <= 1'b1; begin
drive_size[0] <= img_size[31:0]; //Size / 256 on [31:8] mount_wp[0] <= img_readonly;
double_sided[0]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640; mount_size[0] <= img_size[31:0]; //Size / 256 on [31:8]
mount_double_sided[0]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640;
end
end end
// Drive 1 // Drive 1
always @(negedge img_mounted[1]) always @(posedge CLK)
begin begin
drive_wp[1] <= img_readonly; if (img_mounted_d[1] && !img_mounted[1])
drive_ready[1] <= 1'b1; begin
drive_size[1] <= img_size[31:0]; //Size / 256 on [31:8] mount_wp[1] <= img_readonly;
double_sided[1]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640; mount_size[1] <= img_size[31:0]; //Size / 256 on [31:8]
mount_double_sided[1]<= (img_size > 64'd368600) & (img_size < 64'd740000);//20'd368640;
end
end end
// Research: commit metadata on consumer's falling phase after classification.
always @(negedge CLK) if (mount_pending[0]) begin
drive_wp[0] <= mount_wp[0];
drive_ready[0] <= 1'b1;
drive_size[0] <= mount_size[0];
double_sided[0] <= mount_double_sided[0];
end
always @(negedge CLK) if (mount_pending[1]) begin
drive_wp[1] <= mount_wp[1];
drive_ready[1] <= 1'b1;
drive_size[1] <= mount_size[1];
double_sided[1] <= mount_double_sided[1];
end
wd1793 #(1,0) coco_wd1793_sdc_0 wd1793 #(1,0) coco_wd1793_sdc_0
( (
.clk_sys(~CLK), .clk_sys(~CLK),
.ce(ena_8Mhz), .ce(ena_8Mhz),
.reset(~RESET_N), .reset(~wd_reset_release[1]),
.io_en(1'b1), .io_en(1'b1),
.rd(RD[0]), .rd(RD[0]),
.wr(WR[0]), .wr(WR[0]),
@@ -510,7 +546,7 @@ wd1793 #(1,0) coco_wd1793_sdc_1
( (
.clk_sys(~CLK), .clk_sys(~CLK),
.ce(ena_8Mhz), .ce(ena_8Mhz),
.reset(~RESET_N), .reset(~wd_reset_release[1]),
.io_en(1'b1), .io_en(1'b1),
.rd(RD[1]), .rd(RD[1]),
.wr(WR[1]), .wr(WR[1]),
+66 -28
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// //
// sdram // sdram
// Copyright (c) 2015-2019 Sorgelig // Copyright (c) 2015-2019 Sorgelig
@@ -81,10 +83,14 @@ localparam OP_MODE = 2'b00; // only 00 (standard operation) allow
localparam NO_WRITE_BURST = 1'b1; // 0= write burst enabled, 1=only single access write localparam NO_WRITE_BURST = 1'b1; // 0= write burst enabled, 1=only single access write
localparam MODE = {3'b000, NO_WRITE_BURST, OP_MODE, CAS_LATENCY, ACCESS_TYPE, BURST_CODE}; localparam MODE = {3'b000, NO_WRITE_BURST, OP_MODE, CAS_LATENCY, ACCESS_TYPE, BURST_CODE};
localparam sdram_startup_cycles= 14'd12100;// 100us, plus a little more, @ 100MHz // AS4C32M16SB requires 200 us with stable inputs before initialization.
localparam startup_refresh_max = 14'b11111111111111; // 25,000 cycles at 114.545454 MHz leaves >218 us, including command spacing.
localparam sdram_startup_cycles= 15'd25000;
localparam startup_refresh_max = 15'h7fff;
//localparam cycles_per_refresh = 14'd780; // (64000*100)/8192-1 Calc'd as (64ms @ 100MHz)/8192 rose //localparam cycles_per_refresh = 14'd780; // (64000*100)/8192-1 Calc'd as (64ms @ 100MHz)/8192 rose
localparam cycles_per_refresh = 14'd890; // (64000*100)/8192-1 Calc'd as (64ms @ 114.560MHz)/8192 rose (act 895) // Reserve the bounded command/recovery latency before the 894.9-cycle limit
// (64 ms / 8192 at 114.545454 MHz). Do not wait for twice this interval.
localparam cycles_per_refresh = 14'd880;
// SDRAM commands // SDRAM commands
wire [2:0] CMD_NOP = 3'b111; wire [2:0] CMD_NOP = 3'b111;
@@ -95,7 +101,7 @@ wire [2:0] CMD_PRECHARGE = 3'b010;
wire [2:0] CMD_AUTO_REFRESH = 3'b001; wire [2:0] CMD_AUTO_REFRESH = 3'b001;
wire [2:0] CMD_LOAD_MODE = 3'b000; wire [2:0] CMD_LOAD_MODE = 3'b000;
reg [13:0] refresh_count = startup_refresh_max - sdram_startup_cycles; reg [14:0] refresh_count = startup_refresh_max - sdram_startup_cycles;
reg [2:0] command; reg [2:0] command;
localparam STATE_STARTUP = 0; localparam STATE_STARTUP = 0;
@@ -105,6 +111,7 @@ localparam STATE_RW1 = 3;
localparam STATE_IDLE = 4; localparam STATE_IDLE = 4;
localparam STATE_DLY1 = 5; localparam STATE_DLY1 = 5;
localparam STATE_DLY2 = 6; localparam STATE_DLY2 = 6;
localparam STATE_DLY3 = 20;
localparam STATE_IDLE_7 = 17; localparam STATE_IDLE_7 = 17;
localparam STATE_IDLE_6 = 16; localparam STATE_IDLE_6 = 16;
localparam STATE_IDLE_5 = 15; localparam STATE_IDLE_5 = 15;
@@ -114,10 +121,32 @@ localparam STATE_IDLE_2 = 12;
localparam STATE_IDLE_1 = 11; localparam STATE_IDLE_1 = 11;
reg [15:0] dq_reg; reg [15:0] dq_reg;
// CL3's output launches on the preceding edge (READ T4 -> launch T6,
// receive T7). Preserve the original READY alignment: adding another cycle
// selects burst beat two. Pin setup/hold remains checked in external-io.sdc.
localparam READ_CAPTURE_EXTRA = 0;
// Research: CPU-only activation stage. Request arbitration controls state,
// while payload snapshots isolate the external bus from the output mux tree.
reg [24:0] cpu_address_snapshot;
reg [7:0] cpu_data_snapshot;
reg cpu_rnw_snapshot;
localparam STATE_CPU_ACTIVE = 18;
// Research: keep video address arithmetic out of the SDRAM output mux.
// The next state consumes the snapshot from the arbitration edge, adding one
// fast clock before ACTIVE. No address/command is issued from an invalid sample.
reg [24:0] video_address_snapshot;
localparam STATE_VIDEO_ACTIVE = 19;
always @(posedge clk) video_address_snapshot <= sdram_vid_addr;
always @(posedge clk) begin
cpu_address_snapshot <= sdram_cpu_addr;
cpu_data_snapshot <= sdram_cpu_din;
cpu_rnw_snapshot <= sdram_cpu_rnw;
end
always @(posedge clk) begin always @(posedge clk) begin
reg [CAS_LATENCY+BURST_LENGTH:0] data_cpu_ready_delay; reg [CAS_LATENCY+BURST_LENGTH+READ_CAPTURE_EXTRA:0] data_cpu_ready_delay;
reg [CAS_LATENCY+BURST_LENGTH:0] data_vid_ready_delay; reg [CAS_LATENCY+BURST_LENGTH+READ_CAPTURE_EXTRA:0] data_vid_ready_delay;
reg saved_wr; reg saved_wr;
reg saved_vid; reg saved_vid;
@@ -127,9 +156,9 @@ always @(posedge clk) begin
refresh_count <= refresh_count + 1'b1; refresh_count <= refresh_count + 1'b1;
data_vid_ready_delay[CAS_LATENCY+BURST_LENGTH] <= 0; data_vid_ready_delay[CAS_LATENCY+BURST_LENGTH+READ_CAPTURE_EXTRA] <= 0;
data_cpu_ready_delay[CAS_LATENCY+BURST_LENGTH] <= 0; data_cpu_ready_delay[CAS_LATENCY+BURST_LENGTH+READ_CAPTURE_EXTRA] <= 0;
data_cpu_ready_delay <= data_cpu_ready_delay>>1; data_cpu_ready_delay <= data_cpu_ready_delay>>1;
data_vid_ready_delay <= data_vid_ready_delay>>1; data_vid_ready_delay <= data_vid_ready_delay>>1;
@@ -206,7 +235,7 @@ always @(posedge clk) begin
state <= STATE_IDLE; state <= STATE_IDLE;
sdram_busy <= 1'b0; sdram_busy <= 1'b0;
// mask possible refresh to reduce colliding. // mask possible refresh to reduce colliding.
if(refresh_count > cycles_per_refresh) begin if(refresh_count >= cycles_per_refresh) begin
state <= STATE_IDLE_7; state <= STATE_IDLE_7;
command <= CMD_AUTO_REFRESH; command <= CMD_AUTO_REFRESH;
refresh_count <= 0; refresh_count <= 0;
@@ -216,47 +245,53 @@ always @(posedge clk) begin
STATE_IDLE: begin STATE_IDLE: begin
saved_vid <= 1'b0; saved_vid <= 1'b0;
if(refresh_count > (cycles_per_refresh<<1)) if(refresh_count >= cycles_per_refresh)
begin begin
state <= STATE_IDLE_1; state <= STATE_IDLE_1;
sdram_busy <= 1'b1; sdram_busy <= 1'b1;
end end
else else
begin begin
if(sdram_cpu_req & !sdram_cpu_ack) // request has to go away after ready=0 if(sdram_cpu_req & !sdram_cpu_ack)
begin begin
// fix byte writes [no new command until data is actually written] state <= STATE_CPU_ACTIVE;
if (~sdram_cpu_rnw)
{cas_addr[12:9],SDRAM_BA,SDRAM_A,cas_addr[8:0]} <= {~sdram_cpu_addr[0], sdram_cpu_addr[0], 2'b10, sdram_cpu_addr[24:1]}; // Bytes by A0 for writes
else
{cas_addr[12:9],SDRAM_BA,SDRAM_A,cas_addr[8:0]} <= {2'b00, 2'b10, sdram_cpu_addr[24:1]}; // No bytes for reads...
saved_data <= {sdram_cpu_din, sdram_cpu_din};
saved_wr <= ~sdram_cpu_rnw;
command <= CMD_ACTIVE;
state <= STATE_WAIT;
sdram_busy <= 1'b1; sdram_busy <= 1'b1;
end end
else else
begin begin
if (sdram_vid_req) if (sdram_vid_req)
begin begin
{cas_addr[12:9],SDRAM_BA,SDRAM_A,cas_addr[8:0]} <= {2'b00, 2'b10, sdram_vid_addr[24:1]}; // No bytes for reads... state <= STATE_VIDEO_ACTIVE;
command <= CMD_ACTIVE;
saved_vid <= 1'b1; saved_vid <= 1'b1;
saved_wr <= 1'b0; saved_wr <= 1'b0;
sdram_busy <= 1'b1; sdram_busy <= 1'b1;
end
end
end
end
STATE_VIDEO_ACTIVE: begin
{cas_addr[12:9],SDRAM_BA,SDRAM_A,cas_addr[8:0]} <= {2'b00, 2'b10, video_address_snapshot[24:1]};
command <= CMD_ACTIVE;
state <= STATE_WAIT; state <= STATE_WAIT;
end end
end
end STATE_CPU_ACTIVE: begin
if (~cpu_rnw_snapshot)
{cas_addr[12:9],SDRAM_BA,SDRAM_A,cas_addr[8:0]} <= {~cpu_address_snapshot[0], cpu_address_snapshot[0], 2'b10, cpu_address_snapshot[24:1]};
else
{cas_addr[12:9],SDRAM_BA,SDRAM_A,cas_addr[8:0]} <= {2'b00, 2'b10, cpu_address_snapshot[24:1]};
saved_data <= {cpu_data_snapshot, cpu_data_snapshot};
saved_wr <= ~cpu_rnw_snapshot;
command <= CMD_ACTIVE;
state <= STATE_WAIT;
end end
STATE_WAIT: state <= STATE_WAIT1; STATE_WAIT: state <= STATE_WAIT1;
STATE_WAIT1: begin STATE_WAIT1: begin
if (saved_wr) if (saved_wr)
begin begin
if ((data_vid_ready_delay[5:1] == 5'b00000) && (data_cpu_ready_delay[5:1] == 5'b00000)) if ((data_vid_ready_delay[CAS_LATENCY+BURST_LENGTH+READ_CAPTURE_EXTRA:1] == '0) && (data_cpu_ready_delay[CAS_LATENCY+BURST_LENGTH+READ_CAPTURE_EXTRA:1] == '0))
state <= STATE_RW1; // added for clk > 100Mhz state <= STATE_RW1; // added for clk > 100Mhz
end end
else else
@@ -283,17 +318,20 @@ always @(posedge clk) begin
state <= STATE_IDLE; state <= STATE_IDLE;
if (saved_vid) if (saved_vid)
begin begin
data_vid_ready_delay[CAS_LATENCY+BURST_LENGTH] <= 1; data_vid_ready_delay[CAS_LATENCY+BURST_LENGTH+READ_CAPTURE_EXTRA] <= 1;
state <= STATE_DLY1; state <= STATE_DLY1;
end end
else else
data_cpu_ready_delay[CAS_LATENCY+BURST_LENGTH] <= 1; data_cpu_ready_delay[CAS_LATENCY+BURST_LENGTH+READ_CAPTURE_EXTRA] <= 1;
state <= STATE_DLY1; state <= STATE_DLY1;
end end
end end
STATE_DLY1: STATE_DLY1:
state <= STATE_DLY2; state <= STATE_DLY2;
STATE_DLY2: STATE_DLY2:
state <= STATE_DLY3;
STATE_DLY3:
// Eight clocks between legal back-to-back ACTIVEs, >=63 ns tRC.
state <= STATE_IDLE; state <= STATE_IDLE;
endcase endcase
+29
View File
@@ -0,0 +1,29 @@
BSD 3-Clause License
SSC wiring and SP0256/TMS7000 portions are derived from MAME:
Copyright holders: Tim Lindner, Joseph Zbiciak, hap.
See the individual source headers for component provenance.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
+91
View File
@@ -0,0 +1,91 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Cartridge mix and digital SAC model, based on VCCPlus/MAME Tim Lindner.
// audio_ce must be44100Hz: the reference RC coefficients are per audio sample.
// Q16 PCM states and Q24 coefficients approximate the software float circuit.
// This is a digital reference model, not a measured analog transfer function.
module ssc_audio(input wire clk,reset,audio_ce,input wire [17:0] ay_sum,
input wire signed [15:0] speech_sample,output reg signed [15:0] mixed_sample,
output reg sample_valid,activity,overrun,output wire busy);
localparam [3:0] IDLE=0,MIX=1,HP_PREP=2,HP_MULT=3,HP_STORE=4,
ENV_PREP=5,ENV_MULT=6,ENV_STORE=7,AVERAGE=8,MULT_COMBINE=9;
reg [3:0] state;
assign busy=state!=IDLE;
reg [15:0] ay_average;
reg [17:0] divide_shift,quotient;
reg [1:0] remainder;
reg [4:0] divide_count;
wire [2:0] division_step={remainder,divide_shift[17]};
wire [2:0] next_remainder=division_step>=3 ? division_step-3'd3 : division_step;
reg signed [15:0] speech_hold;
reg signed [20:0] mix_quarters;
reg signed [34:0] previous_input,previous_hp,rectified,operand;
reg [34:0] envelope;
reg [23:0] factor;
reg signed [59:0] product;
reg [41:0] product_low;
reg signed [41:0] product_high;
reg [3:0] combine_return;
wire signed [41:0] combined_high=product_high+$signed({18'd0,product_low[41:18]});
wire signed [39:0] scaled_product=product>>>24;
wire signed [39:0] envelope_next=$signed({1'b0,envelope})+scaled_product;
wire signed [34:0] current_input=$signed({3'd0,ay_average,16'd0});
wire signed [20:0] speech_extended={{5{speech_hold[15]}},speech_hold};
always @(posedge clk)begin
if(reset)begin
state<=IDLE;ay_average<=0;speech_hold<=0;mix_quarters<=0;
divide_shift<=0;quotient<=0;remainder<=0;divide_count<=0;
previous_input<=0;previous_hp<=0;rectified<=0;operand<=0;envelope<=0;
factor<=0;product<=0;product_low<=0;product_high<=0;combine_return<=IDLE;
mixed_sample<=0;sample_valid<=0;activity<=0;overrun<=0;
end else begin
sample_valid<=0;
if(audio_ce&&busy)overrun<=1;
case(state)
IDLE:if(audio_ce)begin
divide_shift<=ay_sum;quotient<=0;remainder<=0;divide_count<=18;
speech_hold<=speech_sample;state<=AVERAGE;
end
AVERAGE:begin
remainder<=next_remainder[1:0];
quotient<={quotient[16:0],division_step>=3};divide_shift<=divide_shift<<1;
divide_count<=divide_count-5'd1;
if(divide_count==1)begin ay_average<={quotient[14:0],division_step>=3};state<=MIX;end
end
MIX:begin
mix_quarters<=$signed({2'd0,ay_average,3'd0})+(speech_extended<<<3)-speech_extended;
state<=HP_PREP;
end
HP_PREP:begin
operand<=previous_hp+current_input-previous_input;factor<=24'd16609444;
state<=HP_MULT;
end
HP_MULT,ENV_MULT:begin
product_low<=operand[17:0]*factor;
product_high<=$signed(operand[34:18])*$signed({1'b0,factor});
combine_return<=state==HP_MULT?HP_STORE:ENV_STORE;state<=MULT_COMBINE;
end
MULT_COMBINE:begin product<={combined_high,product_low[17:0]};state<=combine_return;end
HP_STORE:begin
previous_input<=current_input;previous_hp<=scaled_product[34:0];
rectified<=scaled_product[39]?-scaled_product[34:0]:scaled_product[34:0];state<=ENV_PREP;
end
ENV_PREP:begin
operand<=rectified-$signed(envelope);
factor<=rectified>$signed(envelope)?24'd43621:24'd5033;state<=ENV_MULT;
end
ENV_STORE:begin
envelope<=envelope_next[34:0];
if(activity&&envelope_next<40'sd21474836)activity<=0;
else if(!activity&&envelope_next>40'sd107374182)activity<=1;
if(mix_quarters>21'sd131068)mixed_sample<=16'sd32767;
else if(mix_quarters< -21'sd131072)mixed_sample<=16'sh8000;
else mixed_sample<=mix_quarters[17:2];
sample_valid<=1;state<=IDLE;
end
default:state<=IDLE;
endcase
end
end
endmodule
+106
View File
@@ -0,0 +1,106 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// AY-3-8913 behavioral hardware port for Coco 3 Plus.
// Reference: VCCPlus a8a84f22 src/devices/ssc/ay8913.{h,cpp}; see LICENSE.
// The reference volume table is a logarithmic approximation, not silicon data.
// clock_enable pulses once per AY INPUT clock; internal generators divide by 8.
// Same-edge register writes follow generator advancement using old registers.
// sample_sum is the unnormalized three-channel sum, with two pipeline stages.
// The future SSC mixer applies /3 normalization, gain, filtering and routing.
module ssc_ay8913(
input wire clk,reset,clock_enable,
input wire reg_select,reg_write,
input wire [7:0] bus_data,
output wire [7:0] read_data,
output reg [17:0] sample_sum
);
reg [7:0] registers[0:15];
reg [3:0] selected;
reg [2:0] divider;
reg [11:0] tone_counter[0:2];
reg [2:0] tone_output;
reg [4:0] noise_counter;
reg [16:0] noise_lfsr;
reg [15:0] env_counter;
reg [5:0] env_step;
reg env_up,env_holding;
reg [15:0] level[0:2];
wire [11:0] tone_period[0:2];
wire [4:0] noise_period=registers[6][4:0];
wire [15:0] env_period={registers[12],registers[11]};
wire [4:0] env_position=env_up?env_step[4:0]:~env_step[4:0];
wire [3:0] env_level=(!registers[13][3] && env_holding)?4'd0:env_position[4:1];
assign read_data=registers[selected];
function [15:0] volume(input [3:0] index);
begin
case(index)
0:volume=0;1:volume=1304;2:volume=1642;3:volume=2067;
4:volume=2603;5:volume=3277;6:volume=4125;7:volume=5193;
8:volume=6538;9:volume=8231;10:volume=10362;11:volume=13045;
12:volume=16422;13:volume=20675;14:volume=26028;15:volume=32767;
endcase
end
endfunction
genvar ch;
generate for(ch=0;ch<3;ch=ch+1) begin:channels
assign tone_period[ch]={registers[ch*2+1][3:0],registers[ch*2]};
wire gate=(registers[7][ch] || tone_output[ch]) &&
(registers[7][ch+3] || noise_lfsr[0]);
wire [3:0] amplitude=registers[ch+8][4]?env_level:registers[ch+8][3:0];
always @(posedge clk) begin
if(reset) level[ch]<=0;
else level[ch]<=gate?volume(amplitude):16'd0;
end
end endgenerate
integer i;
always @(posedge clk) begin
if(reset) begin
selected<=0;divider<=0;tone_output<=3'b111;
noise_counter<=0;noise_lfsr<=17'd1;
env_counter<=0;env_step<=0;env_up<=1;env_holding<=0;
sample_sum<=0;
for(i=0;i<16;i=i+1) registers[i]<=0;
for(i=0;i<3;i=i+1) tone_counter[i]<=0;
end else begin
sample_sum<={2'b0,level[0]}+{2'b0,level[1]}+{2'b0,level[2]};
if(clock_enable) begin
divider<=divider+1'b1;
if(divider==3'd7) begin
for(i=0;i<3;i=i+1) begin
if(tone_counter[i]>=(tone_period[i]==0?12'd0:tone_period[i]-12'd1)) begin
tone_counter[i]<=0;tone_output[i]<=!tone_output[i];
end else tone_counter[i]<=tone_counter[i]+1'b1;
end
if(noise_counter>=(noise_period==0?5'd0:noise_period-5'd1)) begin
noise_counter<=0;
noise_lfsr<={noise_lfsr[0]^noise_lfsr[3],noise_lfsr[16:1]};
end else noise_counter<=noise_counter+1'b1;
if(env_counter>=(env_period==0?16'd0:env_period-16'd1)) begin
env_counter<=0;
if(!env_holding) begin
if(env_step==6'd31) begin
if(!registers[13][3]) begin env_step<=32;env_holding<=1;end
else if(registers[13][0]) begin
env_step<=31;env_holding<=1;
if(registers[13][1]) env_up<=!env_up;
end else begin
env_step<=0;
if(registers[13][1]) env_up<=!env_up;
end
end else env_step<=env_step+1'b1;
end
end else env_counter<=env_counter+1'b1;
end
end
if(reg_select) selected<=bus_data[3:0];
if(reg_write) begin
registers[selected]<=bus_data;
if(selected==4'd13) begin
env_step<=0;env_holding<=0;env_up<=bus_data[2];
end
end
end
end
endmodule
+74
View File
@@ -0,0 +1,74 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Shared digital SSC cartridge; clocks use enables, never generated fabric clocks.
// reset is FPGA power/reconfiguration reset (clears volatile ROM loader state).
// cartridge_reset restarts chips while retaining loaded ROMs and glue SRAM.
module ssc_cartridge #(parameter integer CLOCK_HZ=114545408)(
input wire clk,reset,cartridge_reset,enable,host_read,host_write,
input wire [15:0] host_address,input wire [7:0] host_data,
output wire host_read_valid,output wire [7:0] host_read_data,output wire [7:0] status,
input wire pic_rom_begin,pic_rom_write,input wire [11:0] pic_rom_address,input wire [7:0] pic_rom_data,
input wire speech_rom_begin,speech_rom_write,input wire [10:0] speech_rom_address,input wire [7:0] speech_rom_data,
output wire pic_loaded,speech_loaded,operational,fault,
output wire signed [15:0] audio_sample,output wire audio_valid,
output wire speech_standby,sound_activity,output wire [15:0] debug_pc);
reg [31:0] ay_phase,speech_phase,audio_phase;
reg ay_ce,phi_ce,speech_ce,audio_ce,phi_half;
wire [32:0] ay_next={1'b0,ay_phase}+33'd1789772;
wire [32:0] speech_next={1'b0,speech_phase}+33'd10000;
wire [32:0] audio_next={1'b0,audio_phase}+33'd44100;
wire [32:0] ay_wrapped=ay_next>=CLOCK_HZ?ay_next-CLOCK_HZ:ay_next;
wire [32:0] speech_wrapped=speech_next>=CLOCK_HZ?speech_next-CLOCK_HZ:speech_next;
wire [32:0] audio_wrapped=audio_next>=CLOCK_HZ?audio_next-CLOCK_HZ:audio_next;
always @(posedge clk)begin
if(reset)begin
ay_phase<=0;speech_phase<=0;audio_phase<=0;ay_ce<=0;phi_ce<=0;speech_ce<=0;audio_ce<=0;phi_half<=0;
end else begin
ay_ce<=ay_next>=CLOCK_HZ;phi_ce<=0;speech_ce<=speech_next>=CLOCK_HZ;audio_ce<=audio_next>=CLOCK_HZ;
ay_phase<=ay_wrapped[31:0];speech_phase<=speech_wrapped[31:0];audio_phase<=audio_wrapped[31:0];
if(ay_next>=CLOCK_HZ)begin phi_half<=!phi_half;phi_ce<=phi_half;end
end
end
wire pic_error,speech_error,pic_initialized,glue_initialized;
wire pic_overrun,speech_overrun,speech_fault,audio_overrun;
wire [31:0] illegal;
wire [7:0] command,host_result;
wire ignored_valid,command_read,busy_line,command_irq,command_busy,controller_reset,speech_reset;
wire gpio_request,gpio_write,gpio_ready;
wire [1:0] gpio_port;
wire [7:0] gpio_write_data,gpio_read_data,ay_bus,ay_read_data;
wire ay_select,ay_write,ald,speech_ready;
wire [5:0] allophone;
wire [17:0] ay_sum;
wire signed [15:0] speech_sample;
wire speech_valid,speech_busy,audio_busy;
wire [18:0] speech_pc;
wire [31:0] speech_frames;
wire rom_ready=pic_loaded&&speech_loaded;
assign fault=pic_error||speech_error||pic_overrun||speech_overrun||speech_fault||audio_overrun||(|illegal);
assign operational=rom_ready&&pic_initialized&&glue_initialized&&!fault;
// Address-independent status lets the wrapper sample at the CPU clock edge
// without feeding live CPU address/control back through the cartridge.
assign status=operational ? {!command_busy,speech_standby,!sound_activity,5'b11111} : 8'h7f;
assign host_read_valid=enable&&host_read&&(host_address==16'hff7d||host_address==16'hff7e);
assign host_read_data=!host_read_valid ? 8'd0 : host_address==16'hff7d ? 8'hff : operational ? host_result : 8'h7f;
ssc_host host(clk,reset||!rom_ready,enable&&operational,host_read,host_write,host_address,host_data,
ignored_valid,host_result,command_read,busy_line,command,command_irq,command_busy,
speech_standby,sound_activity,controller_reset,speech_reset);
ssc_tms7000 controller(.clk(clk),.reset(reset),.controller_reset(controller_reset||cartridge_reset),
.icount_tick(phi_ce),.rom_begin(pic_rom_begin),.rom_write(pic_rom_write),.rom_address(pic_rom_address),.rom_data(pic_rom_data),
.rom_loaded(pic_loaded),.load_error(pic_error),.initialized(pic_initialized),.overrun(pic_overrun),
.debug_pc(debug_pc),.illegal_count(illegal),.irq1(speech_ready),.irq3(command_irq),.timer_external(command[7]),
.gpio_request(gpio_request),.gpio_write(gpio_write),.gpio_port(gpio_port),.gpio_write_data(gpio_write_data),
.gpio_ready(gpio_ready),.gpio_read_data(gpio_read_data));
ssc_glue glue(clk,reset,gpio_request,gpio_write,gpio_port,gpio_write_data,gpio_ready,gpio_read_data,
glue_initialized,command,command_read,busy_line,ay_select,ay_write,ay_bus,ay_read_data,ald,allophone);
ssc_ay8913 ay(clk,reset||controller_reset||cartridge_reset,ay_ce,ay_select,ay_write,ay_bus,ay_read_data,ay_sum);
ssc_sp0256 speech(.clk(clk),.reset(reset),.speech_reset(speech_reset||cartridge_reset),.sample_ce(speech_ce),
.ald(ald),.allophone(allophone),.rom_begin(speech_rom_begin),.rom_write(speech_rom_write),
.rom_address(speech_rom_address),.rom_data(speech_rom_data),.rom_loaded(speech_loaded),.load_error(speech_error),
.data_request(speech_ready),.standby(speech_standby),.sample(speech_sample),.sample_valid(speech_valid),
.busy(speech_busy),.overrun(speech_overrun),.fault(speech_fault),.debug_pc(speech_pc),.frame_count(speech_frames));
ssc_audio audio(clk,reset,audio_ce,ay_sum,speech_sample,audio_sample,audio_valid,sound_activity,audio_overrun,audio_busy);
endmodule
+135
View File
@@ -0,0 +1,135 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Coco 3 Plus: PIC7040 external ports and 2 KiB SRAM.
// Behavioral reference: VCCPlus a8a84f22 src/devices/ssc/ssc_core.cpp;
// MAME CoCo SSC wiring copyright Tim Lindner. Original notices: LICENSE.
// Chip execution/audio is external to this block. All signals use clk.
// Hold request/payload until io_ready, then withdraw request before another
// access. Chip strobes occur once even if a completed request remains asserted.
module ssc_glue (
input wire clk, reset,
input wire io_request, io_write,
input wire [1:0] io_port, // A=0, B=1, C=2, D=3; GPIO values after PIC DDR
input wire [7:0] io_write_data,
output reg io_ready,
output reg [7:0] io_read_data,
output reg init_done,
input wire [7:0] command_data,
output reg command_read,
output wire pic_busy_line,
output reg ay_select, ay_write,
output reg [7:0] ay_bus_data,
input wire [7:0] ay_read_data,
output reg speech_ald,
output reg [5:0] speech_code
);
localparam [1:0] INITIALIZE=0, IDLE=1, EXECUTE=2, WAIT_RELEASE=3;
reg [1:0] state;
reg [10:0] clear_address;
reg access_write;
reg [1:0] access_port;
reg [7:0] access_data;
reg [7:0] port_b, port_c, port_d;
reg [7:0] ram [0:2047];
reg [7:0] ram_read;
wire ram_clear = state == INITIALIZE;
wire ram_store = state == EXECUTE && access_write && access_port == 2 &&
!access_data[4] && !access_data[3];
wire [10:0] ram_write_address = ram_clear ? clear_address : {access_data[2:0],port_b};
wire [7:0] ram_write_data = ram_clear ? 8'h00 : port_d;
wire ram_selected = !port_c[4] && port_c[3];
wire ay_selected_read = !port_c[6] && !port_c[3] && port_c[0];
// AY read overrides SRAM if both devices are selected, matching the reference.
wire [7:0] read_d = ay_selected_read ? ay_read_data : ram_selected ? ram_read : port_d;
assign pic_busy_line = port_c[7];
// Synchronous read/write inference, with a hardware scrub instead of resetting
// every memory element. Keep the future PIC in reset until init_done.
always @(posedge clk) begin
ram_read <= ram[{port_c[2:0],port_b}];
if (!reset && (ram_clear || ram_store))
ram[ram_write_address] <= ram_write_data;
end
always @(posedge clk) begin
if (reset) begin
state <= INITIALIZE;
clear_address <= 0;
init_done <= 0;
io_ready <= 0;
io_read_data <= 0;
command_read <= 0;
ay_select <= 0;
ay_write <= 0;
ay_bus_data <= 0;
speech_ald <= 0;
speech_code <= 0;
access_write <= 0;
access_port <= 0;
access_data <= 0;
// Observable state after SscCore::Reset and the PIC's reset callbacks.
port_b <= 8'hFF;
port_c <= 8'h00;
port_d <= 8'h00;
end else begin
command_read <= 0;
ay_select <= 0;
ay_write <= 0;
speech_ald <= 0;
case (state)
INITIALIZE: begin
if (clear_address == 11'd2047) begin
init_done <= 1;
state <= IDLE;
end else clear_address <= clear_address + 1'b1;
end
IDLE: if (io_request) begin
access_write <= io_write;
access_port <= io_port;
access_data <= io_write_data;
state <= EXECUTE;
end
EXECUTE: begin
if (access_write) begin
case (access_port)
1: port_b <= access_data;
2: begin
port_c <= access_data;
if (!access_data[6] && access_data[3]) begin
ay_bus_data <= port_d;
ay_select <= access_data[0];
ay_write <= !access_data[0];
end
if (port_c[5] && !access_data[5] && port_d < 8'd64) begin
speech_ald <= 1;
speech_code <= port_d[5:0];
end
end
3: port_d <= access_data;
endcase
end else begin
case (access_port)
0: begin
io_read_data <= command_data;
command_read <= 1;
end
1: io_read_data <= port_b;
2: io_read_data <= port_c;
3: begin
io_read_data <= read_d;
port_d <= read_d;
end
endcase
end
io_ready <= 1;
state <= WAIT_RELEASE;
end
WAIT_RELEASE: if (!io_request) begin
io_ready <= 0;
state <= IDLE;
end
endcase
end
end
endmodule
+84
View File
@@ -0,0 +1,84 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Coco 3 Plus: Sound/Speech host interface.
// Behavioral reference: VCCPlus a8a84f22 src/devices/ssc/ssc_core.cpp;
// CoCo SSC wiring derives from MAME, copyright Tim Lindner. See LICENSE.
// This block does not implement the PIC, PSG, speech engine or audio circuit.
// All inputs must be synchronous to clk. host_write/pic_command_read are
// single-cycle transaction strobes, not unqualified CPU bus levels.
module ssc_host (
input wire clk,
input wire reset,
input wire enable,
input wire host_read,
input wire host_write,
input wire [15:0] host_address,
input wire [7:0] host_data,
output wire host_read_valid,
output wire [7:0] host_read_data,
// Future controller's port A input and INT3 command request.
input wire pic_command_read,
input wire pic_busy_line,
output reg [7:0] command_data,
output reg command_irq,
output reg command_busy,
// Future engines supply these levels; this block does not synthesize them.
input wire speech_standby,
input wire sound_active,
// Reset requests last one clk tick (held asserted during global reset).
output reg controller_reset,
output reg speech_reset
);
localparam [15:0] CONTROL_ADDRESS = 16'hFF7D;
localparam [15:0] COMMAND_ADDRESS = 16'hFF7E;
reg reset_bit;
reg previous_busy_line;
wire control_write = enable && host_write && host_address == CONTROL_ADDRESS;
wire command_write = enable && host_write && host_address == COMMAND_ADDRESS;
assign host_read_valid = enable && host_read &&
(host_address == CONTROL_ADDRESS || host_address == COMMAND_ADDRESS);
// An unselected device contributes nothing to the shared read mux.
assign host_read_data = !host_read_valid ? 8'h00 :
host_address == CONTROL_ADDRESS ? 8'hFF :
{ !command_busy, speech_standby, !sound_active, 5'b11111 };
always @(posedge clk) begin
if (reset) begin
reset_bit <= 1'b1;
previous_busy_line <= 1'b0; // controller reset drives port C to zero
command_data <= 8'h00;
command_irq <= 1'b0;
command_busy <= 1'b0;
controller_reset <= 1'b1;
speech_reset <= 1'b1;
end else begin
controller_reset <= 1'b0;
speech_reset <= 1'b0;
previous_busy_line <= pic_busy_line;
if (!previous_busy_line && pic_busy_line)
command_busy <= 1'b0;
if (pic_command_read)
command_irq <= 1'b0;
if (control_write) begin
reset_bit <= host_data[0];
if (host_data[0]) speech_reset <= 1'b1;
if (reset_bit && !host_data[0]) begin
controller_reset <= 1'b1;
command_busy <= 1'b0;
command_irq <= 1'b0;
previous_busy_line <= 1'b0;
end
end
// A fresh host command wins over simultaneous completion/read strobes.
// The controller consuming port A on this edge sees the OLD payload;
// the new payload remains latched with INT3 asserted for its next read.
if (command_write) begin
command_data <= host_data;
command_busy <= 1'b1;
command_irq <= 1'b1;
end
end
end
endmodule
+109
View File
@@ -0,0 +1,109 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// MiSTer HPS file/bus/audio integration. Same57MHz domain; CPU commits on the
// negative edge, cartridge logic on the positive edge. Both half paths are timed.
module ssc_mister_bridge(input wire clk,reset,cpu_reset,mode,
input wire cpu_commit,cpu_rnw,input wire [15:0] cpu_address,input wire [7:0] cpu_data,
input wire ioctl_download,ioctl_wr,input wire [7:0] ioctl_index,
input wire [24:0] ioctl_address,input wire [7:0] ioctl_data,
input wire cartridge_operational,cartridge_fault,
input wire [7:0] cartridge_read_data,input wire signed [15:0] cartridge_audio,
input wire sound_enable,input wire [1:0] sound_select,
input wire [7:0] orchestra_left,orchestra_right,input wire [15:0] legacy_left,legacy_right,
output wire cartridge_reset,host_read,host_write,output wire [15:0] host_address,
output wire [7:0] host_data,output wire read_valid,output wire [7:0] read_data,
output wire palette_owner,rom_files_valid,load_fault,
output wire pic_begin,pic_write,output wire [11:0] pic_address,output wire [7:0] pic_data,
output wire speech_begin,speech_write,output wire [10:0] speech_address,output wire [7:0] speech_data,
output wire [15:0] audio_left,audio_right);
reg download_d,mode_d;
reg [5:0] file_kind;
reg [12:0] count;
reg malformed,pic_valid,speech_valid,pic_bad,speech_bad;
reg pipe_write;
reg [5:0] pipe_kind;
reg [24:0] pipe_address;
reg [7:0] pipe_data;
wire selected=ioctl_index[5:0]==4||ioctl_index[5:0]==5;
wire start=ioctl_download&&!download_d&&selected;
wire finish=!ioctl_download&&download_d;
wire transferring=ioctl_download&&(selected||file_kind==4||file_kind==5);
wire valid_length=(file_kind==4&&count==4096)||(file_kind==5&&count==2048);
assign pic_begin=start&&ioctl_index[5:0]==4;
assign speech_begin=start&&ioctl_index[5:0]==5;
assign pic_write=pipe_write&&pipe_kind==4;
assign speech_write=pipe_write&&pipe_kind==5;
assign pic_address=pipe_address[11:0];assign speech_address=pipe_address[10:0];
assign pic_data=pipe_data;assign speech_data=pipe_data;
assign rom_files_valid=pic_valid&&speech_valid&&!transferring;
assign load_fault=pic_bad||speech_bad||cartridge_fault;
assign palette_owner=!mode;
assign cartridge_reset=cpu_reset||transferring||(mode!=mode_d);
always @(posedge clk)begin
if(reset)begin
download_d<=0;mode_d<=0;file_kind<=0;count<=0;malformed<=0;
pic_valid<=0;speech_valid<=0;pic_bad<=0;speech_bad<=0;
pipe_write<=0;pipe_kind<=0;pipe_address<=0;pipe_data<=0;
end else begin
download_d<=ioctl_download;mode_d<=mode;
pipe_write<=ioctl_download&&ioctl_wr&&selected;
pipe_kind<=ioctl_index[5:0];pipe_address<=ioctl_address;pipe_data<=ioctl_data;
if(start)begin
file_kind<=ioctl_index[5:0];count<=ioctl_wr?13'd1:13'd0;
malformed<=ioctl_wr&&ioctl_address!=0;
if(ioctl_index[5:0]==4)begin pic_valid<=0;pic_bad<=0;end
else begin speech_valid<=0;speech_bad<=0;end
end else if(ioctl_download&&ioctl_wr&&(file_kind==4||file_kind==5))begin
if(ioctl_index[5:0]!=file_kind||ioctl_address!={12'd0,count})malformed<=1;
if(count<4097)count<=count+13'd1;else malformed<=1;
end
if(finish)begin
if(file_kind==4)begin pic_valid<=!malformed&&valid_length;pic_bad<=malformed||!valid_length;end
else if(file_kind==5)begin speech_valid<=!malformed&&valid_length;speech_bad<=malformed||!valid_length;end
file_kind<=0;
end
end
end
// Toggle handshake captures an old CPU bus at its real negative-edge commit.
// It clears after the following positive-edge consume, leaving read data stable
// before a possible back-to-back CPU read on the next negative edge.
reg write_toggle=0,consumed_toggle=0;
reg [15:0] write_address;
reg [7:0] write_data;
reg cpu_mode=0;
reg [7:0] status_sample=8'h7f;
wire write_pending=write_toggle!=consumed_toggle;
always @(negedge clk)begin
// CPU and this snapshot consume OLD values on the same negative edge.
// The CPU therefore sees a full-cycle-stable status through its read mux;
// this adds at most one57MHz tick of status visibility, no CPU wait state.
cpu_mode<=mode;
if(reset||cpu_reset||!rom_files_valid)status_sample<=8'h7f;
else status_sample<=cartridge_read_data;
if(reset||cpu_reset)begin write_toggle<=0;write_address<=0;write_data<=0;end
else if(cpu_commit&&!cpu_rnw)begin
write_address<=cpu_address;write_data<=cpu_data;write_toggle<=!write_toggle;
end
end
always @(posedge clk)if(reset)consumed_toggle<=0;else consumed_toggle<=write_toggle;
assign host_address=write_address;
assign host_data=write_data;
assign host_write=write_pending&&!cpu_reset&&rom_files_valid&&mode;
assign host_read=1'b0;
assign read_valid=cpu_mode&&cpu_rnw&&(cpu_address==16'hff7d||cpu_address==16'hff7e);
assign read_data=!read_valid ? 8'd0 : cpu_address==16'hff7d ? 8'hff :
status_sample;
// In cartridge mux position replace the stale internal-DAC contribution.
// Orchestra remains independent stereo. Its reset midpoint is128/0x8080.
wire select_cartridge=mode&&sound_enable&&sound_select==2;
wire signed [17:0] contribution=rom_files_valid&&cartridge_operational ?
{{2{cartridge_audio[15]}},cartridge_audio} : 18'sd0;
wire signed [17:0] sum_left=$signed({2'd0,orchestra_left,orchestra_left})-18'sd128+contribution;
wire signed [17:0] sum_right=$signed({2'd0,orchestra_right,orchestra_right})-18'sd128+contribution;
function [15:0] saturate(input signed [17:0] value);
begin saturate=value<0 ? 16'd0 : value>18'sd65535 ? 16'hffff : value[15:0];end
endfunction
assign audio_left=select_cartridge?saturate(sum_left):legacy_left;
assign audio_right=select_cartridge?saturate(sum_right):legacy_right;
endmodule
+242
View File
@@ -0,0 +1,242 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// SP0256-AL2 cartridge engine. Public microsequencer/LPC algorithm derived from
// MAME Joseph Zbiciak, Tim Lindner, through pinned VCCPlus a8a84f22. See LICENSE.
// No mask ROM embedded. AL2's on-chip 2 KiB occupies byte addresses1000..17ff;
// unpopulated serial-ROM space reads zero. The cartridge has no host FIFO port.
// sample_ce is native speech clock/312; clk must allow completion before next CE.
module ssc_sp0256(input wire clk,reset,speech_reset,sample_ce,
input wire ald,input wire [5:0] allophone,
input wire rom_begin,rom_write,input wire [10:0] rom_address,input wire [7:0] rom_data,
output wire rom_loaded,load_error,output reg data_request,standby,
output reg signed [15:0] sample,output reg sample_valid,output wire busy,
output reg overrun,fault,output wire [18:0] debug_pc,output reg [31:0] frame_count);
`include "ssc_sp0256_tables.vh"
localparam [5:0] IDLE=0,MICRO=1,IMM=2,OPCODE=3,BRANCH=4,
CONTROL=5,FIELD_START=6,FIELD_APPLY=7,FIELD_NEXT=8,REGDEC=9,
COEF_B=10,COEF_F=11,EXCITE=12,FILTER_MULT=13,FILTER_SUM=14,LIMIT=15,
GET0=16,GET1=17,GET2=18,GET3=19,GET4=20,FILTER_PICK=21,COEF_DECODE=22,COEF_STORE=23;
reg [5:0] state,return_state;
reg [18:0] pc,stack,page;
assign debug_pc=pc;
assign busy=state!=IDLE;
reg halted,pending,fifo_selected,initialized;
reg [5:0] command,mode;
reg [3:0] immediate,opcode,bit_length;
reg [7:0] bit_value,control_index,control_last,byte0;
reg [15:0] control_word;
reg [15:0] next_byte;
reg first_valid,second_valid;
reg [10:0] read_address;
wire [7:0] read_data;
ssc_sp0256_memory memory(clk,reset,rom_begin,rom_write,rom_address,rom_data,
rom_loaded,load_error,read_address,read_data);
reg [7:0] r[0:15];
reg signed [8:0] rpt;
reg signed [10:0] cnt;
reg [7:0] period;
reg [11:0] amplitude;
reg [14:0] rng;
reg interpolate;
reg signed [9:0] bcoef[0:5],fcoef[0:5];
reg signed [15:0] z0[0:5],z1[0:5];
reg signed [15:0] excitation;
reg signed [25:0] product_b,product_f;
reg signed [9:0] operand_b,operand_f,decoded_coefficient;
reg signed [15:0] operand_z0,operand_z1;
reg [7:0] coefficient_input;
reg coefficient_forward;
wire signed [31:0] filter_sum=$signed(excitation)+($signed(product_b)>>>9)+($signed(product_f)>>>8);
reg [2:0] section;
reg [12:0] micro_steps;
integer j;
wire pulse=period!=0 ? cnt<=0 : cnt<=1;
wire [7:0] next_amplitude=r[0]+r[14];
wire [7:0] next_period=r[1]+r[15];
wire [7:0] signed_field=control_word[12] && bit_value[control_word[3:0]-1] ?
(bit_value | (8'hff<<control_word[3:0])) : bit_value;
wire [7:0] shifted_field=signed_field<<control_word[7:4];
wire [15:0] rom_bit_window=({second_valid?read_data:8'd0,byte0}>>pc[2:0]) & ((16'h1<<bit_length)-16'd1);
function [11:0] amp_decode(input [7:0] value);
begin amp_decode={7'd0,value[4:0]}<<value[7:5];end
endfunction
function signed [9:0] coefficient(input [7:0] value);
reg [7:0] negated;
begin negated=-value;
coefficient=value[7]?$signed({1'b0,sp_quant(negated[6:0])}):-$signed({1'b0,sp_quant(value[6:0])});
end
endfunction
function [3:0] reverse4(input [3:0] value);
begin reverse4={value[0],value[1],value[2],value[3]};end
endfunction
function [7:0] reverse8(input [7:0] value);
begin reverse8={value[0],value[1],value[2],value[3],value[4],value[5],value[6],value[7]};end
endfunction
task bits(input [3:0] length,input [5:0] destination);
begin bit_length<=length;return_state<=destination;state<=GET0;end
endtask
always @(posedge clk)begin
if(reset || rom_begin || !rom_loaded || speech_reset)begin
state<=IDLE;return_state<=IDLE;pc<=0;stack<=0;page<=19'h08000;
halted<=1;pending<=0;fifo_selected<=0;initialized<=0;command<=0;mode<=0;
immediate<=0;opcode<=0;bit_length<=0;bit_value<=0;control_index<=0;control_last<=0;
control_word<=0;byte0<=0;next_byte<=0;first_valid<=0;second_valid<=0;read_address<=0;
rpt<=-9'sd1;cnt<=0;period<=0;amplitude<=0;rng<=1;interpolate<=0;
excitation<=0;product_b<=0;product_f<=0;section<=0;micro_steps<=0;
operand_b<=0;operand_f<=0;operand_z0<=0;operand_z1<=0;decoded_coefficient<=0;
coefficient_input<=0;coefficient_forward<=0;
data_request<=rom_loaded&&!reset&&!rom_begin;standby<=1;sample<=0;sample_valid<=0;
overrun<=0;fault<=0;frame_count<=0;
for(j=0;j<16;j=j+1)r[j]<=0;
for(j=0;j<6;j=j+1)begin bcoef[j]<=0;fcoef[j]<=0;z0[j]<=0;z1[j]<=0;end
end else begin
sample_valid<=0;
if(!initialized)begin initialized<=1;data_request<=1;end
if(sample_ce && busy)overrun<=1;
case(state)
IDLE:if(sample_ce)begin micro_steps<=0;state<=rpt<=0?MICRO:EXCITE;end
MICRO:begin
micro_steps<=micro_steps+13'd1;
if(micro_steps==4095)begin
fault<=1;halted<=1;data_request<=1;pending<=0;standby<=1;
sample<=0;sample_valid<=1;state<=IDLE;
end else if(halted && pending)begin
pc<=19'h08000|{9'd0,command,4'd0};halted<=0;pending<=0;
data_request<=1;fifo_selected<=0;
for(j=0;j<16;j=j+1)r[j]<=0;
end else if(halted)begin
rpt<=1;data_request<=1;pending<=0;standby<=1;
for(j=0;j<16;j=j+1)r[j]<=0;
state<=EXCITE;
end else bits(4,IMM);
end
IMM:begin immediate<=bit_value[3:0];bits(4,OPCODE);end
OPCODE:begin
opcode<=bit_value[3:0];
if(bit_value!=1)mode<=mode&6'h0f;
case(bit_value[3:0])
0:begin
if(immediate!=0)page<={reverse4(immediate),15'd0};
else begin
stack<=0;pc<=stack;fifo_selected<=stack==19'h0c000;
if(stack==0)halted<=1;
end
state<=MICRO;
end
1:begin mode<={immediate[1:0],1'b0,immediate[2],immediate[3],1'b0};state<=MICRO;end
13,14:bits(8,BRANCH);
default:begin
if({mode[5:4],immediate}==0)state<=MICRO;
else begin
rpt<=$signed({3'd0,mode[5:4],immediate})+9'sd1;
control_index<=sp_index({bit_value[3:0],mode[2:1],1'b0});
control_last<=sp_index({bit_value[3:0],mode[2:1],1'b1});state<=CONTROL;
end
end
endcase
end
BRANCH:begin
if(opcode==13)stack<=(pc+19'd7)&19'h7fff8;
pc<=page|{4'd0,reverse4(immediate),11'd0}|{8'd0,reverse8(bit_value),3'd0};
fifo_selected<=(page|{4'd0,reverse4(immediate),11'd0}|{8'd0,reverse8(bit_value),3'd0})==19'h0c000;
state<=MICRO;
end
CONTROL:begin
if(control_index>176 || control_last>176)begin fault<=1;sample<=0;sample_valid<=1;state<=IDLE;end
else begin control_word<=sp_control(control_index);state<=FIELD_START;end
end
FIELD_START:begin
if(control_word[15])for(j=0;j<16;j=j+1)r[j]<=0;
if(control_word[14])begin r[12]<=0;r[13]<=0;end
if(control_word[3:0]!=0)bits(control_word[3:0],FIELD_APPLY);
else state<=FIELD_NEXT;
end
FIELD_APPLY:begin
if(control_word[13])r[control_word[11:8]]<=
(r[control_word[11:8]] & ~(8'hff<<control_word[7:4])) | shifted_field;
else if(control_word[12])r[control_word[11:8]]<=r[control_word[11:8]]+shifted_field;
else r[control_word[11:8]]<=shifted_field;
state<=FIELD_NEXT;
end
FIELD_NEXT:begin
if(control_index==control_last)begin
if(opcode==15)r[1]<=64;
state<=REGDEC;
end else begin control_index<=control_index+8'd1;state<=CONTROL;end
end
REGDEC:begin
amplitude<=amp_decode(r[0]);period<=r[1];cnt<=0;
interpolate<=r[14]!=0||r[15]!=0;section<=0;frame_count<=frame_count+32'd1;state<=COEF_B;
end
COEF_B:begin coefficient_input<=r[2+{section,1'b0}];coefficient_forward<=0;state<=COEF_DECODE;end
COEF_F:begin coefficient_input<=r[3+{section,1'b0}];coefficient_forward<=1;state<=COEF_DECODE;end
COEF_DECODE:begin decoded_coefficient<=coefficient(coefficient_input);state<=COEF_STORE;end
COEF_STORE:begin
if(coefficient_forward)begin
fcoef[section]<=decoded_coefficient;
if(section==5)state<=EXCITE;else begin section<=section+3'd1;state<=COEF_B;end
end else begin bcoef[section]<=decoded_coefficient;state<=COEF_F;end
end
EXCITE:begin
if(period!=0)begin
if(pulse)begin cnt<=cnt+$signed({3'd0,period});excitation<=$signed({4'd0,amplitude});end
else begin cnt<=cnt-11'sd1;excitation<=0;end
end else begin
cnt<=pulse?11'sd64:cnt-11'sd1;
rng<=(rng>>1)^(rng[0]?15'h4001:15'd0);
excitation<=rng[0]?$signed({4'd0,amplitude}):-$signed({4'd0,amplitude});
end
if(pulse)begin
rpt<=rpt-9'sd1;
for(j=0;j<6;j=j+1)begin z0[j]<=0;z1[j]<=0;end
if(interpolate)begin
r[0]<=next_amplitude;r[1]<=next_period;
amplitude<=amp_decode(next_amplitude);period<=next_period;
end
end
section<=0;state<=(pulse && rpt<=1)?MICRO:FILTER_PICK;
end
FILTER_PICK:begin
operand_b<=bcoef[section];operand_f<=fcoef[section];
operand_z0<=z0[section];operand_z1<=z1[section];state<=FILTER_MULT;
end
FILTER_MULT:begin
product_b<=$signed(operand_b)*$signed(operand_z1);
product_f<=$signed(operand_f)*$signed(operand_z0);state<=FILTER_SUM;
end
FILTER_SUM:begin
excitation<=filter_sum[15:0];z1[section]<=z0[section];z0[section]<=filter_sum[15:0];
if(section==5)state<=LIMIT;else begin section<=section+3'd1;state<=FILTER_PICK;end
end
LIMIT:begin
sample<=excitation > 16'sd8191 ? 16'sd32764 :
excitation < -16'sd8192 ? 16'sh8000 : excitation<<<2;
sample_valid<=1;state<=IDLE;
end
GET0:begin
if(fifo_selected)begin bit_value<=0;state<=return_state;end
else begin
read_address<=pc[13:3];first_valid<=pc[18:14]==2;
next_byte<=pc[18:3]+16'd1;state<=GET1;
end
end
GET1:state<=GET2;
GET2:begin
byte0<=first_valid?read_data:8'd0;read_address<=next_byte[10:0];
second_valid<=next_byte[15:11]==2;state<=GET3;
end
GET3:state<=GET4;
GET4:begin
bit_value<=rom_bit_window[7:0];
pc<=pc+{15'd0,bit_length};state<=return_state;
end
default:begin fault<=1;state<=IDLE;end
endcase
// A newly accepted ALD wins over a simultaneous idle/microsequencer update.
if(ald && data_request && initialized)begin
command<=allophone;pending<=1;data_request<=0;standby<=0;
end
end
end
endmodule
+26
View File
@@ -0,0 +1,26 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Volatile, synchronous AL2 ROM. Original bytes arrive through a strict loader.
module ssc_sp0256_memory(input wire clk,reset,rom_begin,rom_write,
input wire [10:0] rom_address,input wire [7:0] rom_data,
output reg rom_loaded,load_error,input wire [10:0] read_address,
output reg [7:0] read_data);
reg [7:0] rom[0:2047];
reg loading;
reg [11:0] expected;
always @(posedge clk)begin
read_data<=rom[read_address];
if(reset)begin rom_loaded<=0;load_error<=0;loading<=0;expected<=0;end
else if(rom_begin)begin
rom_loaded<=0;load_error<=rom_write;loading<=!rom_write;expected<=0;
end else if(rom_write)begin
if(!loading || expected!= {1'b0,rom_address})begin
load_error<=1;rom_loaded<=0;loading<=0;
end else begin
rom[rom_address]<=rom_data;expected<=expected+12'd1;
if(expected==2047)begin rom_loaded<=1;loading<=0;end
end
end
end
endmodule
+455
View File
@@ -0,0 +1,455 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// GI SP0256 public algorithm tables, MAME Joseph Zbiciak/Tim Lindner.
// Derived from pinned VCCPlus sp0256.cpp; see LICENSE. No mask ROM.
// Generated by scripts/generate_ssc_sp0256_tables.py.
// Source SHA256: 970ee4a027f637de820a10f66b119e95aeb366c4242df23de949ce1dccd030a3
function [15:0] sp_control(input [7:0] address);
begin case(address)
8'd0: sp_control=16'h8000;
8'd1: sp_control=16'h8008;
8'd2: sp_control=16'h0108;
8'd3: sp_control=16'h0208;
8'd4: sp_control=16'h0308;
8'd5: sp_control=16'h0408;
8'd6: sp_control=16'h0508;
8'd7: sp_control=16'h0608;
8'd8: sp_control=16'h0708;
8'd9: sp_control=16'h0808;
8'd10: sp_control=16'h0908;
8'd11: sp_control=16'h0a08;
8'd12: sp_control=16'h0b08;
8'd13: sp_control=16'h0c08;
8'd14: sp_control=16'h0d08;
8'd15: sp_control=16'h0e08;
8'd16: sp_control=16'h0f08;
8'd17: sp_control=16'h8026;
8'd18: sp_control=16'h0108;
8'd19: sp_control=16'h0834;
8'd20: sp_control=16'h0926;
8'd21: sp_control=16'h0a17;
8'd22: sp_control=16'h0b26;
8'd23: sp_control=16'h0c08;
8'd24: sp_control=16'h0d08;
8'd25: sp_control=16'h8026;
8'd26: sp_control=16'h0108;
8'd27: sp_control=16'h0816;
8'd28: sp_control=16'h0917;
8'd29: sp_control=16'h0a08;
8'd30: sp_control=16'h0b08;
8'd31: sp_control=16'h0c08;
8'd32: sp_control=16'h0d08;
8'd33: sp_control=16'h4000;
8'd34: sp_control=16'h0026;
8'd35: sp_control=16'h2926;
8'd36: sp_control=16'h2b26;
8'd37: sp_control=16'h2d08;
8'd38: sp_control=16'h4000;
8'd39: sp_control=16'h0026;
8'd40: sp_control=16'h2917;
8'd41: sp_control=16'h2b08;
8'd42: sp_control=16'h2d08;
8'd43: sp_control=16'h0000;
8'd44: sp_control=16'h0000;
8'd45: sp_control=16'h1024;
8'd46: sp_control=16'h1105;
8'd47: sp_control=16'h1243;
8'd48: sp_control=16'h1333;
8'd49: sp_control=16'h1443;
8'd50: sp_control=16'h1533;
8'd51: sp_control=16'h1643;
8'd52: sp_control=16'h1733;
8'd53: sp_control=16'h1833;
8'd54: sp_control=16'h1924;
8'd55: sp_control=16'h1a14;
8'd56: sp_control=16'h1b24;
8'd57: sp_control=16'h1c05;
8'd58: sp_control=16'h1d05;
8'd59: sp_control=16'h1024;
8'd60: sp_control=16'h1105;
8'd61: sp_control=16'h1214;
8'd62: sp_control=16'h1324;
8'd63: sp_control=16'h1414;
8'd64: sp_control=16'h1524;
8'd65: sp_control=16'h1614;
8'd66: sp_control=16'h1724;
8'd67: sp_control=16'h1814;
8'd68: sp_control=16'h1915;
8'd69: sp_control=16'h1a05;
8'd70: sp_control=16'h1b05;
8'd71: sp_control=16'h1c05;
8'd72: sp_control=16'h1d05;
8'd73: sp_control=16'h4000;
8'd74: sp_control=16'h0026;
8'd75: sp_control=16'h2335;
8'd76: sp_control=16'h2535;
8'd77: sp_control=16'h2735;
8'd78: sp_control=16'h4000;
8'd79: sp_control=16'h0026;
8'd80: sp_control=16'h2326;
8'd81: sp_control=16'h2526;
8'd82: sp_control=16'h2726;
8'd83: sp_control=16'h8026;
8'd84: sp_control=16'h0108;
8'd85: sp_control=16'h0243;
8'd86: sp_control=16'h0335;
8'd87: sp_control=16'h0443;
8'd88: sp_control=16'h0535;
8'd89: sp_control=16'h0643;
8'd90: sp_control=16'h0735;
8'd91: sp_control=16'h0834;
8'd92: sp_control=16'h0926;
8'd93: sp_control=16'h0a17;
8'd94: sp_control=16'h0b26;
8'd95: sp_control=16'h0e05;
8'd96: sp_control=16'h0f05;
8'd97: sp_control=16'h8026;
8'd98: sp_control=16'h0108;
8'd99: sp_control=16'h0216;
8'd100: sp_control=16'h0326;
8'd101: sp_control=16'h0416;
8'd102: sp_control=16'h0526;
8'd103: sp_control=16'h0616;
8'd104: sp_control=16'h0726;
8'd105: sp_control=16'h0816;
8'd106: sp_control=16'h0917;
8'd107: sp_control=16'h0a08;
8'd108: sp_control=16'h0b08;
8'd109: sp_control=16'h0e05;
8'd110: sp_control=16'h0f05;
8'd111: sp_control=16'h1024;
8'd112: sp_control=16'h1105;
8'd113: sp_control=16'h1833;
8'd114: sp_control=16'h1924;
8'd115: sp_control=16'h1a14;
8'd116: sp_control=16'h1b24;
8'd117: sp_control=16'h1c05;
8'd118: sp_control=16'h1d05;
8'd119: sp_control=16'h1024;
8'd120: sp_control=16'h1105;
8'd121: sp_control=16'h1814;
8'd122: sp_control=16'h1915;
8'd123: sp_control=16'h1a05;
8'd124: sp_control=16'h1b05;
8'd125: sp_control=16'h1c05;
8'd126: sp_control=16'h1d05;
8'd127: sp_control=16'h0026;
8'd128: sp_control=16'h0108;
8'd129: sp_control=16'h8026;
8'd130: sp_control=16'h0108;
8'd131: sp_control=16'h0243;
8'd132: sp_control=16'h0335;
8'd133: sp_control=16'h0443;
8'd134: sp_control=16'h0535;
8'd135: sp_control=16'h0643;
8'd136: sp_control=16'h0735;
8'd137: sp_control=16'h0834;
8'd138: sp_control=16'h0926;
8'd139: sp_control=16'h0a17;
8'd140: sp_control=16'h0b26;
8'd141: sp_control=16'h0c08;
8'd142: sp_control=16'h0d08;
8'd143: sp_control=16'h0e05;
8'd144: sp_control=16'h0f05;
8'd145: sp_control=16'h8026;
8'd146: sp_control=16'h0108;
8'd147: sp_control=16'h0216;
8'd148: sp_control=16'h0326;
8'd149: sp_control=16'h0416;
8'd150: sp_control=16'h0526;
8'd151: sp_control=16'h0616;
8'd152: sp_control=16'h0726;
8'd153: sp_control=16'h0816;
8'd154: sp_control=16'h0917;
8'd155: sp_control=16'h0a08;
8'd156: sp_control=16'h0b08;
8'd157: sp_control=16'h0c08;
8'd158: sp_control=16'h0d08;
8'd159: sp_control=16'h0e05;
8'd160: sp_control=16'h0f05;
8'd161: sp_control=16'h4000;
8'd162: sp_control=16'h0026;
8'd163: sp_control=16'h0108;
8'd164: sp_control=16'h2335;
8'd165: sp_control=16'h2535;
8'd166: sp_control=16'h2735;
8'd167: sp_control=16'h0e05;
8'd168: sp_control=16'h0f05;
8'd169: sp_control=16'h4000;
8'd170: sp_control=16'h0026;
8'd171: sp_control=16'h0108;
8'd172: sp_control=16'h2326;
8'd173: sp_control=16'h2526;
8'd174: sp_control=16'h2726;
8'd175: sp_control=16'h0e05;
8'd176: sp_control=16'h0f05;
default: sp_control=16'h0;
endcase end
endfunction
function [7:0] sp_index(input [6:0] address);
begin case(address)
7'd0: sp_index=8'hff;
7'd1: sp_index=8'hff;
7'd2: sp_index=8'hff;
7'd3: sp_index=8'hff;
7'd4: sp_index=8'hff;
7'd5: sp_index=8'hff;
7'd6: sp_index=8'hff;
7'd7: sp_index=8'hff;
7'd8: sp_index=8'hff;
7'd9: sp_index=8'hff;
7'd10: sp_index=8'hff;
7'd11: sp_index=8'hff;
7'd12: sp_index=8'hff;
7'd13: sp_index=8'hff;
7'd14: sp_index=8'hff;
7'd15: sp_index=8'hff;
7'd16: sp_index=8'h11;
7'd17: sp_index=8'h16;
7'd18: sp_index=8'h11;
7'd19: sp_index=8'h18;
7'd20: sp_index=8'h19;
7'd21: sp_index=8'h1e;
7'd22: sp_index=8'h19;
7'd23: sp_index=8'h20;
7'd24: sp_index=8'h53;
7'd25: sp_index=8'h5e;
7'd26: sp_index=8'h81;
7'd27: sp_index=8'h8e;
7'd28: sp_index=8'h61;
7'd29: sp_index=8'h6c;
7'd30: sp_index=8'h91;
7'd31: sp_index=8'h9e;
7'd32: sp_index=8'h53;
7'd33: sp_index=8'h60;
7'd34: sp_index=8'h81;
7'd35: sp_index=8'h90;
7'd36: sp_index=8'h61;
7'd37: sp_index=8'h6e;
7'd38: sp_index=8'h91;
7'd39: sp_index=8'ha0;
7'd40: sp_index=8'h49;
7'd41: sp_index=8'h4d;
7'd42: sp_index=8'h4a;
7'd43: sp_index=8'h4d;
7'd44: sp_index=8'h4e;
7'd45: sp_index=8'h52;
7'd46: sp_index=8'h4f;
7'd47: sp_index=8'h52;
7'd48: sp_index=8'h21;
7'd49: sp_index=8'h24;
7'd50: sp_index=8'h22;
7'd51: sp_index=8'h25;
7'd52: sp_index=8'h26;
7'd53: sp_index=8'h29;
7'd54: sp_index=8'h27;
7'd55: sp_index=8'h2a;
7'd56: sp_index=8'h7f;
7'd57: sp_index=8'h80;
7'd58: sp_index=8'h7f;
7'd59: sp_index=8'h80;
7'd60: sp_index=8'h7f;
7'd61: sp_index=8'h80;
7'd62: sp_index=8'h7f;
7'd63: sp_index=8'h80;
7'd64: sp_index=8'h01;
7'd65: sp_index=8'h0e;
7'd66: sp_index=8'h01;
7'd67: sp_index=8'h10;
7'd68: sp_index=8'h01;
7'd69: sp_index=8'h0e;
7'd70: sp_index=8'h01;
7'd71: sp_index=8'h10;
7'd72: sp_index=8'h2d;
7'd73: sp_index=8'h38;
7'd74: sp_index=8'h2d;
7'd75: sp_index=8'h3a;
7'd76: sp_index=8'h3b;
7'd77: sp_index=8'h46;
7'd78: sp_index=8'h3b;
7'd79: sp_index=8'h48;
7'd80: sp_index=8'ha1;
7'd81: sp_index=8'ha6;
7'd82: sp_index=8'ha2;
7'd83: sp_index=8'ha6;
7'd84: sp_index=8'ha9;
7'd85: sp_index=8'hae;
7'd86: sp_index=8'haa;
7'd87: sp_index=8'hae;
7'd88: sp_index=8'h6f;
7'd89: sp_index=8'h74;
7'd90: sp_index=8'h6f;
7'd91: sp_index=8'h76;
7'd92: sp_index=8'h77;
7'd93: sp_index=8'h7c;
7'd94: sp_index=8'h77;
7'd95: sp_index=8'h7e;
7'd96: sp_index=8'ha1;
7'd97: sp_index=8'ha8;
7'd98: sp_index=8'ha2;
7'd99: sp_index=8'ha8;
7'd100: sp_index=8'ha9;
7'd101: sp_index=8'hb0;
7'd102: sp_index=8'haa;
7'd103: sp_index=8'hb0;
7'd104: sp_index=8'hff;
7'd105: sp_index=8'hff;
7'd106: sp_index=8'hff;
7'd107: sp_index=8'hff;
7'd108: sp_index=8'hff;
7'd109: sp_index=8'hff;
7'd110: sp_index=8'hff;
7'd111: sp_index=8'hff;
7'd112: sp_index=8'hff;
7'd113: sp_index=8'hff;
7'd114: sp_index=8'hff;
7'd115: sp_index=8'hff;
7'd116: sp_index=8'hff;
7'd117: sp_index=8'hff;
7'd118: sp_index=8'hff;
7'd119: sp_index=8'hff;
7'd120: sp_index=8'h00;
7'd121: sp_index=8'h00;
7'd122: sp_index=8'h00;
7'd123: sp_index=8'h00;
7'd124: sp_index=8'h00;
7'd125: sp_index=8'h00;
7'd126: sp_index=8'h00;
7'd127: sp_index=8'h00;
default: sp_index=8'hff;
endcase end
endfunction
function [8:0] sp_quant(input [6:0] address);
begin case(address)
7'd0: sp_quant=9'h000;
7'd1: sp_quant=9'h009;
7'd2: sp_quant=9'h011;
7'd3: sp_quant=9'h019;
7'd4: sp_quant=9'h021;
7'd5: sp_quant=9'h029;
7'd6: sp_quant=9'h031;
7'd7: sp_quant=9'h039;
7'd8: sp_quant=9'h041;
7'd9: sp_quant=9'h049;
7'd10: sp_quant=9'h051;
7'd11: sp_quant=9'h059;
7'd12: sp_quant=9'h061;
7'd13: sp_quant=9'h069;
7'd14: sp_quant=9'h071;
7'd15: sp_quant=9'h079;
7'd16: sp_quant=9'h081;
7'd17: sp_quant=9'h089;
7'd18: sp_quant=9'h091;
7'd19: sp_quant=9'h099;
7'd20: sp_quant=9'h0a1;
7'd21: sp_quant=9'h0a9;
7'd22: sp_quant=9'h0b1;
7'd23: sp_quant=9'h0b9;
7'd24: sp_quant=9'h0c1;
7'd25: sp_quant=9'h0c9;
7'd26: sp_quant=9'h0d1;
7'd27: sp_quant=9'h0d9;
7'd28: sp_quant=9'h0e1;
7'd29: sp_quant=9'h0e9;
7'd30: sp_quant=9'h0f1;
7'd31: sp_quant=9'h0f9;
7'd32: sp_quant=9'h101;
7'd33: sp_quant=9'h109;
7'd34: sp_quant=9'h111;
7'd35: sp_quant=9'h119;
7'd36: sp_quant=9'h121;
7'd37: sp_quant=9'h129;
7'd38: sp_quant=9'h12d;
7'd39: sp_quant=9'h131;
7'd40: sp_quant=9'h135;
7'd41: sp_quant=9'h139;
7'd42: sp_quant=9'h13d;
7'd43: sp_quant=9'h141;
7'd44: sp_quant=9'h145;
7'd45: sp_quant=9'h149;
7'd46: sp_quant=9'h14d;
7'd47: sp_quant=9'h151;
7'd48: sp_quant=9'h155;
7'd49: sp_quant=9'h159;
7'd50: sp_quant=9'h15d;
7'd51: sp_quant=9'h161;
7'd52: sp_quant=9'h165;
7'd53: sp_quant=9'h169;
7'd54: sp_quant=9'h16d;
7'd55: sp_quant=9'h171;
7'd56: sp_quant=9'h175;
7'd57: sp_quant=9'h179;
7'd58: sp_quant=9'h17d;
7'd59: sp_quant=9'h181;
7'd60: sp_quant=9'h185;
7'd61: sp_quant=9'h189;
7'd62: sp_quant=9'h18d;
7'd63: sp_quant=9'h191;
7'd64: sp_quant=9'h195;
7'd65: sp_quant=9'h199;
7'd66: sp_quant=9'h19d;
7'd67: sp_quant=9'h1a1;
7'd68: sp_quant=9'h1a5;
7'd69: sp_quant=9'h1a9;
7'd70: sp_quant=9'h1ab;
7'd71: sp_quant=9'h1ad;
7'd72: sp_quant=9'h1af;
7'd73: sp_quant=9'h1b1;
7'd74: sp_quant=9'h1b3;
7'd75: sp_quant=9'h1b5;
7'd76: sp_quant=9'h1b7;
7'd77: sp_quant=9'h1b9;
7'd78: sp_quant=9'h1bb;
7'd79: sp_quant=9'h1bd;
7'd80: sp_quant=9'h1bf;
7'd81: sp_quant=9'h1c1;
7'd82: sp_quant=9'h1c3;
7'd83: sp_quant=9'h1c5;
7'd84: sp_quant=9'h1c7;
7'd85: sp_quant=9'h1c9;
7'd86: sp_quant=9'h1cb;
7'd87: sp_quant=9'h1cd;
7'd88: sp_quant=9'h1cf;
7'd89: sp_quant=9'h1d1;
7'd90: sp_quant=9'h1d3;
7'd91: sp_quant=9'h1d5;
7'd92: sp_quant=9'h1d7;
7'd93: sp_quant=9'h1d9;
7'd94: sp_quant=9'h1db;
7'd95: sp_quant=9'h1dd;
7'd96: sp_quant=9'h1df;
7'd97: sp_quant=9'h1e1;
7'd98: sp_quant=9'h1e2;
7'd99: sp_quant=9'h1e3;
7'd100: sp_quant=9'h1e4;
7'd101: sp_quant=9'h1e5;
7'd102: sp_quant=9'h1e6;
7'd103: sp_quant=9'h1e7;
7'd104: sp_quant=9'h1e8;
7'd105: sp_quant=9'h1e9;
7'd106: sp_quant=9'h1ea;
7'd107: sp_quant=9'h1eb;
7'd108: sp_quant=9'h1ec;
7'd109: sp_quant=9'h1ed;
7'd110: sp_quant=9'h1ee;
7'd111: sp_quant=9'h1ef;
7'd112: sp_quant=9'h1f0;
7'd113: sp_quant=9'h1f1;
7'd114: sp_quant=9'h1f2;
7'd115: sp_quant=9'h1f3;
7'd116: sp_quant=9'h1f4;
7'd117: sp_quant=9'h1f5;
7'd118: sp_quant=9'h1f6;
7'd119: sp_quant=9'h1f7;
7'd120: sp_quant=9'h1f8;
7'd121: sp_quant=9'h1f9;
7'd122: sp_quant=9'h1fa;
7'd123: sp_quant=9'h1fb;
7'd124: sp_quant=9'h1fc;
7'd125: sp_quant=9'h1fd;
7'd126: sp_quant=9'h1fe;
7'd127: sp_quant=9'h1ff;
default: sp_quant=9'h0;
endcase end
endfunction
+60
View File
@@ -0,0 +1,60 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Volatile-ROM PIC7040 controller. VCCPlus/MAME/TI provenance: LICENSE/docs.
// No user firmware embedded. All external signals synchronous to clk.
// icount_tick must pulse once per phi (PIC input clock /2); no clock is gated.
module ssc_tms7000(input wire clk,reset,controller_reset,icount_tick,
input wire rom_begin,rom_write,input wire [11:0] rom_address,input wire [7:0] rom_data,
output wire rom_loaded,load_error,initialized,overrun,
output wire [15:0] debug_pc,output wire [31:0] illegal_count,
input wire irq1,irq3,timer_external,
output wire gpio_request,gpio_write,output wire [1:0] gpio_port,
output wire [7:0] gpio_write_data,input wire gpio_ready,input wire [7:0] gpio_read_data);
wire memory_initialized,io_initialized,engine_initialized,engine_done,irq_valid,irq_ack;
wire [1:0] irq_index;
wire [15:0] pc,mem_address;
wire [7:0] sp,status,mem_data,mem_read_data,pf_address,pf_data,pf_read_data;
wire [31:0] illegal;
wire [6:0] cycles;
wire idle,mem_request,mem_write,mem_peripheral,mem_ready,pf_request,pf_write,pf_ready;
wire step,quiet;
reg pending_reset;
reg [2:0] reset_state;
reg io_restart,engine_restart;
reg [1:0] acknowledged_irq;
localparam [2:0] NORMAL=0,IO_WAIT_LOW=1,IO_WAIT_HIGH=2,CPU_WAIT_LOW=3,CPU_WAIT_HIGH=4;
wire cold_reset=reset||rom_begin||!memory_initialized||!rom_loaded;
wire engine_reset=cold_reset||(!io_initialized && reset_state==NORMAL);
wire run=engine_initialized && io_initialized && !cold_reset && !pending_reset && reset_state==NORMAL;
assign initialized=run && !overrun;
assign debug_pc=pc;assign illegal_count=illegal;
ssc_tms7000_exec engine(clk,engine_reset,engine_restart,step,irq_valid,irq_index,
irq_ack,engine_initialized,engine_done,pc,sp,status,idle,illegal,cycles,
mem_request,mem_write,mem_peripheral,mem_address,mem_data,mem_ready,mem_read_data);
ssc_tms7000_memory memory(clk,reset,rom_begin,rom_write,rom_address,rom_data,
rom_loaded,load_error,memory_initialized,mem_request,mem_write,mem_peripheral,
mem_address,mem_data,mem_ready,mem_read_data,pf_request,pf_write,pf_address,pf_data,pf_ready,pf_read_data);
ssc_tms7000_io peripherals(clk,reset||rom_begin,io_restart,io_initialized,
pf_request,pf_write,pf_address,pf_data,pf_ready,pf_read_data,
icount_tick && !cold_reset && (run||!quiet),irq1,irq3,timer_external,
irq_ack,acknowledged_irq,irq_valid,irq_index,gpio_request,gpio_write,gpio_port,gpio_write_data,gpio_ready,gpio_read_data);
ssc_tms7000_pacer scheduler(clk,cold_reset||!engine_initialized,run,icount_tick,
engine_done,cycles,step,quiet,overrun);
always @(posedge clk)begin
if(reset)acknowledged_irq<=0;else acknowledged_irq<=irq_index;
if(cold_reset)begin pending_reset<=0;reset_state<=NORMAL;io_restart<=0;engine_restart<=0;end
else begin
io_restart<=0;engine_restart<=0;
if(controller_reset)pending_reset<=1;
case(reset_state)
NORMAL:if(pending_reset && quiet)begin pending_reset<=0;io_restart<=1;reset_state<=IO_WAIT_LOW;end
IO_WAIT_LOW:if(!io_initialized)reset_state<=IO_WAIT_HIGH;
IO_WAIT_HIGH:if(io_initialized)begin engine_restart<=1;reset_state<=CPU_WAIT_LOW;end
CPU_WAIT_LOW:if(!engine_initialized)reset_state<=CPU_WAIT_HIGH;
CPU_WAIT_HIGH:if(engine_initialized)reset_state<=NORMAL;
default:reset_state<=NORMAL;
endcase
end
end
endmodule
+52
View File
@@ -0,0 +1,52 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// TMS7000 arithmetic/flags, from VCCPlus a8a84f22/MAME hap, Tim Lindner.
// Decimal/multiply use separate registered datapaths. Carry conventions: LICENSE.
module ssc_tms7000_alu(input wire [5:0] operation,
input wire [15:0] destination, input wire [7:0] source,status,
output reg [15:0] result, output reg [7:0] next_status,
output reg writeback, output reg branch, output reg [5:0] extra_cycles);
`include "ssc_tms7000_defs.vh"
reg [16:0] temp;
reg [8:0] flags_value;
reg set_flags,subtract;
always @* begin
temp=0;flags_value=0;result=0;next_status=status;writeback=1;branch=0;
extra_cycles=0;set_flags=1;subtract=0;
case(operation)
OP_MOV:temp={9'd0,source};
OP_AND:temp={9'd0,(destination[7:0]&source)};
OP_OR:temp={9'd0,(destination[7:0]|source)};
OP_XOR:temp={9'd0,(destination[7:0]^source)};
OP_BTJO,OP_BTJZ:begin
temp={9'd0,((operation==OP_BTJO?destination[7:0]:~destination[7:0])&source)};
writeback=0;branch=(temp!=0);extra_cycles=branch?6'd4:6'd2;
end
OP_ADD:temp={9'd0,destination[7:0]}+{9'd0,source};
OP_ADC:temp={9'd0,destination[7:0]}+{9'd0,source}+{16'd0,status[7]};
OP_SUB,OP_CMP:begin temp={9'd0,destination[7:0]}-{9'd0,source};subtract=1;writeback=(operation!=OP_CMP);end
OP_SBB:begin temp={9'd0,destination[7:0]}-{9'd0,source}-{16'd0,!status[7]};subtract=1;end
// MPY has its own registered datapath in the instruction engine.
OP_DEC:begin temp={9'd0,destination[7:0]}-17'd1;subtract=1;end
OP_INC:temp={9'd0,destination[7:0]}+17'd1;
OP_INV:temp={9'd0,~destination[7:0]};
OP_CLR:temp=0;
OP_XCHB:begin temp={9'd0,source};extra_cycles=1;end
OP_SWAP:begin temp={5'd0,destination[7:0],4'd0}|{13'd0,destination[7:4]};extra_cycles=3;end
OP_RR:temp={1'd0,destination[7:0],destination[0],destination[7:1]};
OP_RRC:temp={1'd0,destination[7:0],status[7],destination[7:1]};
OP_RL:temp={8'd0,destination[7:0],destination[7]};
OP_RLC:temp={8'd0,destination[7:0],status[7]};
OP_DJNZ:begin temp={9'd0,destination[7:0]}-17'd1;branch=(temp[15:0]!=0);extra_cycles=branch?6'd4:6'd2;set_flags=0;end
OP_DECD:begin temp={1'b0,destination}-17'd1;subtract=1;end
default:begin writeback=0;set_flags=0;end
endcase
result=temp[15:0];
flags_value=(operation==OP_MPY || operation==OP_DECD)?temp[16:8]:temp[8:0];
if(set_flags) begin
next_status={flags_value[8],flags_value[7],(flags_value[7:0]==0),status[4:0]};
if(subtract) next_status[7]=!flags_value[8];
end
end
endmodule
+32
View File
@@ -0,0 +1,32 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Two-stage parallel decimal adjust, VCCPlus/MAME TMS7000; see LICENSE.
// No operation-select mux precedes the nibble arithmetic. Both results are
// available two rising edges after stable operands, including invalid BCD.
module ssc_tms7000_bcd(input wire clk,reset,input wire [7:0] destination,source,
input wire carry,output reg [7:0] add_result,sub_result,
output reg add_carry,sub_carry);
reg [7:0] add_base,sub_base;
reg [2:0] add_adjust,sub_adjust;
wire [5:0] high_sum={2'd0,destination[7:4]}+{2'd0,source[7:4]};
wire [5:0] low_sum={2'd0,destination[3:0]}+{2'd0,source[3:0]}+{5'd0,carry};
wire low_borrow={1'b0,destination[3:0]}<({1'b0,source[3:0]}+{4'd0,!carry});
function [7:0] correction(input [2:0] index);
begin case(index) 1:correction=8'h06;3,5:correction=8'h66;4:correction=8'h60;default:correction=0;endcase end
endfunction
always @(posedge clk)begin
if(reset)begin
add_base<=0;sub_base<=0;add_adjust<=0;sub_adjust<=0;
add_result<=0;sub_result<=0;add_carry<=0;sub_carry<=0;
end else begin
add_base<=destination+source+{7'd0,carry};
sub_base<=destination-source-{7'd0,!carry};
add_adjust<={(high_sum>9),(high_sum==9),(low_sum>=10)};
sub_adjust<={(destination[7:4]<source[7:4]),(destination[7:4]==source[7:4]),low_borrow};
add_result<=add_base+correction(add_adjust);
sub_result<=sub_base-correction(sub_adjust);
add_carry<=(add_adjust>2);sub_carry<=(sub_adjust<=2);
end
end
endmodule
+89
View File
@@ -0,0 +1,89 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Full original TMS7000 opcode map. VCCPlus/MAME reference; see LICENSE.
module ssc_tms7000_decode(input wire [7:0] opcode,
output reg [5:0] operation,output reg [4:0] mode,
output reg [5:0] base_cycles);
`include "ssc_tms7000_defs.vh"
reg [5:0] binary_operation,unary_operation;
always @* begin
binary_operation=OP_BAD;unary_operation=OP_BAD;
case(opcode[3:0])
2:binary_operation=OP_MOV;3:binary_operation=OP_AND;4:binary_operation=OP_OR;
5:binary_operation=OP_XOR;6:binary_operation=OP_BTJO;7:binary_operation=OP_BTJZ;
8:binary_operation=OP_ADD;9:binary_operation=OP_ADC;10:binary_operation=OP_SUB;
11:binary_operation=OP_SBB;12:binary_operation=OP_MPY;13:binary_operation=OP_CMP;
14:binary_operation=OP_DAC;15:binary_operation=OP_DSB;
default:binary_operation=OP_BAD;
endcase
case(opcode[3:0])
2:unary_operation=OP_DEC;3:unary_operation=OP_INC;4:unary_operation=OP_INV;
5:unary_operation=OP_CLR;6:unary_operation=OP_XCHB;7:unary_operation=OP_SWAP;
8:unary_operation=OP_PUSH;9:unary_operation=OP_POP;10:unary_operation=OP_DJNZ;
11:unary_operation=OP_DECD;12:unary_operation=OP_RR;13:unary_operation=OP_RRC;
14:unary_operation=OP_RL;15:unary_operation=OP_RLC;
default:unary_operation=OP_BAD;
endcase
operation=OP_BAD;mode=AM_NONE;base_cycles=5;
if(opcode>=8'h12 && opcode<=8'h7f && opcode[3:0]>=2) begin
operation=binary_operation;
case(opcode[7:4])
1:begin mode=AM_R_A;base_cycles=8;end
2:begin mode=AM_I_A;base_cycles=7;end
3:begin mode=AM_R_B;base_cycles=8;end
4:begin mode=AM_R_R;base_cycles=10;end
5:begin mode=AM_I_B;base_cycles=7;end
6:begin mode=AM_B_A;base_cycles=5;end
7:begin mode=AM_I_R;base_cycles=9;end
default:begin mode=AM_NONE;operation=OP_BAD;end
endcase
end else if(opcode>=8'hb0 && opcode<=8'hdf) begin
operation=unary_operation;
mode=(opcode[7:4]==11)?AM_A:(opcode[7:4]==12)?AM_B:AM_R;
base_cycles=(mode==AM_R)?6'd7:6'd5;
case(opcode[3:0])
0:begin operation=OP_MOV;mode=(opcode[7:4]==11)?AM_A_A:(opcode[7:4]==12)?AM_A_B:AM_A_R;base_cycles=(mode==AM_A_R)?6'd8:6'd6;end
1:begin operation=OP_MOV;mode=(opcode[7:4]==11)?AM_B_A:(opcode[7:4]==12)?AM_B_B:AM_B_R;base_cycles=(mode==AM_B_A)?6'd5:(mode==AM_B_R)?6'd7:6'd6;end
8,9:base_cycles=(mode==AM_R)?6'd8:6'd6;
11:base_cycles=(mode==AM_R)?6'd11:6'd9;
default:begin end
endcase
end else if(opcode>=8'he8) begin operation=OP_TRAP;base_cycles=14;end
else if(opcode>=8'he0) begin operation=OP_JUMP;base_cycles=3;end
else case(opcode)
8'h00:operation=OP_NOP;
8'h01:begin operation=OP_IDLE;base_cycles=6;end
8'h05:operation=OP_EINT;
8'h06:operation=OP_DINT;
8'h07:operation=OP_SETC;
8'h08:begin operation=OP_POPST;base_cycles=6;end
8'h09:begin operation=OP_STSP;base_cycles=6;end
8'h0a:begin operation=OP_RETS;base_cycles=7;end
8'h0b:begin operation=OP_RETI;base_cycles=9;end
8'h0d:operation=OP_LDSP;
8'h0e:begin operation=OP_PUSHST;base_cycles=6;end
8'h80:begin operation=OP_MOV;mode=AM_P_A;base_cycles=9;end
8'h91:begin operation=OP_MOV;mode=AM_P_B;base_cycles=8;end
default:begin
if(opcode[7:4]>=8 && opcode[7:4]<=10) begin
if(opcode[3:0]>=2 && opcode[3:0]<=7) begin
operation=binary_operation;mode=(opcode[7:4]==8)?AM_A_P:(opcode[7:4]==9)?AM_B_P:AM_I_P;
base_cycles=(opcode[7:4]==8)?6'd10:(opcode[7:4]==9)?6'd9:6'd11;
end else begin
mode=(opcode[7:4]==8)?AM_DIR:(opcode[7:4]==9)?AM_IND:AM_INX;
case(opcode[3:0])
8:begin operation=OP_MOVD;base_cycles=(mode==AM_DIR)?6'd15:(mode==AM_IND)?6'd14:6'd17;end
10:begin operation=OP_LDA;base_cycles=(mode==AM_DIR)?6'd11:(mode==AM_IND)?6'd10:6'd13;end
11:begin operation=OP_STA;base_cycles=(mode==AM_DIR)?6'd11:(mode==AM_IND)?6'd10:6'd13;end
12:begin operation=OP_BR;base_cycles=(mode==AM_DIR)?6'd10:(mode==AM_IND)?6'd9:6'd12;end
13:begin operation=OP_CMPA;base_cycles=(mode==AM_DIR)?6'd12:(mode==AM_IND)?6'd11:6'd14;end
14:begin operation=OP_CALL;base_cycles=(mode==AM_DIR)?6'd14:(mode==AM_IND)?6'd13:6'd16;end
default:mode=AM_NONE;
endcase
end
end
end
endcase
end
endmodule
+19
View File
@@ -0,0 +1,19 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Local instruction/micro-operation identifiers, not chip opcode encodings.
// Behavioral port of VCCPlus/MAME TMS7000; notices in LICENSE.
localparam [5:0] OP_BAD=0, OP_MOV=1, OP_AND=2, OP_OR=3, OP_XOR=4,
OP_BTJO=5, OP_BTJZ=6, OP_ADD=7, OP_ADC=8, OP_SUB=9, OP_SBB=10,
OP_MPY=11, OP_CMP=12, OP_DAC=13, OP_DSB=14, OP_DEC=15, OP_INC=16,
OP_INV=17, OP_CLR=18, OP_XCHB=19, OP_SWAP=20, OP_RR=21, OP_RRC=22,
OP_RL=23, OP_RLC=24, OP_DJNZ=25, OP_DECD=26, OP_PUSH=27, OP_POP=28,
OP_NOP=29, OP_IDLE=30, OP_EINT=31, OP_DINT=32, OP_SETC=33,
OP_POPST=34, OP_STSP=35, OP_RETS=36, OP_RETI=37, OP_LDSP=38,
OP_PUSHST=39, OP_JUMP=40, OP_TRAP=41, OP_LDA=42, OP_STA=43,
OP_BR=44, OP_CALL=45, OP_MOVD=46, OP_CMPA=47;
localparam [4:0] AM_NONE=0, AM_R_A=1, AM_I_A=2, AM_R_B=3, AM_R_R=4,
AM_I_B=5, AM_B_A=6, AM_I_R=7, AM_P_A=8, AM_A_P=9, AM_P_B=10,
AM_B_P=11, AM_I_P=12, AM_A=13, AM_B=14, AM_R=15,
AM_A_A=16, AM_A_B=17, AM_B_B=18, AM_A_R=19, AM_B_R=20,
AM_DIR=21, AM_IND=22, AM_INX=23;
+285
View File
@@ -0,0 +1,285 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// TMS7000 instruction engine, behavioral port of VCCPlus a8a84f22 / MAME.
// Copyright/provenance: hap, Tim Lindner; original notices in LICENSE.
// All state uses clk. One step executes one instruction OR interrupt entry.
// cycles reports architectural icount (/2 input clock), NOT fabric clocks.
// The future scheduler must pace steps/timer ticks; no chip clock is generated.
// External memory supplies RF, peripheral file and ROM with a held-request bus.
// Reset does the CPU reset TRAP; GPIO reset callbacks belong to the wrapper.
module ssc_tms7000_exec(input wire clk,reset,restart,step,
input wire irq_valid,input wire [1:0] irq_index,
output reg irq_ack,output reg initialized,done,
output reg [15:0] pc,output reg [7:0] sp,status,
output reg idle,output reg [31:0] illegal_count,output reg [6:0] cycles,
output reg mem_request,mem_write,mem_peripheral,output reg [15:0] mem_address,
output reg [7:0] mem_write_data,input wire mem_ready,input wire [7:0] mem_read_data);
`include "ssc_tms7000_defs.vh"
localparam [6:0] RESET_START=0,WAIT_STEP=1,FETCHED=2,DECODE=3,
SRC_INDEX=4,SRC_VALUE=5,DEST_START=6,DEST_INDEX=7,DEST_VALUE=8,ALU=9,
UNARY_START=10,UNARY_INDEX=11,PAIR_HIGH=12,PAIR_LOW=13,XCH_VALUE=14,
WRITE_RESULT=15,WRITE_PAIR_LOW=16,BRANCH_START=17,BRANCH_VALUE=18,
ADDRESS_START=19,ADDRESS_HIGH=20,ADDRESS_LOW=21,POINTER_INDEX=22,
POINTER_HIGH=23,POINTER_LOW=24,INDEX_VALUE=25,ADDRESS_READY=26,
MOVD_INDEX=27,LOAD_VALUE=28,STORE_VALUE=29,CMP_VALUE=30,
PUSH_HIGH=31,PUSH_LOW=32,AFTER_PUSH=33,VECTOR_HIGH=34,VECTOR_LOW=35,
POP_VALUE=36,RETURN_LOW=37,RETURN_HIGH=38,RETURN_STATUS=39,
LDSP_VALUE=40,FINISH=41,WAIT_RELEASE=42,BUS_WAIT=43,BUS_RELEASE=44,
IRQ_PUSH_PC=45,ALU_COMMIT=46,MULTIPLY_COMMIT=47,DECIMAL_WAIT=48,DECIMAL_COMMIT=49,
DISPATCH=50;
reg [6:0] state,return_state;
reg [7:0] opcode,value,source_value,destination_value,high_byte,low_byte;
reg [5:0] operation;
reg [4:0] mode;
reg [15:0] destination_address,effective_address,pair_value,return_pc,vector_address;
reg [7:0] pointer_index;
reg branch_taken,is_reset,is_interrupt,destination_peripheral;
reg [15:0] product,saved_result;
reg [7:0] saved_status;
reg saved_write,saved_branch;
reg [5:0] saved_extra;
wire [5:0] decoded_operation,decoded_cycles;
wire [4:0] decoded_mode;
ssc_tms7000_decode decoder(opcode,decoded_operation,decoded_mode,decoded_cycles);
wire [15:0] alu_result;
wire [7:0] alu_status;
wire alu_write,alu_branch;
wire [5:0] alu_extra;
wire [7:0] decimal_add,decimal_sub;
wire decimal_add_carry,decimal_sub_carry;
wire [7:0] decimal_result=(operation==OP_DAC)?decimal_add:decimal_sub;
ssc_tms7000_bcd decimal_unit(clk,reset,destination_value,source_value,status[7],
decimal_add,decimal_sub,decimal_add_carry,decimal_sub_carry);
ssc_tms7000_alu arithmetic(operation,
(operation==OP_DECD)?pair_value:{8'd0,destination_value},source_value,status,
alu_result,alu_status,alu_write,alu_branch,alu_extra);
task read_memory(input [15:0] address,input [6:0] continuation);
begin mem_request<=1;mem_write<=0;mem_peripheral<=0;mem_address<=address;mem_write_data<=0;
return_state<=continuation;state<=BUS_WAIT;end
endtask
task write_memory(input [15:0] address,input [7:0] data,input [6:0] continuation);
begin mem_request<=1;mem_write<=1;mem_peripheral<=0;mem_address<=address;mem_write_data<=data;
return_state<=continuation;state<=BUS_WAIT;end
endtask
task immediate(input [6:0] continuation);
begin read_memory(pc,continuation);pc<=pc+16'd1;end
endtask
function [15:0] previous_register(input [15:0] address);
begin previous_register={8'd0,(address[7:0]-8'd1)};end
endfunction
always @(posedge clk) begin
if(reset) begin
state<=RESET_START;return_state<=WAIT_STEP;mem_request<=0;mem_write<=0;mem_peripheral<=0;
mem_address<=0;mem_write_data<=0;initialized<=0;done<=0;irq_ack<=0;
pc<=0;sp<=8'hff;status<=0;idle<=0;illegal_count<=0;cycles<=0;
opcode<=0;value<=0;source_value<=0;destination_value<=0;high_byte<=0;low_byte<=0;
operation<=OP_BAD;mode<=AM_NONE;destination_address<=0;effective_address<=0;
pair_value<=0;return_pc<=0;vector_address<=0;pointer_index<=0;
branch_taken<=0;is_reset<=1;is_interrupt<=0;destination_peripheral<=0;
product<=0;saved_result<=0;saved_status<=0;saved_write<=0;saved_branch<=0;saved_extra<=0;
end else begin
irq_ack<=0;
// No operation-dependent operand mux before the physical multiplier.
product<=destination_value*source_value;
case(state)
RESET_START:begin
initialized<=0;done<=0;
return_pc<=pc+{15'd0,idle};sp<=8'hff;status<=0;idle<=0;
opcode<=8'hff;vector_address<=16'hfffe;is_reset<=1;is_interrupt<=0;
cycles<=17;state<=PUSH_HIGH;
end
WAIT_STEP:begin
done<=0;
if(restart) state<=RESET_START;
else if(step) begin
is_reset<=0;is_interrupt<=0;
if(irq_valid && status[4] && irq_index<3) begin
irq_ack<=1;is_interrupt<=1;cycles<=idle?7'd17:7'd19;
vector_address<=16'hfffc-{13'd0,irq_index,1'b0};
return_pc<=pc+{15'd0,idle};idle<=0;
sp<=sp+8'd1;write_memory({8'd0,(sp+8'd1)},status,IRQ_PUSH_PC);status<=0;
end else immediate(FETCHED);
end
end
FETCHED:begin opcode<=value;state<=DECODE;end
DECODE:begin
operation<=decoded_operation;mode<=decoded_mode;cycles<={1'b0,decoded_cycles};
branch_taken<=0;destination_peripheral<=0;
state<=DISPATCH;
end
DISPATCH:begin
case(mode)
AM_R_A,AM_R_B,AM_R_R,AM_P_A,AM_P_B:immediate(SRC_INDEX);
AM_I_A,AM_I_B,AM_I_R,AM_I_P:immediate(SRC_VALUE);
AM_A_A,AM_A_B,AM_A_R,AM_A_P:read_memory(0,SRC_VALUE);
AM_B_A,AM_B_B,AM_B_R,AM_B_P:read_memory(1,SRC_VALUE);
AM_A,AM_B,AM_R:state<=UNARY_START;
AM_DIR,AM_IND,AM_INX:state<=ADDRESS_START;
default:case(operation)
OP_BAD:begin illegal_count<=illegal_count+1'b1;state<=FINISH;end
OP_NOP:state<=FINISH;
OP_IDLE:begin pc<=pc-16'd1;idle<=1;state<=FINISH;end
OP_EINT:begin status<=status|8'hf0;state<=FINISH;end
OP_DINT:begin status<=status&8'h0f;state<=FINISH;end
OP_SETC:begin status<=(status&8'hbf)|8'ha0;state<=FINISH;end
OP_STSP:write_memory(1,sp,FINISH);
OP_LDSP:read_memory(1,LDSP_VALUE);
OP_PUSHST:begin sp<=sp+8'd1;write_memory({8'd0,(sp+8'd1)},status,FINISH);end
OP_POPST:begin read_memory({8'd0,sp},RETURN_STATUS);sp<=sp-8'd1;end
OP_RETS,OP_RETI:begin read_memory({8'd0,sp},RETURN_LOW);sp<=sp-8'd1;end
OP_TRAP:begin
return_pc<=pc;vector_address<={8'hff,opcode[6:0],1'b0};state<=PUSH_HIGH;
end
OP_JUMP:begin
case(opcode[2:0])
0:branch_taken<=1;1:branch_taken<=status[6];2:branch_taken<=status[5];3:branch_taken<=status[7];
4:branch_taken<=!(status[5]||status[6]);5:branch_taken<=!status[6];6:branch_taken<=!status[5];7:branch_taken<=!status[7];
endcase
state<=BRANCH_START;
end
default:state<=FINISH;
endcase
endcase
end
SRC_INDEX:begin
read_memory((mode==AM_P_A||mode==AM_P_B)?{8'h01,value}:{8'd0,value},SRC_VALUE);
mem_peripheral<=(mode==AM_P_A||mode==AM_P_B);
end
SRC_VALUE:begin source_value<=value;state<=DEST_START;end
DEST_START:case(mode)
AM_R_A,AM_I_A,AM_B_A,AM_P_A,AM_A_A:begin destination_address<=0;read_memory(0,DEST_VALUE);end
AM_R_B,AM_I_B,AM_P_B,AM_A_B,AM_B_B:begin destination_address<=1;read_memory(1,DEST_VALUE);end
default:immediate(DEST_INDEX);
endcase
DEST_INDEX:begin
destination_address<=(mode==AM_A_P||mode==AM_B_P||mode==AM_I_P)?{8'h01,value}:{8'd0,value};
destination_peripheral<=(mode==AM_A_P||mode==AM_B_P||mode==AM_I_P);
read_memory((mode==AM_A_P||mode==AM_B_P||mode==AM_I_P)?{8'h01,value}:{8'd0,value},DEST_VALUE);
mem_peripheral<=(mode==AM_A_P||mode==AM_B_P||mode==AM_I_P);
end
DEST_VALUE:begin destination_value<=value;state<=ALU;end
UNARY_START:begin
if(mode==AM_R) immediate(UNARY_INDEX);
else begin destination_address<=(mode==AM_A)?16'd0:16'd1;state<=UNARY_INDEX;value<=(mode==AM_A)?8'd0:8'd1;end
end
UNARY_INDEX:begin
destination_address<={8'd0,value};
if(operation==OP_POP) begin read_memory({8'd0,sp},POP_VALUE);sp<=sp-8'd1;end
else if(operation==OP_DECD) read_memory({8'd0,(value-8'd1)},PAIR_HIGH);
else read_memory({8'd0,value},(operation==OP_PUSH)?STORE_VALUE:DEST_VALUE);
end
PAIR_HIGH:begin high_byte<=value;read_memory(destination_address,PAIR_LOW);end
PAIR_LOW:begin pair_value<={high_byte,value};state<=ALU;end
XCH_VALUE:begin source_value<=value;state<=ALU;end
ALU:begin
if(operation==OP_XCHB && mode!=AM_NONE) begin
mode<=AM_NONE;read_memory(1,XCH_VALUE);
end else if(operation==OP_MPY) state<=MULTIPLY_COMMIT;
else if(operation==OP_DAC||operation==OP_DSB) state<=DECIMAL_WAIT;
else begin
saved_result<=alu_result;saved_status<=alu_status;saved_write<=alu_write;
saved_branch<=alu_branch;saved_extra<=alu_extra;state<=ALU_COMMIT;
end
end
MULTIPLY_COMMIT:begin
status<={1'b0,product[15],(product[15:8]==0),status[4:0]};
pair_value<=product;cycles<=cycles+7'd39;destination_address<=1;
write_memory(0,product[15:8],WRITE_PAIR_LOW);
end
DECIMAL_WAIT:state<=DECIMAL_COMMIT;
DECIMAL_COMMIT:begin
status<={((operation==OP_DAC)?decimal_add_carry:decimal_sub_carry),
decimal_result[7],(decimal_result==0),status[4:0]};
cycles<=cycles+7'd2;
write_memory(destination_address,decimal_result,FINISH);mem_peripheral<=destination_peripheral;
end
ALU_COMMIT:begin
status<=saved_status;pair_value<=saved_result;branch_taken<=saved_branch;
cycles<=cycles+{1'b0,saved_extra};
if(operation==OP_DECD) write_memory(previous_register(destination_address),saved_result[15:8],WRITE_PAIR_LOW);
else if(operation==OP_XCHB) write_memory(1,destination_value,WRITE_RESULT);
// DJNZ consumes displacement BEFORE writing its decremented operand.
// This matters when PC wraps into RF and the two addresses alias.
else if(operation==OP_DJNZ) state<=BRANCH_START;
else if(saved_write) begin write_memory(destination_address,saved_result[7:0],BRANCH_START);mem_peripheral<=destination_peripheral;end
else state<=BRANCH_START;
end
WRITE_RESULT:begin write_memory(destination_address,pair_value[7:0],BRANCH_START);mem_peripheral<=destination_peripheral;end
WRITE_PAIR_LOW:write_memory(destination_address,pair_value[7:0],BRANCH_START);
BRANCH_START:begin
if(operation==OP_JUMP) begin cycles<=cycles+(branch_taken?7'd4:7'd2);immediate(BRANCH_VALUE);end
else if(operation==OP_BTJO||operation==OP_BTJZ||operation==OP_DJNZ) immediate(BRANCH_VALUE);
else state<=FINISH;
end
BRANCH_VALUE:begin
if(branch_taken) pc<=pc+{{8{value[7]}},value};
if(operation==OP_DJNZ) write_memory(destination_address,pair_value[7:0],FINISH);
else state<=FINISH;
end
ADDRESS_START:begin if(mode==AM_IND) immediate(POINTER_INDEX);else immediate(ADDRESS_HIGH);end
ADDRESS_HIGH:begin high_byte<=value;immediate(ADDRESS_LOW);end
ADDRESS_LOW:begin
effective_address<={high_byte,value};
if(mode==AM_INX) read_memory(1,INDEX_VALUE);else state<=ADDRESS_READY;
end
POINTER_INDEX:begin pointer_index<=value;read_memory({8'd0,(value-8'd1)},POINTER_HIGH);end
POINTER_HIGH:begin high_byte<=value;read_memory({8'd0,pointer_index},POINTER_LOW);end
POINTER_LOW:begin effective_address<={high_byte,value};state<=ADDRESS_READY;end
INDEX_VALUE:begin effective_address<=effective_address+{8'd0,value};state<=ADDRESS_READY;end
ADDRESS_READY:case(operation)
OP_MOVD:immediate(MOVD_INDEX);
OP_LDA:read_memory(effective_address,LOAD_VALUE);
OP_STA:read_memory(0,STORE_VALUE);
OP_CMPA:read_memory(effective_address,CMP_VALUE);
OP_BR:begin pc<=effective_address;state<=FINISH;end
OP_CALL:begin return_pc<=pc;state<=PUSH_HIGH;end
default:state<=FINISH;
endcase
MOVD_INDEX:begin
destination_address<={8'd0,value};pair_value<=effective_address;
status<={1'b0,effective_address[15],(effective_address[15:8]==0),status[4:0]};
write_memory({8'd0,(value-8'd1)},effective_address[15:8],WRITE_PAIR_LOW);
end
LOAD_VALUE:begin
status<={1'b0,value[7],(value==0),status[4:0]};write_memory(0,value,FINISH);
end
STORE_VALUE:begin
status<={1'b0,value[7],(value==0),status[4:0]};
if(operation==OP_PUSH) begin sp<=sp+8'd1;write_memory({8'd0,(sp+8'd1)},value,FINISH);end
else write_memory(effective_address,value,FINISH);
end
CMP_VALUE:begin source_value<=value;operation<=OP_CMP;read_memory(0,DEST_VALUE);end
PUSH_HIGH:begin sp<=sp+8'd1;write_memory({8'd0,(sp+8'd1)},return_pc[15:8],PUSH_LOW);end
PUSH_LOW:begin sp<=sp+8'd1;write_memory({8'd0,(sp+8'd1)},return_pc[7:0],AFTER_PUSH);end
AFTER_PUSH:begin
if(operation==OP_CALL && !is_reset && !is_interrupt) begin pc<=effective_address;state<=FINISH;end
else read_memory(vector_address,VECTOR_HIGH);
end
VECTOR_HIGH:begin high_byte<=value;read_memory(vector_address+16'd1,VECTOR_LOW);end
VECTOR_LOW:begin pc<={high_byte,value};state<=FINISH;end
IRQ_PUSH_PC:state<=PUSH_HIGH;
POP_VALUE:begin
status<={1'b0,value[7],(value==0),status[4:0]};write_memory(destination_address,value,FINISH);
end
RETURN_LOW:begin low_byte<=value;read_memory({8'd0,sp},RETURN_HIGH);sp<=sp-8'd1;end
RETURN_HIGH:begin
pc<={value,low_byte};
if(operation==OP_RETI) begin read_memory({8'd0,sp},RETURN_STATUS);sp<=sp-8'd1;end
else state<=FINISH;
end
RETURN_STATUS:begin status<=value&8'hf0;state<=FINISH;end
LDSP_VALUE:begin sp<=value;state<=FINISH;end
FINISH:begin
if(is_reset) begin initialized<=1;state<=WAIT_STEP;end
else begin done<=1;state<=WAIT_RELEASE;end
end
WAIT_RELEASE:if(!step) begin done<=0;state<=WAIT_STEP;end
BUS_WAIT:if(mem_ready) begin value<=mem_read_data;mem_request<=0;state<=BUS_RELEASE;end
BUS_RELEASE:if(!mem_ready) state<=return_state;
default:state<=RESET_START;
endcase
end
end
endmodule
+132
View File
@@ -0,0 +1,132 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// PIC7040 peripherals. VCCPlus/MAME hap, Tim Lindner; notices in LICENSE.
// TI SPND001A sections 2.2,2.5,2.6 govern DDR updates, latched/level IRQs,
// and immediate automatic timer reload, where the software reference differs.
// icount_tick is one phi clock (PIC input clock /2), NOT one fabric clock.
// GPIO uses captured held requests. Input/high-impedance output bits are zero
// on this digital glue interface; this does not model external pull resistors.
module ssc_tms7000_io(input wire clk,reset,soft_reset,
output reg initialized,
input wire request,write,input wire [7:0] address,write_data,
output reg ready,output reg [7:0] read_data,
input wire icount_tick,irq1,irq3,timer_external,
input wire irq_ack,input wire [1:0] irq_ack_index,
output wire irq_valid,output wire [1:0] irq_index,
output reg gpio_request,gpio_write,output reg [1:0] gpio_port,
output reg [7:0] gpio_write_data,input wire gpio_ready,input wire [7:0] gpio_read_data);
localparam [3:0] RESET_BEGIN=0,RESET_C=1,RESET_D=2,RESET_END=3,IDLE=4,
EXECUTE=5,READ_GPIO=6,COMPLETE=7,WAIT_RELEASE=8,GPIO_WAIT=9,GPIO_RELEASE=10;
reg [3:0] state,continuation;
reg access_write;
reg [7:0] access_address,access_data,gpio_value;
reg [7:0] latch_b,latch_c,latch_d,ddr_c,ddr_d;
reg [2:0] irq_enable,irq_latched;
reg [1:0] mode_bits;
reg previous_irq1,previous_irq3,previous_external;
reg [7:0] timer_data,timer_control,timer_current,timer_capture;
reg [4:0] timer_prescale;
reg [2:0] timer_divider;
reg timer_running;
wire [2:0] flags=irq_latched|{irq3,1'b0,irq1};
wire [2:0] pending=flags&irq_enable;
assign irq_valid=|pending;
assign irq_index=pending[0]?2'd0:pending[1]?2'd1:2'd2;
wire timer_event=timer_running && icount_tick &&
(timer_control[6]?(timer_external && !previous_external):(timer_divider==3'd7));
wire pf_write=state==EXECUTE && access_write;
task gpio(input w,input [1:0] port,input [7:0] data,input [3:0] next);
begin gpio_request<=1;gpio_write<=w;gpio_port<=port;gpio_write_data<=data;
continuation<=next;state<=GPIO_WAIT;end
endtask
always @(posedge clk)begin
if(reset)begin
state<=RESET_BEGIN;continuation<=IDLE;initialized<=0;ready<=0;read_data<=0;
access_write<=0;access_address<=0;access_data<=0;gpio_value<=0;
gpio_request<=0;gpio_write<=0;gpio_port<=0;gpio_write_data<=0;
latch_b<=0;latch_c<=0;latch_d<=0;ddr_c<=0;ddr_d<=0;
irq_enable<=0;irq_latched<=0;mode_bits<=0;previous_irq1<=0;previous_irq3<=0;
previous_external<=0;timer_data<=0;timer_control<=0;timer_current<=0;
timer_capture<=0;timer_prescale<=0;timer_divider<=0;timer_running<=0;
end else begin
previous_irq1<=irq1;previous_irq3<=irq3;
if(icount_tick)previous_external<=timer_external;
if(irq_ack && irq_ack_index<3)irq_latched[irq_ack_index]<=0;
// Pulse latches survive deassertion; active levels remain visible after ack.
// New assertions win over software clears/ack on the same fabric edge.
if(irq1 && !previous_irq1)irq_latched[0]<=1;
if(irq3 && !previous_irq3)begin irq_latched[2]<=1;timer_capture<=timer_current;end
if(initialized && timer_running && icount_tick && !timer_control[6])
timer_divider<=timer_divider+3'd1;
if(initialized && timer_event)begin
if(timer_prescale==0)begin
timer_prescale<=timer_control[4:0];
if(timer_current==0)begin timer_current<=timer_data;irq_latched[1]<=1;end
else timer_current<=timer_current-8'd1;
end else timer_prescale<=timer_prescale-5'd1;
end
case(state)
RESET_BEGIN:begin
initialized<=0;ready<=0;irq_enable<=0;mode_bits<=0;timer_running<=0;
latch_b<=8'hff;latch_c<=8'hff;latch_d<=8'hff;ddr_c<=0;ddr_d<=0;
if(!gpio_ready)gpio(1,1,8'hff,RESET_C);
end
RESET_C:gpio(1,2,0,RESET_D);
RESET_D:gpio(1,3,0,RESET_END);
RESET_END:begin initialized<=1;state<=IDLE;end
IDLE:begin
if(soft_reset)state<=RESET_BEGIN;
else if(request)begin access_write<=write;access_address<=address;
access_data<=write_data;state<=EXECUTE;end
end
EXECUTE:begin
if(access_write)begin
case(access_address)
0:begin
irq_enable<={access_data[4],access_data[2],access_data[0]};mode_bits<=access_data[7:6];
if(access_data[1])irq_latched[0]<=irq1 && !previous_irq1;
if(access_data[3])irq_latched[1]<=initialized && timer_event && timer_prescale==0 && timer_current==0;
if(access_data[5])irq_latched[2]<=irq3 && !previous_irq3;
state<=COMPLETE;
end
2:begin timer_data<=access_data;state<=COMPLETE;end
3:begin
timer_control<=access_data;timer_running<=access_data[7];
if(access_data[7])begin timer_current<=timer_data;timer_prescale<=access_data[4:0];timer_divider<=0;end
state<=COMPLETE;
end
6:begin latch_b<=access_data;gpio(1,1,access_data,COMPLETE);end
8:begin latch_c<=access_data;gpio(1,2,access_data&ddr_c,COMPLETE);end
9:begin ddr_c<=access_data;gpio(1,2,latch_c&access_data,COMPLETE);end
10:begin latch_d<=access_data;gpio(1,3,access_data&ddr_d,COMPLETE);end
11:begin ddr_d<=access_data;gpio(1,3,latch_d&access_data,COMPLETE);end
default:state<=COMPLETE;
endcase
end else case(access_address)
0:begin read_data<={mode_bits,flags[2],irq_enable[2],flags[1],irq_enable[1],flags[0],irq_enable[0]};state<=COMPLETE;end
2:begin read_data<=timer_current;state<=COMPLETE;end
3:begin read_data<=timer_capture;state<=COMPLETE;end
4:gpio(0,0,0,READ_GPIO);
6:begin read_data<=latch_b;state<=COMPLETE;end
8:gpio(0,2,0,READ_GPIO);
9:begin read_data<=ddr_c;state<=COMPLETE;end
10:gpio(0,3,0,READ_GPIO);
11:begin read_data<=ddr_d;state<=COMPLETE;end
default:begin read_data<=0;state<=COMPLETE;end
endcase
end
READ_GPIO:begin
read_data<=(access_address==4)?gpio_value:(access_address==8)?
((gpio_value&~ddr_c)|(latch_c&ddr_c)):((gpio_value&~ddr_d)|(latch_d&ddr_d));
state<=COMPLETE;
end
COMPLETE:begin ready<=1;state<=WAIT_RELEASE;end
WAIT_RELEASE:if(!request)begin ready<=0;state<=IDLE;end
GPIO_WAIT:if(gpio_ready)begin gpio_value<=gpio_read_data;gpio_request<=0;state<=GPIO_RELEASE;end
GPIO_RELEASE:if(!gpio_ready)state<=continuation;
default:state<=RESET_BEGIN;
endcase
end
end
endmodule
+70
View File
@@ -0,0 +1,70 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Single-chip PIC7040 RF/ROM map and peripheral bus adapter. See LICENSE.
// ROM is volatile, sequentially loaded 0..4095 after rom_begin. No ROM bytes
// are built into this source. A malformed load invalidates the image.
module ssc_tms7000_memory(input wire clk,reset,
input wire rom_begin,rom_write,input wire [11:0] rom_address,input wire [7:0] rom_data,
output reg rom_loaded,load_error,output reg initialized,
input wire request,write,peripheral,input wire [15:0] address,input wire [7:0] write_data,
output reg ready,output reg [7:0] read_data,
output reg pf_request,pf_write,output reg [7:0] pf_address,pf_write_data,
input wire pf_ready,input wire [7:0] pf_read_data);
localparam [2:0] IDLE=0,EXECUTE=1,READ_RETURN=2,PF_WAIT=3,PF_RELEASE=4,WAIT_RELEASE=5;
reg [2:0] state;
reg [7:0] rf[0:127],rom[0:4095];
reg [7:0] rf_read,rom_read;
reg [6:0] clear_address;
reg [15:0] access_address;
reg [7:0] access_data;
reg access_write,access_peripheral,loading;
reg [11:0] expected_address;
wire rf_store=initialized && !rom_begin && state==EXECUTE && access_write && access_address<128 && !access_peripheral;
wire rom_store=!reset && !rom_begin && rom_write && loading && !load_error && rom_address==expected_address;
always @(posedge clk)begin
rf_read<=rf[access_address[6:0]];rom_read<=rom[access_address[11:0]];
if(!reset && !initialized)rf[clear_address]<=0;
else if(!reset && rf_store)rf[access_address[6:0]]<=access_data;
if(rom_store)rom[rom_address]<=rom_data;
end
always @(posedge clk)begin
if(reset)begin
initialized<=0;clear_address<=0;state<=IDLE;ready<=0;read_data<=0;
access_address<=0;access_data<=0;access_write<=0;access_peripheral<=0;
pf_request<=0;pf_write<=0;pf_address<=0;pf_write_data<=0;
rom_loaded<=0;load_error<=0;loading<=0;expected_address<=0;
end else begin
if(!initialized)begin
if(clear_address==127)initialized<=1;else clear_address<=clear_address+7'd1;
end
if(rom_begin)begin rom_loaded<=0;load_error<=0;loading<=1;expected_address<=0;end
else if(rom_write)begin
if(!loading || load_error || rom_address!=expected_address)begin rom_loaded<=0;load_error<=1;loading<=0;end
else if(expected_address==4095)begin rom_loaded<=1;loading<=0;end
else expected_address<=expected_address+12'd1;
end
if(rom_begin)begin state<=IDLE;ready<=0;pf_request<=0;end
else case(state)
IDLE:if(initialized && request)begin
access_address<=address;access_data<=write_data;access_write<=write;access_peripheral<=peripheral;
state<=EXECUTE;
end
EXECUTE:begin
if(access_peripheral || (access_address>=16'h100 && access_address<16'h10c))begin
pf_request<=1;pf_write<=access_write;pf_address<=access_address[7:0];pf_write_data<=access_data;state<=PF_WAIT;
end else state<=READ_RETURN;
end
READ_RETURN:begin
read_data<=access_address<128?rf_read:access_address<256?8'h00:
access_address>=16'hf000 ? rom_read:8'hff;
ready<=1;state<=WAIT_RELEASE;
end
PF_WAIT:if(pf_ready)begin read_data<=pf_read_data;pf_request<=0;state<=PF_RELEASE;end
PF_RELEASE:if(!pf_ready)begin ready<=1;state<=WAIT_RELEASE;end
WAIT_RELEASE:if(!request)begin ready<=0;state<=IDLE;end
default:state<=IDLE;
endcase
end
end
endmodule
+43
View File
@@ -0,0 +1,43 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// SPDX-License-Identifier: BSD-3-Clause
// Instruction-boundary scheduler. icount_tick is PIC input clock /2.
// Start-to-start intervals equal reported architectural cycles. An engine or
// peripheral response that misses its deadline sets overrun and stops launches.
// run may fall during a transaction; quiescent follows its completed budget.
module ssc_tms7000_pacer(input wire clk,reset,run,icount_tick,
input wire engine_done,input wire [6:0] engine_cycles,
output reg step,output wire quiescent,output reg overrun);
localparam [1:0] IDLE=0,EXECUTE=1,RELEASE=2,BUDGET=3;
reg [1:0] state;
reg [7:0] elapsed;
reg [6:0] budget;
wire [8:0] next_elapsed={1'b0,elapsed}+{8'd0,icount_tick};
assign quiescent=state==IDLE && !step;
always @(posedge clk)begin
if(reset)begin state<=IDLE;step<=0;overrun<=0;elapsed<=0;budget<=0;end
else begin
if(state!=IDLE && icount_tick && elapsed!=255)elapsed<=elapsed+8'd1;
// A nonresponding bus must be observable even if engine_done never arrives.
// Original instructions take at most49 icount ticks. Do not abort a captured
// bus operation; latch the fault and require reset if it cannot complete.
if(state==EXECUTE && next_elapsed>=9'd127)overrun<=1;
case(state)
IDLE:if(run && icount_tick && !overrun)begin step<=1;elapsed<=0;state<=EXECUTE;end
EXECUTE:if(engine_done)begin
step<=0;budget<=engine_cycles;state<=RELEASE;
if(next_elapsed>={2'd0,engine_cycles})overrun<=1;
end
RELEASE:if(!engine_done)begin
state<=BUDGET;
if(next_elapsed>={2'd0,budget})overrun<=1;
end
BUDGET:if(icount_tick && next_elapsed>={2'd0,budget})begin
if(run && !overrun)begin step<=1;elapsed<=0;state<=EXECUTE;end
else state<=IDLE;
end
default:state<=IDLE;
endcase
end
end
endmodule
+35
View File
@@ -0,0 +1,35 @@
# quartus_sta -t bh_mpi_timing.tcl PROJECT REVISION OUTPUT
package require ::quartus::project
package require ::quartus::sta
set project [file normalize [lindex $quartus(args) 0]]
set revision [lindex $quartus(args) 1]
set output [file normalize [lindex $quartus(args) 2]]
file mkdir $output
cd [file dirname $project]
project_open [file tail $project] -revision $revision
foreach model {slow fast} {
create_timing_netlist -model $model
read_sdc
update_timing_netlist
foreach {scope pattern} {
config {*mpi_configuration|*}
rom {*mpi_program_roms|*}
banks {*rom_banks*}
restart {*mpi_rom_cold_pending*}
} {
set nodes [get_keepers $pattern]
set count [get_collection_size $nodes]
puts "BH_MPI_SCOPE $model $scope $count"
if {$count==0} {error "Missing new MPI state scope: $scope"}
foreach check {setup hold} {
report_timing -$check -to $nodes -npaths 20 -detail full_path \
-file [file join $output ${scope}-to-${model}-${check}.rpt]
report_timing -$check -from $nodes -npaths 20 -detail full_path \
-file [file join $output ${scope}-from-${model}-${check}.rpt]
}
}
report_timing -setup -npaths 30 -detail full_path \
-file [file join $output global-${model}-setup.rpt]
delete_timing_netlist
}
project_close
+15
View File
@@ -0,0 +1,15 @@
"""Coco 3 Plus deployment paths and native MiSTer remembered-file records."""
NAME = 'coco3plus'
GAME_DIR = '/media/fat/games/' + NAME
ROM_SLOTS = {4: 'pic-7040-510.bin', 5: 'sp0256-al2.bin'}
def startup_records():
# Match MiSTer menu.cpp's 1024-byte, NUL-terminated selPath buffer.
records = {}
for slot, name in ROM_SLOTS.items():
path = (GAME_DIR + '/' + name).encode('ascii')
if len(path) >= 1024:
raise ValueError('Startup path does not fit MiSTer selPath')
records[f'config/{NAME}.f{slot}'] = path.ljust(1024, b'\0')
return records
+72
View File
@@ -0,0 +1,72 @@
# Read-only fitted-design audit. Optional last argument is an experimental SDC.
# quartus_sta -t SCRIPT PROJECT REVISION OUTPUT [EXTRA_SDC]
package require ::quartus::project
package require ::quartus::sta
set project [file normalize [lindex $quartus(args) 0]]
set revision [lindex $quartus(args) 1]
set output [file normalize [lindex $quartus(args) 2]]
set extra [lindex $quartus(args) 3]
set mode [lindex $quartus(args) 4]
file mkdir $output
cd [file dirname $project]
project_open [file tail $project] -revision $revision
if {$mode eq "replace-external"} {
# In-memory settings only: retrospective analysis of an identical fitted
# netlist with a corrected constraint guard. Never export these assignments.
set_global_assignment -remove -name SDC_FILE external-io.sdc
set_global_assignment -name SDC_FILE $extra
set f [open [file join $output constraint-override.txt] w]
puts $f $extra
close $f
set extra ""
}
foreach model {slow fast} {
create_timing_netlist -model $model
read_sdc
if {$extra ne ""} {read_sdc $extra}
update_timing_netlist
foreach {name pattern} {
sdram_dq {SDRAM_DQ[*]}
sdram_command {SDRAM_A[*] SDRAM_BA[*] SDRAM_n* SDRAM_DQM*}
hdmi_video {HDMI_TX_D[*] HDMI_TX_DE HDMI_TX_HS HDMI_TX_VS}
hdmi_audio {HDMI_I2S HDMI_LRCLK HDMI_SCLK}
mcp_i2c {IO_SDA IO_SCL}
} {
set ports [get_ports $pattern]
puts "EXTERNAL_IO_SCOPE $model $name [get_collection_size $ports]"
foreach check {setup hold} {
report_timing -$check -from $ports -npaths 32 -detail full_path -file [file join $output ${name}-in-${model}-${check}.rpt]
report_timing -$check -to $ports -npaths 40 -detail full_path -file [file join $output ${name}-out-${model}-${check}.rpt]
}
}
foreach {mode launch latch} {
scaled {pll_hdmi|pll_hdmi_inst|altera_pll_i|cyclonev_pll|counter[0].output_counter|divclk} hdmi_scaled_forward
direct {emu|pll|pll_inst|altera_pll_i|general[1].gpll~PLL_OUTPUT_COUNTER|divclk} hdmi_direct_forward
} {
if {[get_collection_size [get_clocks $latch]] == 1} {
foreach check {setup hold} {
report_timing -$check -from_clock [get_clocks $launch] -to_clock [get_clocks $latch] -to [get_ports {HDMI_TX_D[*] HDMI_TX_DE HDMI_TX_HS HDMI_TX_VS}] -npaths 40 -detail full_path -file [file join $output hdmi-${mode}-${model}-${check}.rpt]
}
}
}
if {[get_collection_size [get_clocks coco_pixel]] == 1} {
foreach check {setup hold} {
report_timing -$check -from_clock [get_clocks coco_pixel] -npaths 40 -detail full_path -file [file join $output pixel-out-${model}-${check}.rpt]
report_timing -$check -to_clock [get_clocks coco_pixel] -npaths 40 -detail full_path -file [file join $output pixel-in-${model}-${check}.rpt]
}
}
foreach check {setup hold recovery removal} {
report_timing -$check -npaths 40 -detail full_path -file [file join $output global-${model}-${check}.rpt]
}
if {$model eq "slow"} {
report_clocks -file [file join $output clocks.rpt]
report_ucp -file [file join $output unconstrained.rpt]
report_exceptions -file [file join $output exceptions.rpt]
report_clock_transfers -setup -file [file join $output transfers.rpt]
set f [open [file join $output clock-nodes.txt] w]
foreach_in_collection n [get_pins -hierarchical {*divclk* *MISTER_COCOVID*PIX_CLK* *sdramclk_ddr*}] {puts $f [get_node_info -name $n]}
close $f
}
delete_timing_netlist
}
project_close -dont_export_assignments
+60
View File
@@ -0,0 +1,60 @@
# quartus_sta -t nmi_timing_paths.tcl PROJECT REVISION OUTPUT_DIRECTORY
package require ::quartus::project
package require ::quartus::sta
set project [lindex $quartus(args) 0]
set revision [lindex $quartus(args) 1]
set output [file normalize [lindex $quartus(args) 2]]
file mkdir $output
project_open $project -revision $revision
foreach model {slow fast} {
create_timing_netlist -model $model
read_sdc
update_timing_netlist
set nmi [get_registers {*GLBCPU09|NMI*}]
if {[get_collection_size $nmi] < 5} {error "Expected complete CPU NMI register scope"}
puts "NMI_REGISTERS $model [get_collection_size $nmi]"
set cpu [get_registers {*GLBCPU09|*}]
foreach check {setup hold} {
report_timing -$check -from $cpu -to $cpu -npaths 5 -detail full_path \
-file [file join $output cpu-internal-${model}-${check}.rpt]
}
# Register-only endpoints would miss the effective mask/pending view.
# Kept combinational nets must also be covered through to CPU consumers.
if {[get_collection_size $nmi] > 5} {
foreach signal {NMIMask NMILatched} {
set through [get_nets *GLBCPU09|$signal]
if {[get_collection_size $through] == 0} {error "Missing kept NMI net $signal"}
puts "NMI_THROUGH $model $signal [get_collection_size $through]"
foreach check {setup hold} {
report_timing -$check -through $through -npaths 20 -detail full_path \
-file [file join $output nmi-through-${signal}-${model}-${check}.rpt]
}
}
}
foreach check {setup hold recovery removal} {
report_timing -$check -to $nmi -npaths 20 -detail full_path \
-file [file join $output nmi-in-${model}-${check}.rpt]
report_timing -$check -from $nmi -npaths 20 -detail full_path \
-file [file join $output nmi-out-${model}-${check}.rpt]
report_timing -$check -npaths 5 -detail full_path \
-file [file join $output global-${model}-${check}.rpt]
}
if {$model eq "slow"} {
set audit [open [file join $output nmi-register-clocks.tsv] w]
puts $audit "register\tclock_pin\tclock_driver"
foreach_in_collection reg $nmi {
foreach edge [get_register_info -clock_edges $reg] {
set pin [get_edge_info -src $edge]
foreach input_edge [get_node_info -clock_edges $pin] {
puts $audit "[get_register_info -name $reg]\t[get_node_info -name $pin]\t[get_node_info -name [get_edge_info -src $input_edge]]"
}
}
}
close $audit
report_clocks -file [file join $output clocks.rpt]
report_ucp -file [file join $output unconstrained.rpt]
report_clock_transfers -file [file join $output clock-transfers.rpt]
}
delete_timing_netlist
}
project_close
+79
View File
@@ -0,0 +1,79 @@
# quartus_sta -t reset_cpu_timing_paths.tcl PROJECT REVISION OUTPUT_DIRECTORY
package require ::quartus::project
package require ::quartus::sta
set project [lindex $quartus(args) 0]
set revision [lindex $quartus(args) 1]
set output [file normalize [lindex $quartus(args) 2]]
file mkdir $output
project_open $project -revision $revision
foreach model {slow fast} {
create_timing_netlist -model $model
read_sdc
update_timing_netlist
set per_clock [file join $output per-clock-${model}-setup.rpt]
set empty [open $per_clock w]
close $empty
foreach_in_collection clock [get_clocks *] {
report_timing -setup -to_clock [get_clocks [list [get_clock_info -name $clock]]] \
-npaths 2 -detail full_path -append -file $per_clock
}
set resets [get_registers {*coco3|RESET_N *coco3|RESET_RAW_N *coco3|CPU_RESET *coco3|reset_*release[*] *coco_fdc|wd_reset_release[*] *coco_sdc_top|wd_reset_release[*]}]
if {[get_collection_size $resets] < 4} {error "Incomplete reset sequencer scope"}
foreach check {setup hold recovery removal} {
report_timing -$check -from $resets -npaths 30 -detail full_path \
-file [file join $output reset-${model}-${check}.rpt]
report_timing -$check -npaths 30 -detail full_path \
-file [file join $output global-${model}-${check}.rpt]
}
set cpu [get_registers {*GLBCPU09|*}]
puts "CPU_REGISTERS $model [get_collection_size $cpu]"
set control [get_registers {*coco3|data_ready* *coco3|hold_data* *coco3|hold* *coco3|end_hold *coco3|cpu_cycle_ena *coco3|clear_data_ready *coco3|sdram_cpu_req *coco3|sdram_cpu_rnw *coco3|sdram_cpu_addr_L[*] *coco3|GART_RD *coco3|GART_WR *coco3|AMW_WR *coco3|RAM0_BE0_L *coco3|RAM0_BE1_L *coco3|sdram_BE_0 *coco3|sdram_BE_1 *coco3|last_write *coco3|CLK[*] *coco3|SWITCH_L[*]}]
set boot [get_registers {*COCO3_EE_Cold_Bt|*}]
set bridge [get_registers {*cpu_memory_boundary|*}]
foreach check {setup hold} {
report_timing -$check -to $cpu -npaths 30 -detail full_path \
-file [file join $output cpu-in-${model}-${check}.rpt]
report_timing -$check -from $cpu -npaths 30 -detail full_path \
-file [file join $output cpu-out-${model}-${check}.rpt]
report_timing -$check -to $control -npaths 30 -detail full_path \
-file [file join $output control-in-${model}-${check}.rpt]
report_timing -$check -from $control -npaths 30 -detail full_path \
-file [file join $output control-out-${model}-${check}.rpt]
report_timing -$check -from $cpu -to $cpu -npaths 30 -detail full_path \
-file [file join $output cpu-all-${model}-${check}.rpt]
if {[info exists cpu_ce]} {
report_timing -$check -from $cpu_ce -to $cpu_ce -npaths 30 -detail full_path \
-file [file join $output cpu-qualified-${model}-${check}.rpt]
}
report_timing -$check -to $boot -npaths 20 -detail full_path \
-file [file join $output boot-${model}-${check}.rpt]
if {[get_collection_size $bridge] > 0} {
report_timing -$check -to $bridge -npaths 20 -detail full_path \
-file [file join $output bridge-in-${model}-${check}.rpt]
report_timing -$check -from $bridge -npaths 20 -detail full_path \
-file [file join $output bridge-out-${model}-${check}.rpt]
}
}
if {$model eq "slow"} {
set f [open [file join $output cpu-clock-audit.tsv] w]
puts $f "register\trole\tclock_pin\tclock_driver"
foreach_in_collection reg $cpu {
set name [get_register_info -name $reg]
regexp {GLBCPU09\|([A-Za-z_][A-Za-z_0-9]*)} $name unused base
set role single-cycle
if {[info exists cpu_ce_bases] && [lsearch -exact $cpu_ce_bases $base] >= 0} {set role qualified-enable}
foreach edge [get_register_info -clock_edges $reg] {
set pin [get_edge_info -src $edge]
foreach input_edge [get_node_info -clock_edges $pin] {
puts $f "$name\t$role\t[get_node_info -name $pin]\t[get_node_info -name [get_edge_info -src $input_edge]]"
}
}
}
close $f
report_clocks -file [file join $output clocks.rpt]
report_ucp -file [file join $output unconstrained.rpt]
report_exceptions -file [file join $output exceptions.rpt]
}
delete_timing_netlist
}
project_close
+15
View File
@@ -0,0 +1,15 @@
import hashlib,zlib
ROM_IDENTITIES = {
'pic-7040-510.bin': (4096, '0013cd78482cc5f2360fdf584e9ba51d34861e8ccd9d88247f1a54039c16c365',
'7c17dcbc21757535ce0b3a9e1ce5ca61319d3606', 'a8e2eb98'),
'sp0256-al2.bin': (2048, '98c280fd082169c54081e503dfe7d7d9a6fd46d4ffcc973e199ea0e1d9bc1ac9',
'e60fcb5fa16ff3f3b69d36c7a6e955744d3feafc', 'b504ac15'),
}
def verified_rom(path, identity):
size, sha256, sha1, crc = identity
data = path.read_bytes()
if len(data) != size or hashlib.sha256(data).hexdigest() != sha256 or hashlib.sha1(data).hexdigest() != sha1 or f'{zlib.crc32(data):08x}' != crc:
raise RuntimeError('Original ROM identity mismatch: ' + path.name)
return {'path': str(path), 'bytes': size, 'sha256': sha256, 'sha1': sha1, 'crc32': crc}
+86
View File
@@ -0,0 +1,86 @@
#!/usr/bin/env python3
"""Run independent MPI and inherited regressions against an isolated source copy.
This does not compile Quartus, qualify timing, install a core, or test hardware.
Each test owns a fresh output folder and its source-hashed evidence.
"""
import argparse
from concurrent.futures import ThreadPoolExecutor, as_completed
import json
from pathlib import Path
import subprocess
import sys
import time
ROOT = Path(__file__).resolve().parents[1]
def main():
p = argparse.ArgumentParser(description=__doc__)
p.add_argument('project', type=Path, nargs='?', default=ROOT)
p.add_argument('--suite', type=Path, required=True)
p.add_argument('--main-reference', type=Path, required=True)
p.add_argument('--output',type=Path,default=ROOT/'build/regressions')
p.add_argument('--jobs', type=int, default=3, choices=range(1, 5))
a = p.parse_args()
project = a.project.resolve()
if project != ROOT and not project.is_relative_to(ROOT / 'build'):
p.error('Use a prepared build/ project')
base = a.output.resolve()
if not base.is_relative_to(ROOT/'build'):p.error('Use an output under build/')
base.mkdir(parents=True)
logs = base / 'regression-logs'
logs.mkdir() # Preserve any earlier run; never overwrite its evidence.
from source_snapshot import original_sources
original=original_sources('coco3-mister')
jobs = [
('test_bh_mpi.py', 'mpi-functional', ['--project', str(project)]),
('test_bh_mpi_core.py', 'mpi-core-functional', [str(project)]),
('test_ssc_mister_system.py', 'ssc-system-functional', [str(project)]),
('test_registered_interfaces.py', 'registered-functional', [str(project)]),
('test_reset_domains.py', 'reset-functional', [str(project)]),
('test_keyboard_control_phase.py', 'keyboard-functional', [str(project)]),
('test_peripheral_phase.py', 'peripheral-functional', [str(project)]),
('test_external_sdram_commands.py', 'commands-functional', [str(project)]),
('test_external_sdram.py', 'delayed-functional', [str(project)]),
('test_external_audio.py', 'audio-functional', [str(project)]),
('test_external_pixel.py', 'pixel-functional', [str(project)]),
('test_external_i2c.py', 'i2c-functional', [str(project)]),
('test_coco3_bh_startup.py', 'startup-functional',
[str(project), str(a.main_reference.resolve())]),
('test_bh_menu.py', 'menu-functional', [str(project), str(a.main_reference.resolve())]),
('test_video_sdram.py', 'video-functional', [str(original),str(project)]),
]
def run(job):
script, name, inputs = job
command = [sys.executable, '-X', 'utf8', '-B', str(ROOT / 'scripts' / script),
*inputs, str(base / name)]
if script not in ('test_coco3_bh_startup.py','test_bh_menu.py'):
command += ['--suite', str(a.suite.resolve())]
if script == 'test_external_sdram.py':
command += ['--check-cpu-data']
started = time.monotonic()
print('START ' + name, flush=True)
with (logs / (name + '.log')).open('w', encoding='utf-8') as log:
result = subprocess.run(command, cwd=ROOT, stdout=log,
stderr=subprocess.STDOUT)
receipt = dict(name=name, command=command, exit_code=result.returncode,
seconds=round(time.monotonic() - started, 2))
print(('PASS ' if result.returncode == 0 else 'FAIL ') + name, flush=True)
return receipt
results = []
with ThreadPoolExecutor(max_workers=a.jobs) as pool:
for future in as_completed([pool.submit(run, job) for job in jobs]):
results.append(future.result())
passed = all(item['exit_code'] == 0 for item in results)
(logs / 'result.json').write_text(json.dumps(dict(
passed=passed, scope='Offline functional regressions; no timing/hardware signoff',
results=sorted(results, key=lambda x: x['name'])), indent=2) + '\n')
if not passed:
raise SystemExit('One or more regressions failed; inspect regression-logs')
if __name__ == '__main__':
main()
+17
View File
@@ -0,0 +1,17 @@
"""Restore original comparison sources from the preserved upstream commit."""
import hashlib,json,subprocess
from pathlib import Path
ROOT=Path(__file__).resolve().parents[1]
SNAPSHOT='8b8cf72d1fb4de1d05345de8d5b92ec2d500fcd2'
def original_sources(name):
if name!='coco3-mister':raise ValueError('This repository supports MiSTer only')
out=ROOT/'build/source-snapshots'/name
entries=subprocess.check_output(['git','ls-tree','-r','-z',SNAPSHOT],cwd=ROOT).split(b'\0')
for entry in filter(None,entries):
header,name=entry.split(b'\t',1);mode,kind,oid=header.decode().split();name=name.decode()
if kind!='blob' or mode not in ('100644','100755'):raise RuntimeError('Unsupported upstream entry')
data=subprocess.check_output(['git','show',SNAPSHOT+':'+name],cwd=ROOT)
path=out/name
if path.exists() and path.read_bytes()!=data:raise RuntimeError('Preserve changed reference cache: '+name)
if not path.exists():path.parent.mkdir(parents=True,exist_ok=True);path.write_bytes(data)
return out
+49
View File
@@ -0,0 +1,49 @@
# quartus_sta -t ssc_integrated_timing.tcl PROJECT REVISION OUTPUT
package require ::quartus::project
package require ::quartus::sta
set project [file normalize [lindex $quartus(args) 0]]
set revision [lindex $quartus(args) 1]
set output [file normalize [lindex $quartus(args) 2]]
file mkdir $output
cd [file dirname $project]
project_open [file tail $project] -revision $revision
foreach model {slow fast} {
create_timing_netlist -model $model
read_sdc
update_timing_netlist
foreach {name pattern minimum} {
cartridge {*coco3|ssc|*} 1200
bridge {*coco3|ssc_bridge|*} 30
controller {*coco3|ssc|controller|*} 400
speech {*coco3|ssc|speech|*} 400
audio {*coco3|ssc|audio|*} 100
ay {*coco3|ssc|ay|*} 100
glue {*coco3|ssc|glue|*} 15
host {*coco3|ssc|host|*} 10
power {*ssc_power_release*} 2
} {
set nodes [get_keepers $pattern]
set count [get_collection_size $nodes]
puts "SSC_INTEGRATED_SCOPE $model $name $count"
if {$count<$minimum} {error "Incomplete SSC scope: $name"}
set audit [open [file join $output keepers-${name}-${model}.txt] w]
foreach_in_collection node $nodes {puts $audit [get_node_info -name $node]}
close $audit
foreach check {setup hold recovery removal} {
# Setup/hold must have substantive paths. Recovery/removal may legitimately
# be empty for synchronous-only chip helpers; preserve both reports.
report_timing -$check -to $nodes -npaths 40 -detail full_path \
-file [file join $output ${name}-in-${model}-${check}.rpt]
report_timing -$check -from $nodes -npaths 40 -detail full_path \
-file [file join $output ${name}-out-${model}-${check}.rpt]
}
}
report_clock_transfers -setup -file [file join $output clock-transfers-${model}.rpt]
if {$model eq "slow"} {
report_clocks -file [file join $output clocks.rpt]
report_ucp -file [file join $output unconstrained.rpt]
report_exceptions -file [file join $output exceptions.rpt]
}
delete_timing_netlist
}
project_close -dont_export_assignments
+161
View File
@@ -0,0 +1,161 @@
#!/usr/bin/env python3
"""Compile pinned Main's real menu prefix/status parsers against Coco 3 Plus rows.
Filesystem/OSD rendering and hardware transport are outside this host test.
"""
import argparse
import json
import os
from pathlib import Path
import re
import subprocess
from test_coco3_bh_startup import block
from validation_common import ROOT, cpp_environment, digest
def main():
p = argparse.ArgumentParser(description=__doc__)
p.add_argument('project', type=Path)
p.add_argument('reference', type=Path)
p.add_argument('output', type=Path)
a = p.parse_args()
out = a.output.resolve()
if out.exists() or not out.is_relative_to(ROOT / 'build'):
p.error('Use a fresh build/ output')
out.mkdir(parents=True)
top = a.project / 'CoCo3.sv'
user = a.reference / 'user_io.cpp'
menu = a.reference / 'menu.cpp'
provenance = json.loads((a.reference / 'provenance.json').read_text())
for source in (user, menu):
assert digest(source) == provenance['files'][source.name]['sha256']
conf = top.read_text().split('localparam CONF_STR = {', 1)[1].split('};', 1)[0]
entries = re.findall(r'"([^"\n]*)"', conf)
rows = [x[:-1] for x in entries if x.endswith(';')][1:]
user_text = user.read_text()
menu_text = menu.read_text()
# Action-side parser has no drawing calls; keep it byte-for-byte as source.
action = menu_text[menu_text.index('//Hide or Disable flag\n'):]
prefix = block(action, "while ((p[0] == 'H'")
page = block(action, "if (p[0] == 'P')")
definitions = '\n'.join(block(user_text, signature) for signature in (
'int user_io_status_bits(', 'uint32_t user_io_status_get(',
'uint32_t user_io_status_mask(', 'uint32_t user_io_hd_mask(',
'void user_io_status_set('))
harness = r'''
#include <cassert>
#include <cstdio>
#include <cstring>
#include <cstdint>
#include <string>
static unsigned char cur_status[16]={};
int user_io_status_bits(const char*,int*,int*,int,int single=0);
bool is_st(){return true;} bool is_minimig(){return false;}
uint32_t minimig_core_extcfg(){return 0;}
void spi_uio_cmd_cont(int){} void spi_w(uint16_t){} void DisableIO(){}
const int UIO_SET_STATUS2=0;
struct Mgl {bool done=true;}; static Mgl instance; static Mgl *mgl=&instance;
'''+definitions+r'''
struct Decoded{bool hidden,disabled,inpage;std::string row;};
Decoded decode(const char *row,int page,uint32_t hdmask){
char buffer[1024];strcpy(buffer,row);char *p=buffer;
int h=0,d=0,inpage=!page,flat=0;
'''+prefix+'\n'+page+r'''
return {bool(h),bool(d),bool(inpage),p};
}
static const char *rows[]={
'''+',\n'.join(json.dumps(row) for row in rows)+r'''};
bool visible(const char *label,int page,uint32_t mask,bool *disabled=nullptr){
for(const char *r:rows){auto d=decode(r,page,mask);
auto comma=d.row.find(',');if(comma==std::string::npos)continue;
if(d.row[0]=='F'||d.row[0]=='S')
comma=d.row.find(',',comma+1);
if(comma==std::string::npos)continue;
std::string tail=d.row.substr(comma+1);
if(tail==label || tail.rfind(std::string(label)+",",0)==0){
if(disabled)*disabled=d.disabled;
return d.inpage&&!d.hidden;
}
}fprintf(stderr,"Missing contract row: %s page=%d mask=%u\n",label,page,mask);
assert(!"Missing contract row");return false;
}
int main(){
unsigned options=0;
// Every exposed option uses the actual Main bit parser and setter. Verify
// all its representable values without changing any unrelated status bit.
for(const char *r:rows){auto d=decode(r,1,0);const char *p=d.row.c_str();
if(*p!='O'&&*p!='o')continue;
int start,end;int ex=*p=='o';int size=user_io_status_bits(p+1,&start,&end,ex,0);
assert(size>0 && end<63); // bit63 is exclusively the RTL migration marker.
char label[128];const char *first=strchr(p,',');assert(first);
const char *last=strchr(first+1,',');assert(last);
size_t length=last-first-1;assert(length<sizeof(label));
memcpy(label,first+1,length);label[length]=0;
if(!strncmp(label,"Slot ",5)){
int slot=label[5]-'1';assert(slot>=0&&slot<4);
assert(start==43+3*slot && end==45+3*slot);
}
if(!strcmp(label,"Startup slot"))assert(start==12&&end==13);
if(!strcmp(label,"Expansion"))assert(start==42&&end==42);
for(unsigned value=0;value<(1u<<size);++value){
memset(cur_status,0xa5,sizeof(cur_status));unsigned char before[16];
memcpy(before,cur_status,16);user_io_status_set(p+1,value,ex);
assert(user_io_status_get(p+1,ex)==value);
for(int bit=0;bit<128;++bit)if(bit<start||bit>end)
assert(((cur_status[bit/8]^before[bit/8])&(1u<<(bit%8)))==0);
}++options;
}
const char *pages[]={"Cartridges & Multi-Pak","Floppy Disks","CoCo SDC",
"Sound & Expansion","Cassette","Machine","Display","Input","Advanced"};
for(unsigned mask=0;mask<65536;++mask){
for(const char *p:pages)assert(visible(p,0,mask));
}
bool disabled=false;
assert(visible("Drive 0",2,0,&disabled)&&!disabled);
assert(visible("Drive 0",2,8,&disabled)&&disabled);
assert(visible("SDC Drive 0",3,2,&disabled)&&disabled);
assert(visible("Expansion",4,1u<<13,&disabled)&&disabled);
assert(!visible("Assign SSC in Multi-Pak",4,0));
assert(visible("Assign SSC in Multi-Pak",4,1u<<13));
assert(visible("Slot 1 ROM",1,0)&&!visible("Slot 1 ROM",1,1u<<8));
assert(visible("Slot 4 ROM",1,0)&&!visible("Slot 4 ROM",1,1u<<11));
assert(!visible("Legacy cartridge",0,1));
assert(!visible("Load SSC controller (4K)",0,16));
assert(!visible("Load SSC voice (2K)",0,16));
assert(visible("Sound & Speech ready",4,0));
assert(!visible("Sound & Speech ready",4,1u<<6));
assert(visible("Sound & Speech error",4,0));
assert(!visible("Sound & Speech error",4,1u<<7));
assert(visible("Orchestra90 stereo enabled",4,0));
assert(!visible("Orchestra90 stereo enabled",4,1u<<15));
for(const char *r:rows){auto d=decode(r,1,0);
if(d.row.rfind("-,",0)==0)assert(d.row.size()-2<=27);
}
// Ordinary page membership survives H/D prefixes; unrelated pages stay out.
assert(!visible("Drive 0",1,0));assert(!visible("Slot 1 ROM",2,0));
printf("PASS native Main menu: 9 stable pages across65536 masks, %u options with isolated status writes, device visibility and disabled controls\n",options);
}
'''
cpp = out / 'menu-contract.cpp'
cpp.write_text(harness)
compiler, env = cpp_environment(out)
exe = out / ('menu-contract.exe' if os.name == 'nt' else 'menu-contract')
command = ([compiler, '/nologo', '/std:c++17', '/EHsc', '/O2',
'/D_CRT_SECURE_NO_WARNINGS', '/Fe:' + str(exe), str(cpp)]
if os.name == 'nt' else [compiler, '-std=c++17', '-O2', str(cpp), '-o', str(exe)])
with (out / 'compile.log').open('w') as log:
subprocess.run(command, cwd=out, env=env, stdout=log,
stderr=subprocess.STDOUT, check=True)
result = subprocess.run([str(exe)], capture_output=True, text=True)
(out / 'run.log').write_text(result.stdout + result.stderr)
result.check_returncode()
paths = (top, user, menu, cpp, Path(__file__))
(out / 'result.json').write_text(json.dumps(dict(passed=True,
scope='Pinned native Main parsing; no OSD drawing or FPGA/hardware test',
result=result.stdout.strip(), sha256={str(x.resolve()): digest(x) for x in paths}), indent=2)+'\n')
print(result.stdout, end='')
if __name__ == '__main__':
main()
+49
View File
@@ -0,0 +1,49 @@
#!/usr/bin/env python3
"""Exercise actual four-slot modules and independently detect routing/storage defects."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import subprocess
ROOT=Path(__file__).resolve().parents[1]
def main():
p=argparse.ArgumentParser(description=__doc__)
p.add_argument('output',type=Path)
p.add_argument('--suite',type=Path,required=True)
p.add_argument('--project',type=Path,default=ROOT)
a=p.parse_args();out=a.output.resolve()
if out.exists() or not out.is_relative_to(ROOT/'build'):p.error('Use a fresh build/ directory')
out.mkdir(parents=True)
sources=[a.project/'rtl'/('bh_mpi_'+n+'.sv') for n in ('config','router','rom')]
bench=ROOT/'tests/bh_mpi_tb.sv'
env=os.environ.copy();env['PATH']=os.pathsep.join([str(a.suite/'bin'),str(a.suite/'lib'),env['PATH']])
ext='.exe' if os.name=='nt' else ''
variants=[('native',None),('rom-route',('router','layout[cts*3+:3]','layout[scs*3+:3]')),
('rom-slot-alias',('rom','index==6?0:index==7?1:index==9?3:2','2\'d0')),
('singleton',('config','remaining=mask&~used','remaining=mask'))]
results=[]
for name,change in variants:
folder=out/name;folder.mkdir();files=[]
for source in sources:
text=source.read_text()
if change and source.stem=='bh_mpi_'+change[0]:
assert text.count(change[1])==1,change
text=text.replace(change[1],change[2])
dest=folder/source.name;dest.write_text(text,encoding='utf-8',newline='\n');files.append(dest)
binary=folder/'test.vvp'
run=subprocess.run([str(a.suite/'bin'/('iverilog'+ext)),'-g2012','-s','bh_mpi_tb','-o',str(binary),str(bench),*map(str,files)],env=env,capture_output=True,text=True)
(folder/'compile.log').write_text(run.stdout+run.stderr)
if run.returncode:raise RuntimeError('Compile failed: '+str(folder))
run=subprocess.run([str(a.suite/'bin'/('vvp'+ext)),str(binary)],env=env,capture_output=True,text=True,timeout=180)
log=run.stdout+run.stderr;(folder/'rtl.log').write_text(log)
if name=='native':assert run.returncode==0 and 'PASS 65536 routing combinations' in log,log
else:assert run.returncode!=0 and 'FATAL' in log,(name,log)
results.append(dict(name=name,exit_code=run.returncode,result=log.strip()))
print(name+': '+log.strip(),flush=True)
obj=dict(passed=True,source_sha256={str(x):hashlib.sha256(x.read_bytes()).hexdigest() for x in [*sources,bench,Path(__file__)]},cases=results,hardware_tested=False)
(out/'result.json').write_text(json.dumps(obj,indent=2)+'\n')
if __name__=='__main__':main()
+103
View File
@@ -0,0 +1,103 @@
#!/usr/bin/env python3
"""Check actual core ROM/address/bank/IRQ/restart bindings with real slot RAM.
The CPU bus and system/disk ROM bytes are stimuli. This is not a full-core
vendor-IP simulation; exact source snippets are compiled without rewriting them.
"""
import argparse
import hashlib
import json
import os
from pathlib import Path
import re
import subprocess
ROOT=Path(__file__).resolve().parents[1]
def main():
p=argparse.ArgumentParser(description=__doc__)
p.add_argument('project',type=Path);p.add_argument('output',type=Path)
p.add_argument('--suite',type=Path,required=True);a=p.parse_args()
out=a.output.resolve()
if out.exists() or not out.is_relative_to(ROOT/'build'):p.error('Use fresh build/ output')
out.mkdir(parents=True);core=a.project/'rtl/coco3fpga.sv';s=core.read_text()
def region(start,end):return s[s.index(start):s.index(end,s.index(start))]
routing=region('wire [2:0] mpi_rom_kind,mpi_io_kind;','wire [7:0] mpi_orch_right=')
routing+=s[s.index('wire [7:0] mpi_orch_right='):s.index("wire [7:0] mpi_orch_right=")+len("wire [7:0] mpi_orch_right=mpi_orchestra_present?ORCH_RIGHT:8'h80;")]
bank_declarations=region('reg [2:0] rom_banks[0:3];','integer rom_bank_index;')+'integer rom_bank_index;'
bank=region('/*\n$FF40 -','wire [3:0]\tConfig_FLAG')
if 'always @(negedge clk_sys or negedge RESET_N)' not in bank:raise RuntimeError('Bank source contract changed')
romdecode=region('assign FLASH_DATA =','assign\tVDAC_EN =')
addresses=region('assign FLASH_ADDRESS =','// Empty cartridge sockets')
irq=region('// A loaded ROM drives','assign CART_INT_N = CART_INT_IN_N;')
restart=region('reg mpi_rom_cold_pending=0;','AMW coco_AMW (')
trigger=re.search(r'\.Trigger\((AMW_Trigger \|\| \(mpi_rom_cold_pending && AMW_Ready\))\)',s)
assert trigger
selector=re.search(r"16'hFF7F:\s*begin\s*MPI_SCS <= DATA_OUT\[1:0\];\s*MPI_CTS <= DATA_OUT\[5:4\];\s*end",s)[0]
generated='''module actual_mpi_core(input clk_sys,SSC_POWER_RESET,RESET_N,CART_SEL,ROM_SEL,PH_2,RW_N,
input [15:0] ADDRESS,input [1:0] ROM,input [9:0] SWITCH,input [7:0] DATA_OUT,
input [11:0] MPI_LAYOUT,input MPI_BOOT_LOADING,input ioctl_download,ioctl_wr,input [15:0] ioctl_index,
input [24:0] ioctl_addr,input [7:0] ioctl_data,input ext_response,SER_IRQ,
input AMW_Trigger,AMW_Ready,AMW_EN,
output [7:0] FLASH_DATA,output HDD_EN,SDC_OBSERVE,RS232_EN,SLOT3_HW,
output [3:0] MPI_ROM_FAULT,output MPI_ROM_LOADING,MPI_ROM_LOADED,RESTART,
output reg [1:0] MPI_SCS,MPI_CTS,output reg CART_INT_IN_N);
wire [7:0] COCO3_ROM_DATA=8'haa,COCO3_DISK_ROM_DATA=8'hd4,CART_DATA;
wire [7:0] ORCH_LEFT=8'h80,ORCH_RIGHT=8'h80;
wire [21:0] FLASH_ADDRESS;
wire ENA_DISK2,ENA_PAK,ENA_DSK;
wire SSC_MODE=1'b1;
'''+routing+'\n'+bank_declarations+'\n'+addresses+'\n'+romdecode+'\n'+bank+'\n'+irq+'\n'+restart+'''
always @(negedge clk_sys or negedge RESET_N)begin
if(!RESET_N)begin MPI_SCS<=SWITCH[2:1];MPI_CTS<=SWITCH[2:1];end
else if(PH_2&&!RW_N)begin case(ADDRESS)
'''+selector+'''
default:;
endcase end
end
assign RESTART='''+trigger[1]+''';
assign SDC_OBSERVE=SDC_EN_CS;
endmodule
'''
wrapper=out/'actual-core.sv';wrapper.write_text(generated,encoding='utf-8',newline='\n')
bench=ROOT/'tests/bh_mpi_core_tb.sv'
modules=[a.project/'rtl/bh_mpi_router.sv',a.project/'rtl/bh_mpi_rom.sv',a.project/'rtl/bh_mpi_config.sv']
env=os.environ.copy();env['PATH']=os.pathsep.join([str(a.suite/'bin'),str(a.suite/'lib'),env['PATH']]);ext='.exe' if os.name=='nt' else ''
cases=[]
for tag,define,mutation in [('ordinary',False,None),('os9-compatibility',True,None),
('wrong-bank-route',False,('rom_banks[MPI_SCS] <= DATA_OUT[2:0];','rom_banks[MPI_CTS] <= DATA_OUT[2:0];')),
('lost-restart',False,('assign RESTART='+trigger[1], 'assign RESTART=AMW_Trigger || MPI_ROM_LOADED')),
('lost-startup-autoload',False,('MPI_BOOT_LOADING||device_kind==1', 'device_kind==1')),
('startup-main-order',False,None),('early-init-handshake',False,None)]:
startup=tag in ('startup-main-order','early-init-handshake')
active_bench=ROOT/'tests/bh_mpi_startup_tb.sv' if startup else bench
active_modules=modules.copy()
rejected=mutation is not None or tag=='early-init-handshake'
if tag=='early-init-handshake':
original=modules[-1].read_text()
guard='host_started&&!requested[0]&&requested==last_requested&&pending&&!status_set'
assert original.count(guard)==1
bad=out/'early-init-config.sv'
bad.write_text(original.replace(guard,'pending&&!status_set'),encoding='utf-8',newline='\n')
active_modules[-1]=bad
active_wrapper=wrapper
if mutation:
assert generated.count(mutation[0])==1
active_wrapper=out/(tag+'-core.sv')
active_wrapper.write_text(generated.replace(*mutation),encoding='utf-8',newline='\n')
binary=out/(tag+'.vvp')
cmd=[str(a.suite/'bin'/('iverilog'+ext)),'-g2012','-s',
'bh_mpi_startup_tb' if startup else 'bh_mpi_core_tb','-o',str(binary)]
if define:cmd+=['-DCoCo3_sdc_fix_os9_driver']
run=subprocess.run([*cmd,str(active_wrapper),str(active_bench),*map(str,active_modules)],env=env,capture_output=True,text=True)
(out/(tag+'-compile.log')).write_text(run.stdout+run.stderr)
if run.returncode:raise RuntimeError('Actual core binding compile failed: '+tag)
run=subprocess.run([str(a.suite/'bin'/('vvp'+ext)),str(binary)],env=env,capture_output=True,text=True,timeout=120)
log=run.stdout+run.stderr;(out/(tag+'.log')).write_text(log)
if rejected:assert run.returncode!=0 and 'FATAL' in log,(tag,log)
else:assert run.returncode==0 and 'PASS actual core MPI bindings' in log,log
print(tag+': '+log.strip(),flush=True);cases.append(dict(name=tag,result=log.strip()))
files=[core,wrapper,bench,ROOT/'tests/bh_mpi_startup_tb.sv',*modules,Path(__file__)]
(out/'result.json').write_text(json.dumps(dict(passed=True,hardware_tested=False,cases=cases,source_sha256={str(x):hashlib.sha256(x.read_bytes()).hexdigest() for x in files}),indent=2)+'\n')
if __name__=='__main__':main()
+179
View File
@@ -0,0 +1,179 @@
#!/usr/bin/env python3
"""Exercise the pinned original MiSTer FC parser with BH records and mocked I/O.
This verifies host parser/record/index behavior, not the installed ARM binary,
FPGA configuration, analog timing or physical startup. No Main source is edited.
"""
import argparse
import json
import os
from pathlib import Path
import re
import subprocess
from validation_common import ROOT, digest, cpp_environment
from coco3_bh_profile import NAME, ROM_SLOTS, startup_records
def block(text, anchor):
start = text.index(anchor)
opening = text.index('{', start)
depth = 1
end = opening + 1
while depth:
depth += (text[end] == '{') - (text[end] == '}')
end += 1
return text[start:end]
def main():
p = argparse.ArgumentParser(description=__doc__)
p.add_argument('project', type=Path)
p.add_argument('reference', type=Path)
p.add_argument('output', type=Path)
a = p.parse_args()
out = a.output.resolve()
if out.exists() or not out.is_relative_to(ROOT / 'build'):
p.error('Use a fresh build directory')
out.mkdir(parents=True)
source = a.reference / 'user_io.cpp'
provenance = json.loads((a.reference / 'provenance.json').read_text())
if digest(source) != provenance['files']['user_io.cpp']['sha256']:
raise RuntimeError('Pinned Main parser changed')
original = source.read_text()
# Main's real initialization order matters to slot-ROM eligibility: FC
# parsing precedes saved status restoration while bit0 remains asserted.
init_reset = original.index('user_io_status_set("[0]", 1);', original.index('void user_io_init('))
parse_call = original.index('parse_config();', init_reset)
saved_config = original.index('int config_found = FileLoadConfig(name, cur_status', parse_call)
release_reset = original.index('user_io_status_set("[0]", 0);', saved_config)
assert init_reset < parse_call < saved_config < release_reset
file_tx = block(original, 'int user_io_file_tx(const char* name,')
acknowledgement = block(original, 'static void check_status_change()')
assert 'check_status_change();' in file_tx
assert 'user_io_status_set("[0]", 0);' in acknowledgement
parser = block(original, "if (p[0] == 'F')")
substring = block(original, 'int substrcpy(')
extension = block(original, 'unsigned char user_io_ext_idx(')
top = a.project / 'CoCo3.sv'
if 'bh_mpi_config mpi_configuration' in top.read_text():
assert '.MPI_BOOT_LOADING(status[0])' in top.read_text(), 'Retain FC files until saved layout arrives'
conf = top.read_text().split('localparam CONF_STR = {', 1)[1].split('};', 1)[0]
lines = re.findall(r'"([^"\n]*)"', conf)
if not lines[0].startswith('Coco 3 Plus;'):
raise RuntimeError('Fitted source does not have the independent identity')
picks = [next(x[:-1] for x in lines if x.startswith(f'H4FC{n},')) for n in ROM_SLOTS]
cases = [
('default', NAME, picks, [4, 5]),
('hidden-independent', NAME, ['H4D0' + x[2:] for x in picks], [4, 5]),
('legacy-manual', NAME, [x.replace('FC', 'F', 1) for x in picks], []),
('stock-isolated', 'COCO3', picks, []),
('missing-voice', NAME, picks, [4]),
('rom-extension', NAME, picks, [68, 69]),
]
slot_picks = [next(x[:-1] for x in lines if re.match(r'H[89AB]P1FC'+str(n)+',', x))
for n in range(6, 10)] if any('P1FC6,' in x for x in lines) else []
if slot_picks:
cases.append(('slot-autoload', NAME, slot_picks, [6, 7, 8, 9]))
records = startup_records()
if slot_picks:
for n in range(6, 10):
value = f'/media/fat/games/coco3plus/slot{n-5}.ccc'.encode()
records[f'config/{NAME}.f{n}'] = value.ljust(1024, b'\0')
for path, data in records.items():
target = out / path
target.parent.mkdir(exist_ok=True)
target.write_bytes(data)
harness = r'''
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <cstdint>
#include <cassert>
#include <cctype>
#ifdef _MSC_VER
#define strcasecmp _stricmp
#else
#include <strings.h>
#endif
#include <string>
#include <vector>
static const char *identity, *scenario;
static int boot0_loaded=0;
static std::vector<int> sent;
const char *user_io_get_core_name(){return identity;}
bool is_cpc(){return false;}
void StoreIdx_F(int,const char*){}
int FileLoadConfig(const char *name,void *buffer,int size){
std::string path="config/";path+=name;
if(!strcmp(scenario,"missing-voice") && path.find(".f5")!=std::string::npos)return 0;
FILE *f=fopen(path.c_str(),"rb");if(!f)return 0;
int n=fread(buffer,1,size,f);fclose(f);
if(!strcmp(scenario,"rom-extension")) {
char *s=(char*)buffer;char *e=strrchr(s,'.');assert(e);strcpy(e,".rom");
}
assert(((char*)buffer)[size-1]==0);return n;
}
void user_io_file_tx(const char *name,int index,int,int,int,uint32_t address){
assert(!strncmp(name,"/media/fat/games/coco3plus/",strlen("/media/fat/games/coco3plus/")));
assert(address==0);sent.push_back(index);
printf("TX %d %s\n",index,name);
}
'''
generated = harness + '\n' + substring + '\n' + extension + '\nvoid load(char *p){\nchar str[1024]={},ext[256]={};\n'
generated += 'while((p[0]==\'H\'||p[0]==\'D\'||p[0]==\'h\'||p[0]==\'d\')&&strlen(p)>=2)p+=2;\n'
# Exact page-prefix skip from pinned user_io.cpp's config initialization.
page_skip = re.search(r"if \(p\[0\] == 'P'\) p \+= 2;", original)
if not page_skip:
raise RuntimeError('Pinned Main page-prefix contract changed')
generated += page_skip[0] + '\n'
# Exercise the exact original Main name reader with the display identity and
# native MGL override, including embedded spaces and its real 32-byte fields.
name_reader = block(original, 'void user_io_read_core_name()')
name_fixture = r'''namespace identity_contract {
static char core_name[32]={},orig_name[32]={},ovr_name[32]={};
static int is_no_type=0;
char *user_io_get_confstr(int){static char n[]="Coco 3 Plus";return n;}
'''+name_reader+r'''
void run(){
user_io_read_core_name();
assert(!strcmp(core_name,"Coco 3 Plus") && !strcmp(orig_name,"Coco 3 Plus"));
strcpy(ovr_name,"coco3plus");user_io_read_core_name();
assert(!strcmp(core_name,"coco3plus") && !strcmp(orig_name,"Coco 3 Plus"));
}
}
'''
generated += parser + '\n}\n'+name_fixture+'\nint main(int argc,char **argv){assert(argc==3);identity_contract::run();identity=argv[1];scenario=argv[2];\n'
for tag, identity, options, expected in cases:
generated += f'if(!strcmp(scenario,{json.dumps(tag)})){{\n'
for item in options:
generated += f'{{char p[]={json.dumps(item)};load(p);}}\n'
generated += 'assert(boot0_loaded==0);assert((sent==std::vector<int>{' + ','.join(map(str, expected)) + '}));}\n'
generated += 'puts("PASS native Main FC startup parser");}\n'
cpp = out / 'main-fc-probe.cpp'
cpp.write_text(generated)
compiler, env = cpp_environment(out)
ext = '.exe' if os.name == 'nt' else ''
exe = out / ('probe' + ext)
with (out / 'compile.log').open('w') as log:
command = ([compiler, '/nologo', '/std:c++17', '/EHsc', '/O2', '/D_CRT_SECURE_NO_WARNINGS', '/Fe:' + str(exe)]
if os.name == 'nt' else [compiler, '-std=c++17', '-O2', '-o', str(exe)])
subprocess.run([*command, str(cpp)], cwd=out,
env=env, stdout=log, stderr=subprocess.STDOUT, check=True)
results = []
for tag, identity, _, expected in cases:
result = subprocess.run([str(exe), identity, tag], cwd=out, env=env, capture_output=True, text=True)
(out / (tag + '.log')).write_text(result.stdout + result.stderr)
if result.returncode or 'PASS native Main FC startup parser' not in result.stdout:
raise RuntimeError('Startup parser probe failed: ' + tag)
results.append({'case': tag, 'indices': expected, 'log_sha256': digest(out / (tag + '.log'))})
data = {'passed': True, 'hardware_tested': False, 'main_reference': provenance,
'top_sha256': digest(top), 'records': {k: {'bytes': len(v), 'path': v.split(b'\0')[0].decode()} for k, v in records.items()},
'cases': results, 'script_sha256': digest(Path(__file__)),
'scope': 'Original native Main FC/extension parser; mocked file I/O and transport; installed binary startup remains a hardware check'}
(out / 'result.json').write_text(json.dumps(data, indent=2) + '\n')
print(f'PASS {len(cases)} original-Main startup cases, including applicable page-scoped slot ROM records')
if __name__ == '__main__':
main()
+67
View File
@@ -0,0 +1,67 @@
#!/usr/bin/env python3
"""Check the real platform serializer's timing slots; reject a same-edge defect."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import subprocess
ROOT = Path(__file__).resolve().parents[1]
def main():
p = argparse.ArgumentParser(description=__doc__)
p.add_argument('project', type=Path)
p.add_argument('output', type=Path)
p.add_argument('--suite', type=Path, required=True)
a = p.parse_args()
out = a.output.resolve()
if not out.is_relative_to(ROOT / 'build') or out.exists():
p.error('Use a fresh build/ directory')
out.mkdir(parents=True)
source = a.project / 'sys/audio_out.v'
i2s = a.project / 'sys/i2s.v'
text = source.read_text()
ce = text[text.index('localparam AUDIO_RATE'):text.index('\ni2s i2s')]
ce = ce.replace('always @(posedge clk) begin', 'always @(posedge clk) begin : ce_phase', 1)
at = ce.index('reg i2s_ce;')
ce = ce[:at] + ce[at:].replace('always @(posedge clk) begin', 'always @(posedge clk) begin : divider_phase', 1)
wrapper = ('module audio_pin_contract(input clk,reset,sample_rate,output bclk,lrclk,data);\n'
'localparam CLK_RATE=24576000;\n' + ce + '\n'
'i2s i2s(.reset(reset),.clk(clk),.ce(i2s_ce),.sclk(bclk),.lrclk(lrclk),.sdata(data),'
'.left_chan(16\'ha55a),.right_chan(16\'h5aa5));\nendmodule\n')
(out / 'wrapper.sv').write_text(wrapper)
(out / 'i2s.v').write_bytes(i2s.read_bytes())
env = os.environ.copy()
env['PATH'] = os.pathsep.join([str(a.suite / 'bin'), str(a.suite / 'lib'), env['PATH']])
ext = '.exe' if os.name == 'nt' else ''
cmd = [str(a.suite / 'bin' / ('iverilog' + ext)), '-g2012', '-s', 'external_audio_tb', '-o', str(out / 'run.vvp'),
str(ROOT / 'tests/external_audio_tb.sv'), str(out / 'wrapper.sv'), str(out / 'i2s.v')]
for negative in (False, True):
tag = 'negative' if negative else 'positive'
if negative:
# Deliberately invert the forwarded sampling edge.
mutant = i2s.read_text().replace('sclk <= msclk;', 'sclk <= ~msclk;')
assert mutant != i2s.read_text()
(out / 'i2s.v').write_text(mutant)
with (out / f'{tag}-compile.log').open('w') as log:
subprocess.run(cmd, env=env, stdout=log, stderr=subprocess.STDOUT, check=True)
with (out / f'{tag}.log').open('w') as log:
result = subprocess.run([str(a.suite / 'bin' / ('vvp' + ext)), str(out / 'run.vvp')],
env=env, stdout=log, stderr=subprocess.STDOUT, timeout=60)
log_text = (out / f'{tag}.log').read_text()
print(log_text, end='')
if (not negative and (result.returncode or 'PASS audio pin slots' not in log_text)) or (
negative and (not result.returncode or 'I2S receiver setup slot lost' not in log_text)):
raise RuntimeError(f'Unexpected {tag} result')
(out / 'i2s.v').write_bytes(i2s.read_bytes())
(out / 'result.json').write_text(json.dumps({'passed': True, 'wrong_edge_mutant_rejected': True,
'setup_min_fabric_cycles': 5, 'hold_min_fabric_cycles': 3, 'modes_hz': [48000, 96000],
'scope': 'real CE and I2S RTL; no analog edge/pull-up or external receiver model',
'source_sha256': {str(path.relative_to(a.project)): hashlib.sha256(path.read_bytes()).hexdigest()
for path in (source, i2s)}}, indent=2) + '\n')
if __name__ == '__main__':
main()
+80
View File
@@ -0,0 +1,80 @@
#!/usr/bin/env python3
"""Check actual MCP I2C master against fast-mode slots and finite release delay."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import re
import subprocess
ROOT = Path(__file__).resolve().parents[1]
def main():
p = argparse.ArgumentParser(description=__doc__)
p.add_argument('project', type=Path)
p.add_argument('output', type=Path)
p.add_argument('--suite', type=Path, required=True)
a = p.parse_args()
out = a.output.resolve()
if not out.is_relative_to(ROOT / 'build') or out.exists():
p.error('Use a new build/ directory')
out.mkdir(parents=True)
source = a.project / 'sys/i2c.v'
wrapper = a.project / 'sys/mcp23009.sv'
m = re.search(r'i2c\s*#\(50_000_000,\s*([\d_]+)\)', wrapper.read_text())
assert m
native_hz = int(m[1].replace('_', ''))
env = os.environ.copy()
env['PATH'] = os.pathsep.join([str(a.suite / 'bin'), str(a.suite / 'lib'), env['PATH']])
ext = '.exe' if os.name == 'nt' else ''
results = []
for hz in sorted({native_hz, 250000, 500000}):
# Four independent pin-edge extrema for the accepted profile;
# the ideal legacy waveform is the negative frequency/low-time control.
corners = range(16) if hz == 250000 else (0, 1)
for corner in corners:
scl_fall = 300 if corner & 1 else 0
scl_release = 300 if corner & 2 else 0
sda_fall = 300 if corner & 4 else 0
sda_release = 300 if corner & 8 else 0
tag = f'{hz}-{corner}'
text = source.read_text()
# Icarus requires declarations before their use in delayed drivers;
# Quartus accepts the original declaration order. No logic changes.
declarations = []
for name in ('SCLK', 'SDO'):
d = re.search(r'^reg\s+(?:\[[^\]]+\]\s*)?' + name + r';', text, re.M)
assert d
declarations.append(d[0])
text = text.replace(d[0], '', 1)
text = text.replace('assign I2C_SCL =', '\n'.join(declarations) + '\nassign I2C_SCL =', 1)
text = text.replace('assign I2C_SCL =', f'assign #(0,{scl_fall},{scl_release}) I2C_SCL =')
text = text.replace('assign I2C_SDA =', f'assign #(0,{sda_fall},{sda_release}) I2C_SDA =')
(out / 'i2c.v').write_text(text)
cmd = [str(a.suite / 'bin' / ('iverilog' + ext)), '-g2012', f'-DBUS_HZ={hz}',
f'-DSDA_FALL_NS={sda_fall}', f'-DSDA_RELEASE_NS={sda_release}', '-s', 'external_i2c_tb',
'-o', str(out / 'run.vvp'), str(ROOT / 'tests/external_i2c_tb.sv'), str(out / 'i2c.v')]
with (out / f'{tag}-compile.log').open('w') as log:
subprocess.run(cmd, env=env, stdout=log, stderr=subprocess.STDOUT, check=True)
with (out / f'{tag}.log').open('w') as log:
r = subprocess.run([str(a.suite / 'bin' / ('vvp' + ext)), str(out / 'run.vvp')], env=env,
stdout=log, stderr=subprocess.STDOUT, timeout=60)
text = (out / f'{tag}.log').read_text()
print(text, end='')
if hz == 500000:
assert r.returncode and ('I2C low below 1300ns' in text or 'I2C fast-mode period below 2500ns' in text)
else:
assert not r.returncode and 'PASS I2C fast-mode slots' in text
results.append({'bus_hz': hz, 'scl_fall_ns': scl_fall, 'scl_release_ns': scl_release,
'sda_fall_ns': sda_fall, 'sda_release_ns': sda_release, 'exit_code': r.returncode,
'log_sha256': hashlib.sha256((out / f'{tag}.log').read_bytes()).hexdigest()})
(out / 'result.json').write_text(json.dumps({'native_bus_hz': native_hz, 'fast_profile_passed': native_hz == 250000,
'scope': 'actual master, NACK/released FF and maximum-900ns ACK/slave-data cases; independent 0/300ns pin-edge extrema, no physical slave/RC measurement',
'source_sha256': {str(f.relative_to(a.project)): hashlib.sha256(f.read_bytes()).hexdigest() for f in (source, wrapper)},
'results': results}, indent=2) + '\n')
if __name__ == '__main__':
main()
+86
View File
@@ -0,0 +1,86 @@
#!/usr/bin/env python3
"""Verify the actual pixel divider's generated-clock edges and reject a defect."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import re
import subprocess
ROOT = Path(__file__).resolve().parents[1]
def main():
p = argparse.ArgumentParser(description=__doc__)
p.add_argument('project', type=Path)
p.add_argument('output', type=Path)
p.add_argument('--suite', type=Path, required=True)
a = p.parse_args()
out = a.output.resolve()
if not out.is_relative_to(ROOT / 'build') or out.exists():
p.error('Use a fresh build/ directory')
out.mkdir(parents=True)
source = a.project / 'rtl/Mister_Video.v'
sdc = a.project / 'external-io.sdc'
text = source.read_text()
divider = re.search(r'always @ \(posedge MASTER_CLK\)\s*begin\s*reg\s*\[1:0\]\s*div;.*?\nend', text, re.S)
assert divider is not None
assert '-edges {3 7 11}' in sdc.read_text()
block = divider[0].replace('begin', 'begin : divider', 1)
env = os.environ.copy()
env['PATH'] = os.pathsep.join([str(a.suite / 'bin'), str(a.suite / 'lib'), env['PATH']])
ext = '.exe' if os.name == 'nt' else ''
bench = '''`timescale 1ns/1ps
module tb;
reg clk=0; always #5 clk=~clk;
wire pix; generator dut(clk,pix);
integer cycles=0, rises=0, last_rise=0, last_fall=0;
reg previous=0;
always @(posedge clk) cycles=cycles+1;
// Observe the registered final value after all nonblocking assignments settle.
// The original RTL assigns default low then conditionally high in one process.
always @(negedge clk) begin
if(pix && !previous) begin
if(rises==0 && cycles!=2) $fatal(1,"Pixel first edge %0d",cycles);
if(rises>0 && cycles-last_rise!=4) $fatal(1,"Pixel period %0d",cycles-last_rise);
if(rises>0 && cycles-last_fall!=2) $fatal(1,"Pixel low width");
last_rise=cycles;rises=rises+1;
end
if(!pix && previous && rises>0) begin
if(cycles-last_rise!=2) $fatal(1,"Pixel high width");
last_fall=cycles;
end
previous=pix;
end
initial begin
dut.divider.div=0;
repeat(4096) @(negedge clk);
if(rises!=1024) $fatal(1,"Pixel count");
$display("PASS pixel edges {3 7 11}: 1024 periods, divide four, duty half");
$finish;
end
endmodule
'''
(out / 'tb.sv').write_text(bench)
cmd = [str(a.suite / 'bin' / ('iverilog' + ext)), '-g2012', '-s', 'tb', '-o', str(out / 'run.vvp'), str(out / 'tb.sv'), str(out / 'generator.sv')]
for negative in (False, True):
tag = 'negative' if negative else 'positive'
logic = block.replace("(div == 2'd2)", "(div == 2'd3)") if negative else block
(out / 'generator.sv').write_text('module generator(input MASTER_CLK,output reg PIX_CLK);\n' + logic + '\nendmodule\n')
with (out / f'{tag}-compile.log').open('w') as log:
subprocess.run(cmd, env=env, stdout=log, stderr=subprocess.STDOUT, check=True)
with (out / f'{tag}.log').open('w') as log:
r = subprocess.run([str(a.suite / 'bin' / ('vvp' + ext)), str(out / 'run.vvp')], env=env, stdout=log, stderr=subprocess.STDOUT, timeout=30)
output = (out / f'{tag}.log').read_text()
print(output, end='')
if (not negative and (r.returncode or 'PASS pixel edges' not in output)) or (negative and (not r.returncode or 'Pixel' not in output)):
raise RuntimeError('Unexpected divider result: ' + tag)
(out / 'result.json').write_text(json.dumps({'passed': True, 'wrong_duty_mutant_rejected': True,
'generated_edges': [3, 7, 11], 'periods': 1024,
'scope': 'extracted actual divider; FPGA zero power-up counter assumption; not pixel rendering',
'source_sha256': {str(path.relative_to(a.project)): hashlib.sha256(path.read_bytes()).hexdigest() for path in (source, sdc)}}, indent=2) + '\n')
if __name__ == '__main__':
main()
+125
View File
@@ -0,0 +1,125 @@
#!/usr/bin/env python3
"""Delayed SDRAM read-window experiment using the existing independent line oracle.
This is a digital corner model, not vendor silicon or signal-integrity simulation.
It models the fitted clock skew and return propagation explicitly; source stays
unchanged. Generated variants test whether ready strobes select the right beat.
"""
import argparse
import hashlib
import json
import os
from pathlib import Path
import subprocess
from test_video_sdram import normalize_controller
ROOT = Path(__file__).resolve().parents[1]
def main():
p = argparse.ArgumentParser(description=__doc__)
p.add_argument('project', type=Path)
p.add_argument('output', type=Path)
p.add_argument('--suite', type=Path, required=True)
p.add_argument('--check-cpu-data', action='store_true',
help='Also check the competing CPU read payload at the actual positive-edge consumer')
p.add_argument('--legacy-extra-launch-cycle', action='store_true',
help='Reproduce the rejected model that added tAC after three whole CL3 cycles')
args = p.parse_args()
out = args.output.resolve()
if not out.is_relative_to(ROOT / 'build') or out.exists():
p.error('Use a fresh build/ directory')
out.mkdir(parents=True)
env = os.environ.copy()
env['PATH'] = os.pathsep.join([str(args.suite / 'bin'), str(args.suite / 'lib'), env['PATH']])
ext = '.exe' if os.name == 'nt' else ''
source = args.project / 'rtl/sdram/sdram2.sv'
fetch = (args.project / 'rtl/coco_mem_fetch.sv').read_text()
import re
for name in ('SDRAM_VID_REQ', 'BUFF_ADD', 'BUFF_DATA_O', 'BUFFER_WRITE'):
fetch, n = re.subn(r'(output\s+)(?!reg)(\[[^\]]+\]\s*)?(' + name + r'\b)', r'\1reg \2\3', fetch, count=1)
assert n == 1
fetch = re.sub(r'wire(\s+\[2:0\]\s+BUF_HBORDER;)', r'reg\1', fetch, count=1)
(out / 'fetch.sv').write_text(fetch)
bench_source = (ROOT / 'tests/video_sdram_tb.sv').read_text()
if args.check_cpu_data:
# The existing video oracle already checks independent addresses. Its
# competing CPU channel used to count READY without checking payload.
cpu_address = int(re.search(r"sdram_cpu_addr\(25'h([0-9a-fA-F]+)\)", bench_source)[1], 16)
word = cpu_address >> 1
expected = (word & 0xffff) ^ (((word >> 16) & 255) * 0x101) ^ 0x96a5
old = 'if(cpu_ready) cpu_reads<=cpu_reads+1;'
assert bench_source.count(old) == 1
bench_source = bench_source.replace(old,
f'if(cpu_ready) begin cpu_reads<=cpu_reads+1; '
f'if(dout!==16\'h{expected:04x}) $fatal(1,"CPU read data mismatch value=%h",dout); end')
records = []
native_extra_match = re.search(r'localparam READ_CAPTURE_EXTRA\s*=\s*(\d+)', source.read_text())
native_extra = int(native_extra_match[1]) if native_extra_match else 0
# Clock skew bounds are diagnostic envelopes; latest tAC and earliest tOH
# use different stable-data corners. 0/0 is the old logical model control.
for corner, clock_skew, return_delay, command_delay in [('logical', 0, 0, 0), ('late', 4.5, 8.245, 5.0), ('early', 1.5, 3.121, 1.0)]:
for extra_ready in (0, 1):
folder = out / f'{corner}-ready{extra_ready}'
folder.mkdir()
for name in ('reference', 'candidate'):
text = normalize_controller(source.read_text(), 'sdram_' + name)
if native_extra_match:
text = re.sub(r'localparam READ_CAPTURE_EXTRA\s*=\s*\d+', 'localparam READ_CAPTURE_EXTRA = ' + str(extra_ready), text)
elif extra_ready:
# Expand the whole ready pipeline by one, preserving ordering.
text = text.replace('[CAS_LATENCY+BURST_LENGTH:0]', '[CAS_LATENCY+BURST_LENGTH+1:0]')
text = text.replace('[CAS_LATENCY+BURST_LENGTH]', '[CAS_LATENCY+BURST_LENGTH+1]')
(folder / (name + '.sv')).write_text(text)
bench = bench_source.replace('always #5 clk=~clk;', 'always #4.365079 clk=~clk;')
physical_launch_cycles = 3 if corner == 'logical' or args.legacy_extra_launch_cycle else 2
if physical_launch_cycles == 2:
# Alliance Fig31.2: READ at T4, Ax0 launches after T6 and
# is sampled at T7. CL3's third edge is the receive boundary;
# adding tAC after T7 incorrectly adds another whole cycle.
old = "pipe[2]=contents(word_address);pipe[3]=contents(word_address ^ 24'd1);\n valid[2]=1;valid[3]=1;"
new = "pipe[1]=contents(word_address);pipe[2]=contents(word_address ^ 24'd1);\n valid[1]=1;valid[2]=1;"
assert bench.count(old) == 1
bench = bench.replace(old, new)
bench = bench.replace('COMMAND_DELAY_NS=0', 'COMMAND_DELAY_NS=' + str(command_delay))
bench = bench.replace('always @(negedge clk) begin\n drive <= #(RETURN_DELAY_NS) (valid[0]?pipe[0]:16\'hzzzz);',
# Transport each edge: an inertial continuous delay larger
# than half a period incorrectly suppresses the whole clock.
f'reg pin_clk; always @(clk) pin_clk <= #{clock_skew} clk;\n'
f'always @(negedge pin_clk) begin\n drive <= #{return_delay} (valid[0]?pipe[0]:16\'hzzzz);')
assert 'reg pin_clk' in bench
(folder / 'tb.sv').write_text(bench)
cmd = [str(args.suite / 'bin' / ('iverilog' + ext)), '-g2012', '-s', 'video_sdram_tb', '-o', str(folder / 'run.vvp'),
str(folder / 'tb.sv'), str(out / 'fetch.sv'), str(folder / 'reference.sv'), str(folder / 'candidate.sv')]
with (folder / 'compile.log').open('w') as log:
subprocess.run(cmd, env=env, stdout=log, stderr=subprocess.STDOUT, check=True)
with (folder / 'run.log').open('w') as log:
r = subprocess.run([str(args.suite / 'bin' / ('vvp' + ext)), str(folder / 'run.vvp')],
env=env, stdout=log, stderr=subprocess.STDOUT, timeout=180)
result = {'corner': corner, 'extra_ready_cycle': extra_ready, 'clock_skew_ns': clock_skew,
'return_delay_ns': return_delay, 'exit_code': r.returncode,
'command_delay_ns': command_delay,
'physical_launch_cycles': physical_launch_cycles,
'native_extra_cycle': native_extra, 'is_ready_mutant': extra_ready != native_extra,
'log_tail': (folder / 'run.log').read_text().strip().splitlines()[-2:],
'log_sha256': hashlib.sha256((folder / 'run.log').read_bytes()).hexdigest()}
expected_pass = ((corner == 'logical') != bool(extra_ready)) if args.legacy_extra_launch_cycle else not extra_ready
signatures = ['video data channel='] + (['CPU read data mismatch'] if args.check_cpu_data else [])
if (r.returncode == 0) != expected_pass or (r.returncode and not any(s in (folder / 'run.log').read_text() for s in signatures)):
raise RuntimeError(f'Unexpected read-window control result: {corner}/{extra_ready}')
records.append(result)
print(json.dumps(result), flush=True)
(out / 'result.json').write_text(json.dumps({'source_sha256': hashlib.sha256(source.read_bytes()).hexdigest(),
'bench_sha256': hashlib.sha256((ROOT / 'tests/video_sdram_tb.sv').read_bytes()).hexdigest(),
'controller_normalizer_sha256': hashlib.sha256((ROOT / 'scripts/test_video_sdram.py').read_bytes()).hexdigest(),
'generator_sha256': hashlib.sha256(Path(__file__).read_bytes()).hexdigest(),
'scope': 'read bursts / line oracle, no write timing or analog model', 'controls_verified': True,
'cpu_data_oracle': args.check_cpu_data,
'legacy_extra_launch_cycle': args.legacy_extra_launch_cycle,
'native_read_window_passed': all(r['exit_code'] == 0 for r in records if not r['is_ready_mutant']),
'results': records}, indent=2) + '\n')
if __name__ == '__main__':
main()
+54
View File
@@ -0,0 +1,54 @@
#!/usr/bin/env python3
"""Check AS4C32M16SB -7 command minima on actual controller pin commands."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import subprocess
from test_video_sdram import normalize_controller
ROOT = Path(__file__).resolve().parents[1]
def main():
p = argparse.ArgumentParser(description=__doc__)
p.add_argument('project', type=Path)
p.add_argument('output', type=Path)
p.add_argument('--suite', type=Path, required=True)
p.add_argument('--expect-legacy-failures', action='store_true')
a = p.parse_args()
out = a.output.resolve()
if not out.is_relative_to(ROOT / 'build') or out.exists():
p.error('Use a new build/ directory')
out.mkdir(parents=True)
source = a.project / 'rtl/sdram/sdram2.sv'
(out / 'controller.sv').write_text(normalize_controller(source.read_text(), 'sdram_probe'))
env = os.environ.copy()
env['PATH'] = os.pathsep.join([str(a.suite / 'bin'), str(a.suite / 'lib'), env['PATH']])
ext = '.exe' if os.name == 'nt' else ''
cmd = [str(a.suite / 'bin' / ('iverilog' + ext)), '-g2012', '-s', 'external_sdram_commands_tb', '-o', str(out / 'run.vvp'),
str(ROOT / 'tests/external_sdram_commands_tb.sv'), str(out / 'controller.sv')]
with (out / 'compile.log').open('w') as log:
subprocess.run(cmd, env=env, stdout=log, stderr=subprocess.STDOUT, check=True)
results = {}
for tag, extra, signature in [('startup', [], 'SDRAM startup below 200 us'),
('recovery', ['+IGNORE_STARTUP'], 'SDRAM tRC below 63 ns'),
('refresh', ['+IGNORE_STARTUP', '+IGNORE_TRC'], 'SDRAM refresh interval above 7812.5 ns')]:
with (out / f'{tag}.log').open('w') as log:
r = subprocess.run([str(a.suite / 'bin' / ('vvp' + ext)), str(out / 'run.vvp'), *extra], env=env,
stdout=log, stderr=subprocess.STDOUT, timeout=60)
text = (out / f'{tag}.log').read_text()
print(text, end='')
if a.expect_legacy_failures:
assert r.returncode != 0 and signature in text
else:
assert r.returncode == 0 and 'PASS SDRAM command intervals' in text
results[tag] = {'exit_code': r.returncode, 'log_sha256': hashlib.sha256((out / f'{tag}.log').read_bytes()).hexdigest()}
(out / 'result.json').write_text(json.dumps({'source_sha256': hashlib.sha256(source.read_bytes()).hexdigest(),
'legacy_failures_reproduced': a.expect_legacy_failures, 'command_checks_passed': not a.expect_legacy_failures,
'scope': 'digital pin-command intervals, no physical read data or analog timing', 'results': results}, indent=2) + '\n')
if __name__ == '__main__':
main()
+41
View File
@@ -0,0 +1,41 @@
#!/usr/bin/env python3
"""Compare the exact keyboard row against upstream with the stated control delay."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import subprocess
from source_snapshot import original_sources
ROOT=Path(__file__).resolve().parents[1]
def main():
parser=argparse.ArgumentParser(description=__doc__)
parser.add_argument('project',type=Path)
parser.add_argument('output',type=Path)
parser.add_argument('--suite',type=Path,required=True)
args=parser.parse_args();output=args.output.resolve()
if not output.is_relative_to((ROOT/'build').resolve()) or output.exists():parser.error('Use a new build/ output')
output.mkdir(parents=True)
original=original_sources('coco3-mister')/'rtl/coco3fpga.sv';candidate=args.project/'rtl/coco3fpga.sv'
def row(text,start):return text[text.index(start):text.index('assign KEYBOARD_IN[7]')]
reference=row(original.read_text(),'assign KEYBOARD_IN[6] =')
actual=row(candidate.read_text(),'// Research: phase-match the remaining CPU keyboard control flags.')
header='input [3:0] controls,input [72:0] KEY,input [7:0] KEY_COLUMN,output y);\nwire EE_N=controls[3],MUGS=controls[2],SHIFT=controls[1],SHIFT_OVERRIDE=controls[0];\nwire [7:0] KEYBOARD_IN;wire [7:0] BUTTON_N={7\'d0,EE_N};\n'
source=output/'actual-keyboard.sv'
source.write_text('module actual_keyboard_controls(input clk_sys,'+header+actual+'\nassign y=KEYBOARD_IN[6];endmodule\nmodule reference_keyboard_controls('+header+reference+'\nassign y=KEYBOARD_IN[6];endmodule\n',encoding='utf-8')
bench=ROOT/'tests/keyboard_control_phase_tb.sv'
env=os.environ.copy();env['PATH']=os.pathsep.join([str(args.suite/'bin'),str(args.suite/'lib'),env['PATH']])
ext='.exe' if os.name=='nt' else ''
with (output/'compile.log').open('w') as log:
subprocess.run([str(args.suite/'bin'/('iverilog'+ext)),'-g2012','-s','keyboard_control_phase_tb','-o',str(output/'test.vvp'),str(bench),str(source)],env=env,stdout=log,stderr=subprocess.STDOUT,check=True)
with (output/'test.log').open('w') as log:
subprocess.run([str(args.suite/'bin'/('vvp'+ext)),str(output/'test.vvp')],env=env,stdout=log,stderr=subprocess.STDOUT,check=True)
print((output/'test.log').read_text())
(output/'test-result.json').write_text(json.dumps({'passed':True,'hardware_tested':False,'sha256':{str(p):hashlib.sha256(p.read_bytes()).hexdigest() for p in [original,candidate,bench,source,Path(__file__),output/'test.log']}},indent=2)+'\n',encoding='utf-8')
if __name__=='__main__':main()
+65
View File
@@ -0,0 +1,65 @@
#!/usr/bin/env python3
"""Compare actual SDC RAM and VDAC write-clock bindings at legal CPU boundaries."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import re
import subprocess
from source_snapshot import original_sources
ROOT=Path(__file__).resolve().parents[1]
def main():
parser=argparse.ArgumentParser(description=__doc__)
parser.add_argument('project',type=Path)
parser.add_argument('output',type=Path)
parser.add_argument('--suite',type=Path,required=True)
args=parser.parse_args()
output=args.output.resolve()
if not output.is_relative_to((ROOT/'build').resolve()) or output.exists():
parser.error('Use a new output inside build/')
output.mkdir(parents=True)
original=original_sources('coco3-mister')/'rtl/sdc.sv'
candidate=args.project/'rtl/sdc.sv'
core=args.project/'rtl/coco3fpga.sv'
reference=original.read_text();reference=reference[reference.index('module sdc_dpram'):]
text=candidate.read_text();text=text[text.index('module sdc_dpram'):]
# Both CPU RAM address/data/enable expressions must remain identical.
for field in ('address_b','data_b','wren_b'):
pattern=r'\.'+field+r'\(([^\n]+)\)'
if re.search(pattern,original.read_text()).group(1)!=re.search(pattern,candidate.read_text()).group(1):
raise RuntimeError('SDC CPU port changed: '+field)
instance=core.read_text().split('VDAC\tVDAC_inst (',1)[1].split(');',1)[0]
clock=re.search(r'\.wrclock\s*\(\s*([^\)]+)\)',instance).group(1).strip()
if clock!='~clk_sys':raise RuntimeError('Unexpected VDAC write phase')
for field in ('data','wraddress'):
baseline=(original_sources('coco3-mister')/'rtl/coco3fpga.sv').read_text().split('VDAC\tVDAC_inst (',1)[1].split(');',1)[0]
pattern=r'\.'+field+r'\s*\(([^\n]+)\)'
if re.search(pattern,baseline).group(1)!=re.search(pattern,instance).group(1):raise RuntimeError('VDAC payload changed')
wren=re.search(r'\.wren\s*\(([^\n]+)\)',instance).group(1).strip()
compact=re.sub(r'\s+','',wren)
has_ssc=bool(re.search(r'\bssc_cartridge\s*#',core.read_text()))
required='VDAC_EN&PH_2&ssc_palette_owner' if has_ssc else 'VDAC_EN&PH_2'
if compact!=required:raise RuntimeError('Unexpected VDAC address ownership qualification')
source=output/'actual-memory.sv'
source.write_text(reference.replace('module sdc_dpram','module sdc_reference',1)+'\n'+text+
'\nmodule actual_vdac_clock(input clk_sys,output q); assign q='+clock+'; endmodule\n'+
'\nmodule actual_vdac_write(input PH_2,VDAC_EN,ssc_palette_owner,output q,output supports_ssc); assign q='+wren+
"; assign supports_ssc=1'b"+str(int(has_ssc))+'; endmodule\n',encoding='utf-8')
bench=ROOT/'tests/peripheral_phase_tb.sv'
env=os.environ.copy();env['PATH']=os.pathsep.join([str(args.suite/'bin'),str(args.suite/'lib'),env['PATH']])
ext='.exe' if os.name=='nt' else ''
with (output/'compile.log').open('w') as log:
subprocess.run([str(args.suite/'bin'/('iverilog'+ext)),'-g2012','-s','peripheral_phase_tb','-o',str(output/'test.vvp'),str(bench),str(source)],env=env,stdout=log,stderr=subprocess.STDOUT,check=True)
with (output/'test.log').open('w') as log:
subprocess.run([str(args.suite/'bin'/('vvp'+ext)),str(output/'test.vvp')],env=env,stdout=log,stderr=subprocess.STDOUT,check=True)
print((output/'test.log').read_text())
paths=[original,candidate,core,source,bench,Path(__file__),output/'test.log']
(output/'test-result.json').write_text(json.dumps({'passed':True,'hardware_tested':False,'sha256':{str(p):hashlib.sha256(p.read_bytes()).hexdigest() for p in paths}},indent=2)+'\n',encoding='utf-8')
if __name__=='__main__':main()
+76
View File
@@ -0,0 +1,76 @@
#!/usr/bin/env python3
"""Test new request boundary with actual SDRAM controller and complete boot logic."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import re
import subprocess
from source_snapshot import original_sources
ROOT=Path(__file__).resolve().parents[1]
def boot_declarations(text):
constants=re.findall(r'^localparam\s+inst_\w+\s*=[^;]+;',text,re.M)
for declaration in constants:
text=text.replace(declaration,'',1)
position=re.search(r'localparam\s+EE_PROG',text).start()
return text[:position]+'\n'.join(constants)+'\n'+text[position:]
def main():
parser=argparse.ArgumentParser(description=__doc__)
parser.add_argument('project',type=Path)
parser.add_argument('output',type=Path)
parser.add_argument('--suite',type=Path,required=True)
args=parser.parse_args()
output=args.output.resolve()
if not output.is_relative_to((ROOT/'build').resolve()) or output.exists():
parser.error('Use a new output directory inside build/')
output.mkdir(parents=True)
# Icarus does not accept procedural assignment to Quartus's inout reg.
# Model that exact bidirectional driver with an internal reg + continuous wire.
controller=args.project/'rtl/sdram/sdram2.sv'
text=controller.read_text()
text=text.replace('inout reg [15:0] SDRAM_DQ','inout wire [15:0] SDRAM_DQ',1)
text=text.replace('assign SDRAM_nCS = 0;', 'reg [15:0] dq_drive;\nassign SDRAM_DQ = dq_drive;\nassign SDRAM_nCS = 0;',1)
text=text.replace('SDRAM_DQ <=','dq_drive <=')
# Icarus requires these part-select/continuous-assignment operands declared
# before use. Move declarations only, retaining width and all behavior.
declarations=[]
for name in ['command','dq_reg']:
declaration=re.search(r'^reg\s+\[[^\]]+\]\s+'+name+r';',text,re.M).group(0)
text=text.replace(declaration,'',1)
declarations.append(declaration)
text=text.replace('reg [15:0] dq_drive;', '\n'.join(declarations)+'\nreg [15:0] dq_drive;',1)
# The unused board clock-output DDIO primitive has no effect on controller
# state or this bench's constant read bus; model its configured inversion.
text=text[:text.index('\naltddio_out')]+ '\nassign SDRAM_CLK = ~clk;\nendmodule\n'
normalized=output/'sdram-icarus.sv'
normalized.write_text(text,encoding='utf-8')
original=original_sources('coco3-mister')/'rtl/EE_Cold_Bt.v'
reference=output/'boot-reference.v'
reference.write_text(boot_declarations(original.read_text()).replace('module EE_Cold_Bt','module EE_Cold_Bt_reference',1),encoding='utf-8')
boot_candidate=output/'boot-candidate.v'
boot_candidate.write_text(boot_declarations((args.project/'rtl/EE_Cold_Bt.v').read_text()),encoding='utf-8')
env=os.environ.copy()
env['PATH']=os.pathsep.join([str(args.suite/'bin'),str(args.suite/'lib'),env['PATH']])
ext='.exe' if os.name=='nt' else ''
results={}
for name,files in [('bridge_protocol_tb',[ROOT/'tests/bridge_protocol_tb.sv',args.project/'rtl/cpu_sdram_bridge.sv']),('cpu_sdram_bridge_tb',[ROOT/'tests/cpu_sdram_bridge_tb.sv',args.project/'rtl/cpu_sdram_bridge.sv',normalized]),('boot_control_tb',[ROOT/'tests/boot_control_tb.sv',boot_candidate,reference])]:
with (output/(name+'-compile.log')).open('w') as file:
subprocess.run([str(args.suite/'bin'/('iverilog'+ext)),'-g2012','-s',name,'-o',str(output/(name+'.vvp')),*map(str,files)],env=env,stdout=file,stderr=subprocess.STDOUT,check=True)
log=output/(name+'.log')
with log.open('w') as file:
subprocess.run([str(args.suite/'bin'/('vvp'+ext)),str(output/(name+'.vvp'))],env=env,stdout=file,stderr=subprocess.STDOUT,check=True)
print(log.read_text(),flush=True)
results[name]={'sha256':{str(p):hashlib.sha256(p.read_bytes()).hexdigest() for p in [*files,log]}}
results['hardware_tested']=False
results['sdram_model_limit']='Actual RTL controller; inout-reg driver adaptation and unused clock-output DDIO model; constant read bus, no physical SDRAM array/timing model'
(output/'test-result.json').write_text(json.dumps(results,indent=2)+'\n',encoding='utf-8')
if __name__=='__main__':main()
+79
View File
@@ -0,0 +1,79 @@
#!/usr/bin/env python3
"""Test exact consumer reset chains and disk-buffer pipeline cadence contracts."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import subprocess
ROOT=Path(__file__).resolve().parents[1]
def main():
parser=argparse.ArgumentParser(description=__doc__)
parser.add_argument('project',type=Path)
parser.add_argument('output',type=Path)
parser.add_argument('--suite',type=Path,required=True)
args=parser.parse_args()
output=args.output.resolve()
if not output.is_relative_to((ROOT/'build').resolve()) or output.exists():parser.error('Use a new output directory inside build/')
output.mkdir(parents=True)
core=(args.project/'rtl/coco3fpga.sv').read_text()
start=core.index('(* preserve *) reg [1:0] reset_main_release')
end=core.index('reg\t\t[6:0]\tCPU_RESET_SM;',start)
block=core[start:end]
for name in ['RESET_N','RESET_POS_N','RESET_FAST_N']:
block=block.replace('wire '+name+' =','assign '+name+' =')
stages='module actual_reset_domains(input clk_sys,CLK_114,RESET_RAW_N,output RESET_N,RESET_POS_N,RESET_FAST_N);\n'+block+'\nendmodule\n'
fdc=(args.project/'rtl/fdc.sv').read_text()
start=fdc.index('(* preserve *) reg [1:0] wd_reset_release')
end=fdc.index('always@',start)
stages+='module actual_wd_release(input CLK,RESET_N,output WD_RESET_N);\n'+fdc[start:end]+'\nassign WD_RESET_N=wd_reset_release[1];\nendmodule\n'
if '// Research: matching fast-clock' in core:
start=core.index('// Research: matching fast-clock')
end=core.index('localparam Sz_512K',start)
block=core[start:end].replace('reg data_ready_phase;','').replace('reg [15:0] hold_data_phase;','')
stages+='module actual_completion(input CLK_114,clear_data_ready,sdram_cpu_ready,input [15:0] sdram_dout,output reg data_ready_phase,output reg [15:0] hold_data_phase);\nreg data_ready;reg [15:0] hold_data;\n'+block+'\nendmodule\n'
sdc=(args.project/'rtl/sdc.sv').read_text()
wd=(args.project/'rtl/wd1793.sv').read_text()
if '(* preserve *) reg [7:0] cpu_buffer_pipe;' in sdc:
start=sdc.index('(* preserve *) reg [7:0] cpu_buffer_pipe;')
end=sdc.index('sdc_dpram hd_buff',start)
stages+='module actual_sdc_pipeline(input CLK,input [7:0] hd_buff_data_raw,output [7:0] hd_buff_data);\n'+sdc[start:end]+'\nendmodule\n'
else:
assert '.q_b(hd_buff_data)' in sdc and 'always_ff@(negedge clock)' in sdc
stages+='module actual_sdc_pipeline(input CLK,input [7:0] hd_buff_data_raw,output [7:0] hd_buff_data); assign hd_buff_data=hd_buff_data_raw; endmodule\n'
if '(* preserve *) reg [7:0] cpu_buffer_pipe;' in wd:
start=wd.index('(* preserve *) reg [7:0] cpu_buffer_pipe;')
end=wd.index('always @*',start)
stages+='module actual_wd_pipeline(input clk_sys,RWMODE,input [7:0] buff_dout,buff_din,output [7:0] q);\n'+wd[start:end]+'\nassign q=cpu_buffer_pipe;\nendmodule\n'
else:
assert 'buff_rd ? (RWMODE ? buff_dout : buff_din) :' in wd
stages+='module actual_wd_pipeline(input clk_sys,RWMODE,input [7:0] buff_dout,buff_din,output [7:0] q); assign q=RWMODE?buff_dout:buff_din; endmodule\n'
# Verify the actual wrapper inversion, not just the leaf module clock name.
for name,count in [('fdc.sv',4),('sdc_top.sv',2)]:
if (args.project/'rtl'/name).read_text().count('.clk_sys(~CLK)')!=count:raise RuntimeError('WD clock binding changed')
stages+=sdc[sdc.index('module sdc_dpram'):]+'\n'+wd[wd.index('module wd1793_dpram'):]
source=output/'actual-domains-buffers.sv';source.write_text(stages,encoding='utf-8')
env=os.environ.copy();env['PATH']=os.pathsep.join([str(args.suite/'bin'),str(args.suite/'lib'),env['PATH']])
ext='.exe' if os.name=='nt' else '';results={}
cases=[('domains','reset_domains_tb',False),('buffers','disk_buffer_pipeline_tb',False),('buffers-negative','disk_buffer_pipeline_tb',True)]
if 'module actual_completion' in stages:cases.append(('completion','completion_phase_tb',False))
for name,top,negative in cases:
bench=ROOT/'tests'/(top+'.sv')
with (output/(name+'-compile.log')).open('w') as log:
subprocess.run([str(args.suite/'bin'/('iverilog'+ext)),'-g2012',*(['-DNEGATIVE_CONSECUTIVE'] if negative else []),'-s',top,'-o',str(output/(name+'.vvp')),str(bench),str(source)],env=env,stdout=log,stderr=subprocess.STDOUT,check=True)
log=output/(name+'.log')
with log.open('w') as file:run=subprocess.run([str(args.suite/'bin'/('vvp'+ext)),str(output/(name+'.vvp'))],env=env,stdout=file,stderr=subprocess.STDOUT)
text=log.read_text();print(text,flush=True)
if negative:
if run.returncode==0 or not any(message in text for message in ['CPU observed stale disk buffer','unsupported consecutive CPU disk read']):raise RuntimeError('Unsupported consecutive-enable negative control missing')
print('PASS negative control: CPU buffer read phases require the proven nonconsecutive enable contract')
elif run.returncode:raise RuntimeError('Regression failed: '+name)
results[name]={'exit':run.returncode,'sha256':{str(p):hashlib.sha256(p.read_bytes()).hexdigest() for p in [bench,source,log]}}
results['hardware_tested']=False
(output/'test-result.json').write_text(json.dumps(results,indent=2)+'\n',encoding='utf-8')
if __name__=='__main__':main()
+78
View File
@@ -0,0 +1,78 @@
#!/usr/bin/env python3
"""Test actual prepared core SSC instantiations, without replacing chip logic."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import re
import subprocess
import threading
from validation_common import ROOT,digest
from rom_inputs import ROM_IDENTITIES,verified_rom
def main():
parser=argparse.ArgumentParser(description=__doc__)
parser.add_argument('project',type=Path);parser.add_argument('output',type=Path);parser.add_argument('--suite',type=Path,required=True)
args=parser.parse_args();project=args.project.resolve();output=args.output.resolve();suite=args.suite.resolve()
if output.exists() or not output.is_relative_to((ROOT / 'build').resolve()):parser.error('Use a fresh build/ output')
output.mkdir(parents=True);core=project / 'rtl/coco3fpga.sv';text=core.read_text()
top=project / 'CoCo3.sv';top_text=top.read_text()
pll=re.search(r'\bpll\s+pll\s*\((.*?)\);',top_text,re.S)
lock=re.search(r'\.locked\(\s*(\w+)\s*\)',pll[1]) if pll else None
reset_binding=re.search(r'\.SSC_POWER_RESET\(ssc_power_reset\)',top_text)
if not lock or not reset_binding or not re.search(r'always\s*@\(posedge clk_sys or negedge '+re.escape(lock[1])+r'\)\s*if\(!'+re.escape(lock[1])+r'\) ssc_power_release <= 2\x27b00;',top_text):
raise RuntimeError('SSC power reset is not driven by the actual core PLL lock output')
if "else ssc_power_release <= {ssc_power_release[0],1'b1};" not in top_text or 'wire ssc_power_reset = !ssc_power_release[1];' not in top_text:
raise RuntimeError('SSC power reset release contract changed')
if not re.search(r'\.SSC_MODE\(status\[42\]\)',top_text):raise RuntimeError('SSC menu mode binding changed')
if not re.search(r'assign\s+DATA_IN\s*=\s*ssc_read_valid\s*\?\s*ssc_read_data\s*:',text):raise RuntimeError('SSC CPU read-priority binding changed')
declarations=text[text.index('wire ssc_palette_owner,'):text.index('wire [15:0] ssc_legacy_left,ssc_legacy_right;')+len('wire [15:0] ssc_legacy_left,ssc_legacy_right;')]
body=text[text.index('assign ssc_legacy_left ='):text.index('.debug_pc(ssc_debug_pc));')+len('.debug_pc(ssc_debug_pc));')]
routing=''
if 'bh_mpi_router mpi_router' in text:
start=text.index('wire [2:0] mpi_rom_kind,mpi_io_kind;')
end=text.index("wire [7:0] mpi_orch_right=mpi_orchestra_present?ORCH_RIGHT:8'h80;",start)
routing="wire MPI_BOOT_LOADING=0;\nwire [1:0] MPI_CTS=0,MPI_SCS=0;\n"+text[start:end+len("wire [7:0] mpi_orch_right=mpi_orchestra_present?ORCH_RIGHT:8'h80;")]
generated=output / 'actual-bindings.sv'
power_start=top_text.index('(* preserve, altera_attribute',top_text.index('// Cartridge ROM validity'))
power_end=top_text.index('wire ssc_power_reset = !ssc_power_release[1];',power_start)+len('wire ssc_power_reset = !ssc_power_release[1];')
power_block=top_text[power_start:power_end].replace('wire ssc_power_reset =','assign ssc_power_reset =')
generated.write_text('module actual_ssc_power_reset(input clk_sys,'+lock[1]+',output ssc_power_reset);\n'+power_block+'\nendmodule\n'+'''module actual_ssc_mister_system(input clk_sys,SSC_POWER_RESET,RESET_POS_N,SSC_MODE,PH_2,RW_N,
input [15:0] ADDRESS,input [7:0] DATA_OUT,input [11:0] MPI_LAYOUT,input ioctl_download,ioctl_wr,input [15:0] ioctl_index,
input [24:0] ioctl_addr,input [7:0] ioctl_data,input SOUND_EN,input [1:0] SEL,
input [7:0] ORCH_LEFT,ORCH_RIGHT,SOUND,output SSC_READY,SSC_FAULT,
output [15:0] SOUND_LEFT,SOUND_RIGHT,output READ_VALID,output [7:0] READ_DATA,output PALETTE_OWNER);
'''+routing+'\n'+declarations+'\n'+body+'''
assign READ_VALID=ssc_read_valid;assign READ_DATA=ssc_read_data;assign PALETTE_OWNER=ssc_palette_owner;
endmodule
''',encoding='utf-8',newline='\n')
folder=project / 'rtl/ssc';sources=sorted(folder.glob('*.sv'));bench=ROOT / 'tests/ssc_mister_system_tb.sv'
if routing:sources.append(project/'rtl/bh_mpi_router.sv')
paths=[Path(__file__),ROOT / 'scripts/validation_common.py',ROOT / 'scripts/rom_inputs.py',core,top,generated,bench,*sources,*folder.glob('*.vh')]
hashes={str(p):digest(p) for p in paths};roms=ROOT / 'roms/ssc'
identities={name:verified_rom(roms / name,value) for name,value in ROM_IDENTITIES.items()}
env=os.environ.copy();env['PATH']=os.pathsep.join([str(suite / 'bin'),str(suite / 'lib'),env['PATH']]);ext='.exe' if os.name=='nt' else '';binary=output / 'system.vvp'
with (output / 'compile.log').open('w') as log:
subprocess.run([str(suite / 'bin' / ('iverilog'+ext)),'-g2012','-I',str(folder),'-s','ssc_mister_system_tb','-o',str(binary),str(bench),str(generated),*map(str,sources)],env=env,stdout=log,stderr=subprocess.STDOUT,check=True)
process=subprocess.Popen([str(suite / 'bin' / ('vvp'+ext)),str(binary),'+PIC_PATH='+(roms / 'pic-7040-510.bin').as_posix(),'+SPEECH_PATH='+(roms / 'sp0256-al2.bin').as_posix()],cwd=output,env=env,stdout=subprocess.PIPE,stderr=subprocess.STDOUT,text=True,bufsize=1)
timer=threading.Timer(900,process.kill);timer.start();summary=None
try:
with (output / 'rtl.log').open('w') as log:
for line in process.stdout:
print(line.rstrip(),flush=True);log.write(line);log.flush()
if line.startswith('RESULT '):summary=json.loads(line[7:])
code=process.wait()
finally:
timer.cancel()
if process.poll() is None:process.kill();process.wait()
if code or not summary or not summary['passed']:raise RuntimeError('Actual core SSC bindings failed; inspect rtl.log')
if any(digest(Path(p))!=h for p,h in hashes.items()):raise RuntimeError('Actual core/test source changed during run')
for name,value in ROM_IDENTITIES.items():verified_rom(roms / name,value)
hashes.update({str(p):digest(p) for p in output.glob('*.log')})
(output / 'test-result.json').write_text(json.dumps({'passed':True,'roms':identities,'summary':summary,'sha256':hashes,
'hardware_tested':False,'scope':'Actual extracted prepared-core SSC bindings with real chip RTL; CPU/HPS stimulus, not full CoCo CPU/vendor-IP or physical run'},indent=2)+'\n',encoding='utf-8',newline='\n')
if __name__=='__main__':main()
+106
View File
@@ -0,0 +1,106 @@
#!/usr/bin/env python3
"""Compare real video fetch/controller behavior before and after activation staging."""
import argparse
import hashlib
import json
import os
from pathlib import Path
import re
import subprocess
ROOT = Path(__file__).resolve().parents[1]
def normalize_controller(text, name):
# Same driver/declaration adaptation as test_registered_interfaces.py.
text = text.replace('module sdram_32r8w', 'module ' + name, 1)
text = text.replace('inout reg [15:0] SDRAM_DQ', 'inout wire [15:0] SDRAM_DQ', 1)
declarations = []
for register in ('command', 'dq_reg'):
declaration = re.search(r'^reg\s+\[[^\]]+\]\s+' + register + r';', text, re.M).group()
text = text.replace(declaration, '', 1)
declarations.append(declaration)
text = text.replace('assign SDRAM_nCS = 0;', '\n'.join(declarations) +
'\nreg [15:0] dq_drive;\nassign SDRAM_DQ = dq_drive;\nassign SDRAM_nCS = 0;', 1)
text = text.replace('SDRAM_DQ <=', 'dq_drive <=')
return text[:text.index('\naltddio_out')] + '\nassign SDRAM_CLK = ~clk;\nendmodule\n'
def main():
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument('reference', type=Path)
parser.add_argument('candidate', type=Path)
parser.add_argument('output', type=Path)
parser.add_argument('--suite', type=Path, required=True)
args = parser.parse_args()
output = args.output.resolve()
if not output.is_relative_to((ROOT / 'build').resolve()) or output.exists():
parser.error('Use a fresh output directory inside build/')
output.mkdir(parents=True)
sources = []
for name, project in [('reference', args.reference), ('candidate', args.candidate)]:
path = project / 'rtl/sdram/sdram2.sv'
sources.append(path)
(output / (name + '.sv')).write_text(normalize_controller(path.read_text(), 'sdram_' + name), encoding='utf-8')
fetch = args.candidate / 'rtl/coco_mem_fetch.sv'
sources.append(fetch)
if fetch.read_bytes() != (args.reference / 'rtl/coco_mem_fetch.sv').read_bytes():
raise RuntimeError('This comparison expects an unchanged video fetcher')
text = fetch.read_text()
# Quartus accepts procedural assignment to these implicit output nets;
# Icarus needs the explicit variable type. No expression/state edits.
for name in ('SDRAM_VID_REQ', 'BUFF_ADD', 'BUFF_DATA_O', 'BUFFER_WRITE'):
text, n = re.subn(r'(output\s+)(?!reg)(\[[^\]]+\]\s*)?(' + name + r'\b)', r'\1reg \2\3', text, count=1)
if n != 1:
raise RuntimeError('Unexpected fetch output declaration: ' + name)
text = re.sub(r'wire(\s+\[2:0\]\s+BUF_HBORDER;)', r'reg\1', text, count=1)
(output / 'fetch.sv').write_text(text, encoding='utf-8')
bench = ROOT / 'tests/video_sdram_tb.sv'
env = os.environ.copy()
env['PATH'] = os.pathsep.join([str(args.suite / 'bin'), str(args.suite / 'lib'), env['PATH']])
ext = '.exe' if os.name == 'nt' else ''
command = [str(args.suite / 'bin' / ('iverilog' + ext)), '-g2012', '-s', 'video_sdram_tb',
'-o', str(output / 'test.vvp'), str(bench), *map(str, output.glob('*.sv'))]
for name, project in [('REFERENCE', args.reference), ('CANDIDATE', args.candidate)]:
extra = re.search(r'localparam READ_CAPTURE_EXTRA\s*=\s*(\d+)', (project / 'rtl/sdram/sdram2.sv').read_text())
if extra:
# Model a declared extra return cycle, independently of the FSM.
command.insert(1, '-D' + name + '_RETURN_DELAY=' + str(10 * int(extra[1])))
with (output / 'compile.log').open('w') as log:
subprocess.run(command, env=env, stdout=log, stderr=subprocess.STDOUT, check=True)
with (output / 'test.log').open('w') as log:
subprocess.run([str(args.suite / 'bin' / ('vvp' + ext)), str(output / 'test.vvp')],
env=env, stdout=log, stderr=subprocess.STDOUT, check=True, timeout=180)
print((output / 'test.log').read_text())
# An actual address error must be caught by the data oracle. Keep the
# perturbation solely in this generated simulation copy.
negative = output / 'candidate.sv'
original = negative.read_text()
corrupted, changed = re.subn(r'video_address_snapshot\[24:1\]',
r'{video_address_snapshot[24:2],~video_address_snapshot[1]}', original)
if changed != 1:
raise RuntimeError('Expected exactly one video activation address')
negative.write_text(corrupted, encoding='utf-8')
try:
negative_command = command.copy()
negative_command[negative_command.index('-o') + 1] = str(output / 'negative.vvp')
with (output / 'negative-compile.log').open('w') as log:
subprocess.run(negative_command, env=env, stdout=log, stderr=subprocess.STDOUT, check=True)
with (output / 'negative.log').open('w') as log:
failed = subprocess.run([str(args.suite / 'bin' / ('vvp' + ext)), str(output / 'negative.vvp')],
env=env, stdout=log, stderr=subprocess.STDOUT, timeout=180)
if failed.returncode == 0 or 'video data channel=1' not in (output / 'negative.log').read_text():
raise RuntimeError('Corrupted video-address negative control did not fail as expected')
finally:
negative.write_text(original, encoding='utf-8')
print('PASS negative control: corrupting the candidate video address fails the data oracle')
hashes = {str(p): hashlib.sha256(p.read_bytes()).hexdigest() for p in [*sources, bench, Path(__file__)]}
(output / 'test-result.json').write_text(json.dumps({
'passed': True, 'negative_control_passed': True, 'hardware_tested': False, 'input_sha256': hashes,
'model_limit': 'Logical SDRAM read-command/CL3/two-word burst model; no electrical/device timing or video pixel rendering.',
'log': (output / 'test.log').read_text(),
}, indent=2) + '\n', encoding='utf-8')
if __name__ == '__main__':
main()
+50
View File
@@ -0,0 +1,50 @@
# Fitted UART diagnostics, both timing corners; no changes to project assignments.
# quartus_sta -t uart_timing_paths.tcl PROJECT REVISION OUTPUT_DIRECTORY
package require ::quartus::project
package require ::quartus::sta
set project [lindex $quartus(args) 0]
set revision [lindex $quartus(args) 1]
set output [file normalize [lindex $quartus(args) 2]]
file mkdir $output
project_open $project -revision $revision
foreach model {slow fast} {
create_timing_netlist -model $model
read_sdc
update_timing_netlist
# Include the MiSTer wrapper's enable generator/reset chain, not just RS232.
set uart [get_registers {*RS232|* *COM1|* *|CLK_6551* *|uart_tick_release* dw_top_release[*] dw_mode* dw_base_d COM1_CLOCK* COM1_STATE* COM1_CLK*}]
if {[get_collection_size $uart] == 0} {error "Expected fitted UART registers"}
puts "UART_REGISTERS $model [get_collection_size $uart]"
foreach check {setup hold recovery removal} {
report_timing -$check -npaths 3 -detail full_path \
-file [file join $output global-${model}-${check}.rpt]
report_timing -$check -to $uart -npaths 20 -detail full_path \
-file [file join $output uart-${model}-${check}.rpt]
report_timing -$check -from $uart -npaths 10 -detail full_path \
-file [file join $output uart-out-${model}-${check}.rpt]
}
set cfg [get_registers {*RS232|CTL_REG[*] *RS232|CMD_REG[*] *COM1|CTL_REG[*]}]
report_timing -setup -from $cfg -to $uart -npaths 10 -detail full_path \
-file [file join $output uart-config-${model}-setup.rpt]
report_timing -hold -from $cfg -to $uart -npaths 10 -detail full_path \
-file [file join $output uart-config-${model}-hold.rpt]
if {$model eq "slow"} {
set audit [open [file join $output uart-register-clocks.tsv] w]
puts $audit "register\tclock_pin\tclock_driver"
foreach_in_collection reg $uart {
foreach edge [get_register_info -clock_edges $reg] {
set source [get_edge_info -src $edge]
foreach input_edge [get_node_info -clock_edges $source] {
set driver [get_edge_info -src $input_edge]
puts $audit "[get_register_info -name $reg]\t[get_node_info -name $source]\t[get_node_info -name $driver]"
}
}
}
close $audit
report_clocks -file [file join $output clocks.rpt]
report_ucp -file [file join $output unconstrained.rpt]
report_clock_transfers -file [file join $output clock-transfers.rpt]
}
delete_timing_netlist
}
project_close
+25
View File
@@ -0,0 +1,25 @@
import hashlib, os, shutil, subprocess
from pathlib import Path
ROOT=Path(__file__).resolve().parents[1]
def digest(path):return hashlib.sha256(path.read_bytes()).hexdigest()
def cpp_environment(output):
env = os.environ.copy()
if os.name != 'nt':
return os.environ.get('CXX', 'c++'), env
finder = Path(os.environ.get('ProgramFiles(x86)', r'C:\Program Files (x86)')) / 'Microsoft Visual Studio/Installer/vswhere.exe'
vs = subprocess.check_output([str(finder), '-latest', '-version', '[17.0,18.0)',
'-products', '*', '-requires', 'Microsoft.VisualStudio.Component.VC.Tools.x86.x64',
'-property', 'installationPath'], text=True).strip()
if not vs or any(c in vs for c in '%!"&^<>\r\n'):
raise RuntimeError('No usable VS2022 C++ toolchain')
batch = output / 'vs-environment.cmd'
batch.write_text(f'@echo off\ncall "{vs}/Common7/Tools/VsDevCmd.bat" -arch=x64 -host_arch=x64 >nul\nif errorlevel 1 exit /b %errorlevel%\nset\n', encoding='utf-8')
setup = subprocess.check_output([os.environ.get('COMSPEC', 'cmd.exe'), '/d', '/c', str(batch)], text=True, errors='replace')
# Developer environment may contain private values; never print or save it.
env.update((key.upper(), value) for key, value in
(line.split('=', 1) for line in setup.splitlines() if '=' in line and not line.startswith('=')))
compiler = shutil.which('cl.exe', path=env['PATH'])
if not compiler:
raise RuntimeError('VS environment did not provide cl.exe')
return compiler, env
+43
View File
@@ -0,0 +1,43 @@
# quartus_sta -t video_timing_paths.tcl PROJECT REVISION OUTPUT_DIRECTORY
package require ::quartus::project
package require ::quartus::sta
set project [lindex $quartus(args) 0]
set revision [lindex $quartus(args) 1]
set output [file normalize [lindex $quartus(args) 2]]
file mkdir $output
project_open $project -revision $revision
foreach model {slow fast} {
create_timing_netlist -model $model
read_sdc
update_timing_netlist
set snapshot [get_registers {*coco3_sdram|video_address_snapshot[*]*}]
set fetch [get_registers {*video_fetch|*}]
set controller [get_registers {*coco3_sdram|*}]
set source [get_registers {*MISTER_COCOVID|ROW_ADD[*]* *MISTER_COCOVID|SCREEN_START_ADD[*]*}]
foreach {name collection minimum} [list snapshot $snapshot 20 fetch $fetch 10 controller $controller 40 source $source 20] {
set count [get_collection_size $collection]
puts "VIDEO_SCOPE $model $name $count"
if {$count < $minimum} {error "Incomplete video timing scope: $name"}
}
foreach check {setup hold} {
report_timing -$check -from $source -to $snapshot -npaths 30 -detail full_path \
-file [file join $output address-${model}-${check}.rpt]
report_timing -$check -from $snapshot -to $controller -npaths 30 -detail full_path \
-file [file join $output activation-${model}-${check}.rpt]
report_timing -$check -to $fetch -npaths 30 -detail full_path \
-file [file join $output fetch-in-${model}-${check}.rpt]
report_timing -$check -from $fetch -npaths 30 -detail full_path \
-file [file join $output fetch-out-${model}-${check}.rpt]
report_timing -$check -to $controller -npaths 30 -detail full_path \
-file [file join $output controller-in-${model}-${check}.rpt]
report_timing -$check -from $controller -npaths 30 -detail full_path \
-file [file join $output controller-out-${model}-${check}.rpt]
}
if {$model eq "slow"} {
report_clocks -file [file join $output clocks.rpt]
report_ucp -file [file join $output unconstrained.rpt]
report_exceptions -file [file join $output exceptions.rpt]
}
delete_timing_netlist
}
project_close
+13 -5
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
module i2c module i2c
( (
@@ -24,6 +26,12 @@ parameter CLK_Freq = 50_000_000; // 50 MHz
parameter I2C_Freq = 400_000; // 400 KHz parameter I2C_Freq = 400_000; // 400 KHz
localparam I2C_FreqX2 = I2C_Freq*2; localparam I2C_FreqX2 = I2C_Freq*2;
// Wait >=400 ns after the generated falling edge before changing SDA.
// This covers a fast-mode 300 ns SCL fall plus 40 ns fabric skew; the
// former four-clock (80 ns at 50 MHz) pipeline could change data while the
// external SCL was still high. Minimum two stages keeps the slice valid.
localparam SDA_DELAY_STAGES = (CLK_Freq >= 5_000_000) ?
(CLK_Freq + 2_500_000 - 1)/2_500_000 : 2;
reg I2C_CLOCK; reg I2C_CLOCK;
reg [31:0] cnt; reg [31:0] cnt;
@@ -38,10 +46,10 @@ always @(posedge CLK) begin
end end
assign I2C_SCL = (SCLK | I2C_CLOCK) ? 1'bZ : 1'b0; assign I2C_SCL = (SCLK | I2C_CLOCK) ? 1'bZ : 1'b0;
assign I2C_SDA = SDO[3] ? 1'bz : 1'b0; assign I2C_SDA = SDO[SDA_DELAY_STAGES-1] ? 1'bz : 1'b0;
reg SCLK; reg SCLK;
reg [3:0] SDO; reg [SDA_DELAY_STAGES-1:0] SDO;
reg [0:7] rdata; reg [0:7] rdata;
reg [5:0] SD_COUNTER; reg [5:0] SD_COUNTER;
@@ -51,7 +59,7 @@ initial begin
SD_COUNTER = 'b111111; SD_COUNTER = 'b111111;
SD = 'hFFFF; SD = 'hFFFF;
SCLK = 1; SCLK = 1;
SDO = 4'b1111; SDO = {SDA_DELAY_STAGES{1'b1}};
end end
assign I2C_RDATA = rdata; assign I2C_RDATA = rdata;
@@ -66,11 +74,11 @@ always @(posedge CLK) begin
// delay to make sure SDA changed while SCL is stabilized at low // delay to make sure SDA changed while SCL is stabilized at low
if(old_clk && ~I2C_CLOCK && ~SD_COUNTER[5]) SDO[0] <= SD[SD_COUNTER[4:0]]; if(old_clk && ~I2C_CLOCK && ~SD_COUNTER[5]) SDO[0] <= SD[SD_COUNTER[4:0]];
SDO[3:1] <= SDO[2:0]; SDO[SDA_DELAY_STAGES-1:1] <= SDO[SDA_DELAY_STAGES-2:0];
if(~old_st && START) begin if(~old_st && START) begin
SCLK <= 1; SCLK <= 1;
SDO <= 4'b1111; SDO <= {SDA_DELAY_STAGES{1'b1}};
ACK <= 0; ACK <= 0;
END <= 0; END <= 0;
rd <= READ; rd <= READ;
+5 -1
View File
@@ -1,3 +1,5 @@
// Original Coco 3 Plus contributions: Copyright (c) 2026 Brian K. Holman.
// Original component notices/terms retained; see COPYRIGHT.md and LICENSING.md.
// //
// MCP23009 // MCP23009
// (C) 2019 Alexey Melnikov // (C) 2019 Alexey Melnikov
@@ -24,7 +26,9 @@ reg rw;
wire [7:0] dout; wire [7:0] dout;
reg [15:0] din; reg [15:0] din;
i2c #(50_000_000, 500_000) i2c // Fast-mode profile: symmetric 2 us half-periods leave margin for the
// specified 1.3 us minimum low time, finite board edges and FPGA propagation.
i2c #(50_000_000, 250_000) i2c
( (
.CLK(clk), .CLK(clk),
.START(start), .START(start),
+120
View File
@@ -0,0 +1,120 @@
`timescale 1ns/1ps
module bh_mpi_core_tb;
reg clk=0;always #5 clk=~clk;
reg power=1,reset_n=0,cart=0,internal_rom=1,commit=0,rnw=1;
reg [15:0] address=0;reg [1:0] rom_mode=0;reg [9:0] switches=6;
reg [7:0] cpu_data=0;reg [11:0] layout={3'd1,3'd1,3'd1,3'd1};
reg boot_loading=0,download=0,wr=0;reg [15:0] file_index=6;
reg [24:0] file_address=0;reg [7:0] file_data=0;
reg ext_response=0,ser_irq=1,amw_trigger=0,amw_ready=0,amw_en=0;
wire [7:0] flash;wire fd,sd,serial,bankport,loading,loaded,restart,cart_irq;
wire [3:0] fault;wire [1:0] scs,cts;
actual_mpi_core dut(clk,power,reset_n,cart,internal_rom,commit,rnw,address,
rom_mode,switches,cpu_data,layout,boot_loading,download,wr,file_index,file_address,file_data,
ext_response,ser_irq,amw_trigger,amw_ready,amw_en,flash,fd,sd,serial,bankport,
fault,loading,loaded,restart,scs,cts,cart_irq);
integer n,i,j,c,r;
reg [7:0] expected;
function [7:0] pattern(input integer slot,input integer pos);
begin pattern=(slot*41)^(pos>>14)^8'hc7;end
endfunction
task tick;begin @(negedge clk);#1;end endtask
task write_port(input [15:0] port,input [7:0] value);
begin @(posedge clk);address=port;cpu_data=value;commit=1;rnw=0;tick;
@(posedge clk);commit=0;rnw=1;end
endtask
task route(input integer romslot,input integer ioslot);
begin write_port(16'hff7f,(romslot<<4)|ioslot);tick;
if(cts!==romslot[1:0]||scs!==ioslot[1:0])$fatal(1,"Independent FF7F selectors");end
endtask
task read_rom(input integer slot,input integer bank);
begin cart=1;internal_rom=0;address=16'hc100;rom_mode=0;repeat(2)tick;
expected=pattern(slot,bank*16384);
if(flash!==expected)$fatal(1,"Core ROM/bank mapping slot=%0d bank=%0d got=%h exp=%h",slot,bank,flash,expected);
cart=0;internal_rom=1;end
endtask
initial begin
repeat(4)tick;power=0;reset_n=1;repeat(3)tick;
if(cts!==3||scs!==3)$fatal(1,"Startup slot reset");
// Original Main parses remembered FC files before loading the saved layout.
// Slot4 defaults to floppy but the persisted layout makes it a program ROM.
boot_loading=1;layout={3'd2,3'd1,3'd3,3'd6};repeat(3)tick;
@(posedge clk);file_index=9;download=1;wr=1;file_address=0;file_data=pattern(3,0);tick;
@(posedge clk);wr=0;download=0;repeat(4)tick;
if(dut.mpi_rom_valid[3]!==1'b1)$fatal(1,"FC9 lost before saved layout restoration");
layout={3'd1,3'd2,3'd3,3'd6};repeat(3)tick;boot_loading=0;repeat(3)tick;
route(3,3);read_rom(3,0);
// Other remembered files must be discarded if their final socket is absent.
boot_loading=1;layout[5:3]=0;repeat(3)tick;
@(posedge clk);file_index=7;download=1;wr=1;file_address=0;file_data=pattern(1,0);tick;
@(posedge clk);wr=0;download=0;repeat(4)tick;
if(dut.mpi_rom_valid[1]!==1'b1)$fatal(1,"Startup staging did not retain FC7");
boot_loading=0;repeat(3)tick;
if(dut.mpi_rom_valid[1]!==1'b0||dut.mpi_program_roms.owned[1]!==0)
$fatal(1,"Inactive remembered ROM survived final layout");
layout={3'd1,3'd1,3'd1,3'd1};repeat(3)tick;
for(n=0;n<4;n=n+1)begin
@(posedge clk);file_index=6+n;download=1;wr=0;tick;
for(i=0;i<65536;i=i+1)begin
@(posedge clk);wr=1;file_address=i;file_data=pattern(n,i);tick;
end
@(posedge clk);wr=0;download=0;repeat(3)tick;
end
if(fault!==0)$fatal(1,"Program transfer fault");
// Cold-start request must survive an arbitrarily delayed reset/sequencer.
repeat(100)tick;if(!dut.mpi_rom_cold_pending||restart)$fatal(1,"Restart pending lost/early");
amw_ready=1;#1;if(restart!==1'b1)$fatal(1,"Ready sequencer missed deferred restart");
amw_en=1;tick;amw_en=0;tick;if(restart)$fatal(1,"Restart did not retire on consume");
for(n=0;n<4;n=n+1)begin
route(n,n);write_port(16'hff40,n);tick;
end
for(c=0;c<4;c=c+1)for(r=0;r<4;r=r+1)begin
route(c,r);write_port(16'hff40,r);read_rom(c,c);
address=16'hff40;#1;
if(bankport!==1'b1||dut.rom_banks[r]!==r[2:0])$fatal(1,"I/O bank route follows wrong socket");
end
// Ordinary reset preserves inserted ROM bytes and zeroes each bank.
reset_n=0;repeat(3)tick;reset_n=1;repeat(3)tick;
for(n=0;n<4;n=n+1)begin route(n,0);read_rom(n,0);end
// Move each storage controller through every slot, retaining separate CTS.
for(n=0;n<4;n=n+1)begin
layout=0;layout[n*3+:3]=2;
for(c=0;c<4;c=c+1)for(r=0;r<4;r=r+1)begin
route(c,r);address=16'hff48;#1;
if(fd!==(r==n)||sd!==1'b0)$fatal(1,"Moved floppy decode");
address=16'hff68;#1;if(serial!==(r==n))$fatal(1,"Serial companion decode");
cart=1;internal_rom=0;address=16'hc100;repeat(2)tick;
if(flash!==(c==n?8'hd4:8'hff))$fatal(1,"Disk/empty ROM decode");
cart=0;internal_rom=1;
end
layout[n*3+:3]=3;
for(r=0;r<4;r=r+1)begin
route(0,r);address=16'hff48;#1;
if(sd!==(r==n)||fd!==1'b0)$fatal(1,"Moved SDC decode");
end
end
// The inherited OS9 SDC response workaround remains conditional on presence.
layout={3'd2,3'd0,3'd3,3'd0};route(3,3);address=16'hff48;ext_response=1;#1;
`ifdef CoCo3_sdc_fix_os9_driver
if(fd||!sd)$fatal(1,"OS9 SDC response priority lost");
`else
if(!fd||sd)$fatal(1,"Unexpected OS9 override in ordinary build");
`endif
layout={3'd2,3'd0,3'd0,3'd0};#1;if(!fd||sd)$fatal(1,"Absent SDC stole disk I/O");
ext_response=0;
// A separately routed serial controller must still deliver its active-low
// interrupt while a program ROM owns CTS.
layout={3'd2,3'd1,3'd0,3'd0};route(2,3);
// Those earlier ROMs were intentionally removed by the device-layout tests.
// Insert a fresh program image before testing its concurrent serial IRQ.
@(posedge clk);file_index=8;download=1;wr=1;file_address=0;file_data=pattern(2,0);tick;
@(posedge clk);wr=0;download=0;repeat(4)tick;
if(!dut.mpi_rom_valid[2])$fatal(1,"Reinserted ROM did not load");
ser_irq=0;commit=1;repeat(3)tick;
if(cart_irq!==1'b0)$fatal(1,"ROM presence masked serial IRQ");
ser_irq=1;commit=0;
$display("PASS actual core MPI bindings: independent selectors/banks, four images, moved controllers, empty bus, OS9 compatibility, deferred restart and reset retention");
$finish;
end
initial begin #10000000;$fatal(1,"Core binding watchdog");end
endmodule
+57
View File
@@ -0,0 +1,57 @@
`timescale 1ns/1ps
// Original Main init: reset1, FC4/5/6/9 with status polls after each transfer,
// restore saved configuration with reset1, then Main's own reset0 release.
module bh_mpi_startup_tb;
reg clk=0;always #5 clk=~clk;
reg power=1;reg [63:0] requested=0;
wire [63:0] accepted,status_in;wire status_set;
bh_mpi_config cfg(clk,power,requested,accepted,status_in,status_set);
reg pending=0;reg [63:0] pending_value;
always @(posedge clk)if(status_set)begin pending<=1;pending_value<=status_in;end
reg download=0,wr=0;reg [15:0] file_index=0;
reg [24:0] file_address=0;reg [7:0] file_data=0;
wire [7:0] flash;wire [3:0] fault;
actual_mpi_core dut(.clk_sys(clk),.SSC_POWER_RESET(power),.RESET_N(!power),
.CART_SEL(1'b1),.ROM_SEL(1'b0),.PH_2(1'b0),.RW_N(1'b1),.ADDRESS(16'hc000),
.ROM(2'b0),.SWITCH(10'd6),.DATA_OUT(8'd0),.MPI_LAYOUT(accepted[54:43]),
.MPI_BOOT_LOADING(accepted[0]),.ioctl_download(download),.ioctl_wr(wr),
.ioctl_index(file_index),.ioctl_addr(file_address),.ioctl_data(file_data),
.ext_response(1'b0),.SER_IRQ(1'b1),.AMW_Trigger(1'b0),.AMW_Ready(1'b0),
.AMW_EN(1'b0),.FLASH_DATA(flash),.MPI_ROM_FAULT(fault));
task tick;begin @(negedge clk);#1;end endtask
task host_poll;
begin
repeat(4)tick;
if(pending)begin
@(posedge clk);#1;requested=pending_value&~64'd1;pending=0;
repeat(4)tick;
end
end
endtask
task stream(input [15:0] index,input [7:0] value);
begin
@(posedge clk);#1;file_index=index;download=1;wr=1;file_address=0;file_data=value;
tick;
@(posedge clk);#1;download=0;wr=0;repeat(5)tick;
host_poll;
end
endtask
initial begin
repeat(4)tick;@(posedge clk);#1;power=0;requested=1;repeat(8)tick;
stream(4,8'h11);
if(requested[0]!==1'b1)$fatal(1,"Main status acknowledgement cleared init reset after FC4");
stream(5,8'h22);stream(6,8'ha1);stream(9,8'hd4);
if(dut.mpi_rom_valid!==4'b1001)$fatal(1,"Startup streams discarded before saved layout: valid=%b fault=%b status=%h enabled=%b",dut.mpi_rom_valid,fault,accepted,dut.mpi_rom_enabled);
// Final saved layout differs from initial defaults: FD3 and ROM4.
@(posedge clk);#1;requested=accepted;
requested[54:43]={3'd1,3'd2,3'd3,3'd6};requested[13:12]=2;
repeat(8)tick;host_poll;
if(!requested[0])$fatal(1,"Premature status acknowledgement during saved reset");
@(posedge clk);#1;requested[0]=0;repeat(10)tick;host_poll;
if(accepted[54:43]!=={3'd1,3'd2,3'd3,3'd6}||dut.mpi_rom_valid!==4'b1001||fault!==0)
$fatal(1,"Restored layout/ROMs lost or stale migration overwrote configuration");
$display("PASS actual core MPI bindings: original Main init/status polls retain FC6/FC9 through saved layout restoration");
$finish;
end
initial begin #100000;$fatal(1,"Main startup ordering watchdog");end
endmodule
+148
View File
@@ -0,0 +1,148 @@
`timescale 1ns/1ps
module bh_mpi_tb;
reg clk=0;always #5 clk=~clk;
reg reset=1;
reg [63:0] requested=0;
wire [63:0] accepted,status_in;wire status_set;
bh_mpi_config cfg(clk,reset,requested,accepted,status_in,status_set);
reg [11:0] layout=0;reg [1:0] cts=0,scs=0;
wire [2:0] rk,ik;wire fd,sd,rom,serial,ssc,orch,fdp,sdp;
bh_mpi_router router(layout,cts,scs,rk,ik,fd,sd,rom,serial,ssc,orch,fdp,sdp);
reg [1:0] read_slot=0;reg [16:0] read_address=0;
reg download=0,wr=0;reg [7:0] file_index=0,data=0;
reg [24:0] address=0;wire [7:0] read_data;
wire loading,loaded;wire [3:0] valid,fault;
reg [3:0] enabled=15;
bh_mpi_rom memory(clk,reset,read_slot,read_address,read_data,
download,wr,file_index,address,data,loading,valid,fault,loaded,enabled);
integer l,c,s,n,k,j,routes=0;
reg [2:0] a,b;
reg expect_ssc,expect_orch,expect_fd,expect_sd;
reg [63:0] next_request,saved;
reg [7:0] expected_byte;
function [7:0] pattern(input integer slot,input integer location);
begin pattern=(location>>8)^(location>>14)^(slot*71)^8'h96;end
endfunction
task tick;begin @(posedge clk);#1;end endtask
task apply(input [63:0] value);
begin @(negedge clk);requested=value;repeat(8)tick;end
endtask
task change(input integer slot,input [2:0] device);
begin next_request=accepted;next_request[43+slot*3+:3]=device;apply(next_request);end
endtask
task boot;
begin @(negedge clk);reset=1;download=0;wr=0;repeat(3)tick;
@(negedge clk);reset=0;repeat(3)tick;end
endtask
task stream(input integer slot,input integer length,input integer bad_at);
begin
@(negedge clk);file_index=6+slot;download=1;wr=0;tick;
for(k=0;k<length;k=k+1)begin
@(negedge clk);wr=1;address=k+(k==bad_at?1:0);data=pattern(slot,k);tick;
end
@(negedge clk);wr=0;download=0;repeat(3)tick;
end
endtask
task verify_byte(input integer slot,input integer offset,input integer physical);
begin
@(negedge clk);read_slot=slot;read_address=offset;repeat(2)tick;
expected_byte=pattern(slot,physical);
if(read_data!==expected_byte)$fatal(1,"ROM data slot=%d off=%h expected=%h got=%h",slot,offset,expected_byte,read_data);
end
endtask
initial begin
layout=12'hfff;#1;
// Independent exhaustive layout oracle: all4096 layouts,16 separate ROM/I/O routes.
for(l=0;l<4096;l=l+1)begin
layout=l;expect_ssc=0;expect_orch=0;expect_fd=0;expect_sd=0;
for(n=0;n<4;n=n+1)begin
a=(l>>(n*3))&7;
if(a==4||a==6)expect_ssc=1;
if(a==5||a==6)expect_orch=1;
if(a==2)expect_fd=1;
if(a==3)expect_sd=1;
end
for(c=0;c<4;c=c+1)for(s=0;s<4;s=s+1)begin
cts=c;scs=s;#1;a=(l>>(c*3))&7;b=(l>>(s*3))&7;
if(rk!==a||ik!==b||fd!==(b==2)||sd!==(b==3)||
rom!==((b==1)||(b==5)||(b==6))||serial!==((b==2)||(b==3)||(b==7))||
ssc!==expect_ssc||orch!==expect_orch||fdp!==expect_fd||sdp!==expect_sd)
$fatal(1,"Routing layout=%h cts=%d scs=%d",layout,c,s);
routes=routes+1;
end
end
boot;
if(accepted[63]!==1'b1||accepted[54:43]!=={3'd2,3'd1,3'd3,3'd6})
$fatal(1,"Initial all-zero configuration did not migrate");
apply(64'd1);
repeat(10)begin tick;if(status_set)$fatal(1,"Premature initialization status request");end
apply(64'd0);
for(n=0;n<4;n=n+1)begin
next_request=64'h0000000000020148;next_request[13:12]=n;
apply(next_request);
if(!accepted[63]||accepted[13:12]!==((n+1)&3)||
accepted[54:43]!=={3'd2,3'd1,3'd3,3'd6}||
accepted[31:16]!==next_request[31:16])$fatal(1,"Legacy status migration");
saved=accepted;repeat(10)tick;
if(accepted!==saved)$fatal(1,"Migration changed while host status stable");
apply(saved);
if(accepted!==saved)$fatal(1,"Host acknowledgement was not idempotent");
end
change(0,2); // Move floppy from slot4 into slot1, dropping that slot's legacy audio.
if(accepted[45:43]!==2||accepted[54:52]!==0)$fatal(1,"Singleton controller did not move");
for(n=0;n<4;n=n+1)change(n,1);
if(accepted[54:43]!=={3'd1,3'd1,3'd1,3'd1})$fatal(1,"ROM slots are not independent");
next_request=accepted;next_request[54:43]={3'd2,3'd1,3'd3,3'd6};apply(next_request);
change(2,4); // Moving SSC out of combined audio leaves Orchestra behind.
if(accepted[45:43]!==5||accepted[51:49]!==4||!accepted[42])$fatal(1,"SSC move/ownership split");
change(1,5);
if(accepted[45:43]!==0||accepted[48:46]!==5)$fatal(1,"Orchestra singleton move");
for(n=0;n<4;n=n+1)change(n,0);
if(accepted[54:43]!==0||accepted[42])$fatal(1,"Empty layout retains phantom device");
boot;
for(n=0;n<4;n=n+1)begin
read_slot=n;repeat(2)tick;if(read_data!==8'hff)$fatal(1,"Empty socket not open bus");
stream(n,65536,-1);
end
if(valid!==4'b1111||fault!==0)$fatal(1,"Four64K ROMs not loaded");
for(n=0;n<4;n=n+1)for(j=0;j<4;j=j+1)verify_byte(n,j*16384+371,j*16384+371);
stream(0,131072,-1); // Capacity failure must not overwrite the other three ROMs.
if(valid!==4'b1110||!fault[0])$fatal(1,"Capacity failure was not isolated");
for(n=1;n<4;n=n+1)verify_byte(n,32791,32791);
stream(0,8192,-1);verify_byte(0,7371,7371);verify_byte(0,7371+65536,7371);
stream(0,32,7);
if(valid[0]||!fault[0])$fatal(1,"Nonsequential transfer accepted");
for(n=1;n<4;n=n+1)verify_byte(n,49167,49167);
boot;stream(0,131072,-1);stream(1,131072,-1);
if(valid!==4'b0011)$fatal(1,"Two128K ROMs not loaded");
for(n=0;n<2;n=n+1)for(j=0;j<8;j=j+1)verify_byte(n,j*16384+813,j*16384+813);
stream(2,1,-1);if(!fault[2]||valid[2])$fatal(1,"Full pool did not refuse load");
verify_byte(0,123879,123879);verify_byte(1,123879,123879);
enabled[1]=0;repeat(3)tick;
if(valid[1]||fault[1])$fatal(1,"Removed ROM retained occupancy/fault");
stream(2,131072,-1);verify_byte(0,123879,123879);verify_byte(2,123879,123879);
enabled[2]=0;repeat(3)tick;stream(2,16,-1);
if(valid[2]||fault[2])$fatal(1,"Inactive remembered ROM was loaded");
enabled=15;
// Removing a different socket on a failed transfer's completion edge must
// release both owners; otherwise the cleared owner's blocks leak forever.
boot;stream(0,131072,-1);
@(negedge clk);file_index=7;download=1;wr=1;address=1;data=0;tick;
@(negedge clk);download=0;wr=0;tick;
@(negedge clk);enabled[0]=0;tick;repeat(3)tick;
if(valid[0]||!fault[1])$fatal(1,"Concurrent removal/failure state");
enabled=15;stream(2,131072,-1);stream(3,131072,-1);
if(valid!==4'b1100)$fatal(1,"Concurrent removal/failure leaked pool blocks");
boot;stream(3,131073,-1);
if(valid[3]||!fault[3])$fatal(1,"Oversized ROM accepted");
stream(3,128,-1);verify_byte(3,32779,11);
// Old index1 remains an alias for the third slot, without changing other stores.
@(negedge clk);file_index=1;download=1;wr=1;address=0;data=8'h5a;tick;
@(negedge clk);download=0;wr=0;repeat(3)tick;
read_slot=2;read_address=0;repeat(2)tick;
if(!valid[2]||read_data!==8'h5a)$fatal(1,"Legacy cartridge index alias");
$display("PASS %0d routing combinations, migration/moves, four ROMs, banking, mirrors, capacity and malformed-load isolation",routes);
$finish;
end
initial begin #30000000;$fatal(1,"MPI test timeout");end
endmodule
+34
View File
@@ -0,0 +1,34 @@
`timescale 1ns/1ps
module boot_control_tb;
reg clk=0,reset=1,display=0,cold=0;
always #5 clk=~clk;
wire actual_reset_n,actual_ee,reference_reset_n,reference_ee;
reg [1:0] delayed_display=0,delayed_cold=0;
always @(posedge clk or posedge reset)
if(reset) begin delayed_display<=0;delayed_cold<=0;end
else begin delayed_display<={delayed_display[0],display};delayed_cold<={delayed_cold[0],cold};end
EE_Cold_Bt dut(clk,reset,display,cold,actual_reset_n,actual_ee);
EE_Cold_Bt_reference reference(clk,reset,delayed_display[1],delayed_cold[1],reference_reset_n,reference_ee);
integer comparisons=0;
always @(negedge clk) if(!reset) begin
comparisons=comparisons+1;
if({actual_reset_n,actual_ee,dut.prog,dut.timer,dut.next_instruction}!==
{reference_reset_n,reference_ee,reference.prog,reference.timer,reference.next_instruction})
$fatal(1,"boot-control program differs from upstream with two-stage input delay");
end
initial begin
repeat(4) @(negedge clk);#1;reset=0;
#12;cold=1;#35;cold=0;
// Exercise actual full production cold-boot timer/program.
repeat(5500000) @(negedge clk);
#2;display=1;#37;display=0;
repeat(14000000) @(negedge clk);
#2;display=1;cold=1;#31;display=0;cold=0;
repeat(12) @(negedge clk);#2;reset=1;
repeat(4) @(negedge clk);#1;reset=0;
repeat(100) @(negedge clk);
$display("PASS %0d complete production boot-program comparisons: cold boot, Easter Egg, simultaneous priority and reset, with explicit two-stage input latency",comparisons);
$finish;
end
initial begin #200000000;$fatal(1,"boot control timeout");end
endmodule
+48
View File
@@ -0,0 +1,48 @@
`timescale 1ns/1ps
module bridge_protocol_tb;
reg clk=0,fast=0,reset=1,request=0,read_cycle=1,memory_ack=0;
reg [24:0] address=0;
reg [7:0] data=0;
wire [24:0] captured_address;
wire [7:0] captured_data;
wire captured_read,memory_request,ack;
cpu_sdram_bridge dut(clk,fast,reset,address,data,request,read_cycle,memory_ack,ack,captured_address,captured_data,captured_read,memory_request);
always #10 clk=~clk;
always #5 fast=~fast;
task edge_wait;
begin @(negedge clk);#1;end
endtask
integer i;
reg [24:0] expected_address;
reg [7:0] expected_data;
reg expected_read;
initial begin
edge_wait();reset=0;
for(i=0;i<300;i=i+1) begin
// Previous acknowledgement may still be high when a new request arrives.
memory_ack=1;repeat(2) @(negedge fast);
@(posedge clk);#1;
request=1;address=$random;data=$random;read_cycle=i[0];
expected_address=address;expected_data=data;expected_read=read_cycle;
repeat(3) begin edge_wait();if(ack!==0 || memory_request!==0) $fatal(1,"stale ACK accepted");end
memory_ack=0;edge_wait();edge_wait();
if(memory_request!==1 || {captured_address,captured_data,captured_read}!=={expected_address,expected_data,expected_read}) $fatal(1,"request capture missing");
address=~address;data=~data;read_cycle=~read_cycle;
repeat(i%7+1) begin
edge_wait();
if({captured_address,captured_data,captured_read}!=={expected_address,expected_data,expected_read}) $fatal(1,"payload changed during wait");
end
memory_ack=1;@(negedge fast);#1;if(ack!==1) $fatal(1,"fresh ACK missing");
request=0;#1;if(ack!==0) $fatal(1,"ACK leaked after request drop");
edge_wait();if(memory_request!==0) $fatal(1,"request did not drop");
end
memory_ack=0;request=1;edge_wait();edge_wait();
reset=1;edge_wait();if(memory_request!==0) $fatal(1,"reset did not abort request");
repeat(3) begin edge_wait();if(memory_request!==0) $fatal(1,"request restarted during reset");end
request=0;reset=0;edge_wait();request=1;edge_wait();
if(memory_request!==1) $fatal(1,"post-reset request failed");
$display("PASS 300 request scoreboards: stale ACK rejection, fresh ACK, captured payload stability, arbitrary waits, reset abort/restart");
$finish;
end
initial begin #1000000;$fatal(1,"bridge protocol timeout");end
endmodule
+32
View File
@@ -0,0 +1,32 @@
`timescale 1ns/1ps
module completion_phase_tb;
reg sys=1,fast=1,clear=1,ready=0;
reg [15:0] data=0;
always #10 sys=~sys;
always #5 fast=~fast;
wire phase_ready;
wire [15:0] phase_data;
actual_completion dut(fast,clear,ready,data,phase_ready,phase_data);
integer comparisons=0,i;
reg observing=0;
// Compare the values the original and repaired CPU-side consuming edge sees,
// before the coincident positive-fast producer's NBA updates.
always @(negedge sys) if(observing && !clear) begin
if(phase_ready!==dut.data_ready) $fatal(1,"completion phase changed CPU-visible readiness");
if(phase_ready && phase_data!==dut.hold_data) $fatal(1,"completion flag/data became incoherent");
comparisons=comparisons+1;
end
initial begin
repeat(4) @(negedge sys);#1;clear=0;observing=1;
for(i=0;i<20000;i=i+1) begin
@(negedge fast);#1;data=$random;ready=$random;
if(i%19==0) clear=1;
if(i%19==3) clear=0;
end
clear=1;#1;
if(phase_ready!==0 || dut.data_ready!==0) $fatal(1,"completion clear missing");
$display("PASS %0d original/repaired completion flag/data observations at actual CPU phase; no extra CPU sampling cycle, random producer traffic and clears",comparisons);
$finish;
end
initial begin #1000000;$fatal(1,"completion phase timeout");end
endmodule
+80
View File
@@ -0,0 +1,80 @@
`timescale 1ns/1ps
module cpu_sdram_bridge_tb;
reg clk=1,fast=1,reset=1;
always #10 clk=~clk;
always #5 fast=~fast;
reg [24:0] address=0;
reg [7:0] data=0;
reg request=0,read_cycle=1;
wire [24:0] tx_address;
wire [7:0] tx_data;
wire tx_request,tx_read,ack,controller_ack,ready;
cpu_sdram_bridge dut(clk,fast,reset,address,data,request,read_cycle,controller_ack,ack,tx_address,tx_data,tx_read,tx_request);
wire [15:0] dq,dout;
wire [12:0] row;
wire [1:0] bank;
wire ras,cas,we;
// Constant read bus, not a physical SDRAM array/timing model.
assign dq=we?16'ha55a:16'hzzzz;
sdram_32r8w memory(.init(reset),.clk(fast),.SDRAM_DQ(dq),.SDRAM_A(row),.SDRAM_BA(bank),
.SDRAM_nRAS(ras),.SDRAM_nCAS(cas),.SDRAM_nWE(we),.sdram_dout(dout),
.sdram_cpu_addr(tx_address),.sdram_cpu_din(tx_data),.sdram_cpu_req(tx_request),
.sdram_cpu_rnw(tx_read),.sdram_cpu_ack(controller_ack),.sdram_cpu_ready(ready),
.sdram_vid_addr(25'd0),.sdram_vid_req(1'b0));
reg [24:0] expected_address;
reg [7:0] expected_data;
reg expected_read,checking=0;
reg ready_seen=0;
reg [15:0] returned_data;
integer activations=0,commands=0,transactions=0;
always @(posedge fast) begin
#1;
if(checking) begin
if(ready) begin ready_seen=1;returned_data=dout;end
if({ras,cas,we}===3'b011) begin
if(row!==expected_address[22:10] || bank!==expected_address[24:23]) $fatal(1,"wrong row/bank payload");
activations=activations+1;
end
if({ras,cas,we}===3'b101 || {ras,cas,we}===3'b100) begin
if(row[8:0]!==expected_address[9:1] || row[10:9]!==2'b10) $fatal(1,"wrong column/autoprecharge");
if(row[12:11] !== (expected_read?2'b00:{~expected_address[0],expected_address[0]})) $fatal(1,"wrong byte mask");
if((we===1)!==expected_read) $fatal(1,"wrong read/write command");
if(!expected_read && dq!=={expected_data,expected_data}) $fatal(1,"wrong binary write data");
commands=commands+1;
end
end
end
task transaction(input [24:0] a,input [7:0] d,input reg r);
integer count,old_commands,old_activations;
begin
@(posedge clk);#2;
expected_address=a;expected_data=d;expected_read=r;
old_commands=commands;old_activations=activations;
address=a;data=d;read_cycle=r;checking=1;request=1;ready_seen=0;
count=0;
while(ack!==1 && count<1000) begin @(negedge fast);#1;count=count+1;end
if(ack!==1) $fatal(1,"request acknowledgement timeout");
// Once acknowledged, decode inputs may change; the transaction stays captured.
@(negedge clk);#1;request=0;address=~a;data=~d;read_cycle=~r;
count=0;
while(ready_seen!==1 && count<1000) begin @(negedge fast);#1;count=count+1;end
if(ready_seen!==1) $fatal(1,"transaction completion timeout");
if(r && returned_data!==16'ha55a) $fatal(1,"read return data missing");
repeat(5) @(negedge clk);
#2;
if(commands!=old_commands+1 || activations!=old_activations+1) $fatal(1,"lost/duplicate transaction");
if(tx_request!==0 || ack!==0) $fatal(1,"request/ack did not clear");
checking=0;transactions=transactions+1;
end
endtask
integer i;
initial begin
repeat(8) @(negedge clk);reset=0;
repeat(26000) @(negedge fast); // Complete >=200 us SDRAM initialization.
for(i=0;i<25;i=i+1) begin transaction(25'b1<<i,8'h55,0);transaction(~(25'b1<<i),8'haa,1);end
for(i=0;i<256;i=i+1) begin transaction($random,i,0);transaction($random,i,1);end
$display("PASS %0d bridge + actual SDRAM-controller transactions: all address bits/banks/byte masks, all 256 write bytes, read/ack/ready, refresh stalls, no duplicates",transactions);
$finish;
end
initial begin #10000000;$fatal(1,"SDRAM bridge regression timeout");end
endmodule
+61
View File
@@ -0,0 +1,61 @@
`timescale 1ns/1ps
module disk_buffer_pipeline_tb;
reg clk=0,enable=0,sampling=0;
always #10 clk=~clk;
integer period=2,tick=0,reads=0;
reg [8:0] sdc_pointer=0;
reg [10:0] wd_pointer=0,write_address=0;
reg [7:0] write_data=0;
reg writing=0,sdc_writing=0;
wire [7:0] sdc_raw,wd_raw,sdc_piped,wd_piped;
sdc_dpram sdc_memory(.clock(clk),.address_a(write_address[8:0]),.data_a(write_data),.wren_a(sdc_writing),
.address_b(sdc_pointer),.data_b(8'd0),.wren_b(1'b0),.q_b(sdc_raw));
wd1793_dpram wd_memory(.clock(~clk),.address_a(write_address),.data_a(write_data),.wren_a(writing),
.address_b(wd_pointer),.data_b(8'd0),.wren_b(1'b0),.q_b(wd_raw));
actual_sdc_pipeline sdc_pipe(clk,sdc_raw,sdc_piped);
actual_wd_pipeline wd_pipe(~clk,1'b1,wd_raw,8'd0,wd_piped);
function [7:0] pattern(input integer value);
pattern=(value^(value>>3)^(value>>7));
endfunction
// WD native positive clock is the system negative edge in the full wrapper.
always @(negedge clk) if(enable && sampling) wd_pointer<=wd_pointer+1'b1;
always @(negedge clk) begin
if(!sampling) begin enable<=0;tick<=0;end
else begin
enable<=(tick==0);tick<=(tick>=period-1)?0:tick+1;
if(enable) begin
if(sdc_raw!==pattern(reads%512) || wd_raw!==pattern(reads%2048)) begin
`ifdef NEGATIVE_CONSECUTIVE
$fatal(1,"unsupported consecutive CPU disk read");
`else
$fatal(1,"RAM pointer/read phase mismatch");
`endif
end
if(sdc_piped!==sdc_raw || wd_piped!==wd_raw) $fatal(1,"CPU observed stale disk buffer: read=%0d Eperiod=%0d SDC=%h/%h WD=%h/%h ptr=%0d/%0d",reads,period,sdc_piped,sdc_raw,wd_piped,wd_raw,sdc_pointer,wd_pointer);
sdc_pointer<=sdc_pointer+1'b1;reads=reads+1;
end
end
end
integer i,profile;
initial begin
for(i=0;i<2048;i=i+1) begin
@(negedge clk);#1;write_address=i;write_data=pattern(i);writing=1;
// SDC is 512 bytes; write its independent expected low-address pattern.
sdc_writing=(i<512);
end
@(negedge clk);#1;writing=0;sdc_writing=0;
for(profile=0;profile<2;profile=profile+1) begin
@(negedge clk);#1;sampling=0;sdc_pointer=0;wd_pointer=0;reads=0;
`ifdef NEGATIVE_CONSECUTIVE
period=1;
`else
period=profile?6:2;
`endif
repeat(4) @(negedge clk);#1;sampling=1;
wait(reads>=2100);@(posedge clk);#1;sampling=0;
$display("PASS 2100 actual SDC/WD DPRAM CPU read comparisons, pointer phases, 512/2048-byte wrap; E period %0d",period);
end
$finish;
end
initial begin #1000000;$fatal(1,"disk buffer regression timeout");end
endmodule
+40
View File
@@ -0,0 +1,40 @@
`timescale 1ns/1ps
// Real platform CE generator and I2S serializer, including the 48/96 kHz switch.
module external_audio_tb;
reg clk=0, reset=1, rate=0;
always #20.341 clk=~clk;
wire bclk,lrclk,data;
audio_pin_contract dut(clk,reset,rate,bclk,lrclk,data);
integer cycle=0, last_change=-10000, last_rise=-10000;
integer setup_min=10000, hold_min=10000, rises=0, changes=0;
reg checking=0;
always @(posedge clk) cycle=cycle+1;
always @(data or lrclk) if(checking) begin
if(cycle-last_rise < hold_min) hold_min=cycle-last_rise;
if(cycle-last_rise < 3) $fatal(1,"I2S receiver hold slot lost: %0d",cycle-last_rise);
last_change=cycle;changes=changes+1;
end
always @(posedge bclk) if(checking) begin
if(cycle-last_change < setup_min) setup_min=cycle-last_change;
if(cycle-last_change < 5) $fatal(1,"I2S receiver setup slot lost: %0d",cycle-last_change);
last_rise=cycle;rises=rises+1;
end
initial begin
dut.ce_phase.cnt=0;
dut.divider_phase.div=0;
repeat(10) @(negedge clk);
reset=0;
repeat(100) @(negedge clk);
checking=1;
repeat(30000) @(negedge clk);
rate=1;
repeat(30000) @(negedge clk);
rate=0;
repeat(30000) @(negedge clk);
checking=0;
if(rises<5000 || changes<1000 || setup_min!=5 || hold_min!=3)
$fatal(1,"Incomplete I2S transition coverage rises=%0d changes=%0d setup=%0d hold=%0d",rises,changes,setup_min,hold_min);
$display("PASS audio pin slots: %0d rises, %0d changes; setup >=%0d cycles, hold >=%0d cycles",rises,changes,setup_min,hold_min);
$finish;
end
endmodule
+87
View File
@@ -0,0 +1,87 @@
`timescale 1ns/1ps
module external_i2c_tb;
reg clk=0,start=0,rd=0;
reg slave_present=0,slave_release=1;
reg [7:0] slave_data=8'ha5;
always #10 clk=~clk;
tri1 scl,sda;
// Slave maximum 900 ns clock-to-data plus independent pin-edge extrema.
assign #(0,`SDA_FALL_NS,`SDA_RELEASE_NS) sda=slave_release ? 1'bz : 1'b0;
wire done,error;
wire [7:0] data;
i2c #(50_000_000,`BUS_HZ) dut(.CLK(clk),.START(start),.READ(rd),.I2C_ADDR(7'h20),
.I2C_WLEN(1'b1),.I2C_WDATA1(8'h96),.I2C_WDATA2(8'h5a),
.I2C_RDATA(data),.END(done),.ACK(error),.I2C_SCL(scl),.I2C_SDA(sda));
realtime rise_time=0,fall_time=0,data_time=0,start_time=0,stop_time=0;
realtime minimum_low=1e9,minimum_high=1e9,minimum_setup=1e9;
integer rises=0,starts=0,stops=0,j,timeout;
integer bit_index=0,byte_index=0,checked_bytes=0;
reg [7:0] byte_value=0,expected_byte;
reg active=0,checking=0,first_fall=0;
always @(negedge scl) begin
if(slave_present && active) begin
if(bit_index==8 && (!rd || byte_index==0)) slave_release <= #900 0;
else if(rd && byte_index==1 && bit_index<8) slave_release <= #900 slave_data[7-bit_index];
else slave_release <= #900 1;
end else slave_release <= #900 1;
end
always @(negedge sda) if(checking) begin
data_time=$realtime;
if(scl===1) begin
if(stop_time>0 && $realtime-stop_time<1300) $fatal(1,"I2C bus free below 1300ns");
start_time=$realtime;starts=starts+1;active=1;first_fall=1;
bit_index=0;byte_index=0;byte_value=0;
end
end
always @(posedge sda) if(checking) begin
data_time=$realtime;
if(scl===1 && active) begin
if($realtime-rise_time<600) $fatal(1,"I2C stop setup below 600ns");
stop_time=$realtime;stops=stops+1;active=0;
end
end
always @(negedge scl) if(checking && active) begin
if($realtime-rise_time<minimum_high) minimum_high=$realtime-rise_time;
if($realtime-rise_time<600) $fatal(1,"I2C high below 600ns");
if(first_fall && $realtime-start_time<600) $fatal(1,"I2C start hold below 600ns");
first_fall=0;
fall_time=$realtime;
end
always @(posedge scl) if(checking && active && fall_time>0) begin
if(rise_time>0 && $realtime-rise_time<2500) $fatal(1,"I2C fast-mode period below 2500ns");
if($realtime-fall_time<minimum_low) minimum_low=$realtime-fall_time;
if($realtime-fall_time<1300) $fatal(1,"I2C low below 1300ns: %0.3f",$realtime-fall_time);
if($realtime-data_time<minimum_setup) minimum_setup=$realtime-data_time;
if($realtime-data_time<100) $fatal(1,"I2C data setup below 100ns");
rise_time=$realtime;rises=rises+1;
if(bit_index<8) begin
byte_value={byte_value[6:0],sda};
if(bit_index==7) begin
expected_byte=(byte_index==0) ? (rd ? 8'h41 : 8'h40) :
rd ? (slave_present ? slave_data : 8'hff) : (byte_index==1 ? 8'h96 : 8'h5a);
if(byte_value!==expected_byte) $fatal(1,"I2C transmitted-byte mismatch index=%0d actual=%h expected=%h",byte_index,byte_value,expected_byte);
checked_bytes=checked_bytes+1;
end
end
if(bit_index==8) begin bit_index=0;byte_index=byte_index+1;end
else bit_index=bit_index+1;
end
initial begin
dut.cnt=0;dut.I2C_CLOCK=0;
repeat(20) @(negedge clk);
checking=1;
for(j=0;j<40;j=j+1) begin
@(negedge clk);rd=j[0];slave_present=(j>=20);slave_data=j[1]?8'ha5:8'h5a;start=1;
repeat(3) @(negedge clk);start=0;
timeout=0;
while(!done && timeout<10000) begin @(negedge clk);timeout=timeout+1;end
if(timeout==10000) $fatal(1,"I2C completion timeout");
if(error!==!slave_present || (rd && data!==(slave_present ? slave_data : 8'hff)))
$fatal(1,"I2C ACK/data behavior error=%b data=%h present=%b",error,data,slave_present);
repeat(500) @(negedge clk);
end
if(starts!=40 || stops!=40 || rises<600 || checked_bytes!=100) $fatal(1,"Incomplete I2C waveform coverage %0d/%0d/%0d/%0d",starts,stops,rises,checked_bytes);
$display("PASS I2C fast-mode slots: %0d rises, low=%0.3f high=%0.3f setup=%0.3f ns",rises,minimum_low,minimum_high,minimum_setup);
$finish;
end
endmodule
+87
View File
@@ -0,0 +1,87 @@
`timescale 1ns/1ps
// Pin-command minimum intervals, independent of the controller's state encoding.
module external_sdram_commands_tb;
reg clk=0,init=1,req=0,rnw=0;
always #4.365079 clk=~clk;
wire [15:0] dq;
assign dq=rnw ? 16'h965a : 16'hzzzz;
wire [12:0] address;
wire [1:0] bank;
wire cs,ras,cas,we,memclk,ack,ready;
reg [24:0] cpu_address=0;
integer commands=0,activates=0,writes=0,reads=0,refreshes=0;
realtime released=0, next_command=0;
realtime last_active[0:3],next_active[0:3];
realtime now_time, earliest;
realtime last_refresh=-1;
reg configured=0;
integer b,j,timeout;
reg started=0;
sdram_probe dut(.init(init),.clk(clk),.SDRAM_DQ(dq),.SDRAM_A(address),.SDRAM_BA(bank),
.SDRAM_nCS(cs),.SDRAM_nRAS(ras),.SDRAM_nCAS(cas),.SDRAM_nWE(we),.SDRAM_CLK(memclk),
.sdram_cpu_addr(cpu_address),.sdram_cpu_din(8'h5a),.sdram_cpu_req(req),.sdram_cpu_rnw(rnw),
.sdram_cpu_ack(ack),.sdram_cpu_ready(ready),.sdram_vid_addr(25'd0),.sdram_vid_req(1'b0));
initial for(b=0;b<4;b=b+1) begin last_active[b]=-1000000;next_active[b]=0;end
always @(posedge memclk) if(!init && {ras,cas,we}!==3'b111) begin
now_time=$realtime;
if(!started) begin
if(!$test$plusargs("IGNORE_STARTUP") && now_time-released<200000)
$fatal(1,"SDRAM startup below 200 us: %0.3f ns",now_time-released);
started=1;
end
if(now_time+0.001<next_command) $fatal(1,"SDRAM refresh/precharge/mode recovery");
commands=commands+1;
case({ras,cas,we})
3'b011: begin
if(!$test$plusargs("IGNORE_TRC") && now_time-last_active[bank]<63.0) $fatal(1,"SDRAM tRC below 63 ns: %0.3f",now_time-last_active[bank]);
if(!$test$plusargs("IGNORE_TRC") && now_time+0.001<next_active[bank]) $fatal(1,"SDRAM auto-precharge recovery");
last_active[bank]=now_time;activates=activates+1;
end
3'b101,3'b100: begin
if(now_time-last_active[bank]<21.0) $fatal(1,"SDRAM tRCD below 21 ns");
if({ras,cas,we}==3'b100) begin
writes=writes+1;earliest=now_time+14.0;
end else begin
reads=reads+1;earliest=now_time+2.0*8.730158;
end
if(earliest<last_active[bank]+42.0) earliest=last_active[bank]+42.0;
if(address[10]) next_active[bank]=earliest+21.0;
end
3'b010: next_command=now_time+21.0;
3'b001: begin
next_command=now_time+63.0;refreshes=refreshes+1;
if(configured) begin
if(last_refresh>=0 && now_time-last_refresh>7812.5) $fatal(1,"SDRAM refresh interval above 7812.5 ns: %0.3f",now_time-last_refresh);
last_refresh=now_time;
end
end
3'b000: begin next_command=now_time+14.0;configured=1;end
endcase
end
task transfer(input bit read_mode,input [24:0] addr);
begin
@(negedge clk);rnw=read_mode;cpu_address=addr;req=1;
timeout=0;
while(!ack && timeout<40000) begin @(negedge clk);timeout=timeout+1;end
if(timeout==40000) $fatal(1,"SDRAM request timeout");
req=0;
while(ack) @(negedge clk);
if(read_mode) begin
timeout=0;
while(!ready && timeout<100) begin @(negedge clk);timeout=timeout+1;end
if(timeout==100) $fatal(1,"SDRAM read timeout");
end
end
endtask
initial begin
repeat(10) @(negedge clk);
init=0;released=$realtime;
// Legal held-until-ACK requests may be queued during startup.
for(j=0;j<128;j=j+1) transfer(0,{9'd0,j[7:0],8'd0});
for(j=0;j<32;j=j+1) transfer(1,{9'd0,j[7:0],8'd0});
repeat(50000) @(negedge clk);
if(writes!=128 || reads!=32 || refreshes<3) $fatal(1,"Incomplete command coverage");
$display("PASS SDRAM command intervals: startup >=200us, %0d ACT, %0d WR, %0d RD, %0d REF",activates,writes,reads,refreshes);
$finish;
end
endmodule
+26
View File
@@ -0,0 +1,26 @@
`timescale 1ns/1ps
module keyboard_control_phase_tb;
reg clk=0;
always #5 clk=~clk;
reg [3:0] controls=4'b1000,expected_controls=4'b1000;
reg [72:0] keys=0;
reg [7:0] columns=0;
wire observed,reference_value;
actual_keyboard_controls candidate(clk,controls,keys,columns,observed);
reference_keyboard_controls reference(expected_controls,keys,columns,reference_value);
integer flags,column,pattern,comparisons=0;
initial begin
for(flags=0;flags<16;flags=flags+1)
for(column=0;column<256;column=column+1)
for(pattern=0;pattern<256;pattern=pattern+1) begin
@(posedge clk);controls=flags;columns=column;keys[55:48]=pattern;
#1;
if(observed!==reference_value) $fatal(1,"Keyboard flags changed before sampling edge");
@(negedge clk);#1;expected_controls=controls;#1;
if(observed!==reference_value) $fatal(1,"Keyboard row/control decode changed");
comparisons=comparisons+1;
end
$display("PASS %0d exhaustive keyboard-row comparisons: all 16 EE/MUGS/shift controls, 256 column masks, 256 key patterns; original decode and one-negative-edge observation",comparisons);
$finish;
end
endmodule
+63
View File
@@ -0,0 +1,63 @@
`timescale 1ns/1ps
module peripheral_phase_tb;
reg clk=0;
always #10 clk=~clk;
reg enable=0;
reg [8:0] address=0;
reg [7:0] data=0;
reg [15:0] palette=0;
reg selected=0;
reg ssc_palette_owner=1;
wire write_enable=enable && selected;
wire candidate_write_enable,supports_ssc;
actual_vdac_write qualification(enable,selected,ssc_palette_owner,candidate_write_enable,supports_ssc);
wire [7:0] old_q,new_q;
sdc_reference old_ram(.clock(clk),.address_a(9'd0),.data_a(8'd0),.wren_a(1'b0),
.address_b(address),.data_b(data),.wren_b(write_enable),.q_b(old_q));
sdc_dpram new_ram(.clock(clk),.address_a(9'd0),.data_a(8'd0),.wren_a(1'b0),
.address_b(address),.data_b(data),.wren_b(write_enable),.q_b(new_q));
reg [15:0] old_palette[0:255],new_palette[0:255];
integer old_writes=0,new_writes=0;
always @(posedge clk) if(write_enable&&ssc_palette_owner) begin
old_palette[data]<=palette;old_writes=old_writes+1;
end
// Exact generated VDAC write-clock expression; generated wrapper supplies it.
wire candidate_write_clock;
actual_vdac_clock write_clock(clk,candidate_write_clock);
always @(posedge candidate_write_clock) if(candidate_write_enable) begin
new_palette[data]<=palette;new_writes=new_writes+1;
end
integer tick=0,cycles=0,i,seed=32'h451a46d0;
integer blocked_writes=0;
reg previous_enable=0;
// Model actual CPU contract: bus state changes at consuming negative edges;
// the producer chooses the *next* enable in the same NBA update.
always @(negedge clk) begin
if(enable) begin
address<=$random(seed);data<=$random(seed);palette<=$random(seed);
selected<=$random(seed);
end
previous_enable<=enable;
enable<=!enable && (($random(seed)&3)!=0);
cycles=cycles+1;
end
initial begin
for(i=0;i<512;i=i+1) begin old_ram.ram[i]=0;new_ram.ram[i]=0;end
for(i=0;i<256;i=i+1) begin old_palette[i]=0;new_palette[i]=0;end
repeat(20000) begin
@(negedge clk);#1;
if(cycles==10000&&supports_ssc)ssc_palette_owner=0;
if(cycles==15000)ssc_palette_owner=1;
if(!ssc_palette_owner&&write_enable)blocked_writes=blocked_writes+1;
if(old_writes!==new_writes) $fatal(1,"VDAC write count mismatch");
for(i=0;i<512;i=i+1)
if(old_ram.ram[i]!==new_ram.ram[i]) $fatal(1,"SDC CPU write mismatch at %0d",i);
for(i=0;i<256;i=i+1)
if(old_palette[i]!==new_palette[i]) $fatal(1,"VDAC write payload mismatch at %0d",i);
end
if(new_writes<2000) $fatal(1,"Insufficient randomized writes");
if(supports_ssc&&blocked_writes<500)$fatal(1,"Insufficient SSC palette write suppression");
$display("PASS 20000 CPU bus intervals, %0d SDC/VDAC writes: old positive/new negative edge payload, address, enable and memory equality",new_writes);
$finish;
end
endmodule
+36
View File
@@ -0,0 +1,36 @@
`timescale 1ns/1ps
module reset_domains_tb;
reg clk_sys=0,CLK_114=0,run_sys=1,run_fast=1,RESET_RAW_N=1;
always #10 if(run_sys) clk_sys=~clk_sys;
always #5 if(run_fast) CLK_114=~CLK_114;
wire RESET_N,RESET_POS_N,RESET_FAST_N,WD_RESET_N;
actual_reset_domains dut(clk_sys,CLK_114,RESET_RAW_N,RESET_N,RESET_POS_N,RESET_FAST_N);
actual_wd_release disk(clk_sys,RESET_N,WD_RESET_N);
reg observing=0;
always @(posedge RESET_N) if(observing && clk_sys!==0) $fatal(1,"main reset released on wrong phase");
always @(posedge RESET_POS_N) if(observing && clk_sys!==1) $fatal(1,"positive reset released on wrong phase");
always @(posedge RESET_FAST_N) if(observing && CLK_114!==1) $fatal(1,"fast reset released on wrong phase");
always @(posedge WD_RESET_N) if(observing && clk_sys!==1) $fatal(1,"disk reset released on wrong phase");
integer phase;
initial begin
repeat(5) @(negedge clk_sys);observing=1;
for(phase=0;phase<7;phase=phase+1) begin
#(phase+1);RESET_RAW_N=0;#1;
if({RESET_N,RESET_POS_N,RESET_FAST_N,WD_RESET_N}!==0) $fatal(1,"asynchronous domain assertion missing");
@(negedge clk_sys);run_sys=0;run_fast=0;
#13;RESET_RAW_N=1;#40;
if({RESET_N,RESET_POS_N,RESET_FAST_N,WD_RESET_N}!==0) $fatal(1,"stopped clocks released reset");
run_sys=1;
@(negedge clk_sys);#1;if(RESET_N!==0) $fatal(1,"main released after only one edge");
@(negedge clk_sys);#1;if(RESET_N!==1 || RESET_FAST_N!==0) $fatal(1,"main/fast release ordering wrong");
@(posedge clk_sys);#1;if(WD_RESET_N!==0) $fatal(1,"disk released after one edge");
@(posedge clk_sys);#1;if(WD_RESET_N!==1) $fatal(1,"disk release missing");
run_fast=1;
@(posedge CLK_114);#1;if(RESET_FAST_N!==0) $fatal(1,"fast released after one edge");
@(posedge CLK_114);#1;if(RESET_FAST_N!==1) $fatal(1,"fast release missing");
end
$display("PASS actual domain and WD reset chains: seven phases, asynchronous assertion, two consuming edges, independently stopped clocks and release phases");
$finish;
end
initial begin #10000;$fatal(1,"domain reset timeout");end
endmodule
Loaded 100 of 126 files, more files were not shown because too many files have changed in this diff. Show more