README

   1 t.m.k. Keyboard Firmware
   2 ========================
   3 http://github.com/tmk/tmk_keyboard
   4
   5 This is keyboard firmware for AVR USB MCUs or Teensy/Teensy++ 2.0.
   6
   7 The project is heavily based on PJRC USB Keyboard/Mouse Example and
   8 owes a debt to preceding keyboard firmware projects.
   9
  10 http://www.pjrc.com/teensy
  11
  12
  13
  14 Functions
  15 ---------
  16 Mouse key
  17 System Control Key
  18     Power Down, Sleep, Wake Up & USB Remote Wake up
  19 Media Control Key
  20     Volume Down/Up, Mute
  21 USB NKRO
  22
  23
  24 Build
  25 -----
  26 Compiling sources need AVR GCC, AVR Libc and GNU make.(You can use WinAVR on Windows.)
  27
  28 $ cd <target> (hhkb or macway)
  29 $ make
  30
  31 http://winavr.sourceforge.net/
  32
  33
  34 Build Options
  35 -------------
  36 Makefile:
  37 Comment out to disable the option
  38     # USB NKey Rollover
  39     USB_NKRO_ENABLE = yes
  40
  41     # mouse keys
  42     MOUSEKEY_ENABLE = yes
  43
  44     # PS/2 mouse support
  45     PS2_MOUSE_ENABLE = yes
  46
  47 config.h:
  48     /* USB ID */
  49     #define VENDOR_ID       0xFEED
  50     #define PRODUCT_ID      0xBEEF
  51     /* device description */
  52     #define MANUFACTURER    t.m.k.
  53     #define PRODUCT         Macway mod
  54     #define DESCRIPTION     t.m.k. keyboard firmware for Macway mod
  55     /* matrix size */
  56     #define MATRIX_ROWS 8
  57     #define MATRIX_COLS 8
  58     /* mouse keys repeat delay */
  59     #define MOUSEKEY_DELAY_TIME 192
  60     /* PS/2 lines */
  61     #define PS2_CLOCK_PORT  PORTF
  62     #define PS2_CLOCK_PIN   PINF
  63     #define PS2_CLOCK_DDR   DDRF
  64     #define PS2_CLOCK_BIT   0
  65     #define PS2_DATA_PORT   PORTF
  66     #define PS2_DATA_PIN    PINF
  67     #define PS2_DATA_DDR    DDRF
  68     #define PS2_DATA_BIT    1
  69
  70
  71 Configuration
  72 -------------
  73
  74
  75 Debuging & Rescue
  76 -----------------
  77 Use PJRC's hid_listen.exe to see debug messages.
  78 Press right Control + Shift + Alt + GUI + H to debug menu.
  79
  80 Pressing any 3 keys when connected enables debug output.
  81 Pressing any 4 keys when connected makes bootloader comes up.
  82
  83
  84 Projects related
  85 ----------------
  86 PJRC USB Keyboard/Mouse Example
  87     http://www.pjrc.com/teensy/usb_keyboard.html
  88     http://www.pjrc.com/teensy/usb_mouse.html
  89 kbupgrade
  90     http://github.com/rhomann/kbupgrade
  91     http://geekhack.org/showwiki.php?title=Island:8406
  92 c64key
  93     http://symlink.dk/projects/c64key/
  94 rump
  95     http://mg8.org/rump/
  96     http://github.com/clee/rump
  97 dulcimer
  98     http://www.schatenseite.de/dulcimer.html
  99 humblehacker-keyboard
 100     http://github.com/humblehacker
 101     http://www.humblehacker.com/keyboard/
 102     http://geekhack.org/showwiki.php?title=Island:6292
 103 ps2avr
 104     http://sourceforge.net/projects/ps2avr/
 105
 106
 107 EOF