Documentation/devicetree/bindings/input/rmi4/rmi_2d_sensor.txt

   1 Synaptics RMI4 2D Sensor Device Binding
   2
   3 The Synaptics RMI4 core is able to support RMI4 devices using different
   4 transports and different functions. This file describes the device tree
   5 bindings for devices which contain 2D sensors using Function 11 or
   6 Function 12. Complete documentation for transports and other functions
   7 can be found in:
   8 Documentation/devicetree/bindings/input/rmi4.
   9
  10 RMI4 Function 11 and Function 12 are for 2D touch position sensing.
  11 Additional documentation for F11 can be found at:
  12 http://www.synaptics.com/sites/default/files/511-000136-01-Rev-E-RMI4-Interfacing-Guide.pdf
  13
  14 Optional Touch Properties:
  15 Description in Documentation/devicetree/bindings/input/touch
  16 - touchscreen-inverted-x
  17 - touchscreen-inverted-y
  18 - touchscreen-swapped-x-y
  19 - touchscreen-x-mm
  20 - touchscreen-y-mm
  21
  22 Optional Properties:
  23 - syna,clip-x-low: Sets a minimum value for X.
  24 - syna,clip-y-low: Sets a minimum value for Y.
  25 - syna,clip-x-high: Sets a maximum value for X.
  26 - syna,clip-y-high: Sets a maximum value for Y.
  27 - syna,offset-x: Add an offset to X.
  28 - syna,offset-y: Add an offset to Y.
  29 - syna,delta-x-threshold: Set the minimum distance on the X axis required
  30                                 to generate an interrupt in reduced reporting
  31                                 mode.
  32 - syna,delta-y-threshold: Set the minimum distance on the Y axis required
  33                                 to generate an interrupt in reduced reporting
  34                                 mode.
  35 - syna,sensor-type: Set the sensor type. 1 for touchscreen 2 for touchpad.
  36 - syna,disable-report-mask: Mask for disabling posiiton reporting. Used to
  37                                 disable reporing absolute position data.
  38 - syna,rezero-wait-ms: Time in miliseconds to wait after issuing a rezero
  39                                 command.
  40
  41
  42 Example of a RMI4 I2C device with F11:
  43 Example:
  44         &i2c1 {
  45                 rmi4-i2c-dev@2c {
  46                         compatible = "syna,rmi4-i2c";
  47
  48                         ...
  49
  50                         rmi4-f11@11 {
  51                                 reg = <0x11>;
  52                                 touchscreen-inverted-y;
  53                                 syna,sensor-type = <2>;
  54                         };
  55                 };
  56         };