Regenerate documentation

Binary/ReadMe.txt

@@ -42,6 +42,15 @@ MK4_custom.rom will be added to this directory.
 Documentation of the pre-built ROM Images is contained in the 
 RomList.txt file in this directory.
 
+ROM Firmware Update Images (<plt>_<cfg>.upd)
+-------------------------------------
+
+The files with a ".upd" extension are binary images identical to the
+.rom files, but they only have the first 128K bytes.  The first 128K
+is the system image without the ROM disk contents.  These files can be
+used to update the system image without modifyuing the ROM disk
+contents.  Refer to the Getting Started document for more information.
+
 ROM Executable Images (<plt>_<cfg>.com)
 ---------------------------------------
 

Doc/ChangeLog.txt

@@ -12,6 +12,8 @@ Version 3.1.1
 - C?M: Support for RC2014 bus PropIO V2
 - W?S: Updated FLASH software to v1.3.4
 - PMS: Preliminary support for writing to FLASH ROMs
+- PMS: Creation of process to update ROM system area w/o updating ROM disk contents
+- PMS: Added "updater.asm" which allows uploading and updating ROM in one step
 
 Version 3.1
 -----------

ReadMe.md

@@ -3,7 +3,7 @@
 ## Z80/Z180 System Software
 
 Version 3.1 Pre-release  
-Sunday 6 December 2020
+Tuesday 5 January 2021
 
 Wayne Warthen <wwarthen@gmail.com>
 
@@ -707,7 +707,7 @@ most stable and you are less likely to encounter problems.
 ### Notes
 
   - You can change media, but it must be done while at the OS command
-    prompt and you **must** warm start CP/M by pressing ctrl-c. This is
+    prompt and you **must** warm start CP/M by pressing ctrl-c. This is
     a CP/M 2.2 constraint and is well documented in the DRI manuals.
 
   - The original versions of DDT, DDTZ, and ZSID used the RST 38 vector
@@ -1038,7 +1038,7 @@ system, you can use the FLASH application to update your ROM. The
 following is a typical example of transferring ROM image using XModem
 and flashing the chip in-situ.
 
-    E>xm r rom.img
+    E>xm r rom.rom
     
     XMODEM v12.5 - 07/13/86
     RBC, 28-Aug-2019 [WBW], ASCI
@@ -1050,7 +1050,7 @@ and flashing the chip in-situ.
     
     Thanks for the upload
     
-    E>flash write rom.img
+    E>flash write rom.rom
     FLASH4 by Will Sowerbutts <will@sowerbutts.com> version 1.2.3
     
     Using RomWBW (v2.6+) bank switching.
@@ -1179,6 +1179,36 @@ images.
   - FAT.COM
   - TUNE.COM
 
+# System Update
+
+If the system running ROMWBW utilizes the SST39SF040 Flash chip then it
+is possible to do a System Update in place of a System Upgrade in some
+cases.
+
+A System Update would involve only updating the BIOS, ROM applications
+and CP/M system.
+
+A System Update may be more favorable than a System Upgrade in cases
+such as:
+
+  - Overwriting of the ROM drive is not desired.
+  - Space is unavailable to hold a full ROMWBW ROM.
+  - To mimimize time taken to transfer and flash a full ROM.
+  - Configuration changes are only minor and do not impact disk
+    applications.
+
+The ROMWBW build process generates a system upgrade file along with the
+normal ROM image and can be identified by the extension “.upd”. It will
+be 128Kb in size. In comparison the normal ROM image will have the
+extension “.rom” and be 512Kb or 1024Kb in size.
+
+Transferring and flashing the System Update is accomplished in the same
+manner as described above in *Upgrading* with the required difference
+being that the flash application needs to be directed to complete a
+partial flash using the /p command line switch.
+
+`E>flash write rom.upd /p`
+
 # RomWBW Distribution
 
 All source code and distributions are maintained on GitHub. Code

ReadMe.txt

@@ -3,7 +3,7 @@ RomWBW
 Z80/Z180 System Software
 
 Version 3.1 Pre-release
-Sunday 6 December 2020
+Tuesday 5 January 2021
 
 Wayne Warthen wwarthen@gmail.com
 
@@ -1061,7 +1061,7 @@ system, you can use the FLASH application to update your ROM. The
 following is a typical example of transferring ROM image using XModem
 and flashing the chip in-situ.
 
-    E>xm r rom.img
+    E>xm r rom.rom
 
     XMODEM v12.5 - 07/13/86
     RBC, 28-Aug-2019 [WBW], ASCI
@@ -1073,7 +1073,7 @@ and flashing the chip in-situ.
 
     Thanks for the upload
 
-    E>flash write rom.img
+    E>flash write rom.rom
     FLASH4 by Will Sowerbutts <will@sowerbutts.com> version 1.2.3
 
     Using RomWBW (v2.6+) bank switching.
@@ -1199,6 +1199,36 @@ Binary\Apps directory of the distribution and in all of the disk images.
 -   FAT.COM
 -   TUNE.COM
 
+System Update
+
+If the system running ROMWBW utilizes the SST39SF040 Flash chip then it
+is possible to do a System Update in place of a System Upgrade in some
+cases.
+
+A System Update would involve only updating the BIOS, ROM applications
+and CP/M system.
+
+A System Update may be more favorable than a System Upgrade in cases
+such as:
+
+-   Overwriting of the ROM drive is not desired.
+-   Space is unavailable to hold a full ROMWBW ROM.
+-   To mimimize time taken to transfer and flash a full ROM.
+-   Configuration changes are only minor and do not impact disk
+    applications.
+
+The ROMWBW build process generates a system upgrade file along with the
+normal ROM image and can be identified by the extension “.upd”. It will
+be 128Kb in size. In comparison the normal ROM image will have the
+extension “.rom” and be 512Kb or 1024Kb in size.
+
+Transferring and flashing the System Update is accomplished in the same
+manner as described above in Upgrading with the required difference
+being that the flash application needs to be directed to complete a
+partial flash using the /p command line switch.
+
+E>flash write rom.upd /p
+
 RomWBW Distribution
 
 All source code and distributions are maintained on GitHub. Code