Made directories for keyboard and converter projects.

99 files changed, 191 insertions, 165 deletions

diff --git a/README b/README
deleted file mode 100644
index d85f512c71..0000000000
--- a/README
+++ /dev/null
@@ -1,151 +0,0 @@
-t.m.k. Keyboard Firmware
-========================
-This is keyboard firmware for Teensy(AVR USB MCU) and V-USB board.
-
-source code repository:
-http://github.com/tmk/tmk_keyboard
-
-This firmware is used in following projects:
-HHKB mod:   http://geekhack.org/showwiki.php?title=Island:12047
-Macway mod: http://geekhack.org/showwiki.php?title=Island:11930
-PS2 to USB: http://geekhack.org/showwiki.php?title=Island:14618
-ADB to USB: http://geekhack.org/showwiki.php?title=Island:14290
-
-The project is heavily based on PJRC USB Keyboard/Mouse Example and
-owes a debt to preceding keyboard firmware projects.
-http://www.pjrc.com/teensy
-
-
-Features
---------
-Mouse key
-    control mouse cursor from keyboard.
-System Control Key
-    Power Down, Sleep, Wake Up & USB Remote Wake up
-Media Control Key
-    Volume Down/Up, Mute
-USB NKRO
-    send 120 keys(+ 8 modifiers) at most simultaneously.
-PS/2 mouse support
-    integrate PS/2 mouse(TrackPoint) into keyboard as composite device.
-
-
-Limitations
------------
-
-
-Files & Directories
--------------------
-Target:
-hhkb/                           keyboard controller for PFU HHKB pro
-macway/                         keyboard controller for Macway mod
-ps2_usb/                        PS2 to USB keyboard converter
-adb_usb/                        ADB to USB keyboard converter
-
-USB Protocol Stack:
-pjrc/                           PJRC  USB stack
-vusb/                           V-USB USB stack
-ps2.[ch]                        PS/2 protocol
-adb.[ch]                        ADB protocol
-
-
-Build
------
-To compile needs AVR GCC, AVR Libc and GNU make.
-You can use WinAVR on Windows.  http://winavr.sourceforge.net/
-
-$ cd <target>
-$ make
-
-The firmware will be compiled as a file tmk_<target>.hex.
-
-
-Build your own firmware
------------------------
-Copying exsistent target(macway) is easy way.
-1. Copy contens of macway/ to your own target directory.
-2. Edit Makefile. See next section.
-3. Edit config.h. See next section.
-4. Edit matrix.c. You will need to fix followings at least.
-     matrix_init()
-     matrix_scan()
-     read_col()
-     unselect_rows()
-     select_row()
-5. Edit keymap.c. NOTE: It is not final design and a bit messy.
-   You will need to fix followings at least.
-     KEYMAP
-     fn_layer[]
-     fn_keycode[]
-     keymaps[]
-6. Build.
-
-If you have a build error like following, comment out "--relax" option in Makefile.common.
-    (.vectors+0x30): relocation truncated to fit: R_AVR_13_PCREL against symbol `__vector_12'
-
-
-Build Options
--------------
-<target>/Makefile:
-1. Set target name for your firmware.
-     TARGET = tmk_<target>
-2. Choose a MCU and its frequency.
-     MCU = atmega32u4       # Teensy 2.0
-     #MCU = at90usb1286      # Teensy++ 2.0
-     F_CPU = 16000000
-3. Choose optional modules as needed. Comment out to disable optional modules.
-     MOUSEKEY_ENABLE = yes	# Mouse keys
-     PS2_MOUSE_ENABLE = yes	# PS/2 mouse(TrackPoint) support
-     EXTRAKEY_ENABLE = yes	# Enhanced feature for Windows(Audio control and System control)
-     NKRO_ENABLE = yes		# USB Nkey Rollover
-
-<target>/config.h:
-1. USB vendor/product ID and device description
-     #define VENDOR_ID       0xFEED
-     #define PRODUCT_ID      0xBEEF
-     /* device description */
-     #define MANUFACTURER    t.m.k.
-     #define PRODUCT         Macway mod
-     #define DESCRIPTION     t.m.k. keyboard firmware for Macway mod
-2. Keyboard matrix configuration
-     #define MATRIX_ROWS 8
-     #define MATRIX_COLS 8
-     #define MATRIX_HAS_GHOST
-3. Mouse keys configuration if needed.
-4. PS/2 mouse configuration if needed.
-
-
-Debuging & Rescue
------------------
-Use PJRC's hid_listen.exe to see debug messages.
-Press <COMMAND> + H to debug menu. 
-(see config.h for <COMMAND> key combination.)
-
-Pressing any 3 keys when connected enables debug output.
-Pressing any 4 keys when connected makes bootloader comes up.
-
-
-Projects related
-----------------
-PJRC USB Keyboard/Mouse Example
-    http://www.pjrc.com/teensy/usb_keyboard.html
-    http://www.pjrc.com/teensy/usb_mouse.html
-kbupgrade
-    http://github.com/rhomann/kbupgrade
-    http://geekhack.org/showwiki.php?title=Island:8406
-c64key
-    http://symlink.dk/projects/c64key/
-rump
-    http://mg8.org/rump/
-    http://github.com/clee/rump
-dulcimer
-    http://www.schatenseite.de/dulcimer.html
-humblehacker-keyboard
-    http://github.com/humblehacker
-    http://www.humblehacker.com/keyboard/
-    http://geekhack.org/showwiki.php?title=Island:6292
-ps2avr
-    http://sourceforge.net/projects/ps2avr/
-
-
-EOF
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..0361e2ad99
--- /dev/null
+++ b/README.md
@@ -0,0 +1,175 @@
+t.m.k. Keyboard Firmware Collection
+====================================
+This is a keyboard firmware with some features for Atmel AVR controller.
+
+Source code is available here: <http://github.com/tmk/tmk_keyboard>
+
+
+Features
+--------
+* Mouse key - Mouse control by keyboard
+* System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up
+* Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc. 
+* USB NKRO - Can send 120 keys(+ 8 modifiers) simultaneously.
+* PS/2 mouse support - integrate PS/2 mouse(TrackPoint) into keyboard as composite device.
+
+
+Projects
+--------
+### converter
+* ps2_usb - PS/2 keyboard to USB
+* adb_usb - ADB keyboard to USB
+* m0110_usb - Machintosh 128K/512K/Plus keyboard to USB
+* terminal_usb - IBM Model M terminal keyboard(PS/2 scancode set3) to USB
+* sony_usb - Sony NEWS keyboard to USB
+* x68k_usb - Sharp X68000 keyboard to USB
+
+### keyboard
+* hhkb - Happy Hacking Keyboard professional
+* macway - Compact keyboard mod
+* hbk - Happy Buckling sprint keyboard(IBM Model M mod)
+
+[GH_macway]:    http://geekhack.org/showwiki.php?title=Island:11930
+[GH_hhkb]:      http://geekhack.org/showwiki.php?title=Island:12047
+[GH_ps2]:       http://geekhack.org/showwiki.php?title=Island:14618
+[GH_adb]:       http://geekhack.org/showwiki.php?title=Island:14290
+[GH_hhkb_bt]:   http://geekhack.org/showwiki.php?title=Island:20851
+[GH_m0110]:     http://geekhack.org/showwiki.php?title=Island:24965
+[GH_sony]:      http://geekhack.org/showwiki.php?title=Island:25759
+[GH_terminal]:  http://geekhack.org/showwiki.php?title=Island:27272
+[GH_x68k]:      http://geekhack.org/showwiki.php?title=Island:29060
+[GH_hbk]:       http://geekhack.org/showwiki.php?title=Island:29483
+
+
+
+Files & Directories
+-------------------
+### Top
+* common/       common codes
+* protocol/     keyboard protocol support
+* keyboard/     keyboard projects
+* converter/    protocol converter projects
+* doc/          documents
+
+### Keyboard Protocols
+* pjrc/         PJRC USB stack
+* vusb/         Objective Development V-USB
+* iwrap/        Bluetooth HID for Bluegiga iWRAP
+* ps2           PS/2 protocol
+* adb           Apple Desktop Bus protocol
+* m0110         Macintosh 128K/512K/Plus keyboard protocol
+* news          Sony NEWS keyboard protocol
+* x68k          Sharp X68000 keyboard protocol
+
+
+Build & Program
+---------------
+### Build firmware
+To compile you need `AVR GCC`, `AVR Libc` and `GNU make`.
+You can use [WinAVR][1] on Windows and [CrossPack][2] on Mac.
+
+    $ cd <project>
+    $ make
+
+The firmware will be compiled as a file tmk_<project>.hex.
+
+[1]:  http://winavr.sourceforge.net/
+[2]: http://www.obdev.at/products/crosspack/index.html
+
+### Program Controller
+If you have proper program command in Makefile just type this.
+
+    $ make program
+
+As for `Teensy` you can use `PJRC's loader` to program hex file. <http://www.pjrc.com/teensy/loader.html>
+
+
+
+Build Options
+-------------
+### `Makefile`
+#### 1. MCU and Frequency.
+    MCU = atmega32u4       # Teensy 2.0
+    #MCU = at90usb1286      # Teensy++ 2.0
+    F_CPU = 16000000
+
+#### 2. Features
+Note that ***comment out*** to disable them.
+    MOUSEKEY_ENABLE = yes	# Mouse keys
+    PS2_MOUSE_ENABLE = yes	# PS/2 mouse(TrackPoint) support
+    EXTRAKEY_ENABLE = yes	# Enhanced feature for Windows(Audio control and System control)
+    NKRO_ENABLE = yes		# USB Nkey Rollover
+
+#### 3. Programmer
+Set proper command for your controller, bootloader and programmer.
+    # for PJRC Teensy
+    PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex
+
+    # for Atmel AT90USBKEY
+    PROGRAM_CMD = dfu-programmer $(MCU) flash $(TARGET).hex
+
+    # avrdude
+    PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
+    PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
+    PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
+
+### `config.h`
+#### 1. USB vendor/product ID and device description
+    #define VENDOR_ID       0xFEED
+    #define PRODUCT_ID      0xBEEF
+    /* device description */
+    #define MANUFACTURER    t.m.k.
+    #define PRODUCT         Macway mod
+    #define DESCRIPTION     t.m.k. keyboard firmware for Macway mod
+
+#### 2. Keyboard matrix configuration
+    #define MATRIX_ROWS 8
+    #define MATRIX_COLS 8
+    #define MATRIX_HAS_GHOST
+
+### 3. Mouse keys configuration
+
+### 4. PS/2 mouse configuration
+
+
+Keymap
+------
+
+
+Build your own firmware
+-----------------------
+
+
+Debuging
+--------
+Use PJRC's `hid_listen` to see debug messages and press `<COMMAND> + H` to debug menu. 
+See `config.h` for definition of `<COMMAND>` key combination.
+
+
+Other Keyboard Projects
+-----------------------
+### PJRC USB Keyboard/Mouse Example
+- <http://www.pjrc.com/teensy/usb_keyboard.html>
+- <http://www.pjrc.com/teensy/usb_mouse.html>
+
+### kbupgrade
+- <http://github.com/rhomann/kbupgrade>
+- <http://geekhack.org/showwiki.php?title=Island:8406>
+
+### c64key
+- <http://symlink.dk/projects/c64key/>
+
+### rump
+- <http://mg8.org/rump/>
+- <http://github.com/clee/rump>
+
+### dulcimer
+- <http://www.schatenseite.de/dulcimer.html>
+
+### humblehacker-keyboard
+- <http://github.com/humblehacker>
+- <http://www.humblehacker.com/keyboard/>
+- <http://geekhack.org/showwiki.php?title=Island:6292>
+
+### ps2avr
+- <http://sourceforge.net/projects/ps2avr/>
diff --git a/adb_usb/Makefile b/converter/adb_usb/Makefile
index 97850b0e86..64a23d09dc 100644
--- a/adb_usb/Makefile
+++ b/converter/adb_usb/Makefile
@@ -2,7 +2,7 @@
 TARGET = adb_usb
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/adb_usb/README b/converter/adb_usb/README
index 5d0e1bc86b..5d0e1bc86b 100644
--- a/adb_usb/README
+++ b/converter/adb_usb/README
diff --git a/adb_usb/config.h b/converter/adb_usb/config.h
index 52d5925a50..52d5925a50 100644
--- a/adb_usb/config.h
+++ b/converter/adb_usb/config.h
diff --git a/adb_usb/keymap.c b/converter/adb_usb/keymap.c
index cdaa935d32..cdaa935d32 100644
--- a/adb_usb/keymap.c
+++ b/converter/adb_usb/keymap.c
diff --git a/adb_usb/led.c b/converter/adb_usb/led.c
index 0e162f379b..0e162f379b 100644
--- a/adb_usb/led.c
+++ b/converter/adb_usb/led.c
diff --git a/adb_usb/matrix.c b/converter/adb_usb/matrix.c
index a2367af56a..a2367af56a 100644
--- a/adb_usb/matrix.c
+++ b/converter/adb_usb/matrix.c
diff --git a/m0110_usb/Makefile b/converter/m0110_usb/Makefile
index e4fa526c55..4a687b9333 100644
--- a/m0110_usb/Makefile
+++ b/converter/m0110_usb/Makefile
@@ -2,7 +2,7 @@
 TARGET = m0110
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/m0110_usb/README.md b/converter/m0110_usb/README.md
index 0ad3631f7c..0ad3631f7c 100644
--- a/m0110_usb/README.md
+++ b/converter/m0110_usb/README.md
diff --git a/m0110_usb/config.h b/converter/m0110_usb/config.h
index 4563d6da54..4563d6da54 100644
--- a/m0110_usb/config.h
+++ b/converter/m0110_usb/config.h
diff --git a/m0110_usb/doc/m0110.jpg b/converter/m0110_usb/doc/m0110.jpg
index ef9a123abc..ef9a123abc 100644
--- a/m0110_usb/doc/m0110.jpg
+++ b/converter/m0110_usb/doc/m0110.jpg
diff --git a/m0110_usb/doc/teensy.jpg b/converter/m0110_usb/doc/teensy.jpg
index 96e93e7e24..96e93e7e24 100644
--- a/m0110_usb/doc/teensy.jpg
+++ b/converter/m0110_usb/doc/teensy.jpg
diff --git a/m0110_usb/keymap.c b/converter/m0110_usb/keymap.c
index b5cdd300bf..b5cdd300bf 100644
--- a/m0110_usb/keymap.c
+++ b/converter/m0110_usb/keymap.c
diff --git a/m0110_usb/led.c b/converter/m0110_usb/led.c
index f76545f0ba..f76545f0ba 100644
--- a/m0110_usb/led.c
+++ b/converter/m0110_usb/led.c
diff --git a/m0110_usb/matrix.c b/converter/m0110_usb/matrix.c
index 1ca6894c44..1ca6894c44 100644
--- a/m0110_usb/matrix.c
+++ b/converter/m0110_usb/matrix.c
diff --git a/ps2_usb/Makefile b/converter/ps2_usb/Makefile
index 515e6899fe..0bba191a38 100644
--- a/ps2_usb/Makefile
+++ b/converter/ps2_usb/Makefile
@@ -7,7 +7,7 @@
 TARGET = ps2_usb_pjrc
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/ps2_usb/Makefile.pjrc_usart b/converter/ps2_usb/Makefile.pjrc_usart
index 2e570e7107..3dad7e2f8c 100644
--- a/ps2_usb/Makefile.pjrc_usart
+++ b/converter/ps2_usb/Makefile.pjrc_usart
@@ -7,7 +7,7 @@
 TARGET = ps2_usb_pjrc_usart
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/ps2_usb/Makefile.vusb b/converter/ps2_usb/Makefile.vusb
index d85f1d55d5..4d5240c309 100644
--- a/ps2_usb/Makefile.vusb
+++ b/converter/ps2_usb/Makefile.vusb
@@ -7,7 +7,7 @@
 TARGET = ps2_usb_vusb
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/ps2_usb/README b/converter/ps2_usb/README
index c10393e5e7..c10393e5e7 100644
--- a/ps2_usb/README
+++ b/converter/ps2_usb/README
diff --git a/ps2_usb/README.vusb b/converter/ps2_usb/README.vusb
index c92871bcdd..c92871bcdd 100644
--- a/ps2_usb/README.vusb
+++ b/converter/ps2_usb/README.vusb
diff --git a/ps2_usb/config_pjrc.h b/converter/ps2_usb/config_pjrc.h
index 883ffab275..883ffab275 100644
--- a/ps2_usb/config_pjrc.h
+++ b/converter/ps2_usb/config_pjrc.h
diff --git a/ps2_usb/config_pjrc_usart.h b/converter/ps2_usb/config_pjrc_usart.h
index 83ddbf7703..83ddbf7703 100644
--- a/ps2_usb/config_pjrc_usart.h
+++ b/converter/ps2_usb/config_pjrc_usart.h
diff --git a/ps2_usb/config_vusb.h b/converter/ps2_usb/config_vusb.h
index afd2f7911f..afd2f7911f 100644
--- a/ps2_usb/config_vusb.h
+++ b/converter/ps2_usb/config_vusb.h
diff --git a/ps2_usb/keymap.c b/converter/ps2_usb/keymap.c
index f1e34a929a..f1e34a929a 100644
--- a/ps2_usb/keymap.c
+++ b/converter/ps2_usb/keymap.c
diff --git a/ps2_usb/led.c b/converter/ps2_usb/led.c
index e448e84ec7..e448e84ec7 100644
--- a/ps2_usb/led.c
+++ b/converter/ps2_usb/led.c
diff --git a/ps2_usb/matrix.c b/converter/ps2_usb/matrix.c
index 4187ea0601..4187ea0601 100644
--- a/ps2_usb/matrix.c
+++ b/converter/ps2_usb/matrix.c
diff --git a/ps2_usb/usbconfig.h b/converter/ps2_usb/usbconfig.h
index 9038f1eb8c..9038f1eb8c 100644
--- a/ps2_usb/usbconfig.h
+++ b/converter/ps2_usb/usbconfig.h
diff --git a/sony_usb/Makefile.pjrc b/converter/sony_usb/Makefile.pjrc
index b7e22dface..376133ad5e 100644
--- a/sony_usb/Makefile.pjrc
+++ b/converter/sony_usb/Makefile.pjrc
@@ -7,7 +7,7 @@
 TARGET = news_usb_pjrc
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/sony_usb/config_pjrc.h b/converter/sony_usb/config_pjrc.h
index e9cf7dedb6..e9cf7dedb6 100644
--- a/sony_usb/config_pjrc.h
+++ b/converter/sony_usb/config_pjrc.h
diff --git a/sony_usb/keymap.c b/converter/sony_usb/keymap.c
index 4bd556ba09..4bd556ba09 100644
--- a/sony_usb/keymap.c
+++ b/converter/sony_usb/keymap.c
diff --git a/sony_usb/led.c b/converter/sony_usb/led.c
index 51e601318a..51e601318a 100644
--- a/sony_usb/led.c
+++ b/converter/sony_usb/led.c
diff --git a/sony_usb/matrix.c b/converter/sony_usb/matrix.c
index bf363e7d9b..bf363e7d9b 100644
--- a/sony_usb/matrix.c
+++ b/converter/sony_usb/matrix.c
diff --git a/sony_usb/news.c b/converter/sony_usb/news.c
index d18b996f49..d18b996f49 100644
--- a/sony_usb/news.c
+++ b/converter/sony_usb/news.c
diff --git a/sony_usb/news.h b/converter/sony_usb/news.h
index 35e09c4d20..35e09c4d20 100644
--- a/sony_usb/news.h
+++ b/converter/sony_usb/news.h
diff --git a/terminal_usb/Makefile.102_pjrc b/converter/terminal_usb/Makefile.102_pjrc
index a02877acfe..e9d14e7a05 100644
--- a/terminal_usb/Makefile.102_pjrc
+++ b/converter/terminal_usb/Makefile.102_pjrc
@@ -7,7 +7,7 @@
 TARGET = terminal_usb_102_pjrc
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/terminal_usb/Makefile.122_pjrc b/converter/terminal_usb/Makefile.122_pjrc
index 1f21d4e6ca..bec00510e5 100644
--- a/terminal_usb/Makefile.122_pjrc
+++ b/converter/terminal_usb/Makefile.122_pjrc
@@ -7,7 +7,7 @@
 TARGET = terminal_usb_122_pjrc
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/terminal_usb/README b/converter/terminal_usb/README
index 1ce49f33dc..1ce49f33dc 100644
--- a/terminal_usb/README
+++ b/converter/terminal_usb/README
diff --git a/terminal_usb/config_102_pjrc.h b/converter/terminal_usb/config_102_pjrc.h
index 2dce04af7d..2dce04af7d 100644
--- a/terminal_usb/config_102_pjrc.h
+++ b/converter/terminal_usb/config_102_pjrc.h
diff --git a/terminal_usb/config_122_pjrc.h b/converter/terminal_usb/config_122_pjrc.h
index 43691bd71c..43691bd71c 100644
--- a/terminal_usb/config_122_pjrc.h
+++ b/converter/terminal_usb/config_122_pjrc.h
diff --git a/terminal_usb/keymap_102.c b/converter/terminal_usb/keymap_102.c
index 430570c47b..430570c47b 100644
--- a/terminal_usb/keymap_102.c
+++ b/converter/terminal_usb/keymap_102.c
diff --git a/terminal_usb/keymap_122.c b/converter/terminal_usb/keymap_122.c
index 7a2168122f..7a2168122f 100644
--- a/terminal_usb/keymap_122.c
+++ b/converter/terminal_usb/keymap_122.c
diff --git a/terminal_usb/led.c b/converter/terminal_usb/led.c
index e448e84ec7..e448e84ec7 100644
--- a/terminal_usb/led.c
+++ b/converter/terminal_usb/led.c
diff --git a/terminal_usb/matrix.c b/converter/terminal_usb/matrix.c
index a6eff8c1ec..a6eff8c1ec 100644
--- a/terminal_usb/matrix.c
+++ b/converter/terminal_usb/matrix.c
diff --git a/x68k_usb/Makefile b/converter/x68k_usb/Makefile
index 0127c0bf84..c3b5fa29f3 100644
--- a/x68k_usb/Makefile
+++ b/converter/x68k_usb/Makefile
@@ -7,7 +7,7 @@
 TARGET = x68k_usb_pjrc
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/x68k_usb/README b/converter/x68k_usb/README
index 0b61b2c4b3..0b61b2c4b3 100644
--- a/x68k_usb/README
+++ b/converter/x68k_usb/README
diff --git a/x68k_usb/config_pjrc.h b/converter/x68k_usb/config_pjrc.h
index 20758bf249..20758bf249 100644
--- a/x68k_usb/config_pjrc.h
+++ b/converter/x68k_usb/config_pjrc.h
diff --git a/x68k_usb/keymap.c b/converter/x68k_usb/keymap.c
index 94c2aeee11..94c2aeee11 100644
--- a/x68k_usb/keymap.c
+++ b/converter/x68k_usb/keymap.c
diff --git a/x68k_usb/led.c b/converter/x68k_usb/led.c
index 40156cf4ac..40156cf4ac 100644
--- a/x68k_usb/led.c
+++ b/converter/x68k_usb/led.c
diff --git a/x68k_usb/matrix.c b/converter/x68k_usb/matrix.c
index 954e7ef129..954e7ef129 100644
--- a/x68k_usb/matrix.c
+++ b/converter/x68k_usb/matrix.c
diff --git a/x68k_usb/x68k.c b/converter/x68k_usb/x68k.c
index d17af51cc2..d17af51cc2 100644
--- a/x68k_usb/x68k.c
+++ b/converter/x68k_usb/x68k.c
diff --git a/x68k_usb/x68k.h b/converter/x68k_usb/x68k.h
index 2cfda63a7a..2cfda63a7a 100644
--- a/x68k_usb/x68k.h
+++ b/converter/x68k_usb/x68k.h
diff --git a/hbk/Makefile b/keyboard/hbk/Makefile
index c441e2d7ae..26be322e01 100644
--- a/hbk/Makefile
+++ b/keyboard/hbk/Makefile
@@ -2,7 +2,7 @@
 TARGET = hbk
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/hbk/config.h b/keyboard/hbk/config.h
index 5262399dc3..5262399dc3 100644
--- a/hbk/config.h
+++ b/keyboard/hbk/config.h
diff --git a/hbk/controller_teensy.h b/keyboard/hbk/controller_teensy.h
index 1b16113654..1b16113654 100644
--- a/hbk/controller_teensy.h
+++ b/keyboard/hbk/controller_teensy.h
diff --git a/hbk/keymap.c b/keyboard/hbk/keymap.c
index 1de317c9a3..1de317c9a3 100644
--- a/hbk/keymap.c
+++ b/keyboard/hbk/keymap.c
diff --git a/hbk/led.c b/keyboard/hbk/led.c
index fc0eeb0ff7..fc0eeb0ff7 100644
--- a/hbk/led.c
+++ b/keyboard/hbk/led.c
diff --git a/hbk/matrix.c b/keyboard/hbk/matrix.c
index d7c0663642..d7c0663642 100644
--- a/hbk/matrix.c
+++ b/keyboard/hbk/matrix.c
diff --git a/hhkb/Makefile.iwrap b/keyboard/hhkb/Makefile.iwrap
index d922b0f501..ef7ad2eac2 100644
--- a/hhkb/Makefile.iwrap
+++ b/keyboard/hhkb/Makefile.iwrap
@@ -7,7 +7,7 @@
 TARGET = hhkb_iwrap
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/hhkb/Makefile.pjrc b/keyboard/hhkb/Makefile.pjrc
index 28b6b589dd..f6d133eae4 100644
--- a/hhkb/Makefile.pjrc
+++ b/keyboard/hhkb/Makefile.pjrc
@@ -7,7 +7,7 @@
 TARGET = hhkb_pjrc
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/hhkb/Makefile.vusb b/keyboard/hhkb/Makefile.vusb
index 734b73a029..6dd6288077 100644
--- a/hhkb/Makefile.vusb
+++ b/keyboard/hhkb/Makefile.vusb
@@ -7,7 +7,7 @@
 TARGET = hhkb_vusb
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/hhkb/README b/keyboard/hhkb/README
index 65f7dcab5a..65f7dcab5a 100644
--- a/hhkb/README
+++ b/keyboard/hhkb/README
diff --git a/hhkb/config_iwrap.h b/keyboard/hhkb/config_iwrap.h
index 80ab64398b..80ab64398b 100644
--- a/hhkb/config_iwrap.h
+++ b/keyboard/hhkb/config_iwrap.h
diff --git a/hhkb/config_pjrc.h b/keyboard/hhkb/config_pjrc.h
index fffe3522c7..fffe3522c7 100644
--- a/hhkb/config_pjrc.h
+++ b/keyboard/hhkb/config_pjrc.h
diff --git a/hhkb/config_vusb.h b/keyboard/hhkb/config_vusb.h
index 268644849e..268644849e 100644
--- a/hhkb/config_vusb.h
+++ b/keyboard/hhkb/config_vusb.h
diff --git a/hhkb/doc/Bluetooth.txt b/keyboard/hhkb/doc/Bluetooth.txt
index b27f197006..b27f197006 100644
--- a/hhkb/doc/Bluetooth.txt
+++ b/keyboard/hhkb/doc/Bluetooth.txt
diff --git a/hhkb/doc/Bluetooth_img/.picasa.ini b/keyboard/hhkb/doc/Bluetooth_img/.picasa.ini
index f6a4f60674..f6a4f60674 100755
--- a/hhkb/doc/Bluetooth_img/.picasa.ini
+++ b/keyboard/hhkb/doc/Bluetooth_img/.picasa.ini
diff --git a/hhkb/doc/Bluetooth_img/BT_circuit.jpg b/keyboard/hhkb/doc/Bluetooth_img/BT_circuit.jpg
index 2e5a25e81e..2e5a25e81e 100644
--- a/hhkb/doc/Bluetooth_img/BT_circuit.jpg
+++ b/keyboard/hhkb/doc/Bluetooth_img/BT_circuit.jpg
diff --git a/hhkb/doc/HHKB.txt b/keyboard/hhkb/doc/HHKB.txt
index ace931de38..ace931de38 100644
--- a/hhkb/doc/HHKB.txt
+++ b/keyboard/hhkb/doc/HHKB.txt
diff --git a/hhkb/doc/HHKB_img/HHKB_TP1684.jpg b/keyboard/hhkb/doc/HHKB_img/HHKB_TP1684.jpg
index 0a03164094..0a03164094 100644
--- a/hhkb/doc/HHKB_img/HHKB_TP1684.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/HHKB_TP1684.jpg
diff --git a/hhkb/doc/HHKB_img/HHKB_chart1.jpg b/keyboard/hhkb/doc/HHKB_img/HHKB_chart1.jpg
index 1f09bd185c..1f09bd185c 100644
--- a/hhkb/doc/HHKB_img/HHKB_chart1.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/HHKB_chart1.jpg
diff --git a/hhkb/doc/HHKB_img/HHKB_chart2.jpg b/keyboard/hhkb/doc/HHKB_img/HHKB_chart2.jpg
index 45f5ada905..45f5ada905 100644
--- a/hhkb/doc/HHKB_img/HHKB_chart2.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/HHKB_chart2.jpg
diff --git a/hhkb/doc/HHKB_img/HHKB_connector.jpg b/keyboard/hhkb/doc/HHKB_img/HHKB_connector.jpg
index e8a09e9b28..e8a09e9b28 100644
--- a/hhkb/doc/HHKB_img/HHKB_connector.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/HHKB_connector.jpg
diff --git a/hhkb/doc/HHKB_img/HHKB_controller.jpg b/keyboard/hhkb/doc/HHKB_img/HHKB_controller.jpg
index e3dae8e86c..e3dae8e86c 100644
--- a/hhkb/doc/HHKB_img/HHKB_controller.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/HHKB_controller.jpg
diff --git a/hhkb/doc/HHKB_img/HHKB_keyswitch.jpg b/keyboard/hhkb/doc/HHKB_img/HHKB_keyswitch.jpg
index 3afc269e7b..3afc269e7b 100644
--- a/hhkb/doc/HHKB_img/HHKB_keyswitch.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/HHKB_keyswitch.jpg
diff --git a/hhkb/doc/HHKB_img/connector_contact.jpg b/keyboard/hhkb/doc/HHKB_img/connector_contact.jpg
index 5304bc8d7e..5304bc8d7e 100644
--- a/hhkb/doc/HHKB_img/connector_contact.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/connector_contact.jpg
diff --git a/hhkb/doc/HHKB_img/logic_analyzer.jpg b/keyboard/hhkb/doc/HHKB_img/logic_analyzer.jpg
index f1b438ae77..f1b438ae77 100644
--- a/hhkb/doc/HHKB_img/logic_analyzer.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/logic_analyzer.jpg
diff --git a/hhkb/doc/HHKB_img/probe_contact.jpg b/keyboard/hhkb/doc/HHKB_img/probe_contact.jpg
index dc79afa0cc..dc79afa0cc 100644
--- a/hhkb/doc/HHKB_img/probe_contact.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/probe_contact.jpg
diff --git a/hhkb/doc/HHKB_img/teensy_install.jpg b/keyboard/hhkb/doc/HHKB_img/teensy_install.jpg
index 873d988edb..873d988edb 100644
--- a/hhkb/doc/HHKB_img/teensy_install.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/teensy_install.jpg
diff --git a/hhkb/doc/HHKB_img/teensy_wiring.jpg b/keyboard/hhkb/doc/HHKB_img/teensy_wiring.jpg
index 1c4eb67434..1c4eb67434 100644
--- a/hhkb/doc/HHKB_img/teensy_wiring.jpg
+++ b/keyboard/hhkb/doc/HHKB_img/teensy_wiring.jpg
diff --git a/hhkb/keymap.c b/keyboard/hhkb/keymap.c
index 85a7c31b7e..85a7c31b7e 100644
--- a/hhkb/keymap.c
+++ b/keyboard/hhkb/keymap.c
diff --git a/hhkb/led.c b/keyboard/hhkb/led.c
index 669b6107fa..669b6107fa 100644
--- a/hhkb/led.c
+++ b/keyboard/hhkb/led.c
diff --git a/hhkb/matrix.c b/keyboard/hhkb/matrix.c
index 350066b904..350066b904 100644
--- a/hhkb/matrix.c
+++ b/keyboard/hhkb/matrix.c
diff --git a/hhkb/usbconfig.h b/keyboard/hhkb/usbconfig.h
index c3aad34bef..c3aad34bef 100644
--- a/hhkb/usbconfig.h
+++ b/keyboard/hhkb/usbconfig.h
diff --git a/macway/Makefile b/keyboard/macway/Makefile
index 83d31b6747..afee38b120 100644
--- a/macway/Makefile
+++ b/keyboard/macway/Makefile
@@ -2,7 +2,7 @@
 TARGET = macway
 
 # Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
 
 # Directory keyboard dependent files exist
 TARGET_DIR = .
diff --git a/macway/config.h b/keyboard/macway/config.h
index 2e68bf252f..2e68bf252f 100644
--- a/macway/config.h
+++ b/keyboard/macway/config.h
diff --git a/macway/doc/back.jpg b/keyboard/macway/doc/back.jpg
index 0774401f69..0774401f69 100644
--- a/macway/doc/back.jpg
+++ b/keyboard/macway/doc/back.jpg
diff --git a/macway/doc/case.jpg b/keyboard/macway/doc/case.jpg
index c776d5e054..c776d5e054 100644
--- a/macway/doc/case.jpg
+++ b/keyboard/macway/doc/case.jpg
diff --git a/macway/doc/keys.jpg b/keyboard/macway/doc/keys.jpg
index f340ebe8e4..f340ebe8e4 100644
--- a/macway/doc/keys.jpg
+++ b/keyboard/macway/doc/keys.jpg
diff --git a/macway/doc/side.jpg b/keyboard/macway/doc/side.jpg
index bdf8268f25..bdf8268f25 100644
--- a/macway/doc/side.jpg
+++ b/keyboard/macway/doc/side.jpg
diff --git a/macway/doc/switch.jpg b/keyboard/macway/doc/switch.jpg
index a1500d707d..a1500d707d 100644
--- a/macway/doc/switch.jpg
+++ b/keyboard/macway/doc/switch.jpg
diff --git a/macway/doc/teensy.jpg b/keyboard/macway/doc/teensy.jpg
index 07207475d5..07207475d5 100644
--- a/macway/doc/teensy.jpg
+++ b/keyboard/macway/doc/teensy.jpg
diff --git a/macway/doc/wiring.jpg b/keyboard/macway/doc/wiring.jpg
index 0f3490f105..0f3490f105 100644
--- a/macway/doc/wiring.jpg
+++ b/keyboard/macway/doc/wiring.jpg
diff --git a/macway/doc/withHHKB.jpg b/keyboard/macway/doc/withHHKB.jpg
index 9921856e7b..9921856e7b 100644
--- a/macway/doc/withHHKB.jpg
+++ b/keyboard/macway/doc/withHHKB.jpg
diff --git a/macway/doc/withThinkPad.jpg b/keyboard/macway/doc/withThinkPad.jpg
index 231c61d036..231c61d036 100644
--- a/macway/doc/withThinkPad.jpg
+++ b/keyboard/macway/doc/withThinkPad.jpg
diff --git a/macway/keymap.c b/keyboard/macway/keymap.c
index ae9f595fce..ae9f595fce 100644
--- a/macway/keymap.c
+++ b/keyboard/macway/keymap.c
diff --git a/macway/led.c b/keyboard/macway/led.c
index f76545f0ba..f76545f0ba 100644
--- a/macway/led.c
+++ b/keyboard/macway/led.c
diff --git a/macway/matrix.c b/keyboard/macway/matrix.c
index 56fb858960..56fb858960 100644
--- a/macway/matrix.c
+++ b/keyboard/macway/matrix.c
diff --git a/protocol.mk b/protocol.mk
new file mode 100644
index 0000000000..1442c5206b
--- /dev/null
+++ b/protocol.mk
@@ -0,0 +1,2 @@
+# Search Path
+VPATH += $(TOP_DIR)/protocol