xref: /kernel/linux/linux-6.6/Documentation/devicetree/bindings/input/touchscreen/hycon,hy46xx.yaml

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/input/touchscreen/hycon,hy46xx.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Hycon HY46XX series touchscreen controller

description: |
  There are 6 variants of the chip for various touch panel sizes and cover lens material
   Glass: 0.3mm--4.0mm
    PET/PMMA: 0.2mm--2.0mm
    HY4613(B)-N048  < 6"
    HY4614(B)-N068  7" .. 10.1"
    HY4621-NS32  < 5"
    HY4623-NS48  5.1" .. 7"
   Glass: 0.3mm--8.0mm
    PET/PMMA: 0.2mm--4.0mm
    HY4633(B)-N048  < 6"
    HY4635(B)-N048  < 7" .. 10.1"

maintainers:
  - Giulio Benetti <giulio.benetti@benettiengineering.com>

allOf:
  - $ref: touchscreen.yaml#

properties:
  compatible:
    enum:
      - hycon,hy4613
      - hycon,hy4614
      - hycon,hy4621
      - hycon,hy4623
      - hycon,hy4633
      - hycon,hy4635

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  reset-gpios:
    maxItems: 1

  vcc-supply: true

  hycon,threshold:
    description: Allows setting the sensitivity in the range from 0 to 255.
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 0
    maximum: 255

  hycon,glove-enable:
    type: boolean
    description: Allows enabling glove setting.

  hycon,report-speed-hz:
    description: Allows setting the report speed in Hertz.
    minimum: 1
    maximum: 255

  hycon,noise-filter-enable:
    type: boolean
    description: Allows enabling power noise filter.

  hycon,filter-data:
    description: Allows setting how many samples throw before reporting touch
                 in the range from 0 to 5.
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 0
    maximum: 5

  hycon,gain:
    description: Allows setting the sensitivity distance in the range from 0 to 5.
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 0
    maximum: 5

  hycon,edge-offset:
    description: Allows setting the edge compensation in the range from 0 to 16.
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 0
    maximum: 16

  touchscreen-size-x: true
  touchscreen-size-y: true
  touchscreen-fuzz-x: true
  touchscreen-fuzz-y: true
  touchscreen-inverted-x: true
  touchscreen-inverted-y: true
  touchscreen-swapped-x-y: true
  interrupt-controller: true

additionalProperties: false

required:
  - compatible
  - reg
  - interrupts

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    i2c {
      #address-cells = <1>;
      #size-cells = <0>;
      touchscreen@1c {
        compatible = "hycon,hy4633";
        reg = <0x1c>;
        interrupt-parent = <&gpio2>;
        interrupts = <5 IRQ_TYPE_EDGE_FALLING>;
        reset-gpios = <&gpio2 6 GPIO_ACTIVE_LOW>;
      };
    };

...