[deliverable/linux.git] / Documentation / devicetree / bindings / input / matrix-keymap.txt

A simple common binding for matrix-connected key boards. Currently targeted at
defining the keys in the scope of linux key codes since that is a stable and
standardized interface at this time.

Required properties:
- linux,keymap: an array of packed 1-cell entries containing the equivalent
  of row, column and linux key-code. The 32-bit big endian cell is packed
  as:
	row << 24 | column << 16 | key-code

Optional properties:
Some users of this binding might choose to specify secondary keymaps for
cases where there is a modifier key such as a Fn key. Proposed names
for said properties are "linux,fn-keymap" or with another descriptive
word for the modifier other from "Fn".

Example:
	linux,keymap = < 0x00030012
			 0x0102003a >;
Commit	Line	Data
2cd36877 OJ	1	A simple common binding for matrix-connected key boards. Currently targeted at
	2	defining the keys in the scope of linux key codes since that is a stable and
	3	standardized interface at this time.
	4
	5	Required properties:
	6	- linux,keymap: an array of packed 1-cell entries containing the equivalent
	7	of row, column and linux key-code. The 32-bit big endian cell is packed
	8	as:
	9	row << 24 \| column << 16 \| key-code
	10
	11	Optional properties:
	12	Some users of this binding might choose to specify secondary keymaps for
	13	cases where there is a modifier key such as a Fn key. Proposed names
	14	for said properties are "linux,fn-keymap" or with another descriptive
	15	word for the modifier other from "Fn".
	16
	17	Example:
	18	linux,keymap = < 0x00030012
	19	0x0102003a >;