README.md

   1 TMK Keyboard Firmware Collection
   2 ================================
   3 This is a keyboard firmware with some useful features for Atmel AVR controller.
   4
   5 Source code is available here: <http://github.com/tmk/tmk_keyboard>
   6
   7
   8 Features
   9 --------
  10 These features can be used in your keyboard.
  11
  12 * Multi-layer Keymap  - Multiple keyboard layouts with layer switching
  13 * Mouse key           - Mouse control with keyboard
  14 * System Control Key  - Power Down, Sleep, Wake Up and USB Remote Wake up
  15 * Media Control Key   - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
  16 * USB NKRO            - 120 keys(+ 8 modifiers) simultaneously
  17 * PS/2 mouse support  - PS/2 mouse(TrackPoint) as composite device
  18 * Keyboard protocols  - PS/2, ADB, M0110, Sun and other old keyboard protocols
  19 * User Function       - Customizable function of key with writing code
  20 * Macro               - Very primitive at this time
  21 * Keyboard Tricks     - Oneshot modifier and modifier with tapping feature
  22 * Debug Console       - Messages for debug and interaction with firmware
  23 * Virtual DIP Switch  - Configurations stored EEPROM(Boot Magic)
  24 * Locking CapsLock    - Mechanical switch support for CapsLock
  25 * Breathing Sleep LED - Sleep indicator with charm during USB suspend
  26 * Backlight           - Control backlight levels
  27
  28
  29 Projects
  30 --------
  31 You can find some keyboard specific projects under `converter` and `keyboard` directory.
  32
  33 ### converter
  34 * [ps2_usb](converter/ps2_usb/)             - [PS/2 keyboard to USB][GH_ps2]
  35 * [adb_usb](converter/adb_usb/)             - [ADB keyboard to USB][GH_adb]
  36 * [m0110_usb](converter/m0110_usb)          - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110]
  37 * [terminal_usb](converter/terminal_usb/)   - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
  38 * [news_usb](converter/news_usb/)           - [Sony NEWS keyboard to USB][GH_news]
  39 * [x68k_usb](converter/x68k_usb/)           - [Sharp X68000 keyboard to USB][GH_x68k]
  40 * [sun_usb](converter/sun_usb/)             - [Sun] to USB(type4, 5 and 3?)
  41 * [pc98_usb](converter/pc98_usb/)           - [PC98] to USB
  42 * [usb_usb](converter/usb_usb/)             - USB to USB(experimental)
  43 * [ascii_usb](converter/ascii_usb/)         - ASCII(Serial console terminal) to USB
  44 * [ibm4704_usb](converter/ibm4704_usb)      - [IBM 4704 keyboard Converter][GH_ibm4704]
  45
  46 ### keyboard
  47 * [hhkb](keyboard/hhkb/)                    - [Happy Hacking Keyboard pro][GH_hhkb] **my main board**
  48 * [gh60](keyboard/gh60/)                    - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
  49 * [hbkb](keyboard/hbkb/)                    - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
  50 * [hid_liber](keyboard/hid_liber/)          - [HID liberation][HID_liber] controller (by alaricljs)
  51 * [phantom](keyboard/phantom/)              - [Phantom] keyboard (by Tranquilite)
  52 * [IIgs_Standard](keyboard/IIgs/)           - Apple [IIGS] keyboard mod(by JeffreySung)
  53 * [macway](keyboard/macway/)                - [Compact keyboard mod][GH_macway] [retired]
  54 * [KMAC](keyboard/kmac/)                    - Korean custom keyboard
  55 * [Lightsaber](keyboard/lightsaber/)        - Korean custom keyboard
  56 * [Infinity](keyboard/infinity/)            - Massdrop [Infinity keyboard][Infinity]
  57 * [NerD](keyboard/nerd/)                    - Korean custom keyboard
  58 * [KittenPaw](keyboard/kitten_paw)          - Custom Majestouch controller
  59 * [Lightpad](keyboard/lightpad)             - Korean custom keypad
  60 * [ghost_squid](keyboard/ghost_squid/)      - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt]
  61 * [planck](keyboard/planck/)                - [Planck] Ortholinear 40% keyboard
  62 * [atomic](keyboard/atomic/)                - [Atomic] Ortholinear 60% keyboard
  63
  64 ### Extenal projects using tmk_keyboard
  65 * [ErgoDox_cub-uanic][cub-uanic]            - Split Ergonomic Keyboard [ErgoDox][ergodox_org]
  66 * [mcdox][mcdox_tmk]                        - [mcdox][mcdox]
  67
  68
  69 [GH_macway]:    http://geekhack.org/showwiki.php?title=Island:11930
  70 [GH_hhkb]:      http://geekhack.org/showwiki.php?title=Island:12047
  71 [GH_ps2]:       http://geekhack.org/showwiki.php?title=Island:14618
  72 [GH_adb]:       http://geekhack.org/showwiki.php?title=Island:14290
  73 [GH_hhkb_bt]:   http://geekhack.org/showwiki.php?title=Island:20851
  74 [GH_m0110]:     http://geekhack.org/showwiki.php?title=Island:24965
  75 [GH_news]:      http://geekhack.org/showwiki.php?title=Island:25759
  76 [GH_terminal]:  http://geekhack.org/showwiki.php?title=Island:27272
  77 [GH_x68k]:      http://geekhack.org/showwiki.php?title=Island:29060
  78 [GH_hbkb]:      http://geekhack.org/showwiki.php?title=Island:29483
  79 [GH_ibm4704]:   http://geekhack.org/index.php?topic=54706.0
  80 [HID_liber]:    http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
  81 [Phantom]:      http://geekhack.org/index.php?topic=26742
  82 [GH60]:         http://geekhack.org/index.php?topic=34959
  83 [GH60_proto]:   http://geekhack.org/index.php?topic=37570.0
  84 [PC98]:         http://en.wikipedia.org/wiki/NEC_PC-9801
  85 [Sun]:          http://en.wikipedia.org/wiki/Sun-3
  86 [IIGS]:         http://en.wikipedia.org/wiki/Apple_IIGS
  87 [Infinity]:     https://www.massdrop.com/buy/infinity-keyboard-kit
  88 [ghost_squid]:  http://deskthority.net/wiki/Costar_replacement_controllers#The_Ghost_Squid
  89 [cmxt]:         http://gaming.coolermaster.com/en/products/keyboards/quickfirext/
  90 [ergodox_org]:  http://ergodox.org/
  91 [cub-uanic]:    https://github.com/cub-uanic/tmk_keyboard/tree/master/keyboard/ergodox
  92 [mcdox]:        https://github.com/DavidMcEwan/mcdox
  93 [mcdox_tmk]:    https://github.com/DavidMcEwan/tmk_keyboard/tree/master/keyboard/mcdox
  94 [Planck]:       http://planckkeyboard.com
  95 [Atomic]:       http://atomickeyboard.com
  96
  97
  98 License
  99 -------
 100 **GPLv2** or later. Some protocol files are under **Modified BSD License**.
 101 LUFA, PJRC and V-USB stack have their own license respectively.
 102
 103
 104
 105 Build Firmware and Program Controller
 106 -------------------------------------
 107 See [doc/build.md](doc/build.md).
 108
 109
 110
 111 Change your keymap
 112 ------------------
 113 See [doc/keymap.md](doc/keymap.md).
 114
 115
 116
 117 Magic Commands
 118 --------------
 119 To see help press `Magic` + `H`.
 120
 121  `Magic` key bind may be `LShift` + `RShift` in many project, but `Power` key on ADB converter. `Magic` keybind can be vary on each project, check `config.h` in project directory.
 122
 123 Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
 124
 125     ----- Command Help -----
 126     c:      enter console mode
 127     d:      toggle debug enable
 128     x:      toggle matrix debug
 129     k:      toggle keyboard debug
 130     m:      toggle mouse debug
 131     v:      print device version & info
 132     t:      print timer count
 133     s:      print status
 134     e:      print eeprom config
 135     n:      toggle NKRO
 136     0/F10:  switch to Layer0
 137     1/F1:   switch to Layer1
 138     2/F2:   switch to Layer2
 139     3/F3:   switch to Layer3
 140     4/F4:   switch to Layer4
 141     PScr:   power down/remote wake-up
 142     Caps:   Lock Keyboard(Child Proof)
 143     Paus:   jump to bootloader
 144
 145 **TBD**
 146
 147 ### Boot Magic Configuration - Virtual DIP Switch
 148 Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable.
 149 Note that you must use keys of **Layer 0** as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
 150
 151 To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be pressed along with the following configuration keys. The salt key is configurable in `config.h`. See [common/bootmagic.h](common/bootmagic.h).
 152
 153 #### General
 154 - Skip reading EEPROM to start with default configuration(`ESC`)
 155 - Clear configuration stored in EEPROM to reset configuration(`Backspace`)
 156
 157 #### Bootloader
 158 - Kick up Bootloader(`B`)
 159
 160 #### Debug
 161 - Debug enable(`D`)
 162 - Debug matrix enable(`D`+`X`)
 163 - Debug keyboard enable(`D`+`K`)
 164 - Debug mouse enable(`D`+`M`)
 165
 166 #### Keymap
 167 - Swap Control and CapsLock(`Left Control`)
 168 - Change CapsLock to Control(`Caps Lock`)
 169 - Swap LeftAlt and Gui(`Left Alt`)
 170 - Swap RightAlt and Gui(`Right Alt`)
 171 - Disable Gui(`Left Gui`)
 172 - Swap Grave and Escape(`Grave`)
 173 - Swap BackSlash and BackSpace(`Back Slash`)
 174 - Enable NKRO on boot(`N`)
 175
 176 #### Default Layer
 177 - Set Default Layer to 0(`0`)
 178 - Set Default Layer to 1(`1`)
 179 - Set Default Layer to 2(`2`)
 180 - Set Default Layer to 3(`3`)
 181 - Set Default Layer to 4(`4`)
 182 - Set Default Layer to 5(`5`)
 183 - Set Default Layer to 6(`6`)
 184 - Set Default Layer to 7(`7`)
 185
 186 #### Caution
 187 Unintentional use of this feature will cause user confusion.
 188
 189 TODO: Magic key combination to avoid unintentional press during plug in
 190
 191 **TBD**
 192
 193
 194 Mechanical Locking support
 195 --------------------------
 196 This feature makes it possible for you to use mechanical switch for `CapsLock`, `NumLock` or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LNUM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Resync option tries to keep lock switch state consistent with keyboard LED state.
 197
 198     #define LOCKING_SUPPORT_ENABLE
 199     #define LOCKING_RESYNC_ENABLE
 200
 201
 202 Start Your Own Project
 203 -----------------------
 204 **TBD**
 205 ### Config.h Options
 206 #### 1. USB vendor/product ID and device description
 207     #define VENDOR_ID       0xFEED
 208     #define PRODUCT_ID      0xBEEF
 209     #define MANUFACTURER    t.m.k.
 210     #define PRODUCT         Macway mod
 211     #define DESCRIPTION     t.m.k. keyboard firmware for Macway mod
 212
 213 #### 2. Keyboard matrix configuration
 214     #define MATRIX_ROWS 8
 215     #define MATRIX_COLS 8
 216     #define MATRIX_HAS_GHOST
 217
 218
 219
 220 Architecture
 221 ------------
 222     Architecture Diagram
 223                                +---------------+---------------+-------------+
 224                                |    Host       |   Keyboard    | Matrix, LED |
 225        ___________             |-----------+-+ +-------------+ | +-----------|
 226       /          /| Keys/Mouse | Protocol  |d| | Action      | | | Protocol  |
 227      /__________/ |<-----------|  LUFA     |r| |  Layer, Tap | | |  Matrix   |
 228      |.--------.| |   LED      |  V-USB    |i| |-------------| | |  PS/2,IBM |             __________________
 229      ||        || |----------->|  PJRC     |v| | Keymap      | | |  ADB,M0110|  Keys      / /_/_/_/_/_/_/_/ /|
 230      ||  Host  || |  Console   |  iWRAP(BT)|e| | Mousekey    | | |  SUN/NEWS |<----------/ /_/_/_/_/_/_/_/ / /
 231      ||________||/.<-----------|  UART     |r| | Report      | | |  X68K/PC98| Control  / /_/_/_/_/_/_/_/ / /
 232      `_========_'/|            |---------------------------------------------|-------->/___ /_______/ ___/ /
 233      |_o______o_|/             | Sendchar, Print, Debug, Command, ...        |         |_________________|/
 234                                +---------------------------------------------+              Keyboard
 235
 236
 237
 238 Debugging
 239 --------
 240 Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
 241
 242 You can use xprintf() to display debug info on `hid_listen`, see `common/xprintf.h`.
 243
 244
 245
 246 Files and Directories
 247 -------------------
 248 ### Top
 249 * common/       - common codes
 250 * protocol/     - keyboard protocol support
 251 * keyboard/     - keyboard projects
 252 * converter/    - protocol converter projects
 253 * doc/          - documents
 254 * common.mk     - Makefile for common
 255 * protocol.mk    - Makefile for protocol
 256 * rules.mk      - Makefile for build rules
 257
 258 ### Common
 259 * host.h
 260 * host_driver.h
 261 * keyboard.h
 262 * command.h
 263 * keymap.h
 264 * action.h
 265 * keycode.h
 266 * matrix.h
 267 * led.h
 268 * mousekey.h
 269 * report.h
 270 * debug.h
 271 * print.h
 272 * bootloader.h
 273 * sendchar.h
 274 * timer.h
 275 * util.h
 276
 277 ### Keyboard Protocols
 278 * lufa/     - LUFA USB stack
 279 * pjrc/     - PJRC USB stack
 280 * vusb/     - Objective Development V-USB
 281 * iwrap/    - Bluetooth HID for Bluegiga iWRAP
 282 * ps2.c     - PS/2 protocol
 283 * adb.c     - Apple Desktop Bus protocol
 284 * m0110.c   - Macintosh 128K/512K/Plus keyboard protocol
 285 * news.c    - Sony NEWS keyboard protocol
 286 * x68k.c    - Sharp X68000 keyboard protocol
 287 * serial_soft.c - Asynchronous Serial protocol implemented by software
 288
 289
 290
 291 Coding Style
 292 -------------
 293 - Doesn't use Tab to indent, use 4-spaces instead.
 294
 295
 296
 297 Other Keyboard Firmware Projects
 298 ------------------
 299 You can learn a lot about keyboard firmware from these. See [doc/other_projects.md](doc/other_projects.md).