xref: /openbmc/linux/Documentation/devicetree/bindings/iio/light/amstaos,tsl2591.yaml (revision 762f99f4f3cb41a775b5157dd761217beba65873)
1*afa2b78fSJoe Sandom# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2*afa2b78fSJoe Sandom%YAML 1.2
3*afa2b78fSJoe Sandom---
4*afa2b78fSJoe Sandom$id: http://devicetree.org/schemas/iio/light/amstaos,tsl2591.yaml#
5*afa2b78fSJoe Sandom$schema: http://devicetree.org/meta-schemas/core.yaml#
6*afa2b78fSJoe Sandom
7*afa2b78fSJoe Sandomtitle: AMS/TAOS TSL2591 Ambient Light Sensor (ALS)
8*afa2b78fSJoe Sandom
9*afa2b78fSJoe Sandommaintainers:
10*afa2b78fSJoe Sandom  - Joe Sandom <joe.g.sandom@gmail.com>
11*afa2b78fSJoe Sandom
12*afa2b78fSJoe Sandomdescription: |
13*afa2b78fSJoe Sandom  AMS/TAOS TSL2591 is a very-high sensitivity
14*afa2b78fSJoe Sandom  light-to-digital converter that transforms light intensity into a digital
15*afa2b78fSJoe Sandom  signal.
16*afa2b78fSJoe Sandom
17*afa2b78fSJoe Sandomproperties:
18*afa2b78fSJoe Sandom  compatible:
19*afa2b78fSJoe Sandom    const: amstaos,tsl2591
20*afa2b78fSJoe Sandom
21*afa2b78fSJoe Sandom  reg:
22*afa2b78fSJoe Sandom    maxItems: 1
23*afa2b78fSJoe Sandom
24*afa2b78fSJoe Sandom  interrupts:
25*afa2b78fSJoe Sandom    maxItems: 1
26*afa2b78fSJoe Sandom    description:
27*afa2b78fSJoe Sandom      Interrupt (INT:Pin 2) Active low. Should be set to IRQ_TYPE_EDGE_FALLING.
28*afa2b78fSJoe Sandom      interrupt is used to detect if the light intensity has fallen below
29*afa2b78fSJoe Sandom      or reached above the configured threshold values.
30*afa2b78fSJoe Sandom
31*afa2b78fSJoe Sandomrequired:
32*afa2b78fSJoe Sandom  - compatible
33*afa2b78fSJoe Sandom  - reg
34*afa2b78fSJoe Sandom
35*afa2b78fSJoe SandomadditionalProperties: false
36*afa2b78fSJoe Sandom
37*afa2b78fSJoe Sandomexamples:
38*afa2b78fSJoe Sandom  - |
39*afa2b78fSJoe Sandom    #include <dt-bindings/interrupt-controller/irq.h>
40*afa2b78fSJoe Sandom    i2c {
41*afa2b78fSJoe Sandom        #address-cells = <1>;
42*afa2b78fSJoe Sandom        #size-cells = <0>;
43*afa2b78fSJoe Sandom
44*afa2b78fSJoe Sandom        tsl2591@29 {
45*afa2b78fSJoe Sandom            compatible = "amstaos,tsl2591";
46*afa2b78fSJoe Sandom            reg = <0x29>;
47*afa2b78fSJoe Sandom            interrupts = <20 IRQ_TYPE_EDGE_FALLING>;
48*afa2b78fSJoe Sandom       };
49*afa2b78fSJoe Sandom    };
50*afa2b78fSJoe Sandom...
51