Re: [PATCH] iio: dt-bindings: add documentation for Light&Proximity sensor STK331x

[Heiko Stuebner]

Hi,

Am Dienstag, 13. September 2016, 17:27:02 CEST schrieb Andy Yan:
> Add the device tree binding documentation for Light & Proximity sensor
> STK331X from Sensortek
> 
> Signed-off-by: Andy Yan <andy.yan@xxxxxxxxxxxxxx>
> ---
> 
>  .../devicetree/bindings/iio/light/stk3310.txt       | 21
> +++++++++++++++++++++ 1 file changed, 21 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/light/stk3310.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/light/stk3310.txt
> b/Documentation/devicetree/bindings/iio/light/stk3310.txt new file mode
> 100644
> index 0000000..d697118
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/light/stk3310.txt
> @@ -0,0 +1,21 @@
> +* Sensortek STK331X I2C Light&Proximity sensor
> +
> +Required properties:
> +- compatible: should be "sensortek,STK3310" or "sensortek,STK3311"

I guess that is more a question for Rob / Jonathan regarding the casing.

The stk3310 drivers currently provides both an acpi as well as an i2c module 
table and in both the naming is in upper-case ... probably the i2c table being 
simply a copy of the acpi table.

By using the i2c-quirk of extracting the i2c-id from the compatible, the 
binding here would codify this upper case, while normally i2c tables as well 
as dt-bindings are all lower case. 

Looking at kernel c-code and current mainline devicetree files, it doesn't look 
like the i2c-ids gets used anywhere yet, so I guess we could do:

- keep acpi-ids as they are
- make i2c-ids lower-case
- make dt-binding lower-case (and it can still use the i2c quirk to not need a 
separate of id-table)

alternatively we could also just add a separate of-id table with the lower-
case compatible elements.


Heiko

> +- reg: the I2C address of the device
> +- interrupt-parent: phandle to the parent interrupt controller
> +- interrupts: interrupt mapping for GPIO IRQ
> +
> +Example:
> +	&i2c1 {
> +		/* ... */
> +
> +		stk3310@48 {
> +			compatible = "sensortek,STK3310";
> +			reg = <0x48>;
> +			interrupt-parent = <&gpio1>;
> +			interrupts = <5 IRQ_TYPE_LEVEL_LOW>;
> +		};
> +
> +		/* ... */
> +	};