Add doc/build.md and doc/other_projects.md
[tmk_keyboard.git] / README.md
CommitLineData
78fd5a71 1TMK Keyboard Firmware Collection
2================================
3This is a keyboard firmware with some useful features for Atmel AVR controller.
afb08462 4
5Source code is available here: <http://github.com/tmk/tmk_keyboard>
6
7
8Features
9--------
78fd5a71 10These features can be used in your keyboard.
11
633d9aa5 12* Multi-layer Keymap - Multiple keyboard layouts with layer switching
74ecdd15 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
8b9bd51d 23* Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
c0137b4b 24* Locking CapsLock - Mechanical switch support for CapsLock
0142e20b 25* Breathing Sleep LED - Sleep indicator with charm during USB suspend
afb08462 26
27
28Projects
29--------
083c7581 30You can find some keyboard specific projects under `converter` and `keyboard` directory.
31
afb08462 32### converter
1aa067e5 33* [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2]
34* [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb]
35* [m0110_usb](converter/m0110_usb) - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
36* [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
37* [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news]
38* [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
633d9aa5 39* [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?)
40* [pc98_usb](converter/pc98_usb/) - [PC98] to USB
1aa067e5 41* [usb_usb](converter/usb_usb/) - USB to USB(experimental)
afb08462 42
43### keyboard
78fd5a71 44* [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard pro][GH_hhkb] **my main board**
45* [gh60](keyboard/gh60/) - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
46* [hbkb](keyboard/hbkb/) - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
47* [hid_liber](keyboard/hid_liber/) - [HID liberation][HID_liber] controller (by alaricljs)
48* [phantom](keyboard/phantom/) - [Phantom] keyboard (by Tranquilite)
5808317b 49* [IIgs_Standard](keyboard/IIgs/) - Apple [IIGS] keyboard mod(by JeffreySung)
78fd5a71 50* [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway] [retired]
784c6e39 51
afb08462 52[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
53[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
54[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
55[GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
56[GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
57[GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
81706d11 58[GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
afb08462 59[GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
60[GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
81706d11 61[GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
74ecdd15 62[HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
78fd5a71 63[Phantom]: http://geekhack.org/index.php?topic=26742
74ecdd15 64[GH60]: http://geekhack.org/index.php?topic=34959
78fd5a71 65[GH60_proto]: http://geekhack.org/index.php?topic=37570.0
633d9aa5 66[PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
67[Sun]: http://en.wikipedia.org/wiki/Sun-3
68[IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS
afb08462 69
70
71
78fd5a71 72License
73-------
74**GPLv2** or later. Some protocol files are under **Modified BSD License**.
75LUFA, PJRC and V-USB stack have their own license respectively.
74ecdd15 76
afb08462 77
784c6e39 78
78fd5a71 79Build Firmware and Program Controller
80-------------------------------------
81See [doc/build.md](doc/build.md).
afb08462 82
afb08462 83
84
083c7581 85Change your keymap
86------------------
78fd5a71 87See [doc/keymap.md](doc/keymap.md).
afb08462 88
89
74ecdd15 90
91Magic Comannds
92--------------
93To see help press `Magic` + `H`.
94
95 `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.
96
97Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
98
99 ----- Command Help -----
100 c: enter console mode
101 d: toggle debug enable
102 x: toggle matrix debug
103 k: toggle keyboard debug
104 m: toggle mouse debug
105 p: toggle print enable
106 v: print device version & info
107 t: print timer count
108 s: print status
109 0/F10: switch to Layer0
110 1/F1: switch to Layer1
111 2/F2: switch to Layer2
112 3/F3: switch to Layer3
113 4/F4: switch to Layer4
114 PScr: power down/remote wake-up
115 Caps: Lock Keyboard(Child Proof)
116 Paus: jump to bootloader
117
8b9bd51d 118**TBD**
39d09333 119
8b9bd51d 120### Conguration with Boot Magic
121Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable.
122These settings are stored in EEPROM.
39d09333 123
8b9bd51d 124- Clear configuration stored in EEPROM(`Backspace`)
125- Kick up Bootloader(`B`)
126- Debug enable(`D`)
127- Swap Control and CapsLock(`Left Control`)
128- Change CapsLock to Control(`Casp Lock`)
129- Swap LeftAlt and Gui(`Left Alt`)
130- Swap RightAlt and Gui(`Right Alt`)
131- Disable Gui(`Left Gui`)
132- Swap Grave and Escape(`Grave`)
133- Swap BackSlash and BackSpace(`Back Slash`)
39d09333 134
8b9bd51d 135**TBD**
39d09333 136
74ecdd15 137
c0137b4b 138Mechanical Locking support for CapsLock
139---------------------------------------
140To enable this feature define these two macros in `config.h` and use `KC_LCAP` for locking CapsLock in keymap instead of normal `KC_CAPS`. Resync option tries to keep lock switch state consistent with keyboard LED state.
141
142 #define CAPSLOCK_LOCKING_ENABLE
143 #define CAPSLOCK_LOCKING_RESYNC_ENABLE
144
74ecdd15 145
146Start Your Own Project
afb08462 147-----------------------
0142e20b 148**TBD**
41bf9204 149### Config.h Options
150#### 1. USB vendor/product ID and device description
151 #define VENDOR_ID 0xFEED
152 #define PRODUCT_ID 0xBEEF
41bf9204 153 #define MANUFACTURER t.m.k.
154 #define PRODUCT Macway mod
155 #define DESCRIPTION t.m.k. keyboard firmware for Macway mod
156
157#### 2. Keyboard matrix configuration
158 #define MATRIX_ROWS 8
159 #define MATRIX_COLS 8
160 #define MATRIX_HAS_GHOST
161
afb08462 162
afb08462 163
78fd5a71 164Architecture
165------------
166 Architecture Diagram
167 +---------------+---------------+-------------+
168 | Host | Keyboard | Matrix, LED |
169 ___________ |-----------+-+ +-------------+ | +-----------|
170 / /| Keys/Mouse | Protocol |d| | Action | | | Protocol |
171 /__________/ |<-----------| LUFA |r| | Layer, Tap | | | Matrix |
172 |.--------.| | LED | V-USB |i| |-------------| | | PS/2,IBM | __________________
173 || || |----------->| PJRC |v| | Keymap | | | ADB,M0110| Keys / /_/_/_/_/_/_/_/ /|
174 || Host || | Console | iWRAP(BT)|e| | Mousekey | | | SUN/NEWS |<----------/ /_/_/_/_/_/_/_/ / /
175 ||________||/.<-----------| UART |r| | Report | | | X68K/PC98| Control / /_/_/_/_/_/_/_/ / /
176 `_========_'/| |---------------------------------------------|-------->/___ /_______/ ___/ /
177 |_o______o_|/ | Sendchar, Print, Debug, Command, ... | |_________________|/
178 +---------------------------------------------+ Keyboard
179
180
181
182Debuging
183--------
184Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
afb08462 185
78fd5a71 186You will see output from firmware like this.
187
188 r/c 01234567
189 00: 00000000
190 01: 00000000
191 02: 00000000
192 03: 00000000
193 04: 00000000
194 05: 00000000
195 06: 00000000
196 07: 00000000
197
198 ---- action_exec: start -----
199 EVENT: 0307u(22511)
200 Tapping: Tap release(2)
201 ACTION: ACT_LAYER[5:2C]
202 LAYER_PRESSED: Tap: unregister_code
203 TAPPING_KEY=0307u(22511):2
204 processed: 0307u(22511):2
205
206 Tapping: End(Timeout after releasing last tap): FFFFu(22715)
207 TAPPING_KEY=0000u(0):0
208
209
210
211
212Files and Directories
74ecdd15 213-------------------
214### Top
215* common/ - common codes
216* protocol/ - keyboard protocol support
217* keyboard/ - keyboard projects
218* converter/ - protocol converter projects
219* doc/ - documents
220* common.mk - Makefile for common
221* protoco.mk - Makefile for protocol
222* rules.mk - Makefile for build rules
223
224### Common
78fd5a71 225* host.h
0be309cc 226* host_driver.h
78fd5a71 227* keyboard.h
228* command.h
229* keymap.h
230* action.h
0be309cc 231* keycode.h
0be309cc 232* matrix.h
78fd5a71 233* led.h
234* mousekey.h
0be309cc 235* report.h
78fd5a71 236* debug.h
237* print.h
238* bootloader.h
0be309cc 239* sendchar.h
78fd5a71 240* timer.h
241* util.h
74ecdd15 242
243### Keyboard Protocols
244* lufa/ - LUFA USB stack
245* pjrc/ - PJRC USB stack
246* vusb/ - Objective Development V-USB
247* iwrap/ - Bluetooth HID for Bluegiga iWRAP
248* ps2.c - PS/2 protocol
249* adb.c - Apple Desktop Bus protocol
250* m0110.c - Macintosh 128K/512K/Plus keyboard protocol
251* news.c - Sony NEWS keyboard protocol
252* x68k.c - Sharp X68000 keyboard protocol
253* serial_soft.c - Asynchronous Serial protocol implemented by software
afb08462 254
afb08462 255
afb08462 256
78fd5a71 257Other Keyboard Firmware Projects
258------------------
259See [doc/other_projects.md](doc/other_projects.md).
Imprint / Impressum