diff mbox

[PATCHv0,2/3] rtc: rtc-isl12057: fix isil vs isl naming for intersil

Message ID 2ac5b475fd757ea771296ea0731de75d963999ef.1415222752.git.arno@natisbad.org
State New
Headers show

Commit Message

Arnaud Ebalard Nov. 5, 2014, 9:42 p.m. UTC
When Intersil ISL12057 driver was introduced by commit 70e123373c05
(rtc: Add support for Intersil ISL12057 I2C RTC chip), the vendor
prefix 'isl' was used instead of the expected 'isil' (Intersil
NASDAQ symbol). Recently, a patch from Philip Zabel (7a6540ca856a,
ARM: mvebu: Change vendor prefix for Intersil Corporation to isil)
fixed that prefix in ReadyNAS devices .dts files (AFAICT, the only
kernel users at the moment).

That patch completes that work to change the remaining values in:

 - Intersil ISL12057 driver (compatible string) and also associated
   Documentation/devicetree/bindings/i2c/trivial-devices.txt file
   to reflect the changes introduced by previous commit from Philip

 - Documentation/devicetree/bindings/vendor-prefixes.txt files to
   avoid future mistakes

Signed-off-by: Arnaud Ebalard <arno@natisbad.org>
---
 Documentation/devicetree/bindings/i2c/trivial-devices.txt | 2 +-
 Documentation/devicetree/bindings/vendor-prefixes.txt     | 2 +-
 drivers/rtc/rtc-isl12057.c                                | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

Comments

Mark Brown Nov. 6, 2014, 5:32 a.m. UTC | #1
On Wed, Nov 05, 2014 at 10:42:41PM +0100, Arnaud Ebalard wrote:

> When Intersil ISL12057 driver was introduced by commit 70e123373c05
> (rtc: Add support for Intersil ISL12057 I2C RTC chip), the vendor
> prefix 'isl' was used instead of the expected 'isil' (Intersil
> NASDAQ symbol). Recently, a patch from Philip Zabel (7a6540ca856a,
> ARM: mvebu: Change vendor prefix for Intersil Corporation to isil)
> fixed that prefix in ReadyNAS devices .dts files (AFAICT, the only
> kernel users at the moment).

They may be the only in kernel users but someone with an out of tree DT
may be using the existing prefix, we shouldn't break compatibility with
them so we should support both compatible strings even if we want to
deprecate the isl, one.
Arnaud Ebalard Nov. 6, 2014, 10:46 p.m. UTC | #2
Hi Mark,

Mark Brown <broonie@kernel.org> writes:

> On Wed, Nov 05, 2014 at 10:42:41PM +0100, Arnaud Ebalard wrote:
>
>> When Intersil ISL12057 driver was introduced by commit 70e123373c05
>> (rtc: Add support for Intersil ISL12057 I2C RTC chip), the vendor
>> prefix 'isl' was used instead of the expected 'isil' (Intersil
>> NASDAQ symbol). Recently, a patch from Philip Zabel (7a6540ca856a,
>> ARM: mvebu: Change vendor prefix for Intersil Corporation to isil)
>> fixed that prefix in ReadyNAS devices .dts files (AFAICT, the only
>> kernel users at the moment).
>
> They may be the only in kernel users but someone with an out of tree DT
> may be using the existing prefix, we shouldn't break compatibility with
> them so we should support both compatible strings even if we want to
> deprecate the isl, one.

Updating the patch in the following way should make it possible to
support out-of-tree users while avoiding additional uses of 'isl': 

- have two compatible entries in isl12057_dt_match struct instead of one
  i.e.:

    static const struct of_device_id isl12057_dt_match[] = {
   	{ .compatible = "isl,isl12057" },
   	{ .compatible = "isil,isl12057" },
    	{ },
    };

  I think it matches the situation we have.

- keeping the updates I had for trivial-devices.txt and
  vendor-prefixes.txt files.

Thoughts?

Cheers,

a+
Uwe Kleine-König Nov. 7, 2014, 6:39 a.m. UTC | #3
Hello Arnaud,

On Thu, Nov 06, 2014 at 11:46:21PM +0100, Arnaud Ebalard wrote:
> Mark Brown <broonie@kernel.org> writes:
> > On Wed, Nov 05, 2014 at 10:42:41PM +0100, Arnaud Ebalard wrote:
> >
> >> When Intersil ISL12057 driver was introduced by commit 70e123373c05
> >> (rtc: Add support for Intersil ISL12057 I2C RTC chip), the vendor
> >> prefix 'isl' was used instead of the expected 'isil' (Intersil
> >> NASDAQ symbol). Recently, a patch from Philip Zabel (7a6540ca856a,
> >> ARM: mvebu: Change vendor prefix for Intersil Corporation to isil)
> >> fixed that prefix in ReadyNAS devices .dts files (AFAICT, the only
> >> kernel users at the moment).
> >
> > They may be the only in kernel users but someone with an out of tree DT
> > may be using the existing prefix, we shouldn't break compatibility with
> > them so we should support both compatible strings even if we want to
> > deprecate the isl, one.
> 
> Updating the patch in the following way should make it possible to
> support out-of-tree users while avoiding additional uses of 'isl': 
> 
> - have two compatible entries in isl12057_dt_match struct instead of one
>   i.e.:
> 
>     static const struct of_device_id isl12057_dt_match[] = {
>    	{ .compatible = "isl,isl12057" },
>    	{ .compatible = "isil,isl12057" },
>     	{ },
>     };
> 
>   I think it matches the situation we have.
This should work. I suggest to add a comment to the obsolete one to
state not to use it for new boards.

Best regards
Uwe
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/i2c/trivial-devices.txt b/Documentation/devicetree/bindings/i2c/trivial-devices.txt
index fbde415078e6..edac97c0f756 100644
--- a/Documentation/devicetree/bindings/i2c/trivial-devices.txt
+++ b/Documentation/devicetree/bindings/i2c/trivial-devices.txt
@@ -55,7 +55,7 @@  fsl,sgtl5000		SGTL5000: Ultra Low-Power Audio Codec
 gmt,g751		G751: Digital Temperature Sensor and Thermal Watchdog with Two-Wire Interface
 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
+isil,isl12057		Intersil ISL12057 I2C RTC Chip
 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
diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
index 723999d73744..84193ecdc41c 100644
--- a/Documentation/devicetree/bindings/vendor-prefixes.txt
+++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
@@ -77,7 +77,7 @@  innolux	Innolux Corporation
 intel	Intel Corporation
 intercontrol	Inter Control Group
 isee	ISEE 2007 S.L.
-isl	Intersil
+isil	Intersil
 karo	Ka-Ro electronics GmbH
 keymile	Keymile GmbH
 lacie	LaCie
diff --git a/drivers/rtc/rtc-isl12057.c b/drivers/rtc/rtc-isl12057.c
index 8132fbc7e10a..adb0646236b1 100644
--- a/drivers/rtc/rtc-isl12057.c
+++ b/drivers/rtc/rtc-isl12057.c
@@ -279,7 +279,7 @@  static int isl12057_probe(struct i2c_client *client,
 
 #ifdef CONFIG_OF
 static const struct of_device_id isl12057_dt_match[] = {
-	{ .compatible = "isl,isl12057" },
+	{ .compatible = "isil,isl12057" },
 	{ },
 };
 #endif