fcdev 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +22 -20
- package/docs/01-/350/275/257/344/273/266/346/236/266/346/236/204/350/256/276/350/256/241.md +3 -3
- package/docs/02-/345/221/275/344/273/244/350/241/214/344/270/216/346/236/204/345/273/272.md +2 -0
- package/docs/05-/346/250/241/346/213/237/345/231/250/344/270/216/350/260/203/350/257/225.md +8 -6
- package/docs/06-/345/217/215/346/261/207/347/274/226.md +9 -4
- package/docs/08-/346/265/213/350/257/225/344/270/216/351/252/214/350/257/201.md +1 -1
- package/docs/09-/345/217/221/345/270/203.md +4 -3
- package/docs/nes/01-NES/347/233/256/346/240/207.md +1 -1
- package/docs/sb2000/01-/345/274/200/345/217/221/346/214/207/345/215/227.md +15 -8
- package/docs/sb2000/02-/347/263/273/347/273/237/350/260/203/347/224/250/346/211/213/345/206/214.md +7 -7
- package/docs/sb2000/03-/347/241/254/344/273/266/350/257/264/346/230/216.md +17 -8
- package/docs//345/276/205/345/212/236/345/244/207/345/277/230.md +3 -1
- package/package.json +4 -3
- package/src/cli/commands/api-command.mjs +2 -2
- package/src/cli/commands/build-command.mjs +1 -1
- package/src/cli/commands/debug-command.mjs +5 -2
- package/src/cli/commands/disasm-command.mjs +1 -1
- package/src/cli/commands/disk-command.mjs +1 -1
- package/src/cli/commands/docs-command.mjs +3 -3
- package/src/cli/commands/run-command.mjs +2 -2
- package/src/disasm/address-tables.mjs +161 -0
- package/src/disasm/analysis.mjs +17 -11
- package/src/disasm/byte-kinds.mjs +20 -0
- package/src/disasm/disassembler.mjs +3 -2
- package/src/disasm/info-writer.mjs +3 -3
- package/src/docs/doc-topics.mjs +1 -1
- package/src/emulator/debug-client.mjs +1 -1
- package/targets/nes/lib/fcnes.lib +0 -0
- package/targets/nes/lib/nes-font.o +0 -0
- package/targets/sb2000/api-reference.md +310 -1
- package/targets/sb2000/asminc/sb2000.inc +90 -1
- package/targets/sb2000/include/sb2000-dma.h +46 -0
- package/targets/sb2000/include/sb2000-ppu.h +106 -0
- package/targets/sb2000/include/sb2000-symbols.h +170 -0
- package/targets/sb2000/include/sb2000-timer.h +54 -0
- package/targets/sb2000/include/sb2000.h +3 -0
- package/targets/sb2000/lib/crt0.o +0 -0
- package/targets/sb2000/lib/sb2000.lib +0 -0
- package/targets/sb2000/src/lib/dma/sb-dma-page-address.c +16 -0
- package/targets/sb2000/src/lib/dma/sb-dma-to-cpu.c +19 -0
- package/targets/sb2000/src/lib/dma/sb-dma-to-vram.c +16 -0
- package/targets/sb2000/src/lib/dma/sbi-dma-run.c +34 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-address.c +20 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-fill.c +19 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-oam-clear.c +21 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-oam-put.c +20 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-palette-get.c +16 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-palette-set.c +16 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-peek.c +22 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-read.c +20 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-render.c +20 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-wait-vblank.c +25 -0
- package/targets/sb2000/src/lib/ppu/sb-ppu-write.c +21 -0
- package/targets/sb2000/src/lib/sb-internal.h +3 -0
- package/targets/sb2000/src/lib/timer/sb-timer-current.c +16 -0
- package/targets/sb2000/src/lib/timer/sb-timer-mask.c +16 -0
- package/targets/sb2000/src/lib/timer/sb-timer-pending.c +16 -0
- package/targets/sb2000/src/lib/timer/sb-timer-start.c +17 -0
- package/targets/sb2000/src/lib/timer/sb-timer-stop.c +16 -0
- package/targets/sb2000/src/lib/timer/sb-timer-unmask.c +16 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# SB2000 C 接口参考
|
|
2
2
|
|
|
3
3
|
本文由头文件 `include/sb2000-*.h` 的文档注释生成,请不要手改;改注释后运行 `node tools/gen-sb2000-api-doc.mjs`。
|
|
4
|
-
共
|
|
4
|
+
共 204 个函数,17 个模块。随时查询用 `npx fcdev api`:`npx fcdev api <函数名>` 看完整文档,`npx fcdev api <模块名>` 看模块的函数列表,`npx fcdev api '$7B'` 看用到某个系统调用的函数,`npx fcdev api <词>` 按名称与说明搜索。
|
|
5
5
|
|
|
6
6
|
约定:
|
|
7
7
|
|
|
@@ -15,15 +15,18 @@
|
|
|
15
15
|
- [日期与时间(sb2000-clock.h)](#clock)
|
|
16
16
|
- [软驱扇区(sb2000-disk.h)](#disk)
|
|
17
17
|
- [显示、窗口与图片(sb2000-display.h)](#display)
|
|
18
|
+
- [通用 DMA(sb2000-dma.h)](#dma)
|
|
18
19
|
- [文件与目录(sb2000-file.h)](#file)
|
|
19
20
|
- [中文输入法(sb2000-ime.h)](#ime)
|
|
20
21
|
- [键盘、手柄与鼠标(sb2000-input.h)](#input)
|
|
21
22
|
- [数学(sb2000-math.h)](#math)
|
|
22
23
|
- [内存页与远指针(sb2000-memory.h)](#memory)
|
|
24
|
+
- [图形端口(sb2000-ppu.h)](#ppu)
|
|
23
25
|
- [打印机(sb2000-printer.h)](#printer)
|
|
24
26
|
- [声音与语音(sb2000-sound.h)](#sound)
|
|
25
27
|
- [系统与中断(sb2000-system.h)](#system)
|
|
26
28
|
- [文字输出(sb2000-text.h)](#text)
|
|
29
|
+
- [硬件定时器(sb2000-timer.h)](#timer)
|
|
27
30
|
- [总头文件与通用调用(sb2000.h)](#sb2000)
|
|
28
31
|
- [系统调用覆盖表](#系统调用覆盖表)
|
|
29
32
|
|
|
@@ -848,6 +851,66 @@ unsigned int sb_image_unpack_to_memory(const void *stream, unsigned char group,
|
|
|
848
851
|
|
|
849
852
|
返回:解出的字节数。
|
|
850
853
|
|
|
854
|
+
<a id="dma"></a>
|
|
855
|
+
## 通用 DMA(sb2000-dma.h)
|
|
856
|
+
|
|
857
|
+
| 函数 | 说明 | 系统调用 |
|
|
858
|
+
| --- | --- | --- |
|
|
859
|
+
| [`sb_dma_page_address`](#sb_dma_page_address) | 把扩展 RAM 的页号与页内偏移换算成 DMA 的源地址。 | |
|
|
860
|
+
| [`sb_dma_to_cpu`](#sb_dma_to_cpu) | 用 DMA 把扩展 RAM 里的数据复制到 CPU 地址。只有目的在 ERAM($6000-$7FFF)时有效,目的范围不能越过 $8000。 | |
|
|
861
|
+
| [`sb_dma_to_vram`](#sb_dma_to_vram) | 用 DMA 把扩展 RAM 里的数据复制到显存。目的地址不小于 $8000 时是扩展显存,再加 $4300 选的 32K bank,否则是内置字符 RAM。 | |
|
|
862
|
+
|
|
863
|
+
<a id="sb_dma_page_address"></a>
|
|
864
|
+
### sb_dma_page_address
|
|
865
|
+
|
|
866
|
+
```c
|
|
867
|
+
unsigned long sb_dma_page_address(unsigned char page, unsigned int offset);
|
|
868
|
+
```
|
|
869
|
+
|
|
870
|
+
把扩展 RAM 的页号与页内偏移换算成 DMA 的源地址。
|
|
871
|
+
|
|
872
|
+
参数:
|
|
873
|
+
|
|
874
|
+
- `page`:扩展 RAM 页号,0x80 到 0xFF。
|
|
875
|
+
- `offset`:页内偏移,可以超过一页。
|
|
876
|
+
|
|
877
|
+
返回:源地址,传给 sb_dma_to_cpu、sb_dma_to_vram。
|
|
878
|
+
|
|
879
|
+
<a id="sb_dma_to_cpu"></a>
|
|
880
|
+
### sb_dma_to_cpu
|
|
881
|
+
|
|
882
|
+
```c
|
|
883
|
+
unsigned char sb_dma_to_cpu(unsigned long source, unsigned int dest, unsigned int length);
|
|
884
|
+
```
|
|
885
|
+
|
|
886
|
+
用 DMA 把扩展 RAM 里的数据复制到 CPU 地址。只有目的在 ERAM($6000-$7FFF)时有效,目的范围不能越过 $8000。
|
|
887
|
+
|
|
888
|
+
参数:
|
|
889
|
+
|
|
890
|
+
- `source`:源地址,用 sb_dma_page_address 换算。
|
|
891
|
+
- `dest`:目的 CPU 地址。
|
|
892
|
+
- `length`:字节数,1 到 $8000。
|
|
893
|
+
|
|
894
|
+
返回:0 成功;SB_ERR_BAD_PARAMETER 长度为 0 或超过 $8000,或目的范围越过 $8000。
|
|
895
|
+
|
|
896
|
+
<a id="sb_dma_to_vram"></a>
|
|
897
|
+
### sb_dma_to_vram
|
|
898
|
+
|
|
899
|
+
```c
|
|
900
|
+
unsigned char sb_dma_to_vram(unsigned long source, unsigned int dest, unsigned int length);
|
|
901
|
+
```
|
|
902
|
+
|
|
903
|
+
用 DMA 把扩展 RAM 里的数据复制到显存。目的地址不小于 $8000 时是扩展显存,再加 $4300 选的 32K bank,否则是内置字符 RAM。
|
|
904
|
+
调用时要关着显示,或在垂直消隐期间。
|
|
905
|
+
|
|
906
|
+
参数:
|
|
907
|
+
|
|
908
|
+
- `source`:源地址,用 sb_dma_page_address 换算。
|
|
909
|
+
- `dest`:目的显存地址。
|
|
910
|
+
- `length`:字节数,1 到 $8000。
|
|
911
|
+
|
|
912
|
+
返回:0 成功;SB_ERR_BAD_PARAMETER 长度为 0 或超过 $8000。
|
|
913
|
+
|
|
851
914
|
<a id="file"></a>
|
|
852
915
|
## 文件与目录(sb2000-file.h)
|
|
853
916
|
|
|
@@ -2282,6 +2345,177 @@ void sb_window_map_group(unsigned char group);
|
|
|
2282
2345
|
|
|
2283
2346
|
- `group`:页组的首页号。
|
|
2284
2347
|
|
|
2348
|
+
<a id="ppu"></a>
|
|
2349
|
+
## 图形端口(sb2000-ppu.h)
|
|
2350
|
+
|
|
2351
|
+
| 函数 | 说明 | 系统调用 |
|
|
2352
|
+
| --- | --- | --- |
|
|
2353
|
+
| [`sb_ppu_address`](#sb_ppu_address) | 设置显存地址($2006),之后读写 $2007 从这里开始。 | |
|
|
2354
|
+
| [`sb_ppu_write`](#sb_ppu_write) | 把一段数据写进显存。 | |
|
|
2355
|
+
| [`sb_ppu_fill`](#sb_ppu_fill) | 把显存的一段填成同一个值。 | |
|
|
2356
|
+
| [`sb_ppu_peek`](#sb_ppu_peek) | 读显存的一个字节。设地址后第一次读只刷新缓冲,所以函数设两次地址,取第二次读到的值。 | |
|
|
2357
|
+
| [`sb_ppu_read`](#sb_ppu_read) | 读一段显存。 | |
|
|
2358
|
+
| [`sb_ppu_palette_set`](#sb_ppu_palette_set) | 写调色板的一项($2040 起共 64 项:背景 0-31,精灵 32-63)。 | |
|
|
2359
|
+
| [`sb_ppu_palette_get`](#sb_ppu_palette_get) | 读调色板的一项,只返回低 6 位(读出的位 6 恒为 1,已去掉)。 | |
|
|
2360
|
+
| [`sb_ppu_oam_clear`](#sb_ppu_oam_clear) | 把精灵 RAM 的 256 字节全部填成 $F0,使全部 64 个精灵都在屏幕之外。 | |
|
|
2361
|
+
| [`sb_ppu_oam_put`](#sb_ppu_oam_put) | 写一个精灵(4 字节)。读回时属性的位 4-2 总是 1(真机实测)。 | |
|
|
2362
|
+
| [`sb_ppu_wait_vblank`](#sb_ppu_wait_vblank) | 等垂直消隐:轮询 $2002 直到位 7 为 1,最多读 65535 次。 | |
|
|
2363
|
+
| [`sb_ppu_render`](#sb_ppu_render) | 设置控制寄存器与扩展控制寄存器、滚动回到 (0, 0),最后写显示寄存器打开显示。 | |
|
|
2364
|
+
|
|
2365
|
+
<a id="sb_ppu_address"></a>
|
|
2366
|
+
### sb_ppu_address
|
|
2367
|
+
|
|
2368
|
+
```c
|
|
2369
|
+
void sb_ppu_address(unsigned int address);
|
|
2370
|
+
```
|
|
2371
|
+
|
|
2372
|
+
设置显存地址($2006),之后读写 $2007 从这里开始。
|
|
2373
|
+
|
|
2374
|
+
参数:
|
|
2375
|
+
|
|
2376
|
+
- `address`:显存地址。
|
|
2377
|
+
|
|
2378
|
+
<a id="sb_ppu_write"></a>
|
|
2379
|
+
### sb_ppu_write
|
|
2380
|
+
|
|
2381
|
+
```c
|
|
2382
|
+
void sb_ppu_write(unsigned int address, const unsigned char *data, unsigned int count);
|
|
2383
|
+
```
|
|
2384
|
+
|
|
2385
|
+
把一段数据写进显存。
|
|
2386
|
+
|
|
2387
|
+
参数:
|
|
2388
|
+
|
|
2389
|
+
- `address`:显存起始地址。
|
|
2390
|
+
- `data`:数据。
|
|
2391
|
+
- `count`:字节数。
|
|
2392
|
+
|
|
2393
|
+
<a id="sb_ppu_fill"></a>
|
|
2394
|
+
### sb_ppu_fill
|
|
2395
|
+
|
|
2396
|
+
```c
|
|
2397
|
+
void sb_ppu_fill(unsigned int address, unsigned char value, unsigned int count);
|
|
2398
|
+
```
|
|
2399
|
+
|
|
2400
|
+
把显存的一段填成同一个值。
|
|
2401
|
+
|
|
2402
|
+
参数:
|
|
2403
|
+
|
|
2404
|
+
- `address`:显存起始地址。
|
|
2405
|
+
- `value`:填充值。
|
|
2406
|
+
- `count`:字节数。
|
|
2407
|
+
|
|
2408
|
+
<a id="sb_ppu_peek"></a>
|
|
2409
|
+
### sb_ppu_peek
|
|
2410
|
+
|
|
2411
|
+
```c
|
|
2412
|
+
unsigned char sb_ppu_peek(unsigned int address);
|
|
2413
|
+
```
|
|
2414
|
+
|
|
2415
|
+
读显存的一个字节。设地址后第一次读只刷新缓冲,所以函数设两次地址,取第二次读到的值。
|
|
2416
|
+
|
|
2417
|
+
参数:
|
|
2418
|
+
|
|
2419
|
+
- `address`:显存地址。
|
|
2420
|
+
|
|
2421
|
+
返回:该地址的内容。
|
|
2422
|
+
|
|
2423
|
+
<a id="sb_ppu_read"></a>
|
|
2424
|
+
### sb_ppu_read
|
|
2425
|
+
|
|
2426
|
+
```c
|
|
2427
|
+
void sb_ppu_read(unsigned int address, unsigned char *dest, unsigned int count);
|
|
2428
|
+
```
|
|
2429
|
+
|
|
2430
|
+
读一段显存。
|
|
2431
|
+
|
|
2432
|
+
参数:
|
|
2433
|
+
|
|
2434
|
+
- `address`:显存起始地址。
|
|
2435
|
+
- `dest`:存放数据的缓冲。
|
|
2436
|
+
- `count`:字节数。
|
|
2437
|
+
|
|
2438
|
+
<a id="sb_ppu_palette_set"></a>
|
|
2439
|
+
### sb_ppu_palette_set
|
|
2440
|
+
|
|
2441
|
+
```c
|
|
2442
|
+
void sb_ppu_palette_set(unsigned char index, unsigned char color);
|
|
2443
|
+
```
|
|
2444
|
+
|
|
2445
|
+
写调色板的一项($2040 起共 64 项:背景 0-31,精灵 32-63)。
|
|
2446
|
+
|
|
2447
|
+
参数:
|
|
2448
|
+
|
|
2449
|
+
- `index`:项号,0 到 63。
|
|
2450
|
+
- `color`:颜色:低 4 位色相,位 5-4 亮度。
|
|
2451
|
+
|
|
2452
|
+
<a id="sb_ppu_palette_get"></a>
|
|
2453
|
+
### sb_ppu_palette_get
|
|
2454
|
+
|
|
2455
|
+
```c
|
|
2456
|
+
unsigned char sb_ppu_palette_get(unsigned char index);
|
|
2457
|
+
```
|
|
2458
|
+
|
|
2459
|
+
读调色板的一项,只返回低 6 位(读出的位 6 恒为 1,已去掉)。
|
|
2460
|
+
|
|
2461
|
+
参数:
|
|
2462
|
+
|
|
2463
|
+
- `index`:项号,0 到 63。
|
|
2464
|
+
|
|
2465
|
+
返回:颜色。
|
|
2466
|
+
|
|
2467
|
+
<a id="sb_ppu_oam_clear"></a>
|
|
2468
|
+
### sb_ppu_oam_clear
|
|
2469
|
+
|
|
2470
|
+
```c
|
|
2471
|
+
void sb_ppu_oam_clear(void);
|
|
2472
|
+
```
|
|
2473
|
+
|
|
2474
|
+
把精灵 RAM 的 256 字节全部填成 $F0,使全部 64 个精灵都在屏幕之外。
|
|
2475
|
+
|
|
2476
|
+
<a id="sb_ppu_oam_put"></a>
|
|
2477
|
+
### sb_ppu_oam_put
|
|
2478
|
+
|
|
2479
|
+
```c
|
|
2480
|
+
void sb_ppu_oam_put(unsigned char index, unsigned char y, unsigned char tile, unsigned char attr, unsigned char x);
|
|
2481
|
+
```
|
|
2482
|
+
|
|
2483
|
+
写一个精灵(4 字节)。读回时属性的位 4-2 总是 1(真机实测)。
|
|
2484
|
+
|
|
2485
|
+
参数:
|
|
2486
|
+
|
|
2487
|
+
- `index`:精灵序号,0 到 63。
|
|
2488
|
+
- `y`:垂直位置,实际显示在 y + 1 行。
|
|
2489
|
+
- `tile`:图块号。
|
|
2490
|
+
- `attr`:属性:位 7 垂直翻转,位 6 水平镜像,位 5 在背景之后,位 1-0 调色板组。
|
|
2491
|
+
- `x`:水平位置。
|
|
2492
|
+
|
|
2493
|
+
<a id="sb_ppu_wait_vblank"></a>
|
|
2494
|
+
### sb_ppu_wait_vblank
|
|
2495
|
+
|
|
2496
|
+
```c
|
|
2497
|
+
unsigned char sb_ppu_wait_vblank(void);
|
|
2498
|
+
```
|
|
2499
|
+
|
|
2500
|
+
等垂直消隐:轮询 $2002 直到位 7 为 1,最多读 65535 次。
|
|
2501
|
+
|
|
2502
|
+
返回:读到垂直消隐时 $2002 的值;超时返回 0。
|
|
2503
|
+
|
|
2504
|
+
<a id="sb_ppu_render"></a>
|
|
2505
|
+
### sb_ppu_render
|
|
2506
|
+
|
|
2507
|
+
```c
|
|
2508
|
+
void sb_ppu_render(unsigned char mask, unsigned char control, unsigned char ext);
|
|
2509
|
+
```
|
|
2510
|
+
|
|
2511
|
+
设置控制寄存器与扩展控制寄存器、滚动回到 (0, 0),最后写显示寄存器打开显示。
|
|
2512
|
+
|
|
2513
|
+
参数:
|
|
2514
|
+
|
|
2515
|
+
- `mask`:显示寄存器($2001)的值,如 SB_HW_MASK_BG | SB_HW_MASK_SPRITE。
|
|
2516
|
+
- `control`:控制寄存器($2000)的值,不要带允许 NMI 的位,除非 NMI 已经准备好。
|
|
2517
|
+
- `ext`:扩展控制寄存器($2008)的值。
|
|
2518
|
+
|
|
2285
2519
|
<a id="printer"></a>
|
|
2286
2520
|
## 打印机(sb2000-printer.h)
|
|
2287
2521
|
|
|
@@ -3183,6 +3417,81 @@ void sb_beep(void);
|
|
|
3183
3417
|
|
|
3184
3418
|
发一声提示音,用方波通道 2。
|
|
3185
3419
|
|
|
3420
|
+
<a id="timer"></a>
|
|
3421
|
+
## 硬件定时器(sb2000-timer.h)
|
|
3422
|
+
|
|
3423
|
+
| 函数 | 说明 | 系统调用 |
|
|
3424
|
+
| --- | --- | --- |
|
|
3425
|
+
| [`sb_timer_start`](#sb_timer_start) | 设置并启动定时器:先写控制字节,再写预置值(预置值同时装入当前值)。 | |
|
|
3426
|
+
| [`sb_timer_stop`](#sb_timer_stop) | 停止定时器:控制字节写 0。 | |
|
|
3427
|
+
| [`sb_timer_current`](#sb_timer_current) | 读定时器当前值(递减)。 | |
|
|
3428
|
+
| [`sb_timer_pending`](#sb_timer_pending) | 读定时器下溢标志($4033 的位 7)。 | |
|
|
3429
|
+
| [`sb_timer_mask`](#sb_timer_mask) | 屏蔽定时器中断并清除下溢标志。 | |
|
|
3430
|
+
| [`sb_timer_unmask`](#sb_timer_unmask) | 允许定时器中断:之后下溢时置标志,并产生中断(中断没有被关掉时)。 | |
|
|
3431
|
+
|
|
3432
|
+
<a id="sb_timer_start"></a>
|
|
3433
|
+
### sb_timer_start
|
|
3434
|
+
|
|
3435
|
+
```c
|
|
3436
|
+
void sb_timer_start(unsigned char control, unsigned char preset);
|
|
3437
|
+
```
|
|
3438
|
+
|
|
3439
|
+
设置并启动定时器:先写控制字节,再写预置值(预置值同时装入当前值)。
|
|
3440
|
+
|
|
3441
|
+
参数:
|
|
3442
|
+
|
|
3443
|
+
- `control`:控制字节:位 7 允许,位 6 连续重载(0 只计一次),位 5 行消隐时钟(0 是 CPU 时钟),位 3-0 预分频。
|
|
3444
|
+
- `preset`:预置值。
|
|
3445
|
+
|
|
3446
|
+
<a id="sb_timer_stop"></a>
|
|
3447
|
+
### sb_timer_stop
|
|
3448
|
+
|
|
3449
|
+
```c
|
|
3450
|
+
void sb_timer_stop(void);
|
|
3451
|
+
```
|
|
3452
|
+
|
|
3453
|
+
停止定时器:控制字节写 0。
|
|
3454
|
+
|
|
3455
|
+
<a id="sb_timer_current"></a>
|
|
3456
|
+
### sb_timer_current
|
|
3457
|
+
|
|
3458
|
+
```c
|
|
3459
|
+
unsigned char sb_timer_current(void);
|
|
3460
|
+
```
|
|
3461
|
+
|
|
3462
|
+
读定时器当前值(递减)。
|
|
3463
|
+
|
|
3464
|
+
返回:当前值。
|
|
3465
|
+
|
|
3466
|
+
<a id="sb_timer_pending"></a>
|
|
3467
|
+
### sb_timer_pending
|
|
3468
|
+
|
|
3469
|
+
```c
|
|
3470
|
+
unsigned char sb_timer_pending(void);
|
|
3471
|
+
```
|
|
3472
|
+
|
|
3473
|
+
读定时器下溢标志($4033 的位 7)。
|
|
3474
|
+
|
|
3475
|
+
返回:1 已下溢;0 没有。
|
|
3476
|
+
|
|
3477
|
+
<a id="sb_timer_mask"></a>
|
|
3478
|
+
### sb_timer_mask
|
|
3479
|
+
|
|
3480
|
+
```c
|
|
3481
|
+
void sb_timer_mask(void);
|
|
3482
|
+
```
|
|
3483
|
+
|
|
3484
|
+
屏蔽定时器中断并清除下溢标志。
|
|
3485
|
+
|
|
3486
|
+
<a id="sb_timer_unmask"></a>
|
|
3487
|
+
### sb_timer_unmask
|
|
3488
|
+
|
|
3489
|
+
```c
|
|
3490
|
+
void sb_timer_unmask(void);
|
|
3491
|
+
```
|
|
3492
|
+
|
|
3493
|
+
允许定时器中断:之后下溢时置标志,并产生中断(中断没有被关掉时)。
|
|
3494
|
+
|
|
3186
3495
|
<a id="sb2000"></a>
|
|
3187
3496
|
## 总头文件与通用调用(sb2000.h)
|
|
3188
3497
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
; ------------------------------------------------------------------------
|
|
2
2
|
; 名称:sb2000.inc
|
|
3
|
-
; 说明:SB-DOS
|
|
3
|
+
; 说明:SB-DOS 程序接口的符号定义:系统调用变量、功能号、子功能号、出错码、文件打开方式、硬件寄存器与位、运行库入口,便于直接用名字写程序。
|
|
4
4
|
; 作者:sungbin
|
|
5
5
|
; 邮箱:sungbin@3578.cn
|
|
6
6
|
; 日期:2026-11-10
|
|
@@ -288,6 +288,95 @@ PARAM_064F = $064F ; 个数、长度或字节数,含义
|
|
|
288
288
|
PARAM_0652 = $0652 ; 通用参数,多数服务从这里取输入
|
|
289
289
|
PARAM_0653 = $0653 ; 通用参数或返回值,如读到的字节
|
|
290
290
|
|
|
291
|
+
; ---- 硬件寄存器:图形(真机为 UM6576,行为以真机实测为准,见 docs/sb2000/03-硬件说明.md)----
|
|
292
|
+
HW_PPU_CTRL = $2000 ; 控制:位 7 允许 NMI,位 5 精灵 8x16,位 2 地址增量,位 1-0 背景页
|
|
293
|
+
HW_PPU_MASK = $2001 ; 显示:灰度、最左 8 像素、背景与精灵显示、颜色增强
|
|
294
|
+
HW_PPU_STATUS = $2002 ; 状态(读):位 7 垂直消隐,位 6 精灵 0 碰撞,位 5 一行超过 8 个精灵
|
|
295
|
+
HW_OAM_ADDRESS = $2003 ; 精灵 RAM 地址
|
|
296
|
+
HW_OAM_DATA = $2004 ; 精灵 RAM 数据
|
|
297
|
+
HW_PPU_SCROLL = $2005 ; 滚动,连续写两次(X、Y)
|
|
298
|
+
HW_PPU_ADDRESS = $2006 ; 显存地址,连续写两次(高、低)
|
|
299
|
+
HW_PPU_DATA = $2007 ; 显存数据,读要先读一次刷新缓冲
|
|
300
|
+
HW_PPU_EXT = $2008 ; 扩展控制:位 7 背景 16 色,位 3-2 精灵图案表,位 0 名称表起始
|
|
301
|
+
HW_PALETTE = $2040 ; 调色板,64 项($2040-$207F)
|
|
302
|
+
HW_OAM_DMA = $4014 ; 精灵 DMA:写页号,把 $xx00 起的 256 字节送进精灵 RAM
|
|
303
|
+
|
|
304
|
+
; ---- 硬件寄存器:外设与中断 ----
|
|
305
|
+
HW_SOUND_ENABLE = $4015 ; 声音通道使能
|
|
306
|
+
HW_PAD_1 = $4016 ; 手柄 1
|
|
307
|
+
HW_PAD_2 = $4017 ; 手柄 2
|
|
308
|
+
HW_KEY_DATA = $4020 ; 读:键盘扫描码;写:位 7 为 1 时 DMA 控制的位 6、5 才起作用
|
|
309
|
+
HW_KEY_SEND = $4021 ; 发给键盘的数据
|
|
310
|
+
HW_KEY_CONTROL = $4022 ; 键盘控制:位 7 键盘时钟,位 2 允许发送完成中断,位 0 方向
|
|
311
|
+
HW_MOUSE_SELECT = $4023 ; 位 0 选手柄 2 或鼠标
|
|
312
|
+
HW_MOUSE_DATA = $4024 ; 鼠标数据
|
|
313
|
+
HW_PRINTER_DATA = $4025 ; 打印机数据
|
|
314
|
+
HW_EXT_IO = $4026 ; 扩展 I/O
|
|
315
|
+
HW_DAC = $4027 ; 8 位 DAC
|
|
316
|
+
HW_INIT = $4031 ; 初始设置:依次写 $65、$76 进入 6576 模式
|
|
317
|
+
HW_IRQ_MASK = $4032 ; 中断屏蔽:写 1 的位被屏蔽,同时清除 HW_IRQ_PENDING 里对应的位
|
|
318
|
+
HW_IRQ_PENDING = $4033 ; 待处理的中断(只读)
|
|
319
|
+
HW_TIMER_CONTROL = $4034 ; 定时器控制:位 7 允许,位 6 连续重载,位 5 行消隐时钟,位 3-0 预分频
|
|
320
|
+
HW_TIMER_PRESET = $4035 ; 定时器预置值,写入时同时装入当前值
|
|
321
|
+
HW_TIMER_CURRENT = $4036 ; 定时器当前值(递减)
|
|
322
|
+
HW_RTC_ADDRESS = $4080 ; 实时时钟地址
|
|
323
|
+
HW_RTC_DATA = $4081 ; 实时时钟数据
|
|
324
|
+
|
|
325
|
+
; ---- 硬件寄存器:程序窗口、DMA 与显存 bank ----
|
|
326
|
+
HW_WINDOW_0 = $4040 ; 窗口 0($8000)的页号,4K 一页
|
|
327
|
+
HW_WINDOW_1 = $4041 ; 窗口 1($9000)的页号
|
|
328
|
+
HW_WINDOW_2 = $4042 ; 窗口 2($A000)的页号
|
|
329
|
+
HW_WINDOW_3 = $4043 ; 窗口 3($B000)的页号
|
|
330
|
+
HW_WINDOW_4 = $4044 ; 窗口 4($C000)的页号
|
|
331
|
+
HW_WINDOW_5 = $4045 ; 窗口 5($D000)的页号
|
|
332
|
+
HW_WINDOW_6 = $4046 ; 窗口 6($E000)的页号
|
|
333
|
+
HW_WINDOW_7 = $4047 ; 窗口 7($F000)的页号
|
|
334
|
+
HW_DMA_MODE = $4048 ; DMA 模式:位 7 启动,位 6 高速,位 5 目的是 CPU 地址
|
|
335
|
+
HW_DMA_SOURCE_BANK = $4049 ; DMA 源 bank:位 4 为 1 取扩展 RAM,低 4 位是源地址的第 18-15 位
|
|
336
|
+
HW_DMA_SOURCE_LOW = $404A ; DMA 源地址的第 7-0 位
|
|
337
|
+
HW_DMA_SOURCE_HIGH = $404B ; DMA 源地址:位 6-0 是第 14-8 位,位 7 要为 1
|
|
338
|
+
HW_DMA_DEST_LOW = $404C ; DMA 目的地址低字节
|
|
339
|
+
HW_DMA_DEST_HIGH = $404D ; DMA 目的地址高字节,目的是显存时位 7 为 1 表示扩展显存
|
|
340
|
+
HW_DMA_LENGTH_LOW = $404E ; DMA 长度低字节,写“字节数 - 1”
|
|
341
|
+
HW_DMA_LENGTH_HIGH = $404F ; DMA 长度高字节
|
|
342
|
+
HW_VRAM_BANK = $4300 ; 扩展显存的 32K bank
|
|
343
|
+
HW_RESET_6576 = $4301 ; 写 $55 回到 FC 兼容模式
|
|
344
|
+
HW_VOICE_PORT = $4302 ; 语音端口
|
|
345
|
+
|
|
346
|
+
; ---- 硬件寄存器的位 ----
|
|
347
|
+
HW_CTRL_NMI = $80 ; HW_PPU_CTRL:允许 NMI
|
|
348
|
+
HW_CTRL_SPRITE_8X16 = $20 ; HW_PPU_CTRL:精灵 8x16
|
|
349
|
+
HW_CTRL_STEP_32 = $04 ; HW_PPU_CTRL:显存地址每次加 32
|
|
350
|
+
HW_MASK_GRAY = $01 ; HW_PPU_MASK:灰度
|
|
351
|
+
HW_MASK_BG_LEFT = $02 ; HW_PPU_MASK:显示背景最左 8 像素
|
|
352
|
+
HW_MASK_SPRITE_LEFT = $04 ; HW_PPU_MASK:显示精灵最左 8 像素
|
|
353
|
+
HW_MASK_BG = $08 ; HW_PPU_MASK:显示背景
|
|
354
|
+
HW_MASK_SPRITE = $10 ; HW_PPU_MASK:显示精灵
|
|
355
|
+
HW_MASK_TINT_GREEN = $20 ; HW_PPU_MASK:增强绿(PAL 顺序)
|
|
356
|
+
HW_MASK_TINT_RED = $40 ; HW_PPU_MASK:增强红
|
|
357
|
+
HW_MASK_TINT_BLUE = $80 ; HW_PPU_MASK:增强蓝
|
|
358
|
+
HW_STATUS_VBLANK = $80 ; HW_PPU_STATUS:垂直消隐
|
|
359
|
+
HW_STATUS_SPRITE0 = $40 ; HW_PPU_STATUS:精灵 0 碰撞
|
|
360
|
+
HW_STATUS_OVERFLOW = $20 ; HW_PPU_STATUS:一行超过 8 个精灵
|
|
361
|
+
HW_EXT_16_COLOR = $80 ; HW_PPU_EXT:背景 16 色
|
|
362
|
+
HW_EXT_NAMES_2000 = $01 ; HW_PPU_EXT:名称表从显存 $2000 起
|
|
363
|
+
HW_KEY_DMA_ENABLE = $80 ; HW_KEY_DATA(写):使能 DMA 模式的位 6、5
|
|
364
|
+
HW_DMA_START = $80 ; HW_DMA_MODE:启动
|
|
365
|
+
HW_DMA_FAST = $40 ; HW_DMA_MODE:高速(1.78MB/s)
|
|
366
|
+
HW_DMA_TO_CPU = $20 ; HW_DMA_MODE:目的是 CPU 地址(工作 RAM)
|
|
367
|
+
HW_DMA_SOURCE_RAM = $10 ; HW_DMA_SOURCE_BANK:源是扩展 RAM
|
|
368
|
+
HW_DMA_SOURCE_A15 = $80 ; HW_DMA_SOURCE_HIGH:源地址的第 15 位,真机要求为 1
|
|
369
|
+
HW_TIMER_ENABLE = $80 ; HW_TIMER_CONTROL:允许
|
|
370
|
+
HW_TIMER_RELOAD = $40 ; HW_TIMER_CONTROL:连续重载
|
|
371
|
+
HW_TIMER_LINE_CLOCK = $20 ; HW_TIMER_CONTROL:基准时钟用行消隐时钟
|
|
372
|
+
HW_IRQ_TIMER = $80 ; HW_IRQ_MASK、HW_IRQ_PENDING:定时器
|
|
373
|
+
HW_IRQ_MOUSE = $40 ; 鼠标
|
|
374
|
+
HW_IRQ_KEYBOARD = $20 ; 键盘
|
|
375
|
+
HW_IRQ_4 = $10 ; 中断 4
|
|
376
|
+
HW_IRQ_FLOPPY = $08 ; 软驱
|
|
377
|
+
HW_IRQ_2 = $04 ; 中断 2
|
|
378
|
+
HW_IRQ_1 = $02 ; 中断 1
|
|
379
|
+
|
|
291
380
|
; ---- 文件打开方式(FILE_MODE)----
|
|
292
381
|
MODE_OPEN = $00 ; 打开已有文件
|
|
293
382
|
MODE_CREATE = $01 ; 创建文件,已存在则覆盖
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* ------------------------------------------------------------------------
|
|
3
|
+
* 名称:sb2000-dma.h
|
|
4
|
+
* 说明:通用 DMA($4048-$404F):把扩展 RAM 里的数据复制到 CPU 地址或显存。
|
|
5
|
+
* 作者:sungbin
|
|
6
|
+
* 邮箱:sungbin@3578.cn
|
|
7
|
+
* 日期:2026-11-13
|
|
8
|
+
* 备注:由 sb2000.h 引入,程序不必单独包含。按真机实测封装:源只能是扩展 RAM,目的是 CPU 地址时只能写 ERAM($8000 以上的程序窗口写不进去);
|
|
9
|
+
* 长度寄存器写“字节数 - 1”,源地址高字节的位 7 必须为 1,这些都由函数处理。函数不检查显示状态,复制到显存时调用者要先关显示或在垂直消隐期间调用。
|
|
10
|
+
* 函数返回前会等一段足够 DMA 完成的时间,复制到 CPU 地址时返回后就能直接读。硬件细节见 docs/sb2000/03-硬件说明.md。
|
|
11
|
+
* ------------------------------------------------------------------------
|
|
12
|
+
*/
|
|
13
|
+
#ifndef SB2000_DMA_H
|
|
14
|
+
#define SB2000_DMA_H
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* 把扩展 RAM 的页号与页内偏移换算成 DMA 的源地址。
|
|
18
|
+
*
|
|
19
|
+
* @param page 扩展 RAM 页号,0x80 到 0xFF。
|
|
20
|
+
* @param offset 页内偏移,可以超过一页。
|
|
21
|
+
* @return 源地址,传给 sb_dma_to_cpu、sb_dma_to_vram。
|
|
22
|
+
*/
|
|
23
|
+
unsigned long sb_dma_page_address(unsigned char page, unsigned int offset);
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* 用 DMA 把扩展 RAM 里的数据复制到 CPU 地址。只有目的在 ERAM($6000-$7FFF)时有效,目的范围不能越过 $8000。
|
|
27
|
+
*
|
|
28
|
+
* @param source 源地址,用 sb_dma_page_address 换算。
|
|
29
|
+
* @param dest 目的 CPU 地址。
|
|
30
|
+
* @param length 字节数,1 到 $8000。
|
|
31
|
+
* @return 0 成功;SB_ERR_BAD_PARAMETER 长度为 0 或超过 $8000,或目的范围越过 $8000。
|
|
32
|
+
*/
|
|
33
|
+
unsigned char sb_dma_to_cpu(unsigned long source, unsigned int dest, unsigned int length);
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* 用 DMA 把扩展 RAM 里的数据复制到显存。目的地址不小于 $8000 时是扩展显存,再加 $4300 选的 32K bank,否则是内置字符 RAM。
|
|
37
|
+
* 调用时要关着显示,或在垂直消隐期间。
|
|
38
|
+
*
|
|
39
|
+
* @param source 源地址,用 sb_dma_page_address 换算。
|
|
40
|
+
* @param dest 目的显存地址。
|
|
41
|
+
* @param length 字节数,1 到 $8000。
|
|
42
|
+
* @return 0 成功;SB_ERR_BAD_PARAMETER 长度为 0 或超过 $8000。
|
|
43
|
+
*/
|
|
44
|
+
unsigned char sb_dma_to_vram(unsigned long source, unsigned int dest, unsigned int length);
|
|
45
|
+
|
|
46
|
+
#endif
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* ------------------------------------------------------------------------
|
|
3
|
+
* 名称:sb2000-ppu.h
|
|
4
|
+
* 说明:直接操作图形端口($2000-$2008):显存读写、调色板、精灵 RAM、等垂直消隐、打开显示。
|
|
5
|
+
* 作者:sungbin
|
|
6
|
+
* 邮箱:sungbin@3578.cn
|
|
7
|
+
* 日期:2026-11-13
|
|
8
|
+
* 备注:由 sb2000.h 引入,程序不必单独包含。显存、调色板、精灵 RAM 只能在关着显示或垂直消隐期间访问,调用者先用 sb_display_off 关显示、
|
|
9
|
+
* 用完用 sb_display_on 恢复;显存地址不小于 $8000 时是扩展显存,再加 $4300 选的 32K bank。$2000 的地址增量位要为 0。
|
|
10
|
+
* 寄存器的位定义见 sb2000-symbols.h 里的 SB_HW_ 常量,行为见 docs/sb2000/03-硬件说明.md。
|
|
11
|
+
* ------------------------------------------------------------------------
|
|
12
|
+
*/
|
|
13
|
+
#ifndef SB2000_PPU_H
|
|
14
|
+
#define SB2000_PPU_H
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* 设置显存地址($2006),之后读写 $2007 从这里开始。
|
|
18
|
+
*
|
|
19
|
+
* @param address 显存地址。
|
|
20
|
+
*/
|
|
21
|
+
void sb_ppu_address(unsigned int address);
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* 把一段数据写进显存。
|
|
25
|
+
*
|
|
26
|
+
* @param address 显存起始地址。
|
|
27
|
+
* @param data 数据。
|
|
28
|
+
* @param count 字节数。
|
|
29
|
+
*/
|
|
30
|
+
void sb_ppu_write(unsigned int address, const unsigned char *data, unsigned int count);
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* 把显存的一段填成同一个值。
|
|
34
|
+
*
|
|
35
|
+
* @param address 显存起始地址。
|
|
36
|
+
* @param value 填充值。
|
|
37
|
+
* @param count 字节数。
|
|
38
|
+
*/
|
|
39
|
+
void sb_ppu_fill(unsigned int address, unsigned char value, unsigned int count);
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* 读显存的一个字节。设地址后第一次读只刷新缓冲,所以函数设两次地址,取第二次读到的值。
|
|
43
|
+
*
|
|
44
|
+
* @param address 显存地址。
|
|
45
|
+
* @return 该地址的内容。
|
|
46
|
+
*/
|
|
47
|
+
unsigned char sb_ppu_peek(unsigned int address);
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* 读一段显存。
|
|
51
|
+
*
|
|
52
|
+
* @param address 显存起始地址。
|
|
53
|
+
* @param dest 存放数据的缓冲。
|
|
54
|
+
* @param count 字节数。
|
|
55
|
+
*/
|
|
56
|
+
void sb_ppu_read(unsigned int address, unsigned char *dest, unsigned int count);
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* 写调色板的一项($2040 起共 64 项:背景 0-31,精灵 32-63)。
|
|
60
|
+
*
|
|
61
|
+
* @param index 项号,0 到 63。
|
|
62
|
+
* @param color 颜色:低 4 位色相,位 5-4 亮度。
|
|
63
|
+
*/
|
|
64
|
+
void sb_ppu_palette_set(unsigned char index, unsigned char color);
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* 读调色板的一项,只返回低 6 位(读出的位 6 恒为 1,已去掉)。
|
|
68
|
+
*
|
|
69
|
+
* @param index 项号,0 到 63。
|
|
70
|
+
* @return 颜色。
|
|
71
|
+
*/
|
|
72
|
+
unsigned char sb_ppu_palette_get(unsigned char index);
|
|
73
|
+
|
|
74
|
+
/**
|
|
75
|
+
* 把精灵 RAM 的 256 字节全部填成 $F0,使全部 64 个精灵都在屏幕之外。
|
|
76
|
+
*/
|
|
77
|
+
void sb_ppu_oam_clear(void);
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* 写一个精灵(4 字节)。读回时属性的位 4-2 总是 1(真机实测)。
|
|
81
|
+
*
|
|
82
|
+
* @param index 精灵序号,0 到 63。
|
|
83
|
+
* @param y 垂直位置,实际显示在 y + 1 行。
|
|
84
|
+
* @param tile 图块号。
|
|
85
|
+
* @param attr 属性:位 7 垂直翻转,位 6 水平镜像,位 5 在背景之后,位 1-0 调色板组。
|
|
86
|
+
* @param x 水平位置。
|
|
87
|
+
*/
|
|
88
|
+
void sb_ppu_oam_put(unsigned char index, unsigned char y, unsigned char tile, unsigned char attr, unsigned char x);
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* 等垂直消隐:轮询 $2002 直到位 7 为 1,最多读 65535 次。
|
|
92
|
+
*
|
|
93
|
+
* @return 读到垂直消隐时 $2002 的值;超时返回 0。
|
|
94
|
+
*/
|
|
95
|
+
unsigned char sb_ppu_wait_vblank(void);
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* 设置控制寄存器与扩展控制寄存器、滚动回到 (0, 0),最后写显示寄存器打开显示。
|
|
99
|
+
*
|
|
100
|
+
* @param mask 显示寄存器($2001)的值,如 SB_HW_MASK_BG | SB_HW_MASK_SPRITE。
|
|
101
|
+
* @param control 控制寄存器($2000)的值,不要带允许 NMI 的位,除非 NMI 已经准备好。
|
|
102
|
+
* @param ext 扩展控制寄存器($2008)的值。
|
|
103
|
+
*/
|
|
104
|
+
void sb_ppu_render(unsigned char mask, unsigned char control, unsigned char ext);
|
|
105
|
+
|
|
106
|
+
#endif
|