Bindings/input/gpio-mouse.yaml

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

title: GPIO attached mouse

description: |
  This simply uses standard GPIO handles to define a simple mouse connected
  to 5-7 GPIO lines.

maintainers:
  - Anshul Dalal <anshulusr@gmail.com>

properties:
  compatible:
    const: gpio-mouse

  scan-interval-ms:
    maxItems: 1

  up-gpios:
    maxItems: 1

  down-gpios:
    maxItems: 1

  left-gpios:
    maxItems: 1

  right-gpios:
    maxItems: 1

  button-left-gpios:
    maxItems: 1

  button-middle-gpios:
    maxItems: 1

  button-right-gpios:
    maxItems: 1

required:
  - compatible
  - scan-interval-ms
  - up-gpios
  - down-gpios
  - left-gpios
  - right-gpios

additionalProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>

    gpio-mouse {
        compatible = "gpio-mouse";
        scan-interval-ms = <50>;
        up-gpios = <&gpio0 0 GPIO_ACTIVE_LOW>;
        down-gpios = <&gpio0 1 GPIO_ACTIVE_LOW>;
        left-gpios = <&gpio0 2 GPIO_ACTIVE_LOW>;
        right-gpios = <&gpio0 3 GPIO_ACTIVE_LOW>;
        button-left-gpios = <&gpio0 4 GPIO_ACTIVE_LOW>;
        button-middle-gpios = <&gpio0 5 GPIO_ACTIVE_LOW>;
        button-right-gpios = <&gpio0 6 GPIO_ACTIVE_LOW>;
    };