pc98_usb: Add RDY pulse in response receive #666

[max/tmk_keyboard.git] / converter / pc98_usb / README

diff --git a/converter/pc98_usb/README b/converter/pc98_usb/README
index 4d0d0bfe38dda5c34e2e4c8561d2f2e717e14b46..037e971cefc29cc459c653fe2ec2bcc0d91e569f 100644 (file)
--- a/converter/pc98_usb/README
+++ b/converter/pc98_usb/README
@@ -40,47 +40,54 @@ Frame format: 1-Start bit(Lo), 8-Data bits, Odd-Parity, 1-Stop bit
 
 
 
+Prebilt Firmware
+----------------
+Prebuilt firmware HEX files are available under 'binary' directory.
+
+
+
 Build Firmware
 --------------
-Just use 'make' to bild firmware for TMK PC98 converter.
+Just use 'make' to bild firmware for TMK PC98 converter(ATMega32u2).
 
     $ make clean
     $ make
 
-To flash firmware
+To flash firmware run this command
 
     $ make dfu
 
 then push button on converter to flash firmware.
 
-If you are using ATMega32u4 based board instead of premade TMK PC98 converter(ATMega32u2) use following commands.
+If you are using ATMega32u4 based board use following commands to get firmware HEX file.
 
     $ make -f Makefile.32u4 clean
     $ make -f Makefile.32u4
-    $ make -f Makefile.32u4 dfu
+
+And flash it on your board using specific program method.
 
 
 
 PC98 Scan Codes
 ---------------
     ,---. ,---. ,------------------------. ,------------------------. ,------------------------.
-    |Pau| |PrS| | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10| | F11| F12| F13| F14| F15|
+    |Stp| |Cpy| | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10| | F11| F12| F13| F14| F15|
     `---' `---' `------------------------' `------------------------' `------------------------'
     ,-------------------------------------------------------------. ,-------.  ,---------------.
-    | Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|JPY|Bspc| |Ins|Del|  |Hom|End|  -|  /|
+    | Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|JPY|Bspc| |Ins|Del|  |Hom|Hlp|  -|  /|
     |-------------------------------------------------------------| |-------|  |---------------|
-    | Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|      | |PgD|PgU|  |  7|  8|  9|  *|
+    | Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|      | |RUp|RDn|  |  7|  8|  9|  *|
     |-------------------------------------------------------`Enter| |-------|  |---------------|
     |Ctl|Cap|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|  \|     | |  Up   |  |  4|  5|  6|  +|
     |-------------------------------------------------------------| |-------|  |---------------|
     | Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /| RO| Shift | |Lef|Rig|  |  1|  2|  3|  =|
     `-------------------------------------------------------------' |-------|  |---------------|
-     ^3|Kana|Gui|Alt|MHEN|       Space        |HENK|Alt|Gui|App|^2  | Down  |  |  0|  ,|  .| ^1|
+       |Kana|Win|GRP|NFER|       Space        |XFER| ^2|Win| ^3|    | Down  |  |  0|  ,|  .| ^1|
        `-------------------------------------------------------'    `-------'  `---------------'
-    ^1: Enter on keypad is identical to Enter on alphanumeric portion.
-    ^2: Right Alt is ALT on DIGITAL WAVE Dboard while Menu on PC-9821 keyboard.
-        App is HOME key on PC98XL keyboard.
-    ^3: Caps and Kana are locking keys, either mechanically or by firmware emulation.
+    ^1: Enter on keypad is identical to Enter on alphanumeric portion
+    ^2: ALT on DIGITAL WAVE Dboard while Menu on PC-9821 keyboard
+    ^3: HOME on PC98XL keyboard
+    ^4: CAPS and Kana are locking keys, either mechanically or by firmware emulation
 
 
     ,---. ,---. ,------------------------. ,------------------------. ,------------------------.
@@ -170,14 +177,21 @@ NOTES
 
 
 ### RDY
-Current firmware does not control RDY line and it is drived as low to receive data always. While sending command firmware drive the line high.
-
 PC98 host keeps RDY line high to prevent keyboard from sending data while processing.
 
 https://archive.org/stream/PC9800TechnicalDataBookHARDWARE1993/PC-9800TechnicalDataBook_HARDWARE1993#page/n359
 
+PC-9801V keyboard requires RDY pulse as acknowledgement from host, it doesn't next data without this. Dboard doens't need this.
+
+
 ### Inhibit key repeating
 The command(9Ch, 70h) works with Raku Raku keybaord but not with Dboard.
 
 ### LED indicater
-Dboard has LEDs but it seems to ignore LED control command.
+Dboard has LEDs but replys with FA to 9D command but ignore it. The LED indicates just its internal states. Dboard replays with FA to 9C command but it doesn't seem to understand repeat setting.
+
+PC-9801V has no LEDs and doesn't accept LED command. It replys with 9D to 9D command. PC-9801V doesn't accept repeat setting command. It replys with 9C to 9C command.
+
+
+## PC-9801V
+Note that you have to connect this keyboard with converter before plug in USB port. It seems this keyboard requires for host to send any command before starting to send scan code.