22b6e15a17
e5f9940 Merge commit '1bc3dd200b023cecf063a0cb3ba347f77f6d759d' into core_update da03c50 Add note for L/R side bit being ignored e80f3c1 Add in basic documentation for Macro system 35e8a76 core: Swap position of PEQL and PENT in unimap 00751f1 Merge pull request #406 from 39aldo39/patch-1 e50d7de V-USB remote wakeup 4340997 core: Fix typo in definition AC_g 958144d core: Debug print for system and consumer keys e7e1030 core: Fix sleep_led 0866323 core: Change matrix_init and matrix_print 0dbf73d core: Add matrix_clear() and default impl. 3202ca3 core: Add suspend mode options 4cda3aa core: Fix suspend/wake for converters #386 4e15247 core: LUFA_DEBUG_SUART for serial debug b9cf8e7 core: Fix mechanical locking supoort #390 12aa0fd Merge branch 'nemith-master' fccb3fa core: Fix OPT_DEFS for mbed build 2e2d2c8 Merge branch 'master' of github.com:leizzer/tmk_keyboard f1d3634 Change .gitignore for ChibiOS 3aab802 core: Fix build config in protocol.mk 5e43da0 core: Add short names in unimap 7a56998 core: Fix dfu wait in rules.mk 6d9c500 Merge branch 'mediakey-fix' 08382ac core: Fix 'make dfu' message 78cb04e Fix OS X Recognizing keyboard as Mouse/Tablet a114714 core: 'make dfu' waits for bootloader to start d0a8f13 core: Fix unimap UNIMAP_NO case e17abef core: Change lufa NKRO report size 16 to 32 bytes 375b20f core: Fix common.mk for build options 394fdff core: Fix unimap layout comment 912326c core: Add unimap support 00f4011 core: Fix doc/keymap.md for new keymap framework ddbd7b4 core: Add default implemenation of keymap read 671cacc core: action codes are action_t struct now b4fdb27 core: Change chibios repo directory names 7daed10 core: Fix keycode.txt 90399d7 core: Fix USB remote wakeup on ATmega32U2 #361 3677e84 usb_usb: Add multiple keyboard support 54d5b26 core: Fix Logical Maximum in report descriptor bd0d372 core: Fix LUFA report descriptor 95327b5 Merge pull request #355 from papodaca/XT 62bf548 core: change API of adb.c to accept device address 3097c9e Fix function name in host.h 836e209 Merge branch 'core_split_160522' 3918ea2 Merge commit '20b787fc1284176834cbe7ca2134e4b36bec5828' 7f87b11 core: Add comment of register 3 of ADB ef6478a core: Add adb_host_talk() 5c665b4 update macro names in bluefruit 4f2c5bf Merge commit '71381457fa1311dfa0b58ba882a96db740640871' 53a9c08 Merge pull request #321 from njbair/master f08a656 core: Fix media/consumer keys d526de8 Clean up wording in keymap example 0bb3dbb Clarify layer precedence d915c75 clarify layer documentation 72070d4 ps2_usb: Fix for VUSB configuration 170e2dc Mostly working. Is unstable, will emit bad codes after a while. c8e45b5 core: Actionmap support aabaa24 Codes appear to be detected correctly, the break codes are broken. git-subtree-dir: tmk_core git-subtree-split: e5f994033cbc8700745ac0c6d12772820492eed0
153 lines
5.2 KiB
Markdown
153 lines
5.2 KiB
Markdown
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>
|
|
|
|
|
|
Updates
|
|
-------
|
|
#### 2016/06/26
|
|
Keymap framework was updated. `fn_actions[]` should be defined as `action_t` instead of `uint16_t`. And default code for keymap handling is now included in core you just need define `uint8_t keymaps[][MATRIX_ROWS][MATRIX_COLS]` and `action_t fn_actions[]`.
|
|
|
|
#### 2016/02/10
|
|
flabbergast's Chibios protocol was merged from <https://github.com/flabbergast/tmk_keyboard/tree/chibios>. See [protocol/chibios/README.md](protocol/chibios/README.md). Chibios protocol supports Cortex-M such as STM32 and Kinetis.
|
|
|
|
#### 2015/04/22
|
|
separated with TMK Keyboard Firmware Collection
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
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](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.
|