xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/iio/proximity/vishay,vcnl3020.yaml (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2*4882a593Smuzhiyun%YAML 1.2
3*4882a593Smuzhiyun---
4*4882a593Smuzhiyun$id: http://devicetree.org/schemas/iio/proximity/vishay,vcnl3020.yaml#
5*4882a593Smuzhiyun$schema: http://devicetree.org/meta-schemas/core.yaml#
6*4882a593Smuzhiyun
7*4882a593Smuzhiyuntitle: Integrated Proximity Sensor With Infrared Emitter
8*4882a593Smuzhiyun
9*4882a593Smuzhiyunmaintainers:
10*4882a593Smuzhiyun  - Ivan Mikhaylov <i.mikhaylov@yadro.com>
11*4882a593Smuzhiyun
12*4882a593Smuzhiyundescription: |
13*4882a593Smuzhiyun  The VCNL3020 is a fully integrated proximity sensor. Fully integrated means
14*4882a593Smuzhiyun  that the infrared emitter is included in the package. It has 16-bit
15*4882a593Smuzhiyun  resolution. It includes a signal processing IC and features standard I2C
16*4882a593Smuzhiyun  communication interface. It features an interrupt function.
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun  Specifications about the devices can be found at:
19*4882a593Smuzhiyun  https://www.vishay.com/docs/84150/vcnl3020.pdf
20*4882a593Smuzhiyun
21*4882a593Smuzhiyunproperties:
22*4882a593Smuzhiyun  compatible:
23*4882a593Smuzhiyun    enum:
24*4882a593Smuzhiyun      - vishay,vcnl3020
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun  reg:
27*4882a593Smuzhiyun    maxItems: 1
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun  interrupts:
30*4882a593Smuzhiyun    maxItems: 1
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun  vdd-supply:
33*4882a593Smuzhiyun    description: Regulator that provides power to the sensor
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun  vddio-supply:
36*4882a593Smuzhiyun    description: Regulator that provides power to the bus
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun  vishay,led-current-microamp:
39*4882a593Smuzhiyun    description:
40*4882a593Smuzhiyun      The driver current for the LED used in proximity sensing.
41*4882a593Smuzhiyun    enum: [0, 10000, 20000, 30000, 40000, 50000, 60000, 70000, 80000, 90000,
42*4882a593Smuzhiyun           100000, 110000, 120000, 130000, 140000, 150000, 160000, 170000,
43*4882a593Smuzhiyun           180000, 190000, 200000]
44*4882a593Smuzhiyun    default: 20000
45*4882a593Smuzhiyun
46*4882a593Smuzhiyunrequired:
47*4882a593Smuzhiyun  - compatible
48*4882a593Smuzhiyun  - reg
49*4882a593Smuzhiyun
50*4882a593SmuzhiyunadditionalProperties: false
51*4882a593Smuzhiyun
52*4882a593Smuzhiyunexamples:
53*4882a593Smuzhiyun  - |
54*4882a593Smuzhiyun    i2c {
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun        #address-cells = <1>;
57*4882a593Smuzhiyun        #size-cells = <0>;
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun        proximity@13 {
60*4882a593Smuzhiyun              compatible = "vishay,vcnl3020";
61*4882a593Smuzhiyun              reg = <0x13>;
62*4882a593Smuzhiyun              vishay,led-current-microamp = <200000>;
63*4882a593Smuzhiyun        };
64*4882a593Smuzhiyun    };
65