D README => README +0 -151
@@ 1,151 0,0 @@
-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
- EXTRAKEY_ENABLE = yes # Enhanced feature for Windows(Audio control and System control)
- 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
A README.md => README.md +175 -0
@@ 0,0 1,175 @@
+t.m.k. Keyboard Firmware Collection
+====================================
+This is a keyboard firmware with some features for Atmel AVR controller.
+
+Source code is available here: <http://github.com/tmk/tmk_keyboard>
+
+
+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 - PS/2 keyboard to USB
+* adb_usb - ADB keyboard to USB
+* m0110_usb - Machintosh 128K/512K/Plus keyboard to USB
+* terminal_usb - IBM Model M terminal keyboard(PS/2 scancode set3) to USB
+* sony_usb - Sony NEWS keyboard to USB
+* x68k_usb - Sharp X68000 keyboard to USB
+
+### keyboard
+* hhkb - Happy Hacking Keyboard professional
+* macway - Compact keyboard mod
+* hbk - Happy Buckling sprint keyboard(IBM Model M mod)
+
+[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_sony]: 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_hbk]: http://geekhack.org/showwiki.php?title=Island:29483
+
+
+
+Files & Directories
+-------------------
+### Top
+* common/ common codes
+* protocol/ keyboard protocol support
+* keyboard/ keyboard projects
+* converter/ protocol converter projects
+* doc/ documents
+
+### Keyboard Protocols
+* pjrc/ PJRC USB stack
+* vusb/ Objective Development V-USB
+* iwrap/ Bluetooth HID for Bluegiga iWRAP
+* ps2 PS/2 protocol
+* adb Apple Desktop Bus protocol
+* m0110 Macintosh 128K/512K/Plus keyboard protocol
+* news Sony NEWS keyboard protocol
+* x68k Sharp X68000 keyboard protocol
+
+
+Build & Program
+---------------
+### Build firmware
+To compile you need `AVR GCC`, `AVR Libc` and `GNU make`.
+You can use [WinAVR][1] on Windows and [CrossPack][2] on Mac.
+
+ $ cd <project>
+ $ make
+
+The firmware will be compiled as a file tmk_<project>.hex.
+
+[1]: http://winavr.sourceforge.net/
+[2]: 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. <http://www.pjrc.com/teensy/loader.html>
+
+
+
+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 `<COMMAND> + H` to debug menu.
+See `config.h` for definition of `<COMMAND>` key combination.
+
+
+Other Keyboard Projects
+-----------------------
+### 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/>
R adb_usb/Makefile => converter/adb_usb/Makefile +1 -1
@@ 2,7 2,7 @@
TARGET = adb_usb
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R adb_usb/README => converter/adb_usb/README +0 -0
R adb_usb/config.h => converter/adb_usb/config.h +0 -0
R adb_usb/keymap.c => converter/adb_usb/keymap.c +0 -0
R adb_usb/led.c => converter/adb_usb/led.c +0 -0
R adb_usb/matrix.c => converter/adb_usb/matrix.c +0 -0
R m0110_usb/Makefile => converter/m0110_usb/Makefile +1 -1
@@ 2,7 2,7 @@
TARGET = m0110
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R m0110_usb/README.md => converter/m0110_usb/README.md +0 -0
R m0110_usb/config.h => converter/m0110_usb/config.h +0 -0
R m0110_usb/doc/m0110.jpg => converter/m0110_usb/doc/m0110.jpg +0 -0
R m0110_usb/doc/teensy.jpg => converter/m0110_usb/doc/teensy.jpg +0 -0
R m0110_usb/keymap.c => converter/m0110_usb/keymap.c +0 -0
R m0110_usb/led.c => converter/m0110_usb/led.c +0 -0
R m0110_usb/matrix.c => converter/m0110_usb/matrix.c +0 -0
R ps2_usb/Makefile => converter/ps2_usb/Makefile +1 -1
@@ 7,7 7,7 @@
TARGET = ps2_usb_pjrc
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R ps2_usb/Makefile.pjrc_usart => converter/ps2_usb/Makefile.pjrc_usart +1 -1
@@ 7,7 7,7 @@
TARGET = ps2_usb_pjrc_usart
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R ps2_usb/Makefile.vusb => converter/ps2_usb/Makefile.vusb +1 -1
@@ 7,7 7,7 @@
TARGET = ps2_usb_vusb
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R ps2_usb/README => converter/ps2_usb/README +0 -0
R ps2_usb/README.vusb => converter/ps2_usb/README.vusb +0 -0
R ps2_usb/config_pjrc.h => converter/ps2_usb/config_pjrc.h +0 -0
R ps2_usb/config_pjrc_usart.h => converter/ps2_usb/config_pjrc_usart.h +0 -0
R ps2_usb/config_vusb.h => converter/ps2_usb/config_vusb.h +0 -0
R ps2_usb/keymap.c => converter/ps2_usb/keymap.c +0 -0
R ps2_usb/led.c => converter/ps2_usb/led.c +0 -0
R ps2_usb/matrix.c => converter/ps2_usb/matrix.c +0 -0
R ps2_usb/usbconfig.h => converter/ps2_usb/usbconfig.h +0 -0
R sony_usb/Makefile.pjrc => converter/sony_usb/Makefile.pjrc +1 -1
@@ 7,7 7,7 @@
TARGET = news_usb_pjrc
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R sony_usb/config_pjrc.h => converter/sony_usb/config_pjrc.h +0 -0
R sony_usb/keymap.c => converter/sony_usb/keymap.c +0 -0
R sony_usb/led.c => converter/sony_usb/led.c +0 -0
R sony_usb/matrix.c => converter/sony_usb/matrix.c +0 -0
R sony_usb/news.c => converter/sony_usb/news.c +0 -0
R sony_usb/news.h => converter/sony_usb/news.h +0 -0
R terminal_usb/Makefile.102_pjrc => converter/terminal_usb/Makefile.102_pjrc +1 -1
@@ 7,7 7,7 @@
TARGET = terminal_usb_102_pjrc
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R terminal_usb/Makefile.122_pjrc => converter/terminal_usb/Makefile.122_pjrc +1 -1
@@ 7,7 7,7 @@
TARGET = terminal_usb_122_pjrc
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R terminal_usb/README => converter/terminal_usb/README +0 -0
R terminal_usb/config_102_pjrc.h => converter/terminal_usb/config_102_pjrc.h +0 -0
R terminal_usb/config_122_pjrc.h => converter/terminal_usb/config_122_pjrc.h +0 -0
R terminal_usb/keymap_102.c => converter/terminal_usb/keymap_102.c +0 -0
R terminal_usb/keymap_122.c => converter/terminal_usb/keymap_122.c +0 -0
R terminal_usb/led.c => converter/terminal_usb/led.c +0 -0
R terminal_usb/matrix.c => converter/terminal_usb/matrix.c +0 -0
R x68k_usb/Makefile => converter/x68k_usb/Makefile +1 -1
@@ 7,7 7,7 @@
TARGET = x68k_usb_pjrc
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R x68k_usb/README => converter/x68k_usb/README +0 -0
R x68k_usb/config_pjrc.h => converter/x68k_usb/config_pjrc.h +0 -0
R x68k_usb/keymap.c => converter/x68k_usb/keymap.c +0 -0
R x68k_usb/led.c => converter/x68k_usb/led.c +0 -0
R x68k_usb/matrix.c => converter/x68k_usb/matrix.c +0 -0
R x68k_usb/x68k.c => converter/x68k_usb/x68k.c +0 -0
R x68k_usb/x68k.h => converter/x68k_usb/x68k.h +0 -0
R hbk/Makefile => keyboard/hbk/Makefile +1 -1
@@ 2,7 2,7 @@
TARGET = hbk
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R hbk/config.h => keyboard/hbk/config.h +0 -0
R hbk/controller_teensy.h => keyboard/hbk/controller_teensy.h +0 -0
R hbk/keymap.c => keyboard/hbk/keymap.c +0 -0
R hbk/led.c => keyboard/hbk/led.c +0 -0
R hbk/matrix.c => keyboard/hbk/matrix.c +0 -0
R hhkb/Makefile.iwrap => keyboard/hhkb/Makefile.iwrap +1 -1
@@ 7,7 7,7 @@
TARGET = hhkb_iwrap
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R hhkb/Makefile.pjrc => keyboard/hhkb/Makefile.pjrc +1 -1
@@ 7,7 7,7 @@
TARGET = hhkb_pjrc
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R hhkb/Makefile.vusb => keyboard/hhkb/Makefile.vusb +1 -1
@@ 7,7 7,7 @@
TARGET = hhkb_vusb
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R hhkb/README => keyboard/hhkb/README +0 -0
R hhkb/config_iwrap.h => keyboard/hhkb/config_iwrap.h +0 -0
R hhkb/config_pjrc.h => keyboard/hhkb/config_pjrc.h +0 -0
R hhkb/config_vusb.h => keyboard/hhkb/config_vusb.h +0 -0
R hhkb/doc/Bluetooth.txt => keyboard/hhkb/doc/Bluetooth.txt +0 -0
R hhkb/doc/Bluetooth_img/.picasa.ini => keyboard/hhkb/doc/Bluetooth_img/.picasa.ini +0 -0
R hhkb/doc/Bluetooth_img/BT_circuit.jpg => keyboard/hhkb/doc/Bluetooth_img/BT_circuit.jpg +0 -0
R hhkb/doc/HHKB.txt => keyboard/hhkb/doc/HHKB.txt +0 -0
R hhkb/doc/HHKB_img/HHKB_TP1684.jpg => keyboard/hhkb/doc/HHKB_img/HHKB_TP1684.jpg +0 -0
R hhkb/doc/HHKB_img/HHKB_chart1.jpg => keyboard/hhkb/doc/HHKB_img/HHKB_chart1.jpg +0 -0
R hhkb/doc/HHKB_img/HHKB_chart2.jpg => keyboard/hhkb/doc/HHKB_img/HHKB_chart2.jpg +0 -0
R hhkb/doc/HHKB_img/HHKB_connector.jpg => keyboard/hhkb/doc/HHKB_img/HHKB_connector.jpg +0 -0
R hhkb/doc/HHKB_img/HHKB_controller.jpg => keyboard/hhkb/doc/HHKB_img/HHKB_controller.jpg +0 -0
R hhkb/doc/HHKB_img/HHKB_keyswitch.jpg => keyboard/hhkb/doc/HHKB_img/HHKB_keyswitch.jpg +0 -0
R hhkb/doc/HHKB_img/connector_contact.jpg => keyboard/hhkb/doc/HHKB_img/connector_contact.jpg +0 -0
R hhkb/doc/HHKB_img/logic_analyzer.jpg => keyboard/hhkb/doc/HHKB_img/logic_analyzer.jpg +0 -0
R hhkb/doc/HHKB_img/probe_contact.jpg => keyboard/hhkb/doc/HHKB_img/probe_contact.jpg +0 -0
R hhkb/doc/HHKB_img/teensy_install.jpg => keyboard/hhkb/doc/HHKB_img/teensy_install.jpg +0 -0
R hhkb/doc/HHKB_img/teensy_wiring.jpg => keyboard/hhkb/doc/HHKB_img/teensy_wiring.jpg +0 -0
R hhkb/keymap.c => keyboard/hhkb/keymap.c +0 -0
R hhkb/led.c => keyboard/hhkb/led.c +0 -0
R hhkb/matrix.c => keyboard/hhkb/matrix.c +0 -0
R hhkb/usbconfig.h => keyboard/hhkb/usbconfig.h +0 -0
R macway/Makefile => keyboard/macway/Makefile +1 -1
@@ 2,7 2,7 @@
TARGET = macway
# Directory common source filess exist
-TOP_DIR = ..
+TOP_DIR = ../..
# Directory keyboard dependent files exist
TARGET_DIR = .
R macway/config.h => keyboard/macway/config.h +0 -0
R macway/doc/back.jpg => keyboard/macway/doc/back.jpg +0 -0
R macway/doc/case.jpg => keyboard/macway/doc/case.jpg +0 -0
R macway/doc/keys.jpg => keyboard/macway/doc/keys.jpg +0 -0
R macway/doc/side.jpg => keyboard/macway/doc/side.jpg +0 -0
R macway/doc/switch.jpg => keyboard/macway/doc/switch.jpg +0 -0
R macway/doc/teensy.jpg => keyboard/macway/doc/teensy.jpg +0 -0
R macway/doc/wiring.jpg => keyboard/macway/doc/wiring.jpg +0 -0
R macway/doc/withHHKB.jpg => keyboard/macway/doc/withHHKB.jpg +0 -0
R macway/doc/withThinkPad.jpg => keyboard/macway/doc/withThinkPad.jpg +0 -0
R macway/keymap.c => keyboard/macway/keymap.c +0 -0
R macway/led.c => keyboard/macway/led.c +0 -0
R macway/matrix.c => keyboard/macway/matrix.c +0 -0
A protocol.mk => protocol.mk +2 -0
@@ 0,0 1,2 @@
+# Search Path
+VPATH += $(TOP_DIR)/protocol
