Merge pull request #107 from feilipu/master

config - doc / comment language consistency

Binary/RomList.txt

@@ -6,23 +6,23 @@
 ***                                                                 ***
 ***********************************************************************
 
-This directory ("Binary") is part of the RomWBW System Software 
-distribution archive.  Refer to the ReadMe.txt file in this 
-directory for more information on the overall contents of the 
+This directory ("Binary") is part of the RomWBW System Software
+distribution archive.  Refer to the ReadMe.txt file in this
+directory for more information on the overall contents of the
 directory.
 
-When distributed, RomWBW contains a set of pre-built ROM images that 
-are ready to program onto the EEPROM of any of the Z80/Z180 based 
-RetroBrew Computers CPU boards.  Additionally, any custom built ROM 
+When distributed, RomWBW contains a set of pre-built ROM images that
+are ready to program onto the EEPROM of any of the Z80/Z180 based
+RetroBrew Computers CPU boards.  Additionally, any custom built ROM
 images will be placed in this directory.
 
-All of the pre-built ROM images are 512KB.  This size is compatible 
-with all of the Z80/Z180 systems.  Some systems can accept different 
-size ROM images.  Creating alternative sizes requires a custom ROM 
+All of the pre-built ROM images are 512KB.  This size is compatible
+with all of the Z80/Z180 systems.  Some systems can accept different
+size ROM images.  Creating alternative sizes requires a custom ROM
 build (see ReadMe.txt in the Source directory).
 
-It is critical that the right ROM Imgae be selected for the target 
-platform being used.  The table below indicates the correct ROM 
+It is critical that the right ROM Imgae be selected for the target
+platform being used.  The table below indicates the correct ROM
 image to use for each platform:
 
 	SBC V1/V2	SBC_std.rom
@@ -38,23 +38,23 @@ image to use for each platform:
 	Easy Z80	EZZ180_std.rom
 	Dyno		DYNO_std.rom
 
-You will find there is one additional ROM image called 
-"UNA_std.rom". This ROM image is an UNA-based RomWBW ROM image.  As 
-such, this ROM image can be used on any Z80/Z180 platform supported 
-by John Coffman's UNA BIOS.  Refer to RetroBrew Computers Wiki for 
+You will find there is one additional ROM image called
+"UNA_std.rom". This ROM image is an UNA-based RomWBW ROM image.  As
+such, this ROM image can be used on any Z80/Z180 platform supported
+by John Coffman's UNA BIOS.  Refer to RetroBrew Computers Wiki for
 more information on UNA hardware support.
 
-For each of the ROM Images (".rom"), there are corresponding files 
-with the extensions of ".com" and ".img".  The .com variant can be 
-copied to a functional RomWBW-based system and executed like a 
-normal application under CP/M or Z-System. This will load the new 
-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 
+For each of the ROM Images (".rom"), there are corresponding files
+with the extensions of ".com" and ".img".  The .com variant can be
+copied to a functional RomWBW-based system and executed like a
+normal application under CP/M or Z-System. This will load the new
+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.
 
-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.
 
 All of the standard ROM Images are configured for:
@@ -65,25 +65,25 @@ All of the standard ROM Images are configured for:
 
 * RC2014 and Stephen Cousins' kits run at 115,200Kbps baud
 
-All hard disk type devices (IDE, PPIDE, CF Card, SD Card) will be 
-automatically assigned two drive letters per device.  The drive 
-letters will refer to the first 2 slices of the device. The ASSIGN 
-command can be used to display and reassign drives to disk devices 
+All hard disk type devices (IDE, PPIDE, CF Card, SD Card) will be
+automatically assigned two drive letters per device.  The drive
+letters will refer to the first 2 slices of the device. The ASSIGN
+command can be used to display and reassign drives to disk devices
 and slices as desired.
 
 Standard ROM Image Notes
 ------------------------
 
-The standard ROM images will detect and install support for certain 
-devices and peripherals that are on-board or frequently used with 
-each platform as documented below.  If the device or peripheral is 
-not detected at boot, the ROM will simply bypass support 
+The standard ROM images will detect and install support for certain
+devices and peripherals that are on-board or frequently used with
+each platform as documented below.  If the device or peripheral is
+not detected at boot, the ROM will simply bypass support
 appropriately.
 
 SBC (SBC_std.rom):
  - CPU speed is detected at startup
  - Console on onboard UART serial port at 38400 baud
- - Includes support for PPIDE/CF Card(s) connected to on-board    
+ - Includes support for PPIDE/CF Card(s) connected to on-board
    parallel port.
  - Includes support for CVDU and VGA3 boards.  If detected at
    startup, support for video and keyboard is installed
@@ -98,7 +98,7 @@ SBC (SBC_std.rom):
  - SBC V1 has a known race condition in the bank switching
    circuit which is likely to cause system instability.  SBC
    V2 does not have this issue.
-   
+
 SBC (SBC_simh.rom):
  - SBC variant customized to run under SimH
  - Implments two emulated SimH hard disk images
@@ -158,8 +158,8 @@ RCZ80 (RCZ80_std.rom):
  - Console on whichever serial module is installed,
    but will use the SIO/2 if both are installed.  Baud
    rate is determined by hardware, but normally 115200.
- - Includes support for Compact Flash Module
- - Support for PPIDE Module may be enabled in config
+ - Includes support for RC2014 Compact Flash Module
+ - Support for RC2014 PPIDE Module may be enabled in config
  - Support for Scott Baker SIO board may be enabled in config
  - Support for Scott Baker floppy controllers (SMC & WDC) may
    be enabled in config
@@ -169,17 +169,17 @@ RCZ80 w/ KIO (RCZ80_kio.rom):
  - Requires 512K RAM/ROM module
  - Requires KIO module
  - Console on KIO primary serial port at 115200 baud
- - Includes support for Compact Flash Module
- - Includes support for PPIDE Module
+ - Includes support for RC2014 Compact Flash Module
+ - Includes support for RC2014 PPIDE Module
  - Support for Scott Baker SIO board may be enabled in config
  - Support for Scott Baker floppy controllers (SMC & WDC) may
    be enabled in config
 
 RCZ180 (RCZ180_nat.rom & RCZ180_ext.rom):
  - Assumes CPU oscillator of 18.432 MHz
  - Console on Z180 onboard primary ASCI serial port at 115200 baud
- - Includes support for Compact Flash Module
- - Includes support for PPIDE Module
+ - Includes support for RC2014 Compact Flash Module
+ - Includes support for RC2014 PPIDE Module
  - Support for alternative serial modules may be enabled in config
  - Support for Scott Baker floppy controllers (SMC & WDC) may
    be enabled in config
@@ -194,8 +194,8 @@ RCZ180 (RCZ180_nat.rom & RCZ180_ext.rom):
 SCZ180 (SCZ180_126.rom, SCZ180_130.rom, SCZ180_131.rom):
  - Assumes CPU oscillator of 18.432 MHz
  - Console on Z180 onboard primary ASCI serial port at 115200 baud
- - Includes support for Compact Flash Module
- - Includes support for PPIDE Module
+ - Includes support for RC2014 Compact Flash Module
+ - Includes support for RC2014 PPIDE Module
  - Support for alternative serial modules may be enabled in config
  - Support for Scott Baker floppy controllers (SMC & WDC) may
    be enabled in config
@@ -208,7 +208,7 @@ EZZ80 (EZZ80_std.rom):
  - Console on primary SIO serial port at 115200 baud
  - Includes support for on-board SIO
  - Includes support for RC2014 Compact Flash Module
- - Includes support for rc2014 PPIDE Module
+ - Includes support for RC2014 PPIDE Module
 
 DYNO (DYNO_std.rom):
  - Assumes CPU oscillator of 18.432 MHz

Source/HBIOS/cfg_dyno.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_DYNO	; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ18
 CPUFAM		.EQU	CPU_Z180	; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_ezz80.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_EZZ80	; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ1
 CPUFAM		.EQU	CPU_Z80		; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_master.asm

@@ -14,7 +14,7 @@ PLATFORM	.EQU	PLT_SBC		; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ18
 CPUFAM		.EQU	CPU_Z80		; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_mk4.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_MK4		; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ18
 CPUFAM		.EQU	CPU_Z180	; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_n8.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_N8		; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ180
 CPUFAM		.EQU	CPU_Z180	; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_rcz180.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_RCZ180	; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ
 CPUFAM		.EQU	CPU_Z180	; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_rcz80.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_RCZ80	; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ1
 CPUFAM		.EQU	CPU_Z80		; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_sbc.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_SBC		; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ18
 CPUFAM		.EQU	CPU_Z80		; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_scz180.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_SCZ180	; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ
 CPUFAM		.EQU	CPU_Z180	; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_zeta.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_ZETA	; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ18
 CPUFAM		.EQU	CPU_Z80		; CPU_[Z80|Z180]: CPU FAMILY
 BIOS		.EQU	BIOS_WBW	; BIOS_[WBW|UNA]: HARDWARE BIOS
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO] IF AUTO, BOOT DEFAULT AFTER TIMEOUT

Source/HBIOS/cfg_zeta2.asm

@@ -17,7 +17,7 @@ PLATFORM	.EQU	PLT_ZETA2	; PLT_[SBC|ZETA|ZETA2|N8|MK4|UNA|RCZ80|RCZ180|EZZ80|SCZ1
 CPUFAM		.EQU	CPU_Z80		; CPU FAMILY: CPU_[Z80|Z180]
 BIOS		.EQU	BIOS_WBW	; HARDWARE BIOS: BIOS_[WBW|UNA]
 BATCOND		.EQU	FALSE		; ENABLE LOW BATTERY WARNING MESSAGE
-HBIOS_MUTEX	.EQU	FALSE		; PREVENT REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
+HBIOS_MUTEX	.EQU	FALSE		; ENABLE REENTRANT CALLS TO HBIOS (ADDS OVERHEAD)
 USELZSA2	.EQU	TRUE		; ENABLE FONT COMPRESSION
 ;
 BOOTTYPE	.EQU	BT_MENU		; BT_[MENU|AUTO], IF AUTO, BOOT DEFAULT AFTER TIMEOUT