Support DLP Connection on S100 Serial I/O

Update loader for MSX

.github/pull_request_template.md

@@ -1,11 +1,13 @@
 <!--
 BEFORE YOU CREATE A PULL REQUEST:
 
-- Please base all pull requests against the dev branch
+- Please base all pull requests against the master branch
 - Include a clear description of your change
 - Reference related Issue(s) (e.g., "Resolves Issue #123")
 
 Thank you for contributing to RomWBW!  I will review your pull request as soon as possible.
 
+-Wayne
+
 DELETE EVERYTHING IN THIS COMMENT BLOCK AND REPLACE WITH YOUR COMMENTS
 -->

.github/workflows/commit.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.3.0
+        uses: actions/checkout@v4.1.1
 
       - name: Get Commit Ref
         run: |
@@ -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
@@ -36,7 +37,7 @@ jobs:
           find -type f -exec md5sum '{}' \;
 
       - name: Upload Artifact
-        uses: actions/upload-artifact@v3.1.1
+        uses: actions/upload-artifact@v4.3.0
         with:
           name: RomWBW-${{env.COMMIT_REF}}-Linux
           path: .
@@ -46,7 +47,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.3.0
+        uses: actions/checkout@v4.1.1
 
       - name: Get Commit Ref
         run: |
@@ -68,7 +69,7 @@ jobs:
           find . -type f -exec md5 -r -- '{}' +;
 
       - name: Upload Artifact
-        uses: actions/upload-artifact@v3.1.1
+        uses: actions/upload-artifact@v4.3.0
         with:
           name: RomWBW-${{env.COMMIT_REF}}-MacOS
           path: .

.github/workflows/release.yml

@@ -12,14 +12,15 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.3.0
+        uses: actions/checkout@v4.1.1
 
       - name: Build
         run: |
           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
@@ -31,6 +32,8 @@ jobs:
           echo "Tag: ${{github.ref_name}}"
           if grep -q "dev" <<< "${{github.ref_name}}"; then
             TITLE="RomWBW Development Snapshot"
+          elif grep -q "beta" <<< "${{github.ref_name}}"; then
+            TITLE="RomWBW Beta Release"
           elif grep -q "pre" <<< "${{github.ref_name}}"; then
             TITLE="RomWBW Prerelease"
           elif grep -q "rc" <<< "${{github.ref_name}}"; then
@@ -50,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

.gitignore

@@ -20,7 +20,7 @@
 
 Binary/**/*.mym
 Binary/**/*.pt3
-!Binary/cpnos-wbw.sys
+!Binary/CPNET/NetBoot/*/cpnos.sys
 
 Source/**/eeprom
 Source/Apps/Assign.com
@@ -85,6 +85,7 @@ Tools/unix/zx/zx
 !Source/BPBIOS/*.lib
 !Source/BPBIOS/Z34RCP11/cledinst.com
 !Source/BPBIOS/Z34RCP11/cledsave.com
+!Source/CPNET/**
 !Source/Fonts/*
 !Source/Images/**
 !Source/RomDsk/**
@@ -95,8 +96,11 @@ Tools/unix/zx/zx
 !Source/ZPM3/*.[Cc][Oo][Mm]
 !Source/ZSDOS/*.[Cc][Oo][Mm]
 !Source/ZRC/*.bin
+!Source/ZRC512/*.bin
+!Source/EZ512/*.bin
 !Source/Z1RCC/*.bin
 !Source/ZZRCC/*.bin
+!Source/SZ80/*.bin
 !Tools/cpm/**
 !Tools/unix/zx/*
 !Tools/zx/*
@@ -107,4 +111,94 @@ Source/ZPM3/zccp.com
 Source/ZPM3/zpmldr.com
 Source/ZPM3/genbnk.dat
 
-Source/ZSDOS/zsdos.err
+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/zmconfig.ovr
+Binary/Apps/zminit.ovr
+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
+Binary/CPM3/bios3.spr
+Binary/CPM3/bnkbdos3.spr
+Binary/CPM3/bnkbios3.spr
+Binary/CPM3/cpm3fix.pat
+Binary/CPM3/genbnk.dat
+Binary/CPM3/gencpm.dat
+Binary/CPM3/genres.dat
+Binary/CPM3/readme.1st
+Binary/CPM3/resbdos3.spr
+Binary/CPNET/cpn12duo.lbr
+Binary/CPNET/cpn12mt.lbr
+Binary/CPNET/cpn12ser.lbr
+Binary/CPNET/cpn3duo.lbr
+Binary/CPNET/cpn3mt.lbr
+Binary/CPNET/cpn3ser.lbr
+Binary/hd1k_prefix.dat
+Binary/ZPM3/bnkbdos3.spr
+Binary/ZPM3/bnkbios3.spr
+Binary/ZPM3/gencpm.dat
+Binary/ZPM3/resbdos3.spr
+Binary/ZPM3/zinstal.zpm
+Source/BPBIOS/def-ww.lib
+Source/CPNET/cpn12duo.lbr
+Source/CPNET/cpn12mt.lbr
+Source/CPNET/cpn12ser.lbr
+Source/CPNET/cpn3duo.lbr
+Source/CPNET/cpn3mt.lbr
+Source/CPNET/cpn3ser.lbr
+Source/Fonts/font8x11c.asm
+Source/Fonts/font8x11c.bin
+Source/Fonts/font8x11u.asm
+Source/Fonts/font8x16c.asm
+Source/Fonts/font8x16c.bin
+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
+Source/Fonts/fontvgarcc.asm
+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
+Source/Images/*.img
+Source/Images/blank144
+Source/Images/blankhd1k
+Source/Images/blankhd512
+Source/RomDsk/*.cat
+Source/RomDsk/*.dat
+Source/ZCPR-DJ/zcprdemo.com
+Source/ZPM3/autotog.com
+Source/ZPM3/clrhist.com
+Source/ZPM3/cpmldr.com
+Source/ZPM3/setz3.com
+Tools/unix/OpenSpin/build/
+Tools/unix/zxcc/config.h
+Tools/unix/zxcc/zxcc

.vscode/settings.json

@@ -0,0 +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.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"
+  }
+}

Binary/Apps/Clean.cmd

@@ -8,5 +8,9 @@ if exist *.hlp del *.hlp
 if exist Tunes\*.pt? del Tunes\*.pt?
 if exist Tunes\*.mym del Tunes\*.mym
 if exist Tunes\*.vgm del Tunes\*.vgm
+if exist bbcbasic.txt del bbcbasic.txt
+if exist *.cfg del *.cfg
+if exist *.fon del *.fon
 
 pushd Test && call Clean || exit /b 1 & popd
+pushd ZDE && call Clean || exit /b 1 & popd

Binary/Apps/Makefile

@@ -1,6 +1,6 @@
 TOOLS = ../../Tools
 MOREDIFF := $(shell $(TOOLS)/unix/casefn.sh *.com)
-SUBDIRS = Test
+SUBDIRS = Test ZDE
 
 include $(TOOLS)/Makefile.inc
 
@@ -8,4 +8,4 @@ all::
 	mkdir -p Tunes
 
 clean::
-	@rm -f *.bin *.com *.img *.rom *.pdf *.log *.eeprom *.ovr *.hlp *.doc *.COM *.BIN Tunes/*.mym Tunes/*.pt? Tunes/*.vgm
+	@rm -f *.bin *.com *.img *.rom *.pdf *.log *.eeprom *.ovr *.hlp *.doc *.COM *.BIN Tunes/*.mym Tunes/*.pt? Tunes/*.vgm bbcbasic.txt *.cfg *.fon

Binary/Apps/Test/inttest.doc

@@ -0,0 +1,44 @@
+INTTEST
+=======
+
+RomWBW includes an API allowing applications to "hook" interrupts.
+The `INTTEST` utility allows you to test this functionality.
+
+
+** Syntax **
+
+`INTTEST`
+
+
+** Usage **
+
+`INTTEST` is an interactive application.  At startup, it will display
+a list of the interrupt vector slots in your system along with the
+current vector address for each of them.
+
+It then prompts you to enter the slot number (in hex) of a vector to
+hook.  After entering this, the application will watch the hooked
+vector and countdown from 0xFF to 0x00 as interrupts are noted.
+
+When the counter reaches 0x00, the interrupt is unhooked and the
+application terminates.  The application can also be terminated by
+pressing <esc>.
+
+
+** Notes **
+
+If your system is running without interrupts active, the application
+will terminate immediately.
+
+All slots have vectors even if the corresponding interrupt is not
+doing anything.  In this case, the vector is pointing to the "bad
+interrupt" handler.
+
+If you hook a vector that is not receiving any interrupts, the
+down-counter will not do anything.
+
+
+** Etymology* *
+
+The `INTTEST` command is an original product and the source code is
+provided in the RomWBW distribution.

Binary/Apps/ZDE/Clean.cmd

@@ -0,0 +1,4 @@
+@echo off
+setlocal
+
+if exist *.com del *.com

Binary/Apps/ZDE/Makefile

@@ -0,0 +1,6 @@
+TOOLS = ../../../Tools
+
+include $(TOOLS)/Makefile.inc
+
+clean::
+	@rm -f *.com

Binary/Apps/ZDE/ReadMe.txt

@@ -6,12 +6,5 @@
 ***                                                                 ***
 ***********************************************************************
 
-This directory contains the CP/M 3 client tools for CP/NET.  These
-tools work only with the MT011 RCBus module.
-
-All of these files come from Douglas Miller.  Please refer to
-https://github.com/durgadas311/cpnet-z80 for more information and
-the latest source code.
-
-In general, to use CP/NET on RomWBW, it is intended that you will
-copy all of these files into your user 0 directory.
+This directory contains the ZDE executable binaries.  They are
+in their original, unconfigured state.

Binary/CPM22/Clean.cmd

@@ -0,0 +1,4 @@
+@echo off
+setlocal
+
+if exist *.sys del *.sys

Binary/CPM22/Makefile

@@ -0,0 +1,7 @@
+TOOLS = ../../Tools
+MOREDIFF := $(shell $(TOOLS)/unix/casefn.sh *.spr)
+
+include $(TOOLS)/Makefile.inc
+
+clean::
+	@rm -f *.sys

Binary/CPM22/ReadMe.txt

@@ -0,0 +1,23 @@
+***********************************************************************
+***                                                                 ***
+***                          R o m W B W                            ***
+***                                                                 ***
+***                    Z80/Z180 System Software                     ***
+***                                                                 ***
+***********************************************************************
+
+This directory contains the CP/M 2.2 system files for the RomWBW CP/M 2.2
+adaptation.  All of these files are already included on the CP/M
+boot disk images.  However if you are creating a CP/M boot disk
+manually, you should copy all of these files to the boot disk.
+
+Note: Two file have been provided one for RomWBW HBIOS, and one for UNA
+BIOS. One of these files must be installed on the system boot track.
+This is usually achieved by the SYSCOPY utility e.g.
+
+SYSCOPY a:=cpm_wbw.sys
+
+These files should also be copied to any CP/M 2.2 boot disks on your
+system when you upgrade your ROM firmware.  Some of these files
+*must* match the version of the RomWBW firmware you are using for
+proper operation of your system.

Binary/CPNET/Clean.cmd

@@ -0,0 +1,4 @@
+@echo off
+setlocal
+
+if exist *.lbr del *.lbr

Binary/CPNET/Makefile

@@ -0,0 +1,7 @@
+TOOLS = ../../Tools
+MOREDIFF := $(shell $(TOOLS)/unix/casefn.sh *.lbr)
+
+include $(TOOLS)/Makefile.inc
+
+clean::
+	@rm -f *.lbr

Binary/CPNET/ReadMe.txt

@@ -0,0 +1,38 @@
+***********************************************************************
+***                                                                 ***
+***                          R o m W B W                            ***
+***                                                                 ***
+***                    Z80/Z180 System Software                     ***
+***                                                                 ***
+***********************************************************************
+
+This directory contains the CP/NET client packages.  Please refer to 
+the RomWBW User Guide for instructions on installing these packages.  
+Either the MT011 RCBus module or the Duodyne Disk I/O board is required.
+
+All of these files come from Douglas Miller.  Please refer to
+https://github.com/durgadas311/cpnet-z80 for more information, complete
+documentation and the latest source code.  Refer to the RomWBW
+User Guide for basic installation and usage instructions under RomWBW.
+
+| 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   |
+
+In general, to use CP/NET on RomWBW, it is intended that you will
+extract the appropriate set of files into your default directory in
+user area 0.  Refer to the RomWBW User Guide for more information.
+
+The libraries include enhanced help files appropriate for the version 
+of CP/NET.  Rename the desired topic collection to HELP.HLP on the
+target system.
+
+CPM2NET.HLP	CP/M 2.2 basic system with CP/NET 1.2
+CPNET12.HLP	CP/NET 1.2 help only
+CPM3NET.HLP	CP/M 3 basic system with CP/NET 3
+CPNET3.HLP	CP/NET 3 help only
+
+-- WBW 7:14 AM 2/11/2024

Binary/Clean.cmd

@@ -12,5 +12,9 @@ if exist *.pdf del *.pdf
 if exist *.eeprom del *.eeprom
 
 pushd Apps && call Clean || exit /b 1 & popd
+pushd CPM22 && call Clean || exit /b 1 & popd
 pushd CPM3 && call Clean || exit /b 1 & popd
+pushd QPM && call Clean || exit /b 1 & popd
+pushd ZSDOS && call Clean || exit /b 1 & popd
 pushd ZPM3 && call Clean || exit /b 1 & popd
+pushd CPNET && call Clean || exit /b 1 & popd

Binary/Makefile

@@ -1,6 +1,6 @@
 TOOLS = ../Tools
 MOREDIFF := $(shell $(TOOLS)/unix/casefn.sh *.img *.rom *.com *.eeprom)
-SUBDIRS = Apps CPM3 ZPM3
+SUBDIRS = Apps CPM22 CPM3 QPM ZSDOS ZPM3 CPNET
 
 include $(TOOLS)/Makefile.inc
 

Binary/QPM/Clean.cmd

@@ -0,0 +1,4 @@
+@echo off
+setlocal
+
+if exist *.sys del *.sys

Binary/QPM/Makefile

@@ -0,0 +1,7 @@
+TOOLS = ../../Tools
+MOREDIFF := $(shell $(TOOLS)/unix/casefn.sh *.spr)
+
+include $(TOOLS)/Makefile.inc
+
+clean::
+	@rm -f *.sys *.bin

Binary/QPM/ReadMe.txt

@@ -0,0 +1,21 @@
+***********************************************************************
+***                                                                 ***
+***                          R o m W B W                            ***
+***                                                                 ***
+***                    Z80/Z180 System Software                     ***
+***                                                                 ***
+***********************************************************************
+
+This directory contains the QPM 2.7 system files for the RomWBW QPM 2.7
+adaptation.  All of these files are already included on the QPM
+boot disk images.  However if you are creating a QPM boot disk
+manually, you should copy all of these files to the boot disk.
+
+Note: Two file have been provided one for RomWBW HBIOS, and one for UNA
+BIOS. One of these files must be installed on the system boot track.
+Refer to the QPM Documentation for installing QPM
+
+These files should also be copied to any QPM boot disks on your
+system when you upgrade your ROM firmware.  Some of these files
+*must* match the version of the RomWBW firmware you are using for
+proper operation of your system.

Binary/ReadMe.txt

@@ -6,37 +6,37 @@
 ***                                                                 ***
 ***********************************************************************
 
-This directory ("Binary") is part of the RomWBW System Software 
-distribution archive.  It contains the completed binary outputs of 
-the build process.  As described below, these files are used to 
+This directory ("Binary") is part of the RomWBW System Software
+distribution archive.  It contains the completed binary outputs of
+the build process.  As described below, these files are used to
 assemble a working RetroBrew Computers system.
 
-The files in this directory are created by the build process that is 
-documented in the ReadMe.txt file in the Source directory.  When 
-released the directory is populated with the default output files.  
-However, the output of custom builds will be placed in this directory 
+The files in this directory are created by the build process that is
+documented in the ReadMe.txt file in the Source directory.  When
+released the directory is populated with the default output files.
+However, the output of custom builds will be placed in this directory
 as well.
 
-If you only see a few files in this directory, then you downloaded 
-just the source from GitHub.  To retrieve the full release download 
-package, go to https://github.com/wwarthen/RomWBW.  On this page, 
-look for the text "XX releases" where XX is a number. Click on this 
-text to go to the releases page.  On this page, you will see the 
-latest releases listed.  For each release, you will see a package 
-file called something like "RomWBW-2.9.0-Package.zip".  Click on the 
+If you only see a few files in this directory, then you downloaded
+just the source from GitHub.  To retrieve the full release download
+package, go to https://github.com/wwarthen/RomWBW.  On this page,
+look for the text "XX releases" where XX is a number. Click on this
+text to go to the releases page.  On this page, you will see the
+latest releases listed.  For each release, you will see a package
+file called something like "RomWBW-2.9.0-Package.zip".  Click on the
 package file for the release you want to download.
 
 ROM Firmware Images (<plt>_<cfg>.rom)
 -------------------------------------
 
-The files with a ".rom" extension are binary images ready to program 
-into an appropriate PROM.  These files are named with the format 
-<plt>_<cfg>.rom. <plt> refers to the primary platform such as Zeta, 
-N8, Mark IV, etc.  <cfg> refers to the specific configuration.  In 
-general, there will be a standard configuration ("std") for each 
-platform.  So, for example, the file called MK4_std.rom is a ROM 
-image for the Mark IV with the standard configuration. If a custom 
-configuration called "custom" is created and built, a new file called 
+The files with a ".rom" extension are binary images ready to program
+into an appropriate PROM.  These files are named with the format
+<plt>_<cfg>.rom. <plt> refers to the primary platform such as Zeta,
+N8, Mark IV, etc.  <cfg> refers to the specific configuration.  In
+general, there will be a standard configuration ("std") for each
+platform.  So, for example, the file called MK4_std.rom is a ROM
+image for the Mark IV with the standard configuration. If a custom
+configuration called "custom" is created and built, a new file called
 MK4_custom.rom will be added to this directory.
 
 Documentation of the pre-built ROM Images is contained in
@@ -54,52 +54,52 @@ contents.  Refer to the RomWBW User Guide for more information.
 ROM Executable Images (<plt>_<cfg>.com)
 ---------------------------------------
 
-When a ROM image (".rom") is created, an executable version of the 
-ROM is also created.  These files have the same naming convention as 
-the ROM Image files, but have the extension ".com".  These files can 
+When a ROM image (".rom") is created, an executable version of the
+ROM is also created.  These files have the same naming convention as
+the ROM Image files, but have the extension ".com".  These files can
 be copied to a working system and run like a normal CP/M application.
 
-When run on the target system, they install in RAM just like they had 
+When run on the target system, they install in RAM just like they had
 been loaded from  ROM.  This allows a new ROM build to be tested
 without reprogramming the actual ROM.
 
-WARNING: In a few cases the .com file is too big to load.  If you get 
-a message like "Full" or "BAD LOAD" when trying to load one of the 
-.com files, it is too big.  In these cases, you will not be able to 
+WARNING: In a few cases the .com file is too big to load.  If you get
+a message like "Full" or "BAD LOAD" when trying to load one of the
+.com files, it is too big.  In these cases, you will not be able to
 test the ROM prior to programming it.
 
 VDU ROM Image (vdu.rom)
 -----------------------
 
-The VDU video board requires a dedicated onboard ROM containing the 
-font data.  The "vdu.rom" file contains the binary data to program 
+The VDU video board requires a dedicated onboard ROM containing the
+font data.  The "vdu.rom" file contains the binary data to program
 onto that chip.
 
-Disk Images (fd_*.img, hd_*.img, psys.img)
-------------------------------------------
+Disk Images (fd_*.img, hd_*.img)
+--------------------------------
 
-RomWBW includes a mechanism for generating floppy disk and hard disk 
-binary images that are ready to copy directly to a floppy, hard disk, 
-CF Card, or SD Card which will then be ready for use in any 
+RomWBW includes a mechanism for generating floppy disk and hard disk
+binary images that are ready to copy directly to a floppy, hard disk,
+CF Card, or SD Card which will then be ready for use in any
 RomWBW-based system.
 
-Essentially, these files contain prepared floppy and hard disk images 
-with a large set of programs and related files.  By copying the 
-contents of these files to appropriate media as described below, you 
+Essentially, these files contain prepared floppy and hard disk images
+with a large set of programs and related files.  By copying the
+contents of these files to appropriate media as described below, you
 can quickly create ready-to-use media.  Win32DiskImager or
 RawWriteWin can be used to copy images directly to media.  These
 programs are included in the RomWBW Tools directory.
 
-The fd_*.img files are floppy disk images.  They are sized for 1.44MB 
-floppy media and can be copied to actual floppy disks using 
-RawWriteWin (as long as you have access to a floppy drive on your 
-Windows computer).  The resulting floppy disks will be usable on any 
+The fd_*.img files are floppy disk images.  They are sized for 1.44MB
+floppy media and can be copied to actual floppy disks using
+RawWriteWin (as long as you have access to a floppy drive on your
+Windows computer).  The resulting floppy disks will be usable on any
 RomWBW-based system with floppy drive(s).
 
-Likewise, the hd512_*.img and hd1k_*.img files are hard disk images.  
-Each file is intended to be copied to the start of any type of hard 
-disk media (typically a CF Card or SD Card). The resulting media will 
-be usable on any RomWBW-based system that accepts the corresponding 
+Likewise, the hd512_*.img and hd1k_*.img files are hard disk images.
+Each file is intended to be copied to the start of any type of hard
+disk media (typically a CF Card or SD Card). The resulting media will
+be usable on any RomWBW-based system that accepts the corresponding
 media type.
 
 NOTE: The hd512_*.img files are equivalent to the hd_*.img
@@ -109,37 +109,86 @@ maximum number of CP/M directory entries from 512 to 1024.
 Refer to the ReadMe.txt in the Source/Images directory
 for details.
 
-Documentation of the pre-built disk images is contained in the 
-DiskList.txt file in this directory.
+Documentation of the pre-built disk images is contained in the
+"RomWBW User Guide" found in the Doc directory.  The contents of
+the disk images is contained in the "RomWBW Disk Catalog", but it
+is significantly out-of-date.
 
-The contents of the floppy/hard disk images are created by 
-the BuildImages.cmd script in the Source directory.  Additional 
-information on how to generate custom disk images is found in the 
+The contents of the floppy/hard disk images are created by
+the BuildImages.cmd script in the Source directory.  Additional
+information on how to generate custom disk images is found in the
 Source\Images ReadMe.txt file.
 
-The psys.img file contains a full implementation of the UCSD p-System 
-for the Z80 running under RomWBW.  This image file must be placed on 
-disk media by itself (not appended or concatenated with hd*.img files.  
-Refer to the Source/pSys/ReadMe.txt file for more information on the 
+Disk Images (hd512_combo.img, hd1k_combo.img, *_std_hd1k_combo.img)
+-------------------------------------------------------------------
+
+The hd512_combo.img and hd1k_combo.img file are the primary combo
+disk image files suitable for most platforms.
+
+The *_std_hd1k_combo.img files are platform specific combo files
+typically used in romless platforms, they also contain RomWBW binary code
+that is loaded at boot time into RAM
+
+Disk Images (hd1k_prefix.dat, *_std_hd1k_prefix.dat)
+----------------------------------------------------
+
+The hd1k_prefix.dat file is part of the combo disk images and is
+applied to hd1k image files as a prefix, it contains the standard
+partion table.
+
+The *_std_hd1k_prefix.dat files are platform specific prefixes
+typically used in romless platforms, they also contain RomWBW binary code
+that is loaded at boot time into RAM
+
+Disk Images (psys.img)
+----------------------
+
+The psys.img file contains a full implementation of the UCSD p-System
+for the Z80 running under RomWBW.  This image file must be placed on
+disk media by itself (not appended or concatenated with hd*.img files.
+Refer to the Source/pSys/ReadMe.txt file for more information on the
 p-System implementation.
 
 Propeller ROM Images (*.eeprom)
 -------------------------------
 
-The files with and extension of ".eeprom" contain the binary images 
-to be programmed into the Propeller-based boards.  The list below 
+The files with and extension of ".eeprom" contain the binary images
+to be programmed into the Propeller-based boards.  The list below
 indicates which file targets each of the Propeller board variants:
 
 	ParPortProp	ParPortProp.eeprom
 	PropIO V1	PropIO.eeprom
 	PropIO V2	PropIO2.eeprom
 
-Refer to the board documentation of the boards for more information 
+Refer to the board documentation of the boards for more information
 on how to program the EEPROMs on these boards.
 
+SUB DIRECTORIES
+===============
+
 Apps Directory
 --------------
 
 The Apps subdirectory contains the executable application files that
 are specific to RomWBW.  The source for these applications is found
-in the Source\Apps directory of the distribution.
+in the Source\Apps directory of the distribution.
+
+CPNET Directory
+---------------
+
+This directory contains the CP/NET client packages.  Please refer to
+the RomWBW User Guide for instructions on installing these packages,
+or see the Readme.txt file in this sub-directory
+
+CPM22 CPM3 ZSDOS ZPM3 QPM Directories
+-------------------------------------
+
+These directories contains the system files for the RomWBW adaptations
+for each operating system.  All of these files are already included on
+the boot disk images.  However if you are creating a o/s boot disk
+manually, you will need copy all of these files to the boot disk.
+
+These files should also be copied to any boot disks on your
+system when you upgrade your ROM firmware.  Some of these files
+*must* match the version of the RomWBW firmware you are using for
+proper operation of your system.

Binary/ZSDOS/Clean.cmd

@@ -0,0 +1,4 @@
+@echo off
+setlocal
+
+if exist *.sys del *.sys

Binary/ZSDOS/Makefile

@@ -0,0 +1,7 @@
+TOOLS = ../../Tools
+MOREDIFF := $(shell $(TOOLS)/unix/casefn.sh *.spr)
+
+include $(TOOLS)/Makefile.inc
+
+clean::
+	@rm -f *.sys

Binary/ZSDOS/ReadMe.txt

@@ -0,0 +1,23 @@
+***********************************************************************
+***                                                                 ***
+***                          R o m W B W                            ***
+***                                                                 ***
+***                    Z80/Z180 System Software                     ***
+***                                                                 ***
+***********************************************************************
+
+This directory contains the ZSDOS system files for the RomWBW ZSDOS
+adaptation.  All of these files are already included on the ZSDOS
+boot disk images.  However if you are creating a ZSDOS boot disk
+manually, you should copy all of these files to the boot disk.
+
+Note: Two file have been provided one for RomWBW HBIOS, and one for UNA
+BIOS. One of these files must be installed on the system boot track.
+This is usually achieved by the SYSCOPY utility e.g.
+
+SYSCOPY a:=zsys_wbw.sys
+
+These files should also be copied to any ZSDOS boot disks on your
+system when you upgrade your ROM firmware.  Some of these files
+*must* match the version of the RomWBW firmware you are using for
+proper operation of your system.

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing to RomWBW
+
+> **WARNING**: The `dev` branch of RomWBW has been deprecated as of v3.4.  All Pull Requests should now target the `master` branch.
+
+Contributions of all kinds to RomWBW are welcomed and greatly appreciated.
+
+- Reporting bug(s) and suggesting new feature(s)
+- Discussing the current state of the code
+- Submitting a fixes and enhancements
+
+## RomWBW GitHub Repository
+
+The [RomWBW GitHub Repository](https://github.com/wwarthen/RomWBW) is the primary location for developing, supporting, and distributing RomWBW.  Although input is gladly accepted from almost any channel, the GitHub Repository is preferred.
+
+- Use **Issues** to report bugs, request enhancements, or ask usage questions.
+- Use **Discussions** to interact with others
+- Use **Pull Requests** to submit content (code, documentation, etc.)
+
+## Submitting Content
+
+This RomWBW Project uses the standard [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow).  Submission of content changes (including code) are ideally done via Pull Requests.
+
+- Submitters are advised to contact [Wayne Warthen](mailto:wwarthen@gmail.com) or start a GitHub Discussion prior to starting any significant work.  This is simply to ensure that submissions are consistent
+  with the overall goals and intentions of RomWBW.
+- All submissions should be based on the `master` branch.  To create your submission, fork the RomWBW repository and create your branch from `master`.  Make (and test) your changes in your personal fork.
+- Please update relevant documentation and the `ChangeLog` found in the `Doc` folder.
+- You are encouraged to comment your submissions to ensure your work is properly attributed.
+- When ready, submit a Pull Request to merge your forked branch into the RomWBW master branch.
+
+## Coding Style
+
+Due to the nature of the project, you will find a variety of coding styles.  When making changes to existing code, please try to be consistent with the existing coding style.  You may not like the current style, but no one likes mixed styles
+in one file/module.
+
+Be careful with white space.  RomWBW is primarily assembly langauge code.  The use of tab stops at every 8 characters is pretty standard for assembler.  If you use something else, then your code will look odd when viewed by others.
+
+In most cases, the use of `<cr><lf>` line endings is preferred.  This is standard for the operating systems of the era that RomWBW provides.  Also note that CP/M text files should end with a ctrl-Z (0x1A).  This is not magically added by the
+tools that generate the disk images.
+
+## License
+
+RomWBW is licensed under GPLv3.  When you submit code changes, your submissions are understood to be under the same [GPLv3 License](https://www.gnu.org/licenses/gpl-3.0.html) that covers the project.

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) |
+

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.

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.
+

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.
+
+

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.

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.

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.
+
+
+

Doc/CPM/ReadMe.txt

@@ -0,0 +1,83 @@
+***********************************************************************
+***                                                                 ***
+***                          R o m W B W                            ***
+***                                                                 ***
+***                    Z80/Z180 System Software                     ***
+***                                                                 ***
+***********************************************************************
+
+This directory ("Doc/CPM") is part of the RomWBW System Software
+distribution archive.  It contains documentation for the CP/M and
+CP/M work-alike operating system components of the system.
+
+
+CPM Manual ("CPM Manual.pdf")
+-----------------------------
+
+The original DRI CP/M 2.x Operating System Manual.  This should be
+considered the primary reference for system operation.  The section
+on CP/M 2 Alteration can be ignored since this work has already been
+completed as part of the RomWBW distribution.
+
+
+CPM3 Command Summary ("CPM3 Command Summary.pdf")
+CPM3 Programmer's Guide ("CPM3 Programmers Guide.pdf")
+CPM3 System Guide ("CPM3 System Guide.pdf")
+CPM3 User's Guide ("CPM3 Users Guide.pdf")
+------------------------------------------------------
+
+The original DRI CP/M 3.0 Operating System Documentation Set.  This
+should be considered the primary reference for CP/M 3 system operation.
+
+
+NZCOM, Z3PLUS, and replace ZCPR3.3 Documentation
+------------------------------------------------
+
+NZCOM operating system operation manual. ("NZCOM Users Manual.pdf")
+Z3PLUS operating system operation manual.  ("Z3PLUS Users Manual.pdf")
+Z-System User Guide ("Z-System User Guide.pdf")
+ZCPR3.3 Users Guide ("ZCPR3.3 Users Guide.pdf")
+
+
+QP/M 2.7 Installation Guide and Supplements ("qpm27.pdf")
+QP/M 2.7 Interface Guide ("qdos27.pdf")
+QP/M 2.7 Features and Facilities ("qcp27.pdf")
+--------------------------------------------
+
+Official documentation set for QP/M 2.7 from original QP/M distribution.
+
+
+ZCPR Manual ("ZCPR Manual.pdf")
+-------------------------------
+
+ZCPR is the command proccessor portion of Z-System.  This is the
+manual for ZCPR 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.
+
+ZCPR D&J Manual ("ZCPR-DJ.doc")
+-------------------------------
+
+ZCPR D&J User Manual.  This manual supplements the ZCPR Manual.
+
+
+ZSDOS Manual ("ZSDOS Manual.pdf")
+ZSDOS Programmer's Manual ("ZSDOS Programmers Manual.pdf")
+---------------------------------
+
+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.
+
+The ZSDOS Programmer's Manual is also included courtesy of Wayne 
+Hortensius and Randy Merkel.  This manual includes documentation of the
+ZSDOS BDOS API enhancements.
+
+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

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.
+

Doc/ChangeLog.txt

@@ -1,10 +1,150 @@
+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)
+- MGG: Added sample program source files for all language disk iamges
+- WBW: Added support for S100 Dual CF Interface
+- WBW: Added support for S100 ESP32 SD Interface
+- MAP: User guide. Reorder sections around disk formatting
+- R?M: Randy Merkel provided ZSDOS Programmer's Manual as translated by Wayne Hortensius
+- WBW: Updated Cowgol disk image with latest COWFIX.COM from Ladislau Szilagyi
+- WBW: Preliminary support for S100 Computers Z80 CPU
+- HJB: Added MSX platform
+- M?R: Update Timer app with "zero" option
+- HJB: Update PPIDE driver, add support for MSX BEER IDE interface
+- HJB: Added loader for MSX
+- HJB: Added IDE driver master media detect option
+- WBW: Add support for S100 Serial I/O DLP Serial connection
+
+Version 3.5.1
+-------------
+- WBW: Fix CPMLDR.SYS & ZPMLDR.SYS for SYSCOPY (reported by Guido Santer)
+- MAP: Enhanced SLR Tools Disk Image with Plus versions
+- WBW: Add missing BCLOAD file to MS BASIC Compiler Disk Image (reported by Marshall Gates)
+- WBW: Doc improvements (per Fraser and Rob Gowin)
+- WBW: Correct ZMP application crash
+- MAP: Contribution of the SLABEL.COM tool for displaying and changing slice labels.
+- MAP: Hardware documentation, Significant new content added with project links.
+
+Version 3.5
+-----------
+- M?F: Fix for hours display in HBRTC application
+- M?F: Fix for assembly error in DS1501RTC driver
+- WBW: Add VT-100 graphics char selection to Propeller firmware
+- WBW: Allow all lines of VGA display to be used on Propeller firmware
+- WBW: Allow front panel LED/Switch bits to be inverted in config
+- WBW: Add API to expose application banks available
+- WBW: Added console takeover at boot loader prompt
+- L?N: Fixed Propeller font vertical line character to align properly
+- L?S: EF9345 video display controller driver
+- WBW: Added Cowgol disk image based on the work of Ladislau Szilagyi
+- WBW: Added support for CP/NET on Duodyne Disk I/O
+- DDW: Added support for Duodyne Media board
+- WBW: Auto restore TMS video on user reset (CP/M warm boot)
+- L?B: Added support for NABU w/ RomWBW Option Board
+- MAP: Reorganization of Doc directory introducing subfolders
+- WBW: Upgraded BBCBASIC to v5.00
+- W?S: Updated FLASH utility to v1.3.9
+- WBW: Support RCBus PS/2 Keyboard (EP/Sally)
+- M?R: Update Timer app to display output in decimal
+- WBW: Preliminary support for S100 FPGA Z80 platform
+- WBW: Added simple serial (SSER) driver
+- WBW: Added preliminary support for S100 FPGA Z80 SD Cards
+- M?R: Consolidated ROM Applications document into the Applications document
+- M?R: Reviewed and substantially improved the Applications document
+- WBW: Added support for DS1305 RTC on S100 FPGA Z80
+- WBW: Added support for Les Bird's RCBus Graphics/Sound/Joystick module
+- WBW: Added support for Les Bird's Dual 16C550 UART module
+- WBW: Refactor UART driver for more flexible configuration
+- M?R: Added hour/minute/second display to timer app
+- WBW: Substantial customization of NZ-COM disk image
+- WBW: Refactor build post-processing (ZRC, ZZRCC, etc.)
+- MAP: Improved section Real Time Clock in User Guide document
+- WBW: Support for Hitachi HD44780-based LCD display
+- DRJ: Added support for Genesis STD Bus Z180 platform
+- MAP: Improved section Disk Management in User Guide document
+- WBW: Add CPU speed selection for HEATH platform to HBIOS
+- WBW: Add Warm/Cold reboot options to CPUSPD utility
+- D?N: Added support for eZ80 CPU
+- MAP: Contributed COPYSL utility that allows disk slices to be copied
+- MAP: Added new HBIOS function EXT_SLICE, extended disk slice info
+- MAP: ROMLDR now uses EXT_SLICE to get Slice Sector for boot
+- MAP: CBIOS now uses EXT_SLICE during drive selection
+- MAP: CPM3 Boot Loader, and BIOS (drive select) now use EXT_SLICE
+- M?R: Added REBOOT application
+- MAP: Significant improvement in Disk Catalog document
+- MAP: Added Disk Image for the Z3PLUS (Z-System for CP/M-Plus) os.
+- H?H: Fix XModem 12.3 WRERR to put CAN char in proper register to send.
+- MAP: Added support for dynamic HBIOS config via (RTC) NVRAM
+- MAP: Added boot application to allow config of NVRAM options
+- MAP: Configuration of autoboot disk/app added to NVRAM config
+- WBW: Autoboot is now handled in separate prompt during RomWBW startup
+- MAP: Added additional tools (Linker/Disasembler) to the Z80ASM Disk Image
+- PMS: Support interrupt-driven PS2 Keyboard Interface
+- D?M: Added NetBoot support for Duodyne
+- WBW: Add options to TUNE/HBIOS to force detection of MSX and RC AY/YM standard PSG ports
+- MAP: Added /B=OPTIONS for automated drive assignment to ASSIGN.COM
+- WBW: Added TE Editor (Ladislau Szilagyi)
+- WBW: Refresh Cowgol disk image (Ladislau Szilagyi)
+
 Version 3.4
 -----------
 NOTE: Changes require HBIOS/CBIOS/Apps sync, version bump to 3.4 to ensure integrity
 - WBW: Device type number moved from upper nibble to full byte
+- A?C: Support for EP ITX-Mini Z180 Platform
+- M?R: Significant improvement in User Guide document
+- J?P: Preliminary support for Monsputer (MON)
+- JLC: Standardize TMS driver memory map for compatibility
+- WBW: Improved IDE device detection
+- WBW: Fixed decompression when run on Z280
+- K?B: WDATE generic HBIOS date/time utility
+- WBW: Create new DSKY framework with simple driver style interface
+- JBL: Added ColecoVision config in TMS driver
+- WBW: Added support for interrupt mode 1 on Z180
+- WBW: Added S100 platform
+- WBW: Added Duodyne platform
+- WBW: Incorporated John Monahan's S100 Monitor in S100 platform build
+- WBW: Support ESP32 on Duodyne
+- M?C: Fixed port specification when using XM.COM send transfers
+- PMS: Support for Duodyne DMA
+- WBW: Added Serial ROM (SROM.COM) utility
+- WBW: Support S100 Propeller Console
+- SCC: Added support for SC700
+- WBW: Added Heath H8 platform
+- D?J: Enhanced build to run on Raspberry Pi 4
+- WBW: Complete overhaul of ROMless boot operation
+- WBW: Prevent access to slices outside of partition
+- T?P: Contributed the HTALK utility
+- WBW: CTS stall detection
+- W?S: Updated FLASH utility to v1.3.7
+- L?N: Updated UNARC to new OS universal version
+- B?C: Added support for Z1RCC
+- M?R: User Guide enhancements and corrections
+- D?H: Added support for specification of secondary console
+- WBW: Added platform for Monsputer
+- WBW: Added FAT.COM to standard ROM Disk (removed RMAC.COM & LINK.COM)
 
 Version 3.3
 -----------
+NOTE: v3.3 was never released
 - WBW: Support Front Panel switches
 - A?C: Preliminary support for Z80-Retro
 - A?C: Support for SD PIO
@@ -12,7 +152,7 @@ Version 3.3
 - WBW: Support per-drive floppy configuration
 - WBW: Support for Bill Shen's VGARC
 - WBW: Support for MG014 Parallel Port module + printer
-- WBW: Support for EMM Zip Drive on PPI interface (much inspiration from Alan Cox)
+- WBW: Support for IMM Zip Drive on PPI interface (much inspiration from Alan Cox)
 - WBW: Support for PPA Zip Drive on PPI interface (much inspiration from Alan Cox)
 - WBW: Support for SyQuest SparQ Drive on PPI interface (much inspiration from Alan Cox)
 - WBW: Support for ATAPI Disk Drives (not CD-ROMs) on IDE and PPIDE interfaces
@@ -632,4 +772,4 @@ interrupts disabled the BIOS will now start OK even if some vagrant
 hardware is asserting an interrupt (DISKIO).  Seems like this is better
 anyway -- general idea is that we only enable interupts precisely
 when desired for very specific controled purposes since there is no
-concept of interrupt dispatching available.
+concept of interrupt dispatching available.

Doc/Contrib/ZSystem.txt

@@ -4,7 +4,7 @@ ZSDOS Adaptation Notes for RomWBW
 Wayne Warthen
 wwarthen@gmail.com
 
-This file is a log of the work done to adapt the ZSDOS distribution to the N8VEM platforms under RomWBW.  I strongly recommend reviewing the zsdos.pdf file in the Doc directory.
+This file is a log of the work done to adapt the ZSDOS distribution to the N8VEM platforms under RomWBW.  I strongly recommend reviewing the zsdos.pdf file in the Doc/CPM directory.
 
 The starting point was the general public release of ZSDOS that is generally available.  The first line of the README file is "ZSDOS-GP.  General Public Release of the ZSDOS 1.x Operating System."
 
@@ -20,7 +20,7 @@ Beyond the construction and integration of the actual DOS itself, the majority o
 
 The remainder of this document details the changes I made as I went along.  In all cases, my goal was to keep the result as close to the original distribution as possible.  I started by copying all of the files from the distribution (contained in zsdos2.zip) into Support\ZSDOS.  From there I tested, modified, updated, and customized as documented below.  Finally, I cherry picked files that made sense to include on the ZSystem ROM disks.
 
-1. CLOCKS.DAT has been updated to include the RomWBW clock driver, HBCLK.  I have also added the SIMHCLOK clock driver.
+1. CLOCKS.DAT has been updated to include the RomWBW clock driver, WBWCLK.  I have also added the SIMHCLOK clock driver.
 
 2. STAMPS.DAT has been replaced with an updated version.  The update was called STAMPS11.DAT and was found on the Walnut Creek CP/M CDROM.  The original version has a bug that prevents RSX (resident system extension) mode to load properly.
 
@@ -52,4 +52,4 @@ Usage Notes
 
 6. After using PUTDS to initialize a directory for ZDS date stamping, I am finding that it is necessary to run RELOG before the stamping routines will actually start working.
 
-7. Generic CP/M PIP and ZSDOS path searching do not play well together if you use PIP to copy to or from a directory in the ZSDOS search path.  Best to use COPY from the ZSDOS distribution.
+7. Generic CP/M PIP and ZSDOS path searching do not play well together if you use PIP to copy to or from a directory in the ZSDOS search path.  Best to use COPY from the ZSDOS distribution.

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"

Doc/Language/ReadMe.txt

@@ -0,0 +1,70 @@
+***********************************************************************
+***                                                                 ***
+***                          R o m W B W                            ***
+***                                                                 ***
+***                    Z80/Z180 System Software                     ***
+***                                                                 ***
+***********************************************************************
+
+This directory ("Doc/Language") is part of the RomWBW System Software
+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")
+-----------------------------------------------------------------
+
+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")
+------------------------------------------------------------------------------------
+
+Official user manual Borland TurboPascal included in the pascal disk image.
+
+
+The Cowgol Lanaguage ("The Cowgol Language.pdf")
+Cowgol Compiler Manual ("Cowgol Compiler Manual.pdf")
+
+--------------------------------------
+
+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 Messages ("HI-TECH Z80 C Compiler Messages.txt")
+------------------------------------------------------------------
+
+Official user manual for the HI-TECH C Compiler included in the
+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")
+---------------------------------------------------------------------------------------
+
+Official manual for Microsoft BASIC as included in RomWBW.
+
+
+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")
+----------------------------------------------------
+
+Official user manual for the Z80 Macro Assembler by SLR Systems
+included in the z80asm disk image.
+
+
+
+
+
+

Doc/ReadMe.txt

@@ -10,18 +10,31 @@ This directory ("Doc") is part of the RomWBW System Software
 distribution archive.  It contains documentation for components of
 the system.
 
+CPM (Directory)
+---------------
+
+Documentation specific to CP/M, including all versions and derivatives.
+
+
+Language (Directory)
+--------------------
+
+Documentation specific to programming languages, provided with the system
+
+
 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")
-RomWBW ROM Applications ("RomWBW ROM Applications.pdf")
 RomWBW Disk Catalog ("RomWBW Disk Catalog.pdf")
-RomWBW Errata ("RomWBW Errata.pdf")
+RomWBW Hardware ("RomWBW Hardware.pdf")
+
 -------------------------------------------------------
 
 Documentation set for RomWBW.  The primary document is the
@@ -31,25 +44,6 @@ and utilities are detailed in the  Applications and
 ROM Applications documents.
 
 
-CPM Manual ("CPM Manual.pdf")
------------------------------
-
-The original DRI CP/M 2.x Operating System Manual.  This should be
-considered the primary reference for system operation.  The section
-on CP/M 2 Alteration can be ignored since this work has already been
-completed as part of the RomWBW distribution.
-
-
-CPM3 Command Summary ("CPM3 Command Summary.pdf")
-CPM3 Programmer's Guide ("CPM3 Programmers Guide.pdf")
-CPM3 System Guide ("CPM3 System Guide.pdf")
-CPM3 User's Guide ("CPM3 Users Guide.pdf")
-------------------------------------------------------
-
-The original DRI CP/M 3.0 Operating System Documentation Set.  This
-should be considered the primary reference for CP/M 3 system operation.
-
-
 DDTZ Manual ("DDTZ.doc")
 ------------------------
 
@@ -69,47 +63,6 @@ Hard Disk Anatomy ("Hard Disk Anatomy.pdf")
 Diagram of a CP/M & MS-DOS (FAT) hybrid hard disk layout.
 
 
-NZCOM User's Manual ("NZCOM Users Manual.pdf")
-----------------------------------------------
-
-NZCOM operating system operation manual.
-
-
-ZCPR Manual ("ZCPR Manual.pdf")
--------------------------------
-
-ZCPR is the command proccessor portion of Z-System.  This is the
-manual for ZCPR 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.
-
-ZCPR D&J Manual ("ZCPR-DJ.doc")
--------------------------------
-
-ZCPR D&J User Manual.  This manual supplements the ZCPR Manual.
-
-
-ZSDOS Manual ("ZSDOS Manual.pdf")
----------------------------------
-
-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.
-
-Microsoft Basic-80 Reference Manual v5.0 (Microsoft Basic-80 Reference Manual v5.0.pdf)
----------------------------------------------------------------------------------------
-
-Official manual for Microsoft BASIC as included in RomWBW.
-
-
-QP/M 2.7 Installation Guide and Supplements ("qpm27.pdf")
-QP/M 2.7 Interface Guide ("qdos27.pdf")
-QP/M 2.7 Features and Facilities ("qcp27.pdf")
---------------------------------------------
-
-Official documentation set for QP/M 2.7 from original QP/M distribution.
-
 SIO+CTC Baud Rate Options (SIO+CTC Baud Rate Options.pdf)
 ---------------------------------------------------------
 
@@ -132,37 +85,4 @@ UCSD p-System Users Manual ("UCSD p-System Users Manual.pdf")
 Official user manual for p-System operating system included with
 RomWBW.
 
-
-Z80 Assembler User Manual (z80asm (SLR Systems).pdf)
-----------------------------------------------------
-
-Official user manual for the Z80 Macro Assembler by SLR Systems
-included in the z80asm disk image.
-
-
-HI-TECH C Compiler User Manual (HI-TECH Z80 C Compiler Manual.txt)
-------------------------------------------------------------------
-
-Official user manual for the HI-TECH C Compiler included in the
-hitechc disk image.
-
-
-Borland TurboPascal User Manual (Turbo_Pascal_Version_3.0_Reference_Manual_1986.pdf)
-------------------------------------------------------------------------------------
-
-Official user manual Borland TurboPascal included in the pascal disk image.
-
-
-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.
-
-
-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.
-
---WBW 5:18 PM 6/14/2023
+--WBW 8:37 AM 6/6/2025

Doc/Testing Notes.txt

@@ -1,144 +0,0 @@
-SIMH (X)
-----
-- Test UART driver
-- Test HDSK driver
-
-Zeta 1 (X)
-------
-- Test UART driver
-- Test PPP detection (startup w/ and w/o PPP)
-- Test boot to CRT
-- Test PPPSD driver
-- Test PPPCON driver (video & kbd)
-- Test FD driver
-- Test FDU app
-
-Zeta 2 (X)
-------
-- Test UART driver
-- Test PPP detection (startup w/ and w/o PPP)
-- Test boot to CRT
-- Test PPPSD driver
-- Test PPPCON driver (video & kbd)
-- Test FD driver
-- Test FDU app
-
-RCBus (X)
-------
-- Test SIO driver (Serial Module)
-- Test ACIA driver (Dual Serial Module)
-- Test IDE driver (Compact Flash Module)
-- Test PPIDE driver (IDE Module)
-- Test FD driver (SMC and WDC)
-- Test FDU app (SMC and WDC)
-
-N8-2312 (X)
--------
-- Test ASCI driver
-- Test SD driver (CSIO mode)
-- Test FD driver
-- Test FDU app
-- Test TMS driver (video & kbd)
-
-N8-2511 (X)
--------
-- Test ASCI driver
-- Test SD driver (Juha mode)
-- Test FD driver
-- Test FDU app
-- Test TMS driver (video & kbd)
-
-SBC (X)
----
-- Test UART driver
-- Test PPIDE driver
-- Test PPISD driver
-- Test PRP detection
-- Test boot to CRT console
-
-MK4 (X)
----
-- Test ASCI driver
-- Test IDE driver
-- Test SD driver
-- Test PRP detection
-
-RAMF (X)
-----
-- Test RAMF driver
-
-PRP (X)
----
-- Test PRPSD driver
-- Test PRPCON driver (video & kbd)
-
-SCG (X)
----
-- Test TMS driver (video)
-
-VDU (X)
----
-- Test CVDU driver (video & kbd)
-
-CVDU (X)
-----
-- Test CVDU driver (video & kbd)
-
-VGA (X)
----
-- Test VGA driver (video & kbd)
-
-DIO (X)
----
-- Test FD driver
-- Test FDU app
-- Test IDE driver
-
-DIO3 (X)
-----
-- Test FD driver
-- Test FDU app
-- Test PPIDE driver
-
-DIDE (X)
-----
-- Test FD driver
-- Test FDU app
-- Test IDE driver
-
-DSD (X)
----
-- Test SD driver
-
-4UART (X)
------
-- Test UART driver
-
-
-UNA (X)
----
-- General Startup
-- Boot from disk functionality
-- Image loading
-- Monitor
-- XM app
-- ASSIGN app
-- MODE app
-- SYSCOPY app
-- OSLDR app
-- FDU app
-- FDISK80 app
-
-GENERAL (X)
--------
-- Boot to ROM
-- Boot to Disk
-- Boot to Monitor
-- XM app
-- XM port auto-detect
-- ASSIGN app
-- MODE app
-- SYSCOPY app
-- FDU app
-- FDISK80 app
-- TUNE app

Dockerfile

@@ -0,0 +1,46 @@
+FROM ubuntu:jammy-20240111 AS basebuilder
+
+# This docker file can be used to build a tool chain docker image for building RomWBW images.
+
+# Tested on a ubuntu host and on Windows un WSL (with docker desktop)
+
+# First build the docker image (will b)
+# docker build --progress plain -t romwbw-chain .
+
+# 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 --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:
+
+# cd Tools && make
+# cd Source && make # at least once to build many common units
+# cd Source && make rom ROM_PLATFORM=RCEZ80 ROM_CONFIG=std
+
+# when finish, type 'exit' to return to back to your standard terminal session
+
+LABEL Maintainer="Dean Netherton" \
+      Description="RomWBW builder platform"
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN dpkg --add-architecture i386
+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
+
+RUN mkdir work
+WORKDIR /work
+
+FROM basebuilder AS main
+
+LABEL Maintainer="Dean Netherton" \
+      Description="RomWBW builder platform"
+
+RUN mkdir /src
+WORKDIR /src/
+
+RUN apt install -y --no-install-recommends build-essential libncurses-dev srecord bsdmainutils
+
+RUN adduser --disabled-password --gecos "" builder

Makefile

@@ -1,7 +1,7 @@
 .PHONY: tools source clean clobber diff dist
 
 .ONESHELL:
-.SHELLFLAGS = -cex
+.SHELLFLAGS = -ce
 
 all: tools source
 
@@ -22,10 +22,15 @@ 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
 	$(MAKE) --directory Source clean
 
 distlog:
-	$(MAKE) dist 2>&1 | tee make.log
+	time -p $(MAKE) dist 2>&1 | tee make.log

RELEASE_NOTES.md

@@ -0,0 +1,132 @@
+# RomWBW Release Notes
+
+This file contains information useful to those upgrading to a new
+release of RomWBW.
+
+## All Versions
+
+- **Please** review the "Upgrading" Section of the RomWBW User Guide.
+
+- The RomWBW ROM and the RomWBW disk images are intended to be a
+  matched set.  After upgrading your ROM, you need to update your
+  boot disk media by doing one of the following:
+  
+  - Write a new disk image (typically hd1k_combo.img) onto your
+    disk media (will overwrite existing data/files).
+  - Update the boot tracks of the bootable OS images as described in
+    the RomWBW User Guid.
+
+## Version 3.6
+
+### Upgrade Notes
+
+- The FZ80 (S100 FPGA Z80) platform has been renamed to SZ80 (S100 Z80)
+  and has two configurations.  SZ80_std is for the generic S100
+  Z80 CPU.  SZ80_fpga is for the FPGA Z80 SBC.
+
+### New Features
+
+### New Hardware Support
+
+- Support for MSX systems.
+
+## Version 3.5.1
+
+This is a patch release of v3.5.
+
+### Fixes
+
+- Corrects an issue with the `CPMLDR.SYS` and `ZPMLDR.SYS` files that
+  caused `SYSCOPY` to fail when used with them.
+
+- Added missing `BCLOAD` file to the MS BASIC Compiler disk image.
+  
+### New Features
+
+- Added `SLABEL` application (Mark Pruden).
+
+- Variety of documentation improvements, especially an overhaul of
+  the Hardware Document (Mark Pruden).
+
+## Version 3.5
+
+### Upgrade Notes
+
+- RomWBW is now more strict with respect to hard disk partition
+  tables.  If your hard disk media was created using any of the
+  pre-built disk image files, this will **not** affect you.  Otherwise,
+  you may find you are unable to access slices beyond the first
+  slice.  If so, use `FDISK80` to reset the partition table on the
+  disk.  This will restore normal access to all slices.  **Only** do
+  this if you are having an issue.
+
+- For those building custom ROMs that are overriding `DEFSERCFG`, note 
+  that this setting has been moved to a `#DEFINE` instead of an equate 
+  (`.SET` or `.EQU`).  You will find this `#DEFINE` at the top of all
+  standard config files.  You will need to change your setting to a
+  `#DEFINE` at the top of your config file and remove any `.SET` or
+  `.EQU` lines for `DEFSERCFG`.
+
+- Combining config settings `AUTOCON` and `VDAEMU_SERKBD` causes issues
+  at the boot loader prompt.  So, all config files have been changed to
+  consistently enable `AUTOCON` and disable `VDAEMU_SERKBD` (`$FF`).  If
+  are want to use `VDAEMU_SERKBD`, you need to set it in your config
+  file as well as disabling AUTOCON.
+  
+### New Features
+
+- RC2014 Front Panel and LCD Screen support.
+
+- Console "takeover" support at Boot Loader prompt by pressing the
+  <space> key twice on an alternate console device.
+
+- Cowgol disk image based on the work of Ladislau Szilagyi.
+
+- TMS video is automatically reset after an OS warm boot which
+  allows OS to recover from applications that reprogram the TMS
+  video display controller.
+
+- Implemented "application" RAM banks that can be discovered via
+  the HBIOS API.
+
+- Documentation improvements (Mark Pruden), including:
+
+  - Reorganization into multiple directories.
+  - Improved Disk Management section in User Guide.
+  - Overhaul of Disk Catalog.
+  
+- Disk image for Z3PLUS (Mark Pruden).
+
+- `REBOOT` application added (Martin R).  Also, reboot capability
+  added to `CPUSPD` utility.
+
+- `COPYSL` slice copy application (Mark Pruden).
+
+- `SLABEL` slice label display/edit tool (Mark Pruden).
+
+- Improved disk slice management and protection (Mark Pruden).
+
+- Initial NVRAM configuration support (Mark Pruden).
+
+- Enhancements to ASSIGN command to automatically assign drives
+  (Mark Pruden).
+
+### New Hardware Support
+
+- NABU w/ RomWBW Option Board.
+
+- EF9345 video display controller driver (Laszlo Szolnoki).
+
+- Duodyne Disk I/O (CP/NET) and Media boards.
+
+- PS/2 keyboard interface on RCBus systems.
+
+- S100 FPGA-based Z80 including console, SD Cards, and RTC.
+
+- Support for 16C550-family UART support on additional platforms.
+
+- Genesis STD Bus Z180 platform (Doug Jackson).
+
+- Support for Dinoboard eZ80 CPU board provided by Dean Netherton.
+
+- Added interrupt support to PS/2 keyboard driver by Phil Summers.

ReadMe.md

@@ -1,60 +1,70 @@
 
 
-**RomWBW ReadMe** \
-Version 3.4 \
+
+
+
+
+**RomWBW Introduction** \
+Version 3.6 \
 Wayne Warthen  ([wwarthen@gmail.com](mailto:wwarthen@gmail.com)) \
-31 Oct 2023
+29 Sep 2025
 
 # 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:
+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)
-- [RC2014](https://rc2014.co.uk),
+  (<https://www.retrobrewcomputers.org>)
+- [RC2014](https://rc2014.co.uk) (<https://rc2014.co.uk>),  
   [RC2014-Z80](https://groups.google.com/g/rc2014-z80)
-- [retro-comp](https://groups.google.com/forum/#!forum/retro-comp)
+  (<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/>)
 
-General features include:
+A complete list of the currently supported platforms is found in [RomWBW
+Hardware](https://github.com/wwarthen/RomWBW/raw/master/Doc/RomWBW%20Hardware.pdf)
+.
 
+# 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, CF, and SD
+- 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
-- OSes: CP/M 2.2, ZSDOS, CP/M 3, NZ-COM, ZPM3, QPM, p-System, and
-  FreeRTOS
+- 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) 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.
+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.
 
-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.
+## Included Software
 
 Multiple disk images are provided in the distribution. Most disk images
 contain a complete, bootable, ready-to-run implementation of a specific
@@ -63,36 +73,79 @@ 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
-Card) and move it between systems transparently.
+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, Microsoft Fortran, and Microsoft COBOL
+- 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.
 
-# Acquiring RomWBW
+## ROM Distribution
 
-The [RomWBW Repository](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)
-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. Expand
-the “Assets” drop-down for the release you want to download, then select
-the asset named RomWBW-vX.X.X-Package.zip. The Package asset 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.
+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.
 
-All source code and distributions are maintained on GitHub. Code
-contributions are very welcome.
+RomWBW is distributed as both source code and pre-built ROM and disk
+images.
 
-# Installation & Operation
+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. |
+
+#### 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
@@ -102,24 +155,83 @@ functionality.
 
 Complete instructions for installation and operation of RomWBW are found
 in the [RomWBW User
-Guide](https://github.com/wwarthen/RomWBW/raw/dev/Doc/RomWBW%20User%20Guide.pdf).
+Guide](https://github.com/wwarthen/RomWBW/raw/master/Doc/RomWBW%20User%20Guide.pdf).
+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 RomWBW includes:
+There are several documents that form the core of the RomWBW
+documentation:
 
 - [RomWBW User
-  Guide](https://github.com/wwarthen/RomWBW/raw/dev/Doc/RomWBW%20User%20Guide.pdf)
-- [RomWBW System
-  Guide](https://github.com/wwarthen/RomWBW/raw/dev/Doc/RomWBW%20System%20Guide.pdf)
-- [RomWBW
-  Applications](https://github.com/wwarthen/RomWBW/raw/dev/Doc/RomWBW%20Applications.pdf)
-- [RomWBW ROM
-  Applications](https://github.com/wwarthen/RomWBW/raw/dev/Doc/RomWBW%20ROM%20Applications.pdf)
-- [RomWBW
-  Errata](https://github.com/wwarthen/RomWBW/raw/dev/Doc/RomWBW%20Errata.pdf)
+  Guide](https://github.com/wwarthen/RomWBW/raw/master/Doc/RomWBW%20User%20Guide.pdf)
+  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
 
-# Acknowledgments
+- [RomWBW
+  Hardware](https://github.com/wwarthen/RomWBW/raw/master/Doc/RomWBW%20Hardware.pdf)
+  contains a description of all the hardware platforms, and devices
+  supported by RomWBW.
+
+- [RomWBW
+  Applications](https://github.com/wwarthen/RomWBW/raw/master/Doc/RomWBW%20Applications.pdf)
+  is a reference for the ROM-hosted and OS-hosted applications created
+  or customized to enhance the operation of RomWBW.
+
+- [RomWBW Disk
+  Catalog](https://github.com/wwarthen/RomWBW/raw/master/Doc/RomWBW%20Disk%20Catalog.pdf)
+  is a reference for the contents of the disk images provided with
+  RomWBW, with a description of many of the files on each image
+
+- [RomWBW System
+  Guide](https://github.com/wwarthen/RomWBW/raw/master/Doc/RomWBW%20System%20Guide.pdf)
+  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 Wayne Warthen at <wwarthen@gmail.com>. 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
@@ -178,8 +290,12 @@ let me know if I missed you!
 
 - Tasty Basic is a product of Dimitri Theulings.
 
-- Dean Netherton contributed 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.
 
@@ -187,10 +303,107 @@ let me know if I missed you!
   Aztec C, HiTech C, SLR Z80ASM, Turbo Pascal, Microsoft BASIC Compiler,
   Microsoft Fortran Compiler, and a Games compendium.
 
-Contributions of all kinds to RomWBW are very welcome.
+- 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.
+
+- Marshall Gates has contriubed sample program source files for all of
+  the language disk images.
+
+- Randy Merkel provided the ZSDOS Programmer’s Manual as translated by
+  Wayne Hortensius.
+
+- Henk Berends added support for the MSX platform.
+
+## 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
@@ -230,19 +443,3 @@ 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 Wayne Warthen at <wwarthen@gmail.com>.

ReadMe.txt

@@ -1,6 +1,9 @@
-RomWBW ReadMe
+RomWBW Introduction
 Wayne Warthen (wwarthen@gmail.com)
-31 Oct 2023
+29 Sep 2025
+
+
+
 
 
 
@@ -8,52 +11,58 @@ 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:
+of CP/M (and work-alike) operating systems and applications for modern
+Z80/180/280 retro-computing hardware systems.
 
--   RetroBrew Computers
--   RC2014, RC2014-Z80
--   retro-comp
--   Small Computer Central
+A wide variety of platforms are supported including those produced by
+these developer communities:
 
-General features include:
+- RetroBrew Computers (https://www.retrobrewcomputers.org)
+- RC2014 (https://rc2014.co.uk),
+  RC2014-Z80 (https://groups.google.com/g/rc2014-z80)
+- Retro Computing (https://groups.google.com/g/retro-comp)
+- Small Computer Central (https://smallcomputercentral.com/)
 
--   Banked memory services for several banking designs
--   Disk drivers for RAM, ROM, Floppy, IDE, CF, and SD
--   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
--   OSes: CP/M 2.2, ZSDOS, CP/M 3, NZ-COM, ZPM3, QPM, p-System, and
-    FreeRTOS
--   Built-in VT-100 terminal emulation support
+A complete list of the currently supported platforms is found in RomWBW
+Hardware .
 
-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
+
+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) 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.
+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.
 
-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.
+
+Included Software
 
 Multiple disk images are provided in the distribution. Most disk images
 contain a complete, bootable, ready-to-run implementation of a specific
@@ -62,11 +71,24 @@ 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
-Card) and move it between systems transparently.
+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, Microsoft Fortran, and Microsoft COBOL
+- 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
@@ -74,28 +96,67 @@ slices or on stand-alone media. This makes exchanging files with modern
 OSes such as Windows, MacOS, and Linux very easy.
 
 
+ROM Distribution
 
-ACQUIRING ROMWBW
+The RomWBW Repository (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 RomWBW Repository 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 of the repository. On
-this page, you will normally see a Development Snapshot as well as
+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) 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. Expand the “Assets” drop-down
-for the release you want to download, then select the asset named
-RomWBW-vX.X.X-Package.zip. The Package asset 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.
+stick to the most recent stable release.
 
-All source code and distributions are maintained on GitHub. Code
-contributions are very welcome.
+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.
+  -------------------------------------------------------------------------
+
+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
-
+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
@@ -104,98 +165,255 @@ 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 RomWBW User Guide.
+in the RomWBW User Guide. It is also a good idea to review the Release
+Notes for helpful release-specific information.
 
 
 Documentation
 
-Documentation for RomWBW includes:
+There are several documents that form the core of the RomWBW
+documentation:
 
--   RomWBW User Guide
--   RomWBW System Guide
--   RomWBW Applications
--   RomWBW ROM Applications
--   RomWBW Errata
+- RomWBW User Guide 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
+
+- RomWBW Hardware contains a description of all the hardware platforms,
+  and devices supported by RomWBW.
+
+- RomWBW Applications is a reference for the ROM-hosted and OS-hosted
+  applications created or customized to enhance the operation of RomWBW.
+
+- RomWBW Disk 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
+
+- RomWBW System Guide 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.
 
 
 
-ACKNOWLEDGMENTS
+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
+- RC2014 Google Group
+- retro-comp Google Group
+
+Submission of issues and bugs are welcome at the RomWBW GitHub
+Repository.
+
+Also feel free to email Wayne Warthen at wwarthen@gmail.com. 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.
+- 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.
+- 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.
+- 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.
+- 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.
+- 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.
+- 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.
+- 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.
+- 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.
+- 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.
+- 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.
+- The CP/NET client files were developed by Douglas Miller.
 
--   Phillip Stevens contributed support for FreeRTOS.
+- Phillip Stevens contributed support for FreeRTOS.
 
--   Curt Mayer contributed the original Linux / MacOS build process.
+- Curt Mayer contributed the original Linux / MacOS build process.
 
--   UNA BIOS and FDISK80 are the products of John Coffman.
+- UNA BIOS and FDISK80 are the products of John Coffman.
 
--   FLASH4 is a product of Will Sowerbutts.
+- FLASH4 is a product of Will Sowerbutts.
 
--   CLRDIR is a product of Max Scane.
+- CLRDIR is a product of Max Scane.
 
--   Tasty Basic is a product of Dimitri Theulings.
+- Tasty Basic is a product of Dimitri Theulings.
 
--   Dean Netherton contributed the sound driver interface and the
-    SN76489 sound driver.
+- Dean Netherton contributed multiple components:
 
--   The RomWBW Disk Catalog document was produced by Mykl Orders.
+  - eZ80 CPU support
+  - Sound driver infrastructure
+  - SN76489 sound driver
+  - Native USB driver (keyboard, floppy, mass storage)
 
--   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.
+- The RomWBW Disk Catalog document was produced by Mykl Orders.
 
-Contributions of all kinds to RomWBW are very welcome.
+- 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.
+
+- Marshall Gates has contriubed sample program source files for all of
+  the language disk images.
+
+- Randy Merkel provided the ZSDOS Programmer’s Manual as translated by
+  Wayne Hortensius.
+
+- Henk Berends added support for the MSX platform.
+
+
+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.
 
 
 
 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
@@ -235,20 +453,3 @@ 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
--   RC2014 Google Group
--   retro-comp Google Group
-
-Submission of issues and bugs are welcome at the RomWBW GitHub
-Repository.
-
-Also feel free to email Wayne Warthen at wwarthen@gmail.com.

Source/Apps/BBCBASIC/Build.cmd

@@ -0,0 +1,23 @@
+@echo off
+setlocal
+
+set TOOLS=..\..\..\Tools
+
+set PATH=%TOOLS%\zxcc;%PATH%
+
+set CPMDIR80=%TOOLS%/cpm/
+
+zxcc z80asm -dist/FM
+zxcc z80asm -main/FM
+zxcc z80asm -exec/FM
+zxcc z80asm -eval/FM
+zxcc z80asm -asmb/FM
+zxcc z80asm -cmos/FM
+zxcc z80asm -math/FM
+zxcc z80asm -hook/FM
+zxcc z80asm -data/FM
+
+zxcc slrnk -/v,/a:0100,dist,main,exec,eval,asmb,math,hook,cmos,/p:4B00,data,bbcbasic/n,/e
+
+copy /Y bbcbasic.com ..\..\..\Binary\Apps\ || exit /b
+copy /Y bbcbasic.txt ..\..\..\Binary\Apps\ || exit /b

Source/Apps/BBCBASIC/Clean.cmd

@@ -0,0 +1,9 @@
+@echo off
+setlocal
+
+if exist *.com del *.com
+if exist *.lst del *.lst
+if exist *.hex del *.hex
+if exist *.prn del *.prn
+if exist *.rel del *.rel
+if exist *.sym del *.sym

Source/Apps/BBCBASIC/Makefile

@@ -0,0 +1,11 @@
+OBJECTS = bbcbasic.com
+DOCS = bbcbasic.txt
+DEST = ../../../Binary/Apps
+DOCDEST = ../../../Binary/Apps
+TOOLS = ../../../Tools
+OTHERS = *.rel
+
+include $(TOOLS)/Makefile.inc
+
+bbcbasic.com: dist.rel main.rel exec.rel eval.rel asmb.rel cmos.rel math.rel hook.rel data.rel
+	$(ZXCC) SLRNK -/V,/A:0100,DIST,MAIN,EXEC,EVAL,ASMB,MATH,HOOK,CMOS,/P:4B00,DATA,BBCBASIC/N,/E

Source/Apps/BBCBASIC/bbcbasic.txt

@@ -1,3 +1,25 @@
+This is a RomWBW HBIOS adaptation of BBCBASIC v5.00 by R.T.Russell.
+This implementation was adapted from the source code found at
+https://github.com/rtrussell/BBCZ80.
+
+The cursor and screen management assumes the use of an ANSI/VT-100
+terminal which is generally correct for RomWBW.  Support for a hardware
+system timer is also implemented.  If your system does not have a
+hardware timer, the TIME function will always return 0 and the timeout
+parameter of the INKEY(n) function will not be observed (will never
+timeout).
+
+What follows is some basic information on BBCBASIC from the
+distribution.  Note that it starts with the v3.00 information and
+later on provides information on the changes in v5.00.  Complete
+documentation for the BBC BASIC (Z80) is found online at
+https://www.bbcbasic.co.uk/bbcbasic/mancpm/index.html.
+
+-- WBW 4:21 PM 2/17/2025
+
+
+
+
                               BBC BASIC (Z80)
 
                          Generic CP/M Version 3.00
@@ -6,55 +28,55 @@
 
 1. INTRODUCTION
 
-   BBC  BASIC (Z80) has been designed to be as compatible as  possible  with 
-   Version 4 of the 6502 BBC BASIC resident in the BBC Micro Master  series.  
-   The language syntax is not always identical to that of the 6502  version, 
+   BBC  BASIC (Z80) has been designed to be as compatible as  possible  with
+   Version 4 of the 6502 BBC BASIC resident in the BBC Micro Master  series.
+   The language syntax is not always identical to that of the 6502  version,
    but in most cases the Z80 version is more tolerant.
 
-   BBC  BASIC (Z80) is as machine independent as possible and, as  supplied, 
-   it  will  run  on any CP/M 2.2 (or later) system using  a  Z80  processor 
-   (checks  are carried out to ensure that the processor is a Z80  and  that 
-   the version of CP/M is at least 2.2).  It is minimally configured for  an 
+   BBC  BASIC (Z80) is as machine independent as possible and, as  supplied,
+   it  will  run  on any CP/M 2.2 (or later) system using  a  Z80  processor
+   (checks  are carried out to ensure that the processor is a Z80  and  that
+   the version of CP/M is at least 2.2).  It is minimally configured for  an
    ADM3a-compatible VDU.
 
-   Few  CP/M  systems  offer  colour graphics of  the  quality  provided  as 
-   standard  on  the BBC Microcomputer, and no software can  provide  colour 
-   high-resolution graphics from a monochrome character-orientated computer.  
-   However,  many CP/M system users are interested in the  advanced  program 
-   structures  available from BBC BASIC and, within the limitations  of  the 
-   host  computer, BBC BASIC (Z80) provides the programming  structures  and 
+   Few  CP/M  systems  offer  colour graphics of  the  quality  provided  as
+   standard  on  the BBC Microcomputer, and no software can  provide  colour
+   high-resolution graphics from a monochrome character-orientated computer.
+   However,  many CP/M system users are interested in the  advanced  program
+   structures  available from BBC BASIC and, within the limitations  of  the
+   host  computer, BBC BASIC (Z80) provides the programming  structures  and
    the non-graphic commands and functions specified for BBC BASIC.
 
-   In order to make full use of the facilities available in BBC BASIC  (Z80) 
-   it is necessary to install a small patch to adapt it to the  capabilities 
-   of  the  host  computer.  The source code of the  patch  present  in  the 
+   In order to make full use of the facilities available in BBC BASIC  (Z80)
+   it is necessary to install a small patch to adapt it to the  capabilities
+   of  the  host  computer.  The source code of the  patch  present  in  the
    distribution version is supplied as BBCDIST.MAC.
 
-   This  documentation  should be read in conjunction with  a  standard  BBC 
-   BASIC  manual.  Only those features which differ from the standard  Acorn 
+   This  documentation  should be read in conjunction with  a  standard  BBC
+   BASIC  manual.  Only those features which differ from the standard  Acorn
    versions are documented here.
 
 
 2. MEMORY UTILISATION
 
-   BBC  BASIC (Z80) requires about 16 Kbytes of code space, resulting  in  a 
-   value  of  PAGE  of about &3E00.  The remainder of  the  user  memory  is 
-   available  for BASIC programs, variables (heap) and stack.  Depending  on 
+   BBC  BASIC (Z80) requires about 16 Kbytes of code space, resulting  in  a
+   value  of  PAGE  of about &3E00.  The remainder of  the  user  memory  is
+   available  for BASIC programs, variables (heap) and stack.  Depending  on
    the system configuration, HIMEM can have a value up to &FE00.
 
 
 3. COMMANDS, STATEMENTS AND FUNCTIONS
 
-   The syntax of BASIC commands,  statements and functions is in most  cases 
-   identical  to  that  of  the  BBC  Micro  version  (BASIC  4).   The  few 
+   The syntax of BASIC commands,  statements and functions is in most  cases
+   identical  to  that  of  the  BBC  Micro  version  (BASIC  4).   The  few
    differences are documented here:
 
    ADVAL
    This function is not implemented.
 
    CALL
-   CALL  sets  up a table in RAM containing details of the  parameters;  the 
-   processor's  IX register is set to the address of this  parameter  table.  
+   CALL  sets  up a table in RAM containing details of the  parameters;  the
+   processor's  IX register is set to the address of this  parameter  table.
    The other processor registers are initialised as follows:
 
                A is initialised to the least significant byte of A%
@@ -75,7 +97,7 @@
             128          Fixed string        $A%
             129          Movable string      A$
 
-   On  entry  to the subroutine the parameter table contains  the  following 
+   On  entry  to the subroutine the parameter table contains  the  following
    values:
 
           Number of parameters     1 byte (at IX)
@@ -86,29 +108,29 @@
           Parameter type           ) repeated as often as necessary
           Parameter address        )
 
-   Except  in  the case of a movable string (normal  string  variable),  the 
-   parameter  address  given is the absolute address at which  the  item  is 
-   stored.  In the case of movable strings (type 129) it is the address of a 
-   4-byte parameter block containing the current length, the maximum  length 
+   Except  in  the case of a movable string (normal  string  variable),  the
+   parameter  address  given is the absolute address at which  the  item  is
+   stored.  In the case of movable strings (type 129) it is the address of a
+   4-byte parameter block containing the current length, the maximum  length
    and the start address of the string (LSB first) in that order.
 
-   Integer  variables  are stored in twos complement form with  their  least 
+   Integer  variables  are stored in twos complement form with  their  least
    significant byte first.
 
-   Fixed  strings are stored as the characters of the string followed  by  a 
+   Fixed  strings are stored as the characters of the string followed  by  a
    carriage return (&0D).
 
-   Floating point variables are stored in binary floating point format  with 
-   their least significant byte first; the fifth byte is the exponent.   The 
-   mantissa  is  stored as a binary fraction in sign and  magnitude  format.  
-   Bit 7 of the most significant byte is the sign bit and, for the  purposes 
-   of calculating the magnitude of the number, this bit is assumed to be set 
-   to  one.  The exponent is stored as an integer in excess 127  format  (to 
+   Floating point variables are stored in binary floating point format  with
+   their least significant byte first; the fifth byte is the exponent.   The
+   mantissa  is  stored as a binary fraction in sign and  magnitude  format.
+   Bit 7 of the most significant byte is the sign bit and, for the  purposes
+   of calculating the magnitude of the number, this bit is assumed to be set
+   to  one.  The exponent is stored as an integer in excess 127  format  (to
    find the exponent subtract 127 from the value in the fifth byte).
 
-   If the exponent byte of a floating point number is zero, the number is an 
-   integer stored in integer format in the mantissa bytes.  Thus an  integer 
-   can be represented in two different ways in a real variable.  For example 
+   If the exponent byte of a floating point number is zero, the number is an
+   integer stored in integer format in the mantissa bytes.  Thus an  integer
+   can be represented in two different ways in a real variable.  For example
    the value +5 can be stored as:
 
             05 00 00 00 00         Integer 5
@@ -121,15 +143,15 @@
    This statement is not implemented.
 
    EDIT
-   A command to edit or concatenate and edit the specified program  line(s).  
-   The specified lines (including their line numbers) are listed as a single 
-   line.   By changing only the line number you can use EDIT to duplicate  a 
+   A command to edit or concatenate and edit the specified program  line(s).
+   The specified lines (including their line numbers) are listed as a single
+   line.   By changing only the line number you can use EDIT to duplicate  a
    line.
 
      EDIT 230
      EDIT 200,230
 
-   The  following control functions are active both in the EDIT mode and  in 
+   The  following control functions are active both in the EDIT mode and  in
    the immediate entry mode (i.e. at the BASIC prompt):
 
      Move the cursor one character position to the left
@@ -142,8 +164,8 @@
      Delete all characters to the left of the cursor
      Delete all characters from the cursor to the end of the line
 
-   The choice of which keys activate these functions is made when BBC  BASIC 
-   is configured for a particular system.  The distribution version uses ^H, 
+   The choice of which keys activate these functions is made when BBC  BASIC
+   is configured for a particular system.  The distribution version uses ^H,
    ^I, ^K, ^J, ^A, ^E, DEL (&7F), ^L and ^X.
 
    To exit EDIT mode and replace the edited line, type RETURN (ENTER).
@@ -154,28 +176,28 @@
    This statement is not implemented.
 
    GET
-   This  function  waits for a character to be typed at  the  keyboard,  and 
+   This  function  waits for a character to be typed at  the  keyboard,  and
    returns the ASCII code.
 
-   GET can also be used to read data from a processor I/O port; full  16-bit 
+   GET can also be used to read data from a processor I/O port; full  16-bit
    port addressing is available:
 
           N% = GET(X%) : REM input from port X%
 
    INKEY
-   This function waits for a specified maximum number of centiseconds for  a 
-   character to be typed at the keyboard.  If no character is typed in  that 
-   time, the value -1 is returned.  In the distribution version the delay is 
-   determined by a simple software timing loop, and may be very  inaccurate.  
-   The customisation patch allows this to be adjusted to suit the system  in 
+   This function waits for a specified maximum number of centiseconds for  a
+   character to be typed at the keyboard.  If no character is typed in  that
+   time, the value -1 is returned.  In the distribution version the delay is
+   determined by a simple software timing loop, and may be very  inaccurate.
+   The customisation patch allows this to be adjusted to suit the system  in
    use.
 
    INPUT#
-   The format of data files is different from that used by the BBC Micro, in 
-   part  to improve compatibility with standard CP/M files.  Numeric  values 
-   are  stored  as five bytes in the format documented under  CALL;  if  the 
-   fifth  byte is zero the value is an integer.  Strings are stored  as  the 
-   characters  of the string (in the correct order!) followed by a  carriage 
+   The format of data files is different from that used by the BBC Micro, in
+   part  to improve compatibility with standard CP/M files.  Numeric  values
+   are  stored  as five bytes in the format documented under  CALL;  if  the
+   fifth  byte is zero the value is an integer.  Strings are stored  as  the
+   characters  of the string (in the correct order!) followed by a  carriage
    return (&0D).
 
    MODE
@@ -191,15 +213,15 @@
    This function is not implemented.
 
    PRINT#
-   The format of data files is different from that used by the BBC Micro, in 
-   part  to improve compatibility with standard CP/M files.  Numeric  values 
-   are  stored  as five bytes in the format documented under  CALL;  if  the 
-   fifth  byte is zero the value is an integer.  Strings are stored  as  the 
-   characters  of the string (in the correct order!) followed by a  carriage 
+   The format of data files is different from that used by the BBC Micro, in
+   part  to improve compatibility with standard CP/M files.  Numeric  values
+   are  stored  as five bytes in the format documented under  CALL;  if  the
+   fifth  byte is zero the value is an integer.  Strings are stored  as  the
+   characters  of the string (in the correct order!) followed by a  carriage
    return (&0D).
 
    PUT
-   A  statement to output data to a processor port.  Full 16-bit  addressing 
+   A  statement to output data to a processor port.  Full 16-bit  addressing
    is available.
 
           PUT A%,N% : REM Output N% to port A%
@@ -208,7 +230,7 @@
    This statement is not implemented.
 
    TIME
-   This pseudo-variable is not implemented in the distribution version,  but 
+   This pseudo-variable is not implemented in the distribution version,  but
    can be supported by means of the customisation patch.  See BBCDIST.MAC.
 
    USR
@@ -223,34 +245,34 @@
                H is initialised to the least significant byte of H%
                L is initialised to the least significant byte of L%
 
-   USR returns a 32-bit integer result composed of the processor's H, L,  H' 
+   USR returns a 32-bit integer result composed of the processor's H, L,  H'
    and L' registers, with H being the most significant.
 
 
 4. RESIDENT Z80 ASSEMBLER
 
-   The  in-line  assembler is accessed in exactly the same way as  the  6502 
-   assembler  in  the BBC Micro version of BBC BASIC.  That is,  '['  enters 
+   The  in-line  assembler is accessed in exactly the same way as  the  6502
+   assembler  in  the BBC Micro version of BBC BASIC.  That is,  '['  enters
    assembler mode and ']' exits assembler mode.
 
-   All  standard  Zilog  mnemonics are accepted: ADD, ADC and  SBC  must  be 
-   followed by A or HL.  For example, ADD A,C is accepted but ADD C is  not.  
-   However, the brackets around the port number in IN and OUT are  optional.  
-   Thus  both OUT (5),A and OUT 5,A are accepted.  The instruction IN  F,(C) 
+   All  standard  Zilog  mnemonics are accepted: ADD, ADC and  SBC  must  be
+   followed by A or HL.  For example, ADD A,C is accepted but ADD C is  not.
+   However, the brackets around the port number in IN and OUT are  optional.
+   Thus  both OUT (5),A and OUT 5,A are accepted.  The instruction IN  F,(C)
    is not accepted, but the equivalent code is produced from IN (HL),C
 
-   The pseudo-ops DEFB, DEFW and DEFM are included.  DEFM works like EQUS in 
+   The pseudo-ops DEFB, DEFW and DEFM are included.  DEFM works like EQUS in
    the 6502 version.
 
 
 5. OPERATING SYSTEM INTERFACE
 
-   The   following   resident  Operating  System   ("star")   commands   are 
-   implemented.  They may be accessed directly (e.g. *BYE) or via the  OSCLI 
+   The   following   resident  Operating  System   ("star")   commands   are
+   implemented.  They may be accessed directly (e.g. *BYE) or via the  OSCLI
    statement (OSCLI "BYE").
 
-   Control characters, lower-case characters, DEL and quotation marks may be 
-   incorporated in filenames by using the 'escape' character '|'.   However, 
+   Control characters, lower-case characters, DEL and quotation marks may be
+   incorporated in filenames by using the 'escape' character '|'.   However,
    there is no equivalent to the BBC Microcomputer's '|!' to set bit 7.
 
    *BYE
@@ -261,7 +283,7 @@
 
    *. [filespec]
    *DIR [filespec]
-   List  the  files which match the (optional) ambiguous  filespec.  If  the 
+   List  the  files which match the (optional) ambiguous  filespec.  If  the
    filespec is omitted, all .BBC files are listed:
                *DIR           List all .BBC files on the disk
                *DIR B:*.*     List all files on disk B:
@@ -271,53 +293,53 @@
    Select drive d as the default drive for subsequent disk operations.
 
    *ERA filespec
-   Erase (delete) the specified disk file or files.  The extension  defaults 
+   Erase (delete) the specified disk file or files.  The extension  defaults
    to .BBC if omitted.
 
    *ESC [ON|OFF]
-   *ESC OFF disables the abort action of the ESCape key; after *ESC OFF  the 
-   ESCape  key  simply returns the ASCII code ESC (27).  *ESC ON,  or  *ESC, 
+   *ESC OFF disables the abort action of the ESCape key; after *ESC OFF  the
+   ESCape  key  simply returns the ASCII code ESC (27).  *ESC ON,  or  *ESC,
    restores the normal action of the ESCape key.
 
    *EXEC filespec
-   Accept  console  input  from  the  specified file  instead  of  from  the 
+   Accept  console  input  from  the  specified file  instead  of  from  the
    keyboard. If the extension is omitted, .BBC is assumed.
 
    *LOAD filespec aaaa
-   Loads  the specified file into memory at address aaaa. The  load  address 
+   Loads  the specified file into memory at address aaaa. The  load  address
    must be specified. If the extension is omitted, .BBC is assumed.
 
    *OPT [n]
-   Select  the destination for console output characters.  The value n is in 
+   Select  the destination for console output characters.  The value n is in
    the range 0 to 2, as follows:
-               
+
           0    Send characters to the console output
           1    Send characters to the auxiliary output
           2    Send characters to the printer (list) output
 
    *REN newfile=oldfile
    *RENAME newfile=oldfile
-   Renames  'oldfile'  as 'newfile'.  If the extension is omitted,  .BBC  is 
+   Renames  'oldfile'  as 'newfile'.  If the extension is omitted,  .BBC  is
    assumed.
 
    *RESET
-   Rest the disk system (CP/M function 13).  This command does not close any 
-   files  nor does it perform any other housekeeping function.   You  should 
+   Rest the disk system (CP/M function 13).  This command does not close any
+   files  nor does it perform any other housekeeping function.   You  should
    use *RESET after you have changed a disk.
 
    *SAVE filespec aaaa bbbb
    *SAVE filespec aaaa +llll
-   This command saves a specified range of memory to disk. The address range 
-   is  specified either as start (aaaa) and end+1 (bbbb) or as start  (aaaa) 
+   This command saves a specified range of memory to disk. The address range
+   is  specified either as start (aaaa) and end+1 (bbbb) or as start  (aaaa)
    and length (llll). If the extension is omitted, .BBC is assumed.
 
    *SPOOL [filespec]
-   Copy all subsequent console output to the specified file. If the filename 
-   is omitted,  any current spool file is closed and spooling is terminated. 
+   Copy all subsequent console output to the specified file. If the filename
+   is omitted,  any current spool file is closed and spooling is terminated.
    If the extension is omitted, .BBC is assumed.
 
    *TYPE filespec
-   Type the specified file to the screen. If the extension is omitted,  .BBC 
+   Type the specified file to the screen. If the extension is omitted,  .BBC
    is assumed.
 
    *| comment
@@ -335,7 +357,7 @@
    Trappable - BASIC:
 
       1   Out of range             24   Exp range
-      2                            25   
+      2                            25
       3                            26   No such variable
       4   Mistake                  27   Missing )
       5   Missing ,                28   Bad HEX
@@ -366,4 +388,81 @@
      198  Disk full                254  Bad command
      200  Close error              255  CP/M error
      204  Bad name
-
+
+
+New features in BBC BASIC (Z80) version 5.00, January 2025:
+
+1. BASIC V statements
+
+1.1  WHILE...ENDWHILE
+1.2  Multi-line IF...THEN...ELSE...ENDIF
+1.3  CASE...WHEN...OTHERWISE...ENDCASE
+1.4  LOCAL DATA / RESTORE DATA
+1.5  ON ERROR LOCAL / RESTORE ERROR
+1.6  DIM var LOCAL size
+1.7  ERROR err, message$
+1.8  RESTORE +n
+1.9  SWAP var1,var2
+1.10 BPUT #file,string$[;]
+1.11 QUIT
+
+2. BASIC V functions
+
+2.1  DIM(array()[,sub])
+2.2  END (pointer to free space)
+2.3  REPORT$
+2.4  Binary constants
+2.5  LEFT$ & RIGHT$ with last parameter omitted
+2.6  MOD(array())
+2.7  SUM(array())
+2.8  SUMLEN(array())
+2.9  GET$#file
+
+3. BASIC V whole array operations
+
+3.1  Pass a whole array to a FN/PROC
+3.2  Pass a whole array to CALL
+3.3  Whole array assignment
+3.4  Whole array arithmetic *
+3.5  Array dot-product operator
+3.6  Array initialisation lists
+3.7  Array compound assignment (+= etc.)
+3.8  Make a whole array LOCAL
+3.9  DIM a LOCAL array (on the stack) +
+
+* String array expressions are not currently supported, instead of using
+     a$() = b$() + c$()  use  a$() = b$() : a$() += c$()
+  The use of EVAL with whole-array expressions is not currently supported.
+
++ LOCAL string arrays should be initialised to their maximum needed length
+  to eliminate the risk of a memory leak each time the PROC/FN is called:
+     LOCAL a$() : DIM a$(size%) : a$() = STRING$(max%, "a") : a$() = ""
+
+4. Miscellaneous BASIC V features
+
+4.1  Bit-shifts <<, >>, >>>
+4.2  Floating-point indirection (|)
+4.3  Additional VDU delimiter '|'
+4.4  RETURNed parameters from FN/PROC
+4.5  Compound assignment (+=, -=, *=, /= etc.)
+4.6  Assigning to a sub-string: LEFT$()=, MID$()= , RIGHT$()=
+4.7  Hooks for CIRCLE, ELLIPSE, FILL, LINE, ORIGIN, RECTANGLE (graphics)
+4.8  Hooks for MOUSE, OFF, ON, SYS, TINT, WAIT (statements)
+4.9  Hooks for MODE function, TINT function, WIDTH function
+
+5. Extensions to Acorn's BASIC V, compatible with BB4W, BBCSDL and BBCTTY
+
+5.1  EXIT REPEAT / WHILE / FOR [var]
+5.2  Address-of operator (^)
+5.3  Byte (unsigned 8-bit) variables and arrays (& suffix)
+5.4  'BY len' and 'TO term' qualifiers to GET$#file
+5.5  ELSE IF <condition> THEN; (trailing semicolon)
+5.6  == synonymous with = in comparisons
+5.7  DIM a global array inside a FN/PROC (use RETURN)
+5.8  DIM var LOCAL -1 returns the stack pointer, even outside a FN/PROC
+5.9  RESTORE LOCAL restores local variables without exiting the FN/PROC
+
+Note: The token for PUT has changed from &CE in version 3 to &0E in version 5.
+If this token is present in existing programs it will list as ENDWHILE rather
+than PUT, and the programs will need to be modified to restore functionality.
+