Merge remote-tracking branch 'upstream/master'

README.md

@@ -1,12 +1,15 @@
 TMK Keyboard Firmware Collection
 ================================
-This is a keyboard firmware with some useful features for Atmel AVR controller.
+This repository includes keyboard and converter firmware projects built with [`tmk_core`][tmk_core] keyboard library.
 
-Source code is available here: <http://github.com/tmk/tmk_keyboard>
+The latest source code is available here: <http://github.com/tmk/tmk_keyboard>
 
 
 Updates
 -------
+#### 2016/06/22
+Some projects were moved from `converter` and `keyboard` to `orphan` directory. Those might be removed in some future but you will be able to access them with `orphans` tag. See <https://github.com/tmk/tmk_keyboard/issues/173>
+
 #### 2016/02/10
 core: flabbergast's Chibios protocol was merged from <https://github.com/flabbergast/tmk_keyboard/tree/chibios> (@72b1668). See [tmk_core/protocol/chibios/README.md](tmk_core/protocol/chibios/README.md). Chibios protocol supports Cortex-M such as STM32 and Kinetis.
 
@@ -19,28 +22,6 @@ In `Makefile` you need to set `TMK_DIR` to indicate core library location now.
 
 
 
-Features
---------
-These features can be used in your keyboard.
-
-* Multi-layer Keymap  - Multiple keyboard layouts with layer switching
-* Mouse key           - Mouse control with 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            - 120 keys(+ 8 modifiers) simultaneously
-* PS/2 mouse support  - PS/2 mouse(TrackPoint) as composite device
-* Keyboard protocols  - PS/2, ADB, M0110, Sun and other old keyboard protocols
-* User Function       - Customizable function of key with writing code
-* Macro               - Very primitive at this time
-* Keyboard Tricks     - Oneshot modifier and modifier with tapping feature
-* Debug Console       - Messages for debug and interaction with firmware
-* Virtual DIP Switch  - Configurations stored EEPROM(Boot Magic)
-* Locking CapsLock    - Mechanical switch support for CapsLock
-* Breathing Sleep LED - Sleep indicator with charm during USB suspend
-* Backlight           - Control backlight levels
-
-
-
 Projects
 --------
 You can find some keyboard specific projects under `converter` and `keyboard` directory.
@@ -54,32 +35,23 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
 * [x68k_usb](converter/x68k_usb/)           - [Sharp X68000 keyboard to USB][GH_x68k]
 * [sun_usb](converter/sun_usb/)             - [Sun] to USB(type4, 5 and 3?)
 * [pc98_usb](converter/pc98_usb/)           - [PC98] to USB
-* [usb_usb](converter/usb_usb/)             - USB to USB(experimental)
-* [ascii_usb](converter/ascii_usb/)         - ASCII(Serial console terminal) to USB
-* [ibm4704_usb](converter/ibm4704_usb)      - [IBM 4704 keyboard Converter][GH_ibm4704]
+* [usb_usb](converter/usb_usb/)             - [USB to USB][GH_usb]
+* [ibm4704_usb](converter/ibm4704_usb)      - [IBM 4704 keyboard to USB][GH_ibm4704]
+* [next_usb](converter/next_usb)            - NeXT(Non-ADB) to USB, contributed by [BCG](https://github.com/bgould) and based on [Adafruit's work](https://learn.adafruit.com/usb-next-keyboard-with-arduino-micro/overview)
 
 ### keyboard
 * [hhkb](keyboard/hhkb/)                    - [Happy Hacking Keyboard pro][GH_hhkb] **my main board**
-* [gh60](keyboard/gh60/)                    - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
+* [alps64](keyboard/alps64/)                - [Alps64 PCB](https://geekhack.org/index.php?topic=69740.0)
 * [hbkb](keyboard/hbkb/)                    - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
-* [hid_liber](keyboard/hid_liber/)          - [HID liberation][HID_liber] controller (by alaricljs)
-* [phantom](keyboard/phantom/)              - [Phantom] keyboard (by Tranquilite)
-* [IIgs_Standard](keyboard/IIgs/)           - Apple [IIGS] keyboard mod(by JeffreySung)
-* [macway](keyboard/macway/)                - [Compact keyboard mod][GH_macway] [retired]
-* [KMAC](keyboard/kmac/)                    - Korean custom keyboard
-* [Lightsaber](keyboard/lightsaber/)        - Korean custom keyboard
 * [Infinity](keyboard/infinity/)            - Massdrop [Infinity keyboard][Infinity]
-* [NerD](keyboard/nerd/)                    - Korean custom keyboard
-* [KittenPaw](keyboard/kitten_paw)          - Custom Majestouch controller
-* [Lightpad](keyboard/lightpad)             - Korean custom keypad
-* [ghost_squid](keyboard/ghost_squid/)      - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt]
-
-### External projects using tmk_keyboard
-* [ErgoDox_cub-uanic][cub-uanic]            - Split Ergonomic Keyboard [ErgoDox][ergodox_org]
-* [mcdox][mcdox_tmk]                        - [mcdox][mcdox]
+* [gh60](keyboard/gh60/)                    - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
+* [onekey](keyboard/onekey/)                - Simple one key keyboard example
+
+
+### Projects based tmk_keyboard or tmk_core
+https://github.com/tmk/tmk_keyboard/wiki/TMK-Based-Projects
 
 
-[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
@@ -90,20 +62,12 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
 [GH_x68k]:      http://geekhack.org/showwiki.php?title=Island:29060
 [GH_hbkb]:      http://geekhack.org/showwiki.php?title=Island:29483
 [GH_ibm4704]:   http://geekhack.org/index.php?topic=54706.0
-[HID_liber]:    http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
-[Phantom]:      http://geekhack.org/index.php?topic=26742
 [GH60]:         http://geekhack.org/index.php?topic=34959
 [GH60_proto]:   http://geekhack.org/index.php?topic=37570.0
 [PC98]:         http://en.wikipedia.org/wiki/NEC_PC-9801
 [Sun]:          http://en.wikipedia.org/wiki/Sun-3
-[IIGS]:         http://en.wikipedia.org/wiki/Apple_IIGS
 [Infinity]:     https://www.massdrop.com/buy/infinity-keyboard-kit
-[ghost_squid]:  http://deskthority.net/wiki/Costar_replacement_controllers#The_Ghost_Squid
-[cmxt]:         http://gaming.coolermaster.com/en/products/keyboards/quickfirext/
-[ergodox_org]:  http://ergodox.org/
-[cub-uanic]:    https://github.com/cub-uanic/tmk_keyboard/tree/master/keyboard/ergodox
-[mcdox]:        https://github.com/DavidMcEwan/mcdox
-[mcdox_tmk]:    https://github.com/DavidMcEwan/tmk_keyboard/tree/master/keyboard/mcdox
+[tmk_core]:     https://github.com/tmk/tmk_core
 
 
 
@@ -131,7 +95,7 @@ Magic Commands
 --------------
 To see help press `Magic` + `H`.
 
-`Magic` key combination is `LShift` + `RShift` in many project, but `Power` key on ADB converter. 
+`Magic` key combination is `LShift` + `RShift` in many projects, but `Power` key on ADB converter.
 `Magic` keybind can be vary on each project, check `config.h` in project directory.
 
 Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
@@ -202,11 +166,11 @@ To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be
 
 Mechanical Locking support
 --------------------------
-This feature makes it possible for you to use mechanical locking switch for `CapsLock`, `NumLock` 
+This feature makes it possible for you to use mechanical locking switch for `CapsLock`, `NumLock`
 or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LN
 UM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Res
 ync option tries to keep switch state consistent with keyboard LED state.
- 
+
     #define LOCKING_SUPPORT_ENABLE
     #define LOCKING_RESYNC_ENABLE
 
@@ -214,15 +178,21 @@ ync option tries to keep switch state consistent with keyboard LED state.
 
 Start Your Own Project
 -----------------------
-**TBD**
+1. Add `tmk_core` into your repository using `git submodule` or `git subtree`.
+2. Copy files from `tmk_keybaord` or other project similar to yours
+3. Edit those files to support your keyboard.
+
+See these as examples.
+- https://github.com/tmk/infinity_ergodox
+- https://github.com/tmk/whitefox
 
 
 
 Debugging
 --------
-Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
+Use PJRC's `hid_listen` to see debug messages. You can use xprintf() to display debug info, see `tmk_core/common/xprintf.h`.
 
-You can use xprintf() to display debug info on `hid_listen`, see `tmk_core/common/xprintf.h`.
+- https://www.pjrc.com/teensy/hid_listen.html
 
 
 
@@ -236,6 +206,13 @@ Files and Directories
 
 
 
+Contribution
+------------
+- Report bugs in github **[Issues](https://github.com/tmk/tmk_keyboard/issues)**.
+- Pull requets are also welcomed.
+
+
+
 Coding Style
 -------------
 - Doesn't use Tab to indent, use 4-spaces instead.

converter/usb_usb/Makefile

@@ -110,7 +110,7 @@ OPT_DEFS += -DBOOTLOADER_SIZE=4096
 
 SRC =  \
        keymap_common.c \
-       matrix.c \
+       usb_usb.cpp \
        main.cpp
 
 ifdef KEYMAP

converter/usb_usb/main.cpp

@@ -3,17 +3,9 @@
 #include <avr/power.h>
 #include <util/delay.h>
 
-// USB HID host
-#include "Usb.h"
-#include "usbhub.h"
-#include "hid.h"
-#include "hidboot.h"
-#include "parser.h"
-
 // LUFA
 #include "lufa.h"
 
-#include "timer.h"
 #include "sendchar.h"
 #include "debug.h"
 #include "keyboard.h"
@@ -64,22 +56,6 @@ static void LUFA_setup(void)
 
 
 
-/*
- * USB Host Shield HID keyboard
- */
-USB usb_host;
-USBHub hub1(&usb_host);
-HIDBoot<HID_PROTOCOL_KEYBOARD>    kbd(&usb_host);
-KBDReportParser kbd_parser;
-
-
-void led_set(uint8_t usb_led)
-{
-    kbd.SetReport(0, 0, 2, 0, 1, &usb_led);
-}
-
-
-
 int main(void)
 {
     // LED for debug
@@ -94,10 +70,6 @@ int main(void)
 
     LUFA_setup();
 
-    // USB Host Shield setup
-    usb_host.Init();
-    kbd.SetReportParser(0, (HIDReportParser*)&kbd_parser);
-
     /* NOTE: Don't insert time consuming job here.
      * It'll cause unclear initialization failure when DFU reset(worm start).
      */
@@ -111,17 +83,9 @@ int main(void)
 
     debug("init: done\n");
 
-uint16_t timer;
     for (;;) {
         keyboard_task();
 
-timer = timer_read();
-        usb_host.Task();
-timer = timer_elapsed(timer);
-if (timer > 100) {
-    debug("host.Task: "); debug_hex16(timer);  debug("\n");
-}
-
 #if !defined(INTERRUPT_CONTROL_ENDPOINT)
         // LUFA Task for control request
         USB_USBTask();

converter/usb_usb/matrix.c

@@ -1,133 +0,0 @@
-/*
-Copyright 2011 Jun Wako <wakojun@gmail.com>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-#include <stdint.h>
-#include <stdbool.h>
-#include "usb_hid.h"
-#include "keycode.h"
-#include "util.h"
-#include "print.h"
-#include "debug.h"
-#include "matrix.h"
-
-/* KEY CODE to Matrix
- *
- * HID keycode(1 byte):
- * Higher 5 bits indicates ROW and lower 3 bits COL.
- *
- *  7 6 5 4 3 2 1 0
- * +---------------+
- * |  ROW  |  COL  |
- * +---------------+
- *
- * Matrix space(16 * 16):
- *   r\c0123456789ABCDEF
- *   0 +----------------+
- *   : |                |
- *   : |                |
- *  16 +----------------+
- */
-#define ROW_MASK 0xF0
-#define COL_MASK 0x0F
-#define CODE(row, col)  (((row) << 4) | (col))
-#define ROW(code)       (((code) & ROW_MASK) >> 4)
-#define COL(code)       ((code) & COL_MASK)
-#define ROW_BITS(code)  (1 << COL(code))
-
-
-uint8_t matrix_rows(void) { return MATRIX_ROWS; }
-uint8_t matrix_cols(void) { return MATRIX_COLS; }
-void matrix_init(void) {}
-bool matrix_has_ghost(void) { return false; }
-
-static bool matrix_is_mod =false;
-
-uint8_t matrix_scan(void) {
-    static uint16_t last_time_stamp = 0;
-
-    if (last_time_stamp != usb_hid_time_stamp) {
-        last_time_stamp = usb_hid_time_stamp;
-        matrix_is_mod = true;
-    } else {
-        matrix_is_mod = false;
-    }
-    return 1;
-}
-
-bool matrix_is_modified(void) {
-
-    return matrix_is_mod;
-}
-
-bool matrix_is_on(uint8_t row, uint8_t col) {
-    uint8_t code = CODE(row, col);
-
-    if (IS_MOD(code)) {
-        if (usb_hid_keyboard_report.mods & ROW_BITS(code)) {
-            return true;
-        }
-    }
-    for (uint8_t i = 0; i < KEYBOARD_REPORT_KEYS; i++) {
-        if (usb_hid_keyboard_report.keys[i] == code) {
-            return true;
-        }
-    }
-    return false;
-}
-
-matrix_row_t matrix_get_row(uint8_t row) {
-    uint16_t row_bits = 0;
-
-    if (IS_MOD(CODE(row, 0)) && usb_hid_keyboard_report.mods) {
-        row_bits |= usb_hid_keyboard_report.mods;
-    }
-
-    for (uint8_t i = 0; i < KEYBOARD_REPORT_KEYS; i++) {
-        if (IS_ANY(usb_hid_keyboard_report.keys[i])) {
-            if (row == ROW(usb_hid_keyboard_report.keys[i])) {
-                row_bits |= ROW_BITS(usb_hid_keyboard_report.keys[i]);
-            }
-        }
-    }
-    return row_bits;
-}
-
-uint8_t matrix_key_count(void) {
-    uint8_t count = 0;
-
-    count += bitpop(usb_hid_keyboard_report.mods);
-    for (uint8_t i = 0; i < KEYBOARD_REPORT_KEYS; i++) {
-        if (IS_ANY(usb_hid_keyboard_report.keys[i])) {
-            count++;
-        }
-    }
-    return count;
-}
-
-void matrix_print(void) {
-    print("\nr/c 01234567\n");
-    for (uint8_t row = 0; row < matrix_rows(); row++) {
-        phex(row); print(": ");
-        pbin_reverse(matrix_get_row(row));
-#ifdef MATRIX_HAS_GHOST
-        if (matrix_has_ghost_in_row(row)) {
-            print(" <ghost");
-        }
-#endif
-        print("\n");
-    }
-}

converter/usb_usb/usb_usb.cpp

@@ -0,0 +1,221 @@
+/*
+Copyright 2016 Jun Wako <wakojun@gmail.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include <stdint.h>
+#include <stdbool.h>
+
+// USB HID host
+#include "Usb.h"
+#include "usbhub.h"
+#include "hid.h"
+#include "hidboot.h"
+#include "parser.h"
+
+#include "keycode.h"
+#include "util.h"
+#include "print.h"
+#include "debug.h"
+#include "timer.h"
+#include "matrix.h"
+#include "led.h"
+
+
+/* KEY CODE to Matrix
+ *
+ * HID keycode(1 byte):
+ * Higher 5 bits indicates ROW and lower 3 bits COL.
+ *
+ *  7 6 5 4 3 2 1 0
+ * +---------------+
+ * |  ROW  |  COL  |
+ * +---------------+
+ *
+ * Matrix space(16 * 16):
+ *   r\c0123456789ABCDEF
+ *   0 +----------------+
+ *   : |                |
+ *   : |                |
+ *  16 +----------------+
+ */
+#define ROW_MASK 0xF0
+#define COL_MASK 0x0F
+#define CODE(row, col)  (((row) << 4) | (col))
+#define ROW(code)       (((code) & ROW_MASK) >> 4)
+#define COL(code)       ((code) & COL_MASK)
+#define ROW_BITS(code)  (1 << COL(code))
+
+
+// Integrated key state of all keyboards
+static report_keyboard_t keyboard_report;
+
+static bool matrix_is_mod =false;
+
+/*
+ * USB Host Shield HID keyboards
+ * This supports two cascaded hubs and four keyboards
+ */
+USB usb_host;
+USBHub hub1(&usb_host);
+USBHub hub2(&usb_host);
+HIDBoot<HID_PROTOCOL_KEYBOARD>    kbd1(&usb_host);
+HIDBoot<HID_PROTOCOL_KEYBOARD>    kbd2(&usb_host);
+HIDBoot<HID_PROTOCOL_KEYBOARD>    kbd3(&usb_host);
+HIDBoot<HID_PROTOCOL_KEYBOARD>    kbd4(&usb_host);
+KBDReportParser kbd_parser1;
+KBDReportParser kbd_parser2;
+KBDReportParser kbd_parser3;
+KBDReportParser kbd_parser4;
+
+
+uint8_t matrix_rows(void) { return MATRIX_ROWS; }
+uint8_t matrix_cols(void) { return MATRIX_COLS; }
+bool matrix_has_ghost(void) { return false; }
+void matrix_init(void) {
+    // USB Host Shield setup
+    usb_host.Init();
+    kbd1.SetReportParser(0, (HIDReportParser*)&kbd_parser1);
+    kbd2.SetReportParser(0, (HIDReportParser*)&kbd_parser2);
+    kbd3.SetReportParser(0, (HIDReportParser*)&kbd_parser3);
+    kbd4.SetReportParser(0, (HIDReportParser*)&kbd_parser4);
+}
+
+static void or_report(report_keyboard_t report) {
+    // integrate reports into keyboard_report
+    keyboard_report.mods |= report.mods;
+    for (uint8_t i = 0; i < KEYBOARD_REPORT_KEYS; i++) {
+        if (IS_ANY(report.keys[i])) {
+            for (uint8_t j = 0; j < KEYBOARD_REPORT_KEYS; j++) {
+                if (! keyboard_report.keys[j]) {
+                    keyboard_report.keys[j] = report.keys[i];
+                    break;
+                }
+            }
+        }
+    }
+}
+
+uint8_t matrix_scan(void) {
+    static uint16_t last_time_stamp1 = 0;
+    static uint16_t last_time_stamp2 = 0;
+    static uint16_t last_time_stamp3 = 0;
+    static uint16_t last_time_stamp4 = 0;
+
+    // check report came from keyboards
+    if (kbd_parser1.time_stamp != last_time_stamp1 ||
+        kbd_parser2.time_stamp != last_time_stamp2 ||
+        kbd_parser3.time_stamp != last_time_stamp3 ||
+        kbd_parser4.time_stamp != last_time_stamp4) {
+
+        last_time_stamp1 = kbd_parser1.time_stamp;
+        last_time_stamp2 = kbd_parser2.time_stamp;
+        last_time_stamp3 = kbd_parser3.time_stamp;
+        last_time_stamp4 = kbd_parser4.time_stamp;
+
+        // clear and integrate all reports
+        keyboard_report = {};
+        or_report(kbd_parser1.report);
+        or_report(kbd_parser2.report);
+        or_report(kbd_parser3.report);
+        or_report(kbd_parser4.report);
+
+        matrix_is_mod = true;
+
+        dprintf("state:  %02X %02X", keyboard_report.mods, keyboard_report.reserved);
+        for (uint8_t i = 0; i < KEYBOARD_REPORT_KEYS; i++) {
+            dprintf(" %02X", keyboard_report.keys[i]);
+        }
+        dprint("\r\n");
+    } else {
+        matrix_is_mod = false;
+    }
+
+    uint16_t timer;
+    timer = timer_read();
+    usb_host.Task();
+    timer = timer_elapsed(timer);
+    if (timer > 100) {
+        dprintf("host.Task: %d\n", timer);
+    }
+
+    return 1;
+}
+
+bool matrix_is_modified(void) {
+    return matrix_is_mod;
+}
+
+bool matrix_is_on(uint8_t row, uint8_t col) {
+    uint8_t code = CODE(row, col);
+
+    if (IS_MOD(code)) {
+        if (keyboard_report.mods & ROW_BITS(code)) {
+            return true;
+        }
+    }
+    for (uint8_t i = 0; i < KEYBOARD_REPORT_KEYS; i++) {
+        if (keyboard_report.keys[i] == code) {
+            return true;
+        }
+    }
+    return false;
+}
+
+matrix_row_t matrix_get_row(uint8_t row) {
+    uint16_t row_bits = 0;
+
+    if (IS_MOD(CODE(row, 0)) && keyboard_report.mods) {
+        row_bits |= keyboard_report.mods;
+    }
+
+    for (uint8_t i = 0; i < KEYBOARD_REPORT_KEYS; i++) {
+        if (IS_ANY(keyboard_report.keys[i])) {
+            if (row == ROW(keyboard_report.keys[i])) {
+                row_bits |= ROW_BITS(keyboard_report.keys[i]);
+            }
+        }
+    }
+    return row_bits;
+}
+
+uint8_t matrix_key_count(void) {
+    uint8_t count = 0;
+
+    count += bitpop(keyboard_report.mods);
+    for (uint8_t i = 0; i < KEYBOARD_REPORT_KEYS; i++) {
+        if (IS_ANY(keyboard_report.keys[i])) {
+            count++;
+        }
+    }
+    return count;
+}
+
+void matrix_print(void) {
+    print("\nr/c 0123456789ABCDEF\n");
+    for (uint8_t row = 0; row < matrix_rows(); row++) {
+        xprintf("%02d: ", row);
+        print_bin_reverse16(matrix_get_row(row));
+        print("\n");
+    }
+}
+
+void led_set(uint8_t usb_led)
+{
+    kbd1.SetReport(0, 0, 2, 0, 1, &usb_led);
+    kbd2.SetReport(0, 0, 2, 0, 1, &usb_led);
+    kbd3.SetReport(0, 0, 2, 0, 1, &usb_led);
+    kbd4.SetReport(0, 0, 2, 0, 1, &usb_led);
+}

orphan/README.md

@@ -0,0 +1,30 @@
+Orphan Projects
+===============
+These projects won't be updated by tmk anymore and might be removed sometime in the future.
+https://github.com/tmk/tmk_keyboard/issues/173
+
+Also see this wiki page to find original repositories/authors and alternative projects.
+https://github.com/tmk/tmk_keyboard/wiki/TMK-Based-Projects
+
+
+* [ascii_usb](ascii_usb/)        - ASCII(Serial console terminal) to USB
+* [hid_liber](hid_liber/)        - [HID liberation][HID_liber] controller (by alaricljs)
+* [phantom](phantom/)            - [Phantom] keyboard (by Tranquilite)
+* [IIgs](IIgs/)                  - Apple [IIGS] keyboard mod(by JeffreySung)
+* [macway](macway/)              - [Compact keyboard mod][GH_macway] [retired]
+* [kmac](kmac/)                  - Korean custom keyboard
+* [lightsaber](lightsaber/)      - Korean custom keyboard
+* [nerd](nerd/)                  - Korean custom keyboard
+* [lightpad](lightpad)           - Korean custom keypad
+* [kitten_paw](kitten_paw)       - Custom Majestouch controller
+* [ghost_squid](ghost_squid/)    - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt]
+* [terminal_bluefruit](terminal_bluefruit)   - [Model M to Bluetooth with Bluefruit EZ-Key HID][Ada]
+* [serialmouse_usb](serialmouse_usb) - <https://github.com/tmk/tmk_keyboard/pull/131>
+
+[GH_macway]:    http://geekhack.org/showwiki.php?title=Island:11930
+[HID_liber]:    http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
+[Phantom]:      http://geekhack.org/index.php?topic=26742
+[IIGS]:         http://en.wikipedia.org/wiki/Apple_IIGS
+[ghost_squid]:  http://deskthority.net/wiki/Costar_replacement_controllers#The_Ghost_Squid
+[cmxt]:         http://gaming.coolermaster.com/en/products/keyboards/quickfirext/
+[M_bluefruit]:  https://learn.adafruit.com/convert-your-model-m-keyboard-to-bluetooth-with-bluefruit-ez-key-hid/overview