# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/proximity/pulsedlight,lidar-lite-v2.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Pulsedlight/Garmin LIDAR-Lite range-finding sensors

maintainers:
  - Matt Ranostay <matt@ranostay.sg>
  - Rodrigo Gobbi <rodrigo.gobbi.7@gmail.com>

description: |
  This binding covers the I2C interface of the Pulsedlight/Garmin
  LIDAR-Lite v2 and v3 laser rangefinders.

  Besides I2C, the mode control pin can also trigger acquisitions and
  report the measured distance through a PWM signal, without using I2C
  at all. That usage is bidirectional and non-cyclic, and is not
  described by this binding. The same pin can also be used, while I2C
  remains the active interface, as a plain status output signalling
  when an acquisition has completed.

  Datasheets:
    https://static.garmin.com/pumac/LIDAR_Lite_v3_Operation_Manual_and_Technical_Specifications.pdf
    https://github.com/PulsedLight3D/LIDAR-Lite-Documentation/blob/master/Docs/LIDAR-Lite-v2-Docs.pdf

properties:
  compatible:
    oneOf:
      - items:
          - enum:
              - grmn,lidar-lite-v3
          - const: pulsedlight,lidar-lite-v2
      - const: pulsedlight,lidar-lite-v2

  reg:
    maxItems: 1

  powerdown-gpios:
    description: GPIO that can be driven low to shut off power to the device.
    maxItems: 1

  vdd-supply: true

  interrupts:
    description:
      Mode control pin used as a status output, driven while the device is
      busy performing an acquisition. Can be used to signal completion
      instead of polling over I2C.
    maxItems: 1

required:
  - compatible
  - reg
  - vdd-supply

additionalProperties: false

examples:
  - |
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;
        lidar@62 {
            compatible = "grmn,lidar-lite-v3", "pulsedlight,lidar-lite-v2";
            reg = <0x62>;
            vdd-supply = <&vdd_5v0>;
        };
    };
...