feat(saolei): 新增纯 C 扫雷(MMIO 显示 + 中断读鼠标),扩展 CPU 外设并清理仓库

## 背景

在原有五级流水 CPU 的基础上,用一颗 RISC-V 工具链把"纯 C 写的扫雷"编译成机器码
固化进片内 ROM 运行,并为此把 MMIO 外设从"只有一个 LED 寄存器"扩展成
显示(VGA 显存)+ 七段数码管 + 鼠标事件(含中断)的完整子系统。
原 LED MMIO 的语义保持不变,原有跑马灯/中断/指令回归不受影响。

## 硬件(pipelined-cpu/srcs)

- cpu21_mmio.v:扩展成 MMIO 中枢,新增
  * 七段数码管寄存器(0x1004,8 位十六进制)
  * 鼠标寄存器组(0x1100+):STATUS/DATA/ACK/CTRL/INPUT/TIME/FRAME/EVCNT/LEVEL/MAGIC
    —— 含 16 项事件 FIFO 与 mouse_irq_o(读空自动回 0,不丢事件)
  * 显示控制器(0x1140+):CTRL(光标可见/背景色)、CURSOR(列、行)
  * 显存窗口(0x2000-0x27FF):写端口输出到板级顶层的双口 RAM,读保持组合读
  * LEVEL(0x1120):软件中断寄存器,写 1 拉起 level_irq_o(用作"关卡入口")
  * 地址译码、字节写合并、读数据 mux 全部按原风格实现
- 新增外设 RTL:cpu21_vga.v(640x480@60 按格子扫描,8x8 字模放大 2 倍)、
  cpu21_seg7.v(8 位数码管动态扫描)、cpu21_pointer.v(5 向按键→鼠标事件,1 ms 去抖
  + 事件排队)、cpu21_ps2_mouse.v(可选真鼠标,PS/2 11 位帧接收 + 3 字节包解析)
- cpu21_riscv_redirect_int_bpb.v:新增外设总线端口(显存写/读回、鼠标事件输入、
  中断输出、数码管数据、帧脉冲),例化扩展后的 cpu21_mmio
- cpu21_board_top.v:接入显存双口 RAM + VGA + 数码管 + 鼠标事件源,中断接线为
  irq_i = {SW2, LEVEL|SW1, 鼠标|SW0};ROM 宏切换(定义 SAOLEI_ROM 加载扫雷程序);
  ROM_WORDS 1024→8192
- cpu21_board_top.xdc:新增按键、SW[3]、8 位数码管、VGA、PS/2 的全部引脚约束
- tb_board_top.v:新端口显式接 0/1,避免悬空影响原跑马灯回归
- create_project.tcl:把 cpu21_saolei_rom.vh 按 Verilog Header 条件加入

## 软件(saolei/)

- sw/mmio.h:全部 MMIO 地址与格子编码(换地址只改这一个文件)
- sw/saolei.c:纯 C 扫雷 —— 背景"伪操作系统" main()(开始界面)+ 关卡 level_main()
  (在 IRQ1 里跑完整局)+ 棋盘位图/布雷(首点安全)/BFS 展开/插旗/胜负判定/逐格绘制
- sw/isr.c:**中断读鼠标的代码**。三个固定地址入口:
  * isr1_entry(.text.isr1=0x100)关卡入口:保存全部调用者保存寄存器 +
    csrrsi 打开 MIE(让鼠标中断可嵌套)→ level_main
  * isr2_entry(.text.isr2=0x200)鼠标读取:只存 ra → 纯 C 主体 isr_body
  * isr3_entry(.text.isr3=0x300)备用:直接 uret
- sw/start.c:设 sp、清 .bss、进 main(只有这一处必要内联汇编)
- sw/linker.ld:复位 0x0、三个中断入口 0x100/0x200/0x300、栈顶 0x0FFC;
  用 ASSERT 禁止 .data/.rodata(这颗核读不到 ROM 里的数据)

## 构建与工具链适配(saolei/tools)

- build.ps1:一键 C → .o → ELF → .hex + cpu21_saolei_rom.vh,任一步失败立刻停止
- check_isa.py:用"指令白名单"逐条检查反汇编,出现本核未实现的指令即报错并给修复提示
- elf2hex.py:裸二进制 → $readmemh hex + ROM 初始化头文件
- 三处针对本核的关键配置(都已写进脚本注释):
  1) -march=rv32im_zicsr(GCC 15 起 rv32im 不含 Zicsr,csrrsi 会报错)
  2) 不能禁链接器松弛:gcc 函数调用默认是 auipc+jalr,靠松弛压成 jal,
     禁掉后 35 条 auipc 会留在代码里(本核没有 auipc);
     用 -msmall-data-limit=0 防止松弛引入 gp 相对寻址
  3) 中断入口地址必须写在段声明上(.text.isr1 0x100 : ...),
     只写 ". = 0x100;" 会被 ld 忽略(实测 isr1 掉到了 0x14)
- 实测结果:text=3368B、data=0、bss=1436B,842 条指令全部通过 ISA 检查,
  入口地址 _start=0x0 / isr1_entry=0x100 / isr2_entry=0x200 / isr3_entry=0x300

## 仓库清理

- 删除被工程取代的 saolei/hw、saolei/constrs(外设已并入 srcs/rtl)
- 删除全部 Vivado 生成物:.xpr、.runs、.sim、.cache、.hw、.ip_user_files、.Xil、
  vivado.jou/log —— 需要工程时用 source create_project.tcl 一键重建(约 0.3 MB 源文件)
- .gitignore 增加 saolei/build/(构建产物可一键重建)

## 文档

- README:更新目录结构、仓库约定(不放生成物)、MMIO 地址表、文件与模块划分表、
  上板说明,新增"扫雷程序(saolei/)"章节
- saolei/README.md:重写 —— 程序结构(背景/关卡/鼠标 + 三个中断入口)、
  本核指令子集与对应写法、构建步骤与实测数据、MMIO 地址表、上板/仿真步骤、
  操作说明、验证状态与已知可改进项

## 验证状态(如实说明)

- 已实测:C 工具链链路(编译/链接/ISA 检查/hex 生成/入口地址逐条核对)
- 未验证:所有 RTL 未经综合与仿真(本机无 Vivado),C 程序也未在仿真器/硬件上运行过;
  建议先跑 tools/run_regress.ps1 确认原回归仍全 PASS,再用 SAOLEI_ROM 宏做行为仿真
This commit is contained in:
2026-09-16 20:11:00 +08:00
commit f50639e90f
66 changed files with 19733 additions and 0 deletions
@@ -0,0 +1,428 @@
#############################################################
#测试jal,jalr指令,
#############################################################
.text
addi s1,zero, 1 #测试jal,jalrr指令
j jmp_next1 #jal x0,8
addi s1,zero, 1
addi s2,zero, 2
addi s3,zero, 3
jmp_next1:
j jmp_next2
addi s1,zero, 1
addi s2,zero, 2
addi s3,zero, 3
jmp_next2:
j jmp_next3
addi s1,zero, 1
addi s2,zero, 2
addi s3,zero, 3
jmp_next3:
j jmp_next4
addi s1,zero, 1
addi s2,zero, 2
addi s3,zero, 3
jmp_next4:jal jmp_count
#移位测试 需要支持超addi,sll,add,ecall,srl,sll,sra,beq,j,ecall revise date:2015/12/16 tiger
.text
addi s0,zero,1 #简单移位,循环测试,0号区域显示的是初始值1左移1位重复15次的值,1号区域是累加值
addi s1,zero,1
slli s1, s1, 31 #逻辑左移31位 s1=0x80000000
###################################################################
# 逻辑左移测试
# 显示区域依次显示0x80000000 0x20000000 0x08000000 0x02000000 0x00800000 0x00200000 0x00080000 0x00020000 0x00008000 0x00002000 0x00000800 0x00000200 0x00000080 0x00000020 0x00000008 0x00000002 0x00000000
###################################################################
LogicalRightShift: #逻辑右移测试,将最高位1逐位向右右移直至结果为零
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
srli s1, s1, 2
beq s1, zero, shift_next1
j LogicalRightShift
shift_next1:
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
###################################################################
# 逻辑右移测试
# 显示区域依次显示0x00000004 0x00000010 0x00000040 0x00000100 0x00000400 0x00001000 0x00004000 0x00010000 0x00040000 0x00100000 0x00400000 0x01000000 0x04000000 0x10000000 0x40000000 0x00000000
###################################################################
addi s1,zero, 1
LogicalLeftShift: #逻辑左移测试,将最低位1逐位向左移直至结果为零
slli s1, s1, 2
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
beq s1, zero, ArithRightShift
j LogicalLeftShift
###################################################################
# 算术右移测试
# 显示区域依次显示0x80000000 0xf0000000 0xff000000 0xfff00000 0xffff0000 0xfffff000 0xffffff00 0xfffffff0 0xffffffff
###################################################################
ArithRightShift: #算术右移测试,#算术移位测试,80000000算术右移,依次显示为F0000000,FF000000,FFF00000,FFFF0000直至FFFFFFFF
addi s1,zero,1
slli s1, s1, 31 #逻辑左移31位 s1=0x80000000
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
srai s1, s1, 3 #s1=0X80000000-->0XF0000000
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
srai s1, s1, 4 #0XF0000000-->0XFF000000
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
srai s1, s1, 4 #0XFF000000-->0XFFF00000
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
srai s1, s1, 4
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
srai s1, s1, 4
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
srai s1, s1, 4
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
srai s1, s1, 4
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
srai s1, s1, 4
add a0,zero,s1 #display s1
addi a7,zero,34 # display hex
ecall # we are out of here.
#############################################################
#走马灯测试,测试addi,andi,sll,srl,sra,or,ori,nor,ecall LED按走马灯方式来回显示数据
#############################################################
.text
addi s0,zero,1
slli s3, s0, 31 # s3=0x80000000
srai s3, s3, 31 # s3=0xFFFFFFFF
add s0,zero,zero # s0=0
addi s2,zero,12
addi s6,zero,3 #走马灯计数
zmd_loop:
addi s0, s0, 1 #计算下一个走马灯的数据
andi s0, s0, 15
#######################################
addi t0,zero,8
addi t1,zero,1
left:
slli s3, s3, 4 #走马灯左移
or s3, s3, s0
add a0,zero,s3 # display s3
addi a7,zero,34 # system call for LED display
ecall # display
sub t0,t0,t1
bne t0,zero,left
#######################################
addi s0, s0, 1 #计算下一个走马灯的数据
addi t6,zero,15
and s0, s0, t6
slli s0, s0, 28
addi t0,zero,8
addi t1,zero,1
zmd_right:
srli s3, s3, 4 #走马灯右移
or s3, s3, s0
add a0,zero,s3 # display s3
addi a7,zero,34 # system call for LED display
ecall # display
sub t0,t0,t1
bne t0,zero,zmd_right
srli s0, s0, 28
#######################################
sub s6,s6,t1
beq s6,zero, exit
j zmd_loop
exit:
add t0,zero,zero
xori t0,t0,-1 #test r xori
slli t0,t0,8
ori t0,t0,255
add a0,zero,t0 # display t0
addi a7,zero,34 # system call for LED display
ecall # display
#################################################################################
#本程序实现0-15号字单元的降序排序,此程序可在rars 仿真器中运行
#运行时请将rars Setting中的Memory Configuration设置为Compact,data at address 0
#################################################################################
.text
sort_init:
addi s0,zero,-1
addi s1,zero,0
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
sw s0,0(s1)
addi s0,s0,1
addi s1,s1,4
addi s0,s0,1
add s0,zero,zero
addi s1,zero,60 #排序区间
sort_loop:
lw s3,0(s0)
lw s4,0(s1)
slt t0,s3,s4
beq t0,zero,sort_next #降序排序
sw s3, 0(s1)
sw s4, 0(s0)
sort_next:
addi s1, s1, -4
bne s0, s1, sort_loop
add a0,zero,s0 #display s0
addi a7,zero,34 # display hex
ecall # we are out of here. DISP: disp r0, 0
addi s0,s0,4
addi s1,zero,60
bne s0, s1, sort_loop
addi a7,zero,10 # benchmark 测试完成,ecall 停止 # 停止后点击继续运行,将进入下方 CCAB 附加指令测试区
#############################################
# insert your ccmb benchmark program here!!!
#############################################
#===== [1] 运算类C:DIVU 无符号除法(divu/mflo)=====
#依次输出0x11110000 0x08888000 0x04444000 0x02222000 0x01111000 0x00888800 0x00444400 0x00222200 0x00111100 0x00088880 0x00044440 0x00022220 0x00011110 0x00008888 0x00004444 0x00002222 0x00001111 0x00000888 0x00000444 0x00000222 0x00000111 0x00000088 0x00000044 0x00000022 0x00000011 0x00000008 0x00000004 0x00000002 0x00000001
addi t0,zero,2 # /2
addi s1,zero, 0x11
slli s1,s1,8
addi s1,s1,0x11
slli s1,s1,16
add a0,zero,s1
addi a7,zero,34
ecall
addi t3,zero,28 #循环次数
divu_branch:
divu s1,s1,t0 #测试指令
add a0,zero,s1
addi a7,zero,34
ecall #输出当前值
addi t3,t3, -1
bne t3,zero,divu_branch #循环
addi a7,zero,10 # 暂停或退出
#===== [2] 运算类C:REMU 无符号取余 =====
#输出 0x87540110
addi s1,x0,0x88
slli s1,s1,8
addi s1,s1,0x48
addi s2,x0,0x87
slli s2,s2,8
addi s2,s2,0x54
remu s2,s2,s1
slli s2,s2,16
ori s2,s2,0x110
add a0,zero,s2
addi a7,zero,34 # system call for print
ecall
addi a7,zero,10 # system call for exit
#===== [3] 存储类A:SB 存字节 =====
#依次输出 0x00000000 0x00000001 0x00000002 0x00000003 0x00000004 0x00000005 0x00000006 0x00000007 0x00000008 0x00000009 0x0000000a 0x0000000b 0x0000000c 0x0000000d 0x0000000e 0x0000000f 0x00000010 0x00000011 0x00000012 0x00000013 0x00000014 0x00000015 0x00000016 0x00000017 0x00000018 0x00000019 0x0000001a 0x0000001b 0x0000001c 0x0000001d 0x0000001e 0x0000001f 0x03020100 0x07060504 0x0b0a0908 0x0f0e0d0c 0x13121110 0x17161514 0x1b1a1918 0x1f1e1d1c
addi t1,zero,0 #init_addr
addi t3,zero,32 #counter
#sb写入 01,02,03,04
addi s1,zero, 0x00 #
addi s2,zero, 0x01 #
sb_store:
sb s1,(t1)
add a0,zero,s1
addi a7,zero,34 # system call for print
ecall # print
add s1,s1,s2 #data +1
addi t1,t1,1 # addr ++
addi t3,t3,-1 #counter
bne t3,zero,sb_store
addi t3,zero,8
addi t1,zero,0 # addr
sb_branch:
lw s1,(t1) #读出数据
add a0,zero,s1
addi a7,zero,34 # system call for print
ecall # print
addi t1,t1,4
addi t3,t3, -1
bne t3,zero,sb_branch
addi a7,zero,10 # system call for exit
#===== [4] 跳转类B:BLT 小于则跳转(从负数向零累加)=====
#依次输出0xfffffff1 0xfffffff2 0xfffffff3 0xfffffff4 0xfffffff5 0xfffffff6 0xfffffff7 0xfffffff8 0xfffffff9 0xfffffffa 0xfffffffb 0xfffffffc 0xfffffffd 0xfffffffe 0xffffffff
addi s1,zero,-15 #初始值
blt_branch:
add a0,zero,s1
addi a7,zero,34
ecall #输出当前值
addi s1,s1,1
blt s1,zero,blt_branch #测试指令
ccab_end:
addi a7,zero,10
#处理器实现中请用停机指令实现ecall
jmp_count: addi s0,zero, 0
addi s0,s0, 1
add a0,zero,s0
addi a7,zero,34 # display hex
ecall # we are out of here.
addi s0,s0, 2
add a0,zero,s0
addi a7,zero,34 # display hex
ecall # we are out of here.
addi s0,s0, 3
add a0,zero,s0
addi a7,zero,34 # display hex
ecall # we are out of here.
addi s0,s0, 4
add a0,zero,s0
addi a7,zero,34 # display hex
ecall # we are out of here.
addi s0,s0, 5
add a0,zero,s0
addi a7,zero,34 # display hex
ecall # we are out of here.
addi s0,s0, 6
add a0,zero,s0
addi a7,zero,34 # display hex
ecall # we are out of here.
addi s0,s0, 7
add a0,zero,s0
addi a7,zero,34 # display hex
ecall # we are out of here.
addi s0,s0, 8
add a0,zero,s0
addi a7,zero,34 # display hex
addi a7,zero,34 # display hex
ecall # we are out of here.
ret #persudo instruction jalr x0,x1,0