* [PATCH] iio: dt-bindings: add documentation for Light&Proximity sensor STK331x
@ 2016-09-13 9:27 Andy Yan
2016-09-13 9:53 ` Heiko Stuebner
0 siblings, 1 reply; 3+ messages in thread
From: Andy Yan @ 2016-09-13 9:27 UTC (permalink / raw)
To: jic23-DgEjT+Ai2ygdnm+yROfE0A
Cc: knaack.h-Mmb7MZpHnFY, robh+dt-DgEjT+Ai2ygdnm+yROfE0A,
linux-kernel-u79uwXL29TY76Z2rM5mHXA,
linux-iio-u79uwXL29TY76Z2rM5mHXA,
devicetree-u79uwXL29TY76Z2rM5mHXA, lars-Qo5EllUWu/uELgA04lAiVw,
mark.rutland-5wv7dgnIgG8, pmeerw-jW+XmwGofnusTnJN9+BGXg,
heiko-4mtYJXux2i+zQB+pC5nmwQ, Andy Yan
Add the device tree binding documentation for Light & Proximity sensor
STK331X from Sensortek
Signed-off-by: Andy Yan <andy.yan-TNX95d0MmH7DzftRWevZcw@public.gmane.org>
---
.../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"
+- 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>;
+ };
+
+ /* ... */
+ };
--
2.7.4
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [PATCH] iio: dt-bindings: add documentation for Light&Proximity sensor STK331x
2016-09-13 9:27 [PATCH] iio: dt-bindings: add documentation for Light&Proximity sensor STK331x Andy Yan
@ 2016-09-13 9:53 ` Heiko Stuebner
2016-09-13 17:17 ` Jonathan Cameron
0 siblings, 1 reply; 3+ messages in thread
From: Heiko Stuebner @ 2016-09-13 9:53 UTC (permalink / raw)
To: Andy Yan
Cc: jic23, knaack.h, robh+dt, linux-kernel, linux-iio, devicetree,
lars, mark.rutland, pmeerw
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@rock-chips.com>
> ---
>
> .../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>;
> + };
> +
> + /* ... */
> + };
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] iio: dt-bindings: add documentation for Light&Proximity sensor STK331x
2016-09-13 9:53 ` Heiko Stuebner
@ 2016-09-13 17:17 ` Jonathan Cameron
0 siblings, 0 replies; 3+ messages in thread
From: Jonathan Cameron @ 2016-09-13 17:17 UTC (permalink / raw)
To: Heiko Stuebner, Andy Yan
Cc: knaack.h, robh+dt, linux-kernel, linux-iio, devicetree, lars,
mark.rutland, pmeerw
On 13/09/16 10:53, Heiko Stuebner wrote:
> 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@rock-chips.com>
>> ---
>>
>> .../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.
Yup. Not the best. It should have dropped to lower case for the i2c table.
I missed it. Now it's in there we'll have to maintain both going forward
to avoid breaking anyone.
>
> 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
Add another entry that is lowercase...
> - 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.
Should have one of those as well to allow full matching. Sooner or later
we'll run into a collision with just the part name...
Jonathan
>
>
> 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>;
>> + };
>> +
>> + /* ... */
>> + };
>
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2016-09-13 17:17 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-09-13 9:27 [PATCH] iio: dt-bindings: add documentation for Light&Proximity sensor STK331x Andy Yan
2016-09-13 9:53 ` Heiko Stuebner
2016-09-13 17:17 ` Jonathan Cameron
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).