Go to file
Travis Burtrum c2bcad5149 Change default layout to qwerty, and layout changing keys to LCTRL + RCTRL to not conflict with rusty-keys 2018-10-22 00:19:30 -04:00
adb_usb added HHKB/README and clean some codes. 2011-05-25 11:30:14 +09:00
hhkb added HHKB/README and clean some codes. 2011-05-25 11:30:14 +09:00
macway added HHKB/README and clean some codes. 2011-05-25 11:30:14 +09:00
pjrc Update pjrc lib to compile with modern avr-gcc 2018-10-22 00:17:53 -04:00
ps2_usb Change default layout to qwerty, and layout changing keys to LCTRL + RCTRL to not conflict with rusty-keys 2018-10-22 00:19:30 -04:00
vusb Added PS/2 multimeda key support. 2011-05-31 21:25:16 +09:00
.gitignore add mouse function. 2010-09-30 14:50:23 +09:00
Makefile.common host interface for pjrc 2011-02-22 03:09:05 +09:00
Makefile.pjrc host interface for pjrc 2011-02-22 03:09:05 +09:00
Makefile.rules integrate V-USB support into ps2_usb 2011-02-22 03:09:14 +09:00
Makefile.vusb move files: main_vusb.c ps2_usart.c sendchar_usart.c from ps2_usb to common dir 2011-05-07 00:48:18 +09:00
README v3.0 cleanse files 2011-02-22 03:49:02 +09:00
USB_NKRO.txt Add PS/2 mouse support to connect TrackPoint Unit. 2011-01-02 23:52:13 +09:00
adb.c added HHKB/README and clean some codes. 2011-05-25 11:30:14 +09:00
adb.h ADB keyboard LEDs support 2011-01-13 22:46:57 +09:00
command.c First commit. Added dvorak-qwerty switching with scroll lock led indicator, and ctrl button switches back to qwerty for shortcuts. Also added dvorak layout with layer switching. 2011-05-25 11:49:22 -04:00
command.h First commit. Added dvorak-qwerty switching with scroll lock led indicator, and ctrl button switches back to qwerty for shortcuts. Also added dvorak layout with layer switching. 2011-05-25 11:49:22 -04:00
controller_teensy.h First commit. Added dvorak-qwerty switching with scroll lock led indicator, and ctrl button switches back to qwerty for shortcuts. Also added dvorak layout with layer switching. 2011-05-25 11:49:22 -04:00
debug.h improve layer switching 2010-10-30 01:16:47 +09:00
host.h Added PS/2 multimeda key support. 2011-05-31 21:25:16 +09:00
keyboard.c Merge remote branch 'upstream/master' 2011-05-31 12:19:19 -04:00
keyboard.h host interface for pjrc 2011-02-22 03:09:05 +09:00
keymap.h integrate V-USB support into ps2_usb 2011-02-22 03:09:14 +09:00
layer.c First commit. Added dvorak-qwerty switching with scroll lock led indicator, and ctrl button switches back to qwerty for shortcuts. Also added dvorak layout with layer switching. 2011-05-25 11:49:22 -04:00
layer.h refactor keyboard.h, host.h 2011-02-22 03:09:02 +09:00
led.h added protocol stack: pjrc, vusb 2011-02-22 03:08:59 +09:00
main_pjrc.c integrate V-USB support into ps2_usb 2011-02-22 03:09:14 +09:00
main_vusb.c move files: main_vusb.c ps2_usart.c sendchar_usart.c from ps2_usb to common dir 2011-05-07 00:48:18 +09:00
matrix.h integrate V-USB support into ps2_usb 2011-02-22 03:09:14 +09:00
mousekey.c host interface for pjrc 2011-02-22 03:09:05 +09:00
mousekey.c.bak refactor keyboard.h, host.h 2011-02-22 03:09:02 +09:00
mousekey.h refactor keyboard.h, host.h 2011-02-22 03:09:02 +09:00
mousekey.h.bak refactor keyboard.h, host.h 2011-02-22 03:09:02 +09:00
print.c Added keymap support for volume control, and a function to print ints in decimal format. 2011-05-26 01:31:49 -04:00
print.h Added keymap support for volume control, and a function to print ints in decimal format. 2011-05-26 01:31:49 -04:00
ps2.c added initial V-USB support for HHKB 2011-05-16 00:14:06 +09:00
ps2.h Synchronous USART support for PS/2 on V-USB stack 2011-02-22 03:09:12 +09:00
ps2_mouse.c refactor keyboard.h, host.h 2011-02-22 03:09:02 +09:00
ps2_mouse.h add error handling to ps2_mouse 2011-01-04 20:30:23 +09:00
ps2_usart.c move files: main_vusb.c ps2_usart.c sendchar_usart.c from ps2_usb to common dir 2011-05-07 00:48:18 +09:00
sendchar.h added PS/2 to USB converter use V-USB as protocol stack 2011-02-22 03:08:49 +09:00
timer.c added PS/2 to USB converter use V-USB as protocol stack 2011-02-22 03:08:49 +09:00
timer.h added PS/2 to USB converter use V-USB as protocol stack 2011-02-22 03:08:49 +09:00
usb_keycodes.h Merge remote branch 'upstream/master' 2011-05-31 12:19:19 -04:00
util.c add build option: NKRO_ENABLE(remove: USB_12KRO) 2010-12-08 01:57:55 +09:00
util.h new build method for macway 2010-10-27 22:56:01 +09:00

README

t.m.k. Keyboard Firmware
========================
This is keyboard firmware for Teensy(AVR USB MCU) and V-USB board.

source code repository:
http://github.com/tmk/tmk_keyboard

This firmware is used in following projects:
HHKB mod:   http://geekhack.org/showwiki.php?title=Island:12047
Macway mod: http://geekhack.org/showwiki.php?title=Island:11930
PS2 to USB: http://geekhack.org/showwiki.php?title=Island:14618
ADB to USB: http://geekhack.org/showwiki.php?title=Island:14290

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


Features
--------
Mouse key
    control mouse cursor from keyboard.
System Control Key
    Power Down, Sleep, Wake Up & USB Remote Wake up
Media Control Key
    Volume Down/Up, Mute
USB NKRO
    send 120 keys(+ 8 modifiers) at most simultaneously.
PS/2 mouse support
    integrate PS/2 mouse(TrackPoint) into keyboard as composite device.


Limitations
-----------


Files & Directories
-------------------
Target:
hhkb/                           keyboard controller for PFU HHKB pro
macway/                         keyboard controller for Macway mod
ps2_usb/                        PS2 to USB keyboard converter
adb_usb/                        ADB to USB keyboard converter

USB Protocol Stack:
pjrc/                           PJRC  USB stack
vusb/                           V-USB USB stack
ps2.[ch]                        PS/2 protocol
adb.[ch]                        ADB protocol


Build
-----
To compile needs AVR GCC, AVR Libc and GNU make.
You can use WinAVR on Windows.  http://winavr.sourceforge.net/

$ cd <target>
$ make

The firmware will be compiled as a file tmk_<target>.hex.


Build your own firmware
-----------------------
Copying exsistent target(macway) is easy way.
1. Copy contens of macway/ to your own target directory.
2. Edit Makefile. See next section.
3. Edit config.h. See next section.
4. Edit matrix.c. You will need to fix followings at least.
     matrix_init()
     matrix_scan()
     read_col()
     unselect_rows()
     select_row()
5. Edit keymap.c. NOTE: It is not final design and a bit messy.
   You will need to fix followings at least.
     KEYMAP
     fn_layer[]
     fn_keycode[]
     keymaps[]
6. Build.

If you have a build error like following, comment out "--relax" option in Makefile.common.
    (.vectors+0x30): relocation truncated to fit: R_AVR_13_PCREL against symbol `__vector_12'


Build Options
-------------
<target>/Makefile:
1. Set target name for your firmware.
     TARGET = tmk_<target>
2. Choose a MCU and its frequency.
     MCU = atmega32u4       # Teensy 2.0
     #MCU = at90usb1286      # Teensy++ 2.0
     F_CPU = 16000000
3. Choose optional modules as needed. Comment out to disable optional modules.
     MOUSEKEY_ENABLE = yes	# Mouse keys
     PS2_MOUSE_ENABLE = yes	# PS/2 mouse(TrackPoint) support
     USB_EXTRA_ENABLE = yes	# Enhanced feature for Windows(Audio control and System control)
     USB_NKRO_ENABLE = yes	# USB Nkey Rollover

<target>/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 if needed.
4. PS/2 mouse configuration if needed.


Debuging & Rescue
-----------------
Use PJRC's hid_listen.exe to see debug messages.
Press <COMMAND> + H to debug menu. 
(see config.h for <COMMAND> key combination.)

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