From f624082a62db0b9ff7ae2ab54662978e0ceae902 Mon Sep 17 00:00:00 2001 From: Wayne Warthen Date: Sat, 25 May 2019 16:52:53 -0700 Subject: [PATCH] Finalize v0.9.1-pre.15 --- Binary/ReadMe.txt | 32 +++++++++++++++++------------ Binary/RomList.txt | 11 +++++++--- Doc/ReadMe.txt | 20 +++++++++++++----- ReadMe.txt | 18 +++++++++-------- Source/CBIOS/ver.inc | 2 +- Source/HBIOS/ver.inc | 2 +- Source/Prop/ReadMe.txt | 26 +++++++++++++++--------- Source/ReadMe.txt | 46 +++++++++++++++++++++++++----------------- Tools/ReadMe.txt | 16 +++++++-------- 9 files changed, 106 insertions(+), 67 deletions(-) diff --git a/Binary/ReadMe.txt b/Binary/ReadMe.txt index 447e3c35..d6e90a72 100644 --- a/Binary/ReadMe.txt +++ b/Binary/ReadMe.txt @@ -17,15 +17,14 @@ 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 package file for the release -you want to download. - +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 (_.rom) ------------------------------------- @@ -33,15 +32,15 @@ ROM Firmware Images (_.rom) The files with a ".rom" extension are binary images ready to program into an appropriate PROM. These files are named with the format _.rom. refers to the primary platform such as Zeta, -N8, Mark IV, etc. refers to the specific configuration. When -released, there will be a standard configuration ("std") for each +N8, Mark IV, etc. 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 the -RomList.txt file. +RomList.txt file in this directory. ROM Executable Images (_.com) --------------------------------------- @@ -55,6 +54,11 @@ When run on the target system, they install in RAM just like they had been programmed into the 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 +test the ROM prior to programming it. + ROM Binary Images (_.img) ----------------------------------- @@ -84,7 +88,9 @@ 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 -can quickly create ready-to-use media. +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 diff --git a/Binary/RomList.txt b/Binary/RomList.txt index d706b831..8b86f105 100644 --- a/Binary/RomList.txt +++ b/Binary/RomList.txt @@ -50,14 +50,19 @@ ROM on-the-fly. It is an excellent way to test a ROM Image before actually burning it. Similarly, the .img files can be loaded using the UNA FAT loader for testing. -All of the standard ROM Images are configured with: +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. + +All of the standard ROM Images are configured for: - 512KB ROM Disk - 512KB RAM Disk - 38.4Kbps baud serial console (*) - Auto-discovery of all serial ports -* RC2014 & Easy Z80 serial port speed is determined by hardware - and is typically 115,200 baud. +* RC2014 Z80 & Easy Z80 serial port speed is determined by hardware + and is typically 115,200 baud. RC2014 Z180 is normal 38.4Kbps. All hard disk type devices (IDE, PPIDE, CF Card, SD Card) will be automatically assigned two drive letters per device. The drive diff --git a/Doc/ReadMe.txt b/Doc/ReadMe.txt index 3172dd2c..9f596272 100644 --- a/Doc/ReadMe.txt +++ b/Doc/ReadMe.txt @@ -10,31 +10,41 @@ This directory ("Doc") is part of the RomWBW System Software distribution archive. It contains documentation for components of the system. -CPM Manual: +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. -FDisk Manual: +DDTZ Manual ("DDTZ.doc") +------------------------ + +Manual for the DDTZ v2.7 debug tool included on the ROM drive. + +FDisk Manual ("FDisk Manual.pdf") +--------------------------------- The operational manual for John Coffman's hard disk partitioning program. This program is included in RomWBW as FDISK80. -RomWBW Architecture: +RomWBW Architecture ("RomWBW Architecture.pdf") +----------------------------------------------- Document describing the architecture of the RomWBW HBIOS. It includes reference information for the HBIOS calls. -ZCPR 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. -ZSDOS Manual: +ZSDOS Manual ("ZSDOS Manual.pdf") +--------------------------------- ZSDOS is the DOS portion of Z-System. This is the manual fo ZSDOS 1.x as included in RomWBW. The installation instructions can be diff --git a/ReadMe.txt b/ReadMe.txt index 90d778ae..ec05e8b9 100644 --- a/ReadMe.txt +++ b/ReadMe.txt @@ -7,14 +7,15 @@ *********************************************************************** Wayne Warthen (wwarthen@gmail.com) -Version 2.9.1-pre.15, 2019-05-15 +Version 2.9.1-pre.16, 2019-05-25 https://www.retrobrewcomputers.org/ RomWBW is a ROM-based implementation of CP/M-80 2.2 and Z-System for all RetroBrew Computers Z80/Z180 hardware platforms including SBC -1/2, Zeta 1/2, N8, Mark IV, and RC2014. Virtually all RetroBrew -hardware is supported including floppy, hard disk (IDE, CF Card, SD -Card), Video, and keyboard. VT-100 terminal emulation is built-in. +1/2, Zeta 1/2, N8, Mark IV, RC2014, and Easy Z80. Virtually all +RetroBrew hardware is supported including floppy, hard disk (IDE, CF +Card, SD Card), Video, and keyboard. VT-100 terminal emulation is +built-in. The RomWBW ROM loads and runs the built-in operating systems directly from the ROM and includes a selection of standard/useful applications @@ -219,8 +220,9 @@ Current inclusions are: Note: To exit type B in Monitor and BYE in other applications. -Space is available in the ROM image for the inclusion of other software. -Any inbuild application can be set up to launch automatically at startup. +Space is available in the ROM image for the inclusion of other +software. Any inbuild application can be set up to launch +automatically at startup. Source Code Respository ----------------------- @@ -281,8 +283,8 @@ RetroBrew Computers projects is via the community forum at Also feel free to email Wayne Warthen at wwarthen@gmail.com. -To Do ------ +Documentation To Do +------------------- - Formatting Media - Making a Disk Bootable diff --git a/Source/CBIOS/ver.inc b/Source/CBIOS/ver.inc index e22afda9..c1f8a9b7 100644 --- a/Source/CBIOS/ver.inc +++ b/Source/CBIOS/ver.inc @@ -2,4 +2,4 @@ #DEFINE RMN 9 #DEFINE RUP 1 #DEFINE RTP 0 -#DEFINE BIOSVER "2.9.1-pre.15" +#DEFINE BIOSVER "2.9.1-pre.16" diff --git a/Source/HBIOS/ver.inc b/Source/HBIOS/ver.inc index e22afda9..c1f8a9b7 100644 --- a/Source/HBIOS/ver.inc +++ b/Source/HBIOS/ver.inc @@ -2,4 +2,4 @@ #DEFINE RMN 9 #DEFINE RUP 1 #DEFINE RTP 0 -#DEFINE BIOSVER "2.9.1-pre.15" +#DEFINE BIOSVER "2.9.1-pre.16" diff --git a/Source/Prop/ReadMe.txt b/Source/Prop/ReadMe.txt index f22cf1ea..460c4077 100644 --- a/Source/Prop/ReadMe.txt +++ b/Source/Prop/ReadMe.txt @@ -1,12 +1,18 @@ -The Prop directory contains the files used to build the EEPROM -firmware images for the Propeller based boards supported by -RomWBW. +*********************************************************************** +*** *** +*** R o m W B W *** +*** *** +*** Z80/Z180 System Software *** +*** *** +*********************************************************************** -The build process places the resulting ROM image files in the -Binary directory. The firmware images are intended to integrate -with a host CPU board running RomWBW. The following images are -created: +This directory contains the files used to build the EEPROM firmware +images for the Propeller based boards supported by RomWBW. -PropIO.eeprom for use with original PropIO -PropIO2.eeprom for use with PropIO V2 -ParPortProp.eeprom for use with Zeta ParPortProp +The build process places the resulting ROM image files in the Binary +directory. The firmware images are intended to integrate with a host +CPU board running RomWBW. The following images are created: + + - PropIO.eeprom for use with original PropIO + - PropIO2.eeprom for use with PropIO V2 + - ParPortProp.eeprom for use with Zeta ParPortProp diff --git a/Source/ReadMe.txt b/Source/ReadMe.txt index 6f976949..380035ad 100644 --- a/Source/ReadMe.txt +++ b/Source/ReadMe.txt @@ -35,7 +35,7 @@ Build System Requirements All that is required to build the firmware is a computer running Microsoft Windows and the RomWBW distribution zip archive file. -The zip archive includes all of the required source code +The zip archive package includes all of the required source code (including the operating systems) and the programs required to run the build. @@ -60,10 +60,13 @@ The basic steps to create a custom ROM are: 4) Program the resultant ROM image and try it. -It is *not* necessary to perform steps 1 or 2 before running a -build. In fact, I strongly recommend that you perform steps 3 and -4 initially to make sure that you have no issues building and -programming a ROM that works the same as a pre-built ROM. +Note that steps 1 and 2 are performed to customize your ROM as +desired. If you want to simply build a standard configuration, it is +*not* necessary to perform steps 1 or 2 before running a build. In +fact, I strongly recommend that you skip steps 1 and 2 initially and +just perform perform steps 3 and 4 using the standard configuraion to +make sure that you have no issues building and programming a ROM that +works the same as a pre-built ROM. Each of the 4 steps above is described in more detail below. @@ -81,7 +84,7 @@ series of files named _.asm where refers to the CPU board in your system and is used to name the specific configuration so you can maintain multiple configurations. -You will notice that there is initially one configuration file for +You will notice that there is generaly one configuration file for each CPU platform with a name of "std". For example, you there is a file called MK4_std.asm. This is the standard ("std") configuration for a Mark IV CPU board. @@ -90,20 +93,21 @@ The platform names are predefined. Refer to the following table to determine the component of the configuration filename: SBC V1/V2 SBC_std.rom + SBC SimH SBC_simh.rom Zeta V1 ZETA_std.rom Zeta V2 ZETA2_std.rom N8 N8_std.rom Mark IV MK4_std.rom RC2014 RC_std.rom - Easy Z80 EZZ80_std.rom + RC2014 w/ Z180 RC180_nat.rom (native Z180 memory addressing) + RC2014 w/ Z180 RC180_ext.rom (512K RAM/ROM module) + Easy Z80 EZZ180_std.rom You can use any name you choose for the component of the configuration filename. So, let's say you want to create a custom ROM for the Mark IV. You would simply copy "MK4_std.asm" to -something like "MK4_cust.asm". - -Now, just edit the new file ("MK4_cust.asm" in this example) as -desired. +something like "MK4_cust.asm". Now, just edit the new file +("MK4_cust.asm" in this example) as desired. You will see that the file already has lines for all of the common options and there is a comment after each option indicating the @@ -148,6 +152,10 @@ with the platform specified in the ROM Build. There is a ReadMe.txt document in the \Source\RomDsk directory with a more detailed description of this process. +Note that the standard 512K ROM disk is absolutely full. So, if +you want to add files to it, you will need to delete other files +to free up some space. + 3. Run the Build Process ------------------------ @@ -180,7 +188,7 @@ This command will prompt you twice as it runs. These prompts determine the platform and configuration to be built. The first prompt is for the platform, as shown below: - Platform [SBC|ZETA|ZETA2|N8|MK4|UNA]: + Platform [SBC|ZETA|ZETA2|RCZ80|EZZ80|RCZ180|N8|MK4|UNA]: Enter the option corresponding to the platform of the ROM firmware you are building. If you enter something other than one of the @@ -232,7 +240,7 @@ used: Upon completion of a successful build, you should find the resulting firmware in the Binary directory. These output files -will have names that match the config filename, but will different +will have names that match the config filename, but with different extensions. Three output files will be created for a single BuildROM run: @@ -257,22 +265,24 @@ information on the other two file extensions created. Specifying Build Options on Command Line ---------------------------------------- -If you don't want to be prompted for the options to the "BuildROM" +If you don't want to be prompteded for the options to the "BuildROM" command, you can specify the options right on the command line. For example: C:\RomWBW\Source> BuildROM MK4 cust -In this case, you will not be prompted. This is useful if you -wish to automate your build process. +In this case, you will not be prompted. This is useful if you wish +to automate your build process. There is a third parameter that you can specify to the BuildROM -command via a command line. If you want to build a 1024K (1MB) -ROM, you can add "1024" to the end of the line, like this: +command via a command line. If you want to build a 1024K (1MB) ROM, +you can add "1024" to the end of the line, like this: C:\RomWBW\Source> BuildROM MK4 cust 1024 +You must ensure that your system actually supports a 1024K ROM. + Special Build Commands ---------------------- diff --git a/Tools/ReadMe.txt b/Tools/ReadMe.txt index a66323e4..be0c03e9 100644 --- a/Tools/ReadMe.txt +++ b/Tools/ReadMe.txt @@ -20,17 +20,17 @@ does for MS-DOS. bst: -The bst tool set is a multi-platform set of tools for developing -with the Parallax Propeller microcontroller. bst stands for -“Brad's Spin Tool”, however it is never capitalised. This toolset -is used to compile the Propeller firmware for PropIO and -ParPortProp. +The bst tool set is a multi-platform set of tools for developing with +the Parallax Propeller microcontroller. bst stands for “Brad's Spin +Tool”, however it is never capitalised. This toolset is used to +compile the Propeller firmware for PropIO and ParPortProp. cpm: -This is the root of a directory tree containing CP/M-80 programs. -These programs are used (via the Windows CP/M command line -emulator 'zx') to build certain components of RomWBW. The use of +This is the root of a directory tree containing native CP/M-80 +programs. These programs cannot be invoked directly by DOS/Windows. +Instead, they are executed via the Windows CP/M command line +emulator 'zx' to build certain components of RomWBW. The use of real CP/M-80 programs as part of the build process ensures proper construction of these components.