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