t.m.k. Keyboard Firmware
========================
http://github.com/tmk/tmk_keyboard

This is keyboard firmware for AVR USB MCUs or Teensy/Teensy++ 2.0.

The project is heavily based on PJRC USB Keyboard/Mouse Example and
owes a debt to preceding keyboard firmware projects.

http://www.pjrc.com/teensy



Functions
---------
Mouse key
System Control Key
    Power Down, Sleep, Wake Up & USB Remote Wake up
Media Control Key
    Volume Down/Up, Mute
USB NKRO


Build
-----
Compiling sources need AVR GCC, AVR Libc and GNU make.(You can use WinAVR on Windows.)

$ cd <target> (hhkb or macway)
$ make

http://winavr.sourceforge.net/


Build Options
-------------
Makefile:
Comment out to disable the option
    # USB NKey Rollover
    USB_NKRO_ENABLE = yes

    # mouse keys
    MOUSEKEY_ENABLE = yes

    # PS/2 mouse support
    PS2_MOUSE_ENABLE = yes

config.h:
    /* USB ID */
    #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
    /* matrix size */
    #define MATRIX_ROWS 8
    #define MATRIX_COLS 8
    /* mouse keys repeat delay */
    #define MOUSEKEY_DELAY_TIME 192
    /* PS/2 lines */
    #define PS2_CLOCK_PORT  PORTF
    #define PS2_CLOCK_PIN   PINF
    #define PS2_CLOCK_DDR   DDRF
    #define PS2_CLOCK_BIT   0
    #define PS2_DATA_PORT   PORTF
    #define PS2_DATA_PIN    PINF
    #define PS2_DATA_DDR    DDRF
    #define PS2_DATA_BIT    1


Configuration
-------------


Debuging & Rescue
-----------------
Use PJRC's hid_listen.exe to see debug messages.
Press right Control + Shift + Alt + GUI + H to debug menu. 

Pressing any 3 keys when connected enables debug output.
Pressing any 4 keys when connected makes bootloader comes up.


Projects related
----------------
PJRC USB Keyboard/Mouse Example
    http://www.pjrc.com/teensy/usb_keyboard.html
    http://www.pjrc.com/teensy/usb_mouse.html
kbupgrade
    http://github.com/rhomann/kbupgrade
    http://geekhack.org/showwiki.php?title=Island:8406
c64key
    http://symlink.dk/projects/c64key/
rump
    http://mg8.org/rump/
    http://github.com/clee/rump
dulcimer
    http://www.schatenseite.de/dulcimer.html
humblehacker-keyboard
    http://github.com/humblehacker
    http://www.humblehacker.com/keyboard/
    http://geekhack.org/showwiki.php?title=Island:6292
ps2avr
    http://sourceforge.net/projects/ps2avr/


EOF