xref: /linux/Documentation/devicetree/bindings/iio/light/brcm,apds9160.yaml (revision bbfd5594756011167b8f8de9a00e0c946afda1e6) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/iio/light/brcm,apds9160.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Broadcom Combined Proximity & Ambient light sensor
8
9maintainers:
10  - Mikael Gonella-Bolduc <m.gonella.bolduc@gmail.com>
11
12description: |
13  Datasheet: https://docs.broadcom.com/docs/APDS-9160-003-DS
14
15properties:
16  compatible:
17    enum:
18      - brcm,apds9160
19
20  reg:
21    maxItems: 1
22
23  interrupts:
24    maxItems: 1
25
26  vdd-supply: true
27
28  ps-cancellation-duration:
29    $ref: /schemas/types.yaml#/definitions/uint32
30    description:
31      Proximity sensor cancellation pulse duration in half clock cycles.
32      This parameter determines a cancellation pulse duration.
33      The cancellation is applied in the integration phase to cancel out
34      unwanted reflected light from very near objects such as tempered glass
35      in front of the sensor.
36    default: 0
37    maximum: 63
38
39  ps-cancellation-current-picoamp:
40    description:
41      Proximity sensor crosstalk cancellation current in picoampere.
42      This parameter adjusts the current in steps of 2400 pA up to 276000 pA.
43      The provided value must be a multiple of 2400 and in one of these ranges
44      [60000 - 96000]
45      [120000 - 156000]
46      [180000 - 216000]
47      [240000 - 276000]
48      This parameter is used in conjunction with the cancellation duration.
49    minimum: 60000
50    maximum: 276000
51    multipleOf: 2400
52
53required:
54  - compatible
55  - reg
56  - vdd-supply
57
58additionalProperties: false
59
60examples:
61  - |
62    #include <dt-bindings/interrupt-controller/irq.h>
63
64    i2c {
65        #address-cells = <1>;
66        #size-cells = <0>;
67
68        light-sensor@53 {
69            compatible = "brcm,apds9160";
70            reg = <0x53>;
71            vdd-supply = <&vdd_reg>;
72            interrupts = <29 IRQ_TYPE_EDGE_FALLING>;
73            interrupt-parent = <&pinctrl>;
74            ps-cancellation-duration = <10>;
75            ps-cancellation-current-picoamp = <62400>;
76        };
77    };
78...
79