[PATCH v2 0/4] Correct vendor-prefix and document device isl29028

[PATCH v2 0/4] Correct vendor-prefix and document device isl29028

[Darshana Padmadas]

Patchset documents correct and the deprecated vendor-prefix found by checkpatch 
warning and also documents information of device isl29028 for compatibility. 
Patchset also includes corrected vendor-prefix and device name in compatible 
property for files with checkpatch warning of undocumented string "isil,isl29028".

Darshana Padmadas (4):
  Documentation: devicetree: bindings: Document correct and deprecated
    vendor-prefix of device
  Documentation: devicetree: bindings: Document deprecated vendor-prefix
    found by checkpatch.pl
  Staging: iio: light: Added correct vendor-prefix with device name in
    compatible property
  arch: arm: boot: dts: Added correct vendor-prefix with device name to
    compatible property

Changes in v2:
    - Made the commit message more clear.
    - Made cover letter more clear.

 Documentation/devicetree/bindings/i2c/trivial-devices.txt | 2 ++
 Documentation/devicetree/bindings/vendor-prefixes.txt     | 1 +
 arch/arm/boot/dts/tegra30-cardhu.dtsi                     | 2 +-
 drivers/staging/iio/light/isl29028.c                      | 3 ++-
 4 files changed, 6 insertions(+), 2 deletions(-)

-- 
1.9.1

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH v2 1/4] Documentation: devicetree: bindings: Document correct and deprecated vendor-prefix of device

[Darshana Padmadas]

This patch documents the device isl29028 with its vendor-prefix. Undocumented deprecated vendor-prefix
found by checkpatch also documented for compatibility reasons.

Signed-off-by: Darshana Padmadas <darshanapadmadas-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
---
 Documentation/devicetree/bindings/i2c/trivial-devices.txt | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/devicetree/bindings/i2c/trivial-devices.txt b/Documentation/devicetree/bindings/i2c/trivial-devices.txt
index 6af570e..2c0be4c 100644
--- a/Documentation/devicetree/bindings/i2c/trivial-devices.txt
+++ b/Documentation/devicetree/bindings/i2c/trivial-devices.txt
@@ -57,6 +57,8 @@ gmt,g751		G751: Digital Temperature Sensor and Thermal Watchdog with Two-Wire In
 infineon,slb9635tt	Infineon SLB9635 (Soft-) I2C TPM (old protocol, max 100khz)
 infineon,slb9645tt	Infineon SLB9645 I2C TPM (new protocol, max 400khz)
 isl,isl12057		Intersil ISL12057 I2C RTC Chip
+isl,isl29028		Intersil ISL29028 Ambient Light and Proximity Sensor
+isil,isl29028		Deprecated name, use isl,isl29028 instead
 maxim,ds1050		5 Bit Programmable, Pulse-Width Modulator
 maxim,max1237		Low-Power, 4-/12-Channel, 2-Wire Serial, 12-Bit ADCs
 maxim,max6625		9-Bit/12-Bit Temperature Sensors with I²C-Compatible Serial Interface
-- 
1.9.1

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH v2 2/4] Documentation: devicetree: bindings: Document deprecated vendor-prefix found by checkpatch.pl

[Darshana Padmadas]

This patch documents deprecated vendor name found by checkpatch warning for compatibility reasons.

Signed-off-by: Darshana Padmadas <darshanapadmadas-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
---
 Documentation/devicetree/bindings/vendor-prefixes.txt | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
index ac7269f..2c74874 100644
--- a/Documentation/devicetree/bindings/vendor-prefixes.txt
+++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
@@ -69,6 +69,7 @@ intel	Intel Corporation
 intercontrol	Inter Control Group
 isee	ISEE 2007 S.L.
 isl	Intersil
+isil	Deprecated name, use isl instead
 karo	Ka-Ro electronics GmbH
 keymile	Keymile GmbH
 lacie	LaCie
-- 
1.9.1

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH v2 3/4] Staging: iio: light: Added correct vendor-prefix with device name in compatible property

[Darshana Padmadas]

This patch adds the correct vendor-prefix for the device isl29028 to fix
following checkpatch warning:
WARNING: DT compatible string "isil,isl29028" appears un-documented -- check ./Documentation/devicetree/bindings/

Signed-off-by: Darshana Padmadas <darshanapadmadas-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
---
 drivers/staging/iio/light/isl29028.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/staging/iio/light/isl29028.c b/drivers/staging/iio/light/isl29028.c
index 6014625..7090708 100644
--- a/drivers/staging/iio/light/isl29028.c
+++ b/drivers/staging/iio/light/isl29028.c
@@ -537,7 +537,8 @@ static const struct i2c_device_id isl29028_id[] = {
 MODULE_DEVICE_TABLE(i2c, isl29028_id);
 
 static const struct of_device_id isl29028_of_match[] = {
-	{ .compatible = "isil,isl29028", },
+	{ .compatible = "isl,isl29028", },
+	{ .compatible = "isil,isl29028", }, /* Deprecated, don't use */
 	{ },
 };
 MODULE_DEVICE_TABLE(of, isl29028_of_match);
-- 
1.9.1

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH v2 4/4] arch: arm: boot: dts: Added correct vendor-prefix with device name to compatible property

[Darshana Padmadas]

This patch adds the correct vendor-prefix listed in Documentation/devicetree/bindings/vendor-prefixes.txt
with the device name to compatible property.

Signed-off-by: Darshana Padmadas <darshanapadmadas-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
---
 arch/arm/boot/dts/tegra30-cardhu.dtsi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm/boot/dts/tegra30-cardhu.dtsi b/arch/arm/boot/dts/tegra30-cardhu.dtsi
index 2063795..491fed6 100644
--- a/arch/arm/boot/dts/tegra30-cardhu.dtsi
+++ b/arch/arm/boot/dts/tegra30-cardhu.dtsi
@@ -187,7 +187,7 @@
 
 		/* ALS and Proximity sensor */
 		isl29028@44 {
-			compatible = "isil,isl29028";
+			compatible = "isl,isl29028", "isil,isl29028";
 			reg = <0x44>;
 			interrupt-parent = <&gpio>;
 			interrupts = <TEGRA_GPIO(L, 0) IRQ_TYPE_LEVEL_HIGH>;
-- 
1.9.1

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2 4/4] arch: arm: boot: dts: Added correct vendor-prefix with device name to compatible property

[Mark Rutland]

Hi,

On Fri, Sep 26, 2014 at 01:24:52PM +0100, Darshana Padmadas wrote:
> This patch adds the correct vendor-prefix listed in Documentation/devicetree/bindings/vendor-prefixes.txt
> with the device name to compatible property.
> 
> Signed-off-by: Darshana Padmadas <darshanapadmadas-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
> ---
>  arch/arm/boot/dts/tegra30-cardhu.dtsi | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/arch/arm/boot/dts/tegra30-cardhu.dtsi b/arch/arm/boot/dts/tegra30-cardhu.dtsi
> index 2063795..491fed6 100644
> --- a/arch/arm/boot/dts/tegra30-cardhu.dtsi
> +++ b/arch/arm/boot/dts/tegra30-cardhu.dtsi
> @@ -187,7 +187,7 @@
>  
>  		/* ALS and Proximity sensor */
>  		isl29028@44 {
> -			compatible = "isil,isl29028";
> +			compatible = "isl,isl29028", "isil,isl29028";

Please either drop the old string, or don't add the new string.

For compatibility with old DTBs, the kernel must continue to support the
old string. So the old string will alone will work -- it's not necessary
to add the new one to DTs just because the kernel now supports it.

However, this DTB need not work with older kernels, so you could simply
replace the string with the new one if your aim is to remove instances
of "isil" to ensure consistency going forwards. If so, please mention
that in the commit message.

Additionally, please Cc the Tegra maintainers if you touch their DTs,
along with arm-soc. They both need to have some visibility of this and
might not be subscribed to the devicetree mailing list. You should be
able to find a list of people to Cc by using get_maintainer.pl.

Thanks,
Mark.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2 2/4] Documentation: devicetree: bindings: Document deprecated vendor-prefix found by checkpatch.pl

[Mark Rutland]

On Fri, Sep 26, 2014 at 01:24:50PM +0100, Darshana Padmadas wrote:
> This patch documents deprecated vendor name found by checkpatch warning for compatibility reasons.
> 
> Signed-off-by: Darshana Padmadas <darshanapadmadas-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
> ---
>  Documentation/devicetree/bindings/vendor-prefixes.txt | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
> index ac7269f..2c74874 100644
> --- a/Documentation/devicetree/bindings/vendor-prefixes.txt
> +++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
> @@ -69,6 +69,7 @@ intel	Intel Corporation
>  intercontrol	Inter Control Group
>  isee	ISEE 2007 S.L.
>  isl	Intersil
> +isil	Deprecated name, use isl instead

We have one other documented deprecated vendor-prefix (powervr), and it
would be nice to keep the style consistent between them.

There have been suggestions that we should get checkpatch to warn for
deprecated strings, and consitency will make it easier to do so whenever
someone gets the time to implement that.

So please change this to:

isil Intersil (deprecated, use isl)

And please place this before isl, so as to keep the list in alphabetical
order.

With that:

Acked-by: Mark Rutland <mark.rutland-5wv7dgnIgG8@public.gmane.org>

Thanks,
Mark.

>  karo	Ka-Ro electronics GmbH
>  keymile	Keymile GmbH
>  lacie	LaCie
> -- 
> 1.9.1
> 
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> 
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2 3/4] Staging: iio: light: Added correct vendor-prefix with device name in compatible property

[Mark Rutland]

On Fri, Sep 26, 2014 at 01:24:51PM +0100, Darshana Padmadas wrote:
> This patch adds the correct vendor-prefix for the device isl29028 to fix
> following checkpatch warning:
> WARNING: DT compatible string "isil,isl29028" appears un-documented -- check ./Documentation/devicetree/bindings/
> 
> Signed-off-by: Darshana Padmadas <darshanapadmadas-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>

Overall, this looks fine to me, but you need to Cc the driver maintainer
(and others who might be intereested, e.g. the IIO list). You should be
able to find a list of relevant people using get_maintainer.pl.

Thanks,
Mark.

> ---
>  drivers/staging/iio/light/isl29028.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/staging/iio/light/isl29028.c b/drivers/staging/iio/light/isl29028.c
> index 6014625..7090708 100644
> --- a/drivers/staging/iio/light/isl29028.c
> +++ b/drivers/staging/iio/light/isl29028.c
> @@ -537,7 +537,8 @@ static const struct i2c_device_id isl29028_id[] = {
>  MODULE_DEVICE_TABLE(i2c, isl29028_id);
>  
>  static const struct of_device_id isl29028_of_match[] = {
> -	{ .compatible = "isil,isl29028", },
> +	{ .compatible = "isl,isl29028", },
> +	{ .compatible = "isil,isl29028", }, /* Deprecated, don't use */
>  	{ },
>  };
>  MODULE_DEVICE_TABLE(of, isl29028_of_match);
> -- 
> 1.9.1
> 
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> 
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2 4/4] arch: arm: boot: dts: Added correct vendor-prefix with device name to compatible property

[Mark Rutland]

On Sat, Sep 27, 2014 at 05:03:00PM +0100, Darshana Padmadas wrote:
>    On Friday, September 26, 2014 7:20:50 PM UTC+5:30, Mark Rutland wrote:
> 
>      Hi,
> 
>      On Fri, Sep 26, 2014 at 01:24:52PM +0100, Darshana Padmadas wrote:
>      > This patch adds the correct vendor-prefix listed in
>      Documentation/devicetree/bindings/vendor-prefixes.txt
>      > with the device name to compatible property.
>      >
>      > Signed-off-by: Darshana Padmadas <[1]darshana...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
>      > ---
>      >  arch/arm/boot/dts/tegra30-cardhu.dtsi | 2 +-
>      >  1 file changed, 1 insertion(+), 1 deletion(-)
>      >
>      > diff --git a/arch/arm/boot/dts/tegra30-cardhu.dtsi
>      b/arch/arm/boot/dts/tegra30-cardhu.dtsi
>      > index 2063795..491fed6 100644
>      > --- a/arch/arm/boot/dts/tegra30-cardhu.dtsi
>      > +++ b/arch/arm/boot/dts/tegra30-cardhu.dtsi
>      > @@ -187,7 +187,7 @@
>      >  
>      >                  /* ALS and Proximity sensor */
>      >                  isl29028@44 {
>      > -                        compatible = "isil,isl29028";
>      > +                        compatible = "isl,isl29028", "isil,isl29028";
> 
>      Please either drop the old string, or don't add the new string.
> 
>      For compatibility with old DTBs, the kernel must continue to support the
>      old string. So the old string will alone will work -- it's not necessary
>      to add the new one to DTs just because the kernel now supports it.
> 
>      However, this DTB need not work with older kernels, so you could simply
>      replace the string with the new one if your aim is to remove instances
>      of "isil" to ensure consistency going forwards. If so, please mention
>      that in the commit message.
> 
>    So I simply replace isil with isl for the newer kernels? 

For the dts(i) files, that should be fine. You will need to Cc the Tegra
maintainers to verify if they're ok with that.

As an aside, your email came through as HTML, which some lists will
reject. Please ensure your mail client sends plain text.

Thanks,
Mark.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html