1 t.m.k. Keyboard Firmware Collection
2 ====================================
3 This is a keyboard firmware with some features for Atmel AVR controller.
5 Source code is available here: <http://github.com/tmk/tmk_keyboard>
10 * Multi-layer Keymap - Multiple keyboard layouts with layer switching
11 * Mouse key - Mouse control with keyboard
12 * System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up
13 * Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
14 * USB NKRO - 120 keys(+ 8 modifiers) simultaneously
15 * PS/2 mouse support - PS/2 mouse(TrackPoint) as composite device
16 * Keyboard protocols - PS/2, ADB, M0110, Sun and other old keyboard protocols
17 * User Function - Customizable function of key with writing code
18 * Macro - Very primitive at this time
19 * Keyboard Tricks - Oneshot modifier and modifier with tapping feature
20 * Debug Console - Messages for debug and interaction with firmware
21 * Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
22 * Locking CapsLock - Mechanical switch support for CapsLock
23 * Breathing Sleep LED - Sleep indicator with charm during USB suspend
28 You can find some keyboard specific projects under `converter` and `keyboard` directory.
31 * [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2]
32 * [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb]
33 * [m0110_usb](converter/m0110_usb) - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
34 * [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
35 * [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news]
36 * [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
37 * [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?)
38 * [pc98_usb](converter/pc98_usb/) - [PC98] to USB
39 * [usb_usb](converter/usb_usb/) - USB to USB(experimental)
42 * [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard professional][GH_hhkb]
43 * [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway]
44 * [hbkb](keyboard/hbkb/) - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb]
45 * [IIgs_Standard](keyboard/IIgs/) - Apple [IIGS] keyboard mod(by JeffreySung)
46 * [hid_liber](keyboard/hid_liber/) - [HID liberation controller][HID_liber](by alaricljs)
47 * [phantom](keyboard/phantom/) - [Phantom keyboard][PHANTOM] (by Tranquilite)
48 * [gh60](keyboard/gh60/) - [GH60 keyboard][GH60]
50 [GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
51 [GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
52 [GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
53 [GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
54 [GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
55 [GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
56 [GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
57 [GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
58 [GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
59 [GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
60 [HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
61 [PHANTOM]: http://geekhack.org/index.php?topic=26742
62 [GH60]: http://geekhack.org/index.php?topic=34959
63 [PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
64 [Sun]: http://en.wikipedia.org/wiki/Sun-3
65 [IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS
72 First, you need tools to build firmware and program your controller. I assume you are on Windows here.
74 1. **Toolchain** Install [WinAVR][winavr]. This is old but works well for this purpose. `WinAVR` is a tool set to build firmware including C compiler(gcc) and make commands. You can use [CrossPack][crosspack] instead if you are on Mac.
76 2. **Programmer** Install [Atmel FLIP][flip]. `FLIP` is a tool to program(load) firmware into AVR controller via DFU bootloader. AVR USB chips including ATmega32U4 has DFU bootloader by factory default. You can also use [dfu-programmer][dfu-prog] instead if you are on Mac or Linux.
78 3. **Driver** At first time you start DFU bootloader on Chip 'Found New Hardware Wizard' will come up on Windows. If you install device driver properly you can find chip name like 'ATmega32U4' under 'LibUSB-Win32 Devices' tree on 'Device Manager'. If not you shall need to update its driver on 'Device Manager'. You will find the driver in `FLIP` install directory like: C:\Program Files (x86)\Atmel\Flip 3.4.5\usb\. If you use `dfu-programmer` install its driver.
80 If you use PJRC Teensy you don't need step 2 and 3 above, just get [Teensy loader][teensy-loader].
83 ### 2. Download source
84 You can find firmware source at github:
86 - <https://github.com/tmk/tmk_keyboard>
88 If you are familiar with `Git` tools you are recommended to use it but you can also download zip archive from:
90 - <https://github.com/tmk/tmk_keyboard/archive/master.zip>
96 Open terminal window to get access to commands. You can use `cmd` in Windows or `Terminal.app` on Mac OSX. In Windows press `Windows` key and `R` then enter `cmd` in 'Run command' dialog showing up.
98 ### 2. Change directory
99 Move to project directory in the firmware source.
101 cd tmk_keyboard/{'keyboard' or 'converter'}/<project>
104 Build firmware using GNU `make` command. You'll see `<project>_<variant>.hex` file in that directory unless something unexpected occurs in build process.
107 mkae -f Makefile.<variant> clean
108 make -f Makefile.<variant>
115 Now you have **hex** file to program on current directory. This **hex** is only needed to program your controller, other files are used for development and you may leave and forget them.
117 ### 1. Start bootloader
118 How to program controller depends on controller chip and its board design. To program AVR USB chips you'll need to start it up in bootloader mode. Most of boards with the chip have a push button to let bootloader come up. Consult with your controller board manual.
120 ### 2. Program with DFU bootloader
121 Stock AVR USB chip including ATmega32U4 has DFU bootloader by factory default. `FLIP` is a DFU programmer on Windows offered by Atmel. Open source command line tool `dfu-programmer` also supports AVR chips, it runs on Linux, Mac OSX and even Windows.
123 To program AVR chip with DFU bootloader use `FLIP` or `dfu-programmer`.
124 If you have a proper program command in `Makefile` just type this.
126 `FLIP` has two version of tool, GUI app and command line program. If you want GUI see tutorial below.
127 To use command line tool run this command. Note that you need to set PATH variable properly.
129 $ make -f Makefile.<variant> flip
131 Or to program with `dfu-programmer` run:
133 $ make -f Makefile.<variant> dfu
135 #### FLIP GUI tutorial
136 1. On menu bar click Device -> Select, then. `ATmega32u4`.
137 2. On menu bar click Settings -> Communication -> USB, then click 'Open' button on 'USB Port Connection' dialog.
138 At this point you'll see greyouted widgets on the app get colored and ready.
140 3. On menu bar click File -> Load HEX File, then select your firmware hex file on File Selector dialog.
141 4. On 'Operations Flow' panel click 'Run' button to load the firmware binary to the chip. Note that you should keep 'Erase', 'Blank Check', 'Program' and 'Verify' check boxes selected.
142 5. Re-plug USB cord or click 'Start Application' button to restart your controller.
145 See also these instaructions if you need.
147 - <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
148 - <http://www.atmel.com/Images/doc7769.pdf>
151 ### 3. Program with Teensy Loader
152 If you have PJRC Teensy see instruction of `Teensy Loader`.
154 - <http://www.pjrc.com/teensy/loader.html>
156 Or use this command if you have command line version of Teensy Loader installed.
158 $ make -f Makefile.<variant> teensy
161 ### 4. Program with Other programmer
162 You may want to use other programmer like `avrdude` with AVRISPmkII, Aruduino or USBasp. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in Makefile.
164 $ make -f Makefile.<variant> program
167 [winavr]: http://winavr.sourceforge.net/
168 [crosspack]: http://www.obdev.at/products/crosspack/index.html
169 [flip]: http://www.atmel.com/tools/FLIP.aspx
170 [dfu-prog]: http://dfu-programmer.sourceforge.net/
171 [teensy-loader]:http://www.pjrc.com/teensy/loader.html
177 ### 1. MCU and Frequency.
179 MCU = atmega32u4 # Teensy 2.0
180 #MCU = at90usb1286 # Teensy++ 2.0
183 # Boot Section Size in *bytes*
185 # Atmel DFU loader 4096
186 # LUFA bootloader 4096
187 OPT_DEFS += -DBOOTLOADER_SIZE=4096
190 Optional. Note that ***comment out*** to disable them.
192 BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
193 MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
194 EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
195 CONSOLE_ENABLE = yes # Console for debug(+400)
196 COMMAND_ENABLE = yes # Commands for debug and configuration
197 SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend
198 #NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA
201 Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. Not needed if you use `FLIP`, `dfu-programmer` or `Teesy Loader`.
203 # avrdude with AVRISPmkII
204 PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
206 # avrdude with USBaspLoader
207 PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
209 # avrdude with arduino
210 PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
216 ### 1. Magic command key combination
218 #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
220 ### 2. Mechanical Locking Support for CapsLock
222 /* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */
223 #define CAPSLOCK_LOCKING_ENABLE
224 /* Locking CapsLock resynchronize hack */
225 #define CAPSLOCK_LOCKING_RESYNC_ENABLE
230 [keymap.md](doc/keymap.md)
237 Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
239 You will see output from firmware like this.
251 ---- action_exec: start -----
253 Tapping: Tap release(2)
254 ACTION: ACT_LAYER[5:2C]
255 LAYER_PRESSED: Tap: unregister_code
256 TAPPING_KEY=0307u(22511):2
257 processed: 0307u(22511):2
259 Tapping: End(Timeout after releasing last tap): FFFFu(22715)
260 TAPPING_KEY=0000u(0):0
267 To see help press `Magic` + `H`.
269 `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.
271 Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
273 ----- Command Help -----
274 c: enter console mode
275 d: toggle debug enable
276 x: toggle matrix debug
277 k: toggle keyboard debug
278 m: toggle mouse debug
279 p: toggle print enable
280 v: print device version & info
283 0/F10: switch to Layer0
284 1/F1: switch to Layer1
285 2/F2: switch to Layer2
286 3/F3: switch to Layer3
287 4/F4: switch to Layer4
288 PScr: power down/remote wake-up
289 Caps: Lock Keyboard(Child Proof)
290 Paus: jump to bootloader
294 ### Conguration with Boot Magic
295 Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable.
296 These settings are stored in EEPROM.
298 - Clear configuration stored in EEPROM(`Backspace`)
299 - Kick up Bootloader(`B`)
301 - Swap Control and CapsLock(`Left Control`)
302 - Change CapsLock to Control(`Casp Lock`)
303 - Swap LeftAlt and Gui(`Left Alt`)
304 - Swap RightAlt and Gui(`Right Alt`)
305 - Disable Gui(`Left Gui`)
306 - Swap Grave and Escape(`Grave`)
307 - Swap BackSlash and BackSpace(`Back Slash`)
312 Mechanical Locking support for CapsLock
313 ---------------------------------------
314 To 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.
316 #define CAPSLOCK_LOCKING_ENABLE
317 #define CAPSLOCK_LOCKING_RESYNC_ENABLE
320 Start Your Own Project
321 -----------------------
324 #### 1. USB vendor/product ID and device description
325 #define VENDOR_ID 0xFEED
326 #define PRODUCT_ID 0xBEEF
327 /* device description */
328 #define MANUFACTURER t.m.k.
329 #define PRODUCT Macway mod
330 #define DESCRIPTION t.m.k. keyboard firmware for Macway mod
332 #### 2. Keyboard matrix configuration
333 #define MATRIX_ROWS 8
334 #define MATRIX_COLS 8
335 #define MATRIX_HAS_GHOST
343 * common/ - common codes
344 * protocol/ - keyboard protocol support
345 * keyboard/ - keyboard projects
346 * converter/ - protocol converter projects
348 * common.mk - Makefile for common
349 * protoco.mk - Makefile for protocol
350 * rules.mk - Makefile for build rules
357 * controller_teensy.h
376 ### Keyboard Protocols
377 * lufa/ - LUFA USB stack
378 * pjrc/ - PJRC USB stack
379 * vusb/ - Objective Development V-USB
380 * iwrap/ - Bluetooth HID for Bluegiga iWRAP
381 * ps2.c - PS/2 protocol
382 * adb.c - Apple Desktop Bus protocol
383 * m0110.c - Macintosh 128K/512K/Plus keyboard protocol
384 * news.c - Sony NEWS keyboard protocol
385 * x68k.c - Sharp X68000 keyboard protocol
386 * serial_soft.c - Asynchronous Serial protocol implemented by software
392 Under `GPL` 2 or later. Some protocol files are under `Modified BSD License`.
393 LUFA, PJRC and V-USB stack have their own license respectively.