Documentation/devicetree/bindings/iio/proximity/awinic,aw96103.yaml

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

title: Awinic's AW96103 capacitive proximity sensor and similar

maintainers:
  - Wang Shuaijie <wangshuaijie@awinic.com>

description: |
  Awinic's AW96103/AW96105 proximity sensor.
  The specific absorption rate (SAR) is a metric that measures
  the degree of absorption of electromagnetic radiation emitted by
  wireless devices, such as mobile phones and tablets, by human tissue.
  In mobile phone applications, the proximity sensor is primarily
  used to detect the proximity of the human body to the phone. When the
  phone approaches the human body, it will actively reduce the transmit
  power of the antenna to keep the SAR within a safe range. Therefore,
  we also refer to the proximity sensor as a SAR sensor.

properties:
  compatible:
    enum:
      - awinic,aw96103
      - awinic,aw96105

  reg:
    maxItems: 1

  interrupts:
    description:
      Generated by the device to announce that a close/far
      proximity event has happened.
    maxItems: 1

  vcc-supply: true

required:
  - compatible
  - reg
  - interrupts
  - vcc-supply

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;
        proximity@12 {
            compatible = "awinic,aw96103";
            reg = <0x12>;
            interrupt-parent = <&gpio>;
            interrupts = <23 IRQ_TYPE_EDGE_FALLING>;
            vcc-supply = <&pp1800_prox>;
        };
    };