summaryrefslogtreecommitdiff
path: root/converter/ps2_usb/README.md
diff options
context:
space:
mode:
authortmk <nobody@nowhere>2014-04-29 19:42:24 +0900
committertmk <nobody@nowhere>2014-04-29 19:43:25 +0900
commit7209c1d38703eb5ca5c13bd6143c2e7312a15a88 (patch)
tree210b08184e9d891409d0a6f0b0a98558087a3c3e /converter/ps2_usb/README.md
parent110eea578b561f7169ea19927c54533c2b93b3a3 (diff)
Add Makefiles for TMK converters.
Diffstat (limited to 'converter/ps2_usb/README.md')
-rw-r--r--converter/ps2_usb/README.md53
1 files changed, 31 insertions, 22 deletions
diff --git a/converter/ps2_usb/README.md b/converter/ps2_usb/README.md
index 8f06fdd00d..537e92e64f 100644
--- a/converter/ps2_usb/README.md
+++ b/converter/ps2_usb/README.md
@@ -1,31 +1,17 @@
PS/2 to USB keyboard converter
==============================
-This firmware converts PS/2 keyboard protocol to USB and supports only Scan Code Set 2.
-
-
-PS/2 signal handling implementations
-------------------------------------
-Following three methods are used to implement PS/2 signal handling.
-
-### Simple and stupid busy-wait(ps2_busywait.c)
- This is expected to implemented with portable C code for reference.
-### Interrupt driven(ps2_interrupt.c)
- Uses pin interrupt to detect falling edge of clock line.
-### USART hardware module(ps2_usart.c)
- Uses AVR USART engine to receive PS/2 signal.
-
-To select method edit Makefile.
+This firmware converts PS/2 keyboard protocol to USB.(It supports Scan Code Set 2.)
Connect Wires
-------------
In case of Teensy2.0(ATMega32U4):
-1. Connect Vcc and GND.
-2. Connect Clock and Data line.
- - Busywait: Clock is on PD5 and Data on PD2.
- - Interrupt: Clock is on PD1 and Data on PD2.
- - USART: Clock is on PD5 and Data on PD2.
+1. Connect **Vcc** and **GND**.
+2. Connect **Clock** and **Data** line.
+ - **Interrupt**: **Clock** is on `PD1` and **Data** on `PD0`.(Recommended. Soarer's converter compatible)
+ - **Busywait**: **Clock** is on `PD1` and **Data** on `PD0`.
+ - **USART**: **Clock** is on `PD5` and **Data** on `PD2`.
3. Optionally you need pull-up register. 1K-10K Ohm is OK.
To change pin configuration edit config.h.
@@ -33,18 +19,41 @@ To change pin configuration edit config.h.
Build Firmware
--------------
-Just run `make`:
+For **PJRC Teensy** just run `make`:
+ $ make clean
$ make
To select keymap:
+ $ make clean
$ make KEYMAP=[plain|jis|spacefn|...]
+After that you will find HEX file `ps2_usb_lufa.hex` in current directory.
+
+
+- For **TMK converter Rev.1** use `make -f Makefile.tmk_rev1` instead of `make` and HEX file is `ps2_usb_tmk_rev1.hex`.
+
+- For **TMK converter Rev.2** use `make -f Makefile.tmk_rev2` instead of `make` and HEX file is `ps2_usb_tmk_rev2.hex`.
+
Keymap
------
-Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.
+Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document(you can find in README.md of top directory) and existent keymap files.
+
+
+PS/2 signal handling implementations
+------------------------------------
+Following three methods can be used to implement PS/2 signal handling.
+
+### Simple and stupid busy-wait(ps2_busywait.c)
+ This is expected to implemented with portable C code for reference.
+### Interrupt driven(ps2_interrupt.c)
+ Uses pin interrupt to detect falling edge of clock line.
+### USART hardware module(ps2_usart.c)
+ Uses AVR USART engine to receive PS/2 signal.
+
+To select method edit Makefile.
V-USB Support