xref: /freebsd/sys/contrib/device-tree/Bindings/iio/light/sharp,gp2ap002.yaml (revision 7ef62cebc2f965b0f640263e179276928885e33d) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/iio/light/sharp,gp2ap002.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Sharp GP2AP002A00F and GP2AP002S00F proximity and ambient light sensors
8
9maintainers:
10  - Linus Walleij <linus.walleij@linaro.org>
11
12description: |
13  Proximity and ambient light sensor with IR LED for the proximity
14  sensing and an analog output for light intensity. The ambient light
15  sensor output is not available on the GP2AP002S00F variant.
16
17properties:
18  compatible:
19    enum:
20      - sharp,gp2ap002a00f
21      - sharp,gp2ap002s00f
22
23  reg:
24    maxItems: 1
25
26  interrupts:
27    maxItems: 1
28    description: an interrupt for proximity, usually a GPIO line
29
30  vdd-supply:
31    description: VDD power supply a phandle to a regulator
32
33  vio-supply:
34    description: VIO power supply a phandle to a regulator
35
36  io-channels:
37    maxItems: 1
38    description: ALSOUT ADC channel to read the ambient light
39
40  io-channel-names:
41    const: alsout
42
43  sharp,proximity-far-hysteresis:
44    $ref: /schemas/types.yaml#/definitions/uint8
45    description: |
46      Hysteresis setting for "far" object detection, this setting is
47      device-unique and adjust the optical setting for proximity detection
48      of a "far away" object in front of the sensor.
49
50  sharp,proximity-close-hysteresis:
51    $ref: /schemas/types.yaml#/definitions/uint8
52    description: |
53      Hysteresis setting for "close" object detection, this setting is
54      device-unique and adjust the optical setting for proximity detection
55      of a "close" object in front of the sensor.
56
57required:
58  - compatible
59  - reg
60  - interrupts
61  - sharp,proximity-far-hysteresis
62  - sharp,proximity-close-hysteresis
63
64additionalProperties: false
65
66examples:
67  - |
68    #include <dt-bindings/interrupt-controller/irq.h>
69
70    i2c {
71      #address-cells = <1>;
72      #size-cells = <0>;
73
74      light-sensor@44 {
75        compatible = "sharp,gp2ap002a00f";
76        reg = <0x44>;
77        interrupts = <18 IRQ_TYPE_EDGE_FALLING>;
78        vdd-supply = <&vdd_regulator>;
79        vio-supply = <&vio_regulator>;
80        io-channels = <&adc_channel>;
81        io-channel-names = "alsout";
82        sharp,proximity-far-hysteresis = /bits/ 8 <0x2f>;
83        sharp,proximity-close-hysteresis = /bits/ 8 <0x0f>;
84      };
85    };
86
87...
88