Re: [PATCH 2/2] dt-bindings: iio: light: Document the VCNL4xx0 device tree bindings

Jonathan Cameron
2019-03-16T17:15:26Z

On Fri, 15 Mar 2019 14:54:25 -0700
"Angus Ainslie (Purism)" <angus@akkea.ca> wrote:

> devicetree hooks where added to the VCNL4xx0 light and proximity
> sensor driver.
>
> Signed-off-by: Angus Ainslie (Purism) <angus@akkea.ca>
Please avoid wild cards in naming. It goes wrong too often. People can grep
if they want to see if their device is supported by any drivers rather
than try to figure out wildcards.

> ---
> .../devicetree/bindings/iio/light/vcnl4xx0.txt | 15 +++++++++++++++
> 1 file changed, 15 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/light/vcnl4xx0.txt
>
> diff --git a/Documentation/devicetree/bindings/iio/light/vcnl4xx0.txt b/Documentation/devicetree/bindings/iio/light/vcnl4xx0.txt
> new file mode 100644
> index 000000000000..d61cf3c121c3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/light/vcnl4xx0.txt
> @@ -0,0 +1,15 @@
> +VISHAY VCNL4xx0 - Ambient Light and proximity sensor
> +
> +This driver supports the VCNL4000/10/20/40 and VCNL4200
> +
> +Required properties:
> +
> + -compatible: should be "vishay,vcnl4000" or "vishay,vcnl4040"
One per line.

I'd also like to see all the options in the list. We already seem
to have an undocumented difference between your new part and some
of the older ones. It's always better for people to use the 'most
correct' part name the can.

> + -reg: I2C address of the sensor, should be 0x60
> +
> +Example:
> +
> +light-sensor@60 {
> + compatible = "vishay,vcnl4040";
> + reg = <0x60>;
> +};