Browse Source

Merge branch 'master' into dev/BoatFest_Talk

pull/603/head
Marshall G. Gates 6 months ago
parent
commit
0d5681d2db
  1. 3
      .github/workflows/commit.yml
  2. 18
      .github/workflows/release.yml
  3. 21
      .gitignore
  4. 36
      .vscode/settings.json
  5. 81
      Doc/CPM/BPBIOS/BPBIOS_1_Introduction.md
  6. 36
      Doc/CPM/BPBIOS/BPBIOS_2_Features.md
  7. 232
      Doc/CPM/BPBIOS/BPBIOS_3_Tailoring.md
  8. 200
      Doc/CPM/BPBIOS/BPBIOS_4_Installation.md
  9. 1364
      Doc/CPM/BPBIOS/BPBIOS_5_Programming.md
  10. 2579
      Doc/CPM/BPBIOS/BPBIOS_6_Utilities.md
  11. 37
      Doc/CPM/BPBIOS/BPBIOS_7_ZSDOS2.md
  12. 10
      Doc/CPM/BPBIOS/BPBIOS_8_ZCPR4.md
  13. 100
      Doc/CPM/BPBIOS/BPBIOS_9_Glossary.md
  14. 8
      Doc/CPM/ReadMe.txt
  15. 483
      Doc/CPM/ZPM3.txt
  16. 18
      Doc/ChangeLog.txt
  17. BIN
      Doc/Language/Cowgol Compiler Manual.pdf
  18. 99
      Doc/Language/HI-TECH Z80 C Compiler Messages.txt
  19. 28
      Doc/Language/ReadMe.txt
  20. 3
      Doc/ReadMe.txt
  21. BIN
      Doc/RomWBW Applications.pdf
  22. BIN
      Doc/RomWBW Disk Catalog.pdf
  23. BIN
      Doc/RomWBW Hardware.pdf
  24. BIN
      Doc/RomWBW Introduction.pdf
  25. BIN
      Doc/RomWBW System Guide.pdf
  26. BIN
      Doc/RomWBW User Guide.pdf
  27. 12
      Dockerfile
  28. 7
      Makefile
  29. 29
      ReadMe.md
  30. 29
      ReadMe.txt
  31. 16
      Source/Apps/Tune/cli.inc
  32. 2
      Source/Apps/Tune/hbios.inc
  33. 6
      Source/Apps/Tune/timing.inc
  34. 9
      Source/Apps/Tune/tune.asm
  35. 22
      Source/Apps/assign/assign.asm
  36. 34
      Source/Apps/slabel/slabel.asm
  37. 7
      Source/BPBIOS/@WBW Issues.txt
  38. 1
      Source/BPBIOS/Build.cmd
  39. 1
      Source/BPBIOS/Clean.cmd
  40. 2
      Source/BPBIOS/Makefile
  41. 55
      Source/BPBIOS/UTIL/Build.cmd
  42. 6
      Source/BPBIOS/UTIL/Clean.cmd
  43. 40
      Source/BPBIOS/UTIL/Makefile
  44. 2357
      Source/BPBIOS/UTIL/bpbuild.z80
  45. 4539
      Source/BPBIOS/UTIL/bpcnfg.z80
  46. 483
      Source/BPBIOS/UTIL/bpswap.z80
  47. 636
      Source/BPBIOS/UTIL/bpsysgen.z80
  48. 489
      Source/BPBIOS/UTIL/confz4.z80
  49. 752
      Source/BPBIOS/UTIL/hashini.z80
  50. 640
      Source/BPBIOS/UTIL/ldsys.z80
  51. 409
      Source/BPBIOS/UTIL/showhd.z80
  52. 546
      Source/BPBIOS/UTIL/sizeram.z80
  53. 1323
      Source/BPBIOS/UTIL/zscfg2.z80
  54. 1247
      Source/BPBIOS/bpart.txt
  55. 1
      Source/Build.cmd
  56. 4
      Source/BuildBP.cmd
  57. 2
      Source/BuildShared.cmd
  58. 11
      Source/CBIOS/cbios.asm
  59. 23
      Source/CPM22/ReadMe.txt
  60. 1
      Source/Clean.cmd
  61. 587
      Source/Doc/Applications.md
  62. 9
      Source/Doc/Basic.h
  63. 434
      Source/Doc/Catalog.md
  64. 47
      Source/Doc/Hardware.md
  65. 835
      Source/Doc/Introduction.md
  66. 18
      Source/Doc/Makefile
  67. 296
      Source/Doc/ReadMe.md
  68. 98
      Source/Doc/SystemGuide.md
  69. 109
      Source/Doc/UserGuide.md
  70. 16
      Source/Doc/mkdocs.yml
  71. 25
      Source/Fonts/Build.cmd
  72. 15
      Source/Fonts/Makefile
  73. BIN
      Source/Fonts/font6x8.png
  74. BIN
      Source/Fonts/font6x8u.bin
  75. BIN
      Source/Fonts/font8x16.png
  76. BIN
      Source/Fonts/font8x16u.bin
  77. BIN
      Source/Fonts/font8x8.png
  78. BIN
      Source/Fonts/font8x8u.bin
  79. BIN
      Source/Fonts/fontcga.png
  80. BIN
      Source/Fonts/fontcgau.bin
  81. 48
      Source/Fonts/fonts.txt
  82. BIN
      Source/Fonts/fontvgarc.png
  83. BIN
      Source/Fonts/fontvgarcu.bin
  84. 66
      Source/HBIOS/Build.cmd
  85. 12
      Source/HBIOS/Config/RCEZ80_std.asm
  86. 6
      Source/HBIOS/Config/RCZ80_std.asm
  87. 61
      Source/HBIOS/Config/RCZ80_xosera.asm
  88. 88
      Source/HBIOS/Layout.txt
  89. 64
      Source/HBIOS/Makefile
  90. 17
      Source/HBIOS/acia.asm
  91. 2
      Source/HBIOS/ansi.asm
  92. 22
      Source/HBIOS/asci.asm
  93. 4
      Source/HBIOS/audio.inc
  94. 4
      Source/HBIOS/ay38910.asm
  95. 6
      Source/HBIOS/cfg_DUO.asm
  96. 2
      Source/HBIOS/cfg_DYNO.asm
  97. 2
      Source/HBIOS/cfg_EPITX.asm
  98. 2
      Source/HBIOS/cfg_EZZ80.asm
  99. 2
      Source/HBIOS/cfg_FZ80.asm
  100. 2
      Source/HBIOS/cfg_GMZ180.asm

3
.github/workflows/commit.yml

@ -26,7 +26,8 @@ jobs:
run: |
export TZ='America/Los_Angeles'
sudo apt-get install srecord
make distlog
make transpile-c-code
make distlog --trace
rm -rf .git*
- name: List Output

18
.github/workflows/release.yml

@ -19,7 +19,8 @@ jobs:
export TZ='America/Los_Angeles'
sudo apt-get install libncurses-dev
sudo apt-get install srecord
make distlog
make transpile-c-code
make distlog --trace
rm -rf .git*
- name: Create Package Archive
@ -52,6 +53,21 @@ jobs:
title: "${{env.TITLE}} ${{github.ref_name}}"
files: |
RomWBW-${{github.ref_name}}-Package.zip
- name: Build Docs
run: |
export TZ='America/Los_Angeles'
sudo apt-get install gpp pandoc
pip install mkdocs
make -C Source/Doc deploy_mkdocs
mkdocs build -f Source/Doc/mkdocs.yml
- name: Deploy Docs
uses: peaceiris/actions-gh-pages@v4
# if: github.ref == 'refs/heads/master'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: Source/Doc/site
# - name: Upload Package Archive
# uses: AButler/upload-release-assets@v2.0.2

21
.gitignore

@ -114,20 +114,24 @@ Source/ZPM3/genbnk.dat
Source/ZSDOS/zsdos.err
# Lets explicit list all generate untracked binary files
Binary/*.upd
Binary/Apps/bbcbasic.txt
Binary/Apps/copysl.doc
Binary/Apps/copysl.doc
Binary/Apps/fdu.doc
Binary/Apps/fdu.doc
Binary/Apps/Tunes/bgm.vgm
Binary/Apps/Tunes/ending.vgm
Binary/Apps/Tunes/inchina.vgm
Binary/Apps/Tunes/shirakaw.vgm
Binary/Apps/Tunes/startdem.vgm
Binary/Apps/Tunes/wonder01.vgm
Binary/Apps/copysl.doc
Binary/Apps/fdu.doc
Binary/Apps/zmconfig.ovr
Binary/Apps/zminit.ovr
Binary/Apps/zmp.doc
Binary/Apps/zmp.hlp
Binary/Apps/zmp.cfg
Binary/Apps/zmp.doc
Binary/Apps/zmp.fon
Binary/Apps/zmp.hlp
Binary/Apps/zmterm.ovr
Binary/Apps/zmxfer.ovr
Binary/CPM3/bdos3.spr
@ -146,13 +150,12 @@ Binary/CPNET/cpn12ser.lbr
Binary/CPNET/cpn3duo.lbr
Binary/CPNET/cpn3mt.lbr
Binary/CPNET/cpn3ser.lbr
Binary/*.upd
Binary/hd1k_prefix.dat
Binary/ZPM3/bnkbdos3.spr
Binary/ZPM3/bnkbios3.spr
Binary/ZPM3/gencpm.dat
Binary/ZPM3/resbdos3.spr
Binary/ZPM3/zinstal.zpm
Binary/hd1k_prefix.dat
Source/BPBIOS/def-ww.lib
Source/CPNET/cpn12duo.lbr
Source/CPNET/cpn12mt.lbr
@ -169,6 +172,9 @@ Source/Fonts/font8x16u.asm
Source/Fonts/font8x8c.asm
Source/Fonts/font8x8c.bin
Source/Fonts/font8x8u.asm
Source/Fonts/font6x8c.asm
Source/Fonts/font6x8c.bin
Source/Fonts/font6x8u.asm
Source/Fonts/fontcgac.asm
Source/Fonts/fontcgac.bin
Source/Fonts/fontcgau.asm
@ -177,6 +183,8 @@ Source/Fonts/fontvgarcc.bin
Source/Fonts/fontvgarcu.asm
Source/HBIOS/*.upd
Source/HBIOS/build_env.cmd
Source/HBIOS/build_env.cmd
Source/HBIOS/hbios_env.sh
Source/HBIOS/hbios_env.sh
Source/HBIOS/netboot.mod
Source/Images/*.cat
@ -194,4 +202,3 @@ Source/ZPM3/setz3.com
Tools/unix/OpenSpin/build/
Tools/unix/zxcc/config.h
Tools/unix/zxcc/zxcc
Binary/Apps/bbcbasic.txt

36
.vscode/settings.json

@ -1,4 +1,38 @@
{
"z80-macroasm.format.enabled": true,
"z80-macroasm.format.baseIndent": 1,
"z80-macroasm.format.whitespaceAfterInstruction": "tab",
"z80-macroasm.format.uppercaseKeywords": true,
"z80-macroasm.format.spaceAfterArgument": true,
"z80-macroasm.format.hexaNumberStyle": "motorola",
"z80-macroasm.format.hexaNumberCase": true,
"files.trimTrailingWhitespace": false,
"files.eol": "\r\n"
"files.eol": "\r\n",
"files.associations": {
"*.inc": "z80-macroasm",
"*.asm": "z80-macroasm",
"*.180": "z80-macroasm",
"*.asm.m4": "z80-macroasm",
"*.inc.m4": "z80-macroasm",
"*.mac": "z80-macroasm",
"*.asmpp": "z80-macroasm",
"*.zdsproj": "xml",
"*.Z80": "z80-macroasm",
"ch376.h": "c",
"protocol.h": "c",
"usb_state.h": "c",
"functional": "c",
"class_scsi.h": "c",
"z80.h": "c",
"dev_transfers.h": "c",
"usb-base-drv.h": "c",
"critical-section.h": "c",
"enumerate.h": "c",
"ch376inc.h": "c",
"enumerate_storage.h": "c",
"work-area.h": "c",
"hbios-driver-storage.h": "c",
"class_hid_keyboard.h": "c",
"print.h": "c"
}
}

81
Doc/CPM/BPBIOS/BPBIOS_1_Introduction.md

@ -0,0 +1,81 @@
# B/P Bios
# Banked and Portable Basic IO System
# 1 Introduction
The Banked and Portable (B/P) Basic I/O System (BIOS) is an effort to standardize many of the logical to physical mapping mechanisms on Microcomputers running Z-Systems with ZSDOS. In expanding the capabilities of such systems, it became apparent that standard BIOSes do not contain the functionality necessary, adequate standardization in extended BIOS calls, nor an internal structure to fully support external determination of system parameters. B/P Bios provides a method of achieving these goals, while also possessing the flexibility to operate on a wide range of hardware systems with a much smaller level of systems programming than previously required.
## 1.1 About This Manual
Documentation on B/P Bios consists of this manual plus the latest addendum on the distribution disk in the file README.2ND. This manual is divided into the following sections:
* The Features of B/P Bios summarizes the significant features of B/P Bios in general, highlighting advantages and the few limitations in the system.
* Tailoring B/P Bios contains details on altering the many options to generate a customized `.REL` file tailored to your system.
* Installing a B/P Bios details the installation of B/P Bios in both Unbanked and Banked configurations in a "how to" fashion.
* Programming for B/P Bios describes the interfaces, data structures and recommended programming practices to insure the maximum benefit and performance from systems with B/P Bios.
* The B/P Bios Utilities describes the purpose, operation, and customization of all supplied B/P Bios utilities and support routines.
* Appendices which summarize various technical information.
* A glossary defining many technical terms used in this Manual.
* An index of key words and phrases used in this Manual.
For those not interested in the technical details, or who want to bring the system up with a pre-configured version as quickly as possible, Section 4, Installing a B/P Bios, will lead you through the installation steps needed to perform the final tailoring to your specific computer. Other chapters cover details of the individual software modules comprising the B/P Bios, and specifics on the utilities provided to ease you use of this product.
## 1.2 Notational Conventions
Various shorthand terms and notations are used throughout this manual. Terms are listed in the Glossary at the end of this manual.
Though the symbols seem cryptic at first, they are a consistent way of briefly summarizing program syntax. Once you learn to read them you can tell at a glance how to enter even the most complicated commands.
Several special symbols are used in program syntax descriptions. By convention, square brackets (\[\]) indicate optional command line items. You may or may not include items shown between brackets in your command, but if you do not, programs usually substitute a default value of their own. If items between brackets are used in a command, all other items between the brackets must also be used, unless these items are themselves bracketed.
All of the support utilities developed to support the B/P Bios system contain built-in help screens which use the above conventions to display helpful syntax summaries. Help is always invoked by following the command with two slashes (`//`). So for example,
`ZXD //`
invokes help for ZXD, the ZSDOS extended directory program. Interactive ZSDOS programs such as BPCNFG2 also contain more detailed help messages which appear as a session progresses.
Many utilities may be invoked from the command line with options which command the programs to behave in slightly different ways. By convention, options are given after other command parameters. For example, the `P` option in the command
`ZXD *.* P`
causes the ZXD directory utility to list all files (*.*) and send its output to the printer (P). For convenience, a single slash character (/) can often be used in place of leading parameters to signify that the rest of the command line consists of option characters. Therefore, the command
`ZXD /P`
is identical in meaning to the previous example (see 6.23 for more on ZXD).
## 1.3 What is B/P Bios?
B/P Bios is a set of software subroutines which directly control the chips and other hardware in your computer and present a standard software interface to the Operating System such as our ZSDOS/ZDDOS, Echelon's ZRDOS, or even Digital Research's CP/M 2.2. These routines comply with the CP/M 2.2 standards for a Basic IO System (BIOS) with many extensions; some based on CP/M 3.x (aka CP/M Plus), and others developed to provide necessary capabilities of modern software. When properly coded, the modules comprising a B/P Bios perform with all the standard support utilities, nearly all Z-System utilities, and most application programs without alteration.
The ability to operate Banked, Non-banked and Boot System versions of the Bios with a single suite of software, across a number of different hardware machines, plus the maximization of Transient Program Area for application programs in banked systems are features which are offered by no other system of which we are aware.
## 1.4 The History of B/P Bios
Our earlier work developing ZSDOS convinced us that we needed to attack the machine-dependent software in Z80-compatible computers and develop some standard enhancements in order to exercise the full potential of our machines. This premise is even more true today with large Hard Disks (over 100 Megabytes) being very common, needs for large RAM Drives, and an ever shrinking Transient Program Area. Attempts to gain flexibility with normal operating systems were constrained by the 64k addressable memory range in Z80-compatible systems, and forced frequent operating system changes exemplified by NZCOM and NZBLITZ where different operating configurations could be quickly changed to accommodate application program needs.
In the mid to late 1980's, several efforts had been made to bank portions of CP/M 2.2 "type" systems. XBIOS was a banked Bios for only the HD64180-based MicroMint SB-180 family. While it displayed an excellent and flexible interface and the ability to operate with a variety of peripherals, it had several quirks and noticeably degraded the computer performance. A banked Bios was also produced for the XLM-180 single board S-100 computer, but required special versions of many Z-System utilities, and was not produced in any significant quantity. Other spinoffs, such as the Epson portable, attempted banking of the Bios, but most failed to achieve our comprehensive goals of compatibility with the existing software base, high performance, and portability.
In 1989, Cam developed the first prototype of B/P Bios in a Non-banked mode on his TeleTek while Hal concentrated on extending ZSDOS and the Command Processor. As of 1997, B/P Bios has been installed on:
| Computer | Features |
| :--- | :--- |
| YASBEC | Z180 CPU, FD1772 FDC, DP8490 SCSI, 1MB RAM |
| Ampro LB w/MDISK | Z80 CPU, FD1770 FDC, MDISK 1MB RAM |
| MicroMint SB-180 | HD64180 CPU, SMS9266 FDC, 256KB RAM |
| MicroMint SB180FX | HD64180Z CPU, SMS9266 FDC, 512KB RAM |
| Compu/Time S-100 | Z80 CPU, FD1795 FDC, 1 MB RAM |
| Teletek | Z80 CPU, NEC765 FDC, 64KB RAM |
| D-X Designs P112 | Z182 CPU, SMC FDC37C665 FDC, Flash ROM, 512KB RAM (mods for 5380 SCSI and GIDE) |

36
Doc/CPM/BPBIOS/BPBIOS_2_Features.md

@ -0,0 +1,36 @@
# 2 Features of B/P Bios
B/P BIOS is designed to be completely compatible with the CP/M 2.2 standards for a Basic IO System, as well as to provide many extensions needed for banked memory which is becoming so prevalent with newer systems and processors. Additionally, strict coding standards used in the various modules forming the BIOS ease interface problems with applications programs and provide a more robust framework for future development. The extensions added to the basic CP/M 2.2 foundation include many elements from Digital Research's CP/M 3 (aka CP/M Plus), but in a more logically consistent manner. Also included in banked versions are provisions for managing up to 8 MB of extended memory for banked applications, RAM Drives and potentially multitasking in future versions. To provide insight into the methodology used, let us now examine some of the features in a generic B/P Bios.
## 2.1 Character IO
As defined by Digital Research in their CP/M 2.2 standards, character IO consisted of logical devices referred to as TTY, CRT, UC1, CON, etc. B/P Bios extends and generalizes these interfaces using the IOBYTE to define four physical devices called COM1, COM2, PIO and NUL. The first two, COM1 and COM2, are serial ports; PIO is a Parallel port, while NUL is a "bit-bucket" which can be replaced by a customized driver, or used in lieu of an actual device. Digital Research provided only a limited interface capability to the character devices in CP/M 2.2, consisting of a Console (CON), an auxiliary Input and Output (RDR/PUN), and a Printer (LST). The ability to sense Input and Output Status with these devices was extremely limited and was enhanced in CP/M 3. These enhanced capabilities are completely incorporated into B/P Bios with the addition of strict register usage so that only relevant registers may be altered in the respective routines. By manipulating the IOBYTE, any of the four physical devices may be used in the three logical devices of CONsole, AUXiliary, and Printer (LST).
Also featured in B/P Bios are modifications of CP/M 3 functions to initialize (or re-initialize) all devices and parameters, and return the address of a table which contains names and parameters of the defined character devices. While not totally compatible with CP/M 3 equivalents, these functions are consistent with the spirit and functionality needed with this advanced system. Included in the device table are; flags defining whether the device is capable of Input, Output or Both, Data rates for serial devices (Maximum and Set), Serial data format where applicable, and Handshaking method (CTS/RTS, XON/XOFF or None), as well as Input and Output Data masks for stripping unneeded bits from characters during IO.
## 2.2 Mass Storage IO
All versions of Digital Research's CP/M BIOSes define only a generic Disk driver with implementations of Floppy, Hard, RAM and Tape drives left to the user or developer. In B/P Bios, we went several steps further to ease many problems. First, we retained all standard CP/M 2.2 functions and parameters, added CP/M 3 features for returning the Disk Parameter Header (DPH) table address, and flushing of the software deblocking code segment, and added a new vector to the BIOS jump table to provide a standard method of directly addressing low-level device functions. Several standard low-level Floppy Disk functions are supported and used by the standard utilities, including a function to return the type of Disk Controller in use which permits a single support utility to adapt to a wide variety of hardware platforms. In a like manner, low-level functions are provided for SCSI/SASI Hard Disk drives, and provisions for RAM Disk drives in the event special hardware is implemented. The methods used to implement these access mechanisms may be logically extended to handle Tape Drives or Network Interfaces.
## 2.3 Clock Support for Time and Date
Many Hardware vendors have added provisions for Time and Date as non-standard extensions to CP/M 2.2 BIOSes, and more have incorporated such support into CP/M 3 BIOSes. We opted to define the CP/M 3 clock vector as a ZSDOS-standard clock building on our previous Operating System work. This entry point into the Bios completely complies with our ZSDOS standards and can completely replace the separate clock driver when used with ZSDOS. For systems capable of returning tenths-of-seconds, such as the YASBEC and SB-180, the standard has been enhanced to support this capability as well.
## 2.4 Banked Memory Support
While Digital Research added banked memory support to their CP/M 3, it was in a manner incompatible with Bios interface standards defined for earlier CP/M standards. The method used in B/P Bios is compliant with CP/M 2.2 in direct accessing of Bios functions with only one minor exception when using the Banked ZSDOS2, and contains many of the CP/M 3 extensions added for banked memory support, with some being modified to be consistent with standards adopted for Z-System software. The exception to CP/M 2.2 accesses occurs when the Operating System can access certain buffers in the System Memory Bank. With ZSDOS 2, Allocation Bit Buffers (ALV), Check Buffers (CSV), and the Disk Host Buffer are all contained in the System Bank and not directly accessible from Transient Programs. To compensate for this, we have added a command to ZSDOS 2 to return the free space on disks (the most common reason for accessing these buffers) and tailored several utilities to adapt to banked and non-banked systems.
In addition to the primitives initiated by Digital Research, we added functions to directly access Words and Bytes in extended banks of memory, Directly accessing software routines contained in alternate memory banks, and properly managing the system when errors occur. These features make B/P Bios much more robust and resilient than other products. These features are implemented by methods transparent to the system utilities so that the same functions are available in both banked and non-banked versions.
## 2.5 Other Features
B/P Bios contains a standardized identification method which may be used to determine the hardware on which the software is operating. This allows applications to "adapt" to the environment in a manner similar to that used in the rest of the Z-System community. It also minimizes system "crashes" by executing programs which assume certain hardware features which may be detrimental if executed on other systems. The effects of identification of physical system parameters is most readily noticed by virtue of a single suite of support programs performing low-level functions such as formatting and diagnostics which function across widely differing hardware platforms. Portability on this scale can rarely be seen in other computer systems.
The ZCPR 3.4 Environment with extensions is mandatory in a B/P Bios system. Beginning with the addition of System Segment address and size information for CPR, DOS and BIOS which were added in the ZCPR 3.4 Environment, B/P Bios also adds a Resident User Space which may be used to locate unique routines for custom applications in a manner similar to, but more consistent than NZ-COM. An Environment Version number of 90H identifies the Z3 Environment as being compliant with B/P definitions.
In Banked systems, application programs may also be placed in alternate memory banks using location and sizing information contained at standard positions within the Bios Header Structure. This feature permits significantly greater functionality without sacrificing precious Transient Program Area. While the scheme employed in the initial distribution is subject to minor adjustments as the banked ZSDOS2 becomes more firmly developed, experimentation and suggestions into this realm are encouraged.

232
Doc/CPM/BPBIOS/BPBIOS_3_Tailoring.md

@ -0,0 +1,232 @@
# 3 Tailoring a B/P Bios
To customize a B/P Bios for your use, or adapt it to a new hardware set, you will need an editor and an assembler capable of producing standard Microsoft Relocatable files. Systems using the Hitachi HD64180 or Zilog Z180 must be assembled with either ZMAC or SLR180 which recognize the extended mnemonic set, or with a Z80 assembler and MACRO file which permits assembly of the extended instructions. For Z80 and compatible processors, suitable assemblers include ZMAC and Z80ASM. For any assembler, failure to produce standard Microsoft Relocatable code will preclude the ability of our Standard utilities to properly install B/P Bios systems.
## 3.1 Theory of Operation
In order to understand the need for, and principles behind B/P Bios, you must understand the way in which CP/M 2.2, as modified by the Z-System, uses the available memory address space of a Z80 microprocessor. For standard versions of CP/M and compatible systems, the only absolute memory addresses are contained in the Base Page which is the range of 0 to 100H. All addresses above this point are variable (within certain limits). User programs are normally run from the Transient Program Area (TPA) which is the remaining space after all Operating System components have been allocated. The following depicts the assigned areas pictorially along with some common elements assigned to each memory area:
```generic
FFFFH /------------------\
| Z-System Buffers | ENV, TCAP, IOP, FCP, RCP
|------------------|
| Bios | Code + ALV, CSV, Sector Buffers
|------------------|
| Operating System | CP/M 2.2, ZRDOS, ZSDOS1
|------------------|
| Command Processor| CCP, ZCPR3.x
|------------------|
| Transient |
| |
| Program |
| |
| Area |
0100H |------------------|
| Base Page | IOBYTE, Jmp WB, Jmp Dos, FCB, Buffer
0000H \------------------/
```
As more and more functionality was added to the Z-System Buffers, bigger drives were added using more ALV space, and additional functionality was added to Bios code in recent systems, the available TPA space has become increasingly scarce.
B/P Bios attacks this problem at the source in a manner which is easily adaptable to different hardware platforms. It uses additional memory for more than the traditional role of simple RAM Disks, it moves much of the added overhead to alternate memory banks. The generic scheme appears pictorially as:
```generic
FFFFH /----------\
| |
| BNK1 |
| |
8000H |----------| /----------\ /----------\ /----------\
| | | |\ | |\ | |\
| BNK0 | | BNK2 | | BNKU | | BNK3 ||\
| | | || | || | |||
0000H \----------/ \----------/ \----------/ \----------/
\- - - - - / \- - - - - / \- - - - - /|
| BNKM |
\----------/
TPA SYSTEM USER RAM DISK
```
As can be seen from the above diagram, multiple banks of memory may be assigned to different functional regions of memory, with each 32k bank (except for the one defined as BNK1) being switched in and out of the lower 32k of the processor's memory map. The bank defined as BNK1 is ALWAYS present and is referred to as the Common Bank. This bank holds the portions of the Operating System (Command Processor, Operating System, BIOS, and Z-System tables) which may be accessed from other areas, and which therefore must always be "visible" in the processor's memory. It also contains the code to control the Bank switching mechanisms within the B/P Bios.
To illustrate this functional division, the memory map of a basic B/P Bios system is divided as:
```generic
FFFFH /------------------\
| Z-System Buffers |
|------------------|
| User Space |
|------------------|
| Bios |
|------------------|
| Operating System |
|------------------|
| Command Processor| /------------------\ 8000H
|------------------| / | Bios Buffers |
8000H | Transient | | Banked Bios Part |
| | |------------------|
| | | Banked Dos Part |
| Program | |------------------|
| | | Banked CCP Part |
| | |------------------|
| Area | | CCP Restoral |
0100H |------------------| |------------------| 0100H
| Base Page | | Base Page Copy |
0000H \------------------/ \------------------/ 0000H
TPA (BNK0/BNK1) System Bank (BNK2)
```
The B/P Bios banking concept defines a one byte Bank Number permitting up to 8 Megabytes to be directly controlled. Certain assumptions are made in the numbering scheme, the foremost of which is that BNK0 is the lowest physical RAM bank, BNK1 is the next incremental RAM bank, with others follow in incrementing sequential order. A couple of examples may serve to illustrate this process. The YASBEC is offered with a couple of options in the Memory Map. Units with the MEM-1, 2 or 3 decoder PALs assign the first 128k bytes of physical memory to the Boot ROM, so BNK0 is set to 4 (Banks 0-3 are the ROM). The MEM-4 PAL only uses the first 32k (Physical Bank 0) for the ROM which means that BNK0 is assigned to 1, BNK1 to 2 and so on up to the 1 Megabyte maximum where BNKM is 31.
The Ampro Little Board equipped with MDISK, on the other hand, completely removes the Boot ROM from the memory map leaving a maximum of 1 MB of contiguous RAM space. In this system, BNK0 is set to 0 and BNKM to 31 of a fully equipped 1 MB MDISK board.
The region beginning after BNK1 is referred to as the System Bank. It begins at the bank number assigned to BNK2 and ends at the bank number immediately before that assigned to the User Bank, BNKU if present, or BNK3 if no User Bank area is defined.
If present, one or more 32k banks of memory may be defined with the BNKU equate for unique user programs or storage areas. This area begins with the bank number set to the label and ends at the bank number immediately before the BNK3 label. BNK3 defines a high area of physical memory which is most often used for a RAM Disk providing fast temporary workspace in the form of an emulated disk drive.
B/P Bios contains protection mechanisms in the form of software checks to insure that critical portions of the memory map are enforced. In the case of Non-banked systems, a check is made to insure that the system size is not so great that the Bios may overwrite reserved Z-System areas in high memory (RCP, IOP, etc). If a possible overflow condition is detected, the message
`++ mem ovfl ++`
will be issued when the system is started. In Banked Bios systems, this message will be displayed if the top of the system portions in the SYStem Bank exceeds the 32k bank size. For most systems, this space still permits drives of several hundred megabytes to be accommodated.
Since the Common portions of the operating system components must remain visible to applications, a similar check is made to insure that the lowest address used by the Command Processor is equal to or greater than 8000H. This factor is checked both in both MOVxSYS and BPBUILD with either a warning issued in the case of the former, or validity checks on entry in the case of the latter.
## 3.2 B/P Bios Files
This BIOS is divided into a number of files, some of which depend highly on the specific hardware used on the computer, and some of which are generic and need not be edited to assemble a working system. Much use is made of conditional assembly to tailor the resulting Bios file to the desired configuration. The Basic file, `BPBIO-xx.Z80`, specifies which files are used to assemble the Bios image under the direction of an included file, `DEF-xx.LIB`. It is this file which selects features and contains the Hardware-dependent mnemonic equates. By maintaining the maximum possible code in common modules which require no alterations, versions of B/P Bios are relatively easy to convert to different machines. The independent modules used in the B/P Bios system are:
| Filename | Description |
| :--- | :--- |
| `BOOTRAM.Z80` | (only needed in BOOT ROM applications) |
| `BOOTROM.Z80` | (only needed in BOOT ROM applications) |
| `BYTEIO.Z80` | Character IO per IOBYTE using IIO-xx routines |
| `DEBLOCK.Z80` | Disk Deblocking routines |
| `DPB.LIB` | 3.5/5.25" Floppy Format Definitions (if AutoSelect) |
| `DPB8.LIB` | 8"/Hi-Density Floppy Format Definitions (if AutoSelect) |
| `DPB2.LIB` | Additional Floppy Definitions (optional if AutoSelect) |
| `DPBRAM.LIB` | Fixed Floppy Format Definitions (if Not AutoSelect) |
| `DPH.LIB` | Disk Parameter Header Table & Floppy definitions |
| `FLOPPY.Z80` | Floppy Disk High-Level Control |
| `SECTRAN.Z80` | Sector Translate routines |
| `SELFLP1.Z80` | Floppy Select routine (if Not auto selecting) |
| `SELFLP2.Z80` | Floppy Select routine (if auto selecting) |
| `SELRWD.Z80` | Generic Read/Write routines |
| `Z3BASE.LIB` | ZCPR 3.x file equate for Environment settings |
Other files are hardware version dependent to varying extents. These modules requiring customization for different hardware systems are given names which end with a generic "-xx" designator to identify specific versions. Tailoring these modules ranges from simple prompt line customization to complete re-writes. Versions of B/P Bios generated to date are identified as:
| ID | Computer system |
| :---: | :--- |
| `-18` | MicroMint SB-180 | (64180 CPU, 9266 FDC, 5380 SCSI) |
| `-YS` | YASBEC | (Z180 CPU, 1772 FDC, DP8490 SCSI) |
| `-AM` | Ampro Little Board | (Z80 CPU, 1770 FDC, 1MB MDISK) |
| `-CT` | Compu/Time S-100 board set | (Z80 CPU, 1795 FDC, 1MB Memory) |
| `-TT` | Teletek | (Z80 CPU, 765 FDC) |
Files associated with specific hardware versions or require tailoring are:
| Filename | Description |
| :--- | :--- |
| `BPBIO-xx.Z80` | Basic file, tailored for included file names |
| `CBOOT-xx.Z80` | Cold Boot routines, Sign-on prompts |
| `DEF-xx.LIB` | Equates for option settings, mode, speed, etc. |
| `DPBHD-xx.LIB` | Hard Drive Partition Definitions (optional) |
| `DPBM-xx.LIB` | Ram Drive Definition (optional) |
| `DPHHD-xx.LIB` | Hard Drive DPH definitions (optional) |
| `DPHM-xx.LIB` | Ram Drive DPH Definition (optional) |
| `FDC-xx.Z80` | Floppy Disk Low-Level interface/driver routines |
| `HARD-xx.Z80` | Hard Drive Low-Level interface/driver routines (optional) |
| `IBMV-xx.Z80` | Banking Support Routines (if banked) |
| `ICFG-xx.Z80` | Configuration file for speed, Physical Disks, etc. |
| `IIO-xx.Z80` | Character IO definitions and routines |
| `RAMD-xx.Z80` | Ram Drive interface/driver routines (optional) |
| `TIM-xx.Z80` | Counter/Timer routines and ZSDOS Clock Driver |
| `WBOOT-xx.Z80` | Warm Boot and re-initialization routines |
## 3.3 B/P Bios Options
The most logical starting point in beginning a configuration is to edit the `DEF-xx.LIB` file to select your desired options. This file is the basic guide to choosing the options for your system, and some careful choices here will minimize the Bios size and maximize your functionality. Some of the more important options and a brief description of them are:
**MOVCPM** - Integrate into MOVCPM "type" loader? If the system is to be integrated into a MOVCPM system, the Environment descriptor contained in the CBOOT routine is always moved into position as part of the Cold Start process. If set to NO, a check will be made to see if an Environment Descriptor is already loaded, and the Bios copy will not be loaded if one is present.
NOTE: When assembling a Bios for Boot Track Installation (MOVCPM set to YES), many options are deleted to conserve space and the Bios Version Number is forced to 1.1.
**BANKED** - Is this a banked BIOS? If set to YES, the Bank control module, IBMV, is included in the assembly, and much of the code is relocated to the system bank. Note that a Banked system CANNOT be placed on the System Tracks, or integrated into a MOVCPM image.
**IBMOVS** - Are Direct Inter-Bank Moves possible? If set to YES, direct transfer of data between banks is possible such as with the Zilog Z180/Hitachi 64180. If NO, a 256-byte transfer buffer is included in high Common Memory and Interbank moves require transfer of bytes through this buffer.
**ZSDOS2** - Assemble this for a Banked ZSDOS2 system? If YES, the ALV and CSV buffers will be placed in the System bank invisible to normal programs. This has the side effect that many CP/M programs which perform sizing of files (Directory Listers, DATSWEEP, MEX, etc) which do not know about this function will report erroneous sizes. The advantage is that no sacrifice in TPA is required for large Hard Disks. Set this to NO if you want strict CP/M 2.2 compatibility.
**FASTWB** - Restore the Command Processor from the System Bank RAM? If set to YES, Warm Boots will restore the Command Processor from a reserved area in the System RAM bank rather than from the boot tracks. For the maximum benefit of B/P Bios, always attempt to set this to YES. In systems without extended memory, it MUST be set to NO.
**MHZ** - Set to Processor Speed in closest even Megahertz (e.g. for a 9.216 MHz clock rate, set to 9). The value entered here is used in many systems to compute Timing values and/or serial data rate parameters.
**CALCSK** - Calculate Diskette Skew Table? If NO, a Skew table is used for each floppy format included in the image. Calculating Skew is generally more efficient from a size perspective, although slightly slower by factors which are so small as to be practically unmeasurable.
**HAVIOP** - Include IOP code into Jump table? If the IOPINIT routine satisfies your IOP initialization requirements, you may turn this off by setting to NO and save a little space. This typically will be turned off when generating a system for MOVCPM integration to conserve space.
**INROM** - Is the Alternate Bank in ROM? Set to NO for Normal Disk-based systems. Please contact the authors if you need additional information concerning ROM-based system components.
**BIOERM** - Print BIOS error messages? Set this to YES if you desire direct BIOS printing of Floppy Disk Error Messages. If you are building a BIOS for placement on Boot Tracks, however, you will probably not have room and must turn this Off. Set to NO to simply return the normal Success/Fail error flag with no Message printout.
**FLOPY8** - Include 8"/Hi-Density Floppy Formats? Some systems (SB-180, Compu/Time) can handle both 5.25" and 8" disks. If your hardware supports the capability and you want use 8" disks as well as the normal 3.5 and 5.25" diskettes, setting this to YES will add formats contained in `DPB8.LIB` and control logic to the assembly. Future systems may take advantage of the "High-Density" 3.5 and 5.25" Floppy Disks which use higher data rates. Their definitions will be controlled by this flag as well.
NOTE: If AUTOSL is set to NO, this option will probably cause the BIOS to be larger than necessary since these additional formats may not be accessible.
**MORDPB** - Use more Floppy DPB's (in addition to normal 4-5.25" and optional 8")? If YES, the file `DPB2.LIB` is included. Many of the formats are Dummies and may be filled with any non-conflicting formats you desire.
NOTE: If AUTOSL if set to NO, this option will probably cause the BIOS to be larger than necessary since these additional formats may not be accessible.
**MORDEV** - Include Additional Character Device Drivers? Is set to YES, user-defined drivers are added to the Character IO table, and associated driver code is assembled. Systems featuring expansion board such as the SB-180 and YASBEC may now take advantage of additional serial and parallel interfaces within the basic Bios. Set to NO to limit code to the basic 4 drivers.
NOTE: When assembling a Bios for Boot Track Installation (MOVCPM set to YES), MORDEV is overridden to conserve space, and the Bios Version Number is forced to 1.1 in the distribution files.
**BUFCON** - Use type ahead buffer for the Console? If set to YES, code is added to create and manage a type-ahead buffer for the driver assembled as the console. This device will be controlled by either interrupts (in systems such as the YASBEC and SB-180) or background polling (in Ampro and Compu/Time). This means that characters typed while the computer is doing something else will not be lost, but will be held until requested.
**BUFAUX** - Use type ahead buffer on Auxiliary Port? As with BUFCON above, setting to YES will add code to create and manage a type ahead buffer for the auxiliary device. Since the AUX port typically is used for Modem connections, buffering the input will minimize the loss of characters from the remote end.
**AUTOSL** - Auto-select floppy formats? If set to YES, selection of Floppy disks will use an algorithm in `SELFLP2.Z80` to identify the format of the disk from the DPB files included (`DPB.LIB`, optional `DPB8.LIB`, and optional `DPB2.LIB`) and log the disk if a match is found. There must be NO conflicting definitions included in the various files for this to function properly. See the notes in the various files to clarify the restrictions. If set to NO, the single file `DPBRAM.LIB` is included which may be tailored to contain only the fixed format or formats desired per disk drive. This results in the smallest code requirement, but least flexibility.
**RAMDSK** - Include code for a RAM-Disk? If set to YES, any memory above the System or User bank may be used for a RAM Drive (default is drive M:) by including the file `RAMD-xx.Z80`. Parameters to determine the size and configuration are also included in the files `DPHM-xx.LIB` and `DPBM-xx.LIB`. In systems without extended memory, or to conserve space such as when building a system for the boot tracks, this may be disabled by setting to NO.
**HARDDSK** - Include SCSI Hard Disk Driver? Set to YES if you wish to include the ability to access Hard Disk Drives. In a floppy-only system, a NO entry will minimize BIOS code.
**HDINTS** - (System Dependent) In some systems such as the YASBEC, Interrupt-driven Hard Disk Controllers using DMA transfer capabilities may be used. If you wish to use this type of driver specified in the file `HARDI-xx.Z80` instead of the normal polled routines included in `HARD-xx.Z80`, set this option to TRUE. In most cases, this driver will require more Transient Program Area since the Interrupt Handling routine must be in Common Memory.
**CLOCK** - Include ZSDOS Clock Driver Code? If set to YES, the vector at BIOS+4EH will contain a ZSDOS-compatible clock driver with the physical code contained in the `TIM-xx.Z80` module. If set to NO, calls to BIOS+4EH return an error code.
**TICTOC** - (System Dependent) Use pseudo heartbeat counter? This feature is used in systems such as the Ampro Little Board and Compu/Time SBC880 which do not have an Interrupt scheme to control a Real Time Clock. Instead, a series of traps are included in the code (Character IO Status polls, Floppy Disk Status polls) to check for overflow of a 1-Second Counter. It is less desirable than an Interrupt based system, but suffices when no other method is available. Set to NO if not needed.
**QSIZE** - Size in bytes of type ahead buffers controlled by BUFCON and BUFAUX.
**REFRSH** - Activate Dynamic Refresh features of Z180/HD64180 processors? In some computers using these processors such as the YASBEC, refresh is not needed and merely slows down processing. Set to NO if you do not need this feature. If your processor uses dynamic memory, or needs the signal for other purposes (e.g. The SB180 uses Refresh for Floppy Disk DMA), Set this to YES.
**Z3** - Include ZCPR init code? Since a Z3 Environment is mandatory in a B/P Bios (which now "owns" the Environment), this option has little effect.
For assembly of a Banked version of B/P Bios, the identification of various banks of memory must be made so that the various system components "know" where things are located. Refer to Section 3.1 above for a description of these areas. The BNK0 value should be the first bank of RAM in the System unless other decoding is done. The following equates must be set:
| Equate | Description |
| :--- | :--- |
| BNK0 | First 32k TPA Bank (switched in/out) |
| BNK1 | Second 32k TPA Bank (Common Bank) |
| BNK2 | Beginning of System Bank (BIOS, DOS, CPR) area |
| BNKU | Beginning of Bank sequence for User Applications |
| BNK3 | Beginning of Extra Banks (first bank to use for RAM Disk) |
| BNKM | Maximum Bank Number assigned |
## 3.4 Configuration Considerations
When assembling a version of B/P Bios for integration into an IMG file, size of the resulting image is not much of a concern, so you need not worry about minor issues of size. For integration into a system for loading onto diskette boot tracks, however, the limitation is very real in order to insure that the CPR/DOS/BIOS and Boot Sector(s) can fit on the reserved system tracks. Typically, a limit of slightly under 4.5k exists for the Bios component. When the MOVCPM flag is set to YES for this type of assembly, warnings will be issued when the image exceeds 4352 bytes (the maximum for systems with 2 boot records), and 4480 bytes (the maximum for systems with a single boot record). Achieving these limits often requires disabling many of the features.
The first thing you should do before assembling the BIOS is to back up the entire disk, then copy only the necessary files onto a work disk for any editing. After setting the options as desired, edit the hardware definitions in `ICFG-xx.Z80` to reflect the physical characteristics of your floppy and hard drives, as well as any other pertinent items. Then edit the logical characteristics for your Hard and Ram Drives (if any) in `DPBHD-xx.LIB` and `DPBM-xx.LIB`. If you do not desire any of the standard floppy formats or want to change them, edit `DPB.LIB` and/or `DPB2.LIB` (if using auto selection) or `DPBRAM.LIB` if you are using fixed floppy formats. Finally edit the DPH files to place the logical drives where desired in the range A..P.
Decide whether you want to generate a system using the Image file construct developed in support of B/P Bios (BPBUILD/LDSYS), or for integration on a floppy disk's boot tracks. If the latter, you probably will not be able to have all options turned on. For example, with the MicroMint SB-180, the following options must be turned Off: BANKED, ZSDOS2, BIOERM, FLOPY8, MORDPB, BUFAUX and usually either CLOCK or RAMDSK. As an aid to space reduction, conditional assembly based on the MOVCPM flag automatically inhibits all but double-sided Floppy formats from `DPB.LIB`. If configuring for Floppy Boot tracks (MOVCPM flag set to TRUE), a warning will be printed during assembly if the size exceeds that available for a One or Two-sector boot record. Using the BPBUILD/LDSYS method, you may vary nearly all system parameters, even making different systems for later dynamic loading.
If you are using a version of the B/P Bios already set for your type of computer, you are now ready to assemble, build a system and execute it. The only remaining task would be an optional tailoring of the sign on banner in the file `CBOOT-xx.Z80` and reassembly to a `.REL` file.
For those converting a standard version of the B/P Bios to a new hardware system, we recommend that you begin with a Floppy-only system in Non-Banked mode then expand from there. The easiest way to test out new versions is to use the System Image (IMG file) mode, then advance to boot track installations if that is desired. Enhancements that can be added after testing previous versions may be to add Hard Drives, RAM Drive, and finally Banking.

200
Doc/CPM/BPBIOS/BPBIOS_4_Installation.md

@ -0,0 +1,200 @@
# 4 Installing a B/P Bios
The Distribution diskette(s) on which B/P Bios is furnished are configured for booting from the vanilla hardware for the version ordered. A 9600 bps serial terminal is standard, and will allow you to immediately bring up a minimal Non-Banked Floppy Disk system. Due to the variety of different system configurations and size restrictions in some versions, only the Floppy Disk Mass Storage capability can be assured on the initial boot disk. Where space remained on the boot tracks, limited Hard Drive support is also provided, and in some configurations, even RAM Drive support exists.
After booting from either an established system, or the boot tracks of the distribution disk, format one or more fresh diskettes and copy the distribution diskette(s) contents to the backup diskette(s). Copy the boot tracks from the master to the copies using BPSYSGEN (see 6.6). Remove the master diskette(s) for safekeeping and work only with the copies you just made.
Using the backup diskette with the B/P utilities on it, execute BPCNFG in the Boot Track configuration mode (see 6.2), adjusting all the options to your specific operating environment. When you have completed tailoring the system, it is ready for booting by placing the diskette in drive A: and resetting the system.
The sample `STARTUP.COM` file on the distribution disk will automatically execute a sequence of instructions when the system is booted. It contains various instructions which further tailor the system and load portions of the operating system which are too big to fit on the boot tracks. The default instruction sequence is:
| Command | Explanation |
| :--- | :--- |
| `LDDS` | Load the DateStamper style File Stamp routine and clock |
| `LDR SYS.RCP,SYS.FCP,SYS.NDR` | Load ZCPR 3 Environment segments for Resident Command Processor, Flow Control Pkg and Named Dirs |
| `IOPINIT` | Initialize the IO Processor Pkg |
| `TD S` | Prompt for Date and Time, Set Clk / Alternatives are to use `TDD` (6.21) or `SETCLOK` (6.18) |
| `IF ~EX MYTERM.Z3T` | If the file `MYTERM.Z3T` does Not exist... |
| `TCSELECT MYTERM.Z3T` | ..select which terminal you have creating a `MYTERM.Z3T` file |
| `FI` | ...end of the `IF` |
| `LDR MYTERM.Z3T` | Load the Terminal Definition data |
If you wish to alter any of these initial instructions to, for example, initialize the RAM drive using INIRAMD, add File Time Stamp capabilities to it with INITDIR or PUTDS and copy some files there with COPY, these may be added with ALIAS, VALIAS, SALIAS or other compatible files available from the ZSYSTEM or ZCPR33 areas on Z-Nodes.
After the initial system is up and running from the Default Boot Track system, you may expand the operation by generating systems for different purposes in order to gain the most advantage from your system. Many types of installation are possible, the simplest of which is a Non-Banked system using only 64k of the systems memory, all of which is in primary memory. Such a system uses a normal Command Processor such as the ZCPR3.x family, and a Non-Banked Operating System such as our ZSDOS Version 1. Non-Banked systems may be installed on a Disk's Boot Tracks, or created as an Image File for dynamic loading using the LDSYS Utility (see 6.15).
Banked systems MUST be created with the BPBUILD Utility (see 6.1) and loaded with LDSYS (see 6.15). The techniques to manage different memory banks to form a complete Operating Environment are rather intricate and are best handled by our utilities. Many Image files may be created and loaded as needed to tailor your system for optimum performance. The following sections describe these various types of installations in detail.
## 4.1 Boot Track Installation
For most of the existing CP/M compatible computers to begin executing a Disk Operating System, a program must be placed on a specified area of a Floppy or Hard Disk Drive. Normally, the first two or three tracks on the disk are reserved for this purpose and are referred to as the "Boot Tracks". Since the space so defined is generally restricted, neither a complete B/P Bios nor a Banked installation is possible. Instead, a scaled-down system roughly equivalent to those currently in use is used to start the computer and serve as the Operating System, with larger systems loaded later as needed.
If you are using a pre-configured version of B/P Bios for your hardware, you may simply continue to use the Boot Track system from the distribution disk(s) by copying the system as described in Section 4 above using BPSYSGEN (see 6.6). If you elect to alter or otherwise customize the Boot Track system, you must assemble the B/P Bios source setting certain of the equates in the `DEF-xx.LIB` file to insure a correct type of system. To assemble a Boot Track system, the most important equates are:
| Equate | |
| :---: | :--- |
| `MOVCPM` | Set to `YES` |
| `BANKED` | Set to `NO` |
| `ZSDOS2` | Set to `NO` |
One element of Banked Systems is available in a Boot Track installation if additional memory is available, and your B/P Bios routines support such a feature. This feature reloads the Command Processor from Banked memory instead of from the Boot Tracks of a disk, and generally produces less code (taking less space on the Boot Tracks) and executes faster. It is set with:
| Equate | |
| :---: | :--- |
| `FASTWB` | Set to `YES` if desired, `NO` if Warm Boot from disk |
Some of the features that generally need to be disabled to scale a smaller system are set as:
| Equate | |
| :---: | :--- |
| `MORDPB` | Set to `NO` |
| `DPB8` | Set to `NO` |
| `MORDEV` | Set to `NO` |
When at least these equates and any others you desire to change (see section 4) have been made to the component files of the system, assemble your `BPBIO-xx` file to a Microsoft standard `.REL` file. This output file may be used to overlay the Bios portion of the `MOVxSYS.COM` system generation utility (see 6.16) furnished with your distribution disk, or an equivalent program provided with your computer. MOVxSYS or its equivalent (MOVCPM, MOVZSYS, etc) is a special program customized for your particular hardware containing all the Operating System components which will be placed on the Boot Tracks, along with a routine to alter the internal addresses to correspond to a specified memory size.
To Add the new Bios you just assembled, execute INSTAL12 (see procedures in 6.13) specifying your computer's MOVxSYS or equivalent program and follow the prompts to overlay the new Bios. Once INSTAL12 has saved a relocatable or absolute file, you are ready to create a boot disk containing the modified system.
If you used the command INSTAL12 to install system segments on MOVxSYS or equivalent program, you must first create an Absolute System Model file. Since the functional portion of your new program is identical to the original MOVxSYS or equivalent, use the method explained in your original documentation to generate a new system. With MOVxSYS, the command is:
| Command | |
| :---: | :--- |
| `MOVxSYS nn *` | replace MOVxSYS with your version |
Where `nn` is the size of the system (typically 51 for a moderate boot system). The asterisk tells the program to retain the image in memory and not write it to a disk file. You may now use BPSYSGEN to write the new image to the system tracks of your boot diskette. Do this by executing BPSYSGEN with no arguments and issue a single Carriage Return when asked for the source of the Image.
If you used the command `INSTAL12 /A` to install replacement system segments over a System Image file, or used a utility which wrote the new image to a disk file, use BPSYSGEN to write the image file to the system tracks of your boot disk. The proper command is
`BPSYSGEN filename`
where filename is the name of the disk file you just created by executing MOVxSYS or equivalent with output to a disk file, or with INSTAL12 on an existing image file.
If the system is written to a Hard Disk, and your system supports booting from a Hard Disk such as the YASBEC, you normally must alter the default Boot Sector from the default Floppy Disk Boot Sector contained in MOVxSYS or equivalent. This alteration is accomplished by HDBOOT (see 6.9) which must be customized to the specific Hardware System used.
After the above actions have been completed as appropriate, tailor the Boot Track system to reflect the desired starting configurations with BPCNFG (see 6.2). Such items as the desired Startup file name, Bank Numbers (critical if FASTWB is used), and drive types and assignments are routinely tailored at this point. When the you have finished this step, test your new system by resetting the system, or cycling the power and you should be up and running!
## 4.2 Non-Banked Image Installation
A Non-Banked system may be installed as an Image File as opposed to the basic Boot Track installation covered in 4.1 above. To create an Image File, you must have `.REL` or `.ZRL` versions of a Command Processor (ZCPR3.x or equivalent recommended), an Operating (`ZSDOS.ZRL` recommended), and a REL version of B/P Bios for your system assembled with the MOVCPM equate in `DEF-xx.LIB` set to NO. Other equates in this file may be set as described above for the Boot Track system. Since Image Files are not as constrained in size as is installation for Boot Tracks, more features may generally be activated such as Error Messages, RAM Drive, additional Hard Drive partitions, and complete Floppy Format suites. The main precaution here is that large Hard Drives will rapidly cause significant loss of Transient Program Area since all Drive parameters must be in protected high memory above the Bios.
After the Bios has been assembled, an Image file must be produced. This is accomplished with the BPBUILD Utility (see 6.1). Set the File names in Menu 1 to reflect only Non-Banked files (or minimally banked Bios if FASTWB is set to YES), and let BPBUILD do the work. Since the standard Non-Banked System segments are normally set to the "standard" CP/M 2.2 sizes, you may answer the "autosize" query with a Y to obtain the maximum Transient Program Area in the resulting system. When BPBUILD completes its work, a file, normally with the default type of `.IMG`, will have been placed in the currently logged Drive/User area and you are ready to perform the next step in preparation of the Non-Banked Image.
As with the Boot Track installation covered above, several system items must be tailored before the Image may be safely loaded and executed. This is done by calling BPCNFG with the Image file name as an argument, or specify Image configuration from the interactive menu (see 6.2). Set all items as you desire them in the operating system, particularly the Bank Numbers (if FASTWB is active), and the Disk Drive characteristics and assignments. When this has been satisfactorily completed, you are ready to load and execute the newly-created system.
Installing an Image File (default file type of `.IMG`) is extremely easy. Only the utility `LDSYS.COM` (see 6.15) is needed. If the file type has not been changed from the default `.IMG`, only the basic name of the Image File need be passed to LDSYS when executed as:
| Command | |
| :---: | :--- |
| `LDSYS IMGFILE` | where IMGFILE.IMG is your Image file name |
The operating parameters of the currently-executing system are first examined for suitability of loading the Image File. If it is possible to proceed, the Image File is loaded, placed in the proper memory locations, and commanded to begin execution by calling the B/P Bios Cold Boot Vector. The Cold Boot (Bios Function 0) performs final installation, displays any desired opening prompt and transfers control to the Command Processor with any specified Startup file for use by a ZCPR3.x Command Processor Replacement.
Since a non-banked Image File will probably closely resemble that contained on the Boot Tracks, the same STARTUP file may generally be used to complete the initial tailoring sequence. If a different file is desired, the Image File may be altered to specify a different file using BPCNFG.
## 4.3 Banked Bios, Non-banked System Installation
With the B/P Bios system, an Image system may be created and loaded which places portions of the Bios Only in the System bank, retaining a non-banked Operating System and therefore maximum compatibility with existing applications software. A few thousand bytes can normally be reclaimed for Transient Programs in this manner, although large and/or increasing numbers of logical drives will still reduce TPA space because of the need to store Allocation Vector information in Common Memory.
To prepare such a system, simply edit the needed Bios files if necessary with particular emphasis on the `DEF-xx.LIB` file where the following equates must be set as:
| Equate | |
| :---: | :--- |
| `MOVCPM` | Set to `NO` |
| `BANKED` | Set to `YES` |
| `ZSDOS2` | Set to `NO` |
Since banked memory MUST be available for this type of installation, you will probably want the Fast Warm Boot feature available to maximize system performance. To activate this option, set the following equate as:
| Equate | |
| :---: | :--- |
| `FASTWB` | Set to `YES` |
When the editing is complete, assemble the Bios to a Microoft `.REL` file with an appropriate assembler such as ZMAC and build an Image system with BPBUILD (see 6.1) changing the Bios file name in menu 1 to the name of the newly created Bios file. Next, configure the default conditions if necessary with BPCNFG (see 6.2) and you are ready to activate the new system in the same manner as all Image files by calling LDSYS with the Image file argument as:
| Command | |
| :---: | :--- |
| `LDSYS BBSYS` | where BBSYS.IMG is your Image File Name |
As with the completely Non-Banked system described above in Section 4.2, no new requirements are established for a Startup file over that used for the initial Boot System, since both the Command Processor and Disk Operating System are unbanked, and no data areas needed by application programs are placed in the System Bank. As with all Image Files, additional features such as full Bios Error Messages, more extensive Floppy Disk Formats and RAM drive may generally be included in the System definition prior to assembly since the size constraints of Boot Track systems do not apply.
## 4.4 Fully Banked Image Installation
To create a system taking maximum advantage of banked memory, a special banked Operating System and Command Processor are needed. These have been furnished in initial form with this package as `ZSDOS20.ZRL` and `Z40.ZRL` respectively. They use the Banking features of B/P Bios and locate the maximum practicable amount of executable code and data in the System Bank. Of significant importance to maximizing the Transient Program Area is that the Drive Allocation Bit maps are placed in the System Bank meaning that adding large hard drives, or multiple drives produce only minimal expansion to the resident portion of the Bios.
NOTE: The latest versions are `ZS203.ZRL`, `ZS227G.ZRL`, and `Z41.ZRL` as included in the public release of B/P Bios. See also sections 7 and 8.
A Fully banked Bios is created by editing the B/P Bios files as needed to customize the system to your desires. Insure that the following `DEF-xx.LIB` equates are set as:
| Equate | |
| :---: | :--- |
| `MOVCPM` | Set to `NO` |
| `BANKED` | Set to `YES` |
| `ZSDOS2` | Set to `YES` |
Assemble the resultant B/P Bios to a Microsoft `.REL` file, Build an Image file with BPBUILD (see 6.1) and configure the produced Image file with BPCNFG (see 6.2). When you are confident that all default settings have been made, activate the file by entering:
| Command | |
| :---: | :--- |
| `LDSYS FBANKSYS` | where FBANKSYS.IMG is your Image File Name |
Several differences may exist in the Startup file used for a Fully banked system. Generally the changes amount to deleting items such as a File Stamp module for the Non-banked ZSDOS1 which is not necessary with the fully-banked ZSDOS 2 and Z40. Only the type of clock need be specified for ZSDOS2. Furthermore, since the Z40 Command Processor Replacement contains most commonly-used commands gathered from a number of Resident Command Processor (RCP) packages, there is normally no need to load an RCP. A simple Startup file found adequate during development of the fully-banked B/P system is:
| Command | Explanation |
| :--- | :--- |
| `ZSCFG2 CB` | Set ZSDOS 2 clock to Bios+4EH |
| `LDR SYS.FCP,SYS.NDR` | Load ZCPR 3 Environment segments for Flow Control and Named Dirs |
| `IOPINIT` | Initialize the IO Processor Pkg |
| `TD S` | Prompt for Date and Time, Set Clk / Alternatives are to use `TDD` (6.21) or `SETCLOK` (6.18) |
| `IF ~EX MYTERM.Z3T` | If the file `MYTERM.Z3T` does Not exist... |
| `TCSELECT MYTERM.Z3T` | ..select which terminal you have creating a `MYTERM.Z3T` file |
| `FI` | ...end if the `IF` |
| `LDR MYTERM.Z3T` | Load the Terminal Definition data |
Since the requirements for a fully-banked system differ significantly from a non-banked one, we recommend that you use a different name for the Startup file. For example, `STARTUP.COM` is the default name used with Boot Track systems for initial operation, and with Non-banked Image Files, while STARTB may be a suitable name for the script to be executed upon loading a fully-banked system. The name of the desired Startup file may be easily altered in either Boot Track or Image systems from Option 1 in BPCNFG (see 6.2).
An option available to start from a large Image File is to configure a Startup file for execution by the Boot Track system containing a single command. The command would simply invoke LDSYS with the desired Banked Image File as an argument such as:
| Command | |
| :---: | :--- |
| `LDSYS BANKSYS` | where BANKSYS.IMG is your Image file |
In this case, none of the normal initialization sequences cited above would be executed by the Boot Track system, and only those contained in the Startup for `BANKSYS.IMG` would occur. Other options abound and are left to the community to invent new combinations and sequences.
## 4.5 In Case of Problems...
While We attempted to outline procedures for the majority of installations we considered feasible, there may be occasions where you inadvertently find yourself in a position where you seem to have lost the ability to get your system up and running.
**PROBLEM:** When loading an `.IMG` file with LDSYS, the screen displays the LDSYS banner, system addresses, and halts with the last screen displaying: "...loading banked system".
_SOLUTION:_ Something is not set correctly in the Bios, since all lines after the last one displayed are printed from the newly-loaded Bios. One of the most common causes for this problem is incorrect bank number settings. Use the hidden selection in Menu 1 of BPCNFG (see 6.2) to verify that the correct bank numbers have been set for TPA and SYStem banks. Another common cause of this problem is incorrect settings for the Console port, or a setting in the IOBYTE which directs Console data to a device other than the one intended. Use Menu 2 BPCNFG to properly set the IOBYTE and the console parameters.
**PROBLEM:** You boot from or load a B/P Bios system from a Hard Drive, and immediately after starting, the system attempts to log onto Floppy Drive 0.
_SOLUTION:_ The most common cause for this symptom is that the desired Hard Drive and Floppy Drive definitions were not swapped to define a Hard Drive Partition as the A: drive. Use BPCNFG (see 6.2), Menu 5 to exchange drives to the desired configuration. A similar situation may exist where a Hard Drive is activated immediately after booting when a Floppy drive is desired as the A: Drive.
**PROBLEM:** The computer seems to boot satisfactorily, but after a few programs or any program which executes a Warm Boot (or entering Control-C), the system goes into "Never-never Land" and must be reset.
_SOLUTION:_ This symptom is most often caused by an inability to access and load the Command Processor. This is most probably caused by assembling B/P Bios with the FASTWB equate in `DEF-xx.LIB` set to YES when the system contains no extended memory, or incorrect settings of the Bank Numbers. To check Bank Number settings, use the hidden function in BPCNFG, Menu 1 (see 6.2).
**PROBLEM:** When doing a Cold Boot from a Hard Drive (from Power up or Reset), the system goes to a Floppy Drive before displaying the initial sign on messages, and remains logged on the Floppy.
_SOLUTION:_ This is most often due to your forgetting to run the HDBOOT utility on the Hard Drive Boot system after applying it with BPSYSGEN. Normally, systems created with MOVxSYS contain a Floppy Disk Boot sector which will load the initial Operating System from a Floppy. HDBOOT (see 6.9) modifies this record on a specified Hard Drive Unit so that the Operating System is loaded from a Hard Drive. Run HDBOOT on the Desired Hard Drive, then use BPCNFG (see 6.2) to insure that the logical drives are positioned as desired (Menu 5).
**PROBLEM:** When Booting, the system console either doesn't display anything, or prints strange characters.
_SOLUTION:_ This is most often due to incorrect settings for the current Console, most probably the Data rate, or CPU Clock Frequency. Boot from a good system, then use BPCNFG (see 6.2) to adjust the settings on the problem system. Pay particular attention to Menu 1 (CPU Clock Rate) and Menu 2 (IOBYTE and Serial Port Data Rates).
**PROBLEM:** When running a fully-banked system with ZSDOS 2, some programs seem to "hang" or "lock up" the system on exit.
_SOLUTION:_ One of the most common sources of this symptom is with the application program where the author used code which assumes that the BDOS and Command Processor are of a certain size, or bear a fixed relationship to the addresses in page 0. You may experience this most often when using an IMG system built by answering YES to the Autosizing query in BPBUILD (see 6.1). To compensate for such ill-behaved programs, you may use a two-step build process as:
1. Use BPBUILD to create an IMG file answering YES to Autosizing on exit. This maximizes TPA placing the Resident Bios as high as possible in memory.
2. Execute BPBUILD again with an argument of the name you gave to the file just created above. This loads the definition from the IMG file. Immediately exit with a Carriage Return, and answer NO to Autosizing, and YES to placing system segments at standard locations. This procedure keeps the Bios address constant, but will move the starting addresses of BDOS and Command Processor down, if possible, to simulate "standard" sizes used in CP/M 2.2.

1364
Doc/CPM/BPBIOS/BPBIOS_5_Programming.md

File diff suppressed because it is too large

2579
Doc/CPM/BPBIOS/BPBIOS_6_Utilities.md

File diff suppressed because it is too large

37
Doc/CPM/BPBIOS/BPBIOS_7_ZSDOS2.md

@ -0,0 +1,37 @@
# 7 ZSDOS Version 2
Version 2 of ZSDOS is currently in a developmental phase. The version provided with this package is preliminary and should not be considered a final work. Be sure you back up any files which you don't mind sacrificing, and please let us know in as much detail as possible any problems you experience.
In addition to the ZSDOS Version call (Function 48) returning 20H signifying ZSDOS2, three new Operating System functions have been added. They are:
| Function 46 | Return Disk Free Space |
| ---: | :--- |
| Enter: | C = 46 (function #) |
| | E = Drive # (A=0..P=15) |
| Exit: | A = 0 if Ok, <>0 if Error |
| | Disk Free Space in kilobytes is placed in DMA+0 (LSB) thru DMA+3 (MSB) |
This function returns Disk Free Space from fully-banked systems where the ALV buffers are not directly accessible by applications programs. It **MUST** be used to reliably determine free space since there is no way for programs to ascertain which System Bank (if more than one) contains the Allocation Bit Map. For most reasonably-sized systems, only the lower two or three bytes will be used, but four bytes are allocated to accommodate a maximally-sized system.
| Function | Return Environment Descriptor Address |
| ---: | :--- |
| Enter: | C = 49 (function #) |
| Exit: | HL = Address of Env Desc. |
This function returns the address of a ZCPR 3.4 "type" Environment Descriptor needed in B/P Bios systems. Rather than rely on the Command Processor inserting the ENV address into application programs upon execution, this function may be used to reliably acquire the ENV address at any time.
| Function 152 | Parse File Name |
| ---: | :--- |
| Enter: | C = 152 (function #) |
| | DE = Pointer to dest FCB |
| | DMA --> start of parse string |
| Exit: | A = Number of "?" in fn.ft |
| | DE = points to delimiter |
| | FCB+15 will be 0 if parse Ok, 0FFH if errors occurred |
This function may be used to replace Z3LIB library routines in a more robust manner and produce consequently smaller applications programs. It is fully compliant with ZCPR 3.4 parse specifications.
## 7.1 NOTES Spring 2001
The versions of ZSDOS2 (the Banked Z-System DOS) and Z4x Banked Command Processor Replacement have been modified over the years. The manual may refer to specific versions, or by generic names. As of the Spring 2001 release under the GNU General Public License, Two versions of ZSDOS2 are provided; `ZS203.ZRL` which contains code for hashed directories, and `ZS227G,ZRL` which does not.

10
Doc/CPM/BPBIOS/BPBIOS_8_ZCPR4.md

@ -0,0 +1,10 @@
# 8 ZCPR Version 4
`Z40.ZRL` is a consolidation of ZCPR34 and many of the RCP features commonly in use, modified by the need to bank as much of the Command Processor as possible. When Z40 is used in a Fully-Banked system, you may not need much of, or any Resident Command Processor with your system. Z40 relys on ZSDOS2 and will **NOT** work without it since the Command Line Parser and disk free space calculations have been removed in favor of ZSDOS2 services. Additionally, the prompt line displays the time and will only function correctly if he ZSDOS2 clock is enabled. Comments on how these new System components work would be appreciated.
More complete documentation is provided in the `Z40.HLP` files included with the distribution diskettes, and a list of active functions is available with the H command at the prompt. To read the On-line help files, use `HELP.COM` available for downloading from any Z-Node.
## 8.1 NOTES Spring 2001
The versions of ZSDOS2 (the Banked Z-System DOS) and Z4x Banked Command Processor Replacement have been modified over the years. The manual may refer to specific versions, or by generic names. As of the Spring 2001 release under the GNU General Public License, the latest version of the Z4x Processor Replacement is `Z41.ZRL` which features a small amount of tailoring. A new utility; **`CONFZ4.COM`** is available for this purpose.

100
Doc/CPM/BPBIOS/BPBIOS_9_Glossary.md

@ -0,0 +1,100 @@
# GLOSSARY
**Application Programs**
In contrast to utility programs (see), application programs or applications are larger programs such as word processors which function interactively with the user.
**BDOS**
Basic Disk Operating System. The machine-independent, but usually processor-dependent, program which controls the interface between application programs and the machine-dependent hardware devices such as printers, disk drives, clocks, etc. It also establishes the concept of files on media and controls the opening, reading, writing, and closing of such constructs.
**BGii**
BackGrounder ii from Plu*Perfect Systems, a windowing task-switching system for CP/M users with hard or RAM disks.
**BIOS**
Basic Input/Output System. Machine-dependent routines which perform actual peripheral device control such as sending and receiving characters to the console, reading and writing to disk drives, etc.
**Bit**
BInary digiT. An element which can have only a single on or off state.
**Bit Map**
An array of bits used to represent or map large arrays of binary information in a compact form.
**Boot**
The term used for the starting sequence of a computer. Generally applies to starting from a "Cold," or power-off state, and includes the loading of Operating System, and configuration steps.
**Byte**
A grouping of eight bits.
**CPR**
Command Processor Replacement. Replaces CCP (see below). Example: ZCPR
**CCP**
Console Command Processor. The portion of the operating system that interprets user's commands and either executes them directly or loads application programs from disk for execution. The CCP may be overwritten by applications, and is reloaded by the "Warm Boot" function of the BIOS.
**Checksum**
An value which arithmetically summarizes the contents of a series of memory locations, and used to check the current contents for errors.
**Clock Driver**
A software link between a Non-banked ZSDOS and the clock on your system. The clock driver allows ZSDOS and its utilities to read the clock which is normally inherent in the B/P Bios.
**Command Script**
Sometimes called simply scripts, command scripts allow you to create a single command which issues other commands to perform a unique set of actions. CP/M submit files are one kind of command script familiar to all CP/M users. ZCPR also offers more sophisticated types of scripts such as aliases and command files (e.g., ALIAS.CMD).
**DateStamper**
A software package developed by Plu*Perfect Systems to allow time and date stamping of files. The Boot System uses an external module in the file LDDS.COM to implement DateStamper, while ZSDOS2 automatically supports this stamping method. DateStamper is unique among file stampers for microcomputers for two reasons: first, it maintains all file stamps within a file; second, it maintains stamps for create, access, and modify time/date for each file.
**DDT**
Dynamic Debugging Tool. A utility distributed with CP/M 2.2 which can display, disassemble, or alter disk files or areas of memory using opcodes or hexadecimal values.
**DOS**
Disk Operating System. Often used term for the BDOS, but generally refers to the aggregate of CCP, BDOS and BIOS.
**DosDisk**
A software package from Plu*Perfect Systems which allows users of CP/M and compatible computers to write and read files directly to and from standard 5-1/4" 40-track Double-Sided, Double-Density MS-DOS format diskettes. This is the standard "360k" disk format used in IBM-PC compatible computers.
**FCB**
File Control Block. A standard memory structure used by CP/M and compatible operating systems to regulate disk file operations.
**File Attributes**
Also known as file attributes, reserved bits stored along with file names in disk directories which control how the files are accessed.
**Hexadecimal**
A base-16 numbering system consisting of the numbers 0-9 and letters A-F. Often used to represent bytes as two digits (00 to FF). Use of Hexadecimal numbers is usually represented by suffixing the number with an "H" as in "01H".
**IOBYTE**
Input/Output Byte. A reserved byte at location 3 which is used by some CP/M BIOS's to redirect input and output between devices such as terminals and printers.
**K**
Usually refers to Kilobyte or 1024 (2^10th power) bytes.
**P2D**
P2Dos Datestamps. An alternative form of file stamping used in HAJ Ten Brugge's P2DOS. P2D stamps are compatible with CP/M Plus time and date stamps. This format is supported in a B/P Boot system with the LDP2D.COM Stamp module, and automatically in ZSDOS2.
**RAM**
Random Access Memory. As opposed to Read Only Memory (ROM) the area of a computer's memory which may be both read from and written to.
**RSX**
Resident System Extension. A program module complying with a standard developed by Plu*Perfect Systems for extending the functionality of a CP/M 2.2 compatible Operating System. The module must be loaded at the top of the Transient Program Area, and below the Console Command Processor.
**System Prompt**
The familiar A> prompt which appears soon after CP/M computersare started up.
**TPA**
Transient Program Area. That addressable memory space from the lowest available address to the highest available address. Usually this extends from 100H to the base of the BDOS (assuming that the Command Processor is overwritten), or the base of the lowest RSX.
**Utility Programs**
In contrast to application programs (see), utility programs or utilities are shorter programs, such as directory programs, which accept a single command from the user.
**Wheel Byte**
Taking its name from the colloquial "Big Wheel," the Wheel byte controls security under ZCPR and ZSDOS. When the byte is set to a non-zero value, the user has "Wheel status" and may execute commands unavailable to other users.
**Word**
In the computer context, a fixed number of bytes. For 8- bit microcomputers, a word is usually two bytes, or 16 bits.
**Z-System**
An operating system which completely replaces CP/M by substituting ZCPR for Digital Research's command processor and ZSDOS for Digital Research's disk operating system. ZCPR and ZSDOS complement one another in several ways to enhance performance.
**ZCPR**
Z80 Command Processor Replacement. Originally developed as a group effort of the Special Interest Group for Microcomputers (SIG/M), but refined by Richard Conn to ZCPR version 3.0 and Jay Sage to versions 3.3 and 3.4.
**ZRL**
A form of Relocatable file image using specified "Named Common" bases. For ZSDOS, files of this type are MicroSoft-compatible REL files using only the Common Relative segment "_BIOS_".

8
Doc/CPM/ReadMe.txt

@ -68,3 +68,11 @@ ZSDOS is the DOS portion of Z-System. This is the manual for ZSDOS
1.x as included in RomWBW. The installation instructions can be
ignored since that work has already been completed as part of the
RomWBW distribution.
ZPM3 ("ZPM3.txt")
-----------------
A Z80 coded CP/M 3.0 compatible BDOS replacement with ZCPR support.
This minimal documentation is all that is provided with ZPM3.
-- WBW 8:38 AM 6/6/2025

483
Doc/CPM/ZPM3.txt

@ -0,0 +1,483 @@
Z P M 3 by Simeon Cran
========================
A Z80 coded CP/M 3.0 compatible BDOS replacement.
The first public release: 27/3/92
This document dated: 16/6/92
Distributed at: Z-Node 62 (Perth, Western Australia)
V21,V22,V22bis 09 450 0200
WELCOME TO ZPM3
~~~~~~~~~~~~~~~
Welcome to the best CP/M compatible operating system for Z80
based computers with banked memory. The best? Yes, we believe so.
CP/M 3.0 has had bad press, but the fact is that it is faster
than CP/M 2.2 ever was, and it offered more integrated
facilities. Perhaps it was all the Z80 replacement BDOSes for
CP/M 2.2 which stole the limelight from CP/M 3.0, or was it just
that few computers had the required banked memory?
Whatever the reason for CP/M 3.0's lack of success in the
marketplace, there are still plenty of users who will stand by
its wonderful facilities and speed. For those users ZPM3 provides
the long awaited Z80 coded update.
ZPM3 offers all the good things that CP/M 3.0 does, and then it
offers more. Because ZPM3 is written in Z80 code rather than the
8080 code of CP/M 3.0, it can do everything that CP/M 3.0 does,
but in much less space. With the extra space recovered, ZPM3
packs in a number of new facilities. Yet the whole package fits
in exactly the same space as CP/M 3.0 so you can directly replace
your old CP/M 3.0 BDOS with ZPM3 without a worry.
ZPM3 is also fast. Faster, in fact, than CP/M 3.0. This is
possible because the rich Z80 instruction set allows many
algorithms to be implemented more efficiently. In addition, the
extra space available in ZPM3 has been put to use to further
optimise the code. Lots of small optimisations smooth the
execution flow, so ZPM3 becomes the fastest operating system on
most banked CP/M computers.
THE FEATURES
~~~~~~~~~~~~
ZPM3, in addition to complete CP/M 3.0 compatibility, offers the
following features:
Random Read Bug fixed.
++++++++++++++++++++++
Maybe you didn't know, but CP/M 3.0 has a bug. It affects random
reads under very specific circumstances, and can result in a
program thinking that you don't have some pieces of data in a
file when in fact you do. The bug would occur very, very rarely,
but it is real. ZPM3 finally squashes it.
Protected SCB User code
+++++++++++++++++++++++
The System Control Block of CP/M 3.0 was a revolution at the
time. ZCPR has a system environment and most other operating
systems have other similar structures, but the SCB of CP/M 3.0
was one of the very first.
Unfortunately, Digital Research never properly documented it, and
some programmers found things out about it that weren't quite
true and started programming accordingly. As well, because it is
available in the TPA bank, runaway programs can overwrite it
causing problems.
Mostly though, the SCB will survive, or at least any problems
will be so obvious that the user will realise that a crash has
occurred and will reboot. A real problem exists with the CP/M 3.0
code however when the user value is written over with a value
above 15. Many programs now directly write to this byte, and if
they put a value in that is above 15, all sorts of havoc can
happen with the disk system. Actually, CP/M 3.0 will handle user
areas above 15 with this method, and all seems ok until the
operating system mistakes one of these directory entries as an
XFCB. Simply put, user areas above 15 must not be used with CP/M
3.0.
ZPM3 has code which prevents these problems, making the system
even more stable.
Obsoleted Trap system.
++++++++++++++++++++++
One of the problems of the banked operating system was that it
was possible to redirect the BIOS to code below common memory, in
which case the banked BDOS could not access it. One solution is
to call all BIOS code from common memory, but this involves a
bank switch for every BIOS call, and this slows things down
considerably.
CP/M 3.0 got around the problem by providing special code just
below the SCB. If you redirected the BIOS, you also had to change
this code which caused a bank switch when your new BIOS routine
was called. When you removed the redirection, you also had to
restore the special code.
This system has major drawbacks. For a start, if you redirect the
BIOS, then another program redirects your redirection, then you
remove your first redirection (along with the special code), the
bank switch won't happen for the second redirection and the
system will crash.
If a CP/M 2.2 program tried to do the redirection, it would know
nothing about CP/M 3.0 and would not adjust the special code, so
a crash would result in that case too.
The special code was called the "Trap System" as it was meant to
trap redirection (as long as you set the trap). ZPM3 has
eliminated the need for the traps. They are still there, and
programs can still fiddle with them, but it doesn't matter how
they are set, they are ignored. There is simply no need for them
anymore. And this has been achieved without a performance
penalty. In fact, in the case of a program which sets the traps
but forgets to restore them, performance is now much better.
Semi-Permanent Read Only status for drives.
+++++++++++++++++++++++++++++++++++++++++++
In recent years, a trend in CP/M 2.2 is to make drives which have
been set read only to remain that way until explicitly changed by
function 37. ZPM3 now adopts this logic. Previously a control-C
would return a read only drive to read write. The advantage is
that a program can now make a drive read only for a session and
know that it will stay that way.
ZCPR compatible function 152
++++++++++++++++++++++++++++
Function 152 is the CP/M 3.0 parser. It was a great innovation at
the time as parsing is one of the more tedious aspects of
programming for CP/M. Unfortunately, almost as soon as it
appeared, it was made obsolete by the fact that it didn't handle
references to user number (DU references). A line such as
A:FILE.TYP would be correctly parsed, but A3:FILE.TYP would not.
CP/M 3.0 programs would often parse the drive and user
separately, then give function 152 the line without the DU:
reference. All this extra work should not have been necessary if
CP/M 3.0 had included user number parsing.
ZPM3 parses the user number, and goes even further by handling
named directories for ZCPR. This is possible as long as you set a
special word in the SCB which tells ZPM3 where to find the ZCPR
system environment descriptor. ZCCP, a companion CCP for ZPM3,
handles this automatically, but for Z3PLUS users, a special
utility is available which automatically sets this word.
The result is that CP/M 3.0 programs will not balk at DU:
references and ZPM3 aware programs can use the full DU: and DIR:
facilities of function 152. It has also made the brilliant ZCCP
code possible.
New Functions 54 and 55
+++++++++++++++++++++++
Datestamps in CP/M 3.0 are wonderful, but difficult to
manipulate. Two new functions make them easier to handle and at
the same time give compatibility to Z80DOS aware programs.
Function 54 (Get Stamp) returns a Z80DOS compatible datestamp.
Any program (such as many directory programs) which recognise the
Z80DOS standard can make use of function 54. There is only one
slight difference between Z80DOS datestamps and ZPM3's which you
should be aware of. Z80DOS will return a correct datestamp after
any successful open or search of any extent. ZPM3 can only return
a correct datestamp after a successful open or search of the
first extent of the file. This is because CP/M 3.0 datestamps are
only saved for the first extents of each file, in order to
provide the highest performance.
Even more interesting is Function 55 (Use Stamp) which provides a
mechanism for changing datestamps on files. Trying to do this
with CP/M 3.0 was virtually impossible because it involved direct
sector writes. With Function 55 you can simply set the stamp and
then write.
Wheel protected files
+++++++++++++++++++++
If you are using a ZCPR system (ZCCP or Z3PLUS), ZPM3 has access
to the wheel byte and supports wheel protected files. Such files
act normally if the wheel is set (signifying a priveleged user),
but if the wheel is not set, the files can not be changed. This
is of most benefit to BBS systems. The implementation is
virtually the same as most current Z80 CP/M 2.2 compatible
BDOSes.
Better error messages
+++++++++++++++++++++
CP/M 3.0 introduced the best error messages that CP/M had ever
had. ZPM3 goes further. The main difference you will notice is
that the user number as well as the drive is shown in the error
message. This is invaluable in helping you identify which file
might have caused a problem.
Function 10 history buffer and improved editing.
++++++++++++++++++++++++++++++++++++++++++++++++
Function 10 is used by the CCP to input command lines. Many other
programs use function 10 for input.
CP/M 3.0 introduced a history buffer for function 10. You press
control-W and you were returned the last command. It is a great
facility, but because it only remembers one command it is rather
limited. There have been RSXes written which give a much larger
history buffer, but RSXes take up extra program memory so are
undesirable.
ZPM3 gives a large (approximately 250 bytes) history buffer which
can store multiple commands. It also makes very intelligent use
of the buffer so that identical commands are not stored twice,
and commands of less than three characters are not stored. The
history buffer takes up no additional memory, and is always
available.
For security, it is possible to clear the history buffer so that
other users can not see what commands you have used.
The ZPM3 history buffer feature is so good, that for many users,
the ZPM3 upgrade is completely justified by it.
As part of the history buffer system, ZPM3 also offers a facility
called Automatic Command Prompting. This can be disabled, or can
be made switchable from the keyboard. When it is on, ZPM3 tries
to fill in the rest of your command based on what commands you
used most recently. It is like magic, and can save you typing out
complicated commands many times. In effect, it looks through the
history buffer for you and finds the command it thinks you want.
As you keep typing, if it turns out that the command doesn't
match anymore, it will try to match another command, and if it
can't, it lets you make the command by yourself. This facility is
quite amazing to watch.
And to integrate the history buffer and the automatic command
prompting, function 10 has the best command line editing you'll
find anywhere. Most of the control keys do something when you are
editing a function 10 line, and for the most part they mimic the
standard WordStar/NewWord/ZDE functions. You can jump to
different words in the command, delete individual words, delete
individual letters, insert letters, and a whole lot more.
Here is a list of what the various control keys do for function
10:
A Move left one word
B Go to the beginning or end of the line
C Warm boot if at start of line, otherwise nothing
D Go right one character
E Go backwards one command in the history buffer
F Go right one word
G Delete current character
H Destructive backspace
I
J Enter line
K Delete all to the right
L
M Enter line
N
O
P Toggle printing
Q Toggle automatic command prompting (if enabled)
R
S Go left one character
T Delete current word
U Add current line to history buffer
V Clear line and delete from history buffer
W Go forwards one command in the history buffer
X Delete all to the left
Y Clear the whole line
Z
CPMLDR.REL bug fixed.
+++++++++++++++++++++
If you have ever tried to use the CPMLDR.REL code supplied with
CP/M 3.0 to load a CPM3.SYS file larger than 16k, you have
probably come across the CPMLDR.REL bug. The computer probably
crashed, and you were left wondering what you did wrong in your
bios.
Well CPMLDR.REL has a bug. To solve this for you ZPM3 comes with
ZPM3LDR.REL which directly replaces CPMLDR.REL. It is also
somewhat better in that all the messages, and the fcb for loading
CPM3.SYS, are at the start of the file along with plenty of spare
room. As a result you can easily patch the signon and error
messages to say whatever you like and even change the FCB to load
a file called something other than CPM3.SYS.
All About the Random Read Bug.
==============================
Never heard of it? Well it's there in CP/M 3.0. I spent a lot of
time trying to work out what it was and just why it was
happening, and if you are interested, here are the details.
CP/M 3.0 uses the Record Count byte of an active FCB a little
differently from the way CP/M 2.2 does. It is mentioned in the
CP/M 3.0 manuals that the record count may contain numbers
greater than 128, but in such a case it implies that the record
count is really 128. CP/M 2.2 would not return record counts
greater than 128.
The reason for the use of the record count in this way is to help
speed up some of the logic used to find records in a file. It
works very well for sequential access. When it comes to random
access, the system has some failings.
The idea behind CP/M 3.0's unusual use of the record count is to
keep the record count of the last logical extent of the current
physical extent always in the Record Count byte. When accessing
extents before the last one, bit 7 of the byte is set. That way
it will always be at least 128 for logical extents before the
last (which CP/M 3.0 translates to mean equal to 128), and the
lower 7 bits are used as convenient storage for the record count
of the last logical extent. This is particularly convenient
because it means there is no need to go and read the directory
entry again when it comes time to read the last logical extent.
I hope you have followed that! In sequential access, this scheme
is great. The problem occurs with random access. In this case it
is possible to access a logical extent which has no records in
it. This could be any logical extent past the last one. In such a
case the record count must be returned as 0 (which is correct).
If we then go back to a previous logical extent in the same
physical extent, CP/M 3.0 gets confused and assumes that there
must be 128 records in that extent because the one we just came
from had no records and we are now accessing an earlier extent.
You're probably well and truly lost by now!
Anyhow, the assumption that CP/M 3.0 makes is quite wrong. The
record count ends up being set to 128, a read is allowed to go
ahead as if nothing was wrong, no error is returned, and the
record count remains incorrectly set until a different physical
extent is opened. The result could be chaos, but mostly it just
means that a program returns the wrong information.
Remember, a logical extent is always 16k. A physical extent can
be a multiple of 16k and is all the data described by one
directory entry. If your system has physical extents which are
16k, you would never have the problem because a new physical
extent would be properly opened for every new logical extent that
was accessed.
Typically though, a physical extent is 32k, so it holds 2 logical
extents. The problem won't arise until the file grows past the
32k mark in such a case. And when the file gets over 48k the
problem can't occur again until it gets over 64k... and so on.
Even then, it can only happen if reads are attempted to
particular extents in a particular order. So you shouldn't be too
surprised if the bug hasn't been too noticeable to you.
ZPM3 squashes the bug once and for all by using the correct
logic. In the situation where the bug would normally occur, ZPM3
makes sure it gets the correct record count information, and the
reads return the correct record count every time.
If you are interested in seeing a demonstration of the bug in
action (on CP/M 3.0) and comparing it with ZPM3, there is a file
floating around various bulletin boards which contains
demonstrations for the bug and an RSX to fix it. The RSX is a
less than perfect way of overcoming the bug, although it seems to
work. However, now that you have ZPM3, you don't need to worry.
Other things you should know about ZPM3
=======================================
ZPM3 has worked on EVERY CP/M 3.0 system tried so far except one.
This is a Bondwell computer, and as yet it isn't clear why it
won't work. I will study the source code of its BIOS and come up
with a fix shortly.
The MAKEDOS.COM utility is not perfect (as mentioned previously)
and it seems that nobody has managed to get it to work with the
Commodore C128 system. You must use the conventional method for
installing ZPM3 on such systems.
If you have a computer that ZPM3 will not install on with MAKEDOS
and you do not have access to the files required to do a
conventional install, please contact me. I am interested in
making ZPM3 as universal as possible and will help you to install
it on your system.
The ESCAPE key is ignored by function 10. There has been some
lively discussion about this but the decision is final: it stays
ignored. Remember what function 10 is for and you will understand
why I made it ignore the ESCAPE key. The argument against this
has been from people who control their terminals from the command
line. Apparently some people type in an escape sequence at the
command line (which CP/M 3.0 will not output correctly anyhow
(converting the escape character to ^[)) then press return to
have the CCP echo back the line including the escape character.
Sorry folks, that is a KLUDGE in my books! Anybody using Z-System
would of course use an ALIAS and ECHO to do this properly, but
for those who will continue to complain that I have sacrificed
CP/M 3.0 compatibility I am now including ECHOTERM.COM to solve
your problems. Run it and whatever you type will be sent to the
terminal correctly after you press RETURN. Press RETURN twice to
exit the program.
And a reminder that the ability to put control characters into
function 10 lines was always limited by the fact that some
control keys were used to edit the command line. CP/M 3.0 added
even more, and ZPM3 uses virtually all the control keys. The few
that aren't used are ignored, and this is in fact a FEATURE which
guarantees that unusable characters can't get into function 10
lines by accident.
LEGALS and SUCH
===============
The ZPM3 package is supplied free of charge, on the condition
that you don't use it to make money. If you want to use it
commercially you must contact me to get the OK (and negotiate our
fee).
If you find anyone (except myself) charging money for ZPM3,
please inform me!
Nobody is making any guarantees about this software. None at all.
If it causes your house to burn down, or a divorce, or just a bad
day, this is unfortunate, regrettable, but there is nothing that
I can or will do about it. You have been warned.
The ZPM3 package must only be distributed in the form that you
found it. Do not change or add anything. Don't even change it
into a different type of archive. Just leave it alone. However
you are free to distribute it to as many places and people that
you can. Just don't charge for it.
If in using ZPM3 you find that it doesn't act as described,
please forward the details to me so that either the ZPM3 code or
the documentation can be changed. If you would like further
details, please forward your specific questions to me. SJC.
As a service to all our ZPM3 fans, the latest version of the ZPM3
package can now be ordered. At this stage we can only supply IBM
formatted 3.5 inch 720k disks, however if you are keen enough
that shouldn't matter. ZPM3 remains free, however this service
will cost you $15 Australian (for the disk, copying, postage and
packing) to most places in the Western World (others by
arrangement).
This is a good way to guarantee you have the latest version, and
to guarantee that your package has not been corrupted by some
unscrupulous person.
When we fill your order, we will make sure to include the latest
demonstration copy of MYZ80 - the fastest and best Z80 emulator
for IBM AT (and better) compatibles. MYZ80 can run ZPM3 with
ease. It also handles ZCPR and CP/M 2.2. And yes, we do mean
FASTEST.
Send your international money order to:
Software by Simeon
ZPM3 Package
2 Maytone Ave
Killara NSW
Australia 2071
Your order will be promptly filled.


18
Doc/ChangeLog.txt

@ -1,7 +1,25 @@
Version 3.6
-----------
- RDG: Added VDA driver for Xosera FPGA-based VDC
- MGG: Added COBOL language disk image
- WDC: Added config options to PCF driver
- WBW: Enabled dynamic CPU speed update on LCD screen
- WBW: Improve LPT driver boot messaging when not detected (per Robb Bates)
- WBW: Correct DS1307 boot date/time display (per Tadeusz Pycio)
- WBW: Add -DELAY option to TUNE app (per Robb Bates)
- RDG: Add online documentation site
- WBW: Added enhanced Hi-Tech C Compiler files from Ladislau Szilagyi
- WBW: Added boundary check to ram/rom disk driver
- WBW: Per Peter Onion, switch KERMIT default file xfer mode to binary
- J?L: Source for ZSDOS2 and BPBIOS Utilities (from disassembly)
- WBW: Support ROM-based font storage
- MAP: New Slice Inventory Rom App "S" display bootable slices, during boot
- MAP: Device Inventory moved from HBIOS to Rom App, saving >1k space in HBIOS
- MAP: Added disk image for all Infocom text adventure Games
- M?R: Fixed formatting issue with SLABEL where Slice # < 10
- WBW: Improved image creation process to allow user defined aggregates
- WBW: Implemented config driven slice name and system image specification
- D?N: Added native USB driver support (keyboard, floppy, mass storage)
Version 3.5.1
-------------

BIN
Doc/Language/Cowgol Compiler Manual.pdf

Binary file not shown.

99
Doc/Language/HI-TECH Z80 C Compiler Messages.txt

@ -0,0 +1,99 @@
1 "dimension required"
2 "functions can't return arrays"
3 "functions can't return functions"
4 "can't have array of functions"
5 "argument redeclared: %s"
6 "not an argument: %s"
7 "undefined struct/union: %s"
8 "can't have array of functions"
9 "only functions may be void"
10 "functions can't return arrays"
11 "declarator too complex"
12 "no identifier in declaration"
13 "can't initialize arg"
14 "argument redeclared: %s"
15 "bad storage class"
16 "can't mix proto and non-proto args"
17 "type specifier reqd. for proto arg"
18 "can't initialise auto aggregates"
19 "integer expression required"
20 "undefined enum tag: %s"
21 "integer constant expected"
22 "bad bitfield type"
23 "members cannot be functions"
24 "struct/union redefined: %s"
25 "can't be unsigned"
26 "can't be short"
27 "can't be long"
28 "can't be register"
29 "inconsistent type"
30 "bad storage class"
31 "storage class illegal"
32 "inconsistent storage class"
33 "illegal initialisation"
34 "only register storage class allowed"
35 "too much indirection"
36 "argument list conflicts with prototype"
37 "identifier redefined: %s"
38 "not a label identifier: %s"
39 "'case' not in switch"
40 "'default' not in switch"
41 "default case redefined"
42 "inappropriate break/continue"
43 "illegal type for switch expression"
44 "inappropriate 'else'"
45 "illegal initialisation"
46 "initialisation syntax"
47 "illegal initialisation"
48 "%s expected"
49 "close error (disk space?)"
50 "digit out of range"
51 "hex digit expected"
52 "exponent expected"
53 "'.' expected after '..'"
54 "char const too long"
55 "illegal character (0%o)"
56 "illegal conversion"
57 "logical type required"
58 "type conflict"
59 "simple type required for %.3s"
60 "integral type required"
61 "illegal use of void expression"
62 "void function cannot return value"
63 "pointer required"
64 "only lvalues may be assigned to or modified"
65 "can't take this address"
66 "can't take address of register variable"
67 "undefined struct/union: %s"
68 "struct/union member expected"
69 "struct/union required"
70 "illegal type for index expression"
71 "not a variable identifier: %s"
72 "undefined identifier: %s"
73 "expression syntax"
74 "illegal type for array dimension"
75 "constant expression required"
76 "too few arguments"
77 "too many arguments"
78 "function does not take arguments"
79 "float param coerced to double"
80 "non-void function returns no value"
81 "Unreachable code"
82 "implicit return at end of non-void function"
83 "Can't create xref file %s"
84 "implicit conversion of float to integer"
85 "illegal conversion between pointer types"
86 "illegal conversion of pointer to integer"
87 "illegal conversion of integer to pointer"
88 "%s() declared implicit int"
89 "operands of %.3s not same type"
90 "operands of %.3s not same pointer type"
91 "function or function pointer required"
92 "Can't create xref file %s"
93 "close error (disk space?)"
94 "Can't reopen %s"
95 "can't open %s"
96 "illegal '#' directive"
97 "EOF in #asm"
98 "Too many cases in switch"
99 "unexpected EOF"

28
Doc/Language/ReadMe.txt

@ -11,45 +11,53 @@ distribution archive. It contains documentation for Programming
Languages provided with the system.
Aztec C Compiler User Manual (Aztec_C_1.06_User_Manual_Mar84.pdf)
Aztec C Compiler User Manual ("Aztec_C_1.06_User_Manual_Mar84.pdf")
-----------------------------------------------------------------
Official user manual for the Aztec C Compiler included in the aztecc disk image.
Borland TurboPascal User Manual (Turbo_Pascal_Version_3.0_Reference_Manual_1986.pdf)
Borland TurboPascal User Manual ("Turbo_Pascal_Version_3.0_Reference_Manual_1986.pdf")
------------------------------------------------------------------------------------
Official user manual Borland TurboPascal included in the pascal disk image.
Cowgol Lanaguage (Cowgol Language.pdf)
The Cowgol Lanaguage ("The Cowgol Language.pdf")
Cowgol Compiler Manual ("Cowgol Compiler Manual.pdf")
--------------------------------------
Documentation for Cowgol Language included in the cowgol disk image
Documentation for Cowgol Language included in the cowgol disk image.
The Cowgol Language describes the Cowgol Language itself while the
Cowgol Compiler Manual describes the compiler operation.
HI-TECH C Compiler User Manual (HI-TECH Z80 C Compiler Manual.txt)
HI-TECH C Compiler User Manual ("HI-TECH Z80 C Compiler Manual.txt")
HI-TECH C Compiler Messages ("HI-TECH Z80 C Compiler Messages.txt")
------------------------------------------------------------------
Official user manual for the HI-TECH C Compiler included in the
hitechc disk image.
hitechc disk image. The Compiler Messages file provides textual
descriptions of all compiler error and warning codes. These textual
messages have been omitted from the size optimized version of
HI-TECH C found in User Area 1 of the disk image. See the ReadMe.txt
file in the hitechc disk image for more information.
Microsoft Basic-80 Reference Manual v5.0 (Microsoft Basic-80 Reference Manual v5.0.pdf)
Microsoft Basic-80 Reference Manual v5.0 ("Microsoft Basic-80 Reference Manual v5.0.pdf")
---------------------------------------------------------------------------------------
Official manual for Microsoft BASIC as included in RomWBW.
Microsoft FORTRAN-80 User Manual (Microsoft_FORTRAN-80_Users_Manual_1977.pdf)
Microsoft FORTRAN-80 User Manual ("Microsoft_FORTRAN-80_Users_Manual_1977.pdf")
-----------------------------------------------------------------------------
Official user manual for Microsoft's FORTRAN-80 compiler included in the fortran
disk image.
Z80 Assembler User Manual (z80asm (SLR Systems).pdf)
Z80 Assembler User Manual ("z80asm (SLR Systems).pdf")
----------------------------------------------------
Official user manual for the Z80 Macro Assembler by SLR Systems

3
Doc/ReadMe.txt

@ -28,6 +28,7 @@ ChangeLog.txt
Log of changes in RomWBW by version.
RomWBW Introduction ("RomWBW Introduction.pdf")
RomWBW User Guide ("RomWBW User Guide.pdf")
RomWBW System Guide ("RomWBW System Guide.pdf")
RomWBW Applications ("RomWBW Applications.pdf")
@ -84,4 +85,4 @@ UCSD p-System Users Manual ("UCSD p-System Users Manual.pdf")
Official user manual for p-System operating system included with
RomWBW.
--WBW 5:18 PM 6/14/2023
--WBW 8:37 AM 6/6/2025

BIN
Doc/RomWBW Applications.pdf

Binary file not shown.

BIN
Doc/RomWBW Disk Catalog.pdf

Binary file not shown.

BIN
Doc/RomWBW Hardware.pdf

Binary file not shown.

BIN
Doc/RomWBW Introduction.pdf

Binary file not shown.

BIN
Doc/RomWBW System Guide.pdf

Binary file not shown.

BIN
Doc/RomWBW User Guide.pdf

Binary file not shown.

12
Dockerfile

@ -1,4 +1,4 @@
FROM ubuntu:jammy-20240111 as basebuilder
FROM ubuntu:jammy-20240111 AS basebuilder
# This docker file can be used to build a tool chain docker image for building RomWBW images.
@ -10,7 +10,7 @@ FROM ubuntu:jammy-20240111 as basebuilder
# After you have built the above image (called romwbw-chain), you can use it to compile and build the RomWBW images
# as per the standard make scripts within RomWBW.
# Start a new terminal, cd to where you have clone RomWBW, and then run this command:
# docker run -v ${PWD}:/src/ --privileged=true -u $(id -u ${USER}):$(id -g ${USER}) -it romwbw-chain:latest
# docker run --rm -v ${PWD}:/src/ --privileged=true -u $(id -u ${USER}):$(id -g ${USER}) -it romwbw-chain
# you can now compile and build the required images:
@ -21,13 +21,11 @@ FROM ubuntu:jammy-20240111 as basebuilder
# when finish, type 'exit' to return to back to your standard terminal session
LABEL Maintainer="Dean Netherton" \
Description="spike to use clang for ez80 target"
Description="RomWBW builder platform"
ENV DEBIAN_FRONTEND=noninteractive
RUN dpkg --add-architecture i386
RUN sed -i 's/http:\/\/archive\.ubuntu\.com\/ubuntu/http:\/\/au.archive.ubuntu.com\/ubuntu/g' /etc/apt/sources.list
RUN apt update -y
RUN apt dist-upgrade -y
RUN apt install -y --no-install-recommends cmake lzip ca-certificates mtools build-essential dos2unix libboost-all-dev texinfo texi2html libxml2-dev subversion bison flex zlib1g-dev m4 git wget dosfstools curl
@ -35,10 +33,10 @@ RUN apt install -y --no-install-recommends cmake lzip ca-certificates mtools bui
RUN mkdir work
WORKDIR /work
FROM basebuilder as main
FROM basebuilder AS main
LABEL Maintainer="Dean Netherton" \
Description="spike to build RomWBW"
Description="RomWBW builder platform"
RUN mkdir /src
WORKDIR /src/

7
Makefile

@ -1,7 +1,7 @@
.PHONY: tools source clean clobber diff dist
.ONESHELL:
.SHELLFLAGS = -cex
.SHELLFLAGS = -ce
all: tools source
@ -22,6 +22,11 @@ clobber: clean
diff:
$(MAKE) --directory Source diff
# Convert c code to assembly code
transpile-c-code:
@cd Source/HBIOS/ch376-native
$(MAKE) -j
dist:
$(MAKE) ROM_PLATFORM=dist
$(MAKE) --directory Tools clean

29
ReadMe.md

@ -7,12 +7,12 @@
**RomWBW Introduction** \
Version 3.6 \
Wayne Warthen ([wwarthen@gmail.com](mailto:wwarthen@gmail.com)) \
23 May 2025
22 Jul 2025
# Overview
RomWBW software provides a complete, commercial quality implementation
of CP/M (and workalike) operating systems and applications for modern
of CP/M (and work-alike) operating systems and applications for modern
Z80/180/280 retro-computing hardware systems.
A wide variety of platforms are supported including those produced by
@ -49,7 +49,7 @@ Supported hardware features of RomWBW include:
- Disk drivers for RAM, ROM, Floppy, IDE ATA/ATAPI, CF, SD, USB, Zip,
Iomega
- Serial drivers including UART (16550-like), ASCI, ACIA, SIO
- Video drivers including TMS9918, SY6545, MOS8563, HD6445
- Video drivers including TMS9918, SY6545, MOS8563, HD6445, Xosera
- Keyboard (PS/2) drivers via VT8242 or PPI interfaces
- Real time clock drivers including DS1302, BQ4845
- Support for CP/NET networking using Wiznet, MT011 or Serial
@ -191,6 +191,9 @@ documentation:
discusses much of the internal design and construction of RomWBW. It
includes a reference for the RomWBW HBIOS API functions.
An online HTML version of this documentation is hosted at
<https://wwarthen.github.io/RomWBW>.
Each of the operating systems and ROM applications included with RomWBW
are sophisticated tools in their own right. It is not reasonable to
fully document their usage. However, you will find complete manuals in
@ -287,8 +290,12 @@ let me know if I missed you!
- Tasty Basic is a product of Dimitri Theulings.
- Dean Netherton contributed eZ80 CPU support, the sound driver
interface, and the SN76489 sound driver.
- Dean Netherton contributed multiple components:
- eZ80 CPU support
- Sound driver infrastructure
- SN76489 sound driver
- Native USB driver (keyboard, floppy, mass storage)
- The RomWBW Disk Catalog document was produced by Mykl Orders.
@ -304,8 +311,10 @@ let me know if I missed you!
- significant content in the Disk Catalog and User Guide
- creation of the Introduction and Hardware documents
- Z3PLUS operating system disk image
- COPYSL utility
- SLABEL utility
- Infocom text adventure game disk image
- COPYSL, and SLABEL utilities
- Display of bootable slices via “S” command during startup
- Optimisations of HBIOS and CBIOS to reduce overall code size
- a feature for RomWBW configuration by NVRAM
- the /B bulk mode of disk assignment to the ASSIGN utility
@ -340,6 +349,12 @@ let me know if I missed you!
- Les Bird has contributed support for the NABU w/ Option Board
- Rob Gowin created an online documentation site via MkDocs, and
contributed a driver for the Xosera FPGA-based video controller.
- Jörg Linder has contributed disassembled and nicely commented source
for ZSDOS2 and the BPBIOS utilities.
## Related Projects
Outside of the hardware platforms adapted to RomWBW, there are a variety

29
ReadMe.txt

@ -1,6 +1,6 @@
RomWBW Introduction
Wayne Warthen (wwarthen@gmail.com)
23 May 2025
22 Jul 2025
@ -11,7 +11,7 @@ OVERVIEW
RomWBW software provides a complete, commercial quality implementation
of CP/M (and workalike) operating systems and applications for modern
of CP/M (and work-alike) operating systems and applications for modern
Z80/180/280 retro-computing hardware systems.
A wide variety of platforms are supported including those produced by
@ -46,7 +46,7 @@ Supported hardware features of RomWBW include:
- Disk drivers for RAM, ROM, Floppy, IDE ATA/ATAPI, CF, SD, USB, Zip,
Iomega
- Serial drivers including UART (16550-like), ASCI, ACIA, SIO
- Video drivers including TMS9918, SY6545, MOS8563, HD6445
- Video drivers including TMS9918, SY6545, MOS8563, HD6445, Xosera
- Keyboard (PS/2) drivers via VT8242 or PPI interfaces
- Real time clock drivers including DS1302, BQ4845
- Support for CP/NET networking using Wiznet, MT011 or Serial
@ -193,6 +193,9 @@ documentation:
construction of RomWBW. It includes a reference for the RomWBW HBIOS
API functions.
An online HTML version of this documentation is hosted at
https://wwarthen.github.io/RomWBW.
Each of the operating systems and ROM applications included with RomWBW
are sophisticated tools in their own right. It is not reasonable to
fully document their usage. However, you will find complete manuals in
@ -294,8 +297,12 @@ let me know if I missed you!
- Tasty Basic is a product of Dimitri Theulings.
- Dean Netherton contributed eZ80 CPU support, the sound driver
interface, and the SN76489 sound driver.
- Dean Netherton contributed multiple components:
- eZ80 CPU support
- Sound driver infrastructure
- SN76489 sound driver
- Native USB driver (keyboard, floppy, mass storage)
- The RomWBW Disk Catalog document was produced by Mykl Orders.
@ -311,8 +318,10 @@ let me know if I missed you!
- significant content in the Disk Catalog and User Guide
- creation of the Introduction and Hardware documents
- Z3PLUS operating system disk image
- COPYSL utility
- SLABEL utility
- Infocom text adventure game disk image
- COPYSL, and SLABEL utilities
- Display of bootable slices via “S” command during startup
- Optimisations of HBIOS and CBIOS to reduce overall code size
- a feature for RomWBW configuration by NVRAM
- the /B bulk mode of disk assignment to the ASSIGN utility
@ -347,6 +356,12 @@ let me know if I missed you!
- Les Bird has contributed support for the NABU w/ Option Board
- Rob Gowin created an online documentation site via MkDocs, and
contributed a driver for the Xosera FPGA-based video controller.
- Jörg Linder has contributed disassembled and nicely commented source
for ZSDOS2 and the BPBIOS utilities.
Related Projects

16
Source/Apps/Tune/cli.inc

@ -23,6 +23,19 @@ CLI_HAVE_HBIOS_SWITCH1 ; NOT MATCHED --HBIOS
LD (HBIOSMD), A
RET
CLI_HAVE_DELAY_SWITCH:
LD HL, CLIARGS ; TEST FOR --DELAY ON COMMAND LINE
LD DE, DELAYOPT
CALL STRINDEX
JR NZ, CLI_HAVE_DELAY_SWITCH1
OR $FF ; MATCHED --DELAY
LD (DELAYMD), A
RET
CLI_HAVE_DELAY_SWITCH1 ; NOT MATCHED --HBIOS
XOR A
LD (DELAYMD), A
RET
CLI_PORTS:
LD HL, CLIARGS ; TEST FOR -MSX ON COMMAND LINE
LD DE, OPT_MSX
@ -101,7 +114,8 @@ CLI_OCTAVE_ADJST5:
OPT_MSX .DB "-MSX", 0 ; USE MSX PORTS
OPT_RC .DB "-RC", 0 ; USE RC PORTS
HBIOSOPT: .DB "--HBIOS", 0
HBIOSOPT: .DB "--HBIOS", 0 ; USE HBIOS API FOR PLAYBACK
DELAYOPT: .DB "-DELAY",0 ; FORCE DELAY MODE
DOWN1 .DB "-t1", 0 ; DOWN AN OCTAVE
DOWN2 .DB "-t2", 0 ; DOWN TWO OCTAVE
UP1 .DB "+t1", 0 ; UP AN OCTAVE

2
Source/Apps/Tune/hbios.inc

@ -7,6 +7,6 @@ BF_SND .EQU $50
BF_SNDRESET .EQU BF_SND + 0 ; RESET SOUND SYSTEM
BF_SNDVOL .EQU BF_SND + 1 ; REQUEST SOUND VOL - L CONTAINS VOLUME (255 MAX, 0 SILENT) - SCALED AS REQUIRED BY DRIVER (EG: MAPS TO JUST 4 BIT RESOLUTION FOR SN76489)
BF_SNDPRD .EQU BF_SND + 2 ; REQUEST SOUND PERIOD - HL CONTAINS DRIVER SPECIFIC VALUE
BF_SNDNOTE .EQU BF_SND + 3 ; REQUEST NOTE - L CONTAINS NOTE - EACH VALUE IS QUARTER NOTE
BF_SNDNOTE .EQU BF_SND + 3 ; REQUEST NOTE - L CONTAINS NOTE - EACH VALUE IS AN EIGHTH TONE
BF_SNDPLAY .EQU BF_SND + 4 ; INITIATE THE REQUESTED SOUND COMMAND
BF_SNDQUERY .EQU BF_SND + 5 ; E IS SUBFUNCTION

6
Source/Apps/Tune/timing.inc

@ -41,8 +41,14 @@ DLY1 DEC BC ; [6]
; Test for timer running to determine if it can be used for delay
; Return string message in DE
; Assigned (WMOD) with 0 if no hardware time, 1 if hardware timer found
; If -DELAY on command line, force delay mode
;
PROBETIMER:
LD A,(DELAYMD) ; GET COMMAND LINE DELAY FLAG
OR A ; TEST IT
LD A,0 ; ASSUME NO TIMER
LD DE,MSGDLY ; DELAY MODE MESSAGE
JR NZ,SETDLY ; IF TRUE, DONE
LD B,BF_SYSGET ; HBIOS: GET function
LD C,$D0 ; TIMER subfunction
RST 08 ; DE:HL := current tick count

9
Source/Apps/Tune/tune.asm

@ -53,6 +53,7 @@
; 2024-07-11 [WBW] Updated, Les Bird's module now uses same settings as EB6
; 2024-09-17 [WBW] Add support for HEATH H8 with Les Bird's MSX Card
; 2024-12-12 [WBW] Add options to force standard MSX or RC ports
; 2025-05-28 [WBW] Add option to force delay mode
;_______________________________________________________________________________
;
; ToDo:
@ -113,6 +114,7 @@ Id .EQU 1 ; 5) Insert official identificator
CALL CLI_ABRT_IF_OPT_FIRST
CALL CLI_PORTS
CALL CLI_HAVE_HBIOS_SWITCH
CALL CLI_HAVE_DELAY_SWITCH
CALL CLI_OCTAVE_ADJST
JP CONTINUE
@ -703,15 +705,16 @@ FILTYP .DB 0 ; Sound file type (TYPPT2, TYPPT3, TYPMYM)
TMP .DB 0 ; work around use of undocumented Z80
HBIOSMD .DB 0 ; NON-ZERO IF USING HBIOS SOUND DRIVER, ZERO OTHERWISE
DELAYMD .DB 0 ; FORCE DELAY MODE IF TRUE (NON-ZERO)
OCTAVEADJ .DB 0 ; AMOUNT TO ADJUST OCTAVE UP OR DOWN
USEPORTS .DB 0 ; AUDIO CHIP PORT SELECTION MODE
MSGBAN .DB "Tune Player for RomWBW v3.12, 12-Dec-2024",0
MSGUSE .DB "Copyright (C) 2024, Wayne Warthen, GNU GPL v3",13,10
MSGBAN .DB "Tune Player for RomWBW v3.13, 28-May-2025",0
MSGUSE .DB "Copyright (C) 2025, Wayne Warthen, GNU GPL v3",13,10
.DB "PTxPlayer Copyright (C) 2004-2007 S.V.Bulba",13,10
.DB "MYMPlay by Marq/Lieves!Tuore",13,10,13,10
.DB "Usage: TUNE <filename>.[PT2|PT3|MYM] [-msx|-rc] [--hbios] [+tn|-tn]",0
.DB "Usage: TUNE <filename>.[PT2|PT3|MYM] [-msx|-rc] [-delay] [--hbios] [+tn|-tn]",0
MSGBIO .DB "Incompatible BIOS or version, "
.DB "HBIOS v", '0' + RMJ, ".", '0' + RMN, " required",0
MSGPLT .DB "Hardware error, system not supported!",0

22
Source/Apps/assign/assign.asm

@ -38,6 +38,7 @@
; 2024-12-17 [MAP] Added new /B=opt feaure to assign drives
; 2024-12-21 [MAP] Added CBIOS heap estimation to /B to prevent
; overflow when the drives are finally added
; 2025-07-19 [D?N] Support for native USB drivers
;_______________________________________________________________________________
;
; ToDo:
@ -1179,8 +1180,9 @@ makdphwbw: ; determine appropriate dpb (WBW mode, unit number in A)
jr makdph0 ; jump ahead
makdph00:
ld e,MID_FD144 ; assume floppy
cp DIODEV_FD ; floppy?
jr z,makdph0 ; yes, jump ahead
;cp DIODEV_FD ; floppy?
bit 7,c ; floppy?
jr nz,makdph0 ; yes, jump ahead
ld e,MID_RF ; assume ram floppy
cp DIODEV_RF ; ram floppy?
jr z,makdph0 ; yes, jump ahead
@ -1560,7 +1562,7 @@ drvmap:
jr nz,drvmapu ; do UNA mode drvmap
;
; determine device code by scanning for string
ld b,16 ; device table always has 16 entries
ld b,devcnt ; number of entries in devtbl
ld c,0 ; c is used to track table entry num
ld de,tmpstr ; de points to specified device name
ld hl,devtbl ; hl points to first entry of devtbl
@ -1826,7 +1828,7 @@ prtdev:
rst 08 ; call hbios, D := device, E := unit
push de ; save results
ld a,d ; device to A
and $0F ; mask out undesired bits
and $1F ; mask out undesired bits
push hl ; save HL
add a,a ; multiple A by two for word table
ld hl,devtbl ; point to start of device name table
@ -2427,6 +2429,7 @@ devtbl: ; device table
.dw dev04, dev05, dev06, dev07
.dw dev08, dev09, dev10, dev11
.dw dev12, dev13, dev14, dev15
.dw dev16
;
devunk .db "?",0
dev00 .db "MD",0
@ -2444,9 +2447,10 @@ dev11 .db "IMM",0
dev12 .db "SYQ",0
dev13 .db "CHUSB",0
dev14 .db "CHSD",0
dev15 .equ devunk
dev15 .db "USB",0
dev16 .equ devunk
;
devcnt .equ 10 ; 10 devices defined
devcnt .equ 17 ; 17 device types defined
;
udevram .db "RAM",0
udevrom .db "ROM",0
@ -2464,13 +2468,13 @@ stack .equ $ ; stack top
; Messages
;
indent .db " ",0
msgban1 .db "ASSIGN v2.0 for RomWBW CP/M ",0
msgban1 .db "ASSIGN v2.1 for RomWBW CP/M ",0
msg22 .db "2.2",0
msg3 .db "3",0
msbban2 .db ", 21-Dec-2024",0
msbban2 .db ", 19-Jul-2025",0
msghb .db " (HBIOS Mode)",0
msgub .db " (UBIOS Mode)",0
msgban3 .db "Copyright 2024, Wayne Warthen, GNU GPL v3",0
msgban3 .db "Copyright 2025, Wayne Warthen, GNU GPL v3",0
msguse .db "Usage: ASSIGN D:[=[{D:|<device>[<unitnum>]:[<slicenum>]}]][,...]",13,10
.db " ex. ASSIGN (display all active assignments)",13,10
.db " ASSIGN /? (display version and usage)",13,10

34
Source/Apps/slabel/slabel.asm

@ -4,6 +4,9 @@
;==============================================================================
;
; Author: Mark Pruden
;
; This is a SUPERSET of INVNTSLC.ASM -> Please See this program also when
; making changes, as code ( in routine prtslc: ) exists there also
;______________________________________________________________________________
;
; Usage:
@ -32,6 +35,7 @@
; table once (per device), and work out all the LBA's from this single read.
; Note this doesnt omit the fact that the 3 rd sector of each slice wold need to be read regarless.
; To slightly reduce some IO only slices < 64 are considered.
; - Output formatting misaligned with storage units enumerated as greater than 9 (ie 2 digits)
;
; This code will only execute on a Z80 CPU (or derivitive)
; This code requirs the use of HBIOS
@ -42,6 +46,7 @@
; 2024-12-11 [MAP] Started - Reboot v1.0 used as the basis for this code
; 2024-12-14 [MAP] Initial 0.9 alpha with basic working functionality
; 2025-04-21 [MAP] Initial v1.0 release for distribution, fixing all issues
; 2025-07-12 [MR] Minor tweak to partially tidy up output formatting
;______________________________________________________________________________
;
; Include Files
@ -91,7 +96,7 @@ exit:
jp restart ; return to CP/M via restart
;
;===============================================================================
; Initialization
; Initialisation
;
init:
; check for UNA (UBIOS)
@ -208,10 +213,10 @@ prtslc2a:
ld a,c ; slice number
ld (currslice),a ; save slice number
;
push bc ; save loop
push bc ; save loop counter
call prtslc3 ; print detals of the slice
pop bc ; restore loop
ret nz ; if error dont continie
pop bc ; restore loop counter
ret nz ; if error don't continue
;
inc c ; next slice number
djnz prtslc2a ; loop if more slices
@ -245,15 +250,25 @@ prtslc3:
cp c ; compare
jr nz,prtslc5 ; ignore missing signature and loop
;
; Print volume label string at HL, '$' terminated, 16 chars max
; Print slice label string at HL, '$' terminated, 16 chars max
ld a,(currunit)
call prtdecb ; print unit number as decimal
call pdot ; print a DOT
ld a,(currslice)
ld a, (currslice) ; fetch the current slice numeric
call prtdecb
;
;-------------------------------------------------------------------------------
; Added by MartinR, July 2025, to help neaten the output formatting.
; Note - this is not a complete fix and will still result in misaligned output
; where the unit number exceeds 9 (ie - uses 2 digits).
cp 10 ; is it less than 10?
ld a,' '
jr nc,jr01 ; If not, then we don't need an extra space printed
call cout ; print the extra space necessary
jr01: call cout ; print a space
call cout ; print a space
call cout ; print a space
;-------------------------------------------------------------------------------
;
ld hl,bb_label ; point to label
call pvol ; print it
call crlf
@ -435,6 +450,7 @@ pdot:
;
;-------------------------------------------------------------------------------
; Print character in A without destroying any registers
; Use CP/M BDOS function $02 - Console Output
;
prtchr:
cout:
@ -684,7 +700,7 @@ diskwrite:
;===============================================================================
;
str_banner .db "\r\n"
.db "Slice Label, v1.0, April 2025 - M.Pruden",0
.db "Slice Label, v1.1, July 2025 - M.Pruden",0
;
str_err_una .db " ERROR: UNA not supported by application",0
str_err_inv .db " ERROR: Invalid BIOS (signature missing)",0
@ -703,7 +719,7 @@ str_usage .db "\r\n\r\n"
.db " Options are case insensitive.\r\n",0
;
PRTSLC_HDR .TEXT "\r\n\r\n"
.TEXT "Un.Sl Drive \r\n"
.TEXT "Un.Sl Label \r\n"
.TEXT "----- ----------------\r\n"
.DB 0
;

7
Source/BPBIOS/@WBW Issues.txt

@ -15,8 +15,7 @@ as needed. The RomWBW ASSIGN command is not supported. BPBIOS
will boot from the first hard disk unit number you assign and
always from the first slice.
BPBIOS does not yet understand the 1024 directory entry
hard disk format. You must use the 512 directory entry
format images.
BPBIOS is hard-coded to use the 1024 directory entry hard disk
format (hd1k). The hd512 format is not supported at all.
--WBW 1:25 PM 10/7/2021
--WBW 5:04 PM 6/16/2025

1
Source/BPBIOS/Build.cmd

@ -2,6 +2,7 @@
setlocal
pushd ZCPR33 && call Build || exit /b & popd
pushd UTIL && call Build || exit /b & popd
set TOOLS=..\..\Tools
set PATH=%PATH%;%TOOLS%\zxcc;%TOOLS%\cpmtools;

1
Source/BPBIOS/Clean.cmd

@ -11,3 +11,4 @@ if exist *.bak del *.bak
if exist def-ww.lib del def-ww.lib
pushd ZCPR33 && call Clean.cmd & popd
pushd UTIL && call Clean.cmd & popd

2
Source/BPBIOS/Makefile

@ -13,7 +13,7 @@ OTHERS = zcpr33.rel bp*.prn bp*.rel \
TOOLS = ../../Tools
SUBDIRS = ZCPR33
SUBDIRS = ZCPR33 UTIL
include $(TOOLS)/Makefile.inc
zcpr33.rel:

55
Source/BPBIOS/UTIL/Build.cmd

@ -0,0 +1,55 @@
@echo off
setlocal
set TOOLS=..\..\..\Tools
set PATH=%PATH%;%TOOLS%\zxcc;%TOOLS%\cpmtools;
set CPMDIR80=%TOOLS%/cpm/
zxcc Z80ASM -BPBUILD/RFS || exit /b
zxcc SLRNK -BPBUILD/N,/A:100,/D:23E0,BPBUILD,B:SLINK0,B:VLIBS/S,B:Z3LIBS/S,B:SYSLIBS/S,/E || exit /b
zxcc Z80ASM -BPCNFG/RFS || exit /b
zxcc SLRNK -BPCNFG/N,/A:100,/D:3A55,BPCNFG,B:VLIBS/S,B:Z3LIBS/S,B:SYSLIBS/S,/E || exit /b
zxcc Z80ASM -BPSWAP/RFS || exit /b
zxcc SLRNK -BPSWAP/N,/A:100,/D:0854,BPSWAP,B:VLIBS/S,B:Z3LIBS/S,B:SYSLIBS/S,/E || exit /b
zxcc Z80ASM -BPSYSGEN/RFS || exit /b
zxcc SLRNK -BPSYSGEN/N,/A:100,/D:08CD,BPSYSGEN,B:Z3LIBS/S,B:SYSLIBS/S,/E || exit /b
zxcc Z80ASM -CONFZ4/RFS || exit /b
zxcc SLRNK -CONFZ4/N,/A:100,/D:080A,CONFZ4,B:Z3LIBS/S,B:SYSLIBS/S,/E || exit /b
zxcc Z80ASM -HASHINI/RFS || exit /b
zxcc SLRNK -HASHINI/N,/A:100,/D:09E5,HASHINI,B:Z3LIBS/S,B:SYSLIBS/S,/E || exit /b
zxcc Z80ASM -LDSYS/RFS || exit /b
zxcc SLRNK -LDSYS/N,/A:100,/D:0CF8,LDSYS,B:VLIBS/S,B:Z3LIBS/S,B:SYSLIBS/S,/E || exit /b
zxcc Z80ASM -SHOWHD/RFS || exit /b
zxcc SLRNK -SHOWHD/N,/A:100,/D:064D,SHOWHD,B:SYSLIBS/S,/E || exit /b
zxcc Z80ASM -SIZERAM/RFS || exit /b
zxcc SLRNK -SIZERAM/N,/A:100,/D:0750,SIZERAM,B:VLIBS/S,B:Z3LIBS/S,B:SYSLIBS/S,/E || exit /b
zxcc Z80ASM -ZSCFG2/RFS || exit /b
zxcc SLRNK -ZSCFG2/N,/A:100,/D:145E,ZSCFG2,B:VLIBS/S,B:Z3LIBS/S,B:SYSLIBS/S,/E || exit /b
:: zxcc Z80ASM
:: zxcc ZMAC -zcpr33.z80 -/P || exit /b

6
Source/BPBIOS/UTIL/Clean.cmd

@ -0,0 +1,6 @@
@echo off
setlocal
if exist *.com del *.com
if exist *.lst del *.lst
if exist *.rel del *.rel

40
Source/BPBIOS/UTIL/Makefile

@ -0,0 +1,40 @@
OBJECTS = bpbuild.com bpcnfg.com bpswap.com bpsysgen.com confz4.com hashini.com \
ldsys.com showhd.com sizeram.com zscfg2.com
TOOLS = ../../../Tools
# DEST = ..
OTHERS = *.rel
include $(TOOLS)/Makefile.inc
%.rel: %.z80
@$(ZXCC) $(CPM)/Z80ASM -$(basename $<)/RFS
bpbuild.com : bpbuild.rel
$(ZXCC) $(CPM)/SLRNK -bpbuild/n,/a:100,/d:23e0,bpbuild,b:slink0,b:vlibs/s,b:z3libs/s,b:syslibs/s,/e
bpcnfg.com : bpcnfg.rel
$(ZXCC) $(CPM)/SLRNK -bpcnfg/n,/a:100,/d:3a55,bpcnfg,b:vlibs/s,b:z3libs/s,b:syslibs/s,/e
bpswap.com : bpswap.rel
$(ZXCC) $(CPM)/SLRNK -bpswap/n,/a:100,/d:0854,bpswap,b:vlibs/s,b:z3libs/s,b:syslibs/s,/e
bpsysgen.com : bpsysgen.rel
$(ZXCC) $(CPM)/SLRNK -bpsysgen/n,/a:100,/d:08cd,bpsysgen,b:z3libs/s,b:syslibs/s,/e
confz4.com : confz4.rel
$(ZXCC) $(CPM)/SLRNK -confz4/n,/a:100,/d:080a,confz4,b:z3libs/s,b:syslibs/s,/e
hashini.com : hashini.rel
$(ZXCC) $(CPM)/SLRNK -hashini/n,/a:100,/d:09e5,hashini,b:z3libs/s,b:syslibs/s,/e
ldsys.com : ldsys.rel
$(ZXCC) $(CPM)/SLRNK -ldsys/n,/a:100,/d:0cf8,ldsys,b:vlibs/s,b:z3libs/s,b:syslibs/s,/e
showhd.com : showhd.rel
$(ZXCC) $(CPM)/SLRNK -showhd/n,/a:100,/d:064d,showhd,b:syslibs/s,/e
sizeram.com : sizeram.rel
$(ZXCC) $(CPM)/SLRNK -sizeram/n,/a:100,/d:0750,sizeram,b:vlibs/s,b:z3libs/s,b:syslibs/s,/e
zscfg2.com : zscfg2.rel
$(ZXCC) $(CPM)/SLRNK -zscfg2/n,/a:100,/d:145e,zscfg2,b:vlibs/s,b:z3libs/s,b:syslibs/s,/e

2357
Source/BPBIOS/UTIL/bpbuild.z80

File diff suppressed because it is too large

4539
Source/BPBIOS/UTIL/bpcnfg.z80

File diff suppressed because it is too large

483
Source/BPBIOS/UTIL/bpswap.z80

@ -0,0 +1,483 @@
TITLE "Swap drives under B/P Bios"
;************************************************************************
;* B P S W A P *
;* Swap two drive letters in a running B/P Bios system *
;* by Harold F. Bower and Cameron W. Cotrill *
;*----------------------------------------------------------------------*
;* Disassembly: jxl Dec 2024 *
;* public release 1.0 Apr 2025 *
;* see remarks at the end *
;*----------------------------------------------------------------------*
;* LINK with Version 4 libraries: VLIB, Z3LIB, SYSLIB *
;* *
;* A>Z80ASM BPSWAP/RS *
;* A>SLRNK BPSWAP/N,/A:100,/D:0854,BPSWAP,VLIBS/S,Z3LIBS/S,SYSLIBS/S,/E *
;************************************************************************
VER EQU 10
REV EQU ' '
DATE MACRO
DEFB '31 Aug 92'
ENDM
CTRLC EQU 03H ; Control-C character
BEL EQU 07H ; Bell character
TAB EQU 09H ; Tab character
LF EQU 0AH ; Line Feed character
CR EQU 0DH ; Carriage Return character
CPMBIOS EQU 0 ; CP/M BIOS warm boot (JP)
CPMBDOS EQU 5 ; CP/M BDOS entry point (JP)
CPMFCB EQU 5CH ; CP/M standard FCB #1 (+1 filename, +9 filetype)
CPMDMA EQU 80H ; CP/M standard DMA buffer
; From VLIB Get..
EXTRN VPRINT, Z3VINIT
; From Z3LIB Get..
EXTRN GETNAME, PRTNAME, WHRENV
; From SYSLIB Get..
EXTRN CRLF, CAPINE, COUT
;::::: PROGRAM START
ORG 100H
CSEG
BPSWAP: JP START ; bypass header
DEFB 'Z3ENV' ; this is a ZCPR3 utility
DEFB 1 ; show external environment
ENVADR: DEFW 0 ; addr of Z3 environment
START: LD HL,(CPMBDOS) ; ##### BUG: should be CPMBDOS+1 ?
CALL WHRENV ; find Z3 Environment Descriptor
LD (ENVADR),HL ; store addr
CALL Z3VINIT ; ..and init for Z3LIB routines
CALL GETNAME ; get actual program name
CALL GQFLAG
AND A ; running in quiet mode ?
JR NZ,START0 ; ..if so, skip over
CALL VPRINT
DEFB 1,'B/P Drive Swap',2,' V',VER/10+'0','.',VER MOD 10 + '0',', '
DATE
DEFB CR,LF
DEFB 0
START0: LD (STACK),SP
LD SP,STACK
; get first token from command line (in FCB #1)
LD A,(CPMFCB+1) ; get char
CP '/' ; is this a help request ?
JP Z,HELP ; ..if so, show help screen
LD HL,(CPMBIOS+1) ; get warm boot addr (BIOS fn #1)
LD L,30*3 ; adjust ptr to fn #30
LD A,(HL) ; check byte at ptr location
CP 0C3H ; is it opcode 0xC3 (JP) ?
JR NZ,E$BPBIO ; ..if not, jump error and exit
CALL JUMPHL ; else, "call" B/P Bios fn #30 (RETBIO)
LD (BPBASE),BC ; store B/P Bios base addr
LD HL,-6 ; move ptr 6 bytes backward
ADD HL,DE ; (signature string)
LD A,(HL) ; get byte
CP 'B' ; is it 'B' ?
JR NZ,E$BPBIO ; ..if not, error and exit
INC HL ; ptr fwd
LD A,(HL) ; get byte
CP '/' ; is it '/' ?
JR NZ,E$BPBIO ; ..if not, error and exit
INC HL ; ptr fwd
LD A,(HL) ; get byte
CP 'P' ; is it 'P' ?
JR Z,EVALCMD ; ..if so, jump to continue
; else, fall through (error and exit)
E$BPBIO: CALL VPRINT
DEFB CR,LF,BEL,'+++ Not B/P Bios ... aborting +++',CR,LF
DEFB 0
JP EXIT
; evaluate command line
EVALCMD: LD HL,CPMDMA ; ptr to standard DMA buffer (holds command line)
LD A,(HL) ; get length of first token
INC HL ; +1
CALL ADDHLA ; move ptr fwd
LD (HL),0 ; set <NUL> terminator
LD HL,CPMDMA+1 ; set ptr to start of string
CALL FINDDRV ; find letter of first drive
JR C,RUNIMOD ; ..if invalid/not found, switch to interactive mode
LD (DRV1ST),A ; else, store # of first drive
LD A,(HL) ; get following byte
CALL EVALSEP ; is it a separator char ?
JP C,M$ABORT ; ..if not, abort program
CALL FINDDRV ; find letter of second drive
JR C,RUNIM0 ; ..if invalid/not found, switch to interactive mode
LD (DRV2ND),A ; else, store # of second drive
LD A,(HL) ; get following byte
CALL EVALSEP ; is it a separator char ?
JP C,M$ABORT ; ..if not, abort program
JR SWAPDRV ; else, jump to continue
; run in interactive mode
RUNIMOD: CALL VPRINT
DEFB ' First Drive to Swap [A..P] : '
DEFB 0
CALL CAPINE ; get input
CALL CRLF
CP CTRLC ; is it <Ctrl-C> ?
JP Z,M$ABORT ; ..if so, abort program
CALL EVALDRV ; check if drive letter is valid (A..P)
JR C,RUNIMOD ; ..if not, loop ask for new input
LD (DRV1ST),A ; else, store drive #
RUNIM0: CALL VPRINT
DEFB ' Second Drive to Swap [A..P] : '
DEFB 0
CALL CAPINE ; get input
CALL CRLF
CP CTRLC ; is it <Ctrl-C> ?
JP Z,M$ABORT ; ..if so, abort program
CALL EVALDRV ; check if drive letter is valid (A..P)
JR C,RUNIM0 ; ..if not, loop ask for new input
LD (DRV2ND),A ; else, store drive #
;::::: PROCESS
SWAPDRV: LD HL,(BPBASE) ; get B/P Bios base addr
LD L,22*3 ; adjust ptr to fn #22 (DRVTBL)
CALL JUMPHL ; ..and "call" fn
PUSH HL ; save ptr to DRVTBL
LD A,(DRV1ST) ; get # of first drive
ADD A,A ; *2 for 16-bit entries
CALL ADDHLA ; ..and move ptr fwd
EX DE,HL ; swap regs
POP HL ; restore ptr to DRVTBL
LD A,(DRV2ND) ; get # of second drive
ADD A,A ; *2
CALL ADDHLA ; ..and move ptr fwd
; DE= addr DPH first drive
; HL= addr DPH second drive
LD C,(HL) ; swap addr's in DRVTBL using
LD A,(DE) ; regs DE, HL as pointers
LD (HL),A ; and regs A, C holding bytes to copy
LD A,C
LD (DE),A
INC HL
INC DE
LD C,(HL)
LD A,(DE)
LD (HL),A
LD A,C
LD (DE),A
LD HL,0
LD (PDRVVCT),HL ; init new Drive Vector (pos) with 0x0000
DEC HL
LD (NDRVVCT),HL ; init new Drive Vector (neg) with 0xFFFF
LD HL,(ENVADR) ; get ENV addr
LD DE,52 ; offset to Drive Vector
ADD HL,DE ; move ptr
PUSH HL ; ..and save it
LD E,(HL) ; get Drive Vector in DE
INC HL
LD D,(HL)
LD A,(DRV1ST) ; get # of first drive
CALL MKDRMSK ; get bit mask for first drive
LD C,L ; ..and move it to BC
LD B,H
LD A,(DRV2ND) ; get # of second drive
CALL MKDRMSK ; get bit mask for second drive
EX DE,HL ; ..and move it to DE
CALL MKVCMSK ; update new Drive Vector for first drive
PUSH BC ; swap BC and DE
PUSH DE
POP BC
POP DE
CALL MKVCMSK ; update new Drive Vector for second drive
; (Stack) = addr of Drive Vector in ENV - PUSH HL
; HL= current Drive Vector, DE= bit mask first drive, BC= bit mask second drive
EX DE,HL ; swap regs (save current Drive Vector in DE)
ADD HL,BC ; add/merge bit masks
EX (SP),HL ; put merged mask on stack - used by SWAPDRX
; get addr of Drive Vector in ENV
PUSH HL ; ..and save it
EX DE,HL ; swap regs back (current Drive Vector in HL)
LD BC,(PDRVVCT) ; get new Drive Vector (pos)
LD DE,(NDRVVCT) ; and (neg)
LD A,L ; low byte of current Drive Vector
AND E ; reset bit (neg)
OR C ; set bit (pos)
LD E,A ; ..and store result in E
LD A,H ; high byte of current Drive Vector
AND D ; reset bit (neg)
OR B ; set bit (pos)
LD D,A ; ..and store result in D
POP HL ; get addr of Drive Vector in ENV
LD (HL),E ; store new Drive Vector (low byte)
INC HL
LD (HL),D ; ..and high byte
CALL GQFLAG
OR A ; check quiet flag
JR NZ,SWAPDRX ; ..if quiet mode, skip over
CALL VPRINT
DEFB ' ...Drives '
DEFB 0
LD A,(DRV1ST) ; get # of first drive
ADD A,'A' ; make ascii letter
CALL COUT ; ..and display it
CALL VPRINT
DEFB ': and '
DEFB 0
LD A,(DRV2ND) ; get # of second drive
ADD A,'A' ; make ascii letter
CALL COUT ; ..and display it
CALL VPRINT
DEFB ': exchanged',CR,LF
DEFB 0
; exit function
SWAPDRX: POP DE ; restore merged bit masked 1st+2nd drive
LD C,37 ; BDOS fn #37 Reset Drive(s)
CALL CPMBDOS
JP EXIT
M$ABORT: CALL VPRINT
DEFB ' ...aborting...',CR,LF
DEFB 0
JP EXIT
;::::: HELP SCREEN
HELP: CALL VPRINT
DEFB CR,LF,1
DEFB 0
CALL PPRGNAM
CALL VPRINT
DEFB 2,' exchanges the logical definition '
DEFB 'of two physical disk drives',CR,LF
DEFB ' or partitions. Drive letters must be '
DEFB 'in the range of "A"-"P".',CR,LF
DEFB ' The program is re-executable under '
DEFB 'ZCPR with the "GO" command',CR,LF,LF
DEFB ' Syntax: '
DEFB 0
CALL PPRGNAM
CALL VPRINT
DEFB ' <Drv1>[:] <tab| |,> <Drv2>[:]',CR,LF,LF
DEFB ' Examples:',CR,LF,' '
DEFB 0
CALL PPRGNAM
CALL VPRINT
DEFB ' A: E: - Exchange E drive with A',CR,LF
DEFB ' '
DEFB 0
CALL PPRGNAM
CALL VPRINT
DEFB ' D,H - Exchange D drive with H',CR,LF
DEFB ' '
DEFB 0
CALL PPRGNAM
CALL VPRINT
DEFB ' // - display this message',CR,LF
DEFB 0
;::::: EXIT PROGRAM
EXIT: LD SP,(STACK) ; restore stack
RET ; ..and return to system
;::::: SUPPORT FUNCTIONS
; "called" as a pseudo-routine that returns to caller
; in: HL= target addr
JUMPHL: JP (HL) ; jump to addr in HL regs
; parse nul-terminated string skipping separator chars
; then fall through and check/convert drive letter
; in: HL= ptr to string
; out: A= drive number (or <NUL> if invalid letter)
; HL= ptr to byte after end of string
; C-Flag set if <NUL> (end of string) reached
FINDDRV: LD A,(HL) ; get byte
INC HL ; move ptr fwd
OR A ; check if <NUL> (zero) = end of string
SCF ; prepare status indicator (C-Flag set)
RET Z ; ..if <NUL> byte, return
CALL EVALSEP ; check if byte is a separator
JR NC,FINDDRV ; ..if so, get next char
; else, fall through and check if letter is valid
; evaluate if letter is a valid drive (A..P) and return as number
; in: A= letter to check
; out: A= drive number
; C-Flag set if error, NC= ok
EVALDRV: CP 'A' ; is it lower than ascii 'A' ?
RET C ; ..return with C-Flag already set
CP 'P'+1 ; is it greater than ascii 'P' ?
CCF ; ..reverse C-Flag to set correct status
RET C ; and return
SUB 'A' ; else, convert to number
RET
; evaluate char in register A whether it is a separator
; (space, comma, colon, tab, zero)
; in: A= char
; out: C-Flag set if not separator, NC= char is separator
EVALSEP: CP ' ' ; is it <SP> ?
RET Z
CP ',' ; Comma ?
RET Z
CP ':' ; Colon ?
RET Z
CP TAB ; <TAB> ?
RET Z
OR A ; <NUL> (zero) ?
RET Z
SCF ; set C-Flag
RET
; make bit mask for specified drive #
; position of 1-bit represents drive in 16-bit word (similar to Drive Vector)
; in: A= drive number
; out: HL= bit mask
MKDRMSK: LD HL,1 ; set bit 0
INC A ; ahead of loop, increase A
MKDRMS0: DEC A ; decrease A
RET Z ; ..if zero, finished
ADD HL,HL ; *2 (shift 1-bit to next position)
JR MKDRMS0 ; loop
; make bit masks for new Drive Vector
; maintaining a positive (bits set) map, and a negate version (bits reset)
; in: HL= current Drive Vector (from ENV)
; BC= bit mask w/ old position
; DE= bit mask w/ new position
MKVCMSK: PUSH BC ; save regs
LD A,B
AND H ; mask high byte
LD B,A ; ..and store result back in B
LD A,C
AND L ; mask low byte
OR B ; check if invalid (= zero), ie. not mapped in Vector
POP BC ; restore regs
JR Z,MKVCMS0 ; if invalid drive, jump
; drive at new position exists in Drive Vector - set bit
PUSH HL
LD HL,(PDRVVCT)
LD A,H ; high byte first
OR D ; ..merge with new position
LD H,A ; and store result back in H
LD A,L ; low byte
OR E ; ..merge with new position
LD L,A ; and store result back in L
LD (PDRVVCT),HL ; save final result
POP HL
RET
; drive at new position does _not_ exist in Drive Vector - reset bit
MKVCMS0: PUSH HL
LD HL,(NDRVVCT)
LD A,D ; get high byte of new position
CPL ; invert it
AND H ; reset corresponding bit
LD H,A ; ..and store result in H
LD A,E ; get low byte of new position
CPL ; invert it
AND L ; reset corresponding bit
LD L,A ; ..and store result in L
LD (NDRVVCT),HL ; save final result
POP HL
RET
; get Quiet Flag from Z3 Environment
; in: -
; out: A= Quiet Flag, defaults to A= 0 (not quiet)
GQFLAG: LD HL,(ENVADR) ; get ENV addr
LD A,H ; check if invalid (= zero)
OR L
RET Z ; ..if so, return
LD A,40 ; else, move ptr forward
CALL ADDHLA ; to Quiet Flag
LD A,(HL) ; get value
RET ; ..and return
; add A to HL (result in HL)
ADDHLA: ADD A,L ; add L
LD L,A ; store result in L
RET NC ; ..if no overflow, return
INC H ; else, increment H
RET
; print program name on CON: device
; (either the actual name, or fallback to default)
; only used by HELP
PPRGNAM: LD A,(ENVADR+1) ; get high byte of ENVPTR
OR A ; check if valid (<> zero)
JP NZ,PRTNAME ; ..if so, display actual name
; and let return from there
CALL VPRINT ; else, display default
DEFB 'BPSWAP'
DEFB 0
RET
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
; VLIB - 0x0536
; Z3LIB - 0x0757
; SYSLIB - 0x0805
; end addr 0x0854 (begin DSEG)
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
;::::: RAM STORAGE
DSEG
PDRVVCT: DEFW 0 ; new Drive Vector
; (positive notation, bit _set_ for existing drives)
NDRVVCT: DEFW 0 ; new Drive Vector
; (negative notation, bits _reset_ for existing drives)
BPBASE: DEFW 0 ; B/P Bios base addr
DRV1ST: DEFB 0 ; # of first drive
DRV2ND: DEFB 0 ; # of second drive
DEFS 40H ; room for stack
STACK: DEFW 0 ; stack storage location
END
;************************************************************************
; Remarks jxl:
; BPSWAP.COM, included in available B/P Bios package(s), was dis-
; assembled and extensively commented. Labels are up to seven chars long
; to comply with M-REL standards. However, it is recommended to use SLR
; tools that support labels up to sixteen chars.
; In its current state, the compiled/linked file matches exactly the
; original BPSWAP.COM, i.e. no changes to the source were made. There
; seems to be one bug (marked with "##### BUG") at the beginning of the
; program.
;************************************************************************

636
Source/BPBIOS/UTIL/bpsysgen.z80

@ -0,0 +1,636 @@
TITLE "Write B/P Bios System to system tracks of a disk"
;************************************************************************
;* B P S Y S G E N *
;* Copy B/P Bios based Operating System to system tracks *
;* by Harold F. Bower and Cameron W. Cotrill *
;*----------------------------------------------------------------------*
;* Disassembly: jxl Dec 2024 *
;* public release 1.0 Apr 2025 *
;* see remarks at the end *
;*----------------------------------------------------------------------*
;* LINK with Version 4 libraries: VLIB, Z3LIB, SYSLIB *
;* *
;* A>Z80ASM BPSYSGEN/RS *
;* A>SLRNK BPSYSGEN/N,/A:100,/D:08CD,BPSYSGEN,Z3LIBS/S,SYSLIBS/S,/E *
;************************************************************************
VER EQU 10
REV EQU ' '
DATE MACRO
DEFB '31 Aug 92'
ENDM
CTRLC EQU 03H ; Control-C character
BEL EQU 07H ; Bell character
LF EQU 0AH ; Line Feed character
CR EQU 0DH ; Carriage Return character
CPMBIOS EQU 0 ; CP/M BIOS warm boot (JP)
CPMBDOS EQU 5 ; CP/M BDOS entry point (JP)
CPMFCB EQU 5CH ; CP/M standard FCB #1 (+1 filename, +9 filetype)
CPMFCB2 EQU 6CH ; CP/M standard FCB #2
; From Z3LIB Get..
EXTRN GETNAME, PRTNAME, Z3INIT, WHRENV
; From SYSLIB Get..
EXTRN PUTUD, GETUD, SUA, EPRINT, CRLF, CAPINE, CIN, COUT
;::::: PROGRAM START
ORG 100H
CSEG
BPSYSGEN: JP START ; bypass header
DEFB 'Z3ENV' ; this is a ZCPR3 utility
DEFB 1 ; show external environment
ENVADR: DEFW 0 ; addr of Z3 environment
START: LD HL,(CPMBDOS+1) ; BDOS entry as starting point for Z3ENV search
CALL WHRENV ; get Z3 Environment
LD (ENVADR),HL ; ..store it
CALL Z3INIT ; init ENV ptr for Z3LIB modules
CALL GETNAME ; get actual program name
CALL GETQFLG ; check ENV quiet flag
AND A ; zero means 'verbose' i.e. not quiet
JR NZ,START1 ; ..if quiet mode, skip msg
START0: CALL EPRINT
DEFB 'B/P SYSGEN Utility V',VER/10+'0','.',VER MOD 10 + '0',REV
DATE
DEFB CR,LF,LF
DEFB 0
START1: CALL PUTUD ; currently logged in drive/user
LD HL,RESDISK ; prepare exit with resetting disk system
PUSH HL ; by putting addr of 'RESDISK' on stack
LD HL,(CPMBIOS+1) ; get BIOS entry addr
LD A,8*3 ; move forward to fn #9 SELDSK
CALL ADDHLA
LD DE,BIOSELD ; ptr to target addr
LD BC,8*3 ; bytes to copy (8 JP instructions, 3 bytes each)
LDIR ; ..copy
; Evaluate command line (if invalid parameters, switch to interactive mode)
EVALCMD: LD HL,CPMFCB ; set ptr to standard FCB #1
LD A,(HL) ; get drive
LD (SRCDRV),A ; ..and store it (SRC)
INC HL ; move ptr forard
LD A,(HL) ; get byte/char
CP '/' ; is this a help request ?
JP Z,HELP ; ..if so, jump display help
; ..and quit (addr of exit routine on stack)
; syntax: BPSYSGEN [d:]fn[.ft] [d:]
; drive #1 = source, drive #2 = destination
LD A,(CPMFCB2) ; get first byte of standard FCB #2
LD (DSTDRV),A ; store drive # (DEST)
LD (DSTDR2),A ; ..and a copy (as indicator for cmdline input)
LD B,A ; remember value
LD A,(HL) ; get first char of filename in FCB #1
CP ' ' ; is it <SP> ?
JP NZ,SRCRD0 ; ..if not, jump read sys file
LD A,B ; else, restore char (from FCB #2)
AND A ; is it <NUL> ?
JP NZ,SRCREAD ; ..if not, jump read sys tracks
; else, no source specified in command line
; (switch to interactive mode)
LD A,(SRCDRV) ; get source drive number
LD (DSTDRV),A ; ..and overwrite destination drive number
;::::: SOURCE DRIVE
; interactive mode
SRCINP: CALL EPRINT
DEFB 'Source Drive (CR to skip)? '
DEFB 0
CALL CAPINE ; get user input
CALL CRLF
CP CR ; is it <CR> ?
JP Z,SRCRD1 ; ..if so, skip
SUB 40H ; else, convert ascii to number
LD (SRCDRV),A ; ..and store it
CALL EPRINT
DEFB 'Place source disk in drive '
DEFB 0
LD A,(SRCDRV) ; get source drive number
ADD A,40H ; convert to ascii
CALL COUT ; ..and display it
CALL EPRINT
DEFB ': and press return to continue...'
DEFB 0
SRCINP0: CALL CIN ; get input
CP CTRLC ; is it <Ctrl-C> ?
RET Z ; ..if so, return
CP CR ; <CR> ?
JR NZ,SRCINP0 ; ..if not, loop ask for new input
CALL CRLF
; start reading
SRCREAD: CALL RDTRACK ; read system tracks of source disk
JR SRCRD1 ; ..and skip over
SRCRD0: CALL RDFILE ; read system file
SRCRD1: CALL CHKSYS ; check if a valid system was loaded/read
; (fn _not_ implemented, simply returns)
JP NZ,E$NOSYS ; ..if not, jump error and exit
LD A,(DSTDRV) ; get # of destination disk
AND A
JP NZ,DSTINP0 ; ..if not empty (= zero), jump to continue
; else, fall through and ask user
;::::: DESTINATION DRIVE
; interactive mode
DSTINP: CALL EPRINT
DEFB CR,LF,'Destination Drive (^C quits)? '
DEFB 0
CALL CAPINE ; get user input
CP CTRLC ; is it <Ctrl-C> ?
RET Z ; ..if so, return
SUB 40H ; else, convert ascii to number
LD (DSTDRV),A ; ..and store it
CALL CRLF
DSTINP0: LD A,(DSTDR2) ; get copy of # destination disk
AND A ; check if valid
JR NZ,DSTWRIT ; ..if so, running in command line mode
; ..continue writing to destination immediately
; else, fall through and ask user for input
CALL EPRINT
DEFB 'Place destination disk in drive '
DEFB 0
LD A,(DSTDRV) ; get destination drive number
ADD A,40H ; convert to ascii
CALL COUT ; ..and display it
CALL EPRINT
DEFB ': and press return to continue...'
DEFB 0
DSTINP1: CALL CIN ; get input
CP CTRLC ; is it <Ctrl-C> ?
RET Z ; ..if so, return
CP CR ; <CR> ?
JR NZ,DSTINP1 ; ..if not, loop ask for new input
CALL CRLF
; start writing
; exit through "RET", addr of RESDISK routine is on stack
DSTWRIT: CALL WRTRACK
CALL GETQFLG
AND A ; check if quiet flag is set
RET NZ ; ..if not (= verbose), exit program
LD A,(DSTDR2) ; else, get copy of # dest. disk (indicator cmdline mode)
AND A ; check if valid
RET NZ ; ..if not, exit program
JP DSTINP ; else, loop ask for input
; initiate a reset of disk system when returning to system
RESDISK: LD C,13 ; BDOS fn #13 (reset disk system)
CALL CPMBDOS
JP GETUD ; set Drive/User and let return from there
;::::: HELP SCREEN
HELP: CALL PRGNAME
CALL EPRINT
DEFB ' Places a copy of the operating '
DEFB 'system onto the system',CR,LF
DEFB ' tracks of a drive on the system.',CR,LF,LF
DEFB ' Syntax: '
DEFB 0
CALL PRGNAME
CALL EPRINT
DEFB ' [DIR:[Ufn.Ft]] [D:]',CR,LF,LF
DEFB ' Examples:',CR,LF,LF
DEFB ' '
DEFB 0
CALL PRGNAME
CALL EPRINT
DEFB ' - Execute in Interactive Mode',CR,LF
DEFB ' '
DEFB 0
CALL PRGNAME
CALL EPRINT
DEFB ' A: - Prompt for Source, '
DEFB 'Place System onto A',CR,LF
DEFB ' '
DEFB 0
CALL PRGNAME
CALL EPRINT
DEFB ' B:ZSDOS64.COM - Get System from File, '
DEFB 'Prompt for Drive',CR,LF
DEFB ' '
DEFB 0
CALL PRGNAME
CALL EPRINT
DEFB ' A: B: - Copy System from Drive A '
DEFB 'to Drive B',CR,LF
DEFB ' '
DEFB 0
CALL PRGNAME
CALL EPRINT
DEFB ' // - display this help',CR,LF
DEFB 0
RET
;::::: SUPPORT FUNCTIONS
; get Quiet Flag from Z3 Environment
; in: -
; out: A= Quiet Flag, defaults to A= 0 (not quiet)
GETQFLG: LD HL,(ENVADR) ; get local ENVPTR
LD A,H ; check if invalid (= zero)
OR L
RET Z ; ..if so, return
LD A,40 ; else, move ptr forward
CALL ADDHLA ; to Quiet Flag
LD A,(HL) ; get value
RET ; ..and return
; print program name on CON: device
; (either the actual name, or fallback to default)
; only used by HELP
PRGNAME: LD A,(ENVADR+1) ; get high byte of ENVPTR
OR A ; check if valid (<> zero)
JP NZ,PRTNAME ; ..if so, display actual name
; and let return from there
CALL EPRINT ; else, display default
DEFB 'BPSYSGEN'
DEFB 0
RET
; Read system tracks - source
RDTRACK: LD A,(SRCDRV) ; get source drive
CALL SELDRV ; and select it
JP Z,E$SRC ; ..if error, jump
LD (SRCDPH),HL ; store addr of DPH
LD A,10 ; move forward to DPB addr
CALL ADDHLA ; at DPH+10
LD E,(HL) ; get DPB addr in DE
INC HL
LD D,(HL)
EX DE,HL ; swap regs
LD (SRCDPB),HL ; ..and store DPB addr
LD E,(HL) ; get sectors per track in DE
INC HL ; at DPB+0
LD D,(HL)
LD (SECTTRK),DE ; store value
LD A,12 ; move forward to track offset
CALL ADDHLA ; (beginning of directory) at DPB+13
LD E,(HL) ; get track offset in DE
INC HL
LD D,(HL)
LD A,D ; check upper nybble
AND A ; is it zero ?
JP NZ,RDTRK0 ; ..if not, jump to adjust
OR E ; check lower nybble
JP Z,E$NOSYS ; ..if also zero, jump to error and exit
CP 4 ; check upper limit for # of system tracks
JR C,RDTRK1 ; ..if within boundaries, skip over
RDTRK0: LD DE,2 ; set (default) # of system tracks
RDTRK1: LD B,E ; trk offset in B (counter)
LD DE,(SECTTRK) ; get sect/trk
LD HL,0 ; set initial value
RDTRK2: ADD HL,DE ; multiply by addition
DJNZ RDTRK2 ; loop till done
XOR A ; nullify A
OR H ; check if H is zero
JP NZ,E$NOSYS ; ..if not, jump error and exit
PUSH HL ; save regs
LD BC,0
CALL BIOSTTR ; set track # 0
POP HL ; restore regs
LD C,H ; move # of sectors containing system
LD B,L ; to BC (as counter)
LD DE,0 ; set intial value
LD HL,FILEBUF ; set target addr to file buffer
; (at 0x0900, page-aligned after end of program)
RDTRK3: PUSH DE ; save regs
PUSH BC
PUSH HL
LD HL,(SRCDPH) ; get addr of DPH
LD E,(HL) ; get skew table ptr in DE
INC HL
LD D,(HL)
CALL BIOSTRN ; translate logical sector # in BC
LD B,H ; move physical sector # to BC
LD C,L
CALL BIOSTSE ; ..and set (physical) sector
POP BC ; restore target addr
PUSH BC
CALL BIOSTDM ; set as DMA buffer addr
CALL BIOREAD ; read one sector
OR A ; check for error (A <> 0)
JP NZ,E$READ ; ..if error, jump
POP HL ; restore target addr
LD DE,128 ; increase by 128 bytes (1 sector)
ADD HL,DE
POP BC ; restore regs / clear stack
POP DE
DEC B ; decrease counter
RET Z ; ..if finished, return
INC C
LD A,C
AND 00000011b ; mask lower 2 bits
LD A,'.'
CALL Z,COUT ; display progress every 4 sectors (0.5 kB)
LD A,(SECTTRK)
CP C ; max. # sect/trk reached ?
JR NZ,RDTRK3 ; ..if not, loop
INC DE ; increase trk counter
LD C,0 ; reset sect counter
PUSH DE ; save regs
PUSH BC
PUSH HL
LD B,D ; copy trk # in BC
LD C,E
CALL BIOSTTR ; ..and set track #
POP HL ; restore regs
POP BC
POP DE
JR RDTRK3 ; loop
; Read system file (img) - source
RDFILE: LD A,(ENVADR+1) ; get base addr of ENV
AND A ; check if invalid (= zero)
JR Z,RDFIL0 ; ..if no ENV, skip over
LD A,(CPMFCB+0DH) ; else, get user no from standard FCB #1
CALL SUA ; ..and log in
RDFIL0: LD DE,CPMFCB ; set ptr to standard FCB #1
LD C,15 ; BDOS fn #15 Open File
CALL BDOSSV
JP Z,E$SOPEN
LD HL,32 ; ptr to current record
ADD HL,DE
LD (HL),16 ; set # of current record
; (skip 16 records = 2kB, MOVSYS boot loader code)
LD HL,FILEBUF-128 ; set addr of file buffer (-128 ahead of loop)
RDFIL1: LD A,128 ; move forward by 128 bytes (1 sector)
CALL ADDHLA
EX DE,HL ; swap regs
LD C,26 ; BDOS fn #26 Set DMA Address
CALL BDOSSV
EX DE,HL ; swap regs back
LD C,20 ; BDOS fn #20 Read Sequentially
CALL BDOSSV
DEC A ; A= 1 returned means EOF, so decrease A
JR Z,RDFIL1 ; ..if zero, continue with next sector
LD C,16 ; BDOS fn #16 Close File
JP BDOSSV
; Write system tracks - destination
WRTRACK: LD A,(DSTDRV) ; get destination drive
CALL SELDRV ; and select it
JP Z,E$DEST ; ..if error, jump and exit
LD (DSTDPH),HL ; store addr of DPH
LD A,10 ; move forward to DPB addr
CALL ADDHLA ; at DPH+10
LD E,(HL) ; get DPB addr in DE
INC HL
LD D,(HL)
EX DE,HL ; swap regs
LD (DSTDPB),HL ; ..and store DPB addr
LD E,(HL) ; get sectors per track in DE
INC HL ; at DPB+0
LD D,(HL)
LD (SECTTRK),DE ; store value
LD A,12 ; move forward to track offset
CALL ADDHLA ; (beginning of directory) at DPB+13
LD E,(HL) ; get track offset in DE
INC HL
LD D,(HL)
LD A,D ; check upper nybble
AND A ; is it zero ?
JP NZ,WRTRK0 ; ..if not, jump to adjust
OR E ; check lower nybble
JP Z,E$NOSYS ; ..if also zero, jump to error and exit
CP 4 ; check upper limit for # of system tracks
JR C,WRTRK1 ; ..if within boundaries, skip over
WRTRK0: LD DE,2 ; set (default) # of system tracks
WRTRK1: LD B,E ; trk offset in B (counter)
LD DE,(SECTTRK) ; get sect/trk
LD HL,0 ; set initial value
WRTRK2: ADD HL,DE ; multiply by addition
DJNZ WRTRK2 ; loop till done
XOR A ; nullify A
OR H ; check if H is zero
JP NZ,E$NOSYS ; ..if not, jump error and exit
PUSH HL ; save regs
LD BC,0
CALL BIOSTTR ; set track # 0
POP HL ; save regs
LD C,H ; move # of sectors containing system
LD B,L ; to BC (as counter)
LD DE,0 ; set initial value
LD HL,FILEBUF ; set origin addr (file buffer)
WRTRK3: PUSH DE ; save regs
PUSH BC
PUSH HL
LD HL,(DSTDPH) ; get addr of DPH
LD E,(HL) ; get skew table ptr in DE
INC HL
LD D,(HL)
CALL BIOSTRN ; translate logical sector # in BC
LD B,H ; move physical sector # to BC
LD C,L
CALL BIOSTSE ; ..and set (physical) sector
POP BC ; restore origin addr
PUSH BC
CALL BIOSTDM ; set as DMA buffer addr
LD C,0
CALL BIOWRIT ; write one sector
OR A ; check for error (A <> 0)
JP NZ,E$WRITE ; ..if error, jump
POP HL ; restore origin addr
LD DE,128 ; ..and increase by 128 bytes (1 sector)
ADD HL,DE
POP BC ; restore regs / clear stack
POP DE
DEC B ; decrease counter
JR NZ,WRTRK4 ; ..if not finished, continue
LD C,1 ; else, force write (flush to disk)
JP BIOWRIT ; ..and let return from there
WRTRK4: INC C
LD A,C
AND 00000011b ; mask lower 2 bits
LD A,'.'
CALL Z,COUT ; display progress every 4 sectors (0.5 kB)
LD A,(SECTTRK)
CP C ; max. # sect/trk reached ?
JR NZ,WRTRK3 ; ..if not, loop
INC DE ; increase trk counter
LD C,0 ; reset sect counter
PUSH DE ; save regs
PUSH BC
PUSH HL
LD B,D ; copy trk # in BC
LD C,E
CALL BIOSTTR ; ..and set track
POP HL ; restore regs
POP BC
POP DE
JR WRTRK3 ; loop
; check if a valid B/P Bios was loaded
; *** function not implemented ***
; in: -
; out: Z-Flag set if ok, NZ= error
CHKSYS: XOR A ; always return Z-Flag set
RET
; select disk drive
; in: A= drive number (one-based)
; out: Z-Flag set if error
SELDRV: DEC A ; -1 to comply with CP/M BIOS standards
LD C,A
LD E,0
CALL BIOSELD ; call BIOS fn #9 directly
LD A,H
OR L
RET
; call BDOS saving regs BC, DE, HL
; out: A= 0 and Z-Flag set if not found
BDOSSV: PUSH BC
PUSH DE
PUSH HL
CALL CPMBDOS
INC A ; 0xFF --> 0x00 if not found
POP HL
POP DE
POP BC
RET
; add A to HL (result in HL)
ADDHLA: ADD A,L ; add L
LD L,A ; store result in L
RET NC ; ..if no overflow, return
INC H ; else, increment H
RET
;::::: ERROR MESSAGES
; display msg on CON: then exit with warm boot
E$READ: CALL EPRINT
DEFB BEL,'*** Read error'
DEFB 0
JP EXIT
E$SRC: CALL EPRINT
DEFB BEL,'*** Bad source!'
DEFB 0
JP EXIT
E$WRITE: CALL EPRINT
DEFB BEL,'*** Write error'
DEFB 0
JP EXIT
E$DEST: CALL EPRINT
DEFB BEL,'*** Bad destination!'
DEFB 0
JP EXIT
E$NOSYS: CALL EPRINT
DEFB BEL,'*** No system!'
DEFB 0
JP EXIT
E$SOPEN: CALL EPRINT
DEFB BEL,"*** Can't open source file!"
DEFB 0
;::::: EXIT PROGRAM
EXIT: CALL CRLF
LD HL,0 ; set addr
JP (HL) ; and jump to CP/M WBOOT
;::::: BIOS JUMPS (for direct calls)
; area is filled with actual jumps at runtime
; to call BIOS fn's directly
BIOSELD: JP 0 ; fn #9 SELDSK select disk
BIOSTTR: JP 0 ; fn #10 SETTRK set track
BIOSTSE: JP 0 ; fn #11 SETSEC set sector
BIOSTDM: JP 0 ; fn #12 SETDMA set buffer addr
BIOREAD: JP 0 ; fn #13 READ read one sector
BIOWRIT: JP 0 ; fn #14 WRITE write one sector
BIOLIST: JP 0 ; fn #15 LISTST list status (not used)
BIOSTRN: JP 0 ; fn #16 SECTRN sector translation
;::::: RAM STORAGE (not in DSEG !)
SECTTRK: DEFW 0 ; sectors per track (sect/trk), used for src+dst
SRCDPH: DEFW 0 ; source: addr of Disk Parameter Header (DPH)
SRCDPB: DEFW 0 ; source: addr of Disk Parameter Block (DPB)
DSTDPH: DEFW 0 ; destination: addr of DPH
DSTDPB: DEFW 0 ; destination: addr of DPB
SRCDRV: DEFB 0 ; source: drive # (from standard FCB #1)
DSTDRV: DEFB 0 ; destination drive #
DSTDR2: DEFB 0 ; destination drive # (copy)
; extracted from cmdline, used as indicator for run mode
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
; Z3LIB - 0x0735
; SYSLIB - 0x07e3
; end addr 0x08cc (DSEG Z3+SYS = 4 bytes)
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
; buffer start addr = 0x0900
FILEBUF: EQU $+512-($-BPSYSGEN AND 255)
DSEG
END
;************************************************************************
; Remarks jxl:
; BPSYSGEN.COM, included in available B/P Bios package(s), was dis-
; assembled and extensively commented. Labels are up to seven chars long
; to comply with M-REL standards. However, it is recommended to use SLR
; tools that support labels up to sixteen chars.
; In its current state, the compiled/linked file matches exactly the
; original BPSYSGEN.COM, i.e. no changes to the source were made.
; The program is pretty straightforward. It supports a command line
; mode and an interactive mode. (Code portions for the latter are pretty
; short.) Functionality to check if the running system is valid, was
; not implemented. Since other B/P Bios tools perform such checks, this
; is rather surprising.
; An interesting approach was used to end the program and literally
; return to the system. The address of RESDISK routine is pushed on the
; stack at the very beginning.
;************************************************************************

489
Source/BPBIOS/UTIL/confz4.z80

@ -0,0 +1,489 @@
TITLE "ZCPR 4 Configuration Utility"
;************************************************************************
;* C O N F Z 4 *
;* Configure ZCPR 4 options *
;* by Harold F. Bower and Cameron W. Cotrill *
;*----------------------------------------------------------------------*
;* Disassembly: jxl Jan 2025 *
;* public release 1.0 Apr 2025 *
;* see remarks at the end *
;*----------------------------------------------------------------------*
;* LINK with Version 4 libraries: Z3LIB, SYSLIB *
;* *
;* A>Z80ASM CONFZ4/RS *
;* A>SLRNK CONFZ4/N,/A:100,/D:080A,CONFZ4,Z3LIBS/S,SYSLIBS/S,/E *
;************************************************************************
VER EQU 10
REV EQU ' '
DATE MACRO
DEFB '18 Nov 95'
ENDM
BEL EQU 07H ; Bell character
BS EQU 08H ; Backspace character
TAB EQU 09H ; Tab character
LF EQU 0AH ; Line Feed character
CR EQU 0DH ; Carriage Return character
CPMBIOS EQU 0 ; CP/M BIOS warm boot (JP)
CPMBDOS EQU 5 ; CP/M BDOS entry point (JP)
CPMFCB EQU 5CH ; CP/M standard FCB #1 (+1 filename, +9 filetype)
CPMDMA EQU 80H ; CP/M standard DMA buffer
; From Z3LIB Get..
EXTRN GETNAME, PRTNAME, Z3INIT, WHRENV
; From SYSLIB Get..
EXTRN EPRINT, CRLF, CAPIN, PA2HC, COUT
;::::: PROGRAM START
ORG 100H
CSEG
CONFZ4: JP START ; bypass header
DEFB 'Z3ENV' ; this is a ZCPR3 utility
DEFB 1 ; show external environment
ENVADR: DEFW 0 ; addr of Z3 environment
DEFW CONFZ4 ; type 4 filler
DEFB 'CONFZ41 ',0 ; configuration name
START: LD (STACK),SP
LD SP,STACK
CALL EPRINT
DEFB 'B/P System Command Processor Configuration V'
DEFB VER/10+'0','.',VER MOD 10 + '0',REV,' '
DATE
DEFB CR,LF
DEFB 0
CALL INITZ3 ; find Z3ENV and check Wheel Byte
CALL GETNAME ; get actual program name
CALL CHKHLP ; check if help was requested
SUB ' ' ; ##### convert to ... ??
LD (UNUSED1),A ; ##### and store (not used at all)
CALL CHKSYS ; check if running B/P Bios
LD HL,(BPCNFG) ; addr CONFIG area
INC HL ; move ptr fwd
INC HL
LD A,(HL) ; get option flags (OPTF1)
AND 00000001B ; mask bit 0 (0= unbanked, 1= banked)
LD (BPBNKD),A ; store indicator
JR NZ,CHKXENV ; ..if banked, jump to continue
CALL EPRINT ; else, display msg and exit
DEFB CR,LF,'+++ Not Banked System..aborting...!',BEL
DEFB 0
JP EXIT
; check for extended environment
CHKXENV: INC HL ; move ptr fwd
INC HL
INC HL
LD A,(HL) ; get first system bank (SYSBNK)
LD (SYSBNK),A ; store it
LD HL,(ENVADR) ; addr ENV
LD DE,8 ; offset to type
ADD HL,DE ; move ptr
BIT 7,(HL) ; check high bit (= 0x80+ for extended Z3ENV)
JR NZ,CHKVERS ; ..if set, jump to continue
CALL EPRINT
DEFB CR,LF,'+++ Not Extended Environment..aborting..!',BEL
DEFB 0
JP EXIT
; check ZCPR version
CHKVERS
LD DE,55 ; offset addr CPR (8+55 = 63)
ADD HL,DE ; move ptr
LD E,(HL) ; get addr in DE
INC HL
LD D,(HL)
LD HL,5 ; offset to version byte in ZCPR 4.x
; (code starts with JP.., JR.., VERSION)
ADD HL,DE ; move ptr
LD A,(HL) ; get byte
CP 41H ; is it 4.1 (or higher) ?
JR NC,PVRSION ; ..if so, jump to continue
PUSH AF ; else, display error msg and exit
CALL EPRINT
DEFB CR,LF,BEL,"+++ Can't Configure Vers : "
DEFB 0
POP AF
CALL PA2HC
CALL EPRINT
DEFB ' of Command Processor!'
DEFB 0
JP EXIT
; display version
PVRSION: PUSH AF
CALL EPRINT
DEFB CR,LF,' Configuring Options for CPR Version : '
DEFB 0
POP AF ; restore version #
PUSH AF
RRCA ; rotate upper nybble to lower
RRCA ; (major version #)
RRCA
RRCA
AND 00001111B ; mask lower nybble
ADD A,'0' ; ..and convert to ascii
CALL COUT ; display major version #
LD A,'.'
CALL COUT
POP AF ; restore version #
AND 00001111B ; mask lower nybble
ADD A,'0' ; ..and convert to ascii
CALL COUT ; display minor version #
CALL CRLF
LD DE,10 ; move forward by another 10 bytes
ADD HL,DE ; (in Z40-1.Z80 three bytes are defined as 'Space
; reserved for expansion' - this is the last byte)
LD (PFLGADR),HL ; store addr
; branch interactive/cmdline mode
LD A,(CPMFCB+1) ; get first char from cmdline
CP ' ' ; is it <SP> ?
JP NZ,EVALCMD ; ..if not, jump cmdline mode
CALL EPRINT ; else, interactive mode
DEFB CR,LF,'Turn Time ON in Prompt Line ([Y]/N)? : '
DEFB 0
CALL CAPIN ; get user input
LD BC,0FE01H ; default to ON, European format
; ( 11111110 00000001 B )
CP 'N' ; is it 'N' ?
JR NZ,RUNIMOD ; ..if not, skip over
LD C,0 ; else, clear C (indicating OFF)
; run interactive mode
RUNIMOD: CALL SETOPTB ; set byte
CALL EPRINT
DEFB CR,LF,'US (mm/dd/yy) or European (dd.mm.yy) Dates ([U]/E) : '
DEFB 0
CALL CAPIN ; get user input
LD BC,0FD00H ; default to US format
; ( 11111101 00000000 B )
CP 'E' ; is it 'E' ?
JR NZ,RUNIM0 ; ..if not, skip over
LD C,00000010B ; else, set European format
RUNIM0: CALL SETOPTB ; set byte
JP EXIT
; evaluate command line
EVALCMD: LD HL,CPMDMA
LD A,(HL) ; get # of chars
INC HL ; set ptr to start of cmdline
PUSH HL ; save regs
CALL ADDHLA ; move ptr to end of cmdline
LD (HL),0 ; set <NUL> terminator
POP HL ; restore start of cmdline
CALL SKPWHSP ; skip any whitespace at the beginning
LD A,(HL) ; get char
CP '/' ; is it option char ?
JR NZ,ECMD0 ; ..if not, skip over
INC HL ; else, move ptr forward
ECMD0: LD A,(HL) ; get byte
OR A
JR Z,ECMD1 ; ..if zero, jump and exit
CALL CMPRMPT ; else, attempt processing option
JR ECMD0 ; ..and loop
ECMD1: JP EXIT
; cmdline: /T[+|-] Toggle Time in Prompt
; option byte, bit 0 = 0 off / 1 on
;
; cmdline: /U /E US/Europe format
; option byte, bit 1 = 0 US / 1 European
; process prompt on/off
CMPRMPT: CP 'T' ; is char 'T' (Toggle) ?
JR NZ,CMFORMT ; ..if not, try processing format option
INC HL
LD C,00000001B ; prepare for ON
LD A,(HL) ; get next char
CP '+' ; is it '+' ?
JR Z,CMPRMP0 ; ..if so, skip over
LD C,00000000B ; else, prepare for OFF
CP '-' ; is it '-' ?
JR NZ,CMFORMT ; ..if not, rather check format
CMPRMP0: LD B,11111110B ; default to European format
CMSETOP: CALL SETOPTB ; set
CMSETX: INC HL ; move ptr fwd
RET ; ..and exit
; process format
CMFORMT: LD B,11111101B ; default to ON (else, format wouldn't make sense)
LD C,00000010B ; prepare for European
CP 'E' ; is it 'E' ?
JR Z,CMSETOP ; ..if so, set byte
LD C,00000000B ; else, prepare for US
CP 'U' ; is it 'U' ?
JR Z,CMSETOP ; ..if so, set byte
JR CMSETX ; jump exit
; set option byte
; in: B= format (US/European)
; C= on/off
SETOPTB: EX DE,HL ; swap regs (save HL)
LD HL,(PFLGADR) ; addr of Prompt flag in ZCPR4 config area
LD A,(HL) ; get byte
AND B ; apply format setting
OR C ; merge on/off setting
LD (HL),A ; ..and save byte
LD HL,010FH ; offset to option byte in SYSBNK
CALL GETFRB ; get current setting
AND B ; apply format setting
OR C ; merge on/off setting
CALL SETINB ; ..and write back
EX DE,HL
RET
; check if help was requested
; get first token from command line (in FCB #1)
CHKHLP: LD HL,CPMFCB+1
LD A,(HL) ; get char
CP '/' ; is this a help request ?
RET NZ ; ..if not, return
INC HL ; move ptr fwd
LD A,(HL) ; check following char
CP '/' ; if it is also '/'
RET NZ ; ..if not, return
; else, fall through and show help screen
;::::: HELP SCREEN
HELP: CALL EPRINT
DEFB CR,LF,' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' Configure Running B/P Command Processor Options.',CR,LF,LF
DEFB ' Syntax:',CR,LF,' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' - Configure in Interactive Mode',CR,LF,' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' /T[+|-] - Toggle Time in Prompt [Set On/Off]',CR,LF,' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' /E - Display Date in European (dd.mm.yy) form',CR,LF,' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' /U - Display Date in US (mm/dd/yy) form',CR,LF,' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' // - display this screen',CR,LF,LF
DEFB ' Arguments may be combined as:',CR,LF,' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' /T+U - Turn Time On, US-style Date Display',CR,LF,LF
DEFB 'This program will only run in Banked B/P Systems.',CR,LF
DEFB 0
;::::: EXIT PROGRAM
EXIT: CALL CRLF
LD SP,(STACK) ; restore stack
RET ; ..and return to system
;::::: SUPPORT FUNCTIONS
; init Z3ENV and check Wheel byte
; if not successful, exit program
INITZ3: LD HL,(CPMBDOS+1)
CALL WHRENV ; find Z3 Environment Descriptor
LD (ENVADR),HL ; store ENV addr
LD A,H ; check if invalid (= zero)
OR L
JP Z,E$BPBIO ; ..if so, jump exit
CALL Z3INIT ; init for Z3LIB routines
LD A,41 ; offset to addr wheel byte (Z3WHL)
CALL ADDHLA ; move ptr fwd
LD E,(HL) ; get addr in DE
INC HL
LD D,(HL)
EX DE,HL ; swap regs
LD A,(HL) ; get value of wheel byte
AND A ; check if zero
RET NZ ; ..if not ON, return
CALL EPRINT ; else, display message and exit
DEFB BEL,CR,LF,'Must be wheel to Execute !',CR,LF
DEFB 0
JR EXIT
; check if running under B/P Bios
; if not, program is terminated
CHKSYS: LD HL,(CPMBIOS+1) ; get warm boot addr (BIOS fn #1)
LD L,30*3 ; adjust ptr to fn #30
LD A,(HL) ; check byte at ptr location
CP 0C3H ; is it opcode 0xC3 (JP) ?
JR NZ,E$BPBIO ; ..if not, jump error and exit
CALL JUMPHL ; else, "call" B/P Bios fn #30 (RETBIO)
LD (BPADDR),BC ; store base addr of B/P Bios
LD (BPCNFG),DE ; " config area addr
LD HL,-6 ; move ptr 6 bytes backward
ADD HL,DE ; (signature string)
LD A,(HL) ; get byte
CP 'B' ; is it 'B' ?
JR NZ,E$BPBIO ; ..if not, jump error and exit
INC HL
LD A,(HL) ; get next byte
CP '/' ; is it '/' ?
JR NZ,E$BPBIO ; ..if not, jump error and exit
INC HL
LD A,(HL) ; and get next byte
CP 'P' ; is it 'P' ?
RET Z ; ..if so, return
; else, fall through (error and exit)
; error msg
E$BPBIO: CALL EPRINT
DEFB CR,LF,BEL,'Not B/P Bios, aborting...!',CR,LF
DEFB 0
RST 0
; print program name on CON: device
; (either the actual name, or fallback to default)
; only used by HELP
PPRGNAM: LD A,(ENVADR+1) ; get high byte of local ENVPTR
OR A ; check if valid (<> zero)
JP NZ,PRTNAME ; ..if so, display actual name
; and let return from there
CALL EPRINT ; else, display default
DEFB 'SIZERAM' ; apparently wrong :-)
DEFB 0
RET
; skip whitespace (<SP> or <TAB>)
; in: HL= ptr to string
; out: HL= ptr to first char <> whitespace
SKPWHSP: DEC HL ; prior to loop, set ptr back
SKPWH0: INC HL ; move ptr fwd
LD A,(HL) ; get byte
CP ' ' ; is it <SP> ?
JR Z,SKPWH0 ; ..if so, loop
CP TAB ; is it <TAB> ?
JR Z,SKPWH0 ; ..if so, loop
RET ; else, return
; add A to HL (result in HL)
ADDHLA: ADD A,L ; add L
LD L,A ; store result in L
RET NC ; ..if no overflow, return
INC H ; else, increment H
RET
; the following routines rearrange Top of Stack by injecting an
; intermediate return addr, and putting the Bios fn call on top
; so that HL regs are preserved
; order of steps:
; [1] HL (= addr) is pushed onto stack
; [2] intermediate return addr is swapped to Top of Stack
; [3] HL (= addr) is pushed onto stack again
; [4] Bios fn JP addr is swapped to Top of Stack
; [5] Bios is "called" through RET, and returns to intermediate addr
; get byte from ram bank (in C) - in the form LD A,(HL)
; in: HL= addr
; out: A= byte
GETFRB: PUSH BC
PUSH HL ; save addr
LD BC,(SYSBNK) ; C= System Bank, B= not used
LD HL,GETFRB0 ; load return addr
EX (SP),HL ; put it on stack
PUSH HL ; save HL again (previous top of stack)
LD HL,(BPADDR) ; get B/P Bios base addr
LD L,35*3 ; adjust ptr to fn #35 (FRGETB)
EX (SP),HL ; put addr on stack
RET ; ..and "call" Bios fn through stack
GETFRB0: POP BC ; restore regs
RET ; ..and finally return
; set byte in ram bank (in C) - in the form LD (HL),A
; in: HL= addr, A= byte to set
SETINB: PUSH BC
PUSH HL ; save addr
LD BC,(SYSBNK)
LD HL,GETFRB0 ; load return addr
EX (SP),HL ; put it on stack
PUSH HL ; save HL again (previous top of stack)
LD HL,(BPADDR) ; get B/P Bios base addr
LD L,37*3 ; adjust ptr to fn #37 (FRPUTB)
EX (SP),HL
RET ; ..and "call" Bios fn through stack
; "called" as a pseudo-routine that returns to caller
; in: HL= target addr
JUMPHL: JP (HL) ; jump to addr in HL regs
;::::: RAM STORAGE (_no_ DSEG !)
PFLGADR: DEFW 0 ; addr of Prompt flag (last reserved option byte)
SYSBNK: DEFB 0 ; beginning of System Bank(s)
UNUSED1: DEFB 0 ; #####
BPADDR: DEFW 0 ; base addr B/P Bios
BPCNFG: DEFW 0 ; addr of B/P Bios CONFIG area
BPBNKD: DEFB 0 ; indicator banked system
; (bit 0 of OPTF1, 0= unbanked, 1= banked)
DEFS 30H ; room for stack
STACK: DEFW 0 ; stack storage location
END
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
; Z3LIB - 0x06b4
; SYSLIB - 0x0762
; end addr 0x080a (begin DSEG of LIB's)
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
;************************************************************************
; Remarks jxl:
; CONFZ4.COM, included in available B/P Bios package(s), was dis-
; assembled and extensively commented. Labels are up to seven chars long
; to comply with M-REL standards. However, it is recommended to use SLR
; tools that support labels up to sixteen chars.
; In its current state, the compiled/linked file matches exactly the
; original CONFZ4.COM, i.e. no changes to the source were made. Possible
; optimisations detected during disassembly are marked with "#####" in the
; comment.
; The program seems to be in an early stage as it does not comply with
; general coding standards seen by HFB/CWC. For instance, no DSEG is used.
; Only 2 options can be configured with this program. It is not known
; whether provisions were made in ZCPR v4.1 for further options.
;************************************************************************

752
Source/BPBIOS/UTIL/hashini.z80

@ -0,0 +1,752 @@
TITLE "HASHINI Drive Utility"
;************************************************************************
;* H A S H I N I *
;* Set Drive Volume Name and Init for File Stamps *
;* by Harold F. Bower and Cameron W. Cotrill *
;*----------------------------------------------------------------------*
;* Disassembly: jxl Mar 2025 *
;* public release 1.0 Apr 2025 *
;* see remarks at the end *
;*----------------------------------------------------------------------*
;* LINK with Version 4 libraries: Z3LIB, SYSLIB *
;* *
;* A>Z80ASM HASHINI/RS *
;* A>SLRNK HASHINI/N,/A:100,/D:09E5,HASHINI,Z3LIBS/S,SYSLIBS/S,/E *
;************************************************************************
VER EQU 02
REV EQU ' '
DATE MACRO
DEFB '12 Sep 93'
ENDM
CTRLC EQU 03H ; Control-C character
BEL EQU 07H ; Bell character
BS EQU 08H ; Backspace character
TAB EQU 09H ; Tab character
LF EQU 0AH ; Line Feed character
CR EQU 0DH ; Carriage Return character
ESC EQU 1BH ; Escape character
CPMBIOS EQU 0 ; CP/M BIOS warm boot (JP)
CPMBDOS EQU 5 ; CP/M BDOS entry point (JP)
CPMFCB EQU 5CH ; CP/M standard FCB #1 (+1 filename, +9 filetype)
CPMFCB2 EQU 6CH ; CP/M standard FCB #2
CPMDMA EQU 80H ; CP/M standard DMA buffer
; From Z3LIB Get..
EXTRN GETNAME, PRTNAME, GETQUIET, Z3INIT
; From SYSLIB Get..
EXTRN BLINE, EPRINT, CRLF, CAPIN, COUT, CODEND
;::::: PROGRAM START
ORG 100H
CSEG
HASHINI: JP START ; bypass header
DEFB 'Z3ENV' ; this is a ZCPR3 utility
DEFB 1 ; show external environment
DEFB 1
ENVADR: DEFW 0 ; addr of Z3 environment
DEFB 1
DEFB 'HASHINI '
DEFB 0
; config area (for ZNCFG.COM)
CFGAREA: DEFB 0 ; default value for program quiet flag
DEFB 0FFH
START: LD (STACK),SP ; save stack
LD SP,STACK
CALL Z3INIT ; init ENVPTR for Z3LIB routines
CALL GETNAME ; get ptr to program name
CALL GETQUIET ; check ENV quiet flag
LD HL,CFGAREA ; ptr to config area
OR (HL) ; merge flags (ENV + program)
LD (PRGQFLG),A ; store program quiet flag
CALL EPRINT
DEFB CR,LF,'Initialize Volume Label and File Stamps Ver '
DEFB VER/10+'0','.',VER MOD 10 + '0',REV,' '
DATE
DEFB CR,LF
DEFB 0
LD C,25 ; get current disk (BDOS fn #25)
CALL CPMBDOS
LD (OLDDRV),A ; remember drive #
CALL EVALCMD ; evaluate command line
JR INITWSPC
;::::: MAIN LOOP
START0: LD SP,STACK ; reset stack pointer
CALL EPRINT
DEFB CR,LF,LF,'Initialize another Disk? (Y/[N]) : '
DEFB 0
CALL CINPUT ; get user input
CP 'Y' ; is it 'Y' ?
JP NZ,EXIT ; ..if not, jump to exit
CALL SELODRV ; restore previously logged drive
CALL CRLF
OR 0FFH ; from now on run interactively
; init workspace (ram storage)
INITWSPC: LD (RUNMODE),A ; store mode
LD HL,WSPC ; clear workspace data area
LD B,(STACK-WSPC)-3
CALL FILLZ
;::::: DISK DRIVE
GETDISK: LD A,(RUNMODE) ; get mode
OR A ; running in cmdline mode ?
JR Z,GETVOLN ; ..if so, drive is known, jump to continue
; interactive mode - ask for disk to initialize
IMDISK: CALL EPRINT
DEFB CR,LF,LF,'Initialize which Disk for '
DEFB 0
LD A,(STMPTYP) ; stamp format indicator
OR A ; is it P2Dos ?
JR NZ,IMDISK1 ; ..if not, jump to continue
CALL EPRINT ; display chosen format
DEFB 'P2DOS'
DEFB 0
JR IMDISK2 ; skip over
IMDISK1: CALL EPRINT
DEFB 'NZTIME'
DEFB 0
IMDISK2: CALL EPRINT
DEFB ' Date/Time Stamps? : '
DEFB 0
CALL CINPUT ; get user input
CP 'A' ; disk drive letter must be
JR C,IMDISK3 ; between 'A' and 'P'
CP 'P'+1
JR C,IMDISK4
IMDISK3: CALL EPRINT ; else, notify user and loop
DEFB BEL,BS,' ',BS
DEFB 0
JR IMDISK
IMDISK4: LD (CURRDSK),A ; store disk drive letter
;::::: VOLUME NAME
GETVOLN: LD A,(VOLNAME)
OR A
JR NZ,IMVOLN3
; interactive mode - ask for volume name
IMVOLN: CALL EPRINT
DEFB CR,LF,'Enter Volume Name [1-11 chars] : '
DEFB 0
LD HL,CPMDMA ; set ptr to standard buffer
LD (HL),11 ; prepare char count (max. 11 chars)
XOR A ; clear A
LD (CPMDMA+1),A ; prepare end-of-string
DEC A ; let capitalize (A= non-zero)
CALL BLINE ; get user input
LD A,(HL) ; check char count
OR A ; is it empty string (nothing entered) ?
JR Z,IMVOLN ; ..if so, loop
LD DE,VOLNAME ; point to volname buffer
IMVOLN1: LD A,(HL) ; get char
LDI ; ..and copy over
OR A ; end of string ?
JR NZ,IMVOLN1 ; ..if not, loop
IMVOLN3: LD A,(PRGQFLG) ; get program quiet flag
OR A ; running in quiet mode ?
JR Z,DSKPROC ; ..if so, skip over
CALL EPRINT
DEFB CR,LF,' Confirm Initialize Drive '
DEFB 0
LD A,(CURRDSK)
CALL COUT
CALL EPRINT
DEFB ': (Y/[N]) '
DEFB 0
CALL CINPUT ; get user input
CP 'Y'
JP NZ,FINISH
;::::: PROCESS DISK
DSKPROC: LD A,(CURRDSK) ; get current disk drive letter
SUB 'A' ; make numeric
PUSH AF ; save regs
LD E,A ; drive # in E
CALL BDSELD ; select disk drive (BDOS call)
CALL EPRINT ; display warning
DEFB BEL,CR,LF,'+++ Existing Files will be ERASED! +++'
DEFB CR,LF,' --- Proceed anyway (Y/[N]) : '
DEFB 0
CALL CINPUT ; get user input
CP 'Y' ; is it 'Y' ?
JP NZ,FINISH ; ..if not, jump to finish processing
POP AF ; restore regs
LD C,A ; drive # in C
CALL BIOSELD ; select disk drive (BIOS call)
LD A,H ; check if DPH addr is valid
OR L
JP Z,E$DRVILL ; ..if not, jump display error msg and exit
; get parameters of current disk drive
LD E,(HL) ; get addr of skew table in DE
INC HL
LD D,(HL)
LD (SKEWTBL),DE ; and store value
LD DE,9
ADD HL,DE ; move ptr fwd (to DPH+10)
LD E,(HL) ; addr of DPB in DE
INC HL
LD D,(HL)
PUSH DE ; move addr to IX
POP IX
; ??? ##### CODEND not used
CALL CODEND ; get first free memory page addr in HL
LD D,(IX+8) ; get DirMax in DE
LD E,(IX+7) ; (max. dir entries -1)
INC DE ; +1
LD (DIRMAX),DE ; store value
SRL D ; /2
RR E
SRL D ; /4
RR E
LD (STMPMAX),DE ; store value
; (1 stamp dir entry for 4 file dir entries)
LD BC,0
LD HL,CPMDMA ; set to standard buffer
PUSH DE ; save regs
PUSH BC
LD DE,VOLNAME ; ptr to volume name
LD A,(DE) ; get char
OR A ; is it zero ? (<NUL> means empty string)
LD B,3*32 ; prepare counter for 3 stamp entries
JR Z,MKSTMP ; ..if no volume name, jump to continue
; make a volume name entry
; HL= ptr to standard buffer, DE= ptr to VOLNAME
; B= char count, C= char
LD (HL),020H ; set first byte of dir entry (user area)
; to 0x20 - indicates time stamp
INC HL ; move ptr fwd
LD B,11 ; number of chars
MKVOLN: LD A,(DE) ; get VOLNAME char in A
LD C,' ' ; prepare for <NUL> byte
OR A ; end of string ?
JR Z,MKVOLN1 ; ..if so, skip over
LD C,A ; else, get char in C
INC DE ; move VOLNAME ptr forward
MKVOLN1: LD (HL),C ; copy char to buffer
INC HL ; move ptr fwd
DJNZ MKVOLN ; loop till done
LD B,32-12 ; clear remaining bytes of stamp entry
CALL FILLZ
LD B,2*32 ; fill next 2 stamp entries
; make a stamp entry and write to dir
MKSTMP: LD A,0E5H ; CP/M default byte for free dir entries
CALL FILLA ; fill stamp entries
LD A,(STMPTYP) ; get chosen stamp format (0x00 = P2Dos, 0xFF = NZTime)
OR A ; ..and check
LD A,021H ; prepare for P2Dos
JR Z,MKSTMP1 ; ..if so, skip over
LD A,0A1H ; else, prepare for NZTime
MKSTMP1: LD (HL),A ; store byte
INC HL ; move ptr fwd
LD B,32-1 ; ..and clear remaining bytes of stamp entry
CALL FILLZ
POP BC ; restore regs
POP DE
CALL PVBOSE ; if verbose mode, display msg
DEFB CR,LF,'...Writing Initialized Directory...'
DEFB 0
LD DE,0 ; initial start #
LD (STMPCUR),DE ; set # of current stamp entry
CALL WRSTMP ; ..and write stamp to directory
LD HL,CPMDMA ; reset ptr to begin of standard buffer
LD A,0E5H ; clear first part of stamp entry
LD B,32
CALL FILLA
MKSTMP2: CALL WRSTMP ; ..and write next stamp entry
LD HL,(STMPCUR) ; get current #
LD DE,(STMPMAX) ; get max. #
OR A ; clear flags
SBC HL,DE ; check if all entries were written
ADD HL,DE
JR NZ,MKSTMP2 ; ..if not, loop
LD BC,1 ; set C= 1 to indicate Directory Write (forced)
CALL BIOWRIT ; ..and perform through BIOS
JP DSKDONE
; display help and exit
HLPEXIT: XOR A ; clear A
LD (RUNMODE),A ; ..and store mode (cmdline)
JR HELP
E$DRVILL: CALL EPRINT ; display error msg and fall through
DEFB CR,LF,LF,BEL,'Illegal drive name'
DEFB 0
;::::: HELP
HELP: CALL EPRINT
DEFB CR,LF,'Usage: Set Drive Volume Name & '
DEFB 'Initialize for P2Dos/NzTime file stamps',CR,LF,LF
DEFB 'Syntax:',CR,LF,TAB
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' [d:][volname] [/][P | Z | Q]',CR,LF
DEFB 'Examples:',CR,LF,TAB
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB TAB,'- Enter Interactive Mode',CR,LF,TAB
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' /P',TAB,'- Init Drive interactively w/P2D stamps',CR,LF,TAB
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' d:',TAB,'- Initialize drive "d" w/default Stamp',CR,LF,TAB
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' d:name',TAB,'- Init drive "d" adding Vol ID "name"',CR,LF,TAB
DEFB TAB,TAB,' file with default Stamps',CR,LF,TAB
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' d: ZQ',TAB,'- Init drive "d" for NZTime Stamps',CR,LF,TAB
DEFB TAB,TAB,' suppressing unneeded messages',CR,LF,TAB
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' //',TAB,'- Display this message',CR,LF,LF
DEFB 'Note: ZCNFG may be used to configure a flag to suppress',CR,LF
DEFB ' drive confirmation prompt and status messages',CR,LF
DEFB 0
JP FINISH
; print program name on CON: device
; (either the actual name, or fallback to default)
; only used by HELP
PPRGNAM: LD A,(ENVADR) ; get high byte of ENV ptr
OR A ; check if valid (<> zero)
JP NZ,PRTNAME ; ..if so, display actual name
; and let return from there
CALL EPRINT ; else, display default name
DEFB 'HASHINI'
DEFB 0
RET
; write a stamp entry to directory
; in: IX= ptr DPB
; STMPCUR= # of current stamp entry
WRSTMP: PUSH BC ; save regs
PUSH DE
PUSH HL
LD HL,0
LD BC,(STMPCUR) ; get # of current stamp entry
LD D,(IX+1) ; get sectors per track (DPB+0)
LD E,(IX+0)
LD A,17 ; set counter
; determine track # (in BC) and sector # (in HL)
WRSTMP1: OR A ; clear flags
SBC HL,DE ; divide by subtraction
CCF ; inverse C-flag
JR C,WRSTMP2
ADD HL,DE ; compensate overflow
OR A ; clear flags
WRSTMP2: RL C ; divide BC by 2 (track #)
RL B
DEC A ; decrease counter
JR Z,WRSTMP3 ; ..if zero, exit loop
RL L ; else, also divide HL by 2 (sector #)
RL H
JR WRSTMP1 ; and continue
WRSTMP3: PUSH HL ; save (log.) sector #
LD H,(IX+14) ; get track offset (# sys tracks)
LD L,(IX+13)
ADD HL,BC ; add to calculated track #
LD B,H
LD C,L
CALL BIOSTTR ; set track
POP BC ; restore (log.) sector #
LD DE,(SKEWTBL) ; get addr of skew table
CALL BIOSTRN ; translate logical to physical sector
LD B,H
LD C,L
CALL BIOSTSE ; set (phys.) sector
LD BC,CPMDMA ; set buffer addr
CALL BIOSTDM
LD BC,0 ; set C= 0 to indicate Unallocated Write
CALL BIOWRIT ; ..and perform through BIOS
OR A ; check for error
JR Z,WRSTMPX ; ..if not, jump to exit subroutine
CALL EPRINT ; else, display msg
DEFB CR,LF,BEL,'Directory write error'
DEFB 0
JR FINISH
WRSTMPX: LD BC,(STMPCUR) ; get current stamp #
INC BC ; increase
LD (STMPCUR),BC ; ..and save again
POP HL ; restore regs
POP DE
POP BC
RET
; select disk drive that was logged at start of program
; using BIOS fn first, then BDOS fn
SELODRV: LD A,(OLDDRV) ; get # of old logged disk drive
LD C,A ; in C
LD B,0
PUSH BC ; save it
LD DE,1 ; ??? ##### not necessary
CALL BIOSELD ; select disk drive (through BIOS)
POP DE ; restore drive # in E
; ..and fall through
; call BDOS fn #14 SELDSK
; in: E= drive #
BDSELD: LD C,14
JP CPMBDOS ; jump BDOS and let return from there
;::::: FINISH PROCESSING DISK
FINISH: CALL SELODRV ; restore previously logged drive
; ..and fall through
DSKDONE: LD A,(CURRDSK)
SUB 40H ; make numeric
LD B,A ; use value as counter
SCF ; set C-flag
LD HL,0 ; start with all bits cleared
DSKDN0: ADC HL,HL ; shift Carry bit into position
DJNZ DSKDN0 ; loop till done
EX DE,HL ; bit mask in DE (selected disk drive)
LD C,37 ; BDOS fn #37 RESDSK reset disk system
CALL CPMBDOS
LD A,(RUNMODE) ; get mode
OR A ; running in cmdline mode ?
JP NZ,START0 ; ..if not, loop for next drive
; else, fall through and exit
;::::: EXIT PROGRAM
EXIT: LD SP,(STACK) ; restore stack
RET ; ..and return to system
;::::: SUPPORT FUNCTIONS
; EVALCMD Evaluate command line
; based on tokens provided by CP/M parser in FCB #1/#2
; in: A= # of current drive
; out: A= 0x00 cmdline mode, 0xFF interactive mode
; Syntax: [d:][volname] [/][P | Z | Q]
EVALCMD: XOR A ; clear A
LD (CURRDSK),A ; ..and variables
LD (RUNMODE),A
LD HL,CPMFCB ; set ptr to standard FCB #1
LD A,(HL) ; get drive #
OR A ; check if zero
JR Z,ECMD1 ; ..if so, skip over
ADD A,40H ; else, make ascii
CP 'P'+1 ; check if valid
JR NC,ECMD1 ; ..if not, skip over
LD (CURRDSK),A ; else, save disk drive letter
ECMD1
INC HL ; move ptr fwd
LD A,(HL) ; get char
LD DE,VOLNAME ; ptr to buffer for volume name
LD B,11 ; max. 11 chars
CP ' ' ; is it <SP> ?
JR Z,ECMD2 ; ..if so, jump to continue
CP '/' ; is it option or help request ?
JR NZ,ECMD1V ; ..if not, jump to copy volume name
INC HL ; else, move ptr fwd
CP (HL) ; and check next char
JP Z,HLPEXIT ; ..if also '/', jump to display help
JR ECMD3OPT ; else, this char indicates an option
; volume name found, copy it
ECMD1V0: LD A,(HL) ; get char
ECMD1V: CP ' ' ; is it <SP> ?
JR Z,ECMD2 ; ..if so, jump to continue
LD (DE),A ; save char in VOLNAME buffer
INC DE ; move both ptr's forward
INC HL
DJNZ ECMD1V0 ; loop till done
; eval 2nd cmdline token (FCB #2)
ECMD2: XOR A ; clear A
LD (DE),A ; store in VOLNAME to indicate no name
LD HL,CPMFCB2+1 ; set ptr to standard FCB #2, after drive letter
LD A,(HL) ; get char
CP '/' ; is it option or help request ?
JR NZ,ECMD3OPT ; ..if not, letter must be an option, so skip over
INC HL ; else, move ptr fwd
CP (HL) ; and check next char
JP Z,HLPEXIT ; ..if also '/', jump to display help
; eval option and done
ECMD3OPT: CALL EVLOPT ; eval option
RET NZ ; if error, switch to interactive mode and return
; else, continue final check
LD HL,CPMFCB ; set ptr to standard FCB #1
LD A,(HL) ; get byte
OR A ; is it zero ?
JR Z,ECMDIM ; ..if so, jump done (interactive mode)
INC HL ; move ptr fwd
LD A,(HL) ; get char
CP ' ' ; is it <SP> ?
JR NZ,ECMDCM ; ..if not, jump done (cmdline mode)
LD A,(CPMFCB2+1) ; get char of 2nd token
CP ' ' ; is it <SP> ?
JR NZ,ECMDCM ; ..if not, jump done (cmdline mode)
; else, fall through (interactive mode)
ECMDIM: OR 0FFH ; set status (interactive mode)
RET
ECMDCM: XOR A ; set status (cmdline mode)
RET
; evaluate _one_ option on cmdline
; in: HL= ptr to char (already behind a leading '/')
; out: A= 0x00 cmdline mode, 0xFF interactive mode
; Z-flag reset (NZ) in case of error, i.e. interactive mode
; possible flags are /Q (quiet), /P (P2Dos stamps), /Z (NZTime stamps)
EVLOPT: LD B,7 ; max. 7 chars
EVLOPTQ: LD A,(HL) ; get char
CP 'Q' ; option /Q - quiet ?
JR NZ,EVLOPTP ; ..if not, jump to check next option
LD A,(PRGQFLG) ; get program quiet flag
XOR 0FFH ; toggle
LD (PRGQFLG),A ; ..and save back
JR EVLONXT ; jump to continue
EVLOPTP: CP 'P' ; option /P - P2Dos stamps ?
JR NZ,EVLOPTZ ; ..if not, jump to check next option
XOR A ; clear A
LD (STMPTYP),A ; ..and store stamp type
JR EVLONXT ; jump to continue
EVLOPTZ: CP 'Z' ; option /Z - NZTime stamps ?
JR NZ,EVLONX1 ; ..if not, jump to check for whitespace
OR 0FFH ; set A= 0xFF
LD (STMPTYP),A ; store stamp type
; ..and fall through to read next char
EVLONXT: INC HL ; move ptr fwd
LD A,(HL) ; get char
; options are separated by whitespace
EVLONX1: CP ' ' ; is it <SP> ?
JR Z,EVLOXIT ; ..if so, jump to exit loop
CP TAB ; is it <TAB> ?
JR Z,EVLOXIT ; ..if so, jump to exit loop
JR NZ,EVLOERR ; else, invalid option char found
DJNZ EVLOPTQ ; loop till done
EVLOXIT: XOR A ; set return code 0x00 (clear A and flags)
RET
EVLOERR: LD A,(PRGQFLG) ; get program quiet flag
OR A ; running in verbose mode ?
LD A,BEL
CALL Z,COUT ; ..if so, notify user
CALL EPRINT
DEFB CR,LF,'+++ Unrecognized Option "'
DEFB 0
LD A,(HL)
CALL COUT
CALL EPRINT
DEFB '" ... Setting Interactive'
DEFB 0
OR 0FFH ; set return code 0xFF
RET
; get console input
; and check for abort request
CINPUT: CALL CAPIN ; get char and capitalize
CP CTRLC ; is it <Ctrl-C> ?
JP Z,EXIT
CP ESC ; is it <ESC> ?
JP Z,EXIT
CP 'a' ; below 'a' ? (not possible, CAPIN capitalizes)
RET C
CP 'z'+1 ; between lowercase 'a' and lowercase 'z' ?
RET NC
AND 01011111b ; remove bit 5 to capitalize
RET
; ##### unreferenced code (not used)
; copy 32 (0x20) bytes from (HL) to (DE)
LD B,32
UNUSED1: LD A,(HL)
LD (DE),A
INC HL
INC DE
DJNZ UNUSED1
RET
; #####
; fill memory with zero, or byte
; in: A= byte
; B= # of bytes
; HL= target addr
FILLZ: XOR A ; clear A
FILLA: LD (HL),A ; store byte
INC HL ; move ptr fwd
DJNZ FILLA ; loop
RET
; verbose print - print string to CON: if quiet flag is off
; in: (Stack) contains start addr of nul-terminated string
PVBOSE: LD A,(PRGQFLG) ; get program quiet flag
OR A ; running in verbose mode ?
JP Z,EPRINT ; ..if so, jump to print and let return from there
EX (SP),HL ; else, swap HL and top-of-stack
PVBOSE0: LD A,(HL) ; get char
INC HL ; move ptr fwd
OR A ; is byte = zero ?
JR NZ,PVBOSE0 ; ..if not, loop
EX (SP),HL ; else, swap back
RET
; entry points for indirect BIOS calls
; BC is loaded with absolute offset from WBOOT (fn #1)
; to respective jump instruction, i.e. 3 bytes per fn
BIOSELD: PUSH BC
LD BC,3*8 ; fn #9 SELDSK select disk
JR BIOSFN
BIOSTTR: PUSH BC
LD BC,3*9 ; fn #10 SETTRK set track
JR BIOSFN
BIOSTSE: PUSH BC
LD BC,3*10 ; fn #11 SETSEC set sector
JR BIOSFN
BIOSTDM: PUSH BC
LD BC,3*11 ; fn #12 SETDMA set buffer addr
JR BIOSFN
BIOREAD: PUSH BC
LD BC,3*12 ; fn #13 READ read one sector (not used)
JR BIOSFN
BIOWRIT: PUSH BC
LD BC,3*13 ; fn #14 WRITE write one sector
JR BIOSFN
BIOSTRN: PUSH BC
LD BC,3*15 ; fn #16 SECTRN sector translation
JR BIOSFN
; call BIOS fn indirectly
; in: BC= offset to fn in Bios jump table
BIOSFN: EX (SP),HL ; swap HL and top-of-stack (= prev. BC)
PUSH HL ; save HL (prev. BC)
LD HL,(CPMBIOS+1) ; Bios base addr
ADD HL,BC ; add offset to fn #
POP BC ; restore BC
EX (SP),HL ; swap HL and top-of-stack again
RET ; "call" by returning to Bios fn
UNUSED2:
DEFB 0,0,0,0,0,0 ; ##### unreferenced chunk of data
DEFB '!!!TIME&DAT' ; obviously not used
DEFB 0,0,0,0,0,0,0,0
DEFB 0,0,0,0,0,0,0,0
DEFB 0,0,0,0,0,0,0,0
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
; Z3LIB - 0x08a7
; SYSLIB - 0x091a
; end addr 0x09e5 (begin DSEG)
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
DSEG
STMPTYP: DEFB 0 ; stamp type flag, 0x00 = P2Dos, 0xFF = NZTime
PRGQFLG: DEFB 0 ; program quiet flag, 0x00 = verbose
VOLNAME: DEFS 12 ; buffer for volume name, 11 bytes + <NUL> terminator
RUNMODE: DEFB 0 ; indicator, 0x00 = cmdline mode / 0xFF = interactive mode
OLDDRV: DEFB 0 ; logged drive at program start
CURRDSK: DEFB 0 ; current disk drive letter
WSPC: ; workspace starts here
DIRMAX: DEFW 0 ; max. # of dir entries (from DPH +1)
STMPMAX: DEFW 0 ; max. # of stamp entries (= DIRMAX / 4)
STMPCUR: DEFW 0 ; current # of stamp entry (used as counter)
SKEWTBL: DEFW 0 ; addr of skew table (from DPH)
DEFS 070H ; room for stack
STACK: DEFW 0 ; stack storage location
END
;************************************************************************
; Remarks jxl:
; HASHINI.COM, included in available B/P Bios package(s), was dis-
; assembled and extensively commented. Labels are up to seven chars long
; to comply with M-REL standards. However, it is recommended to use SLR
; tools that support labels up to sixteen chars.
; In its current state, the compiled/linked file matches exactly the
; original SHOWHD.COM, i.e. no changes to the source were made. Possible
; optimisations detected during disassembly are marked with "#####" in the
; comment. It is fair to say that the program seems to be in an early
; stage; as the version number indicates. Apparently, provisions were made
; to test exitence, or even generate a DateStamper !!!TIME&.DAT file
; (which is not the case right now.)
; The program supports an interactive and a command line mode. Labels
; start with "IM" to indicate code specifically for interactive mode.
;************************************************************************

640
Source/BPBIOS/UTIL/ldsys.z80

@ -0,0 +1,640 @@
TITLE "B/P Bios System Loader"
;************************************************************************
;* L D S Y S *
;* Load a B/P Bios based system into RAM memory for direct execution *
;* by Harold F. Bower and Cameron W. Cotrill *
;*----------------------------------------------------------------------*
;* Disassembly: jxl Dec 2024 *
;* public release 1.0 Apr 2025 *
;* see remarks at the end *
;*----------------------------------------------------------------------*
;* LINK with Version 4 libraries: VLIB, Z3LIB, SYSLIB *
;* *
;* A>Z80ASM LDSYS/RS *
;* A>SLRNK LDSYS/N,/A:100,/D:0CF8,LDSYS,VLIBS/S,Z3LIBS/S,SYSLIBS/S,/E *
;************************************************************************
VER EQU 12
REV EQU ' '
DATE MACRO
DEFB '17 Jul 96'
ENDM
BEL EQU 07H ; Bell character
LF EQU 0AH ; Line Feed character
CR EQU 0DH ; Carriage Return character
CPMBDOS EQU 5 ; CP/M BDOS entry point (JP)
CPMFCB EQU 5CH ; CP/M standard FCB #1 (+1 filename, +9 filetype)
CPMDMA EQU 80H ; CP/M standard DMA buffer
; From VLIB Get..
EXTRN VPRINT, Z3VINIT
; From Z3LIB Get..
EXTRN GETNAME, PRTNAME, ZFNAME, Z3LOG, WHRENV
EXTRN GZMTOP ; ##### not used, but linked
; From SYSLIB Get..
EXTRN PUTUD, GETUD, F$OPEN, F$READ, SETDMA, PFN3, PHL4HC, COUT, CODEND
EXTRN F$CLOSE, CRLF ; ##### not used, but linked
;::::: PROGRAM START
ORG 100H
CSEG
LDSYS: JP START ; bypass header
DEFB 'Z3ENV' ; this is a ZCPR3 utility
DEFB 1 ; show external environment
ENVADR: DEFW 0 ; addr of Z3 environment
DEFW LDSYS ; type 4 filler
DEFB 'LDSYS ',0 ; configuration name
FTYPE: DEFB 'IMG' ; standard file type
START: LD (STACK),SP
LD SP,STACK
CALL PUTUD ; currently logged drive/user
LD HL,(CPMBDOS+1)
CALL WHRENV ; find Z3 Environment Descriptor
PUSH AF
LD (ENVADR),HL ; store ENV addr
CALL Z3VINIT ; ..and init for Z3LIB routines
CALL GETNAME ; get actual program name
CALL VPRINT
DEFB CR,LF,1,'B/P Bios System Loader',2,' Vers ',VER/10+'0','.'
DEFB VER MOD 10 + '0',REV,' '
DATE
DEFB CR,LF,' Copyright (C) 1991,3 by H.F.Bower & C.W.Cotrill',CR,LF
DEFB 0
; get first token from command line (in FCB #1)
LD A,(CPMFCB+1)
CP '/' ; is this a help request ?
JP Z,HELP ; ..if so, jump display help screen
POP AF
JR Z,E$NOFIL ; else, jump error no file specified
LD HL,(ENVADR) ; get addr Z3ENV
LD DE,70 ; offset to high byte BIOS addr
ADD HL,DE ; move ptr
LD H,(HL) ; get high byte of B/P Bios page addr
LD L,30*3 ; ..and set low byte to fn #30
LD A,(HL) ; check byte at ptr location
CP 0C3H ; is it opcode 0xC3 (JP) ?
JR NZ,E$NOFIL ; ..if not, jump error and exit
CALL JUMPHL ; else, "call" B/P Bios fn #30 (RETBIO)
LD HL,-6 ; move ptr 6 bytes backward
ADD HL,DE ; (signature string)
LD A,(HL) ; get byte
CP 'B' ; is it 'B' ?
JR NZ,E$NOFIL ; ..if not, jump error and exit
INC HL ; ptr fwd
LD A,(HL) ; get byte
CP '/' ; is it '/' ?
JR NZ,E$NOFIL ; ..if not, jump error and exit
INC HL ; ptr fwd
LD A,(HL) ; get byte
CP 'P' ; is it 'P' ?
JR NZ,E$NOFIL ; ..if not, jump error and exit
LD DE,6 ; else, set ptr to OPTF1 (Bios Option Flags)
ADD HL,DE ; at CONFIG+2
BIT 7,(HL) ; check bit 7 (0= not locked, 1= locked, can't reload)
JR Z,E$NOFIL ; ..if not set, skip over
E$RUNBP: CALL VPRINT
DEFB CR,LF,BEL,'*** Running Bios Cannot be Replaced ! ***',CR,LF
DEFB 0
JP EXIT
E$NOFIL: LD A,(CPMFCB+1)
CP ' '
JR NZ,EVALCMD
CALL VPRINT
DEFB ' *** No file specified ! ***',CR,LF,BEL
DEFB 0
;::::: EXIT PROGRAM
EXIT: CALL GETUD ; set previous drive/user
LD SP,(STACK) ; set stack to initial location
RET ; ..and return to system
;::::: EVALUATE COMMAND LINE
EVALCMD: LD DE,CPMFCB
LD HL,CPMDMA+1 ; set ptr to start of string
ECMD1: LD A,(HL) ; get char
INC HL ; move ptr fwd
CP ' ' ; is it <SP> ?
JR Z,ECMD1 ; ..if so, loop get next char
DEC HL ; non-blank char found, move ptr back
XOR A ; and nullify A
CALL ZFNAME ; parse token into FCB
JP NZ,E$AMBIG ; filename must be unambiguous, jump if error
LD HL,9 ; move ptr to file type
ADD HL,DE
LD A,(HL) ; get char
CP ' ' ; is it <SP> ?
JR NZ,RDIMG ; ..if not, skip over
PUSH DE ; else, save regs
EX DE,HL ; swap regs
LD HL,FTYPE ; ptr to standard file type
LD BC,3 ; 3 chars
LDIR ; ... and copy
POP DE ; restore ptr to ZCPR3 FCB
;::::: READ IMAGE FILE
RDIMG: CALL Z3LOG ; log in drive/user
CALL F$OPEN ; attempt to open file
OR A
JP NZ,E$OPEN ; ..if error, jump error and exit
CALL CODEND ; get first available page after code end
LD (WSPCBEG),HL ; ..and store it
RDIMG0: PUSH HL
CALL SETDMA ; set DMA buffer addr (HL)
LD DE,CPMFCB ; set standard FCB #1
CALL F$READ ; read one sector (128 bytes)
POP HL ; restore start addr
JR NZ,RDIMG1 ; ..if end of file, jump exit loop
LD DE,128 ; else, move buffer addr forward
ADD HL,DE
JR RDIMG0 ; ..and loop
RDIMG1: CALL GETUD ; set previously logged drive/user
CALL VPRINT
DEFB CR,LF,' CCP starts at : '
DEFB 0
;::::: READ IMAGE HEADER
; header contains information at following offsets:
; ZCPR CCP 0x10 (16) filename
; 0x1B (27) Unbanked base addr, 0x1D (29) Unbanked size
; 0x1F (31) Banked base addr, 0x22 (33) Banked size
; ZSDOS 0x30 (48) filename
; 0x3B (59) Unbanked base addr, 0x3D (61) Unbanked size
; 0x3F (63) Banked base addr, 0x41 (65) Banked size
; B/P Bios 0x50 (80) filename
; 0x5B (91) Unbanked base addr, 0x5D (93) Unbanked size
; 0x5F (95) Banked base addr, 0x62 (98) Banked size
; 0x70 (112) IMG filename
RDHDR: LD DE,27 ; offset CCP Unbanked base addr
CALL PSEGAS ; display addr and size of segment
LD DE,33 ; offset CCP Banked size
CALL GBYTEWS ; check if empty (0x0000)
JR Z,RDHDR0 ; ..if so, skip over
CALL VPRINT
DEFB ' Banked Ccp at : '
DEFB 0
LD DE,31 ; offset to CCP Banked base addr
CALL PSEGAS ; display addr and size
RDHDR0: CALL VPRINT
DEFB ' DOS starts at : '
DEFB 0
LD DE,59 ; offset to DOS Unbanked base addr
CALL PSEGAS ; display addr and size of segment
LD DE,65 ; offset to DOS Banked size
CALL GBYTEWS ; check if empty (0x0000)
JR Z,RDHDR1 ; ..if so, skip over
CALL VPRINT
DEFB ' Banked Dos at : '
DEFB 0
LD DE,63 ; offset to DOS Banked base addr
CALL PSEGAS ; display addr and size
RDHDR1: CALL VPRINT
DEFB ' BIOS starts at : '
DEFB 0
LD DE,91 ; offset to B/P Bios Unbanked base addr
CALL PSEGAS ; display addr and size of segment
LD DE,97 ; offset to B/P Bios Banked size
CALL GBYTEWS ; check if empty (0x0000)
JR Z,LDSEG ; ..if so, skip over
CALL VPRINT
DEFB ' Banked Bios at : '
DEFB 0
LD DE,95 ; offset to B/P Bios Banked base addr
CALL PSEGAS ; display addr and size
;::::: LOAD SYSTEM SEGMENTS
LDSEG: CALL VPRINT
DEFB CR,LF,' ...installing '
DEFB 0
CALL CHKBNKD ; check options flag if banked system
JR Z,LDSEG0 ; ..if not, skip over
CALL VPRINT
DEFB 'Banked '
DEFB 0
LDSEG0: CALL VPRINT
DEFB 'System',CR,LF,LF
DEFB 0
LDSEG1: DI ; disable interrupts
LD HL,(WSPCBEG) ; get addr WSPC area
LD DE,100H ; + 100H to account for file base
ADD HL,DE
; ZCPR Unbanked portion
LD (CCPUSTRT),HL ; store start in WSPC area
LD DE,27 ; file offset to ZCPR Unbanked base addr
CALL G2WRDWS
LD (CCPUSIZ),BC ; store size
LD (CCPUADR),DE ; store base addr
LD HL,(CCPUSTRT) ; get start in WSPC
PUSH HL
ADD HL,BC ; calc end / start of ZSDOS Unbanked portion
LD (DOSUSTRT),HL ; ..and store it
POP HL ; restore start
LDIR ; copy ZCPR Unbanked
; from img file to target addr
; ZCPR Banked portion
LD DE,31 ; offset to ZCPR Banked base addr
CALL G2WRDWS
LD (CCPBSIZ),BC ; store size
LD (CCPBADR),DE ; store base addr
LD HL,(DOSUSTRT) ; get previously calc'd end
LD (CCPBSTRT),HL ; ..and store it as Banked start in WSPC
LD A,B ; check if size is zero
OR C
JR Z,LDSEG2 ; ..if so, skip over
ADD HL,BC ; else, calc new start of ZSDOS Unbanked
LD (DOSUSTRT),HL ; ..and update it
; ZSDOS Unbanked portion
LDSEG2: LD DE,59 ; offset to ZSDOS Unbanked base addr
CALL G2WRDWS ; DE= base addr, BC= size
LD (DOSUSIZ),BC ; store size
LD HL,(DOSUSTRT) ; get ZSDOS Unbanked start in WSPC area
PUSH HL
ADD HL,BC ; calc end / start of B/P Bios Unbanked portion
LD (BIOUSTRT),HL ; ..and store it
POP HL ; restore start
LDIR ; copy ZSDOS Unbanked
; from img file to target addr
; ZSDOS Banked portion
LD DE,63 ; offset to ZSDOS Banked base addr
CALL G2WRDWS
LD (DOSBSIZ),BC ; store size
LD (DOSBADR),DE ; store base addr
LD HL,(BIOUSTRT) ; get previously calc'd end
LD (DOSBSTRT),HL ; ..and store it as Banked start in WSPC
LD A,B ; check if size is zero
OR C
JR Z,LDSEG3 ; ..if so, skip over
ADD HL,BC ; else, calc new start of B/P Bios Unbanked
LD (BIOUSTRT),HL ; ..and update it
; B/P Bios Unbanked portion
LDSEG3: LD DE,91 ; offset to B/P Bios Unbanked base addr
CALL G2WRDWS
LD (BIOUSIZ),BC ; store size
LD (BIOUADR),DE ; store base addr
LD HL,(BIOUSTRT) ; get start in WSPC area
PUSH HL
ADD HL,BC ; calc end / beginning of Banked portion
LD (BIOBSTRT),HL ; ..and store it
POP HL ; restore start
LDIR ; copy B/P Bios Unbanked
; from img file to target addr
; B/P Bios Banked portion
LD DE,95 ; offset to B/P Bios Banked base addr
CALL G2WRDWS
LD (BIOBSIZ),BC ; store size
LD (BIOBADR),DE ; store base addr
; use B/P Bios functions at new location (Unbanked portion was just loaded)
LD HL,(BIOUADR) ; get (new) B/P Bios base addr
LD L,82h ; offset to TPABNK in config area
LD A,(HL) ; get value
LD L,27*3 ; offset to B/P Bios fn #27 (SELMEM)
CALL JUMPHL ; "call" fn
LD HL,CCPBSIZ ; ptr to stored ZCPR Banked size
CALL LDBNKD
LD HL,DOSBSIZ ; ptr to stored ZSDOS Banked size
CALL LDBNKD
LD HL,BIOBSIZ ; ptr to stored B/P Bios Banked size
CALL LDBNKD
; Z3ENV Descriptor
LD BC,(WSPCBEG) ; get (new) B/P Bios base addr
LD HL,155 ; offset to addr of Z3 Environment Descriptor
ADD HL,BC ; in B/P Bios config area (CONFIG+26)
LD E,(HL) ; get addr in DE
INC HL
LD D,(HL)
LD HL,128 ; offset from start of WSPC area (img file)
ADD HL,BC
LD BC,128 ; bytes to copy
LDIR
; boot new system
LD SP,80H ; set stack pointer to default
XOR A ; nullify A
; ..and fall through, initiating a cold boot
;::::: SUPPORT FUNCTIONS
; call B/P Bios function (at new base addr in RAM)
; in: A= offset to JP (fn # *3)
BIOSFN: LD HL,(BIOUADR) ; get (new) B/P Bios base addr
LD L,A ; adjust to JP of fn #
; ..and fall through
; "called" as a pseudo-routine that returns to caller
; in: HL= target addr
JUMPHL: JP (HL) ; jump to addr in HL regs
; load banked portions of (new) system from WSPC area to SYSBNK
; segment information is stored as consecutive 16-bit words
; in the order <size> <base addr> <start addr in WSPC>
; in: HL= ptr to <size>
; uses B/P Bios functions at new location (Unbanked portion)
LDBNKD: LD C,(HL) ; get <size> low byte
LD A,C
INC HL ; move ptr fwd
LD B,(HL) ; get <size> high byte
INC HL ; ptr fwd
OR B ; check if <size> is zero
RET Z ; ..if so, return
PUSH BC ; save regs
PUSH HL
LD HL,(BIOUADR) ; get (new) B/P Bios base addr
LD L,82H ; offset to TPABNK in config area
LD C,(HL) ; get value
INC HL ; move ptr to SYSBNK
LD B,(HL) ; get value
LD A,29*3 ; offset to B/P Bios fn #29 (XMOVE)
CALL BIOSFN
POP DE ; restore regs, DE now ptr to <base addr>
POP BC
LD HL,(BIOUADR) ; get (new) B/P Bios base addr
LD L,25*3 ; offset to B/P Bios fn #25 (MOVE)
PUSH HL ; put on stack, so it is called at return
; and let Bios routine return to initial caller
EX DE,HL ; swap regs
LD E,(HL) ; get <base addr> in DE
INC HL
LD D,(HL)
INC HL
LD A,(HL)
INC HL
LD H,(HL) ; get <start addr in WSPC> in HL
LD L,A
RET ; ..and call B/P Bios fn #25 (MOVE)
; to copy banked segment to SYSBNK
; get _two_ consecutive 16-bit words from offset addr in WSPC area
; in: DE= offset
; out: DE= first value (at addr)
; BC= second value (at addr+2)
; HL= ptr to high byte of second value in WSPC area
; uses BC, DE, HL
G2WRDWS: CALL G1WRDWS ; get first word in HL
EX DE,HL ; swap regs
INC HL ; move ptr fwd
LD C,(HL) ; get second word in BC
INC HL
LD B,(HL)
RET
; print base addr and size of system segment ton CON:
; in: DE= offset in WSPC area
PSEGAS: CALL G1WRDWS ; get 16-bit word (in HL) at offset (in DE)
CALL PHL4HC ; ..and print to CON: as hex digits
EX DE,HL ; swap regs
INC HL ; move ptr fwd
LD E,(HL) ; get next 16-bit word in DE
INC HL
LD D,(HL)
CALL VPRINT
DEFB ' ('
DEFB 0
EX DE,HL ; swap regs
CALL PHL4HC ; print value (now in HL) to CON: as hex digits
CALL VPRINT
DEFB 'H Bytes)',CR,LF
DEFB 0
RET
; get _one_ 16-bit word from offset addr in WSPC area
; in: DE= offset
; out: HL= value
; DE= ptr to high byte in WSPC area
G1WRDWS: LD HL,(WSPCBEG) ; addr WSPC area
ADD HL,DE ; add offset
LD E,(HL) ; get low byte at ptr addr in E
INC HL
LD D,(HL) ; get high byte at ptr addr in D
EX DE,HL ; swap regs
RET
; get byte from offset addr in WSPC area
; in: DE= offset
; out: A= value, Z-Flag set if following byte is eqal
; HL= ptr to next byte in WSPC area
GBYTEWS: LD HL,(WSPCBEG) ; addr WSPC area
ADD HL,DE ; add offset
LD A,(HL) ; get byte
INC HL ; move ptr fwd
OR (HL) ; check if next byte has same value
RET
; check if img file contains a banked system
; in: -
; out: Z-Flag set for Unbanked Bios, NZ= Banked
CHKBNKD: LD HL,(WSPCBEG) ; addr WSPC area
INC H ; + 100H to account for file base
EX DE,HL ; swap regs, DE holds result over next calc's
LD BC,29 ; offset to ZCPR Unbanked size
CALL SEGTSIZ ; ..add ZCPR size(s) to DE
LD BC,61 ; offset to ZSDOS Unbanked size
CALL SEGTSIZ ; ..add ZSDOS size(s) to DE
LD HL,128 ; DE= offset to beginning of B/P Bios in
ADD HL,DE ; img file, move fwd by 128 more bytes
LD A,(HL) ; get B/P Bios options flag OPTF1 (at CONFIG+2)
AND 00000001b ; check bit 0, and set Z-Flag accordingly
RET
; get total size of a system segment (add Unbanked and Banked sizes)
; in: BC= offset in WSPC area to Unbanked size
; out: DE= sum of segment sizes
SEGTSIZ: LD HL,(WSPCBEG) ; addr WSPC area
ADD HL,BC ; add offset
LD C,(HL) ; get 16-bit word in BC
INC HL ; (Unbanked size)
LD B,(HL)
EX DE,HL ; swap regs
ADD HL,BC ; add retrieved value
EX DE,HL ; ..and swap regs back
INC HL ; move ptr 3 bytes fwd
INC HL
INC HL
LD C,(HL) ; get 16-bit value in BC
INC HL ; (Banked size)
LD B,(HL)
EX DE,HL ; swap regs
ADD HL,BC ; add retrieved value
EX DE,HL ; ..and swap regs back
RET
;::::: ERROR MESSAGES
E$AMBIG: CALL VPRINT
DEFB CR,LF,BEL,' --- Ambiguous File: '
DEFB 0
JR E$FNAME
E$OPEN: CALL VPRINT
DEFB CR,LF,BEL,' --- Error Opening: '
DEFB 0
E$FNAME: LD DE,CPMFCB+1 ; ptr to file name in standard FCB #1
CALL PFN3 ; print it
JP EXIT
;::::: HELP SCREEN
HELP: CALL VPRINT
DEFB CR,LF,1
DEFB 0
CALL PPRGNAM
CALL VPRINT
DEFB 2,' Loads and executes a System image prepared by',CR,LF
DEFB ' BPBUILD containing a B/P Bios.',CR,LF,LF
DEFB ' Syntax:',CR,LF
DEFB ' '
DEFB 0
CALL PPRGNAM
CALL VPRINT
DEFB ' // - print this message',CR,LF
DEFB ' '
DEFB 0
CALL PPRGNAM
CALL VPRINT
DEFB ' [du|dir:]name[.typ] - load system image',CR,LF,LF
DEFB ' File Type Defaults to "'
DEFB 0
LD HL,FTYPE ; ptr to default file type
LD B,3 ; # of chars
HELP0: LD A,(HL) ; get char
INC HL ; move ptr fwd
CALL COUT ; display char on CON:
DJNZ HELP0 ; ..and loop
CALL VPRINT
DEFB '" if not explicitly entered',CR,LF,LF
DEFB 'NOTE: This utility will NOT load a system '
DEFB 'if the "Lock" bit in',CR,LF
DEFB 'the Option Byte (Bit 7 of CONFIG+2) is Set to "1"',CR,LF
DEFB 0
JP EXIT
; print program name on CON: device
; (either the actual name, or fallback to default)
; only used by HELP
PPRGNAM: LD A,(ENVADR+1) ; get high byte of ENVPTR
OR A ; check if valid (<> zero)
JP NZ,PRTNAME ; ..if so, display actual name
; and let return from there
CALL VPRINT ; else, display default
DEFB 'LDSYS'
DEFB 0
RET
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
; VLIB - 0x06db
; Z3LIB - 0x08fc
; SYSLIB - 0x0bcf
; end addr 0x0bf8 (begin DSEG)
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
;::::: RAM STORAGE
DSEG
WSPCBEG: DEFW 0 ; begin of workspace
; (first available page, returned by CODEND)
; addresses of new system as extracted from img file
; first _Unbanked_, then _Banked_
BIOUADR: DEFW 0 ; B/P Bios Unbanked base addr
CCPUADR: DEFW 0 ; ZCPR Unbanked base addr
CCPUSTRT: DEFW 0 ; start in WSPC area
CCPUSIZ: DEFW 0 ; size
DOSUSTRT: DEFW 0 ; ZSDOS Unbanked start
DOSUSIZ: DEFW 0 ; size
BIOUSTRT: DEFW 0 ; B/P Bios Unbanked start
BIOUSIZ: DEFW 0 ; size
CCPBSIZ: DEFW 0 ; ZCPR Banked size
CCPBADR: DEFW 0 ; base addr
CCPBSTRT: DEFW 0 ; start
DOSBSIZ: DEFW 0 ; ZSDOS Banked size
DOSBADR: DEFW 0 ; base addr
DOSBSTRT: DEFW 0 ; start
BIOBSIZ: DEFW 0 ; B/P Bios Banked size
BIOBADR: DEFW 0 ; base addr
BIOBSTRT: DEFW 0 ; start
DEFW GZMTOP ; reference Z3LIB/SYSLIB routines, so they are linked
DEFW F$CLOSE
DEFW CRLF
DEFS 30H-6 ; room for stack
; -6 to account for above ref's
STACK: DEFW 0 ; stack storage location
END
;************************************************************************
; Remarks jxl:
; LDSYS.COM, included in available B/P Bios package(s), was dis-
; assembled and extensively commented. Labels are unique up to the seventh
; character to comply with M-REL standards. However, it is recommended to
; use SLR tools that support labels up to sixteen chars.
; In its current state, the compiled/linked file _almost_ matches the
; original LDSYS.COM with the exception of Z3LIB routine GZMTOP, and
; SYSLIB routines F$CLOSE and CRLF. Even though they are part of the
; original program, they are neither needed nor referenced. This seems
; to indicate that other versions of the LIB's were used. To reproduce
; the original program, the above mentioned routines are referenced (in
; stack area) to have them included when linking.
;
; As a byproduct of the disassembly, the structure of a B/P Bios image
; file was documented. This file contains an excerpt.
;************************************************************************

409
Source/BPBIOS/UTIL/showhd.z80

@ -0,0 +1,409 @@
TITLE "B/P Bios HD drive partition display"
;************************************************************************
;* S H O W H D *
;* Display DPH and DPB data for making B/P HD Partition data the same *
;* by Harold F. Bower and Cameron W. Cotrill *
;*----------------------------------------------------------------------*
;* Disassembly: jxl Jan 2025 *
;* public release 1.0 Apr 2025 *
;* see remarks at the end *
;*----------------------------------------------------------------------*
;* LINK with Version 4 libraries: SYSLIB *
;* *
;* A>Z80ASM SHOWHD/RS *
;* A>SLRNK SHOWHD/N,/A:100,/D:064D,SHOWHD,SYSLIBS/S,/E *
;************************************************************************
VER EQU 10
REV EQU ' '
DATE MACRO
DEFB '2 Nov 91'
ENDM
CTRLC EQU 03H ; Control-C character
BEL EQU 07H ; Bell character
TAB EQU 09H ; Tab character
LF EQU 0AH ; Line Feed character
CR EQU 0DH ; Carriage Return character
ESC EQU 1BH ; Escape character
CPMBIOS EQU 0 ; CP/M BIOS warm boot (JP)
CPMFCB EQU 5CH ; CP/M standard FCB #1 (+1 filename, +9 filetype)
; For SYSLIB make visible...
PUBLIC COUT
; From SYSLIB Get..
EXTRN EPRINT, BOUT, CAPINE, PAFDC, PHLFDC, PA2HC
;::::: PROGRAM START
ORG 100H
CSEG
SHOWHD: JP START ; bypass header
DEFB 'Z3ENV' ; this is (not really) a Z3CPR utility
DEFB 1 ; show external environment
ENVADR: DEFW 0 ; addr of Z3 environment
START: LD (STACK),SP
LD SP,STACK
CALL EPRINT
DEFB CR,LF,'Show Hard Drive Partition Data - '
DATE
DEFB CR,LF
DEFB 0
LD A,(CPMFCB+1) ; check first char of cmdline
CP '/' ; is this a help request ?
JP Z,HELP ; ..if so, jump
START0: CALL EPRINT
DEFB CR,LF,'Enter Drive Letter [A..P] : '
DEFB 0
CALL CAPINE ; get user input
CP CTRLC ; is it <Ctrl-C> ?
JP Z,0 ; ..abort
CP ESC ; is it <ESC> ?
JP Z,0 ; ..abort
CP 'A' ; below ascii 'A' ?
JR C,START0 ; ..if so, loop ask for new input
CP 'P'+1 ; greater than ascii 'P' ?
JR NC,START0 ; ..if so, loop ask for new input
LD (DRLTR),A ; store drive letter
CALL EPRINT
DEFB CR,LF,LF,'Drive: '
DEFB 0
CALL COUT ; display drive
CALL EPRINT
DEFB CR,LF,TAB,'DPH Info',TAB,TAB,'BPCNFG Info',CR,LF
DEFB 0
CALL GDPHADR ; get DPH addr for selected Disk drive
LD (DPHADR),HL ; ..and store it
LD A,H ; check if invalid (= zero)
OR L
JR NZ,PDSKDAT ; ..if not, skip over
CALL EPRINT
DEFB CR,LF,BEL,'+++ Invalid Drive : '
DEFB 0
LD A,(DRLTR) ; get drive letter
CALL COUT ; ..and display it
JP START0 ; then loop to ask for new input
;::::: DISPLAY DISK DRIVE DATA
PDSKDAT: LD DE,10 ; offset in DPH to DPB addr
ADD HL,DE
LD E,(HL) ; DPB addr in DE
INC HL
LD D,(HL)
EX DE,HL ; swap regs
LD (DPBADR),HL ; ..and store DPB addr
CALL EPRINT
DEFB CR,LF,LF,' Sectors/Track = '
DEFB 0
LD E,(HL) ; get Sect/Trk from DPB in DE
INC HL
LD D,(HL)
INC HL
EX DE,HL ; swap regs
CALL PHLFDC ; ..and display (as decimal)
SRL H ; divide by 2
RR L
SRL H ; .. /4
RR L
SRL H ; .. /8
RR L
LD (KBTRK),HL ; store kByte/Trk
EX DE,HL ; swap regs
CALL P2TAB
CALL EPRINT
DEFB '(same)',CR,LF,' Blk Shift Fctr = '
DEFB 0
LD A,(HL) ; get next byte from DPB (= BSH, Block Shift Factor)
INC HL ; move ptr fwd
CALL PAFDC ; display BSH
CALL P2TAB
SUB 3 ; BSH -3
LD B,A ; use as counter for multiplication
LD (BSH3),A ; ..and also store it
LD A,1 ; set initial value
JR Z,PBLKSIZ ; if BSH -3 = 0, skip over
BLKSZLP: ADD A,A ; *2
DJNZ BLKSZLP ; loop
PBLKSIZ: CALL PAFDC ; display block size
; (BSH= 3 -> 1k, 4 -> 2k, ... 8 -> 32k)
CALL EPRINT
DEFB 'k/Block',CR,LF,' Block Mask = '
DEFB 0
LD A,(HL) ; next byte from DPB (= BSM, Block Mask)
INC HL
CALL PAFDC ; ..display it
CALL EPRINT
DEFB CR,LF,' Extent Mask = '
DEFB 0
LD A,(HL) ; next byte from DPB (= EXM, Extent Mask)
INC HL
CALL PAFDC ; ..display it
CALL EPRINT
DEFB CR,LF,' Disk Blocks-1 = '
DEFB 0
LD E,(HL) ; next 16-bit value from DPB in DE
INC HL ; (= Disk Size in BLS units -1)
LD D,(HL)
INC HL
EX DE,HL ; swap regs
CALL PHLFDC ; display value
CALL P2TAB
INC HL ; +1 (= Disk Size)
LD A,(BSH3) ; get BSH-3
LD B,A ; set as initial loop counter
OR A ; check if zero (means single density 1k/block)
LD A,0 ; nullify A
JR Z,PDSKCAP ; ..if already zero, no more calc needed
DSKCLP: ADD HL,HL ; double HL (2, 4, 8 etc. k/block)
ADC A,0 ; a power-of-two multiple
DJNZ DSKCLP ; ..and loop
LD (DCAPH),A ; store disk capacity in kByte
LD (DCAPML),HL ; as 24-bit value
PDSKCAP: CALL PDSKSZ ; ..and display it
CALL EPRINT
DEFB 'k Total ('
DEFB 0
PUSH DE
LD DE,(KBTRK) ; kByte/Trk
LD HL,(DCAPML) ; disk capacity in kByte
LD A,(DCAPH)
LD BC,-1 ; set initial counter value
OR A
DSKTRLP: INC BC ; increase counter (quotient)
SBC HL,DE ; divide by subtraction
SBC A,0 ; check for underflow
JR NC,DSKTRLP ; ..and loop while more to go
LD H,B ; result in HL
LD L,C
CALL PHLFDC ; ..display it
CALL EPRINT
DEFB ' Tracks)'
DEFB 0
POP DE ; restore DPB ptr
EX DE,HL ; swap to HL
CALL EPRINT
DEFB CR,LF,' Max Dirs - 1 = '
DEFB 0
LD E,(HL) ; get next 16-bit value from DPB in DE
INC HL ; (= Dir Max -1)
LD D,(HL)
INC HL
EX DE,HL ; swap regs
CALL PHLFDC ; ..and display value
CALL P2TAB
INC HL ; +1 (= Dir Max)
CALL PHLFDC ; ..and display, too
EX DE,HL
CALL EPRINT
DEFB ' Dir Entries',CR,LF,' Alloc bytes = '
DEFB 0
LD A,(HL) ; next byte from DPB (= AL0, Allocation byte 0)
INC HL
LD D,(HL) ; (= AL1, Allocation byte 1)
INC HL
CALL PA2HC ; display AL0 as hex
CALL EPRINT
DEFB 'H, '
DEFB 0
LD A,D ; AL1 in A
CALL PA2HC ; ..and display as hex
CALL EPRINT
DEFB 'H',CR,LF,' Check Size = '
DEFB 0
LD E,(HL) ; next 16-bit value from DPB in DE
INC HL ; (= CKS, Check Size)
LD D,(HL)
INC HL
EX DE,HL ; swap regs
CALL PHLFDC ; display value
EX DE,HL ; swap regs back
CALL EPRINT
DEFB CR,LF,' Track Offset = '
DEFB 0
LD E,(HL) ; next 16-bit value from DPB in DE
INC HL ; (= Track Offset)
LD D,(HL)
INC HL
EX DE,HL ; swap regs
CALL PHLFDC ; display value
EX DE,HL ; swap regs back
CALL P2TAB
CALL EPRINT
DEFB '(same)',CR,LF
DEFB 0
JP 0 ; and exit with Warm Boot
; print 2 tabs on CON:
P2TAB: PUSH AF
LD A,TAB ; <TAB> in A
CALL COUT ; display on CON:
CALL COUT ; 2x
POP AF ; restore
RET
;::::: HELP
HELP
CALL EPRINT
DEFB CR,LF,'SHOWHD - Display DPH and DPB data for '
DEFB 'specified drive for making B/P',CR,LF
DEFB ' Hard Drive Partition data the same as '
DEFB 'an operating system.',CR,LF,LF
DEFB ' Syntax:',CR,LF,LF
DEFB TAB,'SHOWHD <-- Execute program interactively',CR,LF
DEFB TAB,'SHOWHD // <-- Display this message',CR,LF
DEFB 0
LD SP,(STACK)
RET
;::::: SUPPORT FUNCTIONS
; get addr of Disk Parameter Header (DPH)
; in: Disk drive letter in mem variable
; out: HL= addr DPH
GDPHADR: LD HL,(CPMBIOS+1) ; addr Bios fn #1 (WBOOT)
LD L,9*3 ; adjust ptr to fn #9 (SELDSK)
LD A,(DRLTR) ; get drive letter
SUB 'A' ; ..and convert to number
LD C,A ; copy to reg. C (for Bios call)
LD E,0
JP (HL) ; "call" Bios fn #9 and let return from there
; (SELDSK returns DPH addr in HL)
; print disk size to CON: (capacity of a drive in kB)
; output as decimal with provision for 3-byte values - see ZXD21.Z80 PRBIG
; in: 24-bit value to print in A,H,L
PDSKSZ: PUSH DE ; save regs
PUSH BC
EX AF,AF' ; swap AF
PUSH AF ; save it
EX AF,AF' ; ..and swap back
LD B,0
LD C,-1 ; set initial result
LD DE,86A0H ; 100,000 = 0x0186A0, set lower 2 bytes
OR A ; clear C-Flag
PDSKSZ0: INC C ; accumulate count
SBC HL,DE ; subtract lower 2 bytes
SBC A,1 ; ..and upper byte
JR NC,PDSKSZ0 ; loop till done
ADD HL,DE ; adjust underflow
ADC A,1
CALL PHLD1
LD DE,10000 ; print 10000's
CALL PHLD
LD DE,1000 ; print 1000's
CALL PHLD
LD DE,100 ; print 100's
CALL PHLD
LD DE,10 ; print 10's
CALL PHLD
LD A,L ; print 1's
CALL PHLD2
POP AF ; restore regs
EX AF,AF' ; swap
POP BC ; ..and also restore other regs
POP DE
RET
; print content of HL to CON: as decimal
; divide HL by DE, convert remainder to ascii digit and print it
; (similar to SYSLIB's PHLFDC/PHDC1 - see ZXD21.Z80 DECDSP)
; in: HL= value, DE= divisor
PHLD: LD C,-1 ; set initial count
OR A ; clear C-Flag
PHLD0: INC C ; accumulate count
SBC HL,DE ; divide by subtraction
SBC A,0
JR NC,PHLD0 ; ..and loop while more to go
ADD HL,DE ; compensate underflow
ADC A,0
PHLD1: EX AF,AF' ; swap to retain flags
LD A,C ; get result (quotient)
OR A ; is it zero ?
JR NZ,PHLD2 ; ..if not, skip over
OR B ; get prior digit print flag
JR Z,PHLD3 ; ..if anything printed yet, jump
XOR A ; else, print a zero
PHLD2: ADD A,'0' ; convert to ascii
LD B,A ; remember for next loop
CALL COUT ; ..and display it
PHLD3: EX AF,AF' ; swap regs back
RET
; intercept COUT to re-route SYSLIB calls to to BOUT
; --> declare COUT as PUBLIC, and do _not_ import from SYSLIB
COUT: JP BOUT
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
; SYSLIB - 0x0530
; end addr 0x064d (begin DSEG)
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
;::::: RAM STORAGE
DSEG
KBTRK: DEFW 0 ; kByte/Trk (Sect/Trk divided by 8)
BSH3: DEFB 0 ; BSH -3 (Block Shift Factor -3)
; disk capacity as 24-bit value
DCAPH: DEFB 0 ; high byte
DCAPML: DEFW 0 ; middle and low byte
DRLTR: DEFB 0 ; drive letter (entered by user)
DPHADR: DEFW 0 ; addr DPH (not used)
DPBADR: DEFW 0 ; addr DPB (not used)
DEFS 30H ; room for stack
STACK: DEFW 0 ; stack storage location
END
;************************************************************************
; Remarks jxl:
; SHOWHD.COM, included in available B/P Bios package(s), was dis-
; assembled and extensively commented. Labels are up to seven chars long
; to comply with M-REL standards. However, it is recommended to use SLR
; tools that support labels up to sixteen chars.
; In its current state, the compiled/linked file matches exactly the
; original SHOWHD.COM, i.e. no changes to the source were made.
;
; The program is not very complex. However, one thing might be worth
; to be pointed out: SYSLIB's routine COUT is replaced with an own
; implementation. While it is just a re-routing to another SYSLIB routine,
; it shows how simply this can be achieved. Bear in mind that _all_
; SYSLIB routines calling COUT would now call the local implementation
; instead. With this technique existing routines can be modified without
; rewriting them entirely.
;************************************************************************

546
Source/BPBIOS/UTIL/sizeram.z80

@ -0,0 +1,546 @@
TITLE "B/P Bios RAM size display"
;************************************************************************
;* S I Z E R A M *
;* Determine size and location of (banked) Memory *
;* by Harold F. Bower and Cameron W. Cotrill *
;*----------------------------------------------------------------------*
;* Disassembly: jxl Dec 2024 *
;* public release 1.0 Apr 2025 *
;* see remarks at the end *
;*----------------------------------------------------------------------*
;* LINK with Version 4 libraries: VLIB, Z3LIB, SYSLIB *
;* *
;* A>Z80ASM SIZERAM/RS *
;* A>SLRNK SIZERAM/N,/A:100,/D:0750,SIZERAM,VLIBS/S,Z3LIBS/S,SYSLIBS/S,/E *
;************************************************************************
VER EQU 12
REV EQU ' '
DATE MACRO
DEFB '30 Aug 01'
ENDM
BEL EQU 07H ; Bell character
LF EQU 0AH ; Line Feed character
CR EQU 0DH ; Carriage Return character
CPMBIOS EQU 0 ; CP/M BIOS warm boot (JP)
CPMBDOS EQU 5 ; CP/M BDOS entry point (JP)
CPMFCB EQU 5CH ; CP/M standard FCB #1 (+1 filename, +9 filetype)
; From Z3LIB Get..
EXTRN GETNAME, PRTNAME, Z3INIT, WHRENV
; From SYSLIB Get..
EXTRN EPRINT, CRLF, PAFDC, PHLFDC, COUT, CODEND
;::::: PROGRAM START
ORG 100H
CSEG
SIZERAM: JP START ; bypass header
DEFB 'Z3ENV' ; this is a ZCPR3 utility
DEFB 1 ; show external environment
ENVADR: DEFW 0 ; addr of Z3 environment
DEFW SIZERAM ; type 4 filler
DEFB 'SIZERAM ',0 ; configuration name
START: LD (STACK),SP
LD SP,STACK
CALL EPRINT
DEFB 'B/P Banked RAM Sizing Utility V',VER/10+'0','.'
DEFB VER MOD 10 + '0',REV,' '
DATE
DEFB CR,LF
DEFB 0
CALL CHKZ3E ; check if Z3 Environment is valid
CALL GETNAME ; get actual program name
CALL CHKHELP ; check cmdline for help request
CALL CHKSYS ; check if running under B/P Bios
CALL M$BVER ; display version # msg
LD HL,(BPCNFG) ; get addr of config area
INC HL ; move ptr fwd
INC HL
LD A,(HL) ; get OPTF1 (option flag at CONFIG+2)
AND 00000001b ; mask bit 0
LD (BPBNKD),A ; ..and store it
JP NZ,BNKDSYS ; if banked, jump to continue
;::::: NON-BANKED SYSTEM
NBNKSYS: INC HL ; move ptr to TPABNK in config area
INC HL
CALL EPRINT
DEFB CR,LF,LF,'Non-Banked System using TPA Banks = '
DEFB 0
LD A,(HL) ; get value
PUSH AF
CALL PAFDC ; ..and display
LD A,'/'
CALL COUT
POP AF ; restore value
INC A ; increase it
CALL PAFDC ; ..and display
CALL CRLF
JP EXIT
;::::: BANKED SYSTEM
BNKDSYS: INC HL ; move ptr to UABNK in config area
LD DE,UABNK ; ..and make local copies
LD BC,5 ; (5 bytes, UABNK..MAXBNK)
LDIR
CALL CODEND ; get first available page after code end
LD (WSPCBEG),HL ; and store it
EX DE,HL ; swap regs
; memory read/write tests for all ram banks at addr 0x0000
; building a map in WSPC area: b1= zero if no bank found, b2= initially read byte
; test #1: 0x00/0xFF byte - iterate over banks in forward order
LD HL,0 ; set addr 0x0000
LD C,0 ; start with bank #0 (TPA)
MEMRW: CALL GETFRB ; get byte
LD B,A ; store in B
CPL ; invert (complement) byte
CALL SETINB ; write it back
CALL GETFRB ; read again
CPL ; ..and invert
XOR B ; xor'd with initially read byte
JR NZ,MEMRW0 ; ..if no match, skip over
LD A,B ; get initially read byte
CALL SETINB ; write it
CALL GETFRB ; and read again
SUB B ; subtract initially read byte
JR NZ,MEMRW0 ; ..if not zero, skip over
; injected opcode 0xF6 (OR n) to skip following XOR A
DEFB 0F6h ; = OR 0AFH (write non-zero)
MEMRW0: XOR A ; nullify A
LD (DE),A ; store in WSPC area
INC DE ; move ptr fwd
LD A,B ; get initially read byte
LD (DE),A ; store it, too
INC DE ; move ptr fwd
INC C ; bank # +1
JR NZ,MEMRW ; ..loop till all possible (256 / 0x100) banks tested
; test #2: write no. in each bank (iterate backward), then read and compare (forward)
DEC C ; correct bank # (loop was 1 ahead)
MEMWRB: DEC DE ; move ptr back
DEC DE
LD A,(DE) ; get byte
OR A ; check if bank exists
JR Z,MEMWRB0 ; ..if not, skip over
LD A,C ; else, get bank #
CALL SETINB ; and write in bank
MEMWRB0: LD A,C ; get bank #
SUB 1 ; -1
LD C,A ; set bank #
JR NC,MEMWRB ; ..if not below zero, loop
INC C ; correct bank #
MEMRDB: LD A,(DE) ; get byte from WSPC area
OR A ; check if bank exists
JR Z,MEMRDB0 ; ..if not, skip over
CALL GETFRB ; read byte from bank
CP C ; compare to bank #
JR Z,MEMRDB0 ; ..if match, skip over
XOR A ; else, set <NUL> as indicator
LD (DE),A ; that bank doesn't exist
MEMRDB0: INC DE ; move ptr fwd
INC DE
INC C ; bank # +1
JR NZ,MEMRDB ; ..loop till all possible (256 / 0x100) banks tested
; restore bytes initially read in all banks
LD DE,(WSPCBEG) ; set ptr to start of WSPC addr
MEMRST: LD A,(DE) ; get byte
OR A ; check bank exists
JR Z,MEMRST0 ; ..if not, skip over
INC DE ; move ptr fwd
LD A,(DE) ; get initially read byte
CALL SETINB ; ..and restore it
INC DE ; ptr fwd
JR MEMRST1 ; skip over
MEMRST0: INC DE ; ptr fwd
INC DE
MEMRST1: INC C ; bank # +1
JR NZ,MEMRST ; loop till done
; ..then fall through to display collected data
; display information for Banked System
; detect ranges of continuous ram banks
;
; HL= ptr in WSPC area
; C= counter (up) bank #, B= counter (down) for outer loop
; D= bank # begin of range, E= bank # end of range
LD BC,0
LD HL,(WSPCBEG) ; set ptr to start of WSPC addr
BRANGLP: LD A,(HL) ; get byte
OR A ; check bank exists
JR NZ,BRANGE ; ..if so, skip over
INC HL ; else, use a shorter loop
INC HL ; ..move ptr fwd
INC C ; ..and bank #
JR NZ,BRANGLP ; loop until max. reached (256 / 0x100)
JR PCNFIG ; else, display Bios config report
BRANGE: LD D,C ; store start of range (bank # in D)
BRANG0: INC HL ; ptr fwd
INC HL
INC C ; bank # +1
JR NZ,BRANG1 ; ..if not max., skip over
DEC B
JR PBRANG ; else, display bank ranges
BRANG1: LD A,(HL) ; get byte
OR A ; check bank exists
JR NZ,BRANG0 ; ..if so, loop
; else, fall through
; display collected information
PBRANG: LD E,C ; get current bank # in E
DEC E ; loop is ahead, so -1
CALL EPRINT
DEFB CR,LF,'RAM Banks '
DEFB 0
LD A,D ; get begin of range
CALL PAFDC ; ..and display it
CALL EPRINT
DEFB ' - '
DEFB 0
LD A,E ; get end of range
CALL PAFDC ; ..and display it
CALL EPRINT
DEFB ' ('
DEFB 0
LD A,E ; get end of range
INC A ; adjust for correct calc
SUB D ; calc difference of begin/end
PUSH HL
LD L,A ; get value in L
LD H,0 ; ..and multiply for display
ADD HL,HL ; *2
ADD HL,HL ; *4
ADD HL,HL ; *8
ADD HL,HL ; *16
ADD HL,HL ; *32 (fixed bank size of 32k assumed)
CALL PHLFDC ; ..and display
POP HL
CALL EPRINT
DEFB 'k Bytes)'
DEFB 0
LD A,B ; check if more to go
OR A
JR Z,BRANGLP ; loop till done
; display information as stored in B/P Bios config area
PCNFIG: CALL EPRINT
DEFB CR,LF,LF,'Bios Reports:',CR,LF
DEFB ' TPA Banks = '
DEFB 0
LD A,(TPABNK) ; get TPA bank #
PUSH AF ; save regs
CALL PAFDC ; and display it
LD A,'/'
CALL COUT
POP AF ; restore value
INC A ; +1 (TPA bank is build by 2 consecutive banks)
; fixed size of 32k per bank is assumed
CALL PAFDC ; and display it
CALL EPRINT
DEFB CR,LF,' System Bank = '
DEFB 0
LD A,(SYSBNK) ; get SYSTEM bank #
CALL PAFDC ; and display it
CALL EPRINT
DEFB CR,LF,' User Bank = '
DEFB 0
LD A,(UABNK) ; get # of USER banks
OR A
JR NZ,PCNFIG0 ; ..if not zero, skip over
CALL EPRINT
DEFB '(None)'
DEFB 0
JR PCNFIG1
PCNFIG0: CALL PAFDC ; display # of USER banks
PCNFIG1: CALL EPRINT
DEFB CR,LF,' RAM Disk Start = '
DEFB 0
LD A,(RAMBNK) ; get # of begin RAM Disk
CALL PAFDC
CALL EPRINT
DEFB CR,LF,' Last Used Bank = '
DEFB 0
LD A,(MAXBNK) ; get max. available bank #
CALL PAFDC
CALL EPRINT
DEFB CR,LF,LF,' -- Scan Complete.',CR,LF
DEFB 0
JP EXIT
;::::: SUPPORT FUNCTIONS
; get first token from command line (in FCB #1)
; and check if help was requested
CHKHELP: LD HL,CPMFCB+1
LD A,(HL) ; get byte
CP '/' ; is this a help request ?
RET NZ ; ..if not, return
INC HL ; else, move ptr fwd
LD A,(HL) ; and get next byte
CP '/' ; is it also '/' ?
RET NZ ; ..if not, return
; else, fall through and display help
;::::: HELP SCREEN
HELP: CALL EPRINT
DEFB CR,LF,' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' Determines location and Size of Banked Memory.',CR,LF
DEFB ' (Only TPA Banks printed if Non-Banked)',CR,LF,LF
DEFB ' Syntax:',CR,LF
DEFB ' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' - Print 32k RAM banks present and B/P Allocations',CR,LF
DEFB ' '
DEFB 0
CALL PPRGNAM
CALL EPRINT
DEFB ' // - display this screen',CR,LF
DEFB 0 ; fall through and exit
;::::: EXIT PROGRAM
EXIT: CALL CRLF
LD SP,(STACK) ; restore stack pointer
RET ; ..and return to system
;::::: SUPPORT FUNCTIONS
; check if running under ZCPR3 and status of wheel byte
; terminate program if not succesful
CHKZ3E: LD HL,(CPMBDOS+1)
CALL WHRENV ; find Z3 Environment Descriptor
LD (ENVADR),HL ; store ENV ptr
LD A,H ; check if invalid (= zero)
OR L
JP Z,E$BPBIO ; ..if so, jump error and terminate
CALL Z3INIT ; else, init for Z3LIB routines
LD A,41 ; offset to addr of wheel byte (Z3WHL)
CALL ADDHLA ; adjust ptr
LD E,(HL) ; get addr in DE
INC HL
LD D,(HL)
EX DE,HL ; swap regs
LD A,(HL) ; get value of wheel byte
AND A ; check if zero
RET NZ ; ..if not (wheel on), return
CALL EPRINT ; else, display message and exit
DEFB BEL,CR,LF,'Must be wheel to Execute !',CR,LF
DEFB 0
JR EXIT
; check if running under B/P Bios
; if not, program is terminated
CHKSYS: LD HL,(CPMBIOS+1) ; get warm boot addr (BIOS fn #1)
LD L,30*3 ; adjust ptr to fn #30
LD A,(HL) ; check byte at ptr location
CP 0C3H ; is it opcode 0xC3 (JP) ?
JR NZ,E$BPBIO ; ..if not, jump error and terminate
CALL JUMPHL ; else, "call" B/P Bios fn #30 (RETBIO)
LD (BPVERS),A ; store version of B/P Bios
LD (BPADDR),BC ; " base addr
LD (BPCNFG),DE ; " config area addr
LD HL,-6 ; move ptr 6 bytes backward
ADD HL,DE ; (signature string)
LD A,(HL) ; get byte
CP 'B' ; is it 'B' ?
JR NZ,E$BPBIO ; ..if not, jump error and exit
INC HL ; ptr fwd
LD A,(HL) ; get byte
CP '/' ; is it '/' ?
JR NZ,E$BPBIO ; ..if not, jump error and exit
INC HL ; ptr fwd
LD A,(HL) ; get byte
CP 'P' ; is it 'P' ?
RET Z ; ..if so, return
; else, fall through (error and exit)
; msg aborting
E$BPBIO: CALL EPRINT
DEFB CR,LF,BEL,'Not B/P Bios, aborting...!',CR,LF
DEFB 0
RST 0
; print program name on CON: device
; (either the actual name, or fallback to default)
; only used by HELP
PPRGNAM: LD A,(ENVADR+1) ; get high byte of ENVPTR
OR A ; check if valid (<> zero)
JP NZ,PRTNAME ; ..if so, display actual name
; ..and let return from there
CALL EPRINT ; else, display default
DEFB 'SIZERAM'
DEFB 0
RET
; msg B/P Bios Vers x.x
M$BVER: CALL EPRINT
DEFB ' (B/P Bios Vers '
DEFB 0
LD A,(BPVERS) ; get version #
RRCA ; reverse nybbles in A
RRCA
RRCA
RRCA
AND 00001111b ; mask lower nybble
ADD A,'0' ; make it ascii
CALL COUT ; ..and display
LD A,'.'
CALL COUT
LD A,(BPVERS) ; get version #
AND 00001111b ; mask lower nybble
ADD A,'0' ; make it ascii
CALL COUT ; ..and display
CALL EPRINT
DEFB ')',CR,LF
DEFB 0
RET
; add A to HL (result in HL)
ADDHLA: ADD A,L ; add L
LD L,A ; store result in L
RET NC ; ..if no overflow, return
INC H ; else, increment H
RET
; the following routines rearrange Top of Stack by injecting an
; intermediate return addr, and putting the Bios fn call on top
; so that HL regs are preserved
; order of steps:
; [1] HL (= addr) is pushed onto stack
; [2] intermediate return addr is swapped to Top of Stack
; [3] HL (= addr) is pushed onto stack again
; [4] Bios fn JP addr is swapped to Top of Stack
; [5] Bios is "called" through RET, and returns to intermediate addr
; get byte from ram bank - in the form LD A,(HL)
; in: C= bank #, HL= addr
; out: A= byte
GETFRB: PUSH BC
PUSH HL ; save addr
LD HL,GETFRB0 ; load return addr
EX (SP),HL ; put it on stack
PUSH HL ; save HL again (previous top of stack)
LD HL,(BPADDR) ; get B/P Bios base addr
LD L,35*3 ; adjust ptr to fn #35 (FRGETB)
EX (SP),HL ; put addr on stack
RET ; ..and "call" Bios fn through stack
GETFRB0: POP BC ; restore regs
RET ; ..and finally return
; set byte in ram bank - in the form LD (HL),A
; in: C= bank #, HL= addr, A= byte to set
SETINB: PUSH BC
PUSH HL ; save addr
LD HL,GETFRB0 ; load return addr
EX (SP),HL ; put it on stack
PUSH HL ; save HL again (previous top of stack)
LD HL,(BPADDR) ; get B/P Bios base addr
LD L,37*3 ; adjust ptr to fn #37 (FRPUTB)
EX (SP),HL ; put addr on stack
RET ; ..and "call" Bios fn through stack
; "called" as a pseudo-routine that returns to caller
; in: HL= target addr
JUMPHL: JP (HL) ; jump to addr in HL regs
;::::: LOCAL DATA (not in DSEG)
WSPCBEG: DEFW 0 ; addr begin of workspace area
; (first available page, returned by CODEND)
; data retrieved from running system
BPVERS: DEFB 0 ; B/P Bios version
BPADDR: DEFW 0 ; B/P Bios base addr
BPCNFG: DEFW 0 ; addr of Config Area
BPBNKD: DEFB 0 ; indicator banked system (bit 0 of OPTF1) --> not used
; local copies of RAM bank configuration
UABNK: DEFB 0 ; beginning of User Bank(s)
TPABNK: DEFB 0 ; TPA Bank
SYSBNK: DEFB 0 ; beginning of System Bank(s)
RAMBNK: DEFB 0 ; base bank # for Ram Disk
MAXBNK: DEFB 0 ; highest permissible Bank #
DEFS 30H ; room for stack
STACK: DEFW 0 ; stack storage location
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
; Z3LIB - 0x05ae
; SYSLIB - 0x065c
; end addr 0x0750 (begin DSEG)
;:::::::::::::::::::::::::::::::::::::::::::::::::::::
;::::: RAM STORAGE
DSEG
END
;************************************************************************
; Remarks jxl:
; SIZERAM.COM, included in available B/P Bios package(s), was dis-
; assembled and extensively commented. Labels are up to seven chars long
; to comply with M-REL standards. However, it is recommended to use SLR
; tools that support labels up to sixteen chars.
; In its current state, the compiled/linked file matches exactly the
; original INITRAM.COM, i.e. no changes to the source were made.
;
; The program uses an interesting technique to read and write data in
; alternative ram banks utilizing B/P Bios functions no. 35 FRGETB and
; no. 37 FRPUTB. Top of Stack is manipulated to keep registers intact
; and "call" functions through a RET statement (instead of CALL.)
; Another specialty which is worth mentioning: Routine MEMRW (memory
; read/write) contains an "injected" opcode to alter the behaviour at
; runtime. Otherwise a more complex logic and/or additional routine
; would have been necessary.
; Storage of local data is in CSEG (code segment), not DSEG. There
; seems to be no particular reason for this. So, it can be assumed that
; this just happened by mistake.
;************************************************************************

1323
Source/BPBIOS/UTIL/zscfg2.z80

File diff suppressed because it is too large

1247
Source/BPBIOS/bpart.txt

File diff suppressed because it is too large

1
Source/Build.cmd

@ -4,7 +4,6 @@ setlocal
:: call BuildDoc || exit /b
call BuildProp || exit /b
call BuildShared || exit /b
call BuildBP || exit /b
call BuildImages || exit /b
call BuildROM %* || exit /b
call BuildZRC || exit /b

4
Source/BuildBP.cmd

@ -1,4 +0,0 @@
@echo off
setlocal
pushd BPBIOS && call Build || exit /b & popd

2
Source/BuildShared.cmd

@ -8,8 +8,10 @@ pushd QPM && call Build || exit /b & popd
pushd ZCPR && call Build || exit /b & popd
pushd ZCPR-DJ && call Build || exit /b & popd
pushd ZSDOS && call Build || exit /b & popd
pushd ZSDOS2 && call Build || exit /b & popd
pushd CPM3 && call Build || exit /b & popd
pushd ZPM3 && call Build || exit /b & popd
pushd BPBIOS && call Build || exit /b & popd
pushd CPNET && call Build || exit /b & popd
pushd pSys && call Build || exit /b & popd
pushd Apps && call Build || exit /b & popd

11
Source/CBIOS/cbios.asm

@ -3201,8 +3201,9 @@ MAKDPH0: ; HANDLE RAM/ROM
CP DIODEV_MD ; RAM/ROM DISK?
JR Z,MAKDPH0 ; HANDLE SPECIAL
LD DE,DPB_FD144 ; PRELOAD FLOPPY DPB
CP DIODEV_FD ; FLOPPY?
JR Z,MAKDPH1 ; IF SO, PROCEED TO DPH CREATION
;CP DIODEV_FD ; FLOPPY?
BIT 7,C ; FLOPPY?
JR NZ,MAKDPH1 ; IF SO, PROCEED TO DPH CREATION
LD DE,DPB_RF ; PRELOAD RAM FLOPPY DPB
CP DIODEV_RF ; RAM FLOPPY?
JR Z,MAKDPH1 ; IF SO, PROCEED TO DPH CREATION
@ -3381,7 +3382,7 @@ DEVUNK .DB "UNK$"
RST 08 ; CALL HBIOS
LD A,D ; RESULTANT DEVICE TYPE
PUSH DE ; NEED TO SAVE UNIT NUMBER (IN E)
AND $0F ; ISOLATE DEVICE BITS
AND $1F ; ISOLATE DEVICE BITS
ADD A,A ; MULTIPLY BY TWO FOR WORD TABLE
LD HL,DEVTBL ; POINT TO START OF DEVICE NAME TABLE
CALL ADDHLA ; ADD A TO HL TO POINT TO TABLE ENTRY
@ -3407,6 +3408,7 @@ DEVTBL: ; DEVICE TABLE
.DW DEV04, DEV05, DEV06, DEV07
.DW DEV08, DEV09, DEV10, DEV11
.DW DEV12, DEV13, DEV14, DEV15
.DW DEV16
;
DEVUNK .DB "???$"
DEV00 .DB "MD$"
@ -3424,7 +3426,8 @@ DEV11 .DB "IMM$"
DEV12 .DB "SYQ$"
DEV13 .DB "CHUSB$"
DEV14 .DB "CHSD$"
DEV15 .EQU DEVUNK
DEV15 .DB "USB$"
DEV16 .EQU DEVUNK
;
#ENDIF
;

23
Source/CPM22/ReadMe.txt

@ -38,7 +38,7 @@ It is an independent disassembly and reconstruction of CCP/BDOS.
DRI CPM22PAT01 was already applied. Unclear why, but the BDOS
source was checking for a blank instead of a ctrl-s in the
KBSTAT routine. Ctrl-s seems to be correct based on all other
BDOS images I have encountered. Also, these files imbed the
BDOS images I have encountered. Also, these files embed the
CP/M version number into the serial number fields. Other than
this, they are byte identical to the OS2CCP/OS3BDOS images above.
@ -51,17 +51,24 @@ BDOS22.ASM - Modified ORG & fix for ctrl-S
CCPB03 & BDOSB01
----------------
Sourced from N8VEM effort to create an enhanced
variant of CP/M 2.2.
These files were derived from a disassembly of the Jade DD CP/M-80
image by William Beech in 1982.
It appears to be a disassembly and reconstruction of CCP/BDOS,
but there are no comments attributing the work. DRI CPM22PAT01
was already applied. The message string literals are all
- Modified by Bill Beech for global CP/M size configuration
and separate CCP and BDOSE 2013.
- Modified by Bill Beech for addition of MON
command and display/change of user on command line
1984. Also removed all SN checks.
Eventually modified as part of the N8VEM project and converted to
the Z80 instruction set.
DRI CPM22PAT01 has been applied. The message string literals are all
in CAPS in BDOS. Additionally, there is explicit filler of 0x55
value bytes at the end of the CCP/BDOS files padding their
length out to full page. Other than this, the BDOS
is byte identical to the others above. CCP contains multiple
enhancements and is, therefore, not identical to others.
is byte identical to the others above.
CCPB03.ASM - Enhanced reassembly of CCP

1
Source/Clean.cmd

@ -8,6 +8,7 @@ pushd QPM && call Clean.cmd & popd
pushd ZCPR && call Clean.cmd & popd
pushd ZCPR-DJ && call Clean.cmd & popd
pushd ZSDOS && call Clean.cmd & popd
pushd ZSDOS2 && call Clean.cmd & popd
pushd CBIOS && call Clean.cmd & popd
pushd CPM3 && call Clean.cmd & popd
pushd ZPM3 && call Clean.cmd & popd

587
Source/Doc/Applications.md

@ -56,8 +56,22 @@ User Guide, and for the sake of completeness there is some overlap here.
When a RomWBW system is started the user is presented with a sign-on
message at the default console detailing the RomWBW version and build
date. The system follows this with the list of hardware that it has
discovered, a list of devices and the system units assigned to them,
before finally inviting the to select a boot device with the prompt:
discovered, a list of devices and the system units assigned to them.
If autoboot is configured then the message (below) will count down
and once 0 is reached the system will automatically boot with the configured
options
```
AutoBoot in 3 Seconds (<esc> aborts, <enter> now)...
```
Pressing `esc` - will bypass the auto boot process going immediately
to the `Boot` prompt, or pressing `enter` - will proceed with autoboot
immediately. Auto boot is configured using the `W` boot menu option.
If autoboot is bypassed (or not configured) the user is asked to
select a boot device with the prompt:
```
Boot [H=Help]:
@ -74,18 +88,23 @@ Furthermore, a ROM application may also be started from this prompt.
This start-up process is described in some detailed in the RomWBW User Guide,
and there is some overlap here.
## Help
#### Help
After pressing H or ? at the boot prompt the user will be presented with
the following list of available commands:
```
L - List ROM Applications
D - Device Inventory
R - Reboot System
I <u> [<c>] - Set Console Interface/Baud code
V [<n>] - View/Set HBIOS Diagnostic Verbosity
<u>[.<s>] - Boot Disk Unit/Slice
Boot [H=Help]: H
L - List ROM Applications
D - Device Inventory
S - Slice Inventory
R - Reboot System
W - RomWBW Configure
I <u> [<c>] - Set Console Interface/Baud code
V [<n>] - View/Set HBIOS Diagnostic Verbosity
N - Network Boot
<u>[.<s>] - Boot Disk Unit/Slice
```
The function performed by each command is described below:
@ -102,24 +121,45 @@ D:
system was started.
S:
: Displays the list of disk Slices that contain a label indicating that
they may be bootable. See [SLABEL (Slice Label)] for more details about labels.
R:
: Will restart the system. Note that this does not reset hardware devices
in the same way that power-on or pressing the reset button would.
W:
: Runs the [SYSCONF (System Configuration)] utility allowing RomWBW
configuration stored in Non Volatile memory to be changed.
I:
: Allows the user to select the interface connected to the console, and
optionally the Baud rate. This could be used to allow the system to be
operated from a second console.
V:
: Enables the display of invalid RomWBW HBIOS API calls. This option
is very unlikely to be used by a user and is used for development
purposes.
N:
: Boot into CP/M via an RCBus Wiznet MT011 network module if configured.
Section 10 of the $doc_user$ provides complete instructions for setting
up a CP/NET based network under RomWBW including network booting.
And, finally, the system may be booted by specifying the unit number,
and optional slice, separated by a period('.'), of where the disk operating
system software is located - eg 2, 4.1, 5.3
@ -127,7 +167,7 @@ system software is located - eg 2, 4.1, 5.3
Alternatively, a RomWBW ROM application may be started by pressing the appropriate
key from the applications menu, shown in the following section.
## List ROM Applications
#### List ROM Applications
If the user presses the L key at the Boot Loader prompt then the system will
display the list of ROM applications that are built into RomWBW. If a command
@ -137,16 +177,19 @@ first displaying the menu.
The ROM applications available from the boot prompt are:
```
M: Monitor
C: CP/M 2.2
Z: Z-System
B: BASIC
T: Tasty BASIC
F: Forth
P: Play a Game
N: Network Boot
X: XModem Flash Updater
U: User App
Boot [H=Help]: L
ROM Applications:
M: Monitor
Z: Z-System
C: CP/M 2.2
F: Forth
B: BASIC
T: Tasty BASIC
P: Play a Game
X: XModem Flash Updater
U: User App
```
Each of these will now be described in greater detail.
@ -168,11 +211,11 @@ language and there is no ability to save to persistent storage (disks).
The available memory area for programming is `0100h-EDFFh`.
The following areas are reserved:
Memory Area | Function
------------|-----------------------------------
`0000-00FFh`| Jump and restart (RST) vectors
`EE00-FDFFh`| Monitor
`FE00-FFFFh`| HBIOS proxy
| Memory Area | Function |
|----------------|---------------------------------|
| `0000-00FFh` | Jump and restart (RST) vectors |
| `EE00-FDFFh` | Monitor |
| `FE00-FFFFh` | HBIOS proxy |
The monitor uses a prompt in the format of `xx>` where xx is the
RomWBW bank id number. For example, the prompt may look like this
@ -198,7 +241,7 @@ allow selecting alternate banks.
There now follows a more detailed guide to using the RomWBW
Monitor program:
### Command Summary
### Monitor Commands
**`?`** - Will display a summary of the available commands.
@ -222,13 +265,13 @@ T xxxx - X-modem transfer to memory location xxxx
X - Exit monitor
```
### Cold Boot
#### Cold Boot
**`B`** - Performs a cold boot of the RomWBW system. A complete
re-initialization of the system is performed and the system
returns to the Boot Loader prompt.
### Dump Memory
#### Dump Memory
**`D xxxx [yyyy]`** - Dump memory from hex location xxxx to yyyy
on the screen as lines of 16 hexadecimal bytes with their
@ -261,7 +304,7 @@ Example: `D 100 1FF`
01F0: 01 C5 01 F0 F8 CF E5 26 00 0E 0A CD 39 02 7D 3C .Å.ðøÏå&...Í9.}<
```
### Fill Memory
#### Fill Memory
**`F xxxx yyyy zz`** - Fill memory from hex xxxx to yyyy with
a single value of zz over the full range. The Dump command
@ -269,7 +312,7 @@ can be used to confirm that the fill completed as expected. A
good way to zero out memory areas before writing machine data
for debug purposes.
### Halt System
#### Halt System
**`H`** - Halt system. A Z80 HALT instruction is executed. The
system remains in the halt state until the system is
@ -277,20 +320,20 @@ physically rebooted. Interrupts will not restart the
system. On systems that support a HALT status LED, the
LED will be illuminated.
### Input from Port
#### Input from Port
**`I xxxx`** - Input data from port xxxx and display to the screen.
This command is used to read values from hardware I/O ports
and display the contents in hexadecimal.
### Keyboard Echo
#### Keyboard Echo
**`K`** - Echo any key-presses from the terminal. Press 'ESC' key
to quit. This facility provides that any key stroke sent to
the computer will be echoed back to the terminal. File down
loads will be echoed as well while this facility is ‘on’.
### Load Hex
#### Load Hex
**`L`** - Load a Intel Hex data via the terminal program.
The load address is defined in the hex file of the
@ -304,21 +347,21 @@ Keep in mind that this will be transient unless the
system supports battery backed memory. Saving to memory drive
is not supported.
### Move Memory
#### Move Memory
**`M xxxx yyyy zzzz`** - Move hex memory block xxxx to yyyy to
memory starting at hex location zzzz. Care should be taken
to insure that there is enough memory at the destination so
that code does not get over-written or memory wrapped around.
### Output to Port
#### Output to Port
**`O xxxx yy`** - Output data byte xx to port xxxx. This command is
used to send hexadecimal values to hardware I/O ports to
verify their operation and is the companion to the I operation.
Use clip leaded LEDs to confirm the data written.
### Program Memory
#### Program Memory
**`P xxxx`** - Program memory location xxxx. This routine will
allow you to program a hexadecimal value 'into memory starting
@ -333,7 +376,7 @@ remote computer.
An excellent online resource for looking up opcodes for entry
can be found here: <https://clrhome.org/table>.
### Run Program
#### Run Program
**`R xxxx [[yy] [zzzz]]`** - Run program at location xxxx. If optional
arguments yy and zzzz are entered they are loaded into the
@ -342,7 +385,7 @@ Monitor is saved on the stack so the program can return
to the monitor. On return to the monitor, the contents of
the A, HL, DE and BC registers are displayed.
### Set Bank
#### Set Bank
**`S xx`** - Set the physical memory bank to the RomWBW Bank Id
indicated by xx. Memory addresses
@ -367,12 +410,12 @@ Section 4 of the $doc_sys$ provides detail on how Bank Ids map to the
physical memory of the system and also how specific banks are utilized
by RomWBW.
### Undo Bank
#### Undo Bank
**`U`** - Change the bank in memory back to the previously selected bank.
This command should be used in conjunction with the S command.
### X-Modem Transfer
#### X-Modem Transfer
**`T xxxx`** - Receive an X-modem file transfer and load it into
memory starting at location xxxx.
@ -380,116 +423,10 @@ memory starting at location xxxx.
128 byte blocks and checksum mode is the only supported
protocol.
### Exit Monitor
#### Exit Monitor
**`X`** - Exit the monitor program back to the main boot menu.
## RomWBW System Configuration
System Configuration (`SYSCONF`) is a utility that allows system configuration to
be set, dynamically and stored in NVRAM provided by an RTC chip.
(`SYSCONF`) is both a ROM application ('W' Menu option), and a CP/M utility.
Noting however the CP/M utility is not included on an disk image, it is found in
the `Binary/Applications` folder of the RomWBW distribution.
The $doc_user$ has additional information on the use of NVRAM to set your
system configuration.
### Basic Operation
The application is an interactive application; it does not have a command line syntax.
Instead commands are executed from within the application in a command line structure.
When you first start the (`SYSCONF`) utility it will display the current switches
followed by a command listing.
When you first run the (`SYSCONF`) utility the NVRAM will be uninitialised, and can
be initialised using the (R)eset command, which writes default values to NVRAM.
Updates are done immediately to NVRAM as you enter them, i.e. there is no confirm
changes step. If you make any incorrect changes, you simply need to enter a new
command to set the Switch value correctly.
Once a change has been made it is available, however it may not take effect until
the next system reboot. This is dependent on the Switch itself.
If no NVRAM is provided by your hardware, then running this application will just
report the missing hardware and exit immediately.
To exit from the application use the (Q)uit command.
### Commands and Syntax
The following are the accepted commands, unless otherwise specified a "Space"
character is used to delimit parameters in the command.
| Command | Argument(s) | Description |
|------------|------------------|-----------------------------------------------|
| (P)rint | -none- | Display a list of the current switch value(s) |
| (S)et | {SW} {val},... | Sets an Switch {SW} with specific values(s) |
| (R)eset | -none- | Reset all setting to default |
| (H)elp | {SW} | Provides help on the syntax (values) |
| (Q)uit | -none- | Exit the application |
**Where**
| Argument | Description |
|-----------|----------------------------------------------------------------------|
| {SW} | Switch ID, typically this is 2 character name to identify the switch |
| {val},... | a "Comma" separated list of values to set into the switch |
### Switch Options
#### Auto Boot (AB)
This switch will define if the system will perform auto boot at the RomWBW boot prompt.
Enabling this will not prevent a user from typing a boot command, so long as the timeout is not
exceeded. When configured this replaces the (`AUTO_CMD`) variable
defined in build configuration.
Making changes to auto boot has no affect until the next reboot.
**Arguments**
| Type | Arguments | Description |
|----------|------------|--------------------------------------------------------|
| Enable | 'E' | Auto Boot. eg. "E,10" will auto boot, after 10 seconds |
| | Timout | Timeout in seconds in the range 0-15, 0 = immediate |
| Disabled | 'D' | No Auto Boot. e.g. "D" will disable autoboot |
**Examples**
| Command | Description |
|-----------------------|---------------------------------------------------|
| S AB E,10 | Enable Auto Boot with 10 second delay |
| S AB D | Disable Auto Boot |
#### Boot Options (BO)
This switch will define the boot command to be executed when auto boot is
enabled. When configured this replaces the (`AUTO_CMD`) variable
defined in the ROM build configuration.
Making changes to boot options has no affect until the next reboot.
**Arguments**
| Type | Arguments | Description |
|------|------------------|----------------------------------------------------------|
| Disk | 'D' | Disk Boot. eg. "D,2,14" will boot, disk unit 2, slice 14 |
| | Disk Unit Number | Unit number in the range 0-127 |
| | Disk Slice | Slice in the range 0-255, use 0 for floppy boot |
| ROM | 'R' | ROM App. e.g. "R,M" will boot the Monitor App |
| | Rom App Name | single character used on the Menu to identify the app |
**Examples**
| Command | Description |
|-------------|----------------------------------------------------------|
| S BO D,2,14 | Set the default boot from Disk; Unit 2, Slice 14 |
| S BO R,M | Set the default boot to be the (M)onitor Rom Application |
## CP/M 2.2
This option will boot the CP/M 2.2 disk operating system
@ -624,15 +561,15 @@ above.
### Structure of Forth source files
File | Description
--------------|-----------------------------
camel80.azm | Code Primitives
camel80d.azm | CPU Dependencies
camel80h.azm | High Level words
camel80r.azm | RomWBW additions
glosshi.txt | Glossary of high level words
glosslo.txt | Glossary of low level words
glossr.txt | Glossary of RomWBW additions
| File | Description |
|--------------|------------------------------|
| camel80.azm | Code Primitives |
| camel80d.azm | CPU Dependencies |
| camel80h.azm | High Level words |
| camel80r.azm | RomWBW additions |
| glosshi.txt | Glossary of high level words |
| glosslo.txt | Glossary of low level words |
| glossr.txt | Glossary of RomWBW additions |
### RomWBW Additions
@ -648,19 +585,17 @@ Extensions and changes to this implementation compared to the original distribut
- James Bowman's double precision words have been added from his RC2014 version:
<https://github.com/jamesbowman/camelforth-z80>.
Word | Syntax | Description
--------|----------------------------|---------------------------------
D+ | d1 d2 -- d1+d2 | Add double numbers
2>R | d -- | 2 to R
2R> | d -- | fetch 2 from R
M*/ | d1 n2 u3 -- d=(d1*n2)/u3 | double precision mult. div
SVC | hl de bc n -- hl de bc af | Execute a RomWBW function
P! | n p -- | Write a byte to a I/O port
P@ | p -- n | Read a byte from and I/O port
## Play a Game
| Word | Syntax | Description |
|------|----------------------------|-------------------------------|
| D+ | d1 d2 -- d1+d2 | Add double numbers |
| 2>R | d -- | 2 to R |
| 2R> | d -- | fetch 2 from R |
| M*/ | d1 n2 u3 -- d=(d1*n2)/u3 | double precision mult. div |
| SVC | hl de bc n -- hl de bc af | Execute a RomWBW function |
| P! | n p -- | Write a byte to a I/O port |
| P@ | p -- n | Read a byte from and I/O port |
### 2048
## Play a Game (2048)
2048 is a puzzle game that can be both mindless and challenging. It
appears deceptively simple but failure can creep up on you suddenly.
@ -735,44 +670,40 @@ This is how I lost this game:
Press Q at any time to bring up the option to Quit or Restart the game.
## Network Boot
If your RomWBW system is equipped with an RCBus MT011 module, it is
possible to boot into CP/M 2.2 directly from a CP/NET network server.
This means that the operating system will be loaded directly from the
network server and all of your drive letters will be provided by the
network server.
This function requires substantial knowledge of CP/NET and it's
implementation within RomWBW. Section 10 of the $doc_user$ provides
complete instructions for setting up a CP/NET based network under RomWBW
including a section on network booting.
## Xmodem Flash Updater
The RomWBW Xmodem flash updater provides the capability to update RomWBW from the boot loader using an x-modem file transfer. It offers similar capabilities to Will Sowerbutts FLASH4 utility except that the flashing process occurs during the file transfer.
The RomWBW Xmodem flash updater provides the capability to update RomWBW
from the boot loader using an x-modem file transfer. It offers similar
capabilities to Will Sowerbutts FLASH4 utility except that the flashing
process occurs during the file transfer.
These are the key differences between the two methods are:
Xmodem Flash Updater | FLASH.COM (aka FLASH4)
--------------------------------|-----------------
Available from the boot loader | Well proven and tested
Xmodem transfer is integrated | Wider range of supported chips and hardware
Integrated checksum utilities | Wider range of supported platforms
Capability to copy a ROM image | Only reprograms sectors that have changed
More convenient one step process | Ability save and verify ROM images
No intermediate storage required | Progress display while flashing
. | Displays chip identification information
. | Faster file transfer
The major disadvantages of the Updater is that it is new and relatively untested. There is the risk that a failed transfer will result in a partially flashed and unbootable ROM. There are some limitations on serial transfer speeds.
The updater utility was initially intended to support the Retrobrew SBC-V2-005 platform using Atmel 39SF040 flash chips but has now been extended to be more generic in operation.
| Xmodem Flash Updater | FLASH.COM (aka FLASH4) |
|----------------------------------|----------------------------------------------|
| Available from the boot loader | Well proven and tested |
| Xmodem transfer is integrated | Wider range of supported chips and hardware |
| Integrated checksum utilities | Wider range of supported platforms |
| Capability to copy a ROM image | Only reprograms sectors that have changed |
| More convenient one step process | Ability save and verify ROM images |
| No intermediate storage required | Progress display while flashing |
| . | Displays chip identification information |
| . | Faster file transfer |
The major disadvantages of the Updater is that it is new and relatively
untested. There is the risk that a failed transfer will result in a
partially flashed and unbootable ROM. There are some limitations on
serial transfer speeds.
The updater utility was initially intended to support the Retrobrew SBC-V2-005
platform using Atmel 39SF040 flash chips but has now been extended to be
more generic in operation.
Supported flash chips are
39SF040, 29F040, AT49F040, AT29C040, M29F040 , MX29F040, A29010B, A29040B
The Atmel 39SF040 chip is recommended as it can erase and write 4Kb sectors. Other chips require the whole chip to be erased.
The Atmel 39SF040 chip is recommended as it can erase and write 4Kb sectors.
Other chips require the whole chip to be erased.
### Usage
@ -784,24 +715,40 @@ In most cases, completing a ROM update is a simple as:
4. Initiating an X-modem transfer of your ROM image on your console device
5. Selecting option R - Reboot
If your console device is not able to transfer a ROM image i.e. your console is a VDU then you will have to use the console options to identify which character-input/output device is to be used as the serial device for transfer.
If your console device is not able to transfer a ROM image i.e. your console
is a VDU then you will have to use the console options to identify which
character-input/output device is to be used as the serial device for transfer.
When your console is the serial device used for the transfer, no progress information is displayed as this would disrupt the x-modem file transfer. If you use an alternate character-input/output devices as the serial device for the transfer then progress information will be displayed on the console device.
When your console is the serial device used for the transfer, no progress
information is displayed as this would disrupt the x-modem file transfer.
If you use an alternate character-input/output devices as the serial device
for the transfer then progress information will be displayed on the console device.
Due to different platform processor speeds, serials speeds and flow control capabilities the default console or serial device speed may need to be reduced for a successful transfer and flash to occur. The **Set Console Interface/Baud code** option at the Boot Loader can be used to change the speed if required. Additionally, the Updater has options to set to and revert from a recommended speed.
Due to different platform processor speeds, serials speeds and flow
control capabilities the default console or serial device speed may
need to be reduced for a successful transfer and flash to occur.
The **Set Console Interface/Baud code** option at the Boot Loader can
be used to change the speed if required. Additionally, the Updater has
options to set to and revert from a recommended speed.
See the RomWBW Applications guide for additional information on performing upgrades.
### Console Options
Option ( C ) - Set Console Device
Option ( S ) - Set Serial Device
By default the updater assumes that the current console is a serial device and that the ROM file to be flashed will also be transferred across this device, so the Console and Serial device are both the same.
By default the updater assumes that the current console is a serial device
and that the ROM file to be flashed will also be transferred across this
device, so the Console and Serial device are both the same.
Either device can be can be change to another character-input/output device but the updater will always expect to receive the x-modem transfer on the **Serial Device**
Either device can be can be change to another character-input/output
device but the updater will always expect to receive the x-modem
transfer on the **Serial Device**
The advantage of transferring on a different device to the console is that progress information can be displayed during the transfer.
The advantage of transferring on a different device to the console
is that progress information can be displayed during the transfer.
Option ( > ) - Set Recommended Baud Rate
@ -870,21 +817,32 @@ load CP/M and perform the normal x-modem / flash process to recover.
Option ( 1 ) and ( 2 ) - Calculate and display CRC32 of 1st or 2nd 512k ROM.
Option ( 3 ) - Calculate and display CRC32 of a 1024k (2x512Kb) ROM.
Can be used to verify if a ROM image has been transferred and flashed correctly. Refer to the Tera Term section below for details on configuring the automatic display of a files CRC after it has been transferred.
Can be used to verify if a ROM image has been transferred and flashed
correctly. Refer to the Tera Term section below for details on
configuring the automatic display of a files CRC after it has been
transferred.
In Windows, right clicking on a file should also give you a context menu option CRC SHA which will allow you to select a CRC32 calculation to be done on the selected file.
In Windows, right clicking on a file should also give you a context
menu option CRC SHA which will allow you to select a CRC32 calculation
to be done on the selected file.
### Tera Term macro configuration
Macros are a useful tool for automatic common tasks. There are a number of instances where using macros to facilitate the update process could be worthwhile if you are:
Macros are a useful tool for automatic common tasks. There are a
number of instances where using macros to facilitate the update
process could be worthwhile if you are:
* Following the RomWBW development builds.
* Doing lots of configuration changes.
* Doing development on RomWBW drivers
Macros can be used to automate sending ROM updates or images and for my own purposed I have set up a separate macro for transferring each of the standard build ROM, my own custom configuration ROM and update ROM.
Macros can be used to automate sending ROM updates or images and
for my own purposed I have set up a separate macro for transferring
each of the standard build ROM, my own custom configuration ROM
and update ROM.
An example macro file to send an *.upd file, using checksum mode and display the crc32 value of the transmitted file:
An example macro file to send an *.upd file, using checksum mode
and display the crc32 value of the transmitted file:
```
Xmodem send, checksum, display crc32
@ -896,39 +854,45 @@ messagebox inputstr 'crc32'
### Serial speed guidelines
As identified in the introduction, there are limitations on serial speed depending on processor speed and flow control settings. Listed below are some of the results identified during testing.
Configuration | Processor Speed | Maximum Serial Speed
-----------------------|-----------------|---------------------
UART no flow control | 2MHz | 9600
UART no flow control | 4MHz | 19200
UART no flow control | 5MHz | 19200
UART no flow control | 8MHz | 38400
UART no flow control | 10MHz | 38400
USB-fifo 2MHz+ | | n/a
ASCI no flow control | 18.432MHz | 9600
ASCI with flow control | 18.432MHz | 38400
As identified in the introduction, there are limitations on serial
speed depending on processor speed and flow control settings.
Listed below are some of the results identified during testing.
| Configuration | Processor Speed | Maximum Serial Speed |
|------------------------|-----------------|----------------------|
| UART no flow control | 2MHz | 9600 |
| UART no flow control | 4MHz | 19200 |
| UART no flow control | 5MHz | 19200 |
| UART no flow control | 8MHz | 38400 |
| UART no flow control | 10MHz | 38400 |
| USB-fifo | 2MHz+ | n/a |
| ASCI no flow control | 18.432MHz | 9600 |
| ASCI with flow control | 18.432MHz | 38400 |
The **Set Recommend Baud Rate** option in the Updater menu follows the following guidelines.
Processor Speed | Baud Rate
----------------|----------
1MHz | 4800
2-3MHz | 9600
4-7MHz | 19200
8-20MHz | 38400
| Processor Speed | Baud Rate |
|-----------------|-----------|
| 1MHz | 4800 |
| 2-3MHz | 9600 |
| 4-7MHz | 19200 |
| 8-20MHz | 38400 |
These can be customized in the updater.asm source code in the CLKTBL table if desired.
Feedback to the RomWBW developers on these guidelines would be appreciated.
### Notes
All testing was done with Tera Term x-modem, Forcing checksum mode using macros was found to give the most reliable transfer.
Partial writes can be completed with 39SF040 chips. Other chips require entire flash to be erased before being written.
An SBC V2-005 MegaFlash or Z80 MBC required for 1mb flash support. The Updater assumes both chips are same type
Failure handling has not been tested.
Timing broadly calibrated on a Z80 SBC-v2
Unabios not supported
Notes
* All testing was done with Tera Term x-modem, Forcing checksum mode
using macros was found to give the most reliable transfer.
* Partial writes can be completed with 39SF040 chips. Other chips
require entire flash to be erased before being written.
* An SBC V2-005 MegaFlash or Z80 MBC required for 1mb flash support.
The Updater assumes both chips are same type
* Failure handling has not been tested.
* Timing broadly calibrated on a Z80 SBC-v2
* Unabios not supported
## User Application
@ -2192,6 +2156,146 @@ discover ports that are 'write-only'.
`\clearpage`{=latex}
## SYSCONF (System Configuration)
| SYSCONF | |
| --------------------|---|
| ROM-based |Yes|
| Disk-based |Yes|
System Configuration (`SYSCONF`) is a utility that allows system configuration to
be set, dynamically and stored in NVRAM provided by an RTC chip.
(`SYSCONF`) is both a ROM utility ('W' Menu option), and a CP/M application.
Noting however the CP/M application is not included on an disk image, it is found in
the `Binary/Applications` folder of the RomWBW distribution.
The section "Setting NVRAM Options" in the $doc_user$ has additional information
on the use of NVRAM to set your system configuration.
#### Syntax
The application is an interactive application; it does not have a command line syntax.
Instead commands are executed from within the application in a command line structure.
`SYSCONF` command takes no arguments.
| `SYSCONF`
#### Usage
When you first start the (`SYSCONF`) utility it will display the current switches
followed by a command listing. e.g.
```
RomWBW System Config Utility
Current Configuration:
[BO] / Boot Options: ROM (App = "H")
[AB] / Auto Boot: Disabled
Commands:
(P)rint - Display Current settings
(S)et {SW} {val}[,{val}[,{val}]]- Set a switch value(s)
(R)eset - Init NVRAM to Defaults
(H)elp [{SW}] - This help menu, or help on a switch
e(X)it - Exit Configuration
$
```
When you run (`SYSCONF`) for the first time the NVRAM will be uninitialised, and can
be initialised using the (R)eset command, which writes default values to NVRAM.
Updates are done immediately to NVRAM as you enter them, i.e. there is no confirm
changes step. If you make any incorrect changes, you simply need to enter a new
command to set the Switch value correctly.
Once a change has been made it is available, however it may not take effect until
the next system reboot. This is dependent on the Switch itself.
If no NVRAM is provided by your hardware, then running this application will just
report the missing hardware and exit immediately.
To exit from the application use the (Q)uit command.
#### Commands and Syntax
The following are the accepted commands, unless otherwise specified a "Space"
character is used to delimit parameters in the command.
| Command | Argument(s) | Description |
|-----------|------------------|-----------------------------------------------|
| (P)rint | -none- | Display a list of the current switch value(s) |
| (S)et | {SW} {val},... | Sets an Switch {SW} with specific values(s) |
| (R)eset | -none- | Reset all setting to default |
| (H)elp | {SW} | Provides help on the syntax (values) |
| e(X)it | -none- | Exit the application |
**Where**
| Argument | Description |
|-----------|----------------------------------------------------------------------|
| {SW} | Switch ID, typically this is 2 character name to identify the switch |
| {val},... | a "Comma" separated list of values to set into the switch |
#### Switch Options
#### Auto Boot (AB)
This switch will define if the system will perform auto boot at the RomWBW boot prompt.
Enabling this will not prevent a user from typing a boot command, so long as the timeout is not
exceeded. When configured this replaces the (`AUTO_CMD`) variable
defined in build configuration.
Making changes to auto boot has no affect until the next reboot.
**Arguments**
| Type | Arguments | Description |
|----------|------------|--------------------------------------------------------|
| Enable | 'E' | Auto Boot. eg. "E,10" will auto boot, after 10 seconds |
| | Timout | Timeout in seconds in the range 0-15, 0 = immediate |
| Disabled | 'D' | No Auto Boot. e.g. "D" will disable autoboot |
**Examples**
| Command | Description |
|-----------------------|---------------------------------------------------|
| S AB E,10 | Enable Auto Boot with 10 second delay |
| S AB D | Disable Auto Boot |
#### Boot Options (BO)
This switch will define the boot command to be executed when auto boot is
enabled. When configured this replaces the (`AUTO_CMD`) variable
defined in the ROM build configuration.
Making changes to boot options has no affect until the next reboot.
**Arguments**
| Type | Arguments | Description |
|------|------------------|----------------------------------------------------------|
| Disk | 'D' | Disk Boot. eg. "D,2,14" will boot, disk unit 2, slice 14 |
| | Disk Unit Number | Unit number in the range 0-127 |
| | Disk Slice | Slice in the range 0-255, use 0 for floppy boot |
| ROM | 'R' | ROM App. e.g. "R,M" will boot the Monitor App |
| | Rom App Name | single character used on the Menu to identify the app |
**Examples**
| Command | Description |
|-------------|----------------------------------------------------------|
| S BO D,2,14 | Set the default boot from Disk; Unit 2, Slice 14 |
| S BO R,M | Set the default boot to be the (M)onitor Rom Application |
#### Etymology
The `SYSCONF` utility is an original product specific to RomWBW, source code is included.
`SYSCONF` was contributed by Mark Pruden.
`\clearpage`{=latex}
## SYSCOPY (System Copy)
| SYSCOPY | |
@ -2438,10 +2542,11 @@ whether support for it is included in the RomWBW HBIOS configuration
| `-MSX` | Force MSX port addresses A0H/A1H (no PSG detection) |
| `-RC` | Force RCBus port addresses D8H/D0H (no PSG detection) |
| `--HBIOS` | Utilise HBIOS' sound driver |
| `+T1` | Play tune an octave higher |
| `+T2` | Play tune two octaves higher |
| `-T1` | Play tune an octave lower |
| `-T2` | Play tune two octaves lower |
| `-DELAY` | Force delay mode (don't use hardware timer) |
| `+T1` | Play tune an octave higher |
| `+T2` | Play tune two octaves higher |
| `-T1` | Play tune an octave lower |
| `-T2` | Play tune two octaves lower |
The +t and -t options apply only to HBIOS mode operation. The `-MSX`,
`-RC`, and `--HBIOS` options are mutually exclusive. See Notes below.
@ -2465,7 +2570,7 @@ an error message.
Some hardware (notably Why-Em-Ulator) cannot be detected due limitations
of the emulation. In such cases, you can force the use of the two
most common port addresses using the `-msx` or `-rc` options.
most common port addresses using the `-MSX` or `-RC` options.
On Z180 systems, I/O wait states are added when writing to the sound
chip to avoid exceeding its speed limitations. On Z80 systems, you
@ -2473,9 +2578,13 @@ will need to ensure that the CPU clock speed of your system does not
exceed the timing limitations of your sound chip.
The application probes for an active system timer and uses it to
accurately pace the sound file output. If no system timer is
accurately pace the sound file playback. If no system timer is
available, a delay loop is calculated instead. The delay loop will not
be as accurate as the system timer.
be as accurate as the system timer. If the `-DELAY` options is
specified on the command line, then the delay loop will be used
regardless of whether the system has a hardware timer. This is useful
if the hardware timer does not run at the 50Hz desired for sound
playback.
There are two modes of operation. A direct hardware interface for the
AY-3-8910 or YM2149 chips, or a compatibility layer thru HBIOS supporting

9
Source/Doc/Basic.h

@ -14,7 +14,14 @@ $define{doc_sys}{[RomWBW System Guide]($doc_root$/RomWBW System Guide.pdf)}$
$define{doc_apps}{[RomWBW Applications]($doc_root$/RomWBW Applications.pdf)}$
$define{doc_catalog}{[RomWBW Disk Catalog]($doc_root$/RomWBW Disk Catalog.pdf)}$
$define{doc_hardware}{[RomWBW Hardware]($doc_root$/RomWBW Hardware.pdf)}$
$ifdef{GFM}$
$define{doc_intro}{[RomWBW Introduction](Introduction.md)}$
$define{doc_user}{[RomWBW User Guide](UserGuide.md)}$
$define{doc_sys}{[RomWBW System Guide](SystemGuide.md)}$
$define{doc_apps}{[RomWBW Applications](Applications.md)}$
$define{doc_catalog}{[RomWBW Disk Catalog](Catalog.md)}$
$define{doc_hardware}{[RomWBW Hardware](Hardware.md)}$
$endif$
---
title: $doc_product$ $doc_title$
subtitle: $doc_ver$

434
Source/Doc/Catalog.md

@ -70,11 +70,12 @@ disks should now be fully described.
CP/M 3. Applications have been patched according to the DRI
patch list.
- **ZPM3**: Digital Research CP/M-80 2.2 Distribution Files
- **ZPM3**: ZPM3 Distribution Files
Documentation: *CPM Manual.pdf*
Documentation: *ZPM3.txt*
These files are from Simeon Cran's ZPM3 operating system distribution.
These files are from Simeon Cran's official distribution of ZPM3.
All known patches have been applied.
`\clearpage`{=latex}
@ -573,7 +574,7 @@ This is a generic ZPM3 adaptation for RomWBW.
The following files came from from Microcode Consulting. The official
distribution files can be found on the Microcode Consulting website at
[https://www.microcodeconsulting.com/z80/qpm.htm].
<https://www.microcodeconsulting.com/z80/qpm.htm>.
Also included in this image are debugz, and linkz frm the same company.
This disk includes the standard DRI CP/M 2.2 files in addition to the
@ -651,7 +652,7 @@ look a little strange depending on the terminal emulation you are using.
User area 4 contains a full implementation of the CP/NET 1.2 client
provided by Doug Miller. Please refer to
[https://github.com/durgadas311/cpnet-z80] for more information,
<https://github.com/durgadas311/cpnet-z80> for more information,
complete documentation and the latest source code.
Please refer to the RomWBW User Guide for instructions on installing
@ -666,12 +667,12 @@ The following are found in
| **File** | **CP/NET Version** | **OS** | **Hardware** |
|-----------------|---------------------|-----------------|-------------------------|
| CPN12MT.LBR | CP/NET 1.2 | CP/M 2.2 | RCBus w/ MT011 |
| CPN3MT.LBR | CP/NET 3 | CP/M 3 | RCBus w/ MT011 |
| CPN12DUO.LBR | CP/NET 1.2 | CP/M 2.2 | Duodyne w/ Disk I/O |
| CPN3DUO.LBR | CP/NET 3 | CP/M 3 | Duodyne w/ Disk I/O |
| CPN12SER.LBR | CP/NET 1.2 | CP/M 2.2 | RomWBW Serial Port |
| CPN3SER.LBR | CP/NET 3 | CP/M 3 | RomWBW Serial Port |
| `CPN12MT.LBR` | CP/NET 1.2 | CP/M 2.2 | RCBus w/ MT011 |
| `CPN3MT.LBR` | CP/NET 3 | CP/M 3 | RCBus w/ MT011 |
| `CPN12DUO.LBR` | CP/NET 1.2 | CP/M 2.2 | Duodyne w/ Disk I/O |
| `CPN3DUO.LBR` | CP/NET 3 | CP/M 3 | Duodyne w/ Disk I/O |
| `CPN12SER.LBR` | CP/NET 1.2 | CP/M 2.2 | RomWBW Serial Port |
| `CPN3SER.LBR` | CP/NET 3 | CP/M 3 | RomWBW Serial Port |
## General Purpose Applications
@ -927,12 +928,12 @@ The following files are found in
| **File** | **Description** |
|----------------|-----------------------------------------------------------|
| HDIR.COM | |
| R.COM | transfer files between the simulator and host file system |
| RSETSIMH.COM | -- |
| TIMER.COM | -- |
| URL.COM | -- |
| W.COM | transfer files between the simulator and host file system |
| `HDIR.COM` | |
| `R.COM` | transfer files between the simulator and host file system |
| `RSETSIMH.COM` | -- |
| `TIMER.COM` | -- |
| `URL.COM` | -- |
| `W.COM` | transfer files between the simulator and host file system |
## Testing Applications
@ -979,7 +980,7 @@ The following files are found in
| `ZEXDOC.COM` | Z80 Instruction Set Exerciser |
And The following CPU Tests - Which are probably originally from this source.
[https://github.com/raxoft/z80test]
<https://github.com/raxoft/z80test>
| **File** | **Description** |
|----------------|---------------------------------------------------------------|
@ -1002,7 +1003,7 @@ including MS-DOS, Apple II DOS 3.3 and PRoDOS, Commodore 64, Macintosh and
Amiga. This disk contains the CP/M version of that compiler. A cross-compiler
for MS-DOS or Windows XP is also available.
For full documentation, see [https://www.aztecmuseum.ca]
For full documentation, see <https://www.aztecmuseum.ca>
The user manual is available in the Doc/Language directory
Aztec_C_1.06_User_Manual_Mar84.pdf
@ -1048,38 +1049,79 @@ NOTE : The above is incomplete
The Cowgol 2.0 compiler and related tools.
These files were provided by Ladislau Szilagyi and were sourced
from his GitHub repository at [https://github.com/Laci1953/Cowgol_on_CP_M].
from his GitHub repository at <https://github.com/Laci1953/Cowgol_on_CP_M>.
The primary distribution site for Cowgol 2.0 is at
[https://github.com/davidgiven/cowgol].
<https://github.com/davidgiven/cowgol>.
The user manual is available in the Doc/Language directory
Cowgol Language.pdf
Cowgol Language.pdf.
The following files are found in
* /Source/Images/d_cowgol
| **File** | **Description** |
|--------------|--------------------------------------------|
| ADVENT.COW | Adventure game program source |
| ADVENT.SUB | Submit file to build ADVENT |
| ADVENT?.TXT | Adventure game program resource |
| ADVMAIN.COW | Adventure game program source |
| RAND.AS | Assembler Library File |
| COWBE.COM | |
| COWFE.COM | RomWBW specific (Memory Manage) version |
| COWLINK.COM | |
| DYNMSORT.COW | demonstrates a sort algorithm |
| DYNMSORT.SUB | Submit file to build DYNMSORT |
| HEXDUMP.COW | a simple hex dump utility, purely a Cowgol |
| HEXDUMP.SUB | Submit file to build HEXDUMP |
| HMERGES.C | C Library File |
| XRND.AS | Assembler Library File |
| - | - |
NOTE : The above is incomplete
## Microsoft Fortran 80 (Fortran)
| **File** | **Description** |
|----------------|--------------------------------------------|
| `$EXEC.COM` | HiTech C batch processor which launches the Cowgol toolchain executables |
| `ADVENT.COW` | Adventure game program source |
| `ADVENT.SUB` | SUBMIT file to build Adventure game |
| `ADVENT?.TXT` | Adventure game program resources |
| `ADVMAIN.COW` | Adventure game program source |
| `ADVTRAV.COW` | Adventure game component source |
| `ARGV.COH` | Cowgol include file providing command line argument processing |
| `C.LIB` | HI-TECH C runtime library |
| `CGEN.COM` | HiTech C compiler pass 2 |
| `COMMFILE.COH` | Include file providing file I/O |
| `COMMON.COH` | Include file providing common functions |
| `COWBE.COM` | Cowgol back end which builds the cowgol object files (optimized) |
| `COWFE.COM` | Cowgol front end which parses the source file (optimized) |
| `COWFIX.COM` | Interface to Z80AS -- performs code optimizations |
| `COWGOL.COH` | Include file providing standard Cowgol functions |
| `COWGOL.COM` | Interprets the command line and generates $EXEC run requests (a variant of HiTech C.COM) |
| `COWGOL.COO` | Cowgol object file with ??? |
| `COWGOL.LIB` | ??? |
| `COWGOLC.COH` | Cowgol include file providing ??? |
| `COWLINK.COM` | Cowgol linker which binds all the cowgol object files and outputs a Z80 assembler file (optimized) |
| `CPP.COM` | HiTech C pre-processor, modified to accept // style comments |
| `DYNMSORT.COW` | Sort algorithm sample program source |
| `DYNMSORT.SUB` | SUBMIT file to build DYNMSORT sample application |
| `FACT.COW` | Factorial computation sample program source |
| `FILE.COH` | Include file providing CP/M file processing support |
| `FILEIO.COH` | Include file providing CP/M file processing support |
| `HEXDUMP.COW` | Hex file dump sample source |
| `HEXDUMP.SUB` | SUBMIT file to build HEXDUMP sample program |
| `LIBBASIC.COH` | Include file providing ??? |
| `LIBBIOS.COH` | Include file providing ??? |
| `LIBCONIO.COH` | Include file providing console I/O |
| `LIBFP.COH` | Include file providing floating point support |
| `LIBR.COM` | HiTech object file librarian |
| `LIBSTR.COH` | Include file providing string functions |
| `LINK.COM` | HiTech linker which builds the final executable from object and library files |
| `MALLOC.COH` | Include file providing dynamic memory management functions |
| `MERGES.C` | Merge sort sample function C language source |
| `MISC.COH` | Include file providing miscellaneous functions |
| `MISC.COO` | Miscellaneous functions object file |
| `MISC.COW` | Miscellaneous functions source file |
| `OPTIM.COM` | HiTech C compiler optimizer |
| `P1.COM` | HiTech C compiler first pass |
| `RAND.AS` | Pseudo-random number generator source in assembly language |
| `RANFILE.COH` | Include file providing random file access functions |
| `RANFILE.COO` | Random file access functions object file |
| `RANFILE.COW` | Random file access functions source file |
| `README.TXT` | Cowgol disk image release notes |
| `SEQFILE.COH` | Include file providing sequential file access functions |
| `SEQFILE.COO` | Sequential file access functions object file |
| `SEQFILE.COW` | Sequential file access functions source file |
| `STDCOW.COH` | Include file providing standard library functions |
| `STRING.COH` | Include file providing string functions |
| `STRING.COO` | String functions object file |
| `STRING.COW` | String functions source file |
| `STRINGS.COH` | Include file implementing string functions |
| `TESTAS.COW` | Assembly language interface sample program source |
| `TESTAS.SUB` | SUBMIT file to build TESTAS sample program |
| `Z80AS.COM` | Z80 assembler which assembles the output of COWFIX and other Z80 source files (see <https://github.com/Laci1953/Z80AS>) |
## Microsoft Fortran 80
| Floppy Disk Image: **fd_fortran.img**
| Hard Disk Image: **hd_fortran.img**
@ -1114,12 +1156,12 @@ Zork 1 through 3, Planetfall and Hitchhiker's Guide to the Galaxy.
Nemesis and Dungeon Master is a Rogue-like game released in 1981. It is playable
on a text terminal using ASCII graphics to represent the dungeon. Only a few
thousand copies of the game were ever made, making it very rare. See
[http://crpgaddict.blogspot.com/2019/03/game-322-nemesis-1981.html]
<http://crpgaddict.blogspot.com/2019/03/game-322-nemesis-1981.html>
Colossal Cave Adventure is a CP/M port of the 1976 classic game originally
written by Will Crowther for the PDP-10 mainframe. See
[https://en.wikipedia.org/wiki/Colossal_Cave_Adventure] and
[https://if50.substack.com/p/1976-adventure]
<https://en.wikipedia.org/wiki/Colossal_Cave_Adventure> and
<https://if50.substack.com/p/1976-adventure>
The following files are found in
@ -1136,31 +1178,195 @@ NOTE : The above is incomplete
| Floppy Disk Image: **fd_hitechc.img**
| Hard Disk Image: **hd_hitechc.img**
The HI-TECH C Compiler is a set of software which
The HI-TECH C Compiler is a set of software which
translates programs written in the C language to executable
machine code programs. Versions are available which compile
programs for operation under the host operating system, or
which produce programs for execution in embedded systems
without an operating system.
This is the Mar 21, 2023 update 17 released by Tony Nicholson who currently
maintains HI-TECH C at [https://github.com/agn453/HI-TECH-Z80-C]
This is the Jun 2, 2025 update 19 released by Tony Nicholson who
currently maintains HI-TECH C at
<https://github.com/agn453/HI-TECH-Z80-C>.
The manual is available in the Doc/Language directory,
HI-TECH Z80 C Compiler Manual.txt
HI-TECH Z80 C Compiler Manual.txt. A textual description of all error
and warning messages is found in the same directory, HI-TECH Z80 C
Compiler Messages.txt.
A good blog post about the HI-TECH C Compiler is available at
[https://techtinkering.com/2008/10/22/installing-the-hi-tech-z80-c-compiler-for-cpm]
<https://techtinkering.com/2008/10/22/installing-the-hi-tech-z80-c-compiler-for-cpm>.
User area 1 contains another complete copy of the HI-TECH C Compiler.
It is identical to the copy in user area 0 except for the following files
which were enhanced by Ladislau Szilagyi from his GitHub Repository at
<https://github.com/Laci1953/HiTech-C-compiler-enhanced>. The files
take advantage of additional banked memory using the RomWBW HBIOS API.
As such, they require RomWBW to operate. They should be compatible with
all CP/M and compatible operations systems provided in RomWBW.
The enhanced files are:
- `CGEN.COM`
- `CPP.COM`
- `OPTIM.COM`
- `P1.COM`
- `ZAS.COM`
A thread discussing this enhanced version of HI-TECH C is found at
<https://groups.google.com/g/rc2014-z80/c/sBCCIpOnnGg>.
The following files are found in
* /Source/Images/d_hitechc
| **File** | **Description** |
|----------|-----------------|
| -- | -- |
| **File** | **Description** |
|----------------|--------------------------------------------|
| `$EXEC.COM` | Compiler execution manager |
| `ASSERT.H` | Language include file |
| `C.COM` | Compiler invocation application (updated) |
| `C309.COM` | Compiler invocation application (original) |
| `CGEN.COM` | The code generator - produces assembler code |
| `CONIO.H` | Language include file (see manual) |
| `CPM.H` | Language include file (see manual) |
| `CPP.COM` | Pre-processor - handles macros and conditional compilation |
| `CREF.COM` | Produces cross-reference listings of C or assembler programs |
| `CRTCPM.OBJ` | Startup Object File (standard) |
| `CTYPE.H` | Language include file (see manual) |
| `DEBUG.COM` | C Debugger (Z80) |
| `DRTCPM.OBJ` | Startup Object File (???) |
| `EXEC.H` | Language include file (see manual) |
| `FLOAT.H` | Language include file (see manual) |
| `HITECH.H` | Language include file (see manual) |
| `LIBC.LIB` | Standard C Runtime Library |
| `LIBF.LIB` | Floating Point Library |
| `LIBOVR.LIB` | Overlay Library |
| `LIBR.COM` | Creates and maintains libraries of object modules |
| `LIMITS.H` | Language include file (see manual) |
| `LINQ.COM` | Link editor - links object files with libraries |
| `MATH.H` | Language include file (see manual) |
| `NRTCPM.OBJ` | Startup Object File (minimal getargs) |
| `OBJTOHEX.COM` | Converts the output of LINK into the appropriate executable file format (e.g., .EXE or .PRG or .HEX) |
| `OPTIM.COM` | Code improver - may optionally be omitted, reducing compilation time at a cost of larger, slower code produced |
| `OPTIONS` | Compiler usage help file |
| `OVERLAY.H` | Language include file |
| `P1.COM` | The syntax and semantic analysis pass - writes intermediate code for the code generator to read |
| `RRTCPM.OBJ` | Startup Object File (self relocating) |
| `SETJMP.H` | Language include file (see manual) |
| `SIGNAL.H` | Language include file (see manual) |
| `STAT.H` | Language include file (see manual) |
| `STDARG.H` | Language include file (see manual) |
| `STDDEF.H` | Language include file (see manual) |
| `STDINT.H` | Language include file (see manual) |
| `STDIO.H` | Language include file (see manual) |
| `STDLIB.H` | Language include file (see manual) |
| `STRING.H` | Language include file (see manual) |
| `SYMTOAS.COM` | Convert symbol file to assembler |
| `SYS.H` | Language include file (see manual) |
| `TIME.H` | Language include file (see manual) |
| `UNIXIO.H` | Language include file (see manual) |
| `ZAS.COM` | The assembler - in fact a general purpose macro assembler |
## Infocom (Text Adventure Games)
| Hard Disk Image: **hd_infocom.img**
A collection of all Official releases of the interactive fiction games
produced by Infocom in the 1980's
NOTE : The above is incomplete
The following files are found in
* /Source/Images/d_infocom
| **File** | **Description** |
|--------------|----------------------------------------------------|
| amfv.z4 | A Mind Forever Voyaging (*) |
| arthur.z6 | Arthur - The Quest for Excalibur (*) |
| ballyhoo.z3 | Ballyhoo |
| beyond.z5 | Beyond Zork (*) |
| border.z5 | Border Zone (*) |
| bureau.z4 | Bureaucracy (*) |
| cutthr.z3 | Cutthroats |
| deadline.z3 | Deadline |
| enchant.z3 | Enchanter |
| h2g2.z3 | The Hitchhiker's Guide to the Galaxy |
| hollyw.z3 | Hollywood Hijinx |
| infidel.z3 | Infidel |
| journey.z6 | Journey (*) |
| leather.z3 | Leather Goddesses of Phobos |
| lurking.z3 | The Lurking Horror |
| moonmist.z3 | Moonmist |
| nordbert.z4 | Nord and Bert Couldn't Make Head or Tail of It (*) |
| planet.z3 | Planetfall |
| plunder.z3 | Plundered Hearts |
| readme.txt | Documentation about the Infocom games |
| seastalk.z3 | Seastalker |
| sherlock.z5 | Sherlock (*) |
| shogun.z6 | Shogun (*) |
| sorcerer.z3 | Sorcerer |
| spellb.z3 | Spellbreaker |
| starcros.z3 | Starcross |
| stationf.z3 | Stationfall |
| suspect.z3 | Suspect |
| suspend.z3 | Suspended |
| trinity.z4 | Trinity (*) |
| wishb.z3 | Wishbringer |
| witness.z3 | Witness |
| zork0.z6 | Zork Zero (*) |
| zork1.z3 | Zork I |
| zork2.z3 | Zork II |
| zork3.z3 | Zork III |
| zorknote.txt | Documentation about terminal config of COM files |
The above games have been curated from here <https://eblong.com/infocom/>.
Full game documentation can be found here <https://infodoc.plover.net/>
The game files are a virtual machine code commonly known as Z-Machine, they
are portable and will run on any machine that has a Z-Machine interpreter.
* All the Z3 games come with the official CP/M interpreter (the `COM` file)
version C last updated by Inforcom on 5th Feb 1985. You can simply run the
game by running it from the `COM` program
* All latter games Z4, Z5,.. and above, (Marked as * in the listing above)
are more sophisticated and require a better interpreter. i.e. VEZZA.
#### VEZZA (User Area 15)
Vezza is a modern Infocom/Inform/Z-machine text adventure interpreter for 8 bit
z80 based computers. What makes it modern is that it is written in hand-crafted
z80 assembler for maximum speed, and can load not only the classics such as
Zork 1,2 and 3 but also the later games.
It can run Z1 up to Z8 inform format interactive fiction game files. To run
a game with Vezza just type Vezza followed by the game you want to run. e.g.
`VEZZA ZORK0.Z6`
**Note:** One of the bigger constraints is available RAM. An OS such as ZPM
since it uses banked RAM does have a good amount of available RAM and was
used to test these games work.
This tool is free but the developer accepts your support by letting
you pay what you think is fair for the tool. If you find this useful
consider donating at:
<https://sijnstra.itch.io/vezza>
You should (test and) choose one that works on you configuration,
and best to copy and rename it as vezza.com
| **File** | **Description** |
|--------------|-------------------------------------------------------------------|
| vezza-B.com | 80x24, VT52 + Banked CP/M 3 |
| vezza-FG.com | 80x25, VT100/ANSI (16 color) + CP/M 3 |
| vezza-C2.com | 80x24, VT100 - CP/M 2.2 large memory, no timed input |
| vezza-CC.com | 80x24, VT100 (256 colour) - CP/M 2.2 large memory, no timed input |
| vezza-AV.com | 80x24, VT100 (16 colour) - CP/M 2.2 high RAM. |
| vezza-AX.com | 80x25, VT100/ANSI (16 colour) - CP/M 2.2 high RAM. |
| vezza-RW.com | 80x24, VT100 - CP/M 2.2 |
The above is a subset of available builds. The full repository including
documentation is available at <https://gitlab.com/sijnstra1/vezza/>
## MSX ROMS
@ -1170,7 +1376,7 @@ NOTE : The above is incomplete
The collection of MSX ROMs (2 disks) as provided by Les Bird.
These ROMs are "run" by using the
appropriate variant of Les' MSX8 ROM loader. You can download the
loader binaries from [https://github.com/lesbird/MSX8]. You will need
loader binaries from <https://github.com/lesbird/MSX8>. You will need
appropriate hardware to run the loader.
Please review the file ROMLIST.TXT for information on the current
@ -1206,25 +1412,25 @@ The manual can be found in the Docs/Language directory,
Turbo_Pascal_Version_3.0_Reference_Manual_1986.pdf
A good overview of using Turbo Pascal in CP/M is available at
[https://techtinkering.com/2013/03/05/turbo-pascal-a-great-choice-for-programming-under-cpm]
<https://techtinkering.com/2013/03/05/turbo-pascal-a-great-choice-for-programming-under-cpm>
The following files are found in
* /Source/Images/d_tpascal
| **File** | **Description** |
|--------------|--------------------------------|
| ART.TXT | Part of the Example program |
| SA.PAS | Example Program |
| TINST.COM | Installation and Configuration |
| TINST.DTA | Part of TINST |
| TINST.MSG | Part of TINST |
| TURBO.COM | The main Turbo Pascal program |
| TURBO.MSG | Part of TURBO tascal |
| TURBO.OVR | Part of TURBO tascal |
| TURBOMSG.OVR | Part of TURBO tascal |
| **File** | **Description** |
|----------------|--------------------------------|
| `ART.TXT` | Part of the Example program |
| `SA.PAS` | Example Program |
| `TINST.COM` | Installation and Configuration |
| `TINST.DTA` | Part of TINST |
| `TINST.MSG` | Part of TINST |
| `TURBO.COM` | The main Turbo Pascal program |
| `TURBO.MSG` | Part of TURBO Pascal |
| `TURBO.OVR` | Part of TURBO Pascal |
| `TURBOMSG.OVR` | Part of TURBO Pascal |
## WordStar 4
## WordStar 4 (Word processor)
| Floppy Disk Image: **fd_ws4.img**
| Hard Disk Image: **hd_ws4.img**
@ -1358,10 +1564,10 @@ The manual(s) are available in the Doc/Language directory,
* Z80DIS User Manual (1985).pdf
A run through of using the assembler is available at
[https://8bitlabs.ca/Posts/2023/05/20/learning-z80-asm]
<https://8bitlabs.ca/Posts/2023/05/20/learning-z80-asm>
And another shorter, but shows linker usage guide
[https://pollmyfinger.wordpress.com/2022/01/10/modular-retro-z80-assembly-language-programming-using-slr-systems-z80asm-and-srlnk/]
<https://pollmyfinger.wordpress.com/2022/01/10/modular-retro-z80-assembly-language-programming-using-slr-systems-z80asm-and-srlnk/>
The following files are found in
@ -1369,53 +1575,53 @@ The following files are found in
User Area 0 - Assembler
| **File** | **Description** |
|-------------|---------------------------------------------|
| 180FIG.COM | Configuration utility for SLR180.COM |
| 8080.MAC | ? |
| CONFIG.COM | Configuration utility for Z80ASM.COM |
| CONFIGP.COM | Configuration utility for Z80ASMP.COM |
| DUMP.* | Sample Program |
| MAKESYM.COM | Symbol File .SYM file generation |
| MAKESYM.DOC | Documentation for MAKESYM.COM |
| SLR180.COM | HD64180 (Z180) Relocating Macro Assembler |
| SLR180.DOC | Release Notes for SLR180.COM |
| SLRMAC.COM | 8080 Relocating Macro Assembler |
| SYNTAX.HLP | Documentation basic usage for all SLR Tools |
| SYNTAX.TXT | Documentation basic usage for all SLR Tools |
| TEST.* | Sample Program |
| Z80ASM.COM | Z80 Relocating Macro Assembler |
| Z80ASMP.COM | Z80 Relocating Macro Assembler (PLUS) |
| Z80ASM.DOC | Release Notes for Z80ASM.COM |
| **File** | **Description** |
|---------------|---------------------------------------------|
| `180FIG.COM` | Configuration utility for SLR180.COM |
| `8080.MAC` | ? |
| `CONFIG.COM` | Configuration utility for Z80ASM.COM |
| `CONFIGP.COM` | Configuration utility for Z80ASMP.COM |
| `DUMP.*` | Sample Program |
| `MAKESYM.COM` | Symbol File .SYM file generation |
| `MAKESYM.DOC` | Documentation for MAKESYM.COM |
| `SLR180.COM` | HD64180 (Z180) Relocating Macro Assembler |
| `SLR180.DOC` | Release Notes for SLR180.COM |
| `SLRMAC.COM` | 8080 Relocating Macro Assembler |
| `SYNTAX.HLP` | Documentation basic usage for all SLR Tools |
| `SYNTAX.TXT` | Documentation basic usage for all SLR Tools |
| `TEST.\*` | Sample Program |
| `Z80ASM.COM` | Z80 Relocating Macro Assembler |
| `Z80ASMP.COM` | Z80 Relocating Macro Assembler (PLUS) |
| `Z80ASM.DOC` | Release Notes for Z80ASM.COM |
User Area 1 - Linker and Library Management
| **File** | **Description** |
|--------------|-----------------------------------------------|
| LNKFIG.COM | Configuration utility for SLRNK.COM |
| NZLNKFIX.ZEX | ? |
| SLRIB.COM | SuperLibrarian, library manager |
| SLRNK.COM | SuperLinker, the main linker tool |
| SLRNKP.COM | SuperLinker (PLUS) |
| SLRNK.DOC | Release Notes for SLRNK.COM |
| SLRNKFIX.ZEX | ? |
| SYNTAX.HLP | Documentation basic usage for all SLR Tools |
| SYNTAX.TXT | Documentation basic usage for all SLR Tools |
| SYSSLR.REL | SYSLIB (older) Library compatible with SLR |
| VSLR.REL | VLIB (older) Library compatible with SLR |
| Z3SLR.REL | Z3LIB (older) Library compatible with SLR |
| **File** | **Description** |
|----------------|-----------------------------------------------|
| `LNKFIG.COM` | Configuration utility for SLRNK.COM |
| `NZLNKFIX.ZEX` | ? |
| `SLRIB.COM` | SuperLibrarian, library manager |
| `SLRNK.COM` | SuperLinker, the main linker tool |
| `SLRNKP.COM` | SuperLinker (PLUS) |
| `SLRNK.DOC` | Release Notes for SLRNK.COM |
| `SLRNKFIX.ZEX` | ? |
| `SYNTAX.HLP` | Documentation basic usage for all SLR Tools |
| `SYNTAX.TXT` | Documentation basic usage for all SLR Tools |
| `SYSSLR.REL` | SYSLIB (older) Library compatible with SLR |
| `VSLR.REL` | VLIB (older) Library compatible with SLR |
| `Z3SLR.REL` | Z3LIB (older) Library compatible with SLR |
User Area 2 - Disassembler
| **File** | **Description** |
|--------------|----------------------------------|
| README.22 | Documentation for Z80DIS |
| Z80DIS.000 | Overlay File for Z80DIS.COM |
| Z80DIS.001 | Overlay File for Z80DIS.COM |
| Z80DIS.002 | Overlay File for Z80DIS.COM |
| Z80DIS.COM | Z80DIS Disassembler main program |
| Z80DIS22.DOC | Main Documentation for Z80DIS |
| ZDINSTAL.COM | Instal and Config for Z80DIS.COM |
| ZDINSTAL.DTA | Overlay file for ZDINSTAL.COM |
| ZDINSTAL.MSG | Overlay file for ZDINSTAL.COM |
| **File** | **Description** |
|----------------|----------------------------------|
| `README.22` | Documentation for Z80DIS |
| `Z80DIS.000` | Overlay File for Z80DIS.COM |
| `Z80DIS.001` | Overlay File for Z80DIS.COM |
| `Z80DIS.002` | Overlay File for Z80DIS.COM |
| `Z80DIS.COM` | Z80DIS Disassembler main program |
| `Z80DIS22.DOC` | Main Documentation for Z80DIS |
| `ZDINSTAL.COM` | Instal and Config for Z80DIS.COM |
| `ZDINSTAL.DTA` | Overlay file for ZDINSTAL.COM |
| `ZDINSTAL.MSG` | Overlay file for ZDINSTAL.COM |

47
Source/Doc/Hardware.md

@ -111,26 +111,26 @@ Others
| **Description** | **Bus** | **ROM Image File** | **Baud Rate** |
|-------------------------------------------------------------|----------|-----------------------------|--------------:|
| [Dyno Z180 SBC]^6^ | Dyno | DYNO_std.rom | 38400 |
| [EP Mini-ITX Z180]^11^ | UEXT | EPITX_std.rom | 115200 |
| [eZ80 for RCBus Module]^13^, 512K RAM/ROM | RCBus | RCEZ80_std.rom | 115200 |
| [Genesis Z180 System]^12^ | STD | GMZ180_std.rom | 115200 |
| [Heath H8 Z80 System]^10^ | H8 | HEATH_std.rom | 115200 |
| [NABU w/ RomWBW Option Board]^10^ | NABU | NABU_std.rom | 115200 |
| [S100 Computers Z180 SBC]^9^ | S100 | S100_std.rom | 57600 |
| [S100 Computers FPGA Z80 SBC]^9^ | S100 | FZ80_std.rom | 9600 |
| [UNA Hardware BIOS]^3^ | - | UNA_std.rom | - |
| [Z80-Retro SBC]^8^ | - | Z80RETRO_std.rom | 38400 |
| [Z180 Mark IV SBC]^3^ | ECB | MK4_std.rom | 38400 |
| ^3^Designed by John Coffman
| ^6^Designed by Steve Garcia
| ^8^Designed by Peter Wilson
| ^9^Designed by John Monahan
| ^10^Designed by Les Bird
| ^11^Designed by Alan Cox
| ^12^Designed by Doug Jackson
| ^13^Designed by Dean Netherton
| [Dyno Z180 SBC]^2^ | Dyno | DYNO_std.rom | 38400 |
| [EP Mini-ITX Z180]^6^ | UEXT | EPITX_std.rom | 115200 |
| [eZ80 for RCBus Module]^8^, 512K RAM/ROM | RCBus | RCEZ80_std.rom | 115200 |
| [Genesis Z180 System]^7^ | STD | GMZ180_std.rom | 115200 |
| [Heath H8 Z80 System]^5^ | H8 | HEATH_std.rom | 115200 |
| [NABU w/ RomWBW Option Board]^5^ | NABU | NABU_std.rom | 115200 |
| [S100 Computers Z180 SBC]^4^ | S100 | S100_std.rom | 57600 |
| [S100 Computers FPGA Z80 SBC]^4^ | S100 | FZ80_std.rom | 9600 |
| [UNA Hardware BIOS]^1^ | - | UNA_std.rom | - |
| [Z80-Retro SBC]^3^ | - | Z80RETRO_std.rom | 38400 |
| [Z180 Mark IV SBC]^1^ | ECB | MK4_std.rom | 38400 |
| ^1^Designed by John Coffman
| ^2^Designed by Steve Garcia
| ^3^Designed by Peter Wilson
| ^4^Designed by John Monahan
| ^5^Designed by Les Bird
| ^6^Designed by Alan Cox
| ^7^Designed by Doug Jackson
| ^8^Designed by Dean Netherton
`\clearpage`{=latex}
@ -141,6 +141,11 @@ devices and peripherals that are on-board or frequently used with
each platform. If the device or peripheral is not detected at boot,
the ROM will simply bypass support appropriately.
Each ROM will support a single memory manager. This is determined
by the build configuration and is not dynamically selected. The use
of the term Memory Manager is generally synonymous with Memory
Management Unit (MMU).
In some cases, support for multiple hardware components with potentially
conflicting resource usage are handled by a single ROM image. It is up
to the user to ensure that no conflicting hardware is in use.
@ -2274,6 +2279,7 @@ the active platform and configuration.
| VDU | MC6845 Family Video Display Controller (*) |
| VGA | HD6445CP4-based Video Display Controller |
| VRC | VGARC Video Display Controller |
| XOSERA | XOSERA FPGA-based Video Display Controller |
Note:
@ -2312,6 +2318,7 @@ Note:
| DSRTC | Maxim DS1302 Real-Time Clock w/ NVRAM |
| EZ80RTC | eZ80 Real-Time Clock |
| INTRTC | Interrupt-based Real Time Clock |
| PCRTC | MC146818/DS1285/DS12885 PC style |
| PCF | PCF8584-based I2C Real-Time Clock |
| RP5C01 | Ricoh RPC01A Real-Time Clock w/ NVRAM |
| SIMRTC | SIMH Simulator Real-Time Clock |

835
Source/Doc/Introduction.md

@ -1,410 +1,425 @@
$define{doc_title}{Introduction}$
$include{"Book.h"}$
# Overview
RomWBW software provides a complete, commercial quality
implementation of CP/M (and workalike) operating systems and
applications for modern Z80/180/280 retro-computing hardware systems.
A wide variety of platforms are supported including those
produced by these developer communities:
* [RetroBrew Computers](https://www.retrobrewcomputers.org)
(<https://www.retrobrewcomputers.org>)
* [RC2014](https://rc2014.co.uk) (<https://rc2014.co.uk>), \
[RC2014-Z80](https://groups.google.com/g/rc2014-z80)
(<https://groups.google.com/g/rc2014-z80>)
* [Retro Computing](https://groups.google.com/g/retro-comp)
(<https://groups.google.com/g/retro-comp>)
* [Small Computer Central](https://smallcomputercentral.com/)
(<https://smallcomputercentral.com/>)
A complete list of the currently supported platforms is found in
$doc_hardware$ .
`\clearpage`{=latex}
# Description
## Primary Features
By design, RomWBW isolates all of the hardware specific functions in
the ROM chip itself. The ROM provides a hardware abstraction layer
such that all of the operating systems and applications on a disk
will run on any RomWBW-based system. To put it simply, you can take
a disk (or CF/SD/USB Card) and move it between systems transparently.
Supported hardware features of RomWBW include:
* Z80 Family CPUs including Z80, Z180, and Z280
* Banked memory services for several banking designs
* Disk drivers for RAM, ROM, Floppy, IDE ATA/ATAPI, CF, SD, USB, Zip, Iomega
* Serial drivers including UART (16550-like), ASCI, ACIA, SIO
* Video drivers including TMS9918, SY6545, MOS8563, HD6445
* Keyboard (PS/2) drivers via VT8242 or PPI interfaces
* Real time clock drivers including DS1302, BQ4845
* Support for CP/NET networking using Wiznet, MT011 or Serial
* Built-in VT-100 terminal emulation support
A dynamic disk drive letter assignment mechanism allows mapping
operating system drive letters to any available disk media.
Additionally, mass storage devices (IDE Disk, CF Card, SD Card, etc.)
support the use of multiple slices (up to 256 per device). Each slice
contains a complete CP/M filesystem and can be mapped independently to
any drive letter. This overcomes the inherent size limitations in legacy
OSes and allows up to 2GB of addressable storage on a single device,
with up to 128MB accessible at any one time.
## Included Software
Multiple disk images are provided in the distribution. Most disk
images contain a complete, bootable, ready-to-run implementation of a
specific operating system. A "combo" disk image contains multiple
slices, each with a full operating system implementation. If you use
this disk image, you can easily pick whichever operating system you
want to boot without changing media.
Some of the included software:
* Operating Systems (CP/M 2.2, ZSDOS, NZ-COM, CP/M 3, ZPM3, Z3PLUS, QPM )
* Support for other operating systems, p-System, FreeRTOS, and FUZIX.
* Programming Tools (Z80ASM, Turbo Pascal, Forth, Cowgol)
* C Compiler's including Aztec-C, and HI-TECH C
* Microsoft Basic Compiler, and Microsoft Fortran
* Some games such as Colossal Cave, Zork, etc
* Wordstar Word processing software
Some of the provided software can be launched directly from the
ROM firmware itself:
* System Monitor
* Operating Systems (CP/M 2.2, ZSDOS)
* ROM BASIC (Nascom BASIC and Tasty BASIC)
* ROM Forth
A tool is provided that allows you to access a FAT-12/16/32 filesystem.
The FAT filesystem may be coresident on the same disk media as RomWBW
slices or on stand-alone media. This makes exchanging files with modern
OSes such as Windows, MacOS, and Linux very easy.
`\clearpage`{=latex}
## ROM Distribution
The [RomWBW Repository](https://github.com/wwarthen/RomWBW)
(<https://github.com/wwarthen/RomWBW>) on GitHub is the official
distribution location for all project source and documentation.
RomWBW is distributed as both source code and pre-built ROM and disk
images.
The pre-built ROM images distributed with RomWBW are based on
the default system configurations as determined by the hardware
provider/designer. The pre-built ROM firmware images are generally
suitable for most users.
The fully-built distribution releases are available on the
[RomWBW Releases Page](https://github.com/wwarthen/RomWBW/releases)
(<https://github.com/wwarthen/RomWBW/releases>) of the repository.
On this page, you will normally see a Development Snapshot as well as
recent stable releases. Unless you have a specific reason, I suggest you
stick to the most recent stable release.
The asset named RomWBW-vX.X.X-Package.zip includes all pre-built ROM
and Disk images as well as full source code. The other assets contain
only source code and do not have the pre-built ROM or disk images.
#### Distribution Directory Layout
The RomWBW distribution is a compressed zip archive file organized in
a set of directories. Each of these directories has its own
ReadMe.txt file describing the contents in detail. In summary, these
directories are:
| **Directory** | **Description** |
|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Binary** | The final output files of the build process are placed here. Most importantly, the ROM images with the file names ending in ".rom" and disk images ending in .img. |
| **Doc** | Contains various detailed documentation, both RomWBW specifically as well as the operating systems and applications. |
| **Source** | Contains the source code files used to build the software and ROM images. |
| **Tools** | Contains the programs that are used by the build process or that may be useful in setting up your system. |
`\clearpage`{=latex}
#### Building from Source
It is also very easy to modify and build custom ROM
images that fully tailor the firmware to your specific preferences.
All tools required to build custom ROM firmware under Windows are
included -- no need to install assemblers, etc. The firmware can also
be built using Linux or MacOS after confirming a few standard tools
have been installed.
## Installation & Operation
In general, installation of RomWBW on your platform is very simple. You
just need to program your ROM with the correct ROM image from the RomWBW
distribution. Subsequently, you can write disk images on your disk
drives (IDE disk, CF Card, SD Card, etc.) which then provides even more
functionality.
Complete instructions for installation and operation of RomWBW are found
in the $doc_user$. It is also a good idea to review the [Release
Notes](https://github.com/wwarthen/RomWBW/blob/master/RELEASE_NOTES.md)
for helpful release-specific information.
## Documentation
There are several documents that form the core of the RomWBW documentation:
* $doc_user$ is the main user guide for RomWBW, it covers the major topics
of how to install, manage and use RomWBW, and includes additional guidance
to the use of some of the operating systems supported by RomWBW
* $doc_hardware$ contains a description of all the hardware platforms,
and devices supported by RomWBW.
* $doc_apps$ is a reference for the ROM-hosted and OS-hosted applications
created or customized to enhance the operation of RomWBW.
* $doc_catalog$ is a reference for the contents of the disk images
provided with RomWBW, with a description of many of the files on each image
* $doc_sys$ discusses much of the internal design and construction
of RomWBW. It includes a reference for the RomWBW HBIOS API
functions.
Each of the operating systems and ROM applications included with RomWBW
are sophisticated tools in their own right. It is not reasonable to
fully document their usage. However, you will find complete manuals
in PDF format in the Doc directory of the distribution. The intention
of this documentation is to describe the operation of RomWBW and the ways in
which it enhances the operation of the included applications and
operating systems.
Since RomWBW is purely a software product for many different platforms,
the documentation does **not** cover hardware construction,
configuration, or troubleshooting -- please see your hardware provider
for this information.
# Support
## Getting Assistance
The best way to get assistance with RomWBW or any aspect of the
RetroBrew Computers projects is via one of the community forums:
* [RetroBrew Computers Forum](https://www.retrobrewcomputers.org/forum/)
* [RC2014 Google Group](https://groups.google.com/forum/#!forum/rc2014-z80)
* [retro-comp Google Group](https://groups.google.com/forum/#!forum/retro-comp)
Submission of issues and bugs are welcome at the
[RomWBW GitHub Repository](https://github.com/wwarthen/RomWBW).
Also feel free to email $doc_author$ at [$doc_authmail$](mailto:$doc_authmail$).
I am happy to provide support adapting RomWBW to new or modified systems
# Contributions
All source code and distributions are maintained on GitHub.
Contributions of all kinds to RomWBW are very welcome.
## Acknowledgments
I want to acknowledge that a great deal of the code and inspiration
for RomWBW has been provided by or derived from the work of others
in the RetroBrew Computers Community. I sincerely appreciate all of
their contributions. The list below is probably missing many names --
please let me know if I missed you!
* Andrew Lynch started it all when he created the N8VEM Z80 SBC
which became the first platform RomWBW supported. Some of his
original code can still be found in RomWBW.
* Dan Werner wrote much of the code from which RomWBW was originally
derived and he has always been a great source of knowledge and
advice.
* Douglas Goodall contributed code, time, testing, and advice in "the
early days". He created an entire suite of application programs to
enhance the use of RomWBW. Unfortunately, they have become unusable
due to internal changes within RomWBW. As of RomWBW 2.6, these
applications are no longer provided.
* Sergey Kiselev created several hardware platforms for RomWBW
including the very popular Zeta.
* David Giles created support for the Z180 CSIO which is now included
SD Card driver.
* Phil Summers contributed the Forth and BASIC adaptations in ROM, the
AY-3-8910 sound driver, DMA support, and a long list of general code
and documentation enhancements.
* Ed Brindley contributed some of the code that supports the RCBus
platform.
* Spencer Owen created the RC2014 series of hobbyist kit computers
which has exponentially increased RomWBW usage. Some of his kits
include RomWBW.
* Stephen Cousins has likewise created a series of hobbyist kit
computers at Small Computer Central and is distributing RomWBW
with many of them.
* Alan Cox has contributed some driver code and has provided a great
deal of advice.
* The CP/NET client files were developed by Douglas Miller.
* Phillip Stevens contributed support for FreeRTOS.
* Curt Mayer contributed the original Linux / MacOS build process.
* UNA BIOS and FDISK80 are the products of John Coffman.
* FLASH4 is a product of Will Sowerbutts.
* CLRDIR is a product of Max Scane.
* Tasty Basic is a product of Dimitri Theulings.
* Dean Netherton contributed eZ80 CPU support, the sound driver
interface, and the SN76489 sound driver.
* The RomWBW Disk Catalog document was produced by Mykl Orders.
* Rob Prouse has created many of the supplemental disk images
including Aztec C, HiTech C, SLR Z80ASM, Turbo Pascal, Microsoft
BASIC Compiler, Microsoft Fortran Compiler, and a Games
compendium.
* Martin R has provided substantial help reviewing and improving the
User Guide and Applications documents.
* Mark Pruden has made a wide variety of contributions including:
- significant content in the Disk Catalog and User Guide
- creation of the Introduction and Hardware documents
- Z3PLUS operating system disk image
- COPYSL utility
- SLABEL utility
- a feature for RomWBW configuration by NVRAM
- the /B bulk mode of disk assignment to the ASSIGN utility
* Jacques Pelletier has contributed the DS1501 RTC driver code.
* Jose Collado has contributed enhancements to the TMS driver
including compatibility with standard TMS register configuration.
* Kevin Boone has contributed a generic HBIOS date/time utility (WDATE).
* Matt Carroll has contributed a fix to XM.COM that corrects the
port specification when doing a send.
* Dean Jenkins enhanced the build process to accommodate the
Raspberry Pi 4.
* Tom Plano has contributed a new utility (HTALK) to allow talking
directly to HBIOS COM ports.
* Lars Nelson has contributed several generic utilities such as
a universal (OS agnostic) UNARC application.
* Dylan Hall added support for specifying a secondary console.
* Bill Shen has contributed boot loaders for several of his
systems.
* Laszlo Szolnoki has contributed an EF9345 video display
controller driver.
* Ladislau Szilagyi has contributed an enhanced version of
CP/M Cowgol that leverages RomWBW memory banking.
* Les Bird has contributed support for the NABU w/ Option Board
`\clearpage`{=latex}
## Related Projects
Outside of the hardware platforms adapted to RomWBW, there are a variety
of projects that either target RomWBW specifically or provide
a RomWBW-specific variation. These efforts are greatly appreciated
and are listed below. Please contact the author if there are any other
such projects that are not listed.
#### Z88DK
Z88DK is a software powerful development kit for Z80 computers
supporting both C and assembly language. This kit now provides
specific library support for RomWBW HBIOS. The Z88DK project is
hosted at <https://github.com/z88dk/z88dk>.
#### Paleo Editor
Steve Garcia has created a Windows-hosted IDE that is tailored to
development of RomWBW. The project can be found at
<https://github.com/alloidian/PaleoEditor>.
#### Z80 fig-FORTH
Dimitri Theulings' implementation of fig-FORTH for the Z80 has a
RomWBW-specific variant. The project is hosted at
<https://github.com/dimitrit/figforth>.
#### Assembly Language Programming for the RC2014 Zed
Bruce Hall has written a very nice document that describes how to
develop assembly language applications on RomWBW. It begins with the
setup and configuration of a new RC2014 Zed system running RomWBW.
It describes not only generic CP/M application development, but also
RomWBW HBIOS programming and bare metal programming. The latest copy
of this document is hosted at
[http://w8bh.net/Assembly for RC2014Z.pdf](http://w8bh.net/Assembly%20for%20RC2014Z.pdf).
# Licensing
## License Terms
RomWBW 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.
RomWBW 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 RomWBW. If not, see <https://www.gnu.org/licenses/>.
Portions of RomWBW were created by, contributed by, or derived from
the work of others. It is believed that these works are being used
in accordance with the intentions and/or licensing of their creators.
If anyone feels their work is being used outside of its intended
licensing, please notify:
> $doc_author$ \
> [$doc_authmail$](mailto:$doc_authmail$)
RomWBW is an aggregate work. It is composed of many individual,
standalone programs that are distributed as a whole to function as
a cohesive system. Each program may have its own licensing which
may be different from other programs within the aggregate.
In some cases, a single program (e.g., CP/M Operating System) is
composed of multiple components with different licenses. It is
believed that in all such cases the licenses are compatible with
GPL version 3.
RomWBW encourages code contributions from others. Contributors
may assert their own copyright in their contributions by
annotating the contributed source code appropriately. Contributors
are further encouraged to submit their contributions via the RomWBW
source code control system to ensure their contributions are clearly
documented.
All contributions to RomWBW are subject to this license.
$define{doc_title}{Introduction}$
$include{"Book.h"}$
# Overview
RomWBW software provides a complete, commercial quality
implementation of CP/M (and work-alike) operating systems and
applications for modern Z80/180/280 retro-computing hardware systems.
A wide variety of platforms are supported including those
produced by these developer communities:
* [RetroBrew Computers](https://www.retrobrewcomputers.org)
(<https://www.retrobrewcomputers.org>)
* [RC2014](https://rc2014.co.uk) (<https://rc2014.co.uk>), \
[RC2014-Z80](https://groups.google.com/g/rc2014-z80)
(<https://groups.google.com/g/rc2014-z80>)
* [Retro Computing](https://groups.google.com/g/retro-comp)
(<https://groups.google.com/g/retro-comp>)
* [Small Computer Central](https://smallcomputercentral.com/)
(<https://smallcomputercentral.com/>)
A complete list of the currently supported platforms is found in
$doc_hardware$ .
`\clearpage`{=latex}
# Description
## Primary Features
By design, RomWBW isolates all of the hardware specific functions in
the ROM chip itself. The ROM provides a hardware abstraction layer
such that all of the operating systems and applications on a disk
will run on any RomWBW-based system. To put it simply, you can take
a disk (or CF/SD/USB Card) and move it between systems transparently.
Supported hardware features of RomWBW include:
* Z80 Family CPUs including Z80, Z180, and Z280
* Banked memory services for several banking designs
* Disk drivers for RAM, ROM, Floppy, IDE ATA/ATAPI, CF, SD, USB, Zip, Iomega
* Serial drivers including UART (16550-like), ASCI, ACIA, SIO
* Video drivers including TMS9918, SY6545, MOS8563, HD6445, Xosera
* Keyboard (PS/2) drivers via VT8242 or PPI interfaces
* Real time clock drivers including DS1302, BQ4845
* Support for CP/NET networking using Wiznet, MT011 or Serial
* Built-in VT-100 terminal emulation support
A dynamic disk drive letter assignment mechanism allows mapping
operating system drive letters to any available disk media.
Additionally, mass storage devices (IDE Disk, CF Card, SD Card, etc.)
support the use of multiple slices (up to 256 per device). Each slice
contains a complete CP/M filesystem and can be mapped independently to
any drive letter. This overcomes the inherent size limitations in legacy
OSes and allows up to 2GB of addressable storage on a single device,
with up to 128MB accessible at any one time.
## Included Software
Multiple disk images are provided in the distribution. Most disk
images contain a complete, bootable, ready-to-run implementation of a
specific operating system. A "combo" disk image contains multiple
slices, each with a full operating system implementation. If you use
this disk image, you can easily pick whichever operating system you
want to boot without changing media.
Some of the included software:
* Operating Systems (CP/M 2.2, ZSDOS, NZ-COM, CP/M 3, ZPM3, Z3PLUS, QPM )
* Support for other operating systems, p-System, FreeRTOS, and FUZIX.
* Programming Tools (Z80ASM, Turbo Pascal, Forth, Cowgol)
* C Compiler's including Aztec-C, and HI-TECH C
* Microsoft Basic Compiler, and Microsoft Fortran
* Some games such as Colossal Cave, Zork, etc
* Wordstar Word processing software
Some of the provided software can be launched directly from the
ROM firmware itself:
* System Monitor
* Operating Systems (CP/M 2.2, ZSDOS)
* ROM BASIC (Nascom BASIC and Tasty BASIC)
* ROM Forth
A tool is provided that allows you to access a FAT-12/16/32 filesystem.
The FAT filesystem may be coresident on the same disk media as RomWBW
slices or on stand-alone media. This makes exchanging files with modern
OSes such as Windows, MacOS, and Linux very easy.
`\clearpage`{=latex}
## ROM Distribution
The [RomWBW Repository](https://github.com/wwarthen/RomWBW)
(<https://github.com/wwarthen/RomWBW>) on GitHub is the official
distribution location for all project source and documentation.
RomWBW is distributed as both source code and pre-built ROM and disk
images.
The pre-built ROM images distributed with RomWBW are based on
the default system configurations as determined by the hardware
provider/designer. The pre-built ROM firmware images are generally
suitable for most users.
The fully-built distribution releases are available on the
[RomWBW Releases Page](https://github.com/wwarthen/RomWBW/releases)
(<https://github.com/wwarthen/RomWBW/releases>) of the repository.
On this page, you will normally see a Development Snapshot as well as
recent stable releases. Unless you have a specific reason, I suggest you
stick to the most recent stable release.
The asset named RomWBW-vX.X.X-Package.zip includes all pre-built ROM
and Disk images as well as full source code. The other assets contain
only source code and do not have the pre-built ROM or disk images.
#### Distribution Directory Layout
The RomWBW distribution is a compressed zip archive file organized in
a set of directories. Each of these directories has its own
ReadMe.txt file describing the contents in detail. In summary, these
directories are:
| **Directory** | **Description** |
|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Binary** | The final output files of the build process are placed here. Most importantly, the ROM images with the file names ending in ".rom" and disk images ending in .img. |
| **Doc** | Contains various detailed documentation, both RomWBW specifically as well as the operating systems and applications. |
| **Source** | Contains the source code files used to build the software and ROM images. |
| **Tools** | Contains the programs that are used by the build process or that may be useful in setting up your system. |
`\clearpage`{=latex}
#### Building from Source
It is also very easy to modify and build custom ROM
images that fully tailor the firmware to your specific preferences.
All tools required to build custom ROM firmware under Windows are
included -- no need to install assemblers, etc. The firmware can also
be built using Linux or MacOS after confirming a few standard tools
have been installed.
## Installation & Operation
In general, installation of RomWBW on your platform is very simple. You
just need to program your ROM with the correct ROM image from the RomWBW
distribution. Subsequently, you can write disk images on your disk
drives (IDE disk, CF Card, SD Card, etc.) which then provides even more
functionality.
Complete instructions for installation and operation of RomWBW are found
in the $doc_user$. It is also a good idea to review the [Release
Notes](https://github.com/wwarthen/RomWBW/blob/master/RELEASE_NOTES.md)
for helpful release-specific information.
## Documentation
There are several documents that form the core of the RomWBW documentation:
* $doc_user$ is the main user guide for RomWBW, it covers the major topics
of how to install, manage and use RomWBW, and includes additional guidance
to the use of some of the operating systems supported by RomWBW
* $doc_hardware$ contains a description of all the hardware platforms,
and devices supported by RomWBW.
* $doc_apps$ is a reference for the ROM-hosted and OS-hosted applications
created or customized to enhance the operation of RomWBW.
* $doc_catalog$ is a reference for the contents of the disk images
provided with RomWBW, with a description of many of the files on each image
* $doc_sys$ discusses much of the internal design and construction
of RomWBW. It includes a reference for the RomWBW HBIOS API
functions.
An online HTML version of this documentation is hosted at
<https://wwarthen.github.io/RomWBW>.
Each of the operating systems and ROM applications included with RomWBW
are sophisticated tools in their own right. It is not reasonable to
fully document their usage. However, you will find complete manuals
in PDF format in the Doc directory of the distribution. The intention
of this documentation is to describe the operation of RomWBW and the ways in
which it enhances the operation of the included applications and
operating systems.
Since RomWBW is purely a software product for many different platforms,
the documentation does **not** cover hardware construction,
configuration, or troubleshooting -- please see your hardware provider
for this information.
# Support
## Getting Assistance
The best way to get assistance with RomWBW or any aspect of the
RetroBrew Computers projects is via one of the community forums:
* [RetroBrew Computers Forum](https://www.retrobrewcomputers.org/forum/)
* [RC2014 Google Group](https://groups.google.com/forum/#!forum/rc2014-z80)
* [retro-comp Google Group](https://groups.google.com/forum/#!forum/retro-comp)
Submission of issues and bugs are welcome at the
[RomWBW GitHub Repository](https://github.com/wwarthen/RomWBW).
Also feel free to email $doc_author$ at [$doc_authmail$](mailto:$doc_authmail$).
I am happy to provide support adapting RomWBW to new or modified systems
# Contributions
All source code and distributions are maintained on GitHub.
Contributions of all kinds to RomWBW are very welcome.
## Acknowledgments
I want to acknowledge that a great deal of the code and inspiration
for RomWBW has been provided by or derived from the work of others
in the RetroBrew Computers Community. I sincerely appreciate all of
their contributions. The list below is probably missing many names --
please let me know if I missed you!
* Andrew Lynch started it all when he created the N8VEM Z80 SBC
which became the first platform RomWBW supported. Some of his
original code can still be found in RomWBW.
* Dan Werner wrote much of the code from which RomWBW was originally
derived and he has always been a great source of knowledge and
advice.
* Douglas Goodall contributed code, time, testing, and advice in "the
early days". He created an entire suite of application programs to
enhance the use of RomWBW. Unfortunately, they have become unusable
due to internal changes within RomWBW. As of RomWBW 2.6, these
applications are no longer provided.
* Sergey Kiselev created several hardware platforms for RomWBW
including the very popular Zeta.
* David Giles created support for the Z180 CSIO which is now included
SD Card driver.
* Phil Summers contributed the Forth and BASIC adaptations in ROM, the
AY-3-8910 sound driver, DMA support, and a long list of general code
and documentation enhancements.
* Ed Brindley contributed some of the code that supports the RCBus
platform.
* Spencer Owen created the RC2014 series of hobbyist kit computers
which has exponentially increased RomWBW usage. Some of his kits
include RomWBW.
* Stephen Cousins has likewise created a series of hobbyist kit
computers at Small Computer Central and is distributing RomWBW
with many of them.
* Alan Cox has contributed some driver code and has provided a great
deal of advice.
* The CP/NET client files were developed by Douglas Miller.
* Phillip Stevens contributed support for FreeRTOS.
* Curt Mayer contributed the original Linux / MacOS build process.
* UNA BIOS and FDISK80 are the products of John Coffman.
* FLASH4 is a product of Will Sowerbutts.
* CLRDIR is a product of Max Scane.
* Tasty Basic is a product of Dimitri Theulings.
* Dean Netherton contributed multiple components:
- eZ80 CPU support
- Sound driver infrastructure
- SN76489 sound driver
- Native USB driver (keyboard, floppy, mass storage)
* The RomWBW Disk Catalog document was produced by Mykl Orders.
* Rob Prouse has created many of the supplemental disk images
including Aztec C, HiTech C, SLR Z80ASM, Turbo Pascal, Microsoft
BASIC Compiler, Microsoft Fortran Compiler, and a Games
compendium.
* Martin R has provided substantial help reviewing and improving the
User Guide and Applications documents.
* Mark Pruden has made a wide variety of contributions including:
- significant content in the Disk Catalog and User Guide
- creation of the Introduction and Hardware documents
- Z3PLUS operating system disk image
- Infocom text adventure game disk image
- COPYSL, and SLABEL utilities
- Display of bootable slices via "S" command during startup
- Optimisations of HBIOS and CBIOS to reduce overall code size
- a feature for RomWBW configuration by NVRAM
- the /B bulk mode of disk assignment to the ASSIGN utility
* Jacques Pelletier has contributed the DS1501 RTC driver code.
* Jose Collado has contributed enhancements to the TMS driver
including compatibility with standard TMS register configuration.
* Kevin Boone has contributed a generic HBIOS date/time utility (WDATE).
* Matt Carroll has contributed a fix to XM.COM that corrects the
port specification when doing a send.
* Dean Jenkins enhanced the build process to accommodate the
Raspberry Pi 4.
* Tom Plano has contributed a new utility (HTALK) to allow talking
directly to HBIOS COM ports.
* Lars Nelson has contributed several generic utilities such as
a universal (OS agnostic) UNARC application.
* Dylan Hall added support for specifying a secondary console.
* Bill Shen has contributed boot loaders for several of his
systems.
* Laszlo Szolnoki has contributed an EF9345 video display
controller driver.
* Ladislau Szilagyi has contributed an enhanced version of
CP/M Cowgol that leverages RomWBW memory banking.
* Les Bird has contributed support for the NABU w/ Option Board
* Rob Gowin created an online documentation site via MkDocs, and
contributed a driver for the Xosera FPGA-based video
controller.
* Jörg Linder has contributed disassembled and nicely commented
source for ZSDOS2 and the BPBIOS utilities.
`\clearpage`{=latex}
## Related Projects
Outside of the hardware platforms adapted to RomWBW, there are a variety
of projects that either target RomWBW specifically or provide
a RomWBW-specific variation. These efforts are greatly appreciated
and are listed below. Please contact the author if there are any other
such projects that are not listed.
#### Z88DK
Z88DK is a software powerful development kit for Z80 computers
supporting both C and assembly language. This kit now provides
specific library support for RomWBW HBIOS. The Z88DK project is
hosted at <https://github.com/z88dk/z88dk>.
#### Paleo Editor
Steve Garcia has created a Windows-hosted IDE that is tailored to
development of RomWBW. The project can be found at
<https://github.com/alloidian/PaleoEditor>.
#### Z80 fig-FORTH
Dimitri Theulings' implementation of fig-FORTH for the Z80 has a
RomWBW-specific variant. The project is hosted at
<https://github.com/dimitrit/figforth>.
#### Assembly Language Programming for the RC2014 Zed
Bruce Hall has written a very nice document that describes how to
develop assembly language applications on RomWBW. It begins with the
setup and configuration of a new RC2014 Zed system running RomWBW.
It describes not only generic CP/M application development, but also
RomWBW HBIOS programming and bare metal programming. The latest copy
of this document is hosted at
[http://w8bh.net/Assembly for RC2014Z.pdf](http://w8bh.net/Assembly%20for%20RC2014Z.pdf).
# Licensing
## License Terms
RomWBW 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.
RomWBW 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 RomWBW. If not, see <https://www.gnu.org/licenses/>.
Portions of RomWBW were created by, contributed by, or derived from
the work of others. It is believed that these works are being used
in accordance with the intentions and/or licensing of their creators.
If anyone feels their work is being used outside of its intended
licensing, please notify:
> $doc_author$ \
> [$doc_authmail$](mailto:$doc_authmail$)
RomWBW is an aggregate work. It is composed of many individual,
standalone programs that are distributed as a whole to function as
a cohesive system. Each program may have its own licensing which
may be different from other programs within the aggregate.
In some cases, a single program (e.g., CP/M Operating System) is
composed of multiple components with different licenses. It is
believed that in all such cases the licenses are compatible with
GPL version 3.
RomWBW encourages code contributions from others. Contributors
may assert their own copyright in their contributions by
annotating the contributed source code appropriately. Contributors
are further encouraged to submit their contributions via the RomWBW
source code control system to ensure their contributions are clearly
documented.
All contributions to RomWBW are subject to this license.

18
Source/Doc/Makefile

@ -18,6 +18,10 @@ include $(TOOLS)/Makefile.inc
all :: deploy
clean ::
rm -rf mkdocs
rm -rf site
%.tmp : %.md
gpp -o $@ -U "$$" "$$" "{" "}{" "}$$" "{" "}" "@@@" "" -M "$$" "$$" "{" "}{" "}$$" "{" "}" $<
@ -31,11 +35,16 @@ all :: deploy
pandoc $< -f markdown -t dokuwiki -s -o $@ --default-image-extension=pdf
%.gfm : %.tmp
pandoc $< -f markdown -t gfm-yaml_metadata_block -s -o $@ --default-image-extension=pdf
pandoc $< -f markdown -t gfm-yaml_metadata_block -s -o $@ --default-image-extension=svg
%.txt : %.tmp
pandoc $< -f markdown -t plain -s -o $@ --default-image-extension=pdf
mkdocs/%.md : %.md
-mkdir -p mkdocs
gpp -DGFM -U "$$" "$$" "{" "}{" "}$$" "{" "}" "@@@" "" -M "$$" "$$" "{" "}{" "}$$" "{" "}" $< \
| pandoc -f markdown -t gfm-yaml_metadata_block -s -o $@ --default-image-extension=svg
deploy :
cp Introduction.gfm "../../ReadMe.md"
cp Introduction.txt "../../ReadMe.txt"
@ -45,3 +54,10 @@ deploy :
cp Applications.pdf "../../Doc/RomWBW Applications.pdf"
cp Catalog.pdf "../../Doc/RomWBW Disk Catalog.pdf"
cp Hardware.pdf "../../Doc/RomWBW Hardware.pdf"
deploy_mkdocs : mkdocs/Introduction.md mkdocs/UserGuide.md mkdocs/SystemGuide.md mkdocs/Applications.md \
mkdocs/Catalog.md mkdocs/Hardware.md
mkdir -p mkdocs/UserGuide/Graphics mkdocs/SystemGuide/Graphics
cp mkdocs/Introduction.md mkdocs/README.md
cp Graphics/*.svg mkdocs/UserGuide/Graphics
cp Graphics/*.svg mkdocs/SystemGuide/Graphics

296
Source/Doc/ReadMe.md

@ -1,296 +0,0 @@
$define{doc_title}{ReadMe}$
$include{"Basic.h"}$
# Overview
RomWBW software provides a complete, commercial quality
implementation of CP/M (and workalike) operating systems and
applications for modern Z80/180/280 retro-computing hardware systems.
A wide variety of platforms are supported including those
produced by these developer communities:
* [RetroBrew Computers](https://www.retrobrewcomputers.org)
(<https://www.retrobrewcomputers.org>)
* [RC2014](https://rc2014.co.uk) (<https://rc2014.co.uk>), \
[RC2014-Z80](https://groups.google.com/g/rc2014-z80)
(<https://groups.google.com/g/rc2014-z80>)
* [Retro Computing](https://groups.google.com/g/retro-comp)
(<https://groups.google.com/g/retro-comp>)
* [Small Computer Central](https://smallcomputercentral.com/)
(<https://smallcomputercentral.com/>)
A complete list of the currently supported platforms is found in the
[Installation] section.
Supported hardware features of RomWBW include:
* Z80 Family CPUs including Z80, Z180, and Z280
* Banked memory services for several banking designs
* Disk drivers for RAM, ROM, Floppy, IDE ATA/ATAPI, CF, SD, USB, Zip, Iomega
* Serial drivers including UART (16550-like), ASCI, ACIA, SIO
* Video drivers including TMS9918, SY6545, MOS8563, HD6445
* Keyboard (PS/2) drivers via VT8242 or PPI interfaces
* Real time clock drivers including DS1302, BQ4845
* Support for CP/NET networking using Wiznet, MT011 or Serial
* Built-in VT-100 terminal emulation support
RomWBW is distributed as both source code and pre-built ROM and disk
images. Some of the provided software can be launched directly from the
ROM firmware itself:
* System Monitor
* Operating Systems (CP/M 2.2, ZSDOS)
* ROM BASIC (Nascom BASIC and Tasty BASIC)
* ROM Forth
A dynamic disk drive letter assignment mechanism allows mapping
operating system drive letters to any available disk media.
Additionally, mass storage devices (IDE Disk, CF Card, SD Card, etc.)
support the use of multiple slices (up to 256 per device). Each slice
contains a complete CP/M filesystem and can be mapped independently to
any drive letter. This overcomes the inherent size limitations in legacy
OSes and allows up to 2GB of accessible storage on a single device,
with up to 128MB accessible at any one time.
The pre-built ROM firmware images are generally suitable for most
users. However, it is also very easy to modify and build custom ROM
images that fully tailor the firmware to your specific preferences.
All tools required to build custom ROM firmware under Windows are
included -- no need to install assemblers, etc. The firmware can also
be built using Linux or MacOS after confirming a few standard tools
have been installed.
Multiple disk images are provided in the distribution. Most disk
images contain a complete, bootable, ready-to-run implementation of a
specific operating system. A "combo" disk image contains multiple
slices, each with a full operating system implementation. If you use
this disk image, you can easily pick whichever operating system you
want to boot without changing media.
By design, RomWBW isolates all of the hardware specific functions in
the ROM chip itself. The ROM provides a hardware abstraction layer
such that all of the operating systems and applications on a disk
will run on any RomWBW-based system. To put it simply, you can take
a disk (or CF/SD/USB Card) and move it between systems transparently.
A tool is provided that allows you to access a FAT-12/16/32 filesystem.
The FAT filesystem may be coresident on the same disk media as RomWBW
slices or on stand-alone media. This makes exchanging files with modern
OSes such as Windows, MacOS, and Linux very easy.
# Acquiring RomWBW
The [RomWBW Repository](https://github.com/wwarthen/RomWBW)
(<https://github.com/wwarthen/RomWBW>) on GitHub is the official
distribution location for all project source and documentation.
The fully-built distribution releases are available on the
[RomWBW Releases Page](https://github.com/wwarthen/RomWBW/releases)
(<https://github.com/wwarthen/RomWBW/releases>) of the repository.
On this page, you will normally see a Development Snapshot as well as
recent stable releases. Unless you have a specific reason, I suggest you
stick to the most recent stable release.
The asset named RomWBW-vX.X.X-Package.zip includes all pre-built ROM
and Disk images as well as full source code. The other assets contain
only source code and do not have the pre-built ROM or disk images.
All source code and distributions are maintained on GitHub. Code
contributions are very welcome.
# Installation & Operation
In general, installation of RomWBW on your platform is very simple. You
just need to program your ROM with the correct ROM image from the RomWBW
distribution. Subsequently, you can write disk images on your disk
drives (IDE disk, CF Card, SD Card, etc.) which then provides even more
functionality.
Complete instructions for installation and operation of RomWBW are
found in the $doc_user$. It is also a good idea to review the
[Release Notes](https://github.com/wwarthen/RomWBW/blob/master/RELEASE_NOTES.md)
for helpful release-specific information.
## Documentation
Documentation for $doc_product$ includes:
* $doc_intro$
* $doc_user$
* $doc_sys$
* $doc_apps$
* $doc_catalog$
* $doc_hardware$
# Acknowledgments
I want to acknowledge that a great deal of the code and inspiration
for RomWBW has been provided by or derived from the work of others
in the RetroBrew Computers Community. I sincerely appreciate all of
their contributions. The list below is probably missing many names --
please let me know if I missed you!
* Andrew Lynch started it all when he created the N8VEM Z80 SBC
which became the first platform RomWBW supported. Some of his
original code can still be found in RomWBW.
* Dan Werner wrote much of the code from which RomWBW was originally
derived and he has always been a great source of knowledge and
advice.
* Douglas Goodall contributed code, time, testing, and advice in "the
early days". He created an entire suite of application programs to
enhance the use of RomWBW. Unfortunately, they have become unusable
due to internal changes within RomWBW. As of RomWBW 2.6, these
applications are no longer provided.
* Sergey Kiselev created several hardware platforms for RomWBW
including the very popular Zeta.
* David Giles created support for the Z180 CSIO which is now included
SD Card driver.
* Phil Summers contributed the Forth and BASIC adaptations in ROM, the
AY-3-8910 sound driver, DMA support, and a long list of general code
and documentation enhancements.
* Ed Brindley contributed some of the code that supports the RCBus
platform.
* Spencer Owen created the RC2014 series of hobbyist kit computers
which has exponentially increased RomWBW usage. Some of his kits
include RomWBW.
* Stephen Cousins has likewise created a series of hobbyist kit
computers at Small Computer Central and is distributing RomWBW
with many of them.
* Alan Cox has contributed some driver code and has provided a great
deal of advice.
* The CP/NET client files were developed by Douglas Miller.
* Phillip Stevens contributed support for FreeRTOS.
* Curt Mayer contributed the original Linux / MacOS build process.
* UNA BIOS and FDISK80 are the products of John Coffman.
* FLASH4 is a product of Will Sowerbutts.
* CLRDIR is a product of Max Scane.
* Tasty Basic is a product of Dimitri Theulings.
* Dean Netherton contributed eZ80 CPU support, the sound driver
interface, and the SN76489 sound driver.
* The RomWBW Disk Catalog document was produced by Mykl Orders.
* Rob Prouse has created many of the supplemental disk images
including Aztec C, HiTech C, SLR Z80ASM, Turbo Pascal, Microsoft
BASIC Compiler, Microsoft Fortran Compiler, and a Games
compendium.
* Martin R has provided substantial help reviewing and improving the
User Guide and Applications documents.
* Mark Pruden has made a wide variety of contributions including:
- significant content in the Disk Catalog and User Guide
- creation of the Introduction and Hardware documents
- Z3PLUS operating system disk image
- COPYSL and SLABEL utility
- a feature for RomWBW configuration by NVRAM
- the /B bulk mode of disk assignment to the ASSIGN utility
* Jacques Pelletier has contributed the DS1501 RTC driver code.
* Jose Collado has contributed enhancements to the TMS driver
including compatibility with standard TMS register configuration.
* Kevin Boone has contributed a generic HBIOS date/time utility (WDATE).
* Matt Carroll has contributed a fix to XM.COM that corrects the
port specification when doing a send.
* Dean Jenkins enhanced the build process to accommodate the
Raspberry Pi 4.
* Tom Plano has contributed a new utility (HTALK) to allow talking
directly to HBIOS COM ports.
* Lars Nelson has contributed several generic utilities such as
a universal (OS agnostic) UNARC application.
* Dylan Hall added support for specifying a secondary console.
* Bill Shen has contributed boot loaders for several of his
systems.
* Laszlo Szolnoki has contributed an EF9345 video display
controller driver.
* Ladislau Szilagyi has contributed an enhanced version of
CP/M Cowgol that leverages RomWBW memory banking.
* Les Bird has contributed support for the NABU w/ Option Board
Contributions of all kinds to RomWBW are very welcome.
# Licensing
RomWBW 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.
RomWBW 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 RomWBW. If not, see <https://www.gnu.org/licenses/>.
Portions of RomWBW were created by, contributed by, or derived from
the work of others. It is believed that these works are being used
in accordance with the intentions and/or licensing of their creators.
If anyone feels their work is being used outside of its intended
licensing, please notify:
> $doc_author$ \
> [$doc_authmail$](mailto:$doc_authmail$)
RomWBW is an aggregate work. It is composed of many individual,
standalone programs that are distributed as a whole to function as
a cohesive system. Each program may have its own licensing which
may be different from other programs within the aggregate.
In some cases, a single program (e.g., CP/M Operating System) is
composed of multiple components with different licenses. It is
believed that in all such cases the licenses are compatible with
GPL version 3.
RomWBW encourages code contributions from others. Contributors
may assert their own copyright in their contributions by
annotating the contributed source code appropriately. Contributors
are further encouraged to submit their contributions via the RomWBW
source code control system to ensure their contributions are clearly
documented.
All contributions to RomWBW are subject to this license.
# Getting Assistance
The best way to get assistance with RomWBW or any aspect of the
RetroBrew Computers projects is via one of the community forums:
* [RetroBrew Computers Forum](https://www.retrobrewcomputers.org/forum/)
* [RC2014 Google Group](https://groups.google.com/forum/#!forum/rc2014-z80)
* [retro-comp Google Group](https://groups.google.com/forum/#!forum/retro-comp)
Submission of issues and bugs are welcome at the
[RomWBW GitHub Repository](https://github.com/wwarthen/RomWBW).
Also feel free to email $doc_author$ at [$doc_authmail$](mailto:$doc_authmail$).

98
Source/Doc/SystemGuide.md

@ -142,6 +142,14 @@ currently selected. The upper 32KB is "fixed". This area of memory
is never swapped out and is used to contain software and operating
systems that must remain in the Z80 address space.
Throughout this document, this mechanism of selecting banks of memory
into the lower 32K is referred to as memory management. Achieving
this functionality requires some type of hardware which is generally
referred to as the system's Memory Management Unit (MMU). RomWBW
supports a variety of MMUs -- but they all perform the same function
of swapping in/out banks of memory in the lower 32K of CPU address
space.
Figure 4.1 depicts the memory layout for a system running the CP/M
operating system. Applications residing in TPA invoke BDOS services
of CP/M, BDOS invokes the custom CBIOS APIs, and finally CBIOS
@ -290,6 +298,62 @@ Common Bank:
It is a fixed mapping that is never changed in normal RomWBW operation
hence the name "Common".
## Memory Managers
The following hardware memory managers are supported by RomWBW. The
operation of these memory managers is not documented here -- please
refer to the documentation of your hardware provider for that.
Z2:
: Memory memory manager introduced by Sergey Kiselv in the Zeta 2 SBC.
Popular in many RCBus systems.
Z180:
: Memory manager built into the Z180 CPU
Z280:
: Memory manager built into the Z280 CPU
ZRC:
: Memory manager onboard the ZRC series of computers by Bill Shen.
SBC:
: Memory manager onboard the N8VEM SBC series of computers by
Andrew Lynch.
MBC:
: Memory manager onboard the Nhyodyne computer system by Andrew Lynch.
N8:
: Memory manager onboard the N8 SBC computer by Andrew Lynch.
EZ512:
: Memory manager onboard the EaZy80-512 Z80 CPU Module by Bill Shen.
RPH:
: Memory manager onboard the Rhyophyre computer system by Andrew Lynch.
The memory manager used is determined by the configuration choices
that are part of a RomWBW build process. A given ROM can only have a
single memory manager -- it is not selected dynamically.
The configuration variable `MEMMGR` sets the memory mannager used by
the ROM build. It must be set to one of the above memory manager
types. For example, for the Z2 memory manager, `MEMMGR` should be set
to `MM_Z2`.
Note that the term memory manager (MM) and memory management unit (MMU)
are used interchangeably in the documentation and code.
# Disk Layout
## Floppy Disk Layout
@ -1024,6 +1088,7 @@ below enumerates their values.
| DIODEV_SYQ | 0x0C | Syquest Sparq Disk | syq.asm |
| DIODEV_CHUSB | 0x0D | CH375/376 USB Disk | ch.asm |
| DIODEV_CHSD | 0x0E | CH375/376 SD Card | ch.asm |
| DIODEV_USB | 0x0F | CH376 Native USB Device | ch376.asm |
A fixed set of media types are defined. The currently defined media
types identifiers are listed below. Each driver will support one or
@ -1352,6 +1417,7 @@ unit. The table below enumerates these values.
| RTCDEV_DS7 | 0x04 | Maxim DS1307 PCF I2C RTC w/ NVRAM | ds7rtc.asm |
| RTCDEV_RP5 | 0x05 | Ricoh RPC01A Real-Time Clock w/ NVRAM | rp5rtc.asm |
| RTCDEV_EZ80 | 0x07 | eZ80 on-chip RTC | ez80rtc.asm |
| RTCDEV_PC | 0x08 | MC146818/DS1285/DS12885 RTC w/ NVRAM | pcrtc.asm |
The time functions to get and set the time (RTCGTM and RTCSTM) require a
6 byte date/time buffer in the following format. Each byte is BCD
@ -1700,14 +1766,17 @@ All video units are assigned a Device Type ID which indicates
the specific hardware device driver that handles the unit. The table
below enumerates their values.
| **Device Type** | **ID** | **Description** | **Driver** |
|-----------------|-------:|------------------------------------------|------------|
| VDADEV_VDU | 0x00 | MC6845 Family Video Display Controller | vdu.asm |
| VDADEV_CVDU | 0x01 | MC8563-based Video Display Controller | cvdu.asm |
| VDADEV_GDC | 0x02 | uPD7220 Video Display Controller | gdc.asm |
| VDADEV_TMS | 0x03 | TMS9918/38/58 Video Display Controller | tms.asm |
| VDADEV_VGA | 0x04 | HD6445CP4-based Video Display Controller | vga.asm |
| VDADEV_VRC | 0x05 | VGARC | vrc.asm |
| **Device Type** | **ID** | **Description** | **Driver** |
|-----------------|-------:|--------------------------------------------|------------|
| VDADEV_VDU | 0x00 | MC6845 Family Video Display Controller | vdu.asm |
| VDADEV_CVDU | 0x01 | MC8563-based Video Display Controller | cvdu.asm |
| VDADEV_GDC | 0x02 | uPD7220 Video Display Controller | gdc.asm |
| VDADEV_TMS | 0x03 | TMS9918/38/58 Video Display Controller | tms.asm |
| VDADEV_VGA | 0x04 | HD6445CP4-based Video Display Controller | vga.asm |
| VDADEV_VRC | 0x05 | VGARC | vrc.asm |
| VDADEV_EF | 0x06 | EF9345 | ef.asm |
| VDADEV_FV | 0x07 | S100 FPGA VGA | fv.asm |
| VDADEV_XOSERA | 0x08 | Xosera FPGA-based Video Display Controller | xosera.asm |
Depending on the capabilities of the hardware, the use of colors and
attributes may or may not be supported. If the hardware does not support
@ -2208,16 +2277,16 @@ using values that correspond to musical notes. The frequency will be
applied when the next SNDPLAY function is invoked. The returned Status
(A) is a standard HBIOS result code.
The Note (HL) values correspond to quarter notes. Increasing/decreasing
the value by 4 results in a full note increment/decrement.
The Note (HL) values correspond to eighth tones. Increasing/decreasing
the value by 8 results in a full tone increment/decrement.
Increasing/decreasing the value by 48 results in a full octave
increment/decrement. The value 0 corresponds to Bb/A# in octave 0.
The sound chip resolution and its oscillator limit the range and
accuracy of the notes played. The typical range of the AY-3-8910 is six
octaves: Bb2/A#2 to A7, where each value is a unique tone. Values above
and below can still be played but each quarter tone step may not result
in a note change.
and below can still be played but each eighth tone step may not result
in a tone change.
The following table shows the mapping of the Note (HL) value to the
corresponding octave and note.
@ -2436,9 +2505,8 @@ If the Unit specified is not a hard disk the Media ID will be returned and
the slice parameter ignored. If there is no media in device, or the slice
number is invaid (Parameter Out Of Range) the function will return an error status.
**NOTE:
This function was placed in HBIOS to be shared between the diffeent CP/M
varients supported by RomWBW. It is not strictly a BIOS function,
**NOTE:** This function was placed in HBIOS to be shared between the different CP/M
variants supported by RomWBW. It is not strictly a BIOS function,
and may be moved in future.
`\clearpage`{=latex}

109
Source/Doc/UserGuide.md

@ -340,14 +340,16 @@ enter the command followed by ***\<enter\>***.
For example, typing `H<enter>` will display a short command summary:
```
Boot [H=Help]: h
Boot [H=Help]: H
L - List ROM Applications
D - Device Inventory
S - Slice Inventory
R - Reboot System
W - RomWBW Configure
I <u> [<c>] - Set Console Interface/Baud Rate
V [<n>] - View/Set HBIOS Diagnostic Verbosity
N - Network Boot
<u>[.<s>] - Boot Disk Unit/Slice
```
@ -366,7 +368,6 @@ ROM Applications:
B: BASIC
T: Tasty BASIC
P: Play a Game
N: Network Boot
X: XModem Flash Updater
U: User App
```
@ -410,7 +411,6 @@ prompt:
| BASIC | Microsoft ROM BASIC |
| Tasty&nbsp;BASIC | Dimitri Theuling's Tiny BASIC implementation |
| Play | A simple video game (requires ANSI terminal emulation) |
| Network&nbsp;Boot | Boot system via Wiznet MT011 device |
| Flash&nbsp;Update | Upload and flash a new ROMWBW image using xmodem |
| User App | User written application placeholder |
@ -992,10 +992,10 @@ whether you boot your OS from ROM or from the disk media itself.
## Drive Letter Assignment
In legacy CP/M operating systems only 16 drive letters (A:-P:) available
to be assigned to disks Drive letters were generally mapped to disk
In CP/M operating systems only 16 drive letters (A:-P:) available
to be assigned to disks Drive letters were generally mapped to disk
drives in a completely fixed way. For example, drive A: would **always**
refer to the first floppy disk drive.
refer to the first floppy disk drive.
RomWBW implements a much more flexible drive letter assignment mechanism
so that any drive letter can dynamically be assigned to any disk device,
@ -1188,8 +1188,8 @@ media, you can use the CP/M 2.2 `STAT` command to display information
including the number of "32 Byte Directory Entries"
for a drive letter on the corresponding hard disk.
- If it indicates 512, your disk layout is legacy (hd512).
- If it indicates 1024, your disk layout is modern (hd1k).
- If it indicates 512, your disk layout is Classic (hd512).
- If it indicates 1024, your disk layout is Modern (hd1k).
Here is an example of checking the disk layout.
@ -1335,14 +1335,14 @@ system.
Two hard disk layout schemes exist:
* Modern (hd1k)
* Legacy (hd512)
* Classic (hd512)
You **cannot** mix disk layouts on a single disk device,
however It is perfectly fine for one system to have
multiple hard disks with different layouts -- each physical disk
device is handled separately.
If you are setting up a new disk, the modern (hd1k) layout is
If you are setting up a new disk, the Modern (hd1k) layout is
recommended for the following reasons:
* Larger number of directory entries per filesystem
@ -1350,8 +1350,8 @@ recommended for the following reasons:
* Reduces chances of data corruption
* Each slice occupies exactly 8MB (an exact power of 2) in size
Both the legacy and modern disk layouts continue to be fully supported
by RomWBW. There are no plans to deprecate the legacy layout.
Both the classic and modern disk layouts continue to be fully supported
by RomWBW. There are no plans to deprecate the classic layout.
#### Modern Layout
@ -1368,14 +1368,14 @@ RomWBW does not support extended partitions -- only a single
primary partition can be used.
The existence of a partition table entry for RomWBW on
a hard disk makes it behave in the modern mode. Removing the RomWBW
partition entry from a modern hard disk layout
a hard disk makes it behaves in the modern disk layout mode.
Removing the RomWBW partition entry from a modern hard disk layout
will cause the existing data to be unavailable and/or corrupted
The CP/M filesystem in the slices of the modern disk layout
contain 1024 directory entries.
#### Legacy Layout
#### Classic Layout
Originally, RomWBW always used the very start of the hard disk media
for the location of the slices. In this layout, slice 0 referred to
@ -1384,15 +1384,16 @@ chunk of ~8MB on the disk, and so on. The number of slices is limited
to the size of the disk media -- if you attempted to read/write to a
slice that would exceed the disk size, you would see I/O errors.
The legacy format takes steps to allow a partition table to still be
The classic disk layout takes steps to allow a partition table to still be
used for other types of filesystems such as DOS/FAT. It just does not
use a partition table entry to determine the start of the RomWBW slices.
The lack of a RomWBW partition table entry will cause legacy behaviour.
Adding a partition table entry on an existing legacy RomWBW hard disk
The lack of a RomWBW partition table entry will cause the classic disk
layout to be used.
Adding a partition table entry on an existing classic RomWBW hard disk
will cause the existing data to be unavailable and/or corrupted.
The CP/M filesystem in the slices of the legacy disk layout
The CP/M filesystem in the slices of the classic disk layout
contain 512 directory entries.
### Hard Disk Slices
@ -1466,9 +1467,9 @@ system.
The exact number of CP/M filesystem slices that will fit on your
specific physical hard disk can be determined as follows:
- For modern (hd1k) disk layouts, it is 1024KB + (slices * 8192KB).
- For Modern (hd1k) disk layouts, it is 1024KB + (slices * 8192KB).
Or equivalent to say 1MB + (slices * 8MB).
- For legacy (hd512) disk layouts, it is slices * 8,320KB.
- For Classic (hd512) disk layouts, it is slices * 8,320KB.
**WARNING**: In this document KB means 1024 bytes and MB means 1048576
bytes (frequently expressed as KiB and MiB in modern terminology).
@ -1611,7 +1612,7 @@ This does not mean to imply it is the only possible way.
First you need to understand
* The disk layout approach (either hd1k or the legacy hd512).
* The disk layout approach (either the Modern hd1k or the Classic hd512).
See [Hard Disk Layouts] section if you are not sure.
hd1k should be the preferred layout.
* The number of 8MB slices that you want to allocate, preferred is 64 slices.
@ -1640,7 +1641,7 @@ The disk unit number was assigned at boot See [Device Unit Assignments]
Refer to $doc_apps$ for more information on use of the `FDISK80` utility.
If you want to use the legacy hd512 layout skip down to the [Legacy (hd512)] section
If you want to use the Classic (hd512) layout skip down to the [Classic (hd512)] section
#### Modern (hd1k)
@ -1702,14 +1703,14 @@ At this point, it is best to restart your system to make sure that
the operating system is aware of the partition table updates. Start
CP/M 2.2 or Z-System from ROM again.
#### Legacy (hd512)
#### Classic (hd512)
At this point, use the `I` command to initialize (reset)
the partition table to an empty state.
To use the hd512 layout, use `W` to write the empty table to the disk
and exit. Remember that the lack of a partition for RomWBW implies the
legacy (hd512) layout.
Classic (hd512) layout.
At this point, it is best to restart your system to make sure that
the operating system is aware of the partition table updates. Start
@ -1806,6 +1807,7 @@ The following table shows the disk images available.
| xxx_fortran.img | Microsoft Fortran-80 Compiler | No |
| xxx_games.img | Games Disk for CP/M | No |
| xxx_hitechc.img | HI-TECH Z80 CP/M C compiler | No |
| xxx_infocom.img | Infocom Games Disk | No |
| xxx_msxroms1.img | MSX ROMs Disk 1 | No |
| xxx_msxroms2.img | MSX ROMs Disk 2 | No |
| xxx_nzcom.img | NZCOM ZCPR 3.4 Operating System | Yes |
@ -1820,8 +1822,8 @@ You will find 3 sets of these .img files in the distribution. The
"xxx" portion of the filename will be:
* "fd_" for a floppy image.
* "hd1k_" for a modern layout hard disk image.
* "hd512_" for a legacy layout hard disk image.
* "hd1k_" for a Modern layout hard disk image.
* "hd512_" for a Classic layout hard disk image.
In the case of xxx_dos65.img, only an hd512 variant is provided. This
is a constraint of the DOS65 distribution.
@ -1895,7 +1897,7 @@ These partition sizes and locations were chosen to:
The standard partition table table entries are:
+---------------------------------+-------------------------------+-------------------------------+
| | **--- Modern (hd1k) ---** | **--- Legacy (hd512) ---** |
| | **--- Modern (hd1k) ---** | **--- Classic (hd512) ---** |
| +---------------+---------------+---------------+---------------+
| | Byte(s) | Sector(s) | Byte(s) | Sector(s) |
+=================================+==============:+==============:+==============:+==============:+
@ -1998,7 +2000,52 @@ that there are more disk (slice) images than the 6 that are included in
the Combo Disk Images. These supplemental disk images are identified by
looking for the files that start with hd1k_ or hd512_.
#### Adding Slices to Combo Image
There are two approaches you can use to create custom hard disk
images with multiple slices.
- You can add/modify a configuration file and run the RomWBW
build process. This requires running the RomWBW build process, but
will cause your custom hard disk images to be created with every
build.
- You can manually combine the individual images using `COPY` (Windows)
or `cat` (Linux/MacOS). This does not require running the RomWBW
build process, but will require manually recreating your custom
hard disk images when you upgrade to new releases of RomWBW.
The following sections provide more detail on each approach.
#### Building Custom Hard Disk Images
The RomWBW build process builds the disk images defined in the
`Source/Images` directory. The resultant images are placed in the `Binary`
directory and are ready to copy to your media.
These aggregate disk images are defined using .def files. You will see there
is a combo.def file in the Images directory that defines the slices for the
Combo disk image. You can create your own .def files as desired to
automatically create custom aggregate disk images. When the RomWBW
build process is run, it will automatically look for all .def files
in the `Source/Images` directory and create aggregate disk images for
each using the same base name as the .def file.
There is an example of this in the `Images` directory called
`all.def.example`. You can remove the ".example" suffix so that the
file is called `all.def`. Now, if you run the RomWBW build process, it
will automatically generate `hd512_all.img` and `hd1k_all.img` files in
the `/Binary` directory. This example creates an aggregate disk image
with all of the possible slices.
You could also modify the contents of the Combo disk image by simply
modifying the `combo.def` configuration file. However, it is recommended
that you leave the Combo image alone and simply define your own.
NOTE: All of the `hd1k_xxx.img` aggregate disk image files created in
this way (including the Combo disk image) will already be prefixed with
`hd1k_prefix.dat`, so you do not need to add the prefix file. They are
ready to write to your media.
#### Combining Hard Disk Images Manually
You can add slices to the Combo Disk Images simply by tacking
slices onto the end. For example, if you want to add a slice
@ -2017,7 +2064,7 @@ Linus/MaxOS:
Note that you **must** be sure to use either the hd1k_ or hd512_
prefixed files together. You cannot mix them.
#### Creating a new Custom Image
#### Creating a new Custom Image Manually
If you want to create a completely custom hard disk image that is not
based on the existing combo image, you can generate a disk image entirely
@ -3163,7 +3210,7 @@ floppy disk and hard disk images.
| TUNE | Play .PT2, .PT3, .MYM audio files. |
| INTTEST | Test interrupt vector hooking. |
# Real Time Clock
# Real Time Clock & Date/Time Stamping
RomWBW supports a variety of real time clock hardware. If your
system has this hardware, then it will be able to maintain the

16
Source/Doc/mkdocs.yml

@ -0,0 +1,16 @@
site_name: RomWBW Documentation V3.6
repo_url: https://github.com/wwarthen/RomWBW
edit_uri: ""
docs_dir: mkdocs
nav:
- Introduction: Introduction.md
- User Guide: UserGuide.md
- System Guide: SystemGuide.md
- Applications: Applications.md
- Catalog: Catalog.md
- Hardware: Hardware.md
theme:
name: mkdocs
color_mode: auto
user_color_mode_toggle: true
navigation_depth: 3

25
Source/Fonts/Build.cmd

@ -8,19 +8,14 @@ set PATH=%TOOLS%\lzsa;%TOOLS%\fonttool;%PATH%
echo.
echo Preparing compressed font files...
lzsa -f2 -r font8x8u.bin font8x8c.bin || exit /b
lzsa -f2 -r font8x11u.bin font8x11c.bin || exit /b
lzsa -f2 -r font8x16u.bin font8x16c.bin || exit /b
lzsa -f2 -r fontcgau.bin fontcgac.bin || exit /b
lzsa -f2 -r fontvgarcu.bin fontvgarcc.bin || exit /b
for %%f in (font6x8 font8x8 font8x11 font8x16) do call :genfont %%f
fonttool font8x8u.bin > font8x8u.asm || exit /b
fonttool font8x11u.bin > font8x11u.asm || exit /b
fonttool font8x16u.bin > font8x16u.asm || exit /b
fonttool font8x8c.bin > font8x8c.asm || exit /b
fonttool font8x11c.bin > font8x11c.asm || exit /b
fonttool font8x16c.bin > font8x16c.asm || exit /b
fonttool fontcgau.bin > fontcgau.asm || exit /b
fonttool fontcgac.bin > fontcgac.asm || exit /b
fonttool fontvgarcu.bin > fontvgarcu.asm || exit /b
fonttool fontvgarcc.bin > fontvgarcc.asm || exit /b
goto :eof
:genfont
echo Processing font %1...
lzsa -f2 -r %1u.bin %1c.bin || exit /b
fonttool %1u.bin >%1u.asm || exit /b
fonttool %1c.bin >%1c.asm || exit /b
goto :eof

15
Source/Fonts/Makefile

@ -1,8 +1,8 @@
OBJECTS = \
font8x8u.asm font8x11u.asm font8x16u.asm fontcgau.asm fontvgarcu.asm \
font8x8c.asm font8x11c.asm font8x16c.asm fontcgac.asm fontvgarcc.asm
font6x8u.asm font8x8u.asm font8x11u.asm font8x16u.asm \
font6x8c.asm font8x8c.asm font8x11c.asm font8x16c.asm
OTHERS = font8x8c.bin font8x11c.bin font8x16c.bin fontcgac.bin fontvgarcc.bin
OTHERS = font6x8c.bin font8x8c.bin font8x11c.bin font8x16c.bin
TOOLS = ../../Tools
@ -14,6 +14,9 @@ include $(TOOLS)/Makefile.inc
%.rel: %.asm
%.bin: %.asm
font6x8c.bin: font6x8u.bin
$(BINDIR)/lzsa -f2 -r $< $@
font8x8c.bin: font8x8u.bin
$(BINDIR)/lzsa -f2 -r $< $@
@ -23,11 +26,5 @@ font8x11c.bin: font8x11u.bin
font8x16c.bin: font8x16u.bin
$(BINDIR)/lzsa -f2 -r $< $@
fontcgac.bin: fontcgau.bin
$(BINDIR)/lzsa -f2 -r $< $@
fontvgarcc.bin: fontvgarcu.bin
$(BINDIR)/lzsa -f2 -r $< $@
%.asm: %.bin
$(BINDIR)/bin2asm $< > $@

BIN
Source/Fonts/font6x8.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.7 KiB

BIN
Source/Fonts/font6x8u.bin

Binary file not shown.

BIN
Source/Fonts/font8x16.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 9.3 KiB

BIN
Source/Fonts/font8x16u.bin

Binary file not shown.

BIN
Source/Fonts/font8x8.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.6 KiB

After

Width:  |  Height:  |  Size: 6.2 KiB

BIN
Source/Fonts/font8x8u.bin

Binary file not shown.

BIN
Source/Fonts/fontcga.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.8 KiB

BIN
Source/Fonts/fontcgau.bin

Binary file not shown.

48
Source/Fonts/fonts.txt

@ -1,12 +1,5 @@
Font files for ROMWBW.
8x8: 8x8 cell, mostly IBM CGA, first 16 differ, thin font
8x11: 8x11 cell, possibly VT-100?
8x16: 8x16 cell, IBM MDA
CGA: 8x16 cell, IBM CGA, normal (thick) CGA font, rows 8-15 are unused padding
There are multiple fonts associated with ROMWBW supported hardware:
Board Driver Chip
-------- -------- --------
ECB-SCG tms.asm 9918
@ -15,23 +8,36 @@ There are multiple fonts associated with ROMWBW supported hardware:
ECB-VGA3 vga.asm 6445
MBC-VDC cvdu.asm 8568
MBC-VDP tms.asm 9938/9958
Name Font Storage Size Board & Display Mode
--------------------------------------------------------------------------------------------
font8x8u.bin 6x8 8x8 2048 ECB-SCG, ECB-VGA3 (80x60), MBC-VDP
font8x11u.bin 8x11 8x11 2816 ECB-VGA3 (80x43)
font8x16u.bin 8x14 8x16 4096 ECB-CVDU (80x25), ECB-VGA3 (80x24, 80x25, 80x30), MBC-VDC
fontcgau.bin 8x8 8x16 4096 ECB-CVDU (80x25), MBC-VDC
RCBUS-VRC vrc.asm PLD
RCBUS-TMS tms.asm 99x8
Name Glyph Cell Size Comp Board & Display Mode
------------------------------------------------------------------------------------------------
font6x8 6x8 8x8 2048 1094 ECB-SCG, MBC-VDP
font8x8 6x8 8x8 2048 1259 ECB-CVDU (CGA), MBC-VDC (CGA), ECB-VGA3 (80x60)
font8x11 8x11 8x11 2816 1252 ECB-VGA3 (80x43)
font8x16 8x14 8x16 4096 1466 ECB-CVDU (EGA), MBC-VDC (EGA), ECB-VGA3 (80x24, 80x25, 80x30)
----- -----
11008 5071
Notes:
- The CGA font is roughly equivalent to the 8x8 font, but padded out to 8x16. Scan lines
8-15 are unused. The CVDU driver (8563 chip) always uses fonts defined in an 8x16 cell.
When the CVDU is configured for use with a CGA monitor, an 8x8 character cell is used,
but the font definition must still be 8x16. The CGA font is used for this.
- Compression of the 6x8 font is disabled because the TMS driver must
reload the font when CP/M is warm booted. There is no memory area
where the decompression can safely be done at this point.
- The 856x GDPs always use 16 bytes per font character. The CVDU
driver inserts dummy bytes as needed to utilize the 8x8 font when
selected.
- The 8x11 font is not typically used and only supported by one
board. It is probably not worth the space of storing it and will
probably be eliminated in the future.
- All fonts are in code page 437 except 8x11.
For inclusion in HBIOS the .bin format files must be converted to assembler .asm format.
This is acheived using the fonttool utility and is completed automatically as part of the build process.
This is achieved using the fonttool utility and is completed automatically as part of the build process.
i.e. fonts files are converted to .asm format and then copied to the HBIOS directory.
To replace a font, simply copy it to the Fonts directory using the same naming convention above,
@ -61,7 +67,3 @@ Implementation example (older version):
https://cpcrulez.fr/applications_tools_cruncher_LZSA2_Z80.htm
x86 lzsa compressor application:
http://www.pouet.net/prod.php?which=81573

BIN
Source/Fonts/fontvgarc.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 KiB

BIN
Source/Fonts/fontvgarcu.bin

Binary file not shown.

66
Source/HBIOS/Build.cmd

@ -17,8 +17,8 @@ set CPMDIR80=%TOOLS%/cpm/
::
:: This PowerShell script validates the build variables passed in. If
:: necessary, the user is prmopted to pick the variables. It then creates
:: an include file that is imbedded in the HBIOS assembly (build.inc).
:: necessary, the user is prompted to pick the variables. It then creates
:: an include file that is embedded in the HBIOS assembly (build.inc).
:: It also creates a batch command file that sets environment variables
:: for use by the remainder of this batch file (build_env.cmd).
::
@ -71,7 +71,7 @@ if %Platform%==DUO (
)
::
:: Bring the previously build font files into this directory
:: Bring the previously build font files into this directory
::
copy ..\Fonts\font*.asm . || exit /b
@ -91,45 +91,53 @@ tasm -t%CPUType% -g3 -dAPPBOOT hbios.asm hbios_app.bin hbios_app.lst || exit /b
call :asm dbgmon || exit /b
call :asm romldr || exit /b
call :asm invntdev || exit /b
call :asm invntslc || exit /b
call :asm eastaegg || exit /b
call :asm nascom || exit /b
:: call :asm tastybasic || exit /b
call :asm game || exit /b
call :asm usrrom || exit /b
call :asm updater || exit /b
call :asm imgpad2 || exit /b
call :asm romfonts || exit /b
:: Sysconf builds as both BIN and COM files
tasm -t%CPUType% -g3 -fFF -dROMWBW sysconf.asm sysconf.bin sysconf_bin.lst || exit /b
tasm -t%CPUType% -g3 -fFF -dCPM sysconf.asm sysconf.com sysconf_com.lst || exit /b
::
:: Create additional ROM bank images by assembling components into
:: 32K chunks which can be concatenated later. Note that
:: osimg_small is a special case because it is 20K in size. This
:: image is subsequently used to generate the .com loadable file.
::
copy /b romldr.bin + dbgmon.bin + ..\zsdos\zsys_wbw.bin + ..\cpm22\cpm_wbw.bin osimg.bin || exit /b
copy /b ..\Forth\camel80.bin + nascom.bin + ..\tastybasic\src\tastybasic.bin + game.bin + eastaegg.bin + %NETBOOT% + updater.bin + sysconf.bin + usrrom.bin osimg1.bin || exit /b
:: Create platform specific hardware monitor
if %Platform%==S100 (
zxcc slr180 -s100mon/fh
zxcc slr180 -s100mon/fh || exit /b
zxcc mload25 -s100mon || exit /b
copy /b s100mon.com osimg2.bin || exit /b
set HwMon=s100mon.com
) else (
copy /b imgpad2.bin osimg2.bin || exit /b
call :asm hwmon || exit /b
set HwMon=hwmon.bin
)
copy /b romldr.bin + dbgmon.bin + ..\zsdos\zsys_wbw.bin osimg_small.bin || exit /b
::
:: Create additional ROM bank images by assembling components into
:: 32K chunks which can be concatenated later. Note that
:: appboot is a special case because it is 20K in size. This
:: image is subsequently used to generate the .com loadable file.
::
copy /b romldr.bin + dbgmon.bin + ..\zsdos\zsys_wbw.bin + ..\cpm22\cpm_wbw.bin rom1.bin || exit /b
copy /b ..\Forth\camel80.bin + nascom.bin + ..\tastybasic\src\tastybasic.bin + game.bin + eastaegg.bin + %NETBOOT% + updater.bin + sysconf.bin + usrrom.bin rom2.bin || exit /b
copy /b %HwMon% + invntdev.bin + invntslc.bin + romfonts.bin rom3.bin
copy /b romldr.bin + dbgmon.bin + ..\zsdos\zsys_wbw.bin appboot.bin || exit /b
::
:: Inject one byte checksum at the last byte of all 4 ROM bank image files.
:: This means that computing a checksum over any of the 32K osimg banks
:: should yield a result of zero.
:: This means that computing a checksum over any of the 32K rom banks
:: should yield a result of zero. Any bank image file that is not
:: 32K will be automatically normalized to 32K by the srec_cat
:: formula (extended or truncated)!!!
::
for %%f in (hbios_rom.bin osimg.bin osimg1.bin osimg2.bin) do (
for %%f in (hbios_rom.bin rom1.bin rom2.bin rom3.bin) do (
"%TOOLS%\srecord\srec_cat.exe" %%f -Binary -Crop 0 0x7FFF -Checksum_Negative_Big_Endian 0x7FFF 1 1 -o %%f -Binary || exit /b
)
@ -150,13 +158,13 @@ for %%f in (hbios_rom.bin osimg.bin osimg1.bin osimg2.bin) do (
::
if %ROMSize% gtr 0 (
copy /b hbios_rom.bin + osimg.bin + osimg1.bin + osimg2.bin + ..\RomDsk\rom%ROMDiskSize%_wbw.dat %ROMName%.rom || exit /b
copy /b hbios_rom.bin + osimg.bin + osimg1.bin + osimg2.bin %ROMName%.upd || exit /b
copy /b hbios_app.bin + osimg_small.bin %ROMName%.com || exit /b
copy /b hbios_rom.bin + rom1.bin + rom2.bin + rom3.bin + ..\RomDsk\rom%ROMDiskSize%_wbw.dat %ROMName%.rom || exit /b
copy /b hbios_rom.bin + rom1.bin + rom2.bin + rom3.bin %ROMName%.upd || exit /b
copy /b hbios_app.bin + appboot.bin %ROMName%.com || exit /b
) else (
copy /b hbios_rom.bin + osimg.bin + osimg1.bin + osimg2.bin + ..\RomDsk\rom%RAMDiskSize%_wbw.dat %ROMName%.rom || exit /b
copy /b hbios_rom.bin + osimg.bin + osimg1.bin + osimg2.bin %ROMName%.upd || exit /b
copy /b hbios_app.bin + osimg_small.bin %ROMName%.com || exit /b
copy /b hbios_rom.bin + rom1.bin + rom2.bin + rom3.bin + ..\RomDsk\rom%RAMDiskSize%_wbw.dat %ROMName%.rom || exit /b
copy /b hbios_rom.bin + rom1.bin + rom2.bin + rom3.bin %ROMName%.upd || exit /b
copy /b hbios_app.bin + appboot.bin %ROMName%.com || exit /b
)
::
@ -187,14 +195,14 @@ call :asm dbgmon || exit /b
call :asm romldr || exit /b
:: Create the OS bank
copy /b romldr.bin + dbgmon.bin + ..\zsdos\zsys_una.bin + ..\cpm22\cpm_una.bin osimg.bin || exit /b
copy /b romldr.bin + dbgmon.bin + ..\zsdos\zsys_una.bin + ..\cpm22\cpm_una.bin rom2.bin || exit /b
:: Copy OS Bank and ROM Disk image files to output
copy /b osimg.bin ..\..\Binary\UNA_WBW_SYS.bin || exit /b
copy /b rom2.bin ..\..\Binary\UNA_WBW_SYS.bin || exit /b
copy /b ..\RomDsk\rom%ROMDiskSize%_una.dat ..\..\Binary\UNA_WBW_ROM%ROMDiskSize%.bin || exit /b
:: Create the final ROM image
copy /b ..\UBIOS\UNA-BIOS.BIN + osimg.bin + ..\UBIOS\FSFAT.BIN + ..\RomDsk\rom%ROMDiskSize%_una.dat %ROMName%.rom || exit /b
copy /b ..\UBIOS\UNA-BIOS.BIN + rom2.bin + ..\UBIOS\FSFAT.BIN + ..\RomDsk\rom%ROMDiskSize%_una.dat %ROMName%.rom || exit /b
:: Copy to output
copy %ROMName%.rom ..\..\Binary || exit /b

12
Source/HBIOS/Config/RCEZ80_std.asm

@ -55,7 +55,7 @@ CRTACT .SET FALSE ; ACTIVATE CRT (VDU,CVDU,PROPIO,ETC) AT STARTUP
VDAEMU_SERKBD .SET $FF ; VDA EMULATION: SERIAL KBD UNIT #, OR $FF FOR HW KBD
;;
TMSENABLE .SET FALSE ; TMS: ENABLE TMS9918 VIDEO/KBD DRIVER (TMS.ASM)
TMSMODE .SET TMSMODE_MSX ; TMS: DRIVER MODE: TMSMODE_[SCG|N8|MSX|MSXKBD|MSXMKY|MBC|COLECO|DUO|NABU]
TMSMODE .SET TMSMODE_MSX ; TMS: DRIVER MODE: TMSMODE_[SCG|N8|MSX|MSXKBD|MSXMKY|MBC|COLECO|DUO|NABU|MSXUKY]
TMS80COLS .SET FALSE ; TMS: ENABLE 80 COLUMN SCREEN, REQUIRES V9958
TMSTIMENABLE .SET FALSE ; TMS: ENABLE TIMER INTERRUPTS (REQUIRES IM1)
VRCENABLE .SET FALSE ; VRC: ENABLE VGARC VIDEO/KBD DRIVER (VRC.ASM)
@ -71,6 +71,14 @@ PPIDEENABLE .SET TRUE ; PPIDE: ENABLE PARALLEL PORT IDE DISK DRIVER (PPIDE.ASM)
SDENABLE .SET FALSE ; SD: ENABLE SD CARD DISK DRIVER (SD.ASM)
SDMODE .SET SDMODE_PIO ; SD: DRIVER MODE: SDMODE_[JUHA|N8|CSIO|PPI|UART|DSD|MK4|SC|MT|USR|PIO|Z80R|EPITX|FZ80|GM|EZ512|K80W]
SDCNT .SET 1 ; SD: NUMBER OF SD CARD DEVICES (1-2), FOR DSD/SC/MT ONLY
;
CHENABLE .SET TRUE ; CH: ENABLE CH375/376 USB SUPPORT
CHNATIVEENABLE .SET FALSE ; CH376: ENABLE CH376 NATIVE USB DRIVER
CHSCSIENABLE .SET FALSE ; CH376: ENABLE CH376 NATIVE MASS STORAGE DEVICES (REQUIRES CHNATIVEENABLE)
CHUFIENABLE .SET FALSE ; CH376: ENABLE CH376 NATIVE UFI FLOPPY DISK DEVICES (REQUIRES CHNATIVEENABLE)
CHNATIVEEZ80 .SET TRUE ; CH376: DELEGATE USB DRIVERS TO EZ80'S FIRMWARE
CHNATIVEFORCE .SET FALSE ; CH376: DISABLE AUTO-DETECTION OF MODULE - ASSUME ITS INSTALLED
;
PRPENABLE .SET FALSE ; PRP: ENABLE ECB PROPELLER IO BOARD DRIVER (PRP.ASM)
;
LPTENABLE .SET FALSE ; LPT: ENABLE CENTRONICS PRINTER DRIVER (LPT.ASM)
@ -82,3 +90,5 @@ SN76489ENABLE .SET FALSE ; SN: ENABLE SN76489 SOUND DRIVER
AY38910ENABLE .SET FALSE ; AY: ENABLE AY-3-8910 / YM2149 SOUND DRIVER
AYMODE .SET AYMODE_RCZ80 ; AY: DRIVER MODE: AYMODE_[SCG|N8|RCZ80|RCZ180|MSX|LINC|MBC|DUO|NABU]
AY_FORCE .SET FALSE ; AY: BYPASS AUTO-DETECT, FORCED PRESENT
EZ80TIMER .SET EZ80TMR_FIRM ; EZ80: TIMER TICK MODEL: EZ80TMR_[INT|FIRM]

6
Source/HBIOS/Config/RCZ80_std.asm

@ -72,7 +72,7 @@ ACIAENABLE .SET TRUE ; ACIA: ENABLE MOTOROLA 6850 ACIA DRIVER (ACIA.ASM)
SIOENABLE .SET TRUE ; SIO: ENABLE ZILOG SIO SERIAL DRIVER (SIO.ASM)
;
TMSENABLE .SET FALSE ; TMS: ENABLE TMS9918 VIDEO/KBD DRIVER (TMS.ASM)
TMSMODE .SET TMSMODE_MSX ; TMS: DRIVER MODE: TMSMODE_[SCG|N8|MSX|MSXKBD|MSXMKY|MBC|COLECO|DUO|NABU]
TMSMODE .SET TMSMODE_MSX ; TMS: DRIVER MODE: TMSMODE_[SCG|N8|MSX|MSXKBD|MSXMKY|MBC|COLECO|DUO|NABU|MSXUKY]
TMS80COLS .SET FALSE ; TMS: ENABLE 80 COLUMN SCREEN, REQUIRES V9958
TMSTIMENABLE .SET FALSE ; TMS: ENABLE TIMER INTERRUPTS (REQUIRES IM1)
VRCENABLE .SET FALSE ; VRC: ENABLE VGARC VIDEO/KBD DRIVER (VRC.ASM)
@ -92,6 +92,10 @@ SDMODE .SET SDMODE_PIO ; SD: DRIVER MODE: SDMODE_[JUHA|N8|CSIO|PPI|UART|DSD|MK4
SDCNT .SET 1 ; SD: NUMBER OF SD CARD DEVICES (1-2), FOR DSD/SC/MT ONLY
;
CHENABLE .SET TRUE ; CH: ENABLE CH375/376 USB SUPPORT
CHNATIVEENABLE .SET FALSE ; CH376: ENABLE CH376 NATIVE USB DRIVER
CHSCSIENABLE .SET FALSE ; CH376: ENABLE CH376 NATIVE MASS STORAGE DEVICES (REQUIRES CHNATIVEENABLE)
CHUFIENABLE .SET FALSE ; CH376: ENABLE CH376 NATIVE UFI FLOPPY DISK DEVICES (REQUIRES CHNATIVEENABLE)
CHNATIVEFORCE .SET FALSE ; CH376: DISABLE AUTO-DETECTION OF MODULE - ASSUME ITS INSTALLED
;
PRPENABLE .SET FALSE ; PRP: ENABLE ECB PROPELLER IO BOARD DRIVER (PRP.ASM)
;

61
Source/HBIOS/Config/RCZ80_xosera.asm

@ -0,0 +1,61 @@
;
;==================================================================================================
; ROMWBW CUSTOM USER BUILD SETTINGS EXAMPLE FOR RCBUS Z80
;==================================================================================================
;
; THIS FILE IS AN EXAMPLE OF A CUSTOM USER SETTINGS FILE. THESE
; SETTINGS OVERRIDE THE DEFAULT SETTINGS OF THE INHERITED FILES AS
; DESIRED BY A USER.
;
; ROMWBW USES CASCADING CONFIGURATION FILES AS INDICATED BELOW:
;
; cfg_MASTER.asm - MASTER: CONFIGURATION FILE DEFINES ALL POSSIBLE ROMWBW SETTINGS
; |
; +-> cfg_<platform>.asm - PLATFORM: DEFAULT SETTINGS FOR SPECIFIC PLATFORM
; |
; +-> Config/<plt>_std.asm - BUILD: SETTINGS FOR EACH OFFICIAL DIST BUILD
; |
; +-> Config/<plt>_<cust>.asm - USER: CUSTOM USER BUILD SETTINGS
;
; THE TOP (MASTER CONFIGURATION) FILE DEFINES ALL POSSIBLE ROMWBW
; CONFIGURATION SETTINGS. EACH FILE BELOW THE MASTER CONFIGURATION FILE
; INHERITS THE CUMULATIVE SETTINGS OF THE FILES ABOVE IT AND MAY
; OVERRIDE THESE SETTINGS AS DESIRED.
;
; OTHER THAN THE TOP MASTER FILE, EACH FILE MUST "#INCLUDE" ITS PARENT
; FILE (SEE #INCLUDE STATEMENT BELOW). THE TOP TWO FILES SHOULD NOT BE
; MODIFIED.
;
; THIS FILE EXEMPLIFIES THE IDEAL WAY TO CREATE A USER SPECIFIC BUILD
; CONFIGURATION. NOTICE THAT IT INCLUDES THE DEFAULT BUILD SETTINGS
; FILE AND OVERRIDES SOME DESIRED SETTINGS.
;
; BY CREATING A CUSTOM USER SETTINGS FILE, YOU ARE LESS LIKELY TO BE
; IMPACTED BY FUTURE CHANGES BECAUSE YOU WILL BE INHERITING MOST
; OF YOUR SETTINGS WHICH WILL BE UPDATED BY AUTHORS AS ROMWBW EVOLVES.
;
; PLEASE REFER TO THE CUSTOM BUILD INSTRUCTIONS (README.TXT) IN THE
; SOURCE DIRECTORY (TWO DIRECTORIES ABOVE THIS ONE).
;
; *** WARNING: ASIDE FROM THE MASTER CONFIGURATION FILE, YOU MUST USE
; ".SET" TO OVERRIDE SETTINGS. THE ASSEMBLER WILL ERROR IF YOU ATTEMPT
; TO USE ".EQU" BECAUSE IT WON'T LET YOU REDEFINE A SETTING WITH ".EQU".
;
; THIS FILE ENABLES THE XOSERA DRIVER WITH A BASE ADDRESS Of $A0 AND
; DISPLAY SIZE OF 80 COLUMNS X 30 ROWS.
;
#INCLUDE "Config/RCZ80_std.asm" ; INHERIT FROM OFFICIAL BUILD SETTINGS
;
XOSENABLE .SET TRUE ; XOSERA: ENABLE XOSERA VIDEO DRIVERS (XOSERA.ASM)
XOS_BASE .SET $A0 ; XOSERA: I/O BASE ADDRESS (REQUIRES 32 BYTES)
XOSSIZ .SET V80X30 ; XOSERA: DISPLAY FORMAT [V80X30|V80X60]
;
AUTOCON .SET FALSE ; ENABLE CONSOLE TAKEOVER AT LOADER PROMPT
VDAEMU_SERKBD .SET $0 ; VDA EMULATION: SERIAL KBD UNIT #, OR $FF FOR HW KBD
;
; WHEN A XOSERA BOARD IN IS THE SYSTEM, LIMIT THE NUMBER OF UARTS THAT ARE PROBED
; TO TWO, BECAUSE THE PROBE TO DETECT A THIRD UART WRITES UNLUCKY VALUES TO
; XOSERA THAT CAUSE IT TO RECONFIGURE ITSELF AND LOCK UP THE BUS FOR A TIME. IF
; YOU NEED MORE THAN TWO UARTS, YOU WILL NEED TO MOVE XOSERA OUT OF THE $A0-$BF
; I/O ADDRESS REGION.
UARTCNT .SET 2

88
Source/HBIOS/Layout.txt

@ -3,66 +3,72 @@ Final Output Files
------------------
ROM Output File [512K] -> <config>.rom
hbios_rom [32K]
OSIMG [32K]
OSIMG1 [32K]
OSIMG2 [32K]
romdisk - [384K]
HBIOS_ROM [32K]
ROM1 [32K]
ROM2 [32K]
ROM3 [32K]
ROMDISK [384K] (size varies with ROM in system)
UPD Output File [128K] -> <config>.upd
hbios_rom [32K]
OSIMG [32K]
OSIMG1 [32K]
OSIMG2 [32K]
HBIOS_ROM [32K]
ROM1 [32K]
ROM2 [32K]
ROM3 [32K]
COM Output File -> <config>.com
hbios_app [varies]
OSIMG_SMALL [32K]
HBIOS_APP [<32K] (size varies, no padding]
APPBOOT [ 20K]
-------------------------
Intermediate Output Files
-------------------------
OSIMG [32K] -> osimg.bin
romldr [4K]
dbgmon [4K]
ZSYS (zcpr/zsdos/cbios) [12K]
CPM (ccp/bdos/cbios) [12K]
ROM1 [32K] -> rom1.bin
romldr [ 4K]
dbgmon [ 4K]
ZSYS [12K] (zcpr/zsdos/cbios)
CPM [12K] (ccp/bdos/cbios)
OSIMG_SMALL [20K] -> osimg_small.bin
romldr [4K]
dbgmon [4K]
ZSYS (zcpr/zsdos/cbios) [12K]
OSIMG1 [32K] -> osimg1.bin
ROM2 [32K] -> rom2.bin
camel80 [5.75K]
nascom [8K]
tastybasic [2.5K]
nascom [8.00K]
tastybasic [2.50K]
game [2.25K]
eastaegg [0.5K]
netboot [4K]
eastaegg [0.50K]
netboot [4.00K]
updater.bin [3.25K]
sysconf.bin [2K]
usrrom.bin [3.75K (padded)]
sysconf.bin [2.00K]
usrrom.bin [3.75K]
ROM3 [32K] -> rom3.bin
hwmon [ 8.00K]
invntdev [ 2.75K]
invntslc [ 0.50K]
fonts [ 8.00K]
slack [12.75K]
OSIMG2 [32K] -> osimg2.bin
s100mon [8.25kb (optional)]
(OR) not populated
APPBOOT [20K] -> appboot.bin
romldr [ 4K]
dbgmon [ 4K]
ZSYS [12K] (zcpr/zsdos/cbios)
CPM [12K] -> cpm.bin
ccp [2K]
bdos [3.5K]
cbios [6.5K]
ccp [2.0K]
bdos [3.5K]
cbios [6.5K]
ZSYS [12K] -> zsys.bin
zcpr [2K]
zsdos [3.5K]
cbios [6.5K]
zcpr [2.0K]
zsdos [3.5K]
cbios [6.5K]
-----------------
Compilation Units
-----------------
NOTE: The following need to be reviewed. They are probably out
of date.
hbios.asm -> hbios_rom.bin, hbios_app.bin
std.asm
ver.inc
@ -76,7 +82,7 @@ hbios.asm -> hbios_rom.bin, hbios_app.bin
bcd.asm
dsky.asm
romldr.asm -> romldr.bin: loader?
romldr.asm -> romldr.bin
std.asm
ver.inc
hbios.inc
@ -125,18 +131,16 @@ tastybasic.asm -> tastybasic.bin
<config>.asm
plt_<platform>.inc
=======================================================================
HBIOS Loading Modes:
ROMBOOT: Startup from ROM Bank BID_BOOT
APPBOOT: Startup as CP/M application
IMGBOOT: Startup from RAM Bank BID_USR
IMGBOOT: Startup from RAM Bank BID_USR (deprecated)
=======================================================================
- If not (APPBOOT), include page 0
- Base Hardware Init
- Iff (ROMBOOT), init BBR
- Install Proxy
- Set CURBNK:
@ -149,6 +153,6 @@ HBIOS Loading Modes:
- Copy OS Image to USR Bank
- If (ROM_MODE), copy BID_OS:0 --> BID_USR:0
- Else, copy BID_USR:<os image start> --> BID_USR:0
- Else, copy BID_BIOS:<os image start> --> BID_USR:0
- Chain to BID_USR:0

64
Source/HBIOS/Makefile

@ -1,11 +1,11 @@
MOREDIFF = game.bin hbios_rom.bin nascom.bin usrrom.bin \
dbgmon.bin hbios_app.bin imgpad2.bin osimg1.bin osimg2.bin romldr.bin \
eastaegg.bin hbios_img.bin osimg.bin game.bin updater.bin usrrom.bin
dbgmon.bin hbios_app.bin rom2.bin rom3.bin romldr.bin \
eastaegg.bin hbios_img.bin rom1.bin game.bin updater.bin usrrom.bin
DEST = ../../Binary
TOOLS =../../Tools
OTHERS = *.img *.rom *.com *.upd *.bin *.hex cpm.sys zsys.sys Build.inc font*.asm *.dat hbios_env.sh netboot.mod
OTHERS = *.img *.rom *.com *.upd *.bin *.hex cpm.sys zsys.sys Build.inc font*.asm *.dat hbios_env.sh
# DIFFMAKE = 1
@ -23,8 +23,8 @@ endif
include $(TOOLS)/Makefile.inc
FONTS := font8x11c.asm font8x11u.asm font8x16c.asm font8x16u.asm font8x8c.asm font8x8u.asm \
fontcgac.asm fontcgau.asm fontvgarcc.asm fontvgarcu.asm
FONTS := font6x8c.asm font6x8u.asm font8x8c.asm font8x8u.asm \
font8x11c.asm font8x11u.asm font8x16c.asm font8x16u.asm
ifeq ($(CPUFAM),2)
TASM=$(BINDIR)/uz80as -t hd64180
@ -32,7 +32,7 @@ else ifeq ($(CPUFAM),3)
TASM=$(BINDIR)/uz80as -t z280
endif
DEPS=prereq dbgmon.bin romldr.bin nascom.bin tastybasic.bin game.bin eastaegg.bin updater.bin sysconf.bin sysconf.com usrrom.bin imgpad2.bin
DEPS=prereq dbgmon.bin romldr.bin nascom.bin tastybasic.bin invntdev.bin invntslc.bin game.bin eastaegg.bin updater.bin sysconf.bin sysconf.com usrrom.bin romfonts.bin
ifeq ($(ROM_PLATFORM),UNA)
ROMDEPS=romldr.bin dbgmon.bin
@ -43,9 +43,19 @@ else
endif
ifeq ($(ROM_PLATFORM),S100)
ROMDEPS += s100mon.bin
HWMON=s100mon.bin
else
HWMON=hwmon.bin
endif
ifeq ($(ROM_PLATFORM),DUO)
NETBOOT=netboot-duo.mod
else
NETBOOT=netboot-mt.mod
endif
DEPS += $(HWMON) $(NETBOOT)
ROMNAME=${ROM_PLATFORM}_${ROM_CONFIG}
# $(info DEPS=$(DEPS))
@ -58,37 +68,28 @@ ROMNAME=${ROM_PLATFORM}_${ROM_CONFIG}
# $(info TASM=$(TASM))
$(OBJECTS) : $(ROMDEPS)
@cat romldr.bin dbgmon.bin ../ZSDOS/zsys_$(BIOS).bin ../CPM22/cpm_$(BIOS).bin >osimg.bin
cat romldr.bin dbgmon.bin ../ZSDOS/zsys_$(BIOS).bin >osimg_small.bin
if [ $(ROM_PLATFORM) = DUO ] ; then \
cat netboot-duo.mod >netboot.mod ; \
else \
cat netboot-mt.mod >netboot.mod ; \
fi
@cat romldr.bin dbgmon.bin ../ZSDOS/zsys_$(BIOS).bin ../CPM22/cpm_$(BIOS).bin >rom1.bin
cat romldr.bin dbgmon.bin ../ZSDOS/zsys_$(BIOS).bin >appboot.bin
if [ $(ROM_PLATFORM) != UNA ] ; then \
cat camel80.bin nascom.bin tastybasic.bin game.bin eastaegg.bin netboot.mod updater.bin sysconf.bin usrrom.bin >osimg1.bin ; \
if [ $(ROM_PLATFORM) = S100 ] ; then \
cat s100mon.bin >osimg2.bin ; \
else \
cat imgpad2.bin >osimg2.bin ; \
fi ; \
for f in hbios_rom.bin osimg.bin osimg1.bin osimg2.bin ; do \
cat camel80.bin nascom.bin tastybasic.bin game.bin eastaegg.bin $(NETBOOT) updater.bin sysconf.bin usrrom.bin >rom2.bin ; \
cat $(HWMON) invntdev.bin invntslc.bin romfonts.bin >rom3.bin ; \
for f in hbios_rom.bin rom1.bin rom2.bin rom3.bin ; do \
srec_cat $$f -Binary -Crop 0 0x7FFF -Checksum_Negative_Big_Endian 0x7FFF 1 1 -o $$f -Binary ; \
done \
fi
if [ $(ROM_PLATFORM) = UNA ] ; then \
cp osimg.bin $(DEST)/UNA_WBW_SYS.bin ; \
cp rom1.bin $(DEST)/UNA_WBW_SYS.bin ; \
cp ../RomDsk/rom$(ROMDISKSIZE)_una.dat $(DEST)/UNA_WBW_ROM$(ROMDISKSIZE).bin ; \
cat ../UBIOS/UNA-BIOS.BIN osimg.bin ../UBIOS/FSFAT.BIN ../RomDsk/rom$(ROMDISKSIZE)_una.dat >$(ROMNAME).rom ; \
cat ../UBIOS/UNA-BIOS.BIN rom1.bin ../UBIOS/FSFAT.BIN ../RomDsk/rom$(ROMDISKSIZE)_una.dat >$(ROMNAME).rom ; \
else \
if [ $(ROMSIZE) -gt 0 ] ; then \
cat hbios_rom.bin osimg.bin osimg1.bin osimg2.bin ../RomDsk/rom$(ROMDISKSIZE)_wbw.dat >$(ROMNAME).rom ; \
cat hbios_rom.bin osimg.bin osimg1.bin osimg2.bin >$(ROMNAME).upd ; \
cat hbios_app.bin osimg_small.bin > $(ROMNAME).com ; \
cat hbios_rom.bin rom1.bin rom2.bin rom3.bin ../RomDsk/rom$(ROMDISKSIZE)_wbw.dat >$(ROMNAME).rom ; \
cat hbios_rom.bin rom1.bin rom2.bin rom3.bin >$(ROMNAME).upd ; \
cat hbios_app.bin appboot.bin > $(ROMNAME).com ; \
else \
cat hbios_rom.bin osimg.bin osimg1.bin osimg2.bin ../RomDsk/rom$(RAMDISKSIZE)_wbw.dat >$(ROMNAME).rom ; \
cat hbios_rom.bin osimg.bin osimg1.bin osimg2.bin >$(ROMNAME).upd ; \
cat hbios_app.bin osimg_small.bin > $(ROMNAME).com ; \
cat hbios_rom.bin rom1.bin rom2.bin rom3.bin ../RomDsk/rom$(RAMDISKSIZE)_wbw.dat >$(ROMNAME).rom ; \
cat hbios_rom.bin rom1.bin rom2.bin rom3.bin >$(ROMNAME).upd ; \
cat hbios_app.bin appboot.bin > $(ROMNAME).com ; \
fi \
fi
@ -132,8 +133,13 @@ hbios_env.sh: hbios_env.com
romldr.bin: build.inc
dbgmon.bin: build.inc
nascom.bin: build.inc
invntdev.bin: build.inc
invntslc.bin: build.inc
eastaegg.bin: build.inc
updater.bin: build.inc
romfonts.bin: build.inc
hwmon.bin: build.inc
s100mon.bin: build.inc
dumps:
for i in $(MOREDIFF) ; do \

17
Source/HBIOS/acia.asm

@ -123,10 +123,8 @@ ACIA_INITUNIT:
CALL ACIA_INITSAFE
;
; SET DEFAULT CONFIG
LD DE,-1 ; LEAVE CONFIG ALONE
; CALL INITDEV TO IMPLEMENT CONFIG, BUT NOTE THAT WE CALL
; THE INITDEV ENTRY POINT THAT DOES NOT ENABLE/DISABLE INTS!
JP ACIA_INITDEVX ; IMPLEMENT IT AND RETURN
LD DE,-1 ; LEAVE CONFIG ALONE
JP ACIA_INITDEV ; IMPLEMENT IT AND RETURN
;
;
;
@ -366,15 +364,22 @@ ACIA_OST:
;
;
ACIA_INITDEV:
; INITDEV CAN BE CALLED PRIOR TO INTERRUPTS BEING ENABLED. WE
; NEED TO LEAVE INTERRUPTS ALONE IN THIS SCENARIO
LD A,(INTSENAB) ; INTS ENABLED?
OR A ; TEST VALUE
JR Z,ACIA_INITDEV0 ; BYPASS DI/EI IF NOT ENABLED
;
; INTERRUPTS DISABLED DURING INIT
HB_DI ; AVOID CONFLICTS
CALL ACIA_INITDEVX ; DO THE REAL WORK
CALL ACIA_INITDEV0 ; DO THE REAL WORK
HB_EI ; INTS BACK ON
RET ; DONE
;
; THIS ENTRY POINT BYPASSES DISABLING/ENABLING INTS WHICH IS REQUIRED BY
; PREINIT ABOVE. PREINIT IS NOT ALLOWED TO ENABLE INTS!
;
ACIA_INITDEVX:
ACIA_INITDEV0:
;
#IF (ACIADEBUG)
CALL NEWLINE

2
Source/HBIOS/ansi.asm

@ -1554,4 +1554,4 @@ ANSI_DEVNUM .DB $FF ; TERMINAL DEVICE NUMBER
; E Light Cyan
; F Bright White
;=============================================================
;
;

22
Source/HBIOS/asci.asm

@ -170,9 +170,7 @@ ASCI_INITUNIT:
;
; SET DEFAULT CONFIG
LD DE,-1 ; LEAVE CONFIG ALONE
; CALL INITDEV TO IMPLEMENT CONFIG, BUT NOTE THAT WE CALL
; THE INITDEVX ENTRY POINT THAT DOES NOT ENABLE/DISABLE INTS!
JP ASCI_INITDEVX ; IMPLEMENT IT AND RETURN
JP ASCI_INITDEV ; IMPLEMENT IT AND RETURN
;
;
;
@ -424,20 +422,20 @@ ASCI_OST:
; REQUIRED BY THE ASCI AND STORED IN A PORT/REGISTER INITIALIZATION TABLE,
; WHICH IS THEN LOADED INTO THE ASCI.
;
; NOTE THAT THERE ARE TWO ENTRY POINTS. INITDEV WILL DISABLE/ENABLE INTS
; AND INITDEVX WILL NOT. THIS IS DONE SO THAT THE PREINIT ROUTINE ABOVE
; CAN AVOID ENABLING/DISABLING INTS.
;
ASCI_INITDEV:
; INITDEV CAN BE CALLED PRIOR TO INTERRUPTS BEING ENABLED. WE
; NEED TO LEAVE INTERRUPTS ALONE IN THIS SCENARIO
LD A,(INTSENAB) ; INTS ENABLED?
OR A ; TEST VALUE
JR Z,ASCI_INITDEV0 ; BYPASS DI/EI IF NOT ENABLED
;
; INTERRUPTS DISABLED DURING INIT
HB_DI ; DISABLE INTS
CALL ASCI_INITDEVX ; DO THE WORK
CALL ASCI_INITDEV0 ; DO THE WORK
HB_EI ; INTS BACK ON
RET ; DONE
;
ASCI_INITDEVX:
;
; THIS ENTRY POINT BYPASSES DISABLING/ENABLING INTS WHICH IS REQUIRED BY
; PREINIT ABOVE. PREINIT IS NOT ALLOWED TO ENABLE INTS!
ASCI_INITDEV0:
;
; TEST FOR -1 WHICH MEANS USE CURRENT CONFIG (JUST REINIT)
LD A,D ; TEST DE FOR

4
Source/HBIOS/audio.inc

@ -45,8 +45,8 @@ AUD_SCALE .EQU 3
; ON ENTRY, DE IS ADDRESS OF NOTE TABLE, HL IS NOTE TO PLAY
; NOTE VALUE 0 MEANS B0b/A0# IN OCTAVE 0 WHICH IS THE FIRST ENTRY
; OF THE NOTE TABLE. THE NOTE TABLE REPRESENTS THE FREQUENCIES
; FOR 1 FULL OCTAVE IN QUARTER NOTES. SINCE THERE ARE 12 NOTES
; IN AN OCTAVE, THE TABLE HAS 48 ENTRIES FOR ALL QUARTER NOTES.
; FOR 1 FULL OCTAVE IN EIGHTH TONES. SINCE THERE ARE 12 HALF TONES
; IN AN OCTAVE, THE TABLE HAS 48 ENTRIES FOR ALL EIGHTH TONES.
;
; ON EXIT, HL CONTAINS THE PERIOD VALUE TO PROGRAM INTO THE PSG
; DERIVED FROM THE NOTE TABLE SCALED TO THE REQUESTED OCTAVE.

4
Source/HBIOS/ay38910.asm

@ -556,10 +556,10 @@ AYT_REGWR .DB "\r\nOUT AY-3-8910 $"
#ENDIF
;
;======================================================================
; QUARTER TONE FREQUENCY TABLE
; EIGHTH TONE FREQUENCY TABLE
;======================================================================
;
; THE FOLLOWING TABLE MAPS A FULL OCTAVE OF QUARTER-NOTES
; THE FOLLOWING TABLE MAPS A FULL OCTAVE OF EIGHTH-TONES
; STARTING AT A# IN OCTAVE 0 TO THE CORRESPONDING PERIOD
; VALUE TO USE ON THE PSG TO ACHIEVE THE DESIRED NOTE FREQUENCY.
;

6
Source/HBIOS/cfg_DUO.asm

@ -71,6 +71,7 @@ INTMODE .SET 2 ; INTERRUPTS: 0=NONE, 1=MODE 1, 2=MODE 2, 3=MODE 3 (Z280)
;
RAMSIZE .SET 512 ; SIZE OF RAM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMSIZE .SET 512 ; SIZE OF ROM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMFONTS .SET TRUE ; LOAD FONTS FROM ROM
APP_BNKS .SET $FF ; BANKS TO RESERVE FOR APP USE ($FF FOR AUTO SIZING)
MEMMGR .SET MM_Z2 ; MEMORY MANAGER: MM_[SBC|Z2|N8|Z180|Z280|MBC|RPH|MON|EZ512]
MPGSEL_0 .SET $50 ; Z2 MEM MGR BANK 0 PAGE SELECT REG (WRITE ONLY)
@ -96,6 +97,8 @@ CTCOSC .SET (7372800/8) ; CTC CLOCK FREQUENCY
;
PCFENABLE .SET FALSE ; ENABLE PCF8584 I2C CONTROLLER
PCFBASE .SET $56 ; PCF8584 BASE I/O ADDRESS
PCFCLK .SET PCFCLK_12 ; PCF CLOCK BASE: PCFCLK_[3|443|6|8|12]
PCFTRNS .SET PCFTRNS_90 ; PCF TRANSFER SPEED: PCFTRNS_[90|45|11|15]
;
EIPCENABLE .SET FALSE ; EIPC: ENABLE Z80 EIPC (Z84C15) INITIALIZATION
;
@ -372,6 +375,9 @@ AYMODE .SET AYMODE_DUO ; AY: DRIVER MODE: AYMODE_[SCG|N8|RCZ80|RCZ180|MSX|LINC|
AY_FORCE .SET FALSE ; AY: BYPASS AUTO-DETECT, FORCED PRESENT
;
SPKENABLE .SET TRUE ; SPK: ENABLE RTC LATCH IOBIT SOUND DRIVER (SPK.ASM)
SPKPORT .SET RTCIO ; SPK: THE PORT WITH THE SPEAKER IO BIT
SPKSHADOW .SET HB_RTCVAL ; SPK: THE SHADOW VALUE FOR THE PORT THAT HAS TO BE MAINTAINED
SPKMASK .SET %00000100 ; SPK: THE BIT MASK TO ACTUALLY TOGGLE
;
DMAENABLE .SET FALSE ; DMA: ENABLE DMA DRIVER (DMA.ASM)
DMABASE .SET $40 ; DMA: DMA BASE ADDRESS

2
Source/HBIOS/cfg_DYNO.asm

@ -71,6 +71,7 @@ INTMODE .SET 2 ; INTERRUPTS: 0=NONE, 1=MODE 1, 2=MODE 2, 3=MODE 3 (Z280)
;
RAMSIZE .SET 512 ; SIZE OF RAM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMSIZE .SET 512 ; SIZE OF ROM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMFONTS .SET TRUE ; LOAD FONTS FROM ROM
APP_BNKS .SET $FF ; BANKS TO RESERVE FOR APP USE ($FF FOR AUTO SIZING)
MEMMGR .SET MM_Z180 ; MEMORY MANAGER: MM_[SBC|Z2|N8|Z180|Z280|MBC|RPH|MON|EZ512]
RAMBIAS .SET ROMSIZE ; OFFSET OF START OF RAM IN PHYSICAL ADDRESS SPACE
@ -97,7 +98,6 @@ CTCBASE .SET $88 ; CTC BASE I/O ADDRESS
CTCTIMER .SET FALSE ; ENABLE CTC PERIODIC TIMER
;
PCFENABLE .SET FALSE ; ENABLE PCF8584 I2C CONTROLLER
PCFBASE .SET $F0 ; PCF8584 BASE I/O ADDRESS
;
EIPCENABLE .SET FALSE ; EIPC: ENABLE Z80 EIPC (Z84C15) INITIALIZATION
;

2
Source/HBIOS/cfg_EPITX.asm

@ -71,6 +71,7 @@ INTMODE .SET 2 ; INTERRUPTS: 0=NONE, 1=MODE 1, 2=MODE 2, 3=MODE 3 (Z280)
;
RAMSIZE .SET 512 ; SIZE OF RAM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMSIZE .SET 512 ; SIZE OF ROM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMFONTS .SET TRUE ; LOAD FONTS FROM ROM
APP_BNKS .SET $FF ; BANKS TO RESERVE FOR APP USE ($FF FOR AUTO SIZING)
MEMMGR .SET MM_Z180 ; MEMORY MANAGER: MM_[SBC|Z2|N8|Z180|Z280|MBC|RPH|MON|EZ512]
RAMBIAS .SET ROMSIZE ; OFFSET OF START OF RAM IN PHYSICAL ADDRESS SPACE
@ -92,7 +93,6 @@ CTCBASE .SET $88 ; CTC BASE I/O ADDRESS
CTCTIMER .SET FALSE ; ENABLE CTC PERIODIC TIMER
;
PCFENABLE .SET FALSE ; ENABLE PCF8584 I2C CONTROLLER
PCFBASE .SET $F0 ; PCF8584 BASE I/O ADDRESS
;
EIPCENABLE .SET FALSE ; EIPC: ENABLE Z80 EIPC (Z84C15) INITIALIZATION
;

2
Source/HBIOS/cfg_EZZ80.asm

@ -71,6 +71,7 @@ INTMODE .SET 1 ; INTERRUPTS: 0=NONE, 1=MODE 1, 2=MODE 2, 3=MODE 3 (Z280)
;
RAMSIZE .SET 512 ; SIZE OF RAM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMSIZE .SET 512 ; SIZE OF ROM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMFONTS .SET TRUE ; LOAD FONTS FROM ROM
APP_BNKS .SET $FF ; BANKS TO RESERVE FOR APP USE ($FF FOR AUTO SIZING)
MEMMGR .SET MM_Z2 ; MEMORY MANAGER: MM_[SBC|Z2|N8|Z180|Z280|MBC|RPH|MON|EZ512]
MPGSEL_0 .SET $78 ; Z2 MEM MGR BANK 0 PAGE SELECT REG (WRITE ONLY)
@ -95,7 +96,6 @@ CTCTIMCH .SET 3 ; TIMER CHANNEL (0-3)
CTCOSC .SET CPUOSC ; CTC CLOCK FREQUENCY
;
PCFENABLE .SET FALSE ; ENABLE PCF8584 I2C CONTROLLER
PCFBASE .SET $F0 ; PCF8584 BASE I/O ADDRESS
;
EIPCENABLE .SET FALSE ; EIPC: ENABLE Z80 EIPC (Z84C15) INITIALIZATION
;

2
Source/HBIOS/cfg_FZ80.asm

@ -71,6 +71,7 @@ INTMODE .SET 0 ; INTERRUPTS: 0=NONE, 1=MODE 1, 2=MODE 2, 3=MODE 3 (Z280)
;
RAMSIZE .SET 512 ; SIZE OF RAM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMSIZE .SET 0 ; SIZE OF ROM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMFONTS .SET TRUE ; LOAD FONTS FROM ROM
APP_BNKS .SET $FF ; BANKS TO RESERVE FOR APP USE ($FF FOR AUTO SIZING)
MEMMGR .SET MM_Z2 ; MEMORY MANAGER: MM_[SBC|Z2|N8|Z180|Z280|MBC|RPH|MON|EZ512]
MPGSEL_0 .SET $78 ; Z2 MEM MGR BANK 0 PAGE SELECT REG (WRITE ONLY)
@ -95,7 +96,6 @@ CTCTIMCH .SET 3 ; TIMER CHANNEL (0-3)
CTCOSC .SET CPUOSC ; CTC CLOCK FREQUENCY
;
PCFENABLE .SET FALSE ; ENABLE PCF8584 I2C CONTROLLER
PCFBASE .SET $F0 ; PCF8584 BASE I/O ADDRESS
;
EIPCENABLE .SET FALSE ; EIPC: ENABLE Z80 EIPC (Z84C15) INITIALIZATION
;

2
Source/HBIOS/cfg_GMZ180.asm

@ -70,6 +70,7 @@ INTMODE .SET 2 ; INTERRUPTS: 0=NONE, 1=MODE 1, 2=MODE 2, 3=MODE 3 (Z280)
;
RAMSIZE .SET 512 ; SIZE OF RAM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMSIZE .SET 512 ; SIZE OF ROM IN KB (MUST MATCH YOUR HARDWARE!!!)
ROMFONTS .SET TRUE ; LOAD FONTS FROM ROM
APP_BNKS .SET $FF ; BANKS TO RESERVE FOR APP USE ($FF FOR AUTO SIZING)
MEMMGR .SET MM_Z180 ; MEMORY MANAGER: MM_[SBC|Z2|N8|Z180|Z280|MBC|RPH|MON|EZ512]
RAMBIAS .SET ROMSIZE ; OFFSET OF START OF RAM IN PHYSICAL ADDRESS SPACE
@ -91,7 +92,6 @@ CTCBASE .SET $88 ; CTC BASE I/O ADDRESS
CTCTIMER .SET FALSE ; ENABLE CTC PERIODIC TIMER
;
PCFENABLE .SET FALSE ; ENABLE PCF8584 I2C CONTROLLER
PCFBASE .SET $F0 ; PCF8584 BASE I/O ADDRESS
;
EIPCENABLE .SET FALSE ; EIPC: ENABLE Z80 EIPC (Z84C15) INITIALIZATION
;

Some files were not shown because too many files changed in this diff

Loading…
Cancel
Save