Permalink
Browse files

Some documentation additions/fixes

  • Loading branch information...
1 parent b2b2ac2 commit 1f2c29a2430a549cebe9db533cd66943fe9ce200 @stg committed May 21, 2012
Showing with 38 additions and 11 deletions.
  1. +30 −7 README
  2. +8 −4 doc/mem_format.txt
View
@@ -4,9 +4,6 @@ This program is capable of reading and writing:
* 80k disk image files (our proprietary format)
* Steve Conklin's Tandy PDD1 floppy drive emulator data folders.
-Steve Conklin's emulator was designed for KH-930E,
-but it works equally well with the KH-940.
-
== FILES =============================================================
src/ Source files for the disk image manager
@@ -67,16 +64,40 @@ add - Add a pattern to memory
show - Show patterns contained in memory
This will list all available patterns and to into pattern
-
display mode. In this mode you get the following promt:
+
pattern #>
+
instead of the regular one.
To exit this mode enter d, done or simply enter a blank line.
While in this mode, enter the pattern number of an available
pattern to print out a graphical representation of the
pattern as well as it's binary data representation.
+
+
+emulate - Start floppy emulator
+
+ This will ask for a serial device and the format is different
+ depending on your system. For linux-flavors, it will usually
+ look like:
+ serial device> /dev/ttyS0
+
+ For windows, it will look something like:
+ serial device> COM1
+
+ After entering a serial device, the program will go into
+ floppy emulation mode.
+
+ You can exit this mode by sending a SIGINT, which is usually
+ Ctrl+C on most systems.
+
+ While in this mode, you can use the knitting machine to save
+ or load data into program memory, which can first be build
+ using add or read using read.
+
+ After saving from the machine you can keep it with write.
info - Shows additional non-pattern information
@@ -88,9 +109,11 @@ info - Shows additional non-pattern information
to work values that have been downloaded from the machine.
Therefore it MAY give FAIL on "write pointer" entries and/or
- the "loaded head" entry for some files when entered and
- loaded from knitting machine as the true meaning of these
- parameters is not exactly known.
+ the "loaded head" entry for some files because the machine
+ sometimes inserts a 0x00 byte between patterns which causes
+ a mismatch of 1 for these values. Exactly when/why this is
+ done is uncertain, but it is not needed when writing patterns,
+ so it may actually be a bug in the machine.
Additionally, MOST parameters WILL give FAIL on a blank
formatted file, regardless if done via device or this
View
@@ -13,7 +13,7 @@ dump of all contents in the external RAM memory of the machine.
0x7EDF = 0x7FFF - 0x0120
** When writing about alternatives, it means that contents is not
- entirely classified, and could be any of two alternatives.
+ entirely classified, and could be any of several alternatives.
Further investigation was not warranted because knowing the
exact specification is not necessary to build a functional
disk image.
@@ -25,6 +25,10 @@ Offset Bytes Content
Contains array of *up to* 98 pattern descriptors.
Unused items are filled with 0x55 except for FINHDR which
also needs XX=0 and PTN_NUM=next unused id.
+
+ Patterns are not always stored in linear order, ie the list
+ may be 901, 904, 902, 903. This happens when patterns are
+ deleted in the machine.
Content Address (Offset* from header)
/---------------\ <- 0x0000
@@ -113,7 +117,7 @@ Offset Bytes Content
Each row of the pattern may have a number assigned to it but
it is not significant for operation, consider it meta-data.
- Each number requires one nibble for every row, ie HEIGHT/2.
+ Each such number requires one nibble for every row, ie HEIGHT/2.
This is rounded to the nearest byte, hence a pattern
containing 7 rows will have 4 bytes of MEMO data.
A pattern with 10 rows will have 5 bytes of MEMO data.
@@ -193,7 +197,7 @@ Offset Bytes Content
Contains unidentified bit pattern.
Best guess is working memory for pattern input.
- Content with patterns: 5 repetitions of 5 byte pattern
+ Content with patterns: several repetitions of an n-byte pattern
Content after format: 0x55
Write as: 0x00
@@ -258,7 +262,7 @@ Offset Bytes Content
Contains unidentified bit pattern.
Best guess is working memory for pattern input.
- Content with patterns: 5 repetitions of 5 byte pattern
+ Content with patterns: several repetitions of an n-byte pattern
Content after format: 0x55
Write as: 0x00

0 comments on commit 1f2c29a

Please sign in to comment.