Mostly standard i2c driver with some additional led-current option
for vcnl3020.
Signed-off-by: Ivan Mikhaylov <[email protected]>
---
.../bindings/iio/proximity/vcnl3020.yaml | 65 +++++++++++++++++++
1 file changed, 65 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..29ab2dee1694
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/proximity/vcnl3020.yaml
@@ -0,0 +1,65 @@
+# 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 <[email protected]>
+
+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
+
+ interrupts:
+ description: IRQ line for the proximity sensor
+ maxItems: 1
+
+ vdd-supply:
+ description: Regulator that provides power to the sensor
+
+ vddio-supply:
+ description: Regulator that provides power to the bus
+
+ vishay,led-current-milliamp:
+ 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.
+ allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint32
+ - enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17,
+ 18, 19, 20]
+
+required:
+ - compatible
+ - reg
+
+examples:
+ - |
+ i2c {
+
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ proximity@13 {
+ compatible = "vishay,vcnl3020";
+ reg = <0x13>;
+ vishay,led-current-milliamp = <0x14>;
+ };
+ };
--
2.21.1
On Mon, 6 Apr 2020 20:20:01 +0300
Ivan Mikhaylov <[email protected]> wrote:
> Mostly standard i2c driver with some additional led-current option
> for vcnl3020.
>
> Signed-off-by: Ivan Mikhaylov <[email protected]>
One comment inline preempting likely review from Rob. I'd also like
there to be plenty of time for Rob and others to take a look before I
apply this.
Thanks,
Jonathan
> ---
> .../bindings/iio/proximity/vcnl3020.yaml | 65 +++++++++++++++++++
> 1 file changed, 65 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..29ab2dee1694
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/proximity/vcnl3020.yaml
> @@ -0,0 +1,65 @@
> +# SPDX-License-Identifier: GPL-2.0
Very much preferred for new bindings to have a dual license including
BSD to allow there use outside of the Linux kernel.
> +%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 <[email protected]>
> +
> +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
> +
> + interrupts:
> + description: IRQ line for the proximity sensor
> + maxItems: 1
> +
> + vdd-supply:
> + description: Regulator that provides power to the sensor
> +
> + vddio-supply:
> + description: Regulator that provides power to the bus
> +
> + vishay,led-current-milliamp:
> + 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.
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32
> + - enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17,
> + 18, 19, 20]
> +
> +required:
> + - compatible
> + - reg
> +
> +examples:
> + - |
> + i2c {
> +
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + proximity@13 {
> + compatible = "vishay,vcnl3020";
> + reg = <0x13>;
> + vishay,led-current-milliamp = <0x14>;
> + };
> + };
On Mon, Apr 06, 2020 at 08:20:01PM +0300, Ivan Mikhaylov wrote:
> Mostly standard i2c driver with some additional led-current option
> for vcnl3020.
>
> Signed-off-by: Ivan Mikhaylov <[email protected]>
> ---
> .../bindings/iio/proximity/vcnl3020.yaml | 65 +++++++++++++++++++
> 1 file changed, 65 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..29ab2dee1694
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/proximity/vcnl3020.yaml
> @@ -0,0 +1,65 @@
> +# SPDX-License-Identifier: GPL-2.0
Dual license as Jonathan said.
> +%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 <[email protected]>
> +
> +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
> +
> + interrupts:
> + description: IRQ line for the proximity sensor
Can drop this.
> + maxItems: 1
> +
> + vdd-supply:
> + description: Regulator that provides power to the sensor
> +
> + vddio-supply:
> + description: Regulator that provides power to the bus
> +
> + vishay,led-current-milliamp:
> + description:
> + IR LED current value with valid Range = 0 to 20d. e.g. 0 = 0 mA,
Should be indented 2 fewer spaces.
> + 1 = 10 mA, 20 = 200 mA (2 = 20 mA = DEFAULT). LED Current is
> + limited to 200 mA for values higher than decimal 20.
Use the 'default' property to define the default.
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32
Can drop this as standard units have a type already. However, the
standard unit is '-microamp', so use that. Also, looks like this is
in units of register values, not milliamps. Use microamps (e.g. 200000).
> + - enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17,
> + 18, 19, 20]
> +
> +required:
> + - compatible
> + - reg
> +
> +examples:
> + - |
> + i2c {
> +
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + proximity@13 {
> + compatible = "vishay,vcnl3020";
> + reg = <0x13>;
> + vishay,led-current-milliamp = <0x14>;
> + };
> + };
> --
> 2.21.1
>