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

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

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

162 lines
7.2 KiB
Python

#!/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()