History

Jun Wako 8bcddd24f7 Fix drop key stroke Keyboard report should be checked if its transfer finishs successfully. Otherwise key stroke can be missing when other key event occurs before the last report transfer is done. Boot protocol 10ms interval probably causes this problem in case it receives key events in a row within the period. NKRO protocol suffers less or nothing due to its interval 1ms.		2015-10-17 15:28:21 +09:00
..
common	Chibios: use WFI in idle. WIP suspend stuff.	2015-10-14 10:13:49 +01:00
doc	Fix URL of HID Usage Tables pdf	2015-04-23 17:30:45 +09:00
protocol	Fix drop key stroke	2015-10-17 15:28:21 +09:00
tool	Move chibios/cortex selection to local Makefiles.	2015-10-12 10:38:47 +01:00
.gitignore	Merge commit 'a074364c3731d66b56d988c8a6c960a83ea0e0a1' as 'tmk_core'	2015-04-10 01:32:04 +09:00
.gitmodules	Merge commit 'f6d56675f9f981c5464f0ca7a1fbb0162154e8c5'	2015-05-13 11:13:10 +09:00
common.mk	Move AVR specific sleep_led.c into avr.	2015-09-10 10:30:49 +01:00
ldscript_keymap_avr5.x	core: Add keymap section ldscript for ATMega32U2	2015-07-12 05:44:10 +09:00
ldscript_keymap_avr35.x	core: Add keymap section ldscript for ATMega32U2	2015-07-12 05:44:10 +09:00
protocol.mk	Merge commit '4d116a04e94cf0d19317d5b44e4fa9f34a3e5594'	2015-04-28 11:27:10 +09:00
README.md	Merge commit 'a20ef7052c6e937d2f7672dd59456e55a5c08296' into master_ng	2015-04-22 13:29:13 +09:00
ring_buffer.h	Move ring_buffer.h file	2015-04-22 14:35:20 +09:00
rules.mk	Add compile options '-fdata-sections'	2015-05-10 10:01:16 +09:00

README.md

TMK Keyboard Firmware Core Library

This is a keyboard firmware library with some useful features for Atmel AVR and Cortex-M.

Source code is available here: https://github.com/tmk/tmk_keyboard/tree/core

Features

These features can be used in your keyboard.

Multi-layer Keymap - Multiple keyboard layouts with layer switching
Mouse key - Mouse control with 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 - 120 keys(+ 8 modifiers) simultaneously
PS/2 mouse support - PS/2 mouse(TrackPoint) as composite device
Keyboard protocols - PS/2, ADB, M0110, Sun and other old keyboard protocols
User Function - Customizable function of key with writing code
Macro - Very primitive at this time
Keyboard Tricks - Oneshot modifier and modifier with tapping feature
Debug Console - Messages for debug and interaction with firmware
Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
Locking CapsLock - Mechanical switch support for CapsLock
Breathing Sleep LED - Sleep indicator with charm during USB suspend
Backlight - Control backlight levels

Updates

2015/04/22 separated with TMK Keyboard Firmware Collection

TMK Keyboard Firmware Collection

Complete firmwares for various keyboards and protocol converters.

https://github.com/tmk/tmk_keyboard

License

GPLv2 or later. Some protocol files are under Modified BSD License. LUFA, PJRC and V-USB stack have their own license respectively.

Build Firmware and Program Controller

See doc/build.md.

Start Your Own Project

TBD

Config.h Options

1. USB vendor/product ID and device description

#define VENDOR_ID       0xFEED
#define PRODUCT_ID      0xBEEF
#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

Architecture

Architecture Diagram
                           +---------------+---------------+-------------+
                           |    Host       |   Keyboard    | Matrix, LED |
   ___________             |-----------+-+ +-------------+ | +-----------|
  /          /| Keys/Mouse | Protocol  |d| | Action      | | | Protocol  |
 /__________/ |<-----------|  LUFA     |r| |  Layer, Tap | | |  Matrix   |
 |.--------.| |   LED      |  V-USB    |i| |-------------| | |  PS/2,IBM |             __________________
 ||        || |----------->|  PJRC     |v| | Keymap      | | |  ADB,M0110|  Keys      / /_/_/_/_/_/_/_/ /|
 ||  Host  || |  Console   |  iWRAP(BT)|e| | Mousekey    | | |  SUN/NEWS |<----------/ /_/_/_/_/_/_/_/ / /
 ||________||/.<-----------|  UART     |r| | Report      | | |  X68K/PC98| Control  / /_/_/_/_/_/_/_/ / /
 `_========_'/|            |---------------------------------------------|-------->/___ /_______/ ___/ /
 |_o______o_|/             | Sendchar, Print, Debug, Command, ...        |         |_________________|/
                           +---------------------------------------------+              Keyboard

Debugging

Use PJRC's hid_listen to see debug messages. You can use the tool for debug even if firmware use LUFA stack.

You can use xprintf() to display debug info on hid_listen, see common/xprintf.h.

Files and Directories

Top

common/ - common codes
protocol/ - keyboard protocol support
doc/ - documents
common.mk - Makefile for common
protocol.mk - Makefile for protocol
rules.mk - Makefile for build rules

Common

host.h
host_driver.h
keyboard.h
command.h
keymap.h
action.h
keycode.h
matrix.h
led.h
mousekey.h
report.h
debug.h
print.h
bootloader.h
sendchar.h
timer.h
util.h

Keyboard Protocols

lufa/ - LUFA USB stack
pjrc/ - PJRC USB stack
vusb/ - Objective Development V-USB
iwrap/ - Bluetooth HID for Bluegiga iWRAP
ps2.c - PS/2 protocol
adb.c - Apple Desktop Bus protocol
m0110.c - Macintosh 128K/512K/Plus keyboard protocol
news.c - Sony NEWS keyboard protocol
x68k.c - Sharp X68000 keyboard protocol
serial_soft.c - Asynchronous Serial protocol implemented by software

Coding Style

Doesn't use Tab to indent, use 4-spaces instead.