Re: [PATCH v13 1/2] dt-bindings: proximity: provide vcnl3020 device tree binding document

[Jonathan Cameron <Jonathan.Cameron@xxxxxxxxxx>]

On Thu, 7 May 2020 16:25:59 +0300
Ivan Mikhaylov <i.mikhaylov@xxxxxxxxx> wrote:

> Mostly standard i2c driver with some additional led-current option
> for vcnl3020.
> 
> Signed-off-by: Ivan Mikhaylov <i.mikhaylov@xxxxxxxxx>
> ---
>  .../iio/proximity/vishay,vcnl3020.yaml        | 65 +++++++++++++++++++
>  1 file changed, 65 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/proximity/vishay,vcnl3020.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/proximity/vishay,vcnl3020.yaml b/Documentation/devicetree/bindings/iio/proximity/vishay,vcnl3020.yaml
> new file mode 100644
> index 000000000000..408dee17cdf5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/proximity/vishay,vcnl3020.yaml
> @@ -0,0 +1,65 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/proximity/vishay,vcnl3020.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Integrated Proximity Sensor With Infrared Emitter
> +
> +maintainers:
> +  - Ivan Mikhaylov <i.mikhaylov@xxxxxxxxx>
> +
> +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:
> +    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-microamp:
> +    description:
> +      IR LED current value with valid Range = 0 to 20d. e.g. 0 = 0 mA,
> +      1 = 10 mA, 20 = 200 mA. LED Current is limited to 200 mA for values
> +      higher than decimal 20. The drive current for the LED used in proximity
> +      sensing.

This text is really confusing. Just let the enum speak for itself and leave text as
something short like

"The driver current for the LED used in proximity sensing. "

Units and values are clear already.

> +    enum: [0, 10000, 20000, 30000, 40000, 50000, 60000, 70000, 80000, 90000,
> +          100000, 110000, 120000, 130000, 140000, 150000, 160000, 170000,
> +          180000, 190000, 200000]
> +    default: 20000
> +
> +required:
> +  - compatible
> +  - reg
> +
> +examples:
> +  - |
> +    i2c {
> +
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        proximity@13 {
> +              compatible = "vishay,vcnl3020";
> +              reg = <0x13>;
> +              vishay,led-current-microamp = <200000>;
> +        };
> +    };