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)
26 You can find some keyboard specific projects under `converter` and `keyboard` directory.
29 * [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2]
30 * [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb]
31 * [m0110_usb](converter/m0110_usb) - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
32 * [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
33 * [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news]
34 * [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
35 * [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?)
36 * [pc98_usb](converter/pc98_usb/) - [PC98] to USB
37 * [usb_usb](converter/usb_usb/) - USB to USB(experimental)
40 * [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard professional][GH_hhkb]
41 * [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway]
42 * [hbkb](keyboard/hbkb/) - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb]
43 * [IIgs_Standard](keyboard/IIgs/) - Apple [IIGS] keyboard mod(by JeffreySung)
44 * [hid_liber](keyboard/hid_liber/) - [HID liberation controller][HID_liber](by alaricljs)
45 * [phantom](keyboard/phantom/) - [Phantom keyboard][PHANTOM] (by Tranquilite)
46 * [gh60](keyboard/gh60/) - [GH60 keyboard][GH60]
48 [GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
49 [GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
50 [GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
51 [GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
52 [GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
53 [GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
54 [GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
55 [GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
56 [GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
57 [GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
58 [HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
59 [PHANTOM]: http://geekhack.org/index.php?topic=26742
60 [GH60]: http://geekhack.org/index.php?topic=34959
61 [PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
62 [Sun]: http://en.wikipedia.org/wiki/Sun-3
63 [IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS
70 First, you need tools to build firmware and program your controller. I assume you are on Windows here.
72 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.
74 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.
76 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.
78 If you use PJRC Teensy you don't need step 2 and 3, just get [Teensy loader][teensy-loader].
82 You can find firmware source at github: https://github.com/tmk/tmk_keyboard
84 If you are familiar with `Git` tools you are recommended to use it.
85 If not you can download zip archive from: https://github.com/tmk/tmk_keyboard/archive/master.zip
89 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.
91 2. Move to project directory in the firmware source.
93 cd tmk_keyboard/{keyboard or converter}/<project>
95 3. Build firmware using GNU `make` command. You'll see <project>_<variant>.hex file in that directory unless something unexpected occurs in build process.
97 mkae -f Makefile.<variant> clean
98 make -f Makefile.<variant>
103 ### Program Controller
104 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`.
107 To program AVR chip with DFU bootloader use `FLIP` or `dfu-programmer`.
108 If you have a proper program command in `Makefile` just type this.
110 `FLIP` has two version of tool, GUI app and command line program. If you want GUI see tutorial section below.
111 To use command line tool run this command. Note that you need to set PATH variable properly.
113 $ make -f Makefile.<variant> flip
115 To program with `dfu-programmer` run:
117 $ make -f Makefile.<variant> dfu
120 If you have PJRC Teensy see instruction of `Teensy Loader` at: <http://www.pjrc.com/teensy/loader.html>
121 Or use this command if you have command line version of Teensy Loader installed.
123 $ make -f Makefile.<variant> teensy
126 #### Other programmer
127 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.
129 $ make -f Makefile.<variant> program
133 #### FLIP GUI tutorial
134 1. On menu bar click Device -> Select, then. `ATmega32u4`.
135 2. On menu bar click Settings -> Communication -> USB, then click 'Open' button on 'USB Port Connection' dialog.
136 At this point you'll see greyouted widgets on the app get colored and ready.
138 3. On menu bar click File -> Load HEX File, then select your firmware hex file on File Selector dialog.
139 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.
140 5. Re-plug USB cord or click 'Start Application' button to restart your controller.
143 See also these instaructions if you need.
145 - <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
146 - <http://www.atmel.com/Images/doc7769.pdf>
149 [winavr]: http://winavr.sourceforge.net/
150 [crosspack]: http://www.obdev.at/products/crosspack/index.html
151 [flip]: http://www.atmel.com/tools/FLIP.aspx
152 [dfu-prog]: http://dfu-programmer.sourceforge.net/
153 [teensy-loader]:http://www.pjrc.com/teensy/loader.html
159 ### 1. MCU and Frequency.
161 MCU = atmega32u4 # Teensy 2.0
162 #MCU = at90usb1286 # Teensy++ 2.0
166 Note that ***comment out*** to disable them.
168 BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
169 MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
170 EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
171 CONSOLE_ENABLE = yes # Console for debug(+400)
172 #NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA
173 #PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support
176 Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`.
179 PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex
181 # for Atmel chip with DFU bootloader
182 PROGRAM_CMD = dfu-programmer $(MCU) flash $(TARGET).hex
184 # avrdude with other methods
185 PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
186 PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
187 PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
193 ### 1. USB vendor/product ID and device description
194 #define VENDOR_ID 0xFEED
195 #define PRODUCT_ID 0xBEEF
196 /* device description */
197 #define MANUFACTURER t.m.k.
198 #define PRODUCT Macway mod
199 #define DESCRIPTION t.m.k. keyboard firmware for Macway mod
201 ### 2. Keyboard matrix configuration
202 #define MATRIX_ROWS 8
203 #define MATRIX_COLS 8
204 #define MATRIX_HAS_GHOST
210 ### 5. COMMAND key combination
212 #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
217 [keymap.md](doc/keymap.md)
224 Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
226 You will see output from firmware like this.
238 ---- action_exec: start -----
240 Tapping: Tap release(2)
241 ACTION: ACT_LAYER[5:2C]
242 LAYER_PRESSED: Tap: unregister_code
243 TAPPING_KEY=0307u(22511):2
244 processed: 0307u(22511):2
246 Tapping: End(Timeout after releasing last tap): FFFFu(22715)
247 TAPPING_KEY=0000u(0):0
254 To see help press `Magic` + `H`.
256 `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.
258 Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
260 ----- Command Help -----
261 c: enter console mode
262 d: toggle debug enable
263 x: toggle matrix debug
264 k: toggle keyboard debug
265 m: toggle mouse debug
266 p: toggle print enable
267 v: print device version & info
270 0/F10: switch to Layer0
271 1/F1: switch to Layer1
272 2/F2: switch to Layer2
273 3/F3: switch to Layer3
274 4/F4: switch to Layer4
275 PScr: power down/remote wake-up
276 Caps: Lock Keyboard(Child Proof)
277 Paus: jump to bootloader
281 ### Conguration with Boot Magic
282 Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable.
283 These settings are stored in EEPROM.
285 - Clear configuration stored in EEPROM(`Backspace`)
286 - Kick up Bootloader(`B`)
288 - Swap Control and CapsLock(`Left Control`)
289 - Change CapsLock to Control(`Casp Lock`)
290 - Swap LeftAlt and Gui(`Left Alt`)
291 - Swap RightAlt and Gui(`Right Alt`)
292 - Disable Gui(`Left Gui`)
293 - Swap Grave and Escape(`Grave`)
294 - Swap BackSlash and BackSpace(`Back Slash`)
300 Start Your Own Project
301 -----------------------
308 * common/ - common codes
309 * protocol/ - keyboard protocol support
310 * keyboard/ - keyboard projects
311 * converter/ - protocol converter projects
313 * common.mk - Makefile for common
314 * protoco.mk - Makefile for protocol
315 * rules.mk - Makefile for build rules
322 * controller_teensy.h
341 ### Keyboard Protocols
342 * lufa/ - LUFA USB stack
343 * pjrc/ - PJRC USB stack
344 * vusb/ - Objective Development V-USB
345 * iwrap/ - Bluetooth HID for Bluegiga iWRAP
346 * ps2.c - PS/2 protocol
347 * adb.c - Apple Desktop Bus protocol
348 * m0110.c - Macintosh 128K/512K/Plus keyboard protocol
349 * news.c - Sony NEWS keyboard protocol
350 * x68k.c - Sharp X68000 keyboard protocol
351 * serial_soft.c - Asynchronous Serial protocol implemented by software
357 Under `GPL` 2 or later. Some protocol files are under `Modified BSD License`.
358 LUFA, PJRC and V-USB stack have their own license respectively.