Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml

# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/proximity/maxbotix,mb1232.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: MaxBotix I2CXL-MaxSonar ultrasonic distance sensor

maintainers:
  - Andreas Klinger <ak@it-klinger.de>

description: |
  MaxBotix I2CXL-MaxSonar ultrasonic distance sensor of type  mb1202,
  mb1212, mb1222, mb1232, mb1242, mb7040 or mb7137 using the i2c interface
  for ranging

  Specifications about the devices can be found at:
  https://www.maxbotix.com/documents/I2CXL-MaxSonar-EZ_Datasheet.pdf

properties:
  compatible:
    enum:
      - maxbotix,mb1202
      - maxbotix,mb1212
      - maxbotix,mb1222
      - maxbotix,mb1232
      - maxbotix,mb1242
      - maxbotix,mb7040
      - maxbotix,mb7137

  reg:
    maxItems: 1

  interrupts:
    description:
      Interrupt used to announce the preceding reading request has finished
      and that data is available.  If no interrupt is specified the device
      driver falls back to wait a fixed amount of time until data can be
      retrieved.
    maxItems: 1

required:
  - compatible
  - reg

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    i2c {
      #address-cells = <1>;
      #size-cells = <0>;
      proximity@70 {
        compatible = "maxbotix,mb1232";
        reg = <0x70>;
        interrupt-parent = <&gpio2>;
        interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
      };
    };