Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input

NXP LPC32xx Key Scan Interface

Required Properties:

- compatible: Should be "nxp,lpc3220-key"

- reg: Physical base address of the controller and length of memory mapped

  region.

- interrupts: The interrupt number to the cpu.

- keypad,num-rows: Number of rows and columns, e.g. 1: 1x1, 6: 6x6

- keypad,num-columns: Must be equal to keypad,num-rows since LPC32xx only

  supports square matrices

- nxp,debounce-delay-ms: Debounce delay in ms

- nxp,scan-delay-ms: Repeated scan period in ms

- linux,keymap: the key-code to be reported when the key is pressed

  and released, see also

  Documentation/devicetree/bindings/input/matrix-keymap.txt

Example:

	key@40050000 {

		compatible = "nxp,lpc3220-key";

		reg = <0x40050000 0x1000>;

		interrupts = <54 0>;

		keypad,num-rows = <1>;

		keypad,num-columns = <1>;

		nxp,debounce-delay-ms = <3>;

		nxp,scan-delay-ms = <34>;

		linux,keymap = <0x00000002>;

	};

* TI's Keypad Controller device tree bindings

TI's Keypad controller is used to interface a SoC with a matrix-type

keypad device. The keypad controller supports multiple row and column lines.

A key can be placed at each intersection of a unique row and a unique column.

The keypad controller can sense a key-press and key-release and report the

event using a interrupt to the cpu.

Required SoC Specific Properties:

- compatible: should be one of the following

   - "ti,omap4-keypad": For controllers compatible with omap4 keypad

      controller.

Required Board Specific Properties, in addition to those specified by

the shared matrix-keyboard bindings:

- keypad,num-rows: Number of row lines connected to the keypad

  controller.

- keypad,num-columns: Number of column lines connected to the

  keypad controller.

Optional Properties specific to linux:

- linux,keypad-no-autorepeat: do no enable autorepeat feature.

Example:

	keypad@4ae1c000{

		compatible = "ti,omap4-keypad";

		keypad,num-rows = <2>;

		keypad,num-columns = <8>;

		linux,keypad-no-autorepeat;

	};

Vibra driver for the twl6040 family

The vibra driver is a child of the twl6040 MFD dirver.

Documentation/devicetree/bindings/mfd/twl6040.txt

Required properties:

- compatible : Must be "ti,twl6040-vibra";

- interrupts: 4, Vibra overcurrent interrupt

- vddvibl-supply: Regulator supplying the left vibra motor

- vddvibr-supply: Regulator supplying the right vibra motor

- vibldrv_res: Board specific left driver resistance

- vibrdrv_res: Board specific right driver resistance

- viblmotor_res: Board specific left motor resistance

- vibrmotor_res: Board specific right motor resistance

Optional properties:

- vddvibl_uV: If the vddvibl default voltage need to be changed

- vddvibr_uV: If the vddvibr default voltage need to be changed

Example:

/*

 * 8-channel high quality low-power audio codec

 * http://www.ti.com/lit/ds/symlink/twl6040.pdf

 */

twl6040: twl6040@4b {

	...

	twl6040_vibra: twl6040@1 {

		compatible = "ti,twl6040-vibra";

		interrupts = <4>;

		vddvibl-supply = <&vbat>;

		vddvibr-supply = <&vbat>;

		vibldrv_res = <8>;

		vibrdrv_res = <3>;

		viblmotor_res = <10>;

		vibrmotor_res = <10>;

	};

};

minimum set consists of ABS_MT_POSITION_X and ABS_MT_POSITION_Y, which

allows for multiple contacts to be tracked.  If the device supports it, the

ABS_MT_TOUCH_MAJOR and ABS_MT_WIDTH_MAJOR may be used to provide the size

of the contact area and approaching contact, respectively.

of the contact area and approaching tool, respectively.

The TOUCH and WIDTH parameters have a geometrical interpretation; imagine

looking through a window at someone gently holding a finger against the

glass.  You will see two regions, one inner region consisting of the part

of the finger actually touching the glass, and one outer region formed by

the perimeter of the finger. The diameter of the inner region is the

ABS_MT_TOUCH_MAJOR, the diameter of the outer region is

ABS_MT_WIDTH_MAJOR. Now imagine the person pressing the finger harder

against the glass. The inner region will increase, and in general, the

ratio ABS_MT_TOUCH_MAJOR / ABS_MT_WIDTH_MAJOR, which is always smaller than

unity, is related to the contact pressure. For pressure-based devices,

the perimeter of the finger. The center of the touching region (a) is

ABS_MT_POSITION_X/Y and the center of the approaching finger (b) is

ABS_MT_TOOL_X/Y. The touch diameter is ABS_MT_TOUCH_MAJOR and the finger

diameter is ABS_MT_WIDTH_MAJOR. Now imagine the person pressing the finger

harder against the glass. The touch region will increase, and in general,

the ratio ABS_MT_TOUCH_MAJOR / ABS_MT_WIDTH_MAJOR, which is always smaller

than unity, is related to the contact pressure. For pressure-based devices,

ABS_MT_PRESSURE may be used to provide the pressure on the contact area

instead. Devices capable of contact hovering can use ABS_MT_DISTANCE to

indicate the distance between the contact and the surface.

In addition to the MAJOR parameters, the oval shape of the contact can be

described by adding the MINOR parameters, such that MAJOR and MINOR are the

major and minor axis of an ellipse. Finally, the orientation of the oval

shape can be describe with the ORIENTATION parameter.

	  Linux MT                               Win8

         __________                     _______________________

        /          \                   |                       |

       /            \                  |                       |

      /     ____     \                 |                       |

     /     /    \     \                |                       |

     \     \  a  \     \               |       a               |

      \     \____/      \              |                       |

       \                 \             |                       |

        \        b        \            |           b           |

         \                 \           |                       |

          \                 \          |                       |

           \                 \         |                       |

            \                /         |                       |

             \              /          |                       |

              \            /           |                       |

               \__________/            |_______________________|

In addition to the MAJOR parameters, the oval shape of the touch and finger

regions can be described by adding the MINOR parameters, such that MAJOR

and MINOR are the major and minor axis of an ellipse. The orientation of

the touch ellipse can be described with the ORIENTATION parameter, and the

direction of the finger ellipse is given by the vector (a - b).

For type A devices, further specification of the touch shape is possible

via ABS_MT_BLOB_ID.

The above four values can be used to derive additional information about

the contact. The ratio ABS_MT_TOUCH_MAJOR / ABS_MT_WIDTH_MAJOR approximates

the notion of pressure. The fingers of the hand and the palm all have

different characteristic widths [1].

different characteristic widths.

ABS_MT_PRESSURE

ABS_MT_ORIENTATION

The orientation of the ellipse. The value should describe a signed quarter

of a revolution clockwise around the touch center. The signed value range

is arbitrary, but zero should be returned for a finger aligned along the Y

axis of the surface, a negative value when finger is turned to the left, and

a positive value when finger turned to the right. When completely aligned with

the X axis, the range max should be returned.  Orientation can be omitted

if the touching object is circular, or if the information is not available

in the kernel driver. Partial orientation support is possible if the device

can distinguish between the two axis, but not (uniquely) any values in

between. In such cases, the range of ABS_MT_ORIENTATION should be [0, 1]

[4].

The orientation of the touching ellipse. The value should describe a signed

quarter of a revolution clockwise around the touch center. The signed value

range is arbitrary, but zero should be returned for an ellipse aligned with

the Y axis of the surface, a negative value when the ellipse is turned to

the left, and a positive value when the ellipse is turned to the

right. When completely aligned with the X axis, the range max should be

returned.

Touch ellipsis are symmetrical by default. For devices capable of true 360

degree orientation, the reported orientation must exceed the range max to

indicate more than a quarter of a revolution. For an upside-down finger,

range max * 2 should be returned.

Orientation can be omitted if the touch area is circular, or if the

information is not available in the kernel driver. Partial orientation

support is possible if the device can distinguish between the two axis, but

not (uniquely) any values in between. In such cases, the range of

ABS_MT_ORIENTATION should be [0, 1] [4].

ABS_MT_POSITION_X

The surface Y coordinate of the center of the touching ellipse.

ABS_MT_TOOL_X

The surface X coordinate of the center of the approaching tool. Omit if

the device cannot distinguish between the intended touch point and the

tool itself.

ABS_MT_TOOL_Y

The surface Y coordinate of the center of the approaching tool. Omit if the

device cannot distinguish between the intended touch point and the tool

itself.

The four position values can be used to separate the position of the touch

from the position of the tool. If both positions are present, the major

tool axis points towards the touch point [1]. Otherwise, the tool axes are

aligned with the touch axes.

ABS_MT_TOOL_TYPE

The type of approaching tool. A lot of kernel drivers cannot distinguish

the device can distinguish between a finger along the Y axis (0) and a

finger along the X axis (1).

For win8 devices with both T and C coordinates, the position mapping is

   ABS_MT_POSITION_X := T_X

   ABS_MT_POSITION_Y := T_Y

   ABS_MT_TOOL_X := C_X

   ABS_MT_TOOL_X := C_Y

Unfortunately, there is not enough information to specify both the touching

ellipse and the tool ellipse, so one has to resort to approximations.  One

simple scheme, which is compatible with earlier usage, is:

   ABS_MT_TOUCH_MAJOR := min(X, Y)

   ABS_MT_TOUCH_MINOR := <not used>

   ABS_MT_ORIENTATION := <not used>

   ABS_MT_WIDTH_MAJOR := min(X, Y) + distance(T, C)

   ABS_MT_WIDTH_MINOR := min(X, Y)

Rationale: We have no information about the orientation of the touching

ellipse, so approximate it with an inscribed circle instead. The tool

ellipse should align with the the vector (T - C), so the diameter must

increase with distance(T, C). Finally, assume that the touch diameter is

equal to the tool thickness, and we arrive at the formulas above.

Finger Tracking

---------------

For example usage of the type A protocol, see the bcm5974 driver. For

example usage of the type B protocol, see the hid-egalax driver.

[1] With the extension ABS_MT_APPROACH_X and ABS_MT_APPROACH_Y, the

difference between the contact position and the approaching tool position

could be used to derive tilt.

[1] Also, the difference (TOOL_X - POSITION_X) can be used to model tilt.

[2] The list can of course be extended.

[3] The mtdev project: http://bitmath.org/code/mtdev/.

[4] See the section on event computation.

 * keymap: pointer to keymap data (table and size)

 * rep: enables key autorepeat

 * mode: choose keyboard support(9x9, 6x6, 2x2)

 * suspended_rate: rate at which keyboard would operate in suspended mode

 *

 * This structure is supposed to be used by platform code to supply

 * keymaps to drivers that implement keyboards.

	const struct matrix_keymap_data *keymap;

	bool rep;

	unsigned int mode;

	unsigned int suspended_rate;

};

#endif /* __PLAT_KEYBOARD_H */