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

   1 # SPDX-License-Identifier: GPL-2.0
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/iio/proximity/maxbotix,mb1232.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: MaxBotix I2CXL-MaxSonar ultrasonic distance sensor
   8
   9 maintainers:
  10   - Andreas Klinger <ak@it-klinger.de>
  11
  12 description: |
  13   MaxBotix I2CXL-MaxSonar ultrasonic distance sensor of type  mb1202,
  14   mb1212, mb1222, mb1232, mb1242, mb7040 or mb7137 using the i2c interface
  15   for ranging
  16
  17   Specifications about the devices can be found at:
  18   https://www.maxbotix.com/documents/I2CXL-MaxSonar-EZ_Datasheet.pdf
  19
  20 properties:
  21   compatible:
  22     enum:
  23       - maxbotix,mb1202
  24       - maxbotix,mb1212
  25       - maxbotix,mb1222
  26       - maxbotix,mb1232
  27       - maxbotix,mb1242
  28       - maxbotix,mb7040
  29       - maxbotix,mb7137
  30
  31   reg:
  32     maxItems: 1
  33
  34   interrupts:
  35     description:
  36       Interrupt used to announce the preceding reading request has finished
  37       and that data is available.  If no interrupt is specified the device
  38       driver falls back to wait a fixed amount of time until data can be
  39       retrieved.
  40     maxItems: 1
  41
  42 required:
  43   - compatible
  44   - reg
  45
  46 additionalProperties: false
  47
  48 examples:
  49   - |
  50     #include <dt-bindings/interrupt-controller/irq.h>
  51     i2c {
  52       #address-cells = <1>;
  53       #size-cells = <0>;
  54       proximity@70 {
  55         compatible = "maxbotix,mb1232";
  56         reg = <0x70>;
  57         interrupt-parent = <&gpio2>;
  58         interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
  59       };
  60     };