Documentation/devicetree/bindings/iio/proximity/st,vl53l0x.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/iio/proximity/st,vl53l0x.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/iio/proximity/st,vl53l0x.yaml
Extension
.yaml
Size
1177 bytes
Lines
64
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

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

title: ST VL53L0X/VL53L1X ToF ranging sensor

maintainers:
  - Song Qiang <songqiang1304521@gmail.com>
  - Siratul Islam <email@sirat.me>

properties:
  compatible:
    enum:
      - st,vl53l0x
      - st,vl53l1x

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  reset-gpios:
    maxItems: 1
    description:
      Phandle to the XSHUT GPIO. Used for hardware reset.

  vdd-supply: true

required:
  - compatible
  - reg

allOf:
  - if:
      properties:
        compatible:
          contains:
            const: st,vl53l1x
    then:
      required:
        - vdd-supply

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        proximity@29 {
            compatible = "st,vl53l1x";
            reg = <0x29>;
            vdd-supply = <&reg_3v3>;
            interrupt-parent = <&gpio>;
            interrupts = <23 IRQ_TYPE_EDGE_FALLING>;
        };
    };
...

Annotation

Implementation Notes