Browse Source

Another Iteration of Documentation Updates

... still a lot left to go.
pull/331/head
Wayne Warthen 3 years ago
parent
commit
0a6009b38f
  1. BIN
      Doc/RomWBW Applications.pdf
  2. BIN
      Doc/RomWBW Disk Catalog.pdf
  3. BIN
      Doc/RomWBW Errata.pdf
  4. BIN
      Doc/RomWBW ROM Applications.pdf
  5. BIN
      Doc/RomWBW System Guide.pdf
  6. BIN
      Doc/RomWBW User Guide.pdf
  7. 58
      ReadMe.md
  8. 61
      ReadMe.txt
  9. 4
      Source/Doc/Build.cmd
  10. BIN
      Source/Doc/Graphics/Hard Disk Anatomy.vsd
  11. 6
      Source/Doc/Makefile
  12. 68
      Source/Doc/ReadMe.md
  13. 924
      Source/Doc/UserGuide.md

BIN
Doc/RomWBW Applications.pdf

Binary file not shown.

BIN
Doc/RomWBW Disk Catalog.pdf

Binary file not shown.

BIN
Doc/RomWBW Errata.pdf

Binary file not shown.

BIN
Doc/RomWBW ROM Applications.pdf

Binary file not shown.

BIN
Doc/RomWBW System Guide.pdf

Binary file not shown.

BIN
Doc/RomWBW User Guide.pdf

Binary file not shown.

58
ReadMe.md

@ -33,7 +33,7 @@ A dynamic disk drive letter assignment mechanism allows mapping
operating system drive letters to any available disk media. operating system drive letters to any available disk media.
Additionally, mass media devices (IDE Disk, CF Card, SD Card) support Additionally, mass media devices (IDE Disk, CF Card, SD Card) support
the use of multiple slices (up to 256 per device). Each slice contains a 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
complete CP/M file system and can be mapped independently to any drive
letter. This overcomes the inherent size limitations in legacy OSes and letter. This overcomes the inherent size limitations in legacy OSes and
allows up to 2GB of accessible storage on a single device. allows up to 2GB of accessible storage on a single device.
@ -52,16 +52,16 @@ with a full operating system implementation. If you use this disk image,
you can easily pick whichever operating system you want to boot without you can easily pick whichever operating system you want to boot without
changing media. changing media.
By design, RomWBW isolates all of the hardware specific fucntions in the
By design, RomWBW isolates all of the hardware specific functions in the
ROM chip itself. The ROM provides a hardware abstraction layer such that 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 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 RomWBW-based system. To put it simply, you can take a disk (or CF/SD
Card) and move it between systems transparently. Card) and move it between systems transparently.
A tool is provided that allows you to access a FAT-12/16/32 filesystem.
The FAT filesystem may coreside 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.
A tool is provided that allows you to access a FAT-12/16/32 file system.
The FAT file system 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 # Acquiring RomWBW
@ -111,34 +111,50 @@ includes:
# Acknowledgments # Acknowledgments
While I have heavily modified much of the code, I want to acknowledge
that much of the work is derived from the work of others in the
RetroBrew Computers Community including Andrew Lynch, Dan Werner, Max
Scane, David Giles, John Coffman, and probably many others I am not
clearly aware of (let me know if I omitted someone!).
I especially want to credit Douglas Goodall for contributing code, time,
testing, and advice. He created an entire suite of application programs
to enhance the use of RomWBW. However, he is looking for someone to
continue the maintenance of these applications and they have become
unusable due to changes within RomWBW. As of RomWBW 2.6, these
applications are no longer provided.
- David Giles contributed support for the CSIO support in the SD Card
driver.
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 code can still
be found in RomWBW.
- Dan Werner wrote much of the code from which RomWBW was originally
derived and he has always been a great source of knowledge and advice.
- Douglas Goodall contributed code, time, testing, and advice in “the
early days”. He created an entire suite of application programs to
enhance the use of RomWBW. Unfortunately, they have become unusable
due to internal changes within RomWBW. As of RomWBW 2.6, these
applications are no longer provided.
- David Giles created support for the Z180 CSIO which is now included SD
Card driver.
- Ed Brindley contributed some of the code that supports the RC2014 - Ed Brindley contributed some of the code that supports the RC2014
platform. platform.
- Phil Summers contributed the Forth and BASIC adaptations in ROM, the - Phil Summers contributed the Forth and BASIC adaptations in ROM, the
AY-3-8910 sound driver as well as a long list of general code AY-3-8910 sound driver as well as a long list of general code
enhancements. enhancements.
- 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 - Dean Netherton contributed the sound driver interface and the SN76489
sound driver. sound driver.
- The RomWBW Disk Catalog document was produced by Mykl Orders. - The RomWBW Disk Catalog document was produced by Mykl Orders.
Contributions of all kinds to RomWBW are very welcome. Contributions of all kinds to RomWBW are very welcome.

61
ReadMe.txt

@ -1,6 +1,6 @@
RomWBW ReadMe RomWBW ReadMe
Wayne Warthen (mailto:wwarthen@gmail.com) Wayne Warthen (mailto:wwarthen@gmail.com)
27 Jan 2023
29 Jan 2023
@ -47,7 +47,7 @@ A dynamic disk drive letter assignment mechanism allows mapping
operating system drive letters to any available disk media. operating system drive letters to any available disk media.
Additionally, mass media devices (IDE Disk, CF Card, SD Card) support Additionally, mass media devices (IDE Disk, CF Card, SD Card) support
the use of multiple slices (up to 256 per device). Each slice contains a 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
complete CP/M file system and can be mapped independently to any drive
letter. This overcomes the inherent size limitations in legacy OSes and letter. This overcomes the inherent size limitations in legacy OSes and
allows up to 2GB of accessible storage on a single device. allows up to 2GB of accessible storage on a single device.
@ -66,16 +66,16 @@ with a full operating system implementation. If you use this disk image,
you can easily pick whichever operating system you want to boot without you can easily pick whichever operating system you want to boot without
changing media. changing media.
By design, RomWBW isolates all of the hardware specific fucntions in the
By design, RomWBW isolates all of the hardware specific functions in the
ROM chip itself. The ROM provides a hardware abstraction layer such that 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 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 RomWBW-based system. To put it simply, you can take a disk (or CF/SD
Card) and move it between systems transparently. Card) and move it between systems transparently.
A tool is provided that allows you to access a FAT-12/16/32 filesystem.
The FAT filesystem may coreside 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.
A tool is provided that allows you to access a FAT-12/16/32 file system.
The FAT file system 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 Acquiring RomWBW
@ -117,34 +117,51 @@ includes:
Acknowledgments Acknowledgments
While I have heavily modified much of the code, I want to acknowledge
that much of the work is derived from the work of others in the
RetroBrew Computers Community including Andrew Lynch, Dan Werner, Max
Scane, David Giles, John Coffman, and probably many others I am not
clearly aware of (let me know if I omitted someone!).
I especially want to credit Douglas Goodall for contributing code, time,
testing, and advice. He created an entire suite of application programs
to enhance the use of RomWBW. However, he is looking for someone to
continue the maintenance of these applications and they have become
unusable due to changes within RomWBW. As of RomWBW 2.6, these
applications are no longer provided.
- David Giles contributed support for the CSIO support in the SD Card
driver.
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 code can
still be found in RomWBW.
- Dan Werner wrote much of the code from which RomWBW was originally
derived and he has always been a great source of knowledge and
advice.
- Douglas Goodall contributed code, time, testing, and advice in “the
early days”. He created an entire suite of application programs to
enhance the use of RomWBW. Unfortunately, they have become unusable
due to internal changes within RomWBW. As of RomWBW 2.6, these
applications are no longer provided.
- David Giles created support for the Z180 CSIO which is now included
SD Card driver.
- Ed Brindley contributed some of the code that supports the RC2014 - Ed Brindley contributed some of the code that supports the RC2014
platform. platform.
- Phil Summers contributed the Forth and BASIC adaptations in ROM, the - Phil Summers contributed the Forth and BASIC adaptations in ROM, the
AY-3-8910 sound driver as well as a long list of general code AY-3-8910 sound driver as well as a long list of general code
enhancements. enhancements.
- 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 - Dean Netherton contributed the sound driver interface and the
SN76489 sound driver. SN76489 sound driver.
- The RomWBW Disk Catalog document was produced by Mykl Orders. - The RomWBW Disk Catalog document was produced by Mykl Orders.
Contributions of all kinds to RomWBW are very welcome. Contributions of all kinds to RomWBW are very welcome.

4
Source/Doc/Build.cmd

@ -7,7 +7,7 @@ setlocal
:: ::
set TOOLS=..\..\Tools set TOOLS=..\..\Tools
set PATH=%TOOLS%\m4;%TOOLS%\gpp;%PATH%
set PATH=%TOOLS%\gpp;%PATH%
if not "%1"=="" (call :GenDoc %1 & goto :eof) if not "%1"=="" (call :GenDoc %1 & goto :eof)
@ -40,7 +40,7 @@ echo Processing document %1.md...
::gpp -o %1.tmp %1.md ::gpp -o %1.tmp %1.md
::gpp -o %1.tmp -U "\\" "" "{" "}{" "}" "{" "}" "#" "" %1.md ::gpp -o %1.tmp -U "\\" "" "{" "}{" "}" "{" "}" "#" "" %1.md
::gpp -o %1.tmp -U "" "" "(" "," ")" "(" ")" "#" "" -M "#" "\n" " " " " "\n" "(" ")" %1.md ::gpp -o %1.tmp -U "" "" "(" "," ")" "(" ")" "#" "" -M "#" "\n" " " " " "\n" "(" ")" %1.md
gpp -o %1.tmp -U "$" "$" "{" "}{" "}$" "{" "}" "@@@" "" -M "$" "$" "{" "}{" "}$" "{" "}" %1.md
gpp -o %1.tmp -U "$" "$" "{" "}{" "}$" "{" "}" "@@@" "" -M "$" "$" "{" "}{" "}$" "{" "}" %1.md || exit /b
:: pandoc %1.tmp -f markdown -s -o %1.tex --default-image-extension=pdf || exit /b :: pandoc %1.tmp -f markdown -s -o %1.tex --default-image-extension=pdf || exit /b
:: pause :: pause

BIN
Source/Doc/Graphics/Hard Disk Anatomy.vsd

Binary file not shown.

6
Source/Doc/Makefile

@ -3,7 +3,7 @@
# and available on commandline for this build to work!!! # and available on commandline for this build to work!!!
# Typically "sudo apt install pandoc, texlive-latex-extra, gpp" # Typically "sudo apt install pandoc, texlive-latex-extra, gpp"
# #
OBJECTS = ReadMe.gfm Readme.txt UserGuide.pdf SystemGuide.pdf Applications.pdf ROM_Applications.pdf Catalog.pdf Errata.pdf
OBJECTS = ReadMe.gfm ReadMe.txt UserGuide.pdf SystemGuide.pdf Applications.pdf ROM_Applications.pdf Catalog.pdf Errata.pdf
# DEST = ../../Doc # DEST = ../../Doc
TOOLS = ../../Tools TOOLS = ../../Tools
OTHERS = *.tmp OTHERS = *.tmp
@ -13,7 +13,7 @@ include $(TOOLS)/Makefile.inc
all :: deploy all :: deploy
%.tmp : %.md %.tmp : %.md
gpp -o $@ -U "$" "$" "{" "}{" "}$" "{" "}" "@@@" "" -M "$" "$" "{" "}{" "}$" "{" "}" $<
gpp -o $@ -U "$$" "$$" "{" "}{" "}$$" "{" "}" "@@@" "" -M "$$" "$$" "{" "}{" "}$$" "{" "}" $<
%.pdf : %.tmp %.pdf : %.tmp
pandoc $< -f markdown -t latex -s -o $@ --default-image-extension=pdf pandoc $< -f markdown -t latex -s -o $@ --default-image-extension=pdf
@ -38,4 +38,4 @@ deploy :
cp Applications.pdf "../../Doc/RomWBW Applications.pdf" cp Applications.pdf "../../Doc/RomWBW Applications.pdf"
cp ROM_Applications.pdf "../../Doc/RomWBW ROM Applications.pdf" cp ROM_Applications.pdf "../../Doc/RomWBW ROM Applications.pdf"
cp Catalog.pdf "../../Doc/RomWBW Disk Catalog.pdf" cp Catalog.pdf "../../Doc/RomWBW Disk Catalog.pdf"
cp Erratapdf "../../Doc/RomWBW Errata.pdf"
cp Errata.pdf "../../Doc/RomWBW Errata.pdf"

68
Source/Doc/ReadMe.md

@ -37,11 +37,12 @@ ROM firmware itself:
* ROM BASIC (Nascom BASIC and Tasty BASIC) * ROM BASIC (Nascom BASIC and Tasty BASIC)
* ROM Forth * ROM Forth
A dynamic disk drive letter assignment mechanism allows mapping A dynamic disk drive letter assignment mechanism allows mapping
operating system drive letters to any available disk media. operating system drive letters to any available disk media.
Additionally, mass media devices (IDE Disk, CF Card, SD Card) support Additionally, mass media devices (IDE Disk, CF Card, SD Card) support
the use of multiple slices (up to 256 per device). Each slice contains 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
a complete CP/M file system and can be mapped independently to any
drive letter. This overcomes the inherent size limitations in legacy drive letter. This overcomes the inherent size limitations in legacy
OSes and allows up to 2GB of accessible storage on a single device. OSes and allows up to 2GB of accessible storage on a single device.
@ -60,16 +61,16 @@ slices, each with a full operating system implementation. If you use
this disk image, you can easily pick whichever operating system you this disk image, you can easily pick whichever operating system you
want to boot without changing media. want to boot without changing media.
By design, RomWBW isolates all of the hardware specific fucntions in
By design, RomWBW isolates all of the hardware specific functions in
the ROM chip itself. The ROM provides a hardware abstraction layer the ROM chip itself. The ROM provides a hardware abstraction layer
such that all of the operating systems and applications on a disk 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 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. a disk (or CF/SD Card) and move it between systems transparently.
A tool is provided that allows you to access a FAT-12/16/32 filesystem.
The FAT filesystem may coreside 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.
A tool is provided that allows you to access a FAT-12/16/32 file system.
The FAT file system 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 # Acquiring RomWBW
@ -113,34 +114,51 @@ also includes:
# Acknowledgments # Acknowledgments
While I have heavily modified much of the code, I want to acknowledge
that much of the work is derived from the work of others in the
RetroBrew Computers Community including Andrew Lynch, Dan Werner, Max
Scane, David Giles, John Coffman, and probably many others I am not
clearly aware of (let me know if I omitted someone!).
I especially want to credit Douglas Goodall for contributing code,
time, testing, and advice. He created an entire suite of application
programs to enhance the use of RomWBW. However, he is looking for
someone to continue the maintenance of these applications and they
have become unusable due to changes within RomWBW. As of RomWBW 2.6,
these applications are no longer provided.
* David Giles contributed support for the CSIO support in the SD Card
driver.
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
code can still be found in RomWBW.
* Dan Werner wrote much of the code from which RomWBW was originally
derived and he has always been a great source of knowledge and
advice.
* Douglas Goodall contributed code, time, testing, and advice in "the
early days". He created an entire suite of application programs to
enhance the use of RomWBW. Unfortunately, they have become unusable
due to internal changes within RomWBW. As of RomWBW 2.6, these
applications are no longer provided.
* David Giles created support for the Z180 CSIO which is now included
SD Card driver.
* Ed Brindley contributed some of the code that supports the RC2014 * Ed Brindley contributed some of the code that supports the RC2014
platform.
platform.
* Phil Summers contributed the Forth and BASIC adaptations in ROM, the * Phil Summers contributed the Forth and BASIC adaptations in ROM, the
AY-3-8910 sound driver as well as a long list of general code
enhancements.
AY-3-8910 sound driver as well as a long list of general code
enhancements.
* 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 * Dean Netherton contributed the sound driver interface and
the SN76489 sound driver.
the SN76489 sound driver.
* The RomWBW Disk Catalog document was produced by Mykl Orders. * The RomWBW Disk Catalog document was produced by Mykl Orders.
Contributions of all kinds to RomWBW are very welcome. Contributions of all kinds to RomWBW are very welcome.

924
Source/Doc/UserGuide.md

File diff suppressed because it is too large
Loading…
Cancel
Save