git.gir.st - tmk_keyboard.git/blame_incremental

... / ...

Commit	Line	Data
	1	TMK Keyboard Firmware Collection
	2	================================
	3	This is a keyboard firmware with some useful features for Atmel AVR controller.
	4
	5	Source code is available here: <http://github.com/tmk/tmk_keyboard>
	6
	7
	8	Features
	9	--------
	10	These features can be used in your keyboard.
	11
	12	* Multi-layer Keymap - Multiple keyboard layouts with layer switching
	13	* Mouse key - Mouse control with keyboard
	14	* System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up
	15	* Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
	16	* USB NKRO - 120 keys(+ 8 modifiers) simultaneously
	17	* PS/2 mouse support - PS/2 mouse(TrackPoint) as composite device
	18	* Keyboard protocols - PS/2, ADB, M0110, Sun and other old keyboard protocols
	19	* User Function - Customizable function of key with writing code
	20	* Macro - Very primitive at this time
	21	* Keyboard Tricks - Oneshot modifier and modifier with tapping feature
	22	* Debug Console - Messages for debug and interaction with firmware
	23	* Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
	24	* Locking CapsLock - Mechanical switch support for CapsLock
	25	* Breathing Sleep LED - Sleep indicator with charm during USB suspend
	26	* Backlight - Control backlight levels
	27
	28
	29	Projects
	30	--------
	31	You can find some keyboard specific projects under `converter` and `keyboard` directory.
	32
	33	### converter
	34	* [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2]
	35	* [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb]
	36	* [m0110_usb](converter/m0110_usb) - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110]
	37	* [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
	38	* [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news]
	39	* [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
	40	* [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?)
	41	* [pc98_usb](converter/pc98_usb/) - [PC98] to USB
	42	* [usb_usb](converter/usb_usb/) - USB to USB(experimental)
	43	* [ascii_usb](converter/ascii_usb/) - ASCII(Serial console terminal) to USB
	44	* [ibm4704_usb](converter/ibm4704_usb) - [IBM 4704 keyboard Converter][GH_ibm4704]
	45
	46	### keyboard
	47	* [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard pro][GH_hhkb] my main board
	48	* [gh60](keyboard/gh60/) - [GH60] DIY 60% keyboard [prototype][GH60_proto] my second board
	49	* [hbkb](keyboard/hbkb/) - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
	50	* [hid_liber](keyboard/hid_liber/) - [HID liberation][HID_liber] controller (by alaricljs)
	51	* [phantom](keyboard/phantom/) - [Phantom] keyboard (by Tranquilite)
	52	* [IIgs_Standard](keyboard/IIgs/) - Apple [IIGS] keyboard mod(by JeffreySung)
	53	* [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway] [retired]
	54	* [KMAC](keyboard/kmac/) - Korean custom keyboard
	55	* [Lightsaber](keyboard/lightsaber/) - Korean custom keyboard
	56
	57	[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
	58	[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
	59	[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
	60	[GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
	61	[GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
	62	[GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
	63	[GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
	64	[GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
	65	[GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
	66	[GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
	67	[GH_ibm4704]: http://geekhack.org/index.php?topic=54706.0
	68	[HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
	69	[Phantom]: http://geekhack.org/index.php?topic=26742
	70	[GH60]: http://geekhack.org/index.php?topic=34959
	71	[GH60_proto]: http://geekhack.org/index.php?topic=37570.0
	72	[PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
	73	[Sun]: http://en.wikipedia.org/wiki/Sun-3
	74	[IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS
	75
	76
	77
	78	License
	79	-------
	80	GPLv2 or later. Some protocol files are under Modified BSD License.
	81	LUFA, PJRC and V-USB stack have their own license respectively.
	82
	83
	84
	85	Build Firmware and Program Controller
	86	-------------------------------------
	87	See [doc/build.md](doc/build.md).
	88
	89
	90
	91	Change your keymap
	92	------------------
	93	See [doc/keymap.md](doc/keymap.md).
	94
	95
	96
	97	Magic Commands
	98	--------------
	99	To see help press `Magic` + `H`.
	100
	101	`Magic` key bind may be `LShift` + `RShift` in many project, but `Power` key on ADB converter. `Magic` keybind can be vary on each project, check `config.h` in project directory.
	102
	103	Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
	104
	105	----- Command Help -----
	106	c: enter console mode
	107	d: toggle debug enable
	108	x: toggle matrix debug
	109	k: toggle keyboard debug
	110	m: toggle mouse debug
	111	v: print device version & info
	112	t: print timer count
	113	s: print status
	114	e: print eeprom config
	115	n: toggle NKRO
	116	0/F10: switch to Layer0
	117	1/F1: switch to Layer1
	118	2/F2: switch to Layer2
	119	3/F3: switch to Layer3
	120	4/F4: switch to Layer4
	121	PScr: power down/remote wake-up
	122	Caps: Lock Keyboard(Child Proof)
	123	Paus: jump to bootloader
	124
	125	TBD
	126
	127	### Boot Magic Configuration - Virtual DIP Switch
	128	Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable.
	129	Note that you must use keys of Layer 0 as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
	130
	131	To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be pressed along with the following configuration keys. The salt key is configurable in `config.h`. See [common/bootmagic.h](common/bootmagic.h).
	132
	133	#### General
	134	- Skip reading EEPROM to start with default configuration(`ESC`)
	135	- Clear configuration stored in EEPROM to reset configuration(`Backspace`)
	136
	137	#### Bootloader
	138	- Kick up Bootloader(`B`)
	139
	140	#### Debug
	141	- Debug enable(`D`)
	142	- Debug matrix enable(`D`+`X`)
	143	- Debug keyboard enable(`D`+`K`)
	144	- Debug mouse enable(`D`+`M`)
	145
	146	#### Keymap
	147	- Swap Control and CapsLock(`Left Control`)
	148	- Change CapsLock to Control(`Caps Lock`)
	149	- Swap LeftAlt and Gui(`Left Alt`)
	150	- Swap RightAlt and Gui(`Right Alt`)
	151	- Disable Gui(`Left Gui`)
	152	- Swap Grave and Escape(`Grave`)
	153	- Swap BackSlash and BackSpace(`Back Slash`)
	154
	155	#### Default Layer
	156	- Set Default Layer to 0(`0`)
	157	- Set Default Layer to 1(`1`)
	158	- Set Default Layer to 2(`2`)
	159	- Set Default Layer to 3(`3`)
	160	- Set Default Layer to 4(`4`)
	161	- Set Default Layer to 5(`5`)
	162	- Set Default Layer to 6(`6`)
	163	- Set Default Layer to 7(`7`)
	164
	165	#### Caution
	166	Unintentional use of this feature will cause user confusion.
	167
	168	TODO: Magic key combination to avoid unintentional press during plug in
	169
	170	TBD
	171
	172
	173	Mechanical Locking support
	174	--------------------------
	175	This feature makes it possible for you to use mechanical switch for `CapsLock`, `NumLock` or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LNUM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Resync option tries to keep lock switch state consistent with keyboard LED state.
	176
	177	#define LOCKING_SUPPORT_ENABLE
	178	#define LOCKING_RESYNC_ENABLE
	179
	180
	181	Start Your Own Project
	182	-----------------------
	183	TBD
	184	### Config.h Options
	185	#### 1. USB vendor/product ID and device description
	186	#define VENDOR_ID 0xFEED
	187	#define PRODUCT_ID 0xBEEF
	188	#define MANUFACTURER t.m.k.
	189	#define PRODUCT Macway mod
	190	#define DESCRIPTION t.m.k. keyboard firmware for Macway mod
	191
	192	#### 2. Keyboard matrix configuration
	193	#define MATRIX_ROWS 8
	194	#define MATRIX_COLS 8
	195	#define MATRIX_HAS_GHOST
	196
	197
	198
	199	Architecture
	200	------------
	201	Architecture Diagram
	202	+---------------+---------------+-------------+
	203	\| Host \| Keyboard \| Matrix, LED \|
	204	___________ \|-----------+-+ +-------------+ \| +-----------\|
	205	/ /\| Keys/Mouse \| Protocol \|d\| \| Action \| \| \| Protocol \|
	206	/__________/ \|<-----------\| LUFA \|r\| \| Layer, Tap \| \| \| Matrix \|
	207	\|.--------.\| \| LED \| V-USB \|i\| \|-------------\| \| \| PS/2,IBM \| __________________
	208	\|\| \|\| \|----------->\| PJRC \|v\| \| Keymap \| \| \| ADB,M0110\| Keys / /_/_/_/_/_/_/_/ /\|
	209	\|\| Host \|\| \| Console \| iWRAP(BT)\|e\| \| Mousekey \| \| \| SUN/NEWS \|<----------/ /_/_/_/_/_/_/_/ / /
	210	\|\|________\|\|/.<-----------\| UART \|r\| \| Report \| \| \| X68K/PC98\| Control / /_/_/_/_/_/_/_/ / /
	211	`_========_'/\| \|---------------------------------------------\|-------->/___ /_______/ ___/ /
	212	\|_o______o_\|/ \| Sendchar, Print, Debug, Command, ... \| \|_________________\|/
	213	+---------------------------------------------+ Keyboard
	214
	215
	216
	217	Debugging
	218	--------
	219	Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
	220
	221	You can use xprintf() to display debug info on `hid_listen`, see `common/xprintf.h`.
	222
	223
	224
	225	Files and Directories
	226	-------------------
	227	### Top
	228	* common/ - common codes
	229	* protocol/ - keyboard protocol support
	230	* keyboard/ - keyboard projects
	231	* converter/ - protocol converter projects
	232	* doc/ - documents
	233	* common.mk - Makefile for common
	234	* protocol.mk - Makefile for protocol
	235	* rules.mk - Makefile for build rules
	236
	237	### Common
	238	* host.h
	239	* host_driver.h
	240	* keyboard.h
	241	* command.h
	242	* keymap.h
	243	* action.h
	244	* keycode.h
	245	* matrix.h
	246	* led.h
	247	* mousekey.h
	248	* report.h
	249	* debug.h
	250	* print.h
	251	* bootloader.h
	252	* sendchar.h
	253	* timer.h
	254	* util.h
	255
	256	### Keyboard Protocols
	257	* lufa/ - LUFA USB stack
	258	* pjrc/ - PJRC USB stack
	259	* vusb/ - Objective Development V-USB
	260	* iwrap/ - Bluetooth HID for Bluegiga iWRAP
	261	* ps2.c - PS/2 protocol
	262	* adb.c - Apple Desktop Bus protocol
	263	* m0110.c - Macintosh 128K/512K/Plus keyboard protocol
	264	* news.c - Sony NEWS keyboard protocol
	265	* x68k.c - Sharp X68000 keyboard protocol
	266	* serial_soft.c - Asynchronous Serial protocol implemented by software
	267
	268
	269
	270	Coding Style
	271	-------------
	272	- Doesn't use Tab to indent, use 4-spaces instead.
	273
	274
	275
	276	Other Keyboard Firmware Projects
	277	------------------
	278	See [doc/other_projects.md](doc/other_projects.md).