[PATCH v2 1/2] iio: proximity: provide device tree binding document

Ivan Mikhaylov
2020-03-25T15:12:28Z

Mostly standard i2c driver with some additional led-current option
for vcnl3020.

Signed-off-by: Ivan Mikhaylov <i.mikhaylov@yadro.com>
---
.../bindings/iio/proximity/vcnl3020.yaml | 47 +++++++++++++++++++
1 file changed, 47 insertions(+)
create mode 100644 Documentation/devicetree/bindings/iio/proximity/vcnl3020.yaml

diff --git a/Documentation/devicetree/bindings/iio/proximity/vcnl3020.yaml b/Documentation/devicetree/bindings/iio/proximity/vcnl3020.yaml
new file mode 100644
index 000000000000..76c29514c663
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/proximity/vcnl3020.yaml
@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/proximity/vcnl3020.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Integrated Proximity Sensor With Infrared Emitter
+
+maintainers:
+ - Ivan Mikhaylov <i.mikhaylov@yadro.com>
+
+description: |
+ The VCNL3020 is a fully integrated proximity sensor. Fully integrated means
+ that the infrared emitter is included in the package. It has 16-bit
+ resolution. It includes a signal processing IC and features standard I2C
+ communication interface. It features an interrupt function.
+
+ Specifications about the devices can be found at:
+ https://www.vishay.com/docs/84150/vcnl3020.pdf
+
+properties:
+ compatible:
+ enum:
+ - vishay,vcnl3020
+
+ reg:
+ maxItems: 1
+
+ led-current:
+ description:
+ IR LED current value with valid Range = 0 to 20d. e.g. 0 = 0 mA,
+ 1 = 10 mA, 20 = 200 mA (2 = 20 mA = DEFAULT). LED Current is
+ limited to 200 mA for values higher than decimal 20.
+
+required:
+ - compatible
+ - reg
+ - led-current
+
+examples:
+ - |
+ iio-proximity@13 {
+ compatible = "vishay,vcnl3020";
+ reg = <0x13>;
+
+ led-current = <0x14>;
+ };
--
2.21.1