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. 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. Install [Atmel FLIP][flip]. `FLIP` is a tool to program(load) firmware into AVR controller(ATMega32u4) via DFU bootloader. ATMega32u4 has DFU bootloader by factory default. You can use [dfu-programmer][dfu-prog] instead if you are on Mac.
78 3. Install driver for DFU bootloader. 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, just get [Teensy loader][teensy-loader].
84 You can find firmware source at github: https://github.com/tmk/tmk_keyboard
86 If you are familiar with `Git` tools you are recommended to use it.
87 If not you can download zip archive from: https://github.com/tmk/tmk_keyboard/archive/master.zip
91 1. 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.
93 2. Move to project directory in the firmware source.
95 cd tmk_keyboard/{keyboard or converter}/<project>
97 3. Build firmware using GNU `make` command. You'll see <project>_<variant>.hex file in that directory unless something unexpected occurs in build process.
99 mkae -f Makefile.<variant> clean
100 make -f Makefile.<variant>
105 ### Program Controller
106 Sock AVR USB chip including ATmega32U4 has DFU bootloader by factory default, you can use DFU tools for this purpose. `FLIP` is a DFU tool on Windows offered by Atmel. Open source command line DFU tool `dfu-programmer` also supports AVR chips, which run on Linux, Mac OSX and even Windows. If you have a PJRC Teensy you should use `Teensy Loader`.
109 To program AVR chip with DFU bootloader use `FLIP` or `dfu-programmer`.
110 If you have a proper program command in `Makefile` just type this.
112 `FLIP` has two version of tool, GUI app and command line program. If you want GUI see tutorial section below.
113 To use command line tool run this command. Note that you need to set PATH variable properly.
115 $ make -f Makefile.<variant> flip
117 To program with `dfu-programmer` run:
119 $ make -f Makefile.<variant> dfu
122 If you have PJRC Teensy see instruction of `Teensy Loader` at: <http://www.pjrc.com/teensy/loader.html>
123 Or use this command if you have command line version of Teensy Loader installed.
125 $ make -f Makefile.<variant> teensy
128 #### Other programmer
129 You may want to use other you favorite 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.
131 $ make -f Makefile.<variant> program
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 [winavr]: http://winavr.sourceforge.net/
152 [crosspack]: http://www.obdev.at/products/crosspack/index.html
153 [flip]: http://www.atmel.com/tools/FLIP.aspx
154 [dfu-prog]: http://dfu-programmer.sourceforge.net/
155 [teensy-loader]:http://www.pjrc.com/teensy/loader.html
161 ### 1. MCU and Frequency.
163 MCU = atmega32u4 # Teensy 2.0
164 #MCU = at90usb1286 # Teensy++ 2.0
168 Note that ***comment out*** to disable them.
170 BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
171 MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
172 EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
173 CONSOLE_ENABLE = yes # Console for debug(+400)
174 SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend
175 #NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA
176 #PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support
179 Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`.
182 PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex
184 # for Atmel chip with DFU bootloader
185 PROGRAM_CMD = dfu-programmer $(MCU) flash $(TARGET).hex
187 # avrdude with other methods
188 PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
189 PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
190 PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
196 ### 1. USB vendor/product ID and device description
197 #define VENDOR_ID 0xFEED
198 #define PRODUCT_ID 0xBEEF
199 /* device description */
200 #define MANUFACTURER t.m.k.
201 #define PRODUCT Macway mod
202 #define DESCRIPTION t.m.k. keyboard firmware for Macway mod
204 ### 2. Keyboard matrix configuration
205 #define MATRIX_ROWS 8
206 #define MATRIX_COLS 8
207 #define MATRIX_HAS_GHOST
213 ### 5. COMMAND key combination
215 #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
220 [keymap.md](doc/keymap.md)
227 Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
229 You will see output from firmware like this.
241 ---- action_exec: start -----
243 Tapping: Tap release(2)
244 ACTION: ACT_LAYER[5:2C]
245 LAYER_PRESSED: Tap: unregister_code
246 TAPPING_KEY=0307u(22511):2
247 processed: 0307u(22511):2
249 Tapping: End(Timeout after releasing last tap): FFFFu(22715)
250 TAPPING_KEY=0000u(0):0
257 To see help press `Magic` + `H`.
259 `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.
261 Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
263 ----- Command Help -----
264 c: enter console mode
265 d: toggle debug enable
266 x: toggle matrix debug
267 k: toggle keyboard debug
268 m: toggle mouse debug
269 p: toggle print enable
270 v: print device version & info
273 0/F10: switch to Layer0
274 1/F1: switch to Layer1
275 2/F2: switch to Layer2
276 3/F3: switch to Layer3
277 4/F4: switch to Layer4
278 PScr: power down/remote wake-up
279 Caps: Lock Keyboard(Child Proof)
280 Paus: jump to bootloader
284 ### Conguration with Boot Magic
285 Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable.
286 These settings are stored in EEPROM.
288 - Clear configuration stored in EEPROM(`Backspace`)
289 - Kick up Bootloader(`B`)
291 - Swap Control and CapsLock(`Left Control`)
292 - Change CapsLock to Control(`Casp Lock`)
293 - Swap LeftAlt and Gui(`Left Alt`)
294 - Swap RightAlt and Gui(`Right Alt`)
295 - Disable Gui(`Left Gui`)
296 - Swap Grave and Escape(`Grave`)
297 - Swap BackSlash and BackSpace(`Back Slash`)
302 Mechanical Locking support for CapsLock
303 ---------------------------------------
304 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.
306 #define CAPSLOCK_LOCKING_ENABLE
307 #define CAPSLOCK_LOCKING_RESYNC_ENABLE
310 Start Your Own Project
311 -----------------------
319 * common/ - common codes
320 * protocol/ - keyboard protocol support
321 * keyboard/ - keyboard projects
322 * converter/ - protocol converter projects
324 * common.mk - Makefile for common
325 * protoco.mk - Makefile for protocol
326 * rules.mk - Makefile for build rules
333 * controller_teensy.h
352 ### Keyboard Protocols
353 * lufa/ - LUFA USB stack
354 * pjrc/ - PJRC USB stack
355 * vusb/ - Objective Development V-USB
356 * iwrap/ - Bluetooth HID for Bluegiga iWRAP
357 * ps2.c - PS/2 protocol
358 * adb.c - Apple Desktop Bus protocol
359 * m0110.c - Macintosh 128K/512K/Plus keyboard protocol
360 * news.c - Sony NEWS keyboard protocol
361 * x68k.c - Sharp X68000 keyboard protocol
362 * serial_soft.c - Asynchronous Serial protocol implemented by software
368 Under `GPL` 2 or later. Some protocol files are under `Modified BSD License`.
369 LUFA, PJRC and V-USB stack have their own license respectively.