Documentation/devicetree/bindings/input/touchscreen/edt-ft5x06.yaml

   1 # SPDX-License-Identifier: GPL-2.0
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/input/touchscreen/edt-ft5x06.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: FocalTech EDT-FT5x06 Polytouch
   8
   9 description: |
  10              There are 5 variants of the chip for various touch panel sizes
  11               FT5206GE1  2.8" .. 3.8"
  12               FT5306DE4  4.3" .. 7"
  13               FT5406EE8  7"   .. 8.9"
  14               FT5506EEG  7"   .. 8.9"
  15               FT5726NEI  5.7” .. 11.6"
  16
  17 maintainers:
  18   - Dmitry Torokhov <dmitry.torokhov@gmail.com>
  19
  20 allOf:
  21   - $ref: touchscreen.yaml#
  22   - if:
  23       properties:
  24         compatible:
  25           contains:
  26             enum:
  27               - evervision,ev-ft5726
  28
  29     then:
  30       properties:
  31         offset-x: true
  32         offset-y: true
  33
  34 properties:
  35   compatible:
  36     enum:
  37       - edt,edt-ft5206
  38       - edt,edt-ft5306
  39       - edt,edt-ft5406
  40       - edt,edt-ft5506
  41       - evervision,ev-ft5726
  42       - focaltech,ft5426
  43       - focaltech,ft5452
  44       - focaltech,ft6236
  45       - focaltech,ft8201
  46       - focaltech,ft8719
  47
  48   reg:
  49     maxItems: 1
  50
  51   interrupts:
  52     maxItems: 1
  53
  54   reset-gpios:
  55     maxItems: 1
  56
  57   wake-gpios:
  58     maxItems: 1
  59
  60   wakeup-source: true
  61
  62   vcc-supply: true
  63   iovcc-supply: true
  64
  65   gain:
  66     description: Allows setting the sensitivity in the range from 0 to 31.
  67                  Note that lower values indicate higher sensitivity.
  68     $ref: /schemas/types.yaml#/definitions/uint32
  69     minimum: 0
  70     maximum: 31
  71
  72   offset:
  73     description: Allows setting the edge compensation in the range from 0 to 31.
  74     $ref: /schemas/types.yaml#/definitions/uint32
  75     minimum: 0
  76     maximum: 31
  77
  78   offset-x:
  79     description: Same as offset, but applies only to the horizontal position.
  80                  Range from 0 to 80, only supported by evervision,ev-ft5726 devices.
  81     $ref: /schemas/types.yaml#/definitions/uint32
  82     minimum: 0
  83     maximum: 80
  84
  85   offset-y:
  86     description: Same as offset, but applies only to the vertical position.
  87                  Range from 0 to 80, only supported by evervision,ev-ft5726 devices.
  88     $ref: /schemas/types.yaml#/definitions/uint32
  89     minimum: 0
  90     maximum: 80
  91
  92   report-rate-hz:
  93     description: |
  94                  Allows setting the scan rate in Hertz.
  95                   M06 supports range from 30 to 140 Hz.
  96                   M12 supports range from 1 to 255 Hz.
  97     minimum: 1
  98     maximum: 255
  99
 100   threshold:
 101     description: Allows setting the  "click"-threshold in the range from 0 to 255.
 102     $ref: /schemas/types.yaml#/definitions/uint32
 103     minimum: 0
 104     maximum: 255
 105
 106   touchscreen-size-x: true
 107   touchscreen-size-y: true
 108   touchscreen-fuzz-x: true
 109   touchscreen-fuzz-y: true
 110   touchscreen-inverted-x: true
 111   touchscreen-inverted-y: true
 112   touchscreen-swapped-x-y: true
 113   interrupt-controller: true
 114
 115 additionalProperties: false
 116
 117 required:
 118   - compatible
 119   - reg
 120   - interrupts
 121
 122 examples:
 123   - |
 124     #include <dt-bindings/gpio/gpio.h>
 125     #include <dt-bindings/interrupt-controller/arm-gic.h>
 126     i2c {
 127       #address-cells = <1>;
 128       #size-cells = <0>;
 129       touchscreen@38 {
 130         compatible = "edt,edt-ft5406";
 131         reg = <0x38>;
 132         interrupt-parent = <&gpio2>;
 133         interrupts = <5 IRQ_TYPE_EDGE_FALLING>;
 134         reset-gpios = <&gpio2 6 GPIO_ACTIVE_LOW>;
 135         wake-gpios = <&gpio4 9 GPIO_ACTIVE_HIGH>;
 136       };
 137     };
 138
 139 ...