diff options
| author | tmk <nobody@nowhere> | 2013-02-10 21:37:03 +0900 |
|---|---|---|
| committer | tmk <nobody@nowhere> | 2013-02-10 23:59:01 +0900 |
| commit | 0be309ccc6acae61616f89bcc43df5e02c4df92a (patch) | |
| tree | 8f7290da2a3026a9244a1526c9d01ab9c58741f6 /README.md | |
| parent | 74ecdd15a72ee344f3ae0c01cff52f5fee04a011 (diff) | |
| download | qmk_firmware-0be309ccc6acae61616f89bcc43df5e02c4df92a.tar.gz qmk_firmware-0be309ccc6acae61616f89bcc43df5e02c4df92a.zip | |
Add doc/keycode.txt
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 23 insertions, 3 deletions
| @@ -289,8 +289,7 @@ See `common/keycode.h`. Keycode is 8bit internal code to inidicate action perfor | |||
| 289 | 289 | ||
| 290 | **`KC_FNnn`** are `Fn` keys which not given any action at the beginning unlike most of keycodes has its own action. To use these keys in `KEYMAP` you need to assign action you want at first. Action of `Fn` is defined in `fn_actions[]` and index of the array is identical with number part of `KC_FNnn`. Thus `KC_FN0` designates action defined in first element of the array. ***32 `Fn` keys can be defined at most.*** | 290 | **`KC_FNnn`** are `Fn` keys which not given any action at the beginning unlike most of keycodes has its own action. To use these keys in `KEYMAP` you need to assign action you want at first. Action of `Fn` is defined in `fn_actions[]` and index of the array is identical with number part of `KC_FNnn`. Thus `KC_FN0` designates action defined in first element of the array. ***32 `Fn` keys can be defined at most.*** |
| 291 | 291 | ||
| 292 | See keycode table or `keycode.h` for other keycodes. | 292 | See [keycode table](doc/keycode.txt) in `doc/keycode.txt` or `common/keycode.h` for other keycodes. |
| 293 | ***TODO: Keycode table link here.*** | ||
| 294 | 293 | ||
| 295 | In regard to implementation side most of keycodes are identical with [HID usage] sent to host for real and some virtual keycodes are defined to support special actions. | 294 | In regard to implementation side most of keycodes are identical with [HID usage] sent to host for real and some virtual keycodes are defined to support special actions. |
| 296 | [HID usage]: http://www.usb.org/developers/devclass_docs/Hut1_11.pdf | 295 | [HID usage]: http://www.usb.org/developers/devclass_docs/Hut1_11.pdf |
| @@ -520,7 +519,28 @@ Files & Directories | |||
| 520 | * rules.mk - Makefile for build rules | 519 | * rules.mk - Makefile for build rules |
| 521 | 520 | ||
| 522 | ### Common | 521 | ### Common |
| 523 | ***TODO*** | 522 | * action.[ch] |
| 523 | * action_macro.[ch] | ||
| 524 | * bootloader.[ch] | ||
| 525 | * command.[ch] | ||
| 526 | * controller_teensy.h | ||
| 527 | * debug.[ch] | ||
| 528 | * host.[ch] | ||
| 529 | * host_driver.h | ||
| 530 | * keyboard.[ch] | ||
| 531 | * keycode.h | ||
| 532 | * keymap.[ch] | ||
| 533 | * led.h | ||
| 534 | * matrix.h | ||
| 535 | * mousekey.[ch] | ||
| 536 | * print.[ch] | ||
| 537 | * report.h | ||
| 538 | * sendchar.h | ||
| 539 | * sendchar_null.c | ||
| 540 | * sendchar_uart.c | ||
| 541 | * timer.[ch] | ||
| 542 | * uart.[ch] | ||
| 543 | * util.[ch] | ||
| 524 | 544 | ||
| 525 | ### Keyboard Protocols | 545 | ### Keyboard Protocols |
| 526 | * lufa/ - LUFA USB stack | 546 | * lufa/ - LUFA USB stack |
