mirror of
https://github.com/Keychron/qmk_firmware.git
synced 2024-11-24 01:17:07 +06:00
39bd760faf
* Unify multiple HID interfaces into one This reduces the number of USB endpoints required, which frees them up for other things. NKRO and EXTRAKEY always use the shared endpoint. By default, MOUSEKEY also uses it. This means it won't work as a Boot Procotol mouse in some BIOSes, etc. If you really think your keyboard needs to work as a mouse in your BIOS, set MOUSE_SHARED_EP = no in your rules.mk. By default, the core keyboard does not use the shared endpoint, as not all BIOSes are standards compliant and that's one place you don't want to find out your keyboard doesn't work.. If you are really confident, you can set KEYBOARD_SHARED_EP = yes to use the shared endpoint here too. * unify endpoints: ChibiOS protocol implementation * fixup: missing #ifdef EXTRAKEY_ENABLEs broke build on AVR with EXTRAKEY disabled * endpoints: restore error when too many endpoints required * lufa: wait up to 10ms to send keyboard input This avoids packets being dropped when two reports are sent in quick succession (eg. releasing a dual role key). * endpoints: fix compile on ARM_ATSAM * endpoint: ARM_ATSAM fixes No longer use wrong or unexpected endpoint IDs * endpoints: accommodate VUSB protocol V-USB has its own, understandably simple ideas about the report formats. It already blasts the mouse and extrakeys through one endpoint with report IDs. We just stay out of its way. * endpoints: document new endpoint configuration options * endpoints: respect keyboard_report->mods in NKRO The caller(s) of host_keyboard_send expect to be able to just drop modifiers in the mods field and not worry about whether NKRO is in use. This is a good thing. So we just shift it over if needs be. * endpoints: report.c: update for new keyboard_report format |
||
|---|---|---|
| .. | ||
| common | ||
| protocol | ||
| tool/chibios | ||
| .gitignore | ||
| .gitmodules | ||
| arm_atsam.mk | ||
| avr.mk | ||
| chibios.mk | ||
| common.mk | ||
| ldscript_keymap_avr5.x | ||
| ldscript_keymap_avr35.x | ||
| native.mk | ||
| protocol.mk | ||
| readme.md | ||
| ring_buffer.h | ||
| rules.mk | ||
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/master/tmk_core
Updates
2016/02/10
flabbergast's Chibios protocol was merged from https://github.com/flabbergast/tmk_keyboard/tree/chibios. See 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 - 248 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.
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.