t.m.k. Keyboard Firmware Collection ==================================== This is a keyboard firmware with some features for Atmel AVR controller. Source code is available here: Features -------- * Mouse key - Mouse control by keyboard * System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up * Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc. * USB NKRO - Can send 120 keys(+ 8 modifiers) simultaneously. * PS/2 mouse support - integrate PS/2 mouse(TrackPoint) into keyboard as composite device. Projects -------- ### converter * [ps2_usb][c1] - [PS/2 keyboard to USB][GH_ps2] * [adb_usb][c2] - [ADB keyboard to USB][GH_adb] * [m0110_usb][c3] - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110] * [terminal_usb][c4] - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal] * [news_usb][c5] - [Sony NEWS keyboard to USB][GH_news] * [x68k_usb][c6] - [Sharp X68000 keyboard to USB][GH_x68k] ### keyboard * [hhkb][k1] - [Happy Hacking Keyboard professional][GH_hhkb] * [macway][k2] - [Compact keyboard mod][GH_macway] * [hbkb][k3] - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb] [c1]: converter/ps2_usb/ [c2]: converter/adb_usb/ [c3]: converter/m0110_usb/ [c4]: converter/terminal_usb/ [c5]: converter/news_usb/ [c6]: converter/x68k_usb/ [k1]: keyboard/hhkb [k2]: keyboard/macway [k3]: keyboard/hbkb [GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930 [GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047 [GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618 [GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290 [GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851 [GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965 [GH_news]: http://geekhack.org/showwiki.php?title=Island:25759 [GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272 [GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060 [GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483 Files & Directories ------------------- ### Top * [common/](common/) - common codes * [protocol/](protocol/) - keyboard protocol support * [keyboard/](keyboard/) - keyboard projects * [converter/](converter/) - protocol converter projects * [doc/](doc/) - documents ### Keyboard Protocols * [pjrc/](protocol/pjrc/) - PJRC USB stack * [vusb/](protocol/vusb/) - Objective Development V-USB * [iwrap/](protocol/iwrap) - Bluetooth HID for Bluegiga iWRAP * [ps2.c](protocol/ps2.c) - PS/2 protocol * [adb.c](protocol/adb.c) - Apple Desktop Bus protocol * [m0110.c](protocol/m0110.c) - Macintosh 128K/512K/Plus keyboard protocol * [news.c](protocol/news.c) - Sony NEWS keyboard protocol * [x68k.c](protocol/x68k.c) - Sharp X68000 keyboard protocol Build & Program --------------- ### Build firmware To compile you need `AVR GCC`, `AVR Libc` and `GNU make`. You can use [WinAVR][winavr] on Windows and [CrossPack][crosspack] on Mac. $ cd $ make The firmware will be compiled as a file `tmk_.hex`. [winavr]: http://winavr.sourceforge.net/ [crosspack]: http://www.obdev.at/products/crosspack/index.html ### Program Controller If you have proper program command in Makefile just type this. $ make program As for `Teensy` you can use `PJRC's loader` to program hex file. Build Options ------------- ### `Makefile` #### 1. MCU and Frequency. MCU = atmega32u4 # Teensy 2.0 #MCU = at90usb1286 # Teensy++ 2.0 F_CPU = 16000000 #### 2. Features Note that ***comment out*** to disable them. MOUSEKEY_ENABLE = yes # Mouse keys PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support EXTRAKEY_ENABLE = yes # Enhanced feature for Windows(Audio control and System control) NKRO_ENABLE = yes # USB Nkey Rollover #### 3. Programmer Set proper command for your controller, bootloader and programmer. # for PJRC Teensy PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex # for Atmel AT90USBKEY PROGRAM_CMD = dfu-programmer $(MCU) flash $(TARGET).hex # avrdude PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex ### `config.h` #### 1. USB vendor/product ID and device description #define VENDOR_ID 0xFEED #define PRODUCT_ID 0xBEEF /* device description */ #define MANUFACTURER t.m.k. #define PRODUCT Macway mod #define DESCRIPTION t.m.k. keyboard firmware for Macway mod #### 2. Keyboard matrix configuration #define MATRIX_ROWS 8 #define MATRIX_COLS 8 #define MATRIX_HAS_GHOST ### 3. Mouse keys configuration ### 4. PS/2 mouse configuration Keymap ------ Build your own firmware ----------------------- Debuging -------- Use PJRC's `hid_listen` to see debug messages and press ` + H` to debug menu. See `config.h` for definition of `` key combination. Other Keyboard Projects ----------------------- ### PJRC USB Keyboard/Mouse Example - - ### kbupgrade - - ### c64key - ### rump - - ### dulcimer - ### humblehacker-keyboard - - - ### ps2avr -