PS/2 to USB keyboard converter

5 files changed, 867 insertions, 0 deletions

diff --git a/ps2_usb/Makefile b/ps2_usb/Makefile
new file mode 100644
index 0000000000..bd9a76eb85
--- /dev/null
+++ b/ps2_usb/Makefile
@@ -0,0 +1,81 @@
+# Hey Emacs, this is a -*- makefile -*-
+#----------------------------------------------------------------------------
+# WinAVR Makefile Template written by Eric B. Weddington, Jörg Wunsch, et al.
+#
+# Released to the Public Domain
+#
+# Additional material for this makefile was written by:
+# Peter Fleury
+# Tim Henigan
+# Colin O'Flynn
+# Reiner Patommel
+# Markus Pfaff
+# Sander Pool
+# Frederik Rouleau
+# Carlos Lamas
+#
+#----------------------------------------------------------------------------
+# On command line:
+#
+# make all = Make software.
+#
+# make clean = Clean out built project files.
+#
+# make coff = Convert ELF to AVR COFF.
+#
+# make extcoff = Convert ELF to AVR Extended COFF.
+#
+# make program = Download the hex file to the device, using avrdude.
+#                Please customize the avrdude settings below first!
+#
+# make debug = Start either simulavr or avarice as specified for debugging, 
+#              with avr-gdb or avr-insight as the front end for debugging.
+#
+# make filename.s = Just compile filename.c into the assembler code only.
+#
+# make filename.i = Create a preprocessed source file for use in submitting
+#                   bug reports to the GCC project.
+#
+# To rebuild project do "make clean" then "make all".
+#----------------------------------------------------------------------------
+
+# Target file name (without extension).
+TARGET = tmk_ps2_usb
+
+# Directory common source filess exist
+COMMON_DIR = ..
+
+# Directory keyboard dependent files exist
+TARGET_DIR = .
+
+# keyboard dependent files
+TARGET_SRC =	keymap.c \
+  	        matrix.c \
+		ps2.c
+
+
+# MCU name, you MUST set this to match the board you are using
+# type "make clean" after changing this, so all files will be rebuilt
+#MCU = at90usb162       # Teensy 1.0
+MCU = atmega32u4       # Teensy 2.0
+#MCU = at90usb646       # Teensy++ 1.0
+#MCU = at90usb1286      # Teensy++ 2.0
+
+
+# Processor frequency.
+#   Normally the first thing your program should do is set the clock prescaler,
+#   so your program will run at the correct speed.  You should also set this
+#   variable to same clock speed.  The _delay_ms() macro uses this, and many
+#   examples use this variable to calculate timings.  Do not add a "UL" here.
+F_CPU = 16000000
+
+
+# Build Options
+#   comment out to disable the options.
+#
+MOUSEKEY_ENABLE = yes	# Mouse keys
+USB_EXTRA_ENABLE = yes	# Enhanced feature for Windows(Audio control and System control)
+USB_NKRO_ENABLE = yes	# USB Nkey Rollover
+
+
+include $(COMMON_DIR)/Makefile.common
diff --git a/ps2_usb/README b/ps2_usb/README
new file mode 100644
index 0000000000..3c9eb14282
--- /dev/null
+++ b/ps2_usb/README
@@ -0,0 +1,103 @@
+PS/2 to USB keyboard converter
+==============================
+
+This firmware converts PS/2 keyboard protocol to USB.
+
+
+Demostration build
+------------------
+In this demo build, you can try several layouts,
+mouse keys and USB NKRO.
+
+Special keys:
+    Magic+0:    Qwerty with mouse keys(default)
+    Magic+1:    Qwerty
+    Magic+2:    Colemak
+    Magic+3:    Dvorak
+    Magic+4:    Workman
+    Magic+N:    toggles NKRO/6KRO(6KRO by default)
+    Magic+Esc:  sends Power Event
+    where Magic=(LShift+RShift) or (LControl+RShift)
+
+Keybinds:
+    Fn0+(hjkl): Mouse key move(vi cursor)
+    Fn0+(yuio): Mouse wheel(left,down,up,right)
+    Fn0+space:  Mouse button1
+    Fn0+(mnb):  Mouse buttons(1,2,3)
+    Fn0+(zxc):  Media control(Volup, Voldown, Mute)
+    Fn1+(hjkl): Cursor move(vi cursor)
+    Fn1+(nm,.): Cursor move(Home,PageDown,PageUp,End)
+
+    Fn2+(esdf): Mouse key move(invert T cursor)
+    Fn2+(qwrt): Mouse wheel(left,down,up,right)
+    Fn2+space:  Mouse button1
+    Fn2+(,./):  Media control(Volup, Voldown, Mute)
+    where Fn0=;, Fn1=/, Fn2=a
+
+
+Features
+--------
+Mouse keys
+    You can emulates mouse move and button click using keyboard.
+System/Media control
+    You can sends Power event, Volume down/up and Mute.
+USB NKRO(actually 120KRO+8Modifiers)
+    You can tolggles NKRO/6KRO.(Not tested on Mac.)
+Keymap customization
+    You can customize keymaps easily by editing source code.
+
+
+Build
+-----
+0. Connect PS/2 keyboard to Teensy by 4 lines(Vcc, GND, Data, Clock).
+1. Define following macros for PS/2 connection in config.h:
+   PS2_DATA_PORT
+   PS2_DATA_PIN
+   PS2_DATA_DDR
+   PS2_DATA_BIT
+   PS2_CLOCK_PORT
+   PS2_CLOCK_PIN
+   PS2_CLOCK_DDR
+   PS2_CLOCK_BIT
+2. Edit Makefile for build options and MCU setting.
+2. make
+3. program Teensy.
+   http://www.pjrc.com/teensy/loader.html
+
+
+Keymap
+------
+You can change a keymap by editing code of keymap.c like following.
+How to define the keymap is probably obvious. You can find  key
+symbols in usb_keycodes.h.
+If you want to define more than one keymap, see hhkb/keymap.c and
+macway/keymap.c as examples. To define keymap(layer) switching may
+needs a bit of your effort at this time.
+
+    /* Default Layer: plain keymap
+     * ,---.   ,---------------. ,---------------. ,---------------. ,-----------.     ,-----------.
+     * |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|     |Pwr|Slp|Wak|
+     * `---'   `---------------' `---------------' `---------------' `-----------'     `-----------'
+     * ,-----------------------------------------------------------. ,-----------. ,---------------.
+     * |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backspa| |Ins|Hom|PgU| |NmL|  /|  *|  -|
+     * |-----------------------------------------------------------| |-----------| |---------------|
+     * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD| |  7|  8|  9|   |
+     * |-----------------------------------------------------------| `-----------' |-----------|  +|
+     * |CapsLo|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |               |  4|  5|  6|   |
+     * |-----------------------------------------------------------|     ,---.     |---------------|
+     * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shift     |     |Up |     |  1|  2|  3|   |
+     * |-----------------------------------------------------------| ,-----------. |-----------|Ent|
+     * |Ctrl |Gui |Alt |         Space         |Alt |Gui |Menu|Ctrl| |Lef|Dow|Rig| |      0|  .|   |
+     * `-----------------------------------------------------------' `-----------' `---------------'
+     */
+    KEYMAP(
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12,           PSCR,SLCK,BRK,          PWR, F13, F14,
+    GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC,     INS, HOME,PGUP,    NLCK,PSLS,PAST,PMNS,
+    TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,BSLS,     DEL, END, PGDN,    P7,  P8,  P9,
+    CAPS,A,   S,   D,   F,   G,   H,   J,   K,   L,   SCLN,QUOT,     ENT,                         P4,  P5,  P6,  PPLS,
+    LSFT,Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, SLSH,          RSFT,          UP,           P1,  P2,  P3,
+    LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
+    ),
+
+
+EOF
diff --git a/ps2_usb/config.h b/ps2_usb/config.h
new file mode 100644
index 0000000000..be96f004a8
--- /dev/null
+++ b/ps2_usb/config.h
@@ -0,0 +1,38 @@
+#ifndef CONFIG_H
+#define CONFIG_H
+
+/* controller configuration */
+#include "controller_teensy.h"
+
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x6512
+#define MANUFACTURER    t.m.k.
+#define PRODUCT         PS/2 keyboard converter
+#define DESCRIPTION     convert PS/2 keyboard to USB
+
+/* matrix size */
+#define MATRIX_ROWS 32  // keycode bit: 3-0
+#define MATRIX_COLS 8   // keycode bit: 6-4
+/* define if matrix has ghost */
+//#define MATRIX_HAS_GHOST
+
+/* USB NKey Rollover */
+#ifdef USB_NKRO_ENABLE
+#endif
+
+/* mouse keys */
+#ifdef MOUSEKEY_ENABLE
+#   define MOUSEKEY_DELAY_TIME 255
+#endif
+
+/* PS/2 mouse */
+#define PS2_CLOCK_PORT  PORTF
+#define PS2_CLOCK_PIN   PINF
+#define PS2_CLOCK_DDR   DDRF
+#define PS2_CLOCK_BIT   0
+#define PS2_DATA_PORT   PORTF
+#define PS2_DATA_PIN    PINF
+#define PS2_DATA_DDR    DDRF
+#define PS2_DATA_BIT    1
+
+#endif
diff --git a/ps2_usb/keymap.c b/ps2_usb/keymap.c
new file mode 100644
index 0000000000..f38784d1f5
--- /dev/null
+++ b/ps2_usb/keymap.c
@@ -0,0 +1,189 @@
+/* 
+ * Keymap for PS/2 keyboard
+ */
+#include <stdint.h>
+#include <stdbool.h>
+#include <avr/pgmspace.h>
+#include "usb_keyboard.h"
+#include "usb_keycodes.h"
+#include "print.h"
+#include "debug.h"
+#include "util.h"
+#include "keymap_skel.h"
+
+
+#define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
+
+// Convert physical keyboard layout to matrix array.
+// This is a macro to define keymap easily in keyboard layout form.
+#define KEYMAP( \
+    K76,  K05,K06,K04,K0C, K03,K0B,K83,K0A, K01,K09,K78,K07, KFE,K7E,KFF,      KB7,KBF,KDE, \
+    K0E,K16,K1E,K26,K25,K2E,K36,K3D,K3E,K46,K45,K4E,K55,K66, KF0,KEC,KFD,  K77,KCA,K7C,K7B, \
+    K0D,K15,K1D,K24,K2D,K2C,K35,K3C,K43,K44,K4D,K54,K5B,K5D, KF1,KE9,KFA,  K6C,K75,K7D,     \
+    K58,K1C,K1B,K23,K2B,K34,K33,K3B,K42,K4B,K4C,K52,    K5A,               K6B,K73,K74,K79, \
+    K12,K1A,K22,K21,K2A,K32,K31,K3A,K41,K49,K4A,        K59,     KF5,      K69,K72,K7A,     \
+    K14,K9F,K11,        K29,                K91,KA7,KAF,K94, KEB,KF2,KF4,  K70,    K71,KDA  \
+) { \
+    { KB_NO,    KB_##K01, KB_NO,    KB_##K03, KB_##K04, KB_##K05, KB_##K06, KB_##K07 }, \
+    { KB_NO,    KB_##K09, KB_##K0A, KB_##K0B, KB_##K0C, KB_##K0D, KB_##K0E, KB_NO    }, \
+    { KB_NO,    KB_##K11, KB_##K12, KB_NO,    KB_##K14, KB_##K15, KB_##K16, KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_##K1A, KB_##K1B, KB_##K1C, KB_##K1D, KB_##K1E, KB_NO    }, \
+    { KB_NO,    KB_##K21, KB_##K22, KB_##K23, KB_##K24, KB_##K25, KB_##K26, KB_NO    }, \
+    { KB_NO,    KB_##K29, KB_##K2A, KB_##K2B, KB_##K2C, KB_##K2D, KB_##K2E, KB_NO    }, \
+    { KB_NO,    KB_##K31, KB_##K32, KB_##K33, KB_##K34, KB_##K35, KB_##K36, KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_##K3A, KB_##K3B, KB_##K3C, KB_##K3D, KB_##K3E, KB_NO    }, \
+    { KB_NO,    KB_##K41, KB_##K42, KB_##K43, KB_##K44, KB_##K45, KB_##K46, KB_NO    }, \
+    { KB_NO,    KB_##K49, KB_##K4A, KB_##K4B, KB_##K4C, KB_##K4D, KB_##K4E, KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_##K52, KB_NO,    KB_##K54, KB_##K55, KB_NO,    KB_NO    }, \
+    { KB_##K58, KB_##K59, KB_##K5A, KB_##K5B, KB_NO,    KB_##K5D, KB_NO,    KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_##K66, KB_NO    }, \
+    { KB_NO,    KB_##K69, KB_NO,    KB_##K6B, KB_##K6C, KB_NO,    KB_NO,    KB_NO    }, \
+    { KB_##K70, KB_##K71, KB_##K72, KB_##K73, KB_##K74, KB_##K75, KB_##K76, KB_##K77 }, \
+    { KB_##K78, KB_##K79, KB_##K7A, KB_##K7B, KB_##K7C, KB_##K7D, KB_##K7E, KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_##K83, KB_NO,    KB_NO,    KB_NO,    KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO    }, \
+    { KB_NO,    KB_##K91, KB_NO,    KB_NO,    KB_##K94, KB_NO,    KB_NO,    KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_##K9F }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_##KA7 }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_##KAF }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_##KB7 }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_##KBF }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_##KCA, KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_##KDA, KB_NO,    KB_NO,    KB_NO,    KB_##KDE, KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO,    KB_NO    }, \
+    { KB_NO,    KB_##KE9, KB_NO,    KB_##KEB, KB_##KEC, KB_NO,    KB_NO,    KB_NO    }, \
+    { KB_##KF0, KB_##KF1, KB_##KF2, KB_NO,    KB_##KF4, KB_##KF5, KB_NO,    KB_NO    }, \
+    { KB_NO,    KB_NO,    KB_##KFA, KB_NO,    KB_NO,    KB_##KFD, KB_##KFE, KB_##KFF }, \
+}
+
+
+// Assign Fn key(0-7) to a layer to which switch with the Fn key pressed.
+static const uint8_t PROGMEM fn_layer[] = {
+    5,              // Fn0
+    6,              // Fn1
+    5,              // Fn2
+    0,              // Fn3
+    0,              // Fn4
+    0,              // Fn5
+    0,              // Fn6
+    0               // Fn7
+};
+
+// Assign Fn key(0-7) to a keycode sent when release Fn key without use of the layer.
+// See layer.c for details.
+static const uint8_t PROGMEM fn_keycode[] = {
+    KB_SCLN,        // Fn0
+    KB_SLSH,        // Fn1
+    KB_A,           // Fn2
+    KB_NO,          // Fn3
+    KB_NO,          // Fn4
+    KB_NO,          // Fn5
+    KB_NO,          // Fn6
+    KB_NO           // Fn7
+};
+
+static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* keymap
+     * ,---.   ,---------------. ,---------------. ,---------------. ,-----------.     ,-----------.
+     * |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|     |Pwr|Slp|Wak|
+     * `---'   `---------------' `---------------' `---------------' `-----------'     `-----------'
+     * ,-----------------------------------------------------------. ,-----------. ,---------------.
+     * |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backspa| |Ins|Hom|PgU| |NmL|  /|  *|  -|
+     * |-----------------------------------------------------------| |-----------| |---------------|
+     * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD| |  7|  8|  9|   |
+     * |-----------------------------------------------------------| `-----------' |-----------|  +|
+     * |CapsLo|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |               |  4|  5|  6|   |
+     * |-----------------------------------------------------------|     ,---.     |---------------|
+     * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shift     |     |Up |     |  1|  2|  3|   |
+     * |-----------------------------------------------------------| ,-----------. |-----------|Ent|
+     * |Ctrl |Gui |Alt |         Space         |Alt |Gui |Menu|Ctrl| |Lef|Dow|Rig| |      0|  .|   |
+     * `-----------------------------------------------------------' `-----------' `---------------'
+     */
+    /* 0: default */
+    KEYMAP(
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12,           PSCR,SLCK,BRK,          PWR, F13, F14,
+    GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC,     INS, HOME,PGUP,    NLCK,PSLS,PAST,PMNS,
+    TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,BSLS,     DEL, END, PGDN,    P7,  P8,  P9,
+    CAPS,FN2, S,   D,   F,   G,   H,   J,   K,   L,   FN0, QUOT,     ENT,                         P4,  P5,  P6,  PPLS,
+    LSFT,Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, FN1,           RSFT,          UP,           P1,  P2,  P3,
+    LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
+    ),
+    /* 1: plain Qwerty without layer switching */
+    KEYMAP(
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12,           PSCR,SLCK,BRK,          PWR, F13, F14,
+    GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC,     INS, HOME,PGUP,    NLCK,PSLS,PAST,PMNS,
+    TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,BSLS,     DEL, END, PGDN,    P7,  P8,  P9,
+    CAPS,A,   S,   D,   F,   G,   H,   J,   K,   L,   SCLN,QUOT,     ENT,                         P4,  P5,  P6,  PPLS,
+    LSFT,Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, SLSH,          RSFT,          UP,           P1,  P2,  P3,
+    LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
+    ),
+    /* 2: Colemak http://colemak.com */
+    KEYMAP(
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12,           PSCR,SLCK,BRK,          PWR, F13, F14,
+    GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC,     INS, HOME,PGUP,    NLCK,PSLS,PAST,PMNS,
+    TAB, Q,   W,   F,   P,   G,   J,   L,   U,   Y,   SCLN,LBRC,RBRC,BSLS,     DEL, END, PGDN,    P7,  P8,  P9,
+    BSPC,A,   R,   S,   T,   D,   H,   N,   E,   I,   O,   QUOT,     ENT,                         P4,  P5,  P6,  PPLS,
+    LSFT,Z,   X,   C,   V,   B,   K,   M,   COMM,DOT, SLSH,          RSFT,          UP,           P1,  P2,  P3,
+    LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
+    ),
+    /* 3: Dvorak http://en.wikipedia.org/wiki/Dvorak_Simplified_Keyboard */
+    KEYMAP(
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12,           PSCR,SLCK,BRK,          PWR, F13, F14,
+    GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   LBRC,RBRC,BSPC,     INS, HOME,PGUP,    NLCK,PSLS,PAST,PMNS,
+    TAB, QUOT,COMM,DOT, P,   Y,   F,   G,   C,   R,   L,   SLSH,EQL, BSLS,     DEL, END, PGDN,    P7,  P8,  P9,
+    CAPS,A,   O,   E,   U,   I,   D,   H,   T,   N,   S,   MINS,     ENT,                         P4,  P5,  P6,  PPLS,
+    LSFT,SCLN,Q,   J,   K,   X,   B,   M,   W,   V,   Z,             RSFT,          UP,           P1,  P2,  P3,
+    LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
+    ),
+    /* 4: Workman http://viralintrospection.wordpress.com/2010/09/06/a-different-philosophy-in-designing-keyboard-layouts/ */
+    KEYMAP(
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12,           PSCR,SLCK,BRK,          PWR, F13, F14,
+    GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC,     INS, HOME,PGUP,    NLCK,PSLS,PAST,PMNS,
+    TAB, Q,   D,   R,   W,   B,   J,   F,   U,   P,   SCLN,LBRC,RBRC,BSLS,     DEL, END, PGDN,    P7,  P8,  P9,
+    BSPC,A,   S,   H,   T,   G,   Y,   N,   E,   O,   I,   QUOT,     ENT,                         P4,  P5,  P6,  PPLS,
+    LSFT,Z,   X,   M,   C,   V,   K,   L,   COMM,DOT, SLSH,          RSFT,          UP,           P1,  P2,  P3,
+    LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
+    ),
+    /* 5: Mouse keys */
+    KEYMAP(
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12,           PSCR,SLCK,BRK,          PWR, F13, F14,
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F8,  F10, F11, F12, BSPC,     INS, HOME,PGUP,    NLCK,PSLS,PAST,PMNS,
+    TAB, WH_L,WH_D,MS_U,WH_U,WH_R,WH_L,WH_D,WH_U,WH_R,NO,  NO,  NO,  BSLS,     DEL, END, PGDN,    P7,  P8,  P9,
+    CAPS,FN2, MS_L,MS_D,MS_R,NO,  MS_L,MS_D,MS_U,MS_R,FN0, NO,       ENT,                         P4,  P5,  P6,  PPLS,
+    LSFT,VOLD,VOLU,MUTE,BTN2,BTN3,BTN2,BTN1,VOLD,VOLU,MUTE,          RSFT,          UP,           P1,  P2,  P3,
+    LCTL,LGUI,LALT,          BTN1,                    RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
+    ),
+    /* 6: Cursor keys */
+    KEYMAP(
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12,           PSCR,SLCK,BRK,          PWR, F13, F14,
+    ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F8,  F10, F11, F12, BSPC,     INS, HOME,PGUP,    NLCK,PSLS,PAST,PMNS,
+    TAB, NO,  NO,  NO,  NO,  NO,  HOME,PGDN,PGUP,END, NO,  NO,  NO,  BSLS,     DEL, END, PGDN,    P7,  P8,  P9,
+    CAPS,NO,  NO,  NO,  NO,  NO,  LEFT,DOWN,UP,  RGHT,NO,  NO,       ENT,                         P4,  P5,  P6,  PPLS,
+    LSFT,VOLD,VOLU,MUTE,NO,  NO,  HOME,PGUP,PGDN,END, FN1,           RSFT,          UP,           P1,  P2,  P3,
+    LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL,     LEFT,DOWN,RGHT,    P0,       PDOT,PENT
+    ),
+};
+
+
+uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col)
+{
+    return KEYCODE(layer, row, col);
+}
+
+uint8_t keymap_fn_layer(uint8_t fn_bits)
+{
+    return pgm_read_byte(&fn_layer[biton(fn_bits)]);
+}
+
+uint8_t keymap_fn_keycode(uint8_t fn_bits)
+{
+    return pgm_read_byte(&fn_keycode[(biton(fn_bits))]);
+}
+
+// define a condition to enter special function mode
+bool keymap_is_special_mode(uint8_t fn_bits)
+{
+    return usb_keyboard_mods == (BIT_LSHIFT | BIT_RSHIFT) || usb_keyboard_mods == (BIT_LCTRL | BIT_RSHIFT);
+}
diff --git a/ps2_usb/matrix.c b/ps2_usb/matrix.c
new file mode 100644
index 0000000000..366568d681
--- /dev/null
+++ b/ps2_usb/matrix.c
@@ -0,0 +1,456 @@
+/*
+ * scan matrix
+ */
+#include <stdint.h>
+#include <stdbool.h>
+#include <avr/io.h>
+#include <util/delay.h>
+#include "print.h"
+#include "util.h"
+#include "debug.h"
+#include "ps2.h"
+#include "usb_keyboard.h"
+#include "matrix_skel.h"
+
+
+#if (MATRIX_COLS > 16)
+#   error "MATRIX_COLS must not exceed 16"
+#endif
+#if (MATRIX_ROWS > 255)
+#   error "MATRIX_ROWS must not exceed 255"
+#endif
+
+
+/*
+ * Matrix usage:
+ * "PS/2 Scan Codes Set 2" is assigned to 256(32x8)cells matrix.
+ * Hmm, It is very sparse and not efficient :(
+ *
+ *      8bit
+ *    ---------
+ *  0|         |
+ *  :|   XX    | 00-7F for normal codes
+ *  f|_________|
+ * 10|         |
+ *  :|  E0 XX  | 80-FF for E0-prefix codes(use (XX|0x80) as code)
+ * 1f|         |
+ *    ---------
+ * exceptions:
+ * 0x83: F8(normal code placed beyond 0x7F)
+ * 0xFE: PrintScreen
+ * 0xFF: Puause/Break
+ */
+#define _PRINT_SCREEN   (0xFE)
+#define _PAUSE_BREAK    (0xFF)
+#define _ROW(code)      (code>>3)
+#define _COL(code)      (code&0x07)
+
+static bool _matrix_is_modified = false;
+
+// matrix state buffer(1:on, 0:off)
+#if (MATRIX_COLS <= 8)
+static uint8_t *matrix;
+static uint8_t _matrix0[MATRIX_ROWS];
+#else
+static uint16_t *matrix;
+static uint16_t _matrix0[MATRIX_ROWS];
+#endif
+
+#ifdef MATRIX_HAS_GHOST
+static bool matrix_has_ghost_in_row(uint8_t row);
+#endif
+static void _matrix_make(uint8_t code);
+static void _matrix_break(uint8_t code);
+static void _ps2_reset(void);
+static void _ps2_set_leds(uint8_t leds);
+
+
+inline
+uint8_t matrix_rows(void)
+{
+    return MATRIX_ROWS;
+}
+
+inline
+uint8_t matrix_cols(void)
+{
+    return MATRIX_COLS;
+}
+
+void matrix_init(void)
+{
+    print_enable = true;
+    ps2_host_init();
+
+    _ps2_reset();
+
+    // flush LEDs
+    _ps2_set_leds(1<<PS2_LED_NUM_LOCK);
+    _delay_ms(100);
+    _ps2_set_leds(1<<PS2_LED_NUM_LOCK|1<<PS2_LED_CAPS_LOCK);
+    _delay_ms(100);
+    _ps2_set_leds(1<<PS2_LED_NUM_LOCK|1<<PS2_LED_CAPS_LOCK|1<<PS2_LED_SCROLL_LOCK);
+    _delay_ms(300);
+    _ps2_set_leds(0x00);
+    
+    // initialize matrix state: all keys off
+    for (uint8_t i=0; i < MATRIX_ROWS; i++) _matrix0[i] = 0x00;
+    matrix = _matrix0;
+
+    return;
+}
+
+uint8_t matrix_scan(void)
+{
+
+    static enum {
+        INIT,
+        BREAK,
+        E0,
+        E0_F0,
+        // states for PrintScreen
+        E0_12,
+        E0_12_E0,
+        E0_F0_7C,
+        E0_F0_7C_E0,
+        E0_F0_7C_E0_F0,
+        // states for Pause/Break
+        E1,
+        E1_14,
+        E1_14_77,
+        E1_14_77_E1,
+        E1_14_77_E1_F0,
+        E1_14_77_E1_F0_14,
+        E1_14_77_E1_F0_14_F0,
+    } state = INIT;
+
+
+    _matrix_is_modified = false;
+
+    // Pause/Break off(PS/2 has no break for this key)
+    if (matrix_is_on(_ROW(_PAUSE_BREAK), _COL(_PAUSE_BREAK))) {
+        _matrix_break(_PAUSE_BREAK);
+    }
+
+    uint8_t code;
+    while ((code = ps2_host_recv())) {
+        switch (state) {
+            case INIT:
+                switch (code) {
+                    case 0xE0:  // 2byte make
+                        state = E0;
+                        break;
+                    case 0xF0:  // break code
+                        state = BREAK;
+                        break;
+                    case 0xE1:  // Pause/Break
+                        state = E1;
+                        break;
+                    default:    // normal key make
+                        if (code < 0x80) {
+                            _matrix_make(code);
+                        } else {
+                            debug("ps/2 unknow code: "); debug_hex(code); debug("\n");
+                        }
+                        state = INIT;
+                }
+                break;
+            case E0:
+                switch (code) {
+                    case 0x12:  // PrintScreen(make)
+                        state = E0_12;
+                        break;
+                    case 0x7C:  // PrintScreen(typematic)
+                        // ignore
+                        state = INIT;
+                        break;
+                    case 0xF0:  // E0 break
+                        state = E0_F0;
+                        break;
+                    default:    // E0 make
+                        if (code < 0x80) {
+                            _matrix_make(code|0x80);
+                        } else {
+                            debug("ps/2 unknow code: "); debug_hex(code); debug("\n");
+                        }
+                        state = INIT;
+                }
+                break;
+            case BREAK:
+                if (code < 0x80) {
+                    _matrix_break(code);
+                } else {
+                    debug("ps/2 unknow code: "); debug_hex(code); debug("\n");
+                }
+                state = INIT;
+                break;
+            case E0_F0: // E0 break
+                switch (code) {
+                    case 0x7C:
+                        state = E0_F0_7C;
+                        break;
+                    default:
+                        if (code < 0x80) {
+                            _matrix_break(code|0x80);
+                        } else {
+                            debug("ps/2 unknow code: "); debug_hex(code); debug("\n");
+                        }
+                        state = INIT;
+                }
+                break;
+            /* PrintScreen(make) */
+            case E0_12:
+                switch (code) {
+                    case 0xE0:
+                        state = E0_12_E0;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            case E0_12_E0:
+                switch (code) {
+                    case 0x7C:
+                        _matrix_make(_PRINT_SCREEN);
+                        state = INIT;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            /* PrintScreen(break) */
+            case E0_F0_7C:
+                switch (code) {
+                    case 0xE0:
+                        state = E0_F0_7C_E0;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            case E0_F0_7C_E0:
+                switch (code) {
+                    case 0xF0:
+                        state = E0_F0_7C_E0_F0;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            case E0_F0_7C_E0_F0:
+                switch (code) {
+                    case 0x12:
+                        _matrix_break(_PRINT_SCREEN);
+                        state = INIT;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            /* Pause/Break */
+            case E1:
+                switch (code) {
+                    case 0x14:
+                        state = E1_14;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            case E1_14:
+                switch (code) {
+                    case 0x77:
+                        state = E1_14_77;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            case E1_14_77:
+                switch (code) {
+                    case 0xE1:
+                        state = E1_14_77_E1;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            case E1_14_77_E1:
+                switch (code) {
+                    case 0xF0:
+                        state = E1_14_77_E1_F0;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            case E1_14_77_E1_F0:
+                switch (code) {
+                    case 0x14:
+                        state = E1_14_77_E1_F0_14;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            case E1_14_77_E1_F0_14:
+                switch (code) {
+                    case 0xF0:
+                        state = E1_14_77_E1_F0_14_F0;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            case E1_14_77_E1_F0_14_F0:
+                switch (code) {
+                    case 0x77:
+                        _matrix_make(_PAUSE_BREAK);
+                        state = INIT;
+                        break;
+                    default:
+                        state = INIT;
+                }
+                break;
+            default:
+                state = INIT;
+        }
+    }
+
+    static uint8_t prev_leds = 0;
+    if (prev_leds != usb_keyboard_leds) {
+        uint8_t leds = 0;
+        if (usb_keyboard_leds&(1<<USB_LED_SCROLL_LOCK))
+            leds |= (1<<PS2_LED_SCROLL_LOCK);
+        if (usb_keyboard_leds&(1<<USB_LED_NUM_LOCK))
+            leds |= (1<<PS2_LED_NUM_LOCK);
+        if (usb_keyboard_leds&(1<<USB_LED_CAPS_LOCK))
+            leds |= (1<<PS2_LED_CAPS_LOCK);
+
+        _ps2_set_leds(leds);
+        prev_leds = usb_keyboard_leds;
+    }
+
+    return 1;
+}
+
+bool matrix_is_modified(void)
+{
+    return _matrix_is_modified;
+}
+
+inline
+bool matrix_has_ghost(void)
+{
+#ifdef MATRIX_HAS_GHOST
+    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+        if (matrix_has_ghost_in_row(i))
+            return true;
+    }
+#endif
+    return false;
+}
+
+inline
+bool matrix_is_on(uint8_t row, uint8_t col)
+{
+    return (matrix[row] & (1<<col));
+}
+
+inline
+#if (MATRIX_COLS <= 8)
+uint8_t matrix_get_row(uint8_t row)
+#else
+uint16_t matrix_get_row(uint8_t row)
+#endif
+{
+    return matrix[row];
+}
+
+void matrix_print(void)
+{
+#if (MATRIX_COLS <= 8)
+    print("\nr/c 01234567\n");
+#else
+    print("\nr/c 0123456789ABCDEF\n");
+#endif
+    for (uint8_t row = 0; row < matrix_rows(); row++) {
+        phex(row); print(": ");
+#if (MATRIX_COLS <= 8)
+        pbin_reverse(matrix_get_row(row));
+#else
+        pbin_reverse16(matrix_get_row(row));
+#endif
+#ifdef MATRIX_HAS_GHOST
+        if (matrix_has_ghost_in_row(row)) {
+            print(" <ghost");
+        }
+#endif
+        print("\n");
+    }
+}
+
+uint8_t matrix_key_count(void)
+{
+    uint8_t count = 0;
+    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+#if (MATRIX_COLS <= 8)
+        count += bitpop(matrix[i]);
+#else
+        count += bitpop16(matrix[i]);
+#endif
+    }
+    return count;
+}
+
+#ifdef MATRIX_HAS_GHOST
+inline
+static bool matrix_has_ghost_in_row(uint8_t row)
+{
+    // no ghost exists in case less than 2 keys on
+    if (((matrix[row] - 1) & matrix[row]) == 0)
+        return false;
+
+    // ghost exists in case same state as other row
+    for (uint8_t i=0; i < MATRIX_ROWS; i++) {
+        if (i != row && (matrix[i] & matrix[row]) == matrix[row])
+            return true;
+    }
+    return false;
+}
+#endif
+
+
+inline
+static void _matrix_make(uint8_t code)
+{
+    if (!matrix_is_on(_ROW(code), _COL(code))) {
+        matrix[_ROW(code)] |= 1<<_COL(code);
+        _matrix_is_modified = true;
+    }
+}
+
+inline
+static void _matrix_break(uint8_t code)
+{
+    if (matrix_is_on(_ROW(code), _COL(code))) {
+        matrix[_ROW(code)] &= ~(1<<_COL(code));
+        _matrix_is_modified = true;
+    }
+}
+
+static void _ps2_reset(void)
+{
+    ps2_host_send(0xFF);
+    ps2_host_recv(); // 0xFA
+    ps2_host_recv(); // 0xAA
+    _delay_ms(1000);
+}
+
+static void _ps2_set_leds(uint8_t leds)
+{
+        ps2_host_send(0xED);
+        ps2_host_recv();        // 0xFA
+        ps2_host_send(leds);
+        ps2_host_recv();        // 0xFA
+}