diff mbox series

[1/2] dt-bindings: backlight: fix vendor prefix for ArcticSand arcxcnn driver bindings

Message ID 1561435529-7835-2-git-send-email-bdodge09@gmail.com (mailing list archive)
State New, archived
Headers show
Series fix vendor prefix for arcxcnn driver and bindings | expand

Commit Message

Brian Dodge June 25, 2019, 4:05 a.m. UTC
The vendor-prefixes.txt file properly refers to ArcticSand
    as arctic but the driver bindings improperly abbreviated the
    prefix to arc. This was a mistake in the original patch

Signed-off-by: Brian Dodge <bdodge09@gmail.com>
---
 .../bindings/leds/backlight/arcxcnn_bl.txt         | 24 +++++++++++++---------
 1 file changed, 14 insertions(+), 10 deletions(-)

Comments

Daniel Thompson June 25, 2019, 8:55 a.m. UTC | #1
On Tue, Jun 25, 2019 at 12:05:28AM -0400, Brian Dodge wrote:
>     The vendor-prefixes.txt file properly refers to ArcticSand
>     as arctic but the driver bindings improperly abbreviated the
>     prefix to arc. This was a mistake in the original patch
> 
> Signed-off-by: Brian Dodge <bdodge09@gmail.com>
> ---
>  .../bindings/leds/backlight/arcxcnn_bl.txt         | 24 +++++++++++++---------
>  1 file changed, 14 insertions(+), 10 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> index 230abde..9cf4c44 100644
> --- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> +++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> @@ -1,8 +1,12 @@
> -Binding for ArcticSand arc2c0608 LED driver
> +Binding for ArcticSand arc family LED drivers
>  
>  Required properties:
> -- compatible:		should be "arc,arc2c0608"
> -- reg:			slave address
> +- compatible: one of
> +	"arctic,arc1c0608"
> +	"arctic,arc2c0608"
> +	"arctic,arc3c0845"

This is more a question for the DT folks than for Brian but...

AFAICT this patch is fixing the binding for the ArcticSand devices to
use the correct value from vendor-prefixes.yaml and has been previously
discussed here:
https://lkml.org/lkml/2018/9/25/726

Currently this patch series just updates the DT bindings but the
implementation also honours the old values (since there is a Chromebook
in the wild that uses the current bindings).

Hence I'm not clear whether the bindings should document the deprecated
options too (e.g. make it easier to find the bindings doc with git grep
and friends).


Daniel.


> +
> +- reg:		slave address
>  
>  Optional properties:
>  - default-brightness:	brightness value on boot, value from: 0-4095
> @@ -11,19 +15,19 @@ Optional properties:
>  - led-sources:		List of enabled channels from 0 to 5.
>  			See Documentation/devicetree/bindings/leds/common.txt
>  
> -- arc,led-config-0:	setting for register ILED_CONFIG_0
> -- arc,led-config-1:	setting for register ILED_CONFIG_1
> -- arc,dim-freq:		PWM mode frequence setting (bits [3:0] used)
> -- arc,comp-config:	setting for register CONFIG_COMP
> -- arc,filter-config:	setting for register FILTER_CONFIG
> -- arc,trim-config:	setting for register IMAXTUNE
> +- arctic,led-config-0:	setting for register ILED_CONFIG_0
> +- arctic,led-config-1:	setting for register ILED_CONFIG_1
> +- arctic,dim-freq:		PWM mode frequence setting (bits [3:0] used)
> +- arctic,comp-config:	setting for register CONFIG_COMP
> +- arctic,filter-config:	setting for register FILTER_CONFIG
> +- arctic,trim-config:	setting for register IMAXTUNE
>  
>  Note: Optional properties not specified will default to values in IC EPROM
>  
>  Example:
>  
>  arc2c0608@30 {
> -	compatible = "arc,arc2c0608";
> +	compatible = "arctic,arc2c0608";
>  	reg = <0x30>;
>  	default-brightness = <500>;
>  	label = "lcd-backlight";
> -- 
> 2.7.4
>
Brian Dodge June 25, 2019, 11:44 a.m. UTC | #2
I would like to deprecate the old prefix in the future after communicating
with all chip customers, which is why the old prefix is not documented in
the new bindings.


On Tue, Jun 25, 2019, 4:55 AM Daniel Thompson <daniel.thompson@linaro.org>
wrote:

> On Tue, Jun 25, 2019 at 12:05:28AM -0400, Brian Dodge wrote:
> >     The vendor-prefixes.txt file properly refers to ArcticSand
> >     as arctic but the driver bindings improperly abbreviated the
> >     prefix to arc. This was a mistake in the original patch
> >
> > Signed-off-by: Brian Dodge <bdodge09@gmail.com>
> > ---
> >  .../bindings/leds/backlight/arcxcnn_bl.txt         | 24
> +++++++++++++---------
> >  1 file changed, 14 insertions(+), 10 deletions(-)
> >
> > diff --git
> a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> > index 230abde..9cf4c44 100644
> > --- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> > +++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> > @@ -1,8 +1,12 @@
> > -Binding for ArcticSand arc2c0608 LED driver
> > +Binding for ArcticSand arc family LED drivers
> >
> >  Required properties:
> > -- compatible:                should be "arc,arc2c0608"
> > -- reg:                       slave address
> > +- compatible: one of
> > +     "arctic,arc1c0608"
> > +     "arctic,arc2c0608"
> > +     "arctic,arc3c0845"
>
> This is more a question for the DT folks than for Brian but...
>
> AFAICT this patch is fixing the binding for the ArcticSand devices to
> use the correct value from vendor-prefixes.yaml and has been previously
> discussed here:
> https://lkml.org/lkml/2018/9/25/726
>
> Currently this patch series just updates the DT bindings but the
> implementation also honours the old values (since there is a Chromebook
> in the wild that uses the current bindings).
>
> Hence I'm not clear whether the bindings should document the deprecated
> options too (e.g. make it easier to find the bindings doc with git grep
> and friends).
>
>
> Daniel.
>
>
> > +
> > +- reg:               slave address
> >
> >  Optional properties:
> >  - default-brightness:        brightness value on boot, value from:
> 0-4095
> > @@ -11,19 +15,19 @@ Optional properties:
> >  - led-sources:               List of enabled channels from 0 to 5.
> >                       See
> Documentation/devicetree/bindings/leds/common.txt
> >
> > -- arc,led-config-0:  setting for register ILED_CONFIG_0
> > -- arc,led-config-1:  setting for register ILED_CONFIG_1
> > -- arc,dim-freq:              PWM mode frequence setting (bits [3:0]
> used)
> > -- arc,comp-config:   setting for register CONFIG_COMP
> > -- arc,filter-config: setting for register FILTER_CONFIG
> > -- arc,trim-config:   setting for register IMAXTUNE
> > +- arctic,led-config-0:       setting for register ILED_CONFIG_0
> > +- arctic,led-config-1:       setting for register ILED_CONFIG_1
> > +- arctic,dim-freq:           PWM mode frequence setting (bits [3:0]
> used)
> > +- arctic,comp-config:        setting for register CONFIG_COMP
> > +- arctic,filter-config:      setting for register FILTER_CONFIG
> > +- arctic,trim-config:        setting for register IMAXTUNE
> >
> >  Note: Optional properties not specified will default to values in IC
> EPROM
> >
> >  Example:
> >
> >  arc2c0608@30 {
> > -     compatible = "arc,arc2c0608";
> > +     compatible = "arctic,arc2c0608";
> >       reg = <0x30>;
> >       default-brightness = <500>;
> >       label = "lcd-backlight";
> > --
> > 2.7.4
> >
>
<div dir="auto">I would like to deprecate the old prefix in the future after communicating with all chip customers, which is why the old prefix is not documented in the new bindings.<div dir="auto"><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Jun 25, 2019, 4:55 AM Daniel Thompson &lt;<a href="mailto:daniel.thompson@linaro.org" target="_blank" rel="noreferrer">daniel.thompson@linaro.org</a>&gt; wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On Tue, Jun 25, 2019 at 12:05:28AM -0400, Brian Dodge wrote:<br>
&gt;     The vendor-prefixes.txt file properly refers to ArcticSand<br>
&gt;     as arctic but the driver bindings improperly abbreviated the<br>
&gt;     prefix to arc. This was a mistake in the original patch<br>
&gt; <br>
&gt; Signed-off-by: Brian Dodge &lt;<a href="mailto:bdodge09@gmail.com" rel="noreferrer noreferrer" target="_blank">bdodge09@gmail.com</a>&gt;<br>
&gt; ---<br>
&gt;  .../bindings/leds/backlight/arcxcnn_bl.txt         | 24 +++++++++++++---------<br>
&gt;  1 file changed, 14 insertions(+), 10 deletions(-)<br>
&gt; <br>
&gt; diff --git a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt<br>
&gt; index 230abde..9cf4c44 100644<br>
&gt; --- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt<br>
&gt; +++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt<br>
&gt; @@ -1,8 +1,12 @@<br>
&gt; -Binding for ArcticSand arc2c0608 LED driver<br>
&gt; +Binding for ArcticSand arc family LED drivers<br>
&gt;  <br>
&gt;  Required properties:<br>
&gt; -- compatible:                should be &quot;arc,arc2c0608&quot;<br>
&gt; -- reg:                       slave address<br>
&gt; +- compatible: one of<br>
&gt; +     &quot;arctic,arc1c0608&quot;<br>
&gt; +     &quot;arctic,arc2c0608&quot;<br>
&gt; +     &quot;arctic,arc3c0845&quot;<br>
<br>
This is more a question for the DT folks than for Brian but...<br>
<br>
AFAICT this patch is fixing the binding for the ArcticSand devices to<br>
use the correct value from vendor-prefixes.yaml and has been previously<br>
discussed here:<br>
<a href="https://lkml.org/lkml/2018/9/25/726" rel="noreferrer noreferrer noreferrer" target="_blank">https://lkml.org/lkml/2018/9/25/726</a><br>
<br>
Currently this patch series just updates the DT bindings but the<br>
implementation also honours the old values (since there is a Chromebook<br>
in the wild that uses the current bindings).<br>
<br>
Hence I&#39;m not clear whether the bindings should document the deprecated<br>
options too (e.g. make it easier to find the bindings doc with git grep<br>
and friends).<br>
<br>
<br>
Daniel.<br>
<br>
<br>
&gt; +<br>
&gt; +- reg:               slave address<br>
&gt;  <br>
&gt;  Optional properties:<br>
&gt;  - default-brightness:        brightness value on boot, value from: 0-4095<br>
&gt; @@ -11,19 +15,19 @@ Optional properties:<br>
&gt;  - led-sources:               List of enabled channels from 0 to 5.<br>
&gt;                       See Documentation/devicetree/bindings/leds/common.txt<br>
&gt;  <br>
&gt; -- arc,led-config-0:  setting for register ILED_CONFIG_0<br>
&gt; -- arc,led-config-1:  setting for register ILED_CONFIG_1<br>
&gt; -- arc,dim-freq:              PWM mode frequence setting (bits [3:0] used)<br>
&gt; -- arc,comp-config:   setting for register CONFIG_COMP<br>
&gt; -- arc,filter-config: setting for register FILTER_CONFIG<br>
&gt; -- arc,trim-config:   setting for register IMAXTUNE<br>
&gt; +- arctic,led-config-0:       setting for register ILED_CONFIG_0<br>
&gt; +- arctic,led-config-1:       setting for register ILED_CONFIG_1<br>
&gt; +- arctic,dim-freq:           PWM mode frequence setting (bits [3:0] used)<br>
&gt; +- arctic,comp-config:        setting for register CONFIG_COMP<br>
&gt; +- arctic,filter-config:      setting for register FILTER_CONFIG<br>
&gt; +- arctic,trim-config:        setting for register IMAXTUNE<br>
&gt;  <br>
&gt;  Note: Optional properties not specified will default to values in IC EPROM<br>
&gt;  <br>
&gt;  Example:<br>
&gt;  <br>
&gt;  arc2c0608@30 {<br>
&gt; -     compatible = &quot;arc,arc2c0608&quot;;<br>
&gt; +     compatible = &quot;arctic,arc2c0608&quot;;<br>
&gt;       reg = &lt;0x30&gt;;<br>
&gt;       default-brightness = &lt;500&gt;;<br>
&gt;       label = &quot;lcd-backlight&quot;;<br>
&gt; -- <br>
&gt; 2.7.4<br>
&gt; <br>
</blockquote></div>
Daniel Thompson June 26, 2019, 10:56 a.m. UTC | #3
On Tue, Jun 25, 2019 at 07:44:06AM -0400, Brian Dodge wrote:
> I would like to deprecate the old prefix in the future after communicating
> with all chip customers, which is why the old prefix is not documented in
> the new bindings.

Deprecation is fine (by me at least) it's just that I'm not sure that
removing the documentation for the deprecated bindings is the right way
to do it. What is the prior art here?


Daniel.



> 
> 
> On Tue, Jun 25, 2019, 4:55 AM Daniel Thompson <daniel.thompson@linaro.org>
> wrote:
> 
> > On Tue, Jun 25, 2019 at 12:05:28AM -0400, Brian Dodge wrote:
> > >     The vendor-prefixes.txt file properly refers to ArcticSand
> > >     as arctic but the driver bindings improperly abbreviated the
> > >     prefix to arc. This was a mistake in the original patch
> > >
> > > Signed-off-by: Brian Dodge <bdodge09@gmail.com>
> > > ---
> > >  .../bindings/leds/backlight/arcxcnn_bl.txt         | 24
> > +++++++++++++---------
> > >  1 file changed, 14 insertions(+), 10 deletions(-)
> > >
> > > diff --git
> > a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> > b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> > > index 230abde..9cf4c44 100644
> > > --- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> > > +++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> > > @@ -1,8 +1,12 @@
> > > -Binding for ArcticSand arc2c0608 LED driver
> > > +Binding for ArcticSand arc family LED drivers
> > >
> > >  Required properties:
> > > -- compatible:                should be "arc,arc2c0608"
> > > -- reg:                       slave address
> > > +- compatible: one of
> > > +     "arctic,arc1c0608"
> > > +     "arctic,arc2c0608"
> > > +     "arctic,arc3c0845"
> >
> > This is more a question for the DT folks than for Brian but...
> >
> > AFAICT this patch is fixing the binding for the ArcticSand devices to
> > use the correct value from vendor-prefixes.yaml and has been previously
> > discussed here:
> > https://lkml.org/lkml/2018/9/25/726
> >
> > Currently this patch series just updates the DT bindings but the
> > implementation also honours the old values (since there is a Chromebook
> > in the wild that uses the current bindings).
> >
> > Hence I'm not clear whether the bindings should document the deprecated
> > options too (e.g. make it easier to find the bindings doc with git grep
> > and friends).
> >
> >
> > Daniel.
> >
> >
> > > +
> > > +- reg:               slave address
> > >
> > >  Optional properties:
> > >  - default-brightness:        brightness value on boot, value from:
> > 0-4095
> > > @@ -11,19 +15,19 @@ Optional properties:
> > >  - led-sources:               List of enabled channels from 0 to 5.
> > >                       See
> > Documentation/devicetree/bindings/leds/common.txt
> > >
> > > -- arc,led-config-0:  setting for register ILED_CONFIG_0
> > > -- arc,led-config-1:  setting for register ILED_CONFIG_1
> > > -- arc,dim-freq:              PWM mode frequence setting (bits [3:0]
> > used)
> > > -- arc,comp-config:   setting for register CONFIG_COMP
> > > -- arc,filter-config: setting for register FILTER_CONFIG
> > > -- arc,trim-config:   setting for register IMAXTUNE
> > > +- arctic,led-config-0:       setting for register ILED_CONFIG_0
> > > +- arctic,led-config-1:       setting for register ILED_CONFIG_1
> > > +- arctic,dim-freq:           PWM mode frequence setting (bits [3:0]
> > used)
> > > +- arctic,comp-config:        setting for register CONFIG_COMP
> > > +- arctic,filter-config:      setting for register FILTER_CONFIG
> > > +- arctic,trim-config:        setting for register IMAXTUNE
> > >
> > >  Note: Optional properties not specified will default to values in IC
> > EPROM
> > >
> > >  Example:
> > >
> > >  arc2c0608@30 {
> > > -     compatible = "arc,arc2c0608";
> > > +     compatible = "arctic,arc2c0608";
> > >       reg = <0x30>;
> > >       default-brightness = <500>;
> > >       label = "lcd-backlight";
> > > --
> > > 2.7.4
> > >
> >
Dan Murphy June 26, 2019, 11:44 a.m. UTC | #4
Hello

On 6/25/19 3:55 AM, Daniel Thompson wrote:
> On Tue, Jun 25, 2019 at 12:05:28AM -0400, Brian Dodge wrote:
>>      The vendor-prefixes.txt file properly refers to ArcticSand
>>      as arctic but the driver bindings improperly abbreviated the
>>      prefix to arc. This was a mistake in the original patch
>>
>> Signed-off-by: Brian Dodge <bdodge09@gmail.com>
>> ---
>>   .../bindings/leds/backlight/arcxcnn_bl.txt         | 24 +++++++++++++---------
>>   1 file changed, 14 insertions(+), 10 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
>> index 230abde..9cf4c44 100644
>> --- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
>> +++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
>> @@ -1,8 +1,12 @@
>> -Binding for ArcticSand arc2c0608 LED driver
>> +Binding for ArcticSand arc family LED drivers
>>   
>>   Required properties:
>> -- compatible:		should be "arc,arc2c0608"
>> -- reg:			slave address
>> +- compatible: one of
>> +	"arctic,arc1c0608"
>> +	"arctic,arc2c0608"
>> +	"arctic,arc3c0845"
> This is more a question for the DT folks than for Brian but...
>
> AFAICT this patch is fixing the binding for the ArcticSand devices to
> use the correct value from vendor-prefixes.yaml and has been previously
> discussed here:
> https://lkml.org/lkml/2018/9/25/726
>
> Currently this patch series just updates the DT bindings but the
> implementation also honours the old values (since there is a Chromebook
> in the wild that uses the current bindings).
>
> Hence I'm not clear whether the bindings should document the deprecated
> options too (e.g. make it easier to find the bindings doc with git grep
> and friends).
>
>
> Daniel.
>
>
>> +
>> +- reg:		slave address
>>   
>>   Optional properties:
>>   - default-brightness:	brightness value on boot, value from: 0-4095
>> @@ -11,19 +15,19 @@ Optional properties:
>>   - led-sources:		List of enabled channels from 0 to 5.
>>   			See Documentation/devicetree/bindings/leds/common.txt
>>   
>> -- arc,led-config-0:	setting for register ILED_CONFIG_0
>> -- arc,led-config-1:	setting for register ILED_CONFIG_1
>> -- arc,dim-freq:		PWM mode frequence setting (bits [3:0] used)
>> -- arc,comp-config:	setting for register CONFIG_COMP
>> -- arc,filter-config:	setting for register FILTER_CONFIG
>> -- arc,trim-config:	setting for register IMAXTUNE

IMO I would prefer to keep these and mark them as deprecated since the 
driver will still

honor these properties.

Maybe in a Optional Deprecated Properties section in the DT binding.

Dan


>> +- arctic,led-config-0:	setting for register ILED_CONFIG_0
>> +- arctic,led-config-1:	setting for register ILED_CONFIG_1
>> +- arctic,dim-freq:		PWM mode frequence setting (bits [3:0] used)
>> +- arctic,comp-config:	setting for register CONFIG_COMP
>> +- arctic,filter-config:	setting for register FILTER_CONFIG
>> +- arctic,trim-config:	setting for register IMAXTUNE
>>   
>>   Note: Optional properties not specified will default to values in IC EPROM
>>   
>>   Example:
>>   
>>   arc2c0608@30 {
>> -	compatible = "arc,arc2c0608";
>> +	compatible = "arctic,arc2c0608";
>>   	reg = <0x30>;
>>   	default-brightness = <500>;
>>   	label = "lcd-backlight";
>> -- 
>> 2.7.4
>>
Lee Jones June 26, 2019, 1:22 p.m. UTC | #5
On Wed, 26 Jun 2019, Daniel Thompson wrote:

> On Tue, Jun 25, 2019 at 07:44:06AM -0400, Brian Dodge wrote:
> > I would like to deprecate the old prefix in the future after communicating
> > with all chip customers, which is why the old prefix is not documented in
> > the new bindings.
> 
> Deprecation is fine (by me at least) it's just that I'm not sure that
> removing the documentation for the deprecated bindings is the right way
> to do it. What is the prior art here?

I'd let Rob et al. make the final decision.
Rob Herring June 26, 2019, 2:43 p.m. UTC | #6
On Wed, Jun 26, 2019 at 4:56 AM Daniel Thompson
<daniel.thompson@linaro.org> wrote:
>
> On Tue, Jun 25, 2019 at 07:44:06AM -0400, Brian Dodge wrote:
> > I would like to deprecate the old prefix in the future after communicating
> > with all chip customers, which is why the old prefix is not documented in
> > the new bindings.
>
> Deprecation is fine (by me at least) it's just that I'm not sure that
> removing the documentation for the deprecated bindings is the right way
> to do it. What is the prior art here?

Kind of depends on how widely used something is and we've done both
ways generally. If there are not any upstream dts files, removal is
fine IMO.

With schema, there's a 'deprecated' keyword coming in draft8. So we'll
have a defined way to keep things documented as needed and also warn
about their use.

Rob
Pavel Machek June 26, 2019, 2:56 p.m. UTC | #7
On Wed 2019-06-26 11:56:14, Daniel Thompson wrote:
> On Tue, Jun 25, 2019 at 07:44:06AM -0400, Brian Dodge wrote:
> > I would like to deprecate the old prefix in the future after communicating
> > with all chip customers, which is why the old prefix is not documented in
> > the new bindings.
> 
> Deprecation is fine (by me at least) it's just that I'm not sure that
> removing the documentation for the deprecated bindings is the right way
> to do it. What is the prior art here?

I believe we should keep the docs.

								Pavel
Brian Dodge June 26, 2019, 2:59 p.m. UTC | #8
Is there a standard way to format to-be-deprecated items in the bindings?


On Wed, Jun 26, 2019, 10:56 AM Pavel Machek <pavel@ucw.cz> wrote:

> On Wed 2019-06-26 11:56:14, Daniel Thompson wrote:
> > On Tue, Jun 25, 2019 at 07:44:06AM -0400, Brian Dodge wrote:
> > > I would like to deprecate the old prefix in the future after
> communicating
> > > with all chip customers, which is why the old prefix is not documented
> in
> > > the new bindings.
> >
> > Deprecation is fine (by me at least) it's just that I'm not sure that
> > removing the documentation for the deprecated bindings is the right way
> > to do it. What is the prior art here?
>
> I believe we should keep the docs.
>
>                                                                 Pavel
>
<div dir="auto">Is there a standard way to format to-be-deprecated items in the bindings?<div dir="auto"><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Jun 26, 2019, 10:56 AM Pavel Machek &lt;<a href="mailto:pavel@ucw.cz">pavel@ucw.cz</a>&gt; wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On Wed 2019-06-26 11:56:14, Daniel Thompson wrote:<br>
&gt; On Tue, Jun 25, 2019 at 07:44:06AM -0400, Brian Dodge wrote:<br>
&gt; &gt; I would like to deprecate the old prefix in the future after communicating<br>
&gt; &gt; with all chip customers, which is why the old prefix is not documented in<br>
&gt; &gt; the new bindings.<br>
&gt; <br>
&gt; Deprecation is fine (by me at least) it&#39;s just that I&#39;m not sure that<br>
&gt; removing the documentation for the deprecated bindings is the right way<br>
&gt; to do it. What is the prior art here?<br>
<br>
I believe we should keep the docs.<br>
<br>
                                                                Pavel<br>
</blockquote></div>
Dan Murphy June 26, 2019, 3:09 p.m. UTC | #9
On 6/26/19 9:56 AM, Pavel Machek wrote:
> On Wed 2019-06-26 11:56:14, Daniel Thompson wrote:
>> On Tue, Jun 25, 2019 at 07:44:06AM -0400, Brian Dodge wrote:
>>> I would like to deprecate the old prefix in the future after communicating
>>> with all chip customers, which is why the old prefix is not documented in
>>> the new bindings.
>> Deprecation is fine (by me at least) it's just that I'm not sure that
>> removing the documentation for the deprecated bindings is the right way
>> to do it. What is the prior art here?
> I believe we should keep the docs.

I agree with Pavel on keeping the docs.

Keep the doc but mark the properties as deprecated since they are not 
removed from

the code

Dan


> 								Pavel
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
index 230abde..9cf4c44 100644
--- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
+++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
@@ -1,8 +1,12 @@ 
-Binding for ArcticSand arc2c0608 LED driver
+Binding for ArcticSand arc family LED drivers
 
 Required properties:
-- compatible:		should be "arc,arc2c0608"
-- reg:			slave address
+- compatible: one of
+	"arctic,arc1c0608"
+	"arctic,arc2c0608"
+	"arctic,arc3c0845"
+
+- reg:		slave address
 
 Optional properties:
 - default-brightness:	brightness value on boot, value from: 0-4095
@@ -11,19 +15,19 @@  Optional properties:
 - led-sources:		List of enabled channels from 0 to 5.
 			See Documentation/devicetree/bindings/leds/common.txt
 
-- arc,led-config-0:	setting for register ILED_CONFIG_0
-- arc,led-config-1:	setting for register ILED_CONFIG_1
-- arc,dim-freq:		PWM mode frequence setting (bits [3:0] used)
-- arc,comp-config:	setting for register CONFIG_COMP
-- arc,filter-config:	setting for register FILTER_CONFIG
-- arc,trim-config:	setting for register IMAXTUNE
+- arctic,led-config-0:	setting for register ILED_CONFIG_0
+- arctic,led-config-1:	setting for register ILED_CONFIG_1
+- arctic,dim-freq:		PWM mode frequence setting (bits [3:0] used)
+- arctic,comp-config:	setting for register CONFIG_COMP
+- arctic,filter-config:	setting for register FILTER_CONFIG
+- arctic,trim-config:	setting for register IMAXTUNE
 
 Note: Optional properties not specified will default to values in IC EPROM
 
 Example:
 
 arc2c0608@30 {
-	compatible = "arc,arc2c0608";
+	compatible = "arctic,arc2c0608";
 	reg = <0x30>;
 	default-brightness = <500>;
 	label = "lcd-backlight";