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

Message ID 1561940895-15837-2-git-send-email-bdodge09@gmail.com
State Changes Requested
Headers show
Series
  • fix vendor prefix for arcxcnn driver and bindings
Related show

Checks

Context Check Description
robh/checkpatch success

Commit Message

Brian Dodge July 1, 2019, 12:28 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. This
patch adds "arctic" and retains "arc" (deprecated) bindings

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

Comments

Daniel Thompson July 2, 2019, 9:26 a.m. UTC | #1
> [PATCH 1/2] dt-bindings: backlight: fix vendor prefix for
> ArcticSand arcxcnn driver bindings

The "v2" is normally applied to the whole patchset (if you
prepare the patchset using git format-patch then you can use
the --subject-prefix argument for that).


On Sun, Jun 30, 2019 at 08:28:14PM -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. This
> patch adds "arctic" and retains "arc" (deprecated) bindings
> 
> Signed-off-by: Brian Dodge <bdodge09@gmail.com>
> ---
>  .../bindings/leds/backlight/arcxcnn_bl.txt         | 31 +++++++++++++++-------
>  1 file changed, 21 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..4d98394 100644
> --- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> +++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> @@ -1,8 +1,13 @@
> -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"
> +	"arc,arc2c0608" (deprecated)

Nothing wrong with adding compatible strings for arc1 and arc3 but I
would expect it to be mentioned in the description to reassure reviewers
that the right depth of thought has been applied Something like "Also added
compatible strings for other family members, all the existing optional
properties work the same way for the new devices." (if you agree that it
is true) is good to show you were paying proper attention!

However this does perhaps verge a little towards nitpicking so maybe
wait to see what the DT folks say. From my point of view:
Acked-by: Daniel Thompson <daniel.thompson@linaro.org>


Daniel.


> +
> +- reg:		slave address
>  
>  Optional properties:
>  - default-brightness:	brightness value on boot, value from: 0-4095
> @@ -11,19 +16,25 @@ 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
> +- arc,led-config-0:	setting for register ILED_CONFIG_0 (deprecated)
> +- arc,led-config-1:	setting for register ILED_CONFIG_1 (deprecated)
> +- arc,dim-freq:		PWM mode frequence setting (bits [3:0] used) (deprecated)
> +- arc,comp-config:	setting for register CONFIG_COMP (deprecated)
> +- arc,filter-config:	setting for register FILTER_CONFIG (deprecated)
> +- arc,trim-config:	setting for register IMAXTUNE (deprecated)
>  
>  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 July 2, 2019, 11:21 a.m. UTC | #2
On 7/2/19 5:26 AM, Daniel Thompson wrote:
>> [PATCH 1/2] dt-bindings: backlight: fix vendor prefix for
>> ArcticSand arcxcnn driver bindings
> The "v2" is normally applied to the whole patchset (if you
> prepare the patchset using git format-patch then you can use
> the --subject-prefix argument for that).
Sorry and noted
>
> On Sun, Jun 30, 2019 at 08:28:14PM -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. This
>> patch adds "arctic" and retains "arc" (deprecated) bindings
>>
>> Signed-off-by: Brian Dodge <bdodge09@gmail.com>
>> ---
>>   .../bindings/leds/backlight/arcxcnn_bl.txt         | 31 +++++++++++++++-------
>>   1 file changed, 21 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..4d98394 100644
>> --- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
>> +++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
>> @@ -1,8 +1,13 @@
>> -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"
>> +	"arc,arc2c0608" (deprecated)
> Nothing wrong with adding compatible strings for arc1 and arc3 but I
> would expect it to be mentioned in the description to reassure reviewers
> that the right depth of thought has been applied Something like "Also added
> compatible strings for other family members, all the existing optional
> properties work the same way for the new devices." (if you agree that it
> is true) is good to show you were paying proper attention!
>
> However this does perhaps verge a little towards nitpicking so maybe
> wait to see what the DT folks say. From my point of view:
> Acked-by: Daniel Thompson <daniel.thompson@linaro.org>
>
>
> Daniel.

Good point. I did actually think about this a bit. The *only* chip 
available at the time of the original driver was the arc2c0608 and that 
is the chip that is currently in use in the Samsung Chromebook Plus, and 
the only use I know of using the "arc" prefix. There will be no reason 
to ever support "arc,arc1.." or "arc,arc3..." in the bindings for past 
or future use.

The new two chips are just basically supported by this driver. There is 
more functionality to them which will be enabled in my next patch. I 
wanted to separate the move to "arctic" from the move to fully support 
the other chips for clarity (you guys are all rightly picky!) I did put 
the new chip bindings in the driver/bindings in this patch though so I 
could test this patch against the actual h/w instances: I have three 
boards, one with each chip type and each has a dtb with the "arctic,.." 
type binding onboard.

>> +
>> +- reg:		slave address
>>   
>>   Optional properties:
>>   - default-brightness:	brightness value on boot, value from: 0-4095
>> @@ -11,19 +16,25 @@ 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
>> +- arc,led-config-0:	setting for register ILED_CONFIG_0 (deprecated)
>> +- arc,led-config-1:	setting for register ILED_CONFIG_1 (deprecated)
>> +- arc,dim-freq:		PWM mode frequence setting (bits [3:0] used) (deprecated)
>> +- arc,comp-config:	setting for register CONFIG_COMP (deprecated)
>> +- arc,filter-config:	setting for register FILTER_CONFIG (deprecated)
>> +- arc,trim-config:	setting for register IMAXTUNE (deprecated)
>>   
>>   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
>>
Daniel Thompson July 2, 2019, 1:11 p.m. UTC | #3
On Tue, Jul 02, 2019 at 07:21:29AM -0400, Brian Dodge wrote:
> 
> On 7/2/19 5:26 AM, Daniel Thompson wrote:
> > > [PATCH 1/2] dt-bindings: backlight: fix vendor prefix for
> > > ArcticSand arcxcnn driver bindings
> > The "v2" is normally applied to the whole patchset (if you
> > prepare the patchset using git format-patch then you can use
> > the --subject-prefix argument for that).
> Sorry and noted
> > 
> > On Sun, Jun 30, 2019 at 08:28:14PM -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. This
> > > patch adds "arctic" and retains "arc" (deprecated) bindings
> > > 
> > > Signed-off-by: Brian Dodge <bdodge09@gmail.com>
> > > ---
> > >   .../bindings/leds/backlight/arcxcnn_bl.txt         | 31 +++++++++++++++-------
> > >   1 file changed, 21 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..4d98394 100644
> > > --- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> > > +++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> > > @@ -1,8 +1,13 @@
> > > -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"
> > > +	"arc,arc2c0608" (deprecated)
> > Nothing wrong with adding compatible strings for arc1 and arc3 but I
> > would expect it to be mentioned in the description to reassure reviewers
> > that the right depth of thought has been applied Something like "Also added
> > compatible strings for other family members, all the existing optional
> > properties work the same way for the new devices." (if you agree that it
> > is true) is good to show you were paying proper attention!
> > 
> > However this does perhaps verge a little towards nitpicking so maybe
> > wait to see what the DT folks say. From my point of view:
> > Acked-by: Daniel Thompson <daniel.thompson@linaro.org>
> > 
> > 
> > Daniel.
> 
> Good point. I did actually think about this a bit. The *only* chip available
> at the time of the original driver was the arc2c0608 and that is the chip
> that is currently in use in the Samsung Chromebook Plus, and the only use I
> know of using the "arc" prefix. There will be no reason to ever support
> "arc,arc1.." or "arc,arc3..." in the bindings for past or future use.
> 
> The new two chips are just basically supported by this driver. There is more
> functionality to them which will be enabled in my next patch. I wanted to
> separate the move to "arctic" from the move to fully support the other chips
> for clarity (you guys are all rightly picky!) I did put the new chip
> bindings in the driver/bindings in this patch though so I could test this
> patch against the actual h/w instances: I have three boards, one with each
> chip type and each has a dtb with the "arctic,.." type binding onboard.

I think you have misunderstood. I've got no problem with renaming the
properties as well.

What I was bringing up is that you have extended the scope of the
bindings to cover the arc1 and arc3 devices. It would be good for you
to explicitly confirm that the existing properties all still apply
to arc1 and arc3 devices, and that no new properties are needed to
model them properly.

As it happens I *did* glance at your old arc1/arc3 patch to check it for
myself before I offered you the Acked-by and didn't see anything that
offended me. However a good patch description would have spared me that
work...


Daniel.


> 
> > > +
> > > +- reg:		slave address
> > >   Optional properties:
> > >   - default-brightness:	brightness value on boot, value from: 0-4095
> > > @@ -11,19 +16,25 @@ 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
> > > +- arc,led-config-0:	setting for register ILED_CONFIG_0 (deprecated)
> > > +- arc,led-config-1:	setting for register ILED_CONFIG_1 (deprecated)
> > > +- arc,dim-freq:		PWM mode frequence setting (bits [3:0] used) (deprecated)
> > > +- arc,comp-config:	setting for register CONFIG_COMP (deprecated)
> > > +- arc,filter-config:	setting for register FILTER_CONFIG (deprecated)
> > > +- arc,trim-config:	setting for register IMAXTUNE (deprecated)
> > >   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 July 8, 2019, 6:02 p.m. UTC | #4
Brian

On 6/30/19 7:28 PM, 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. This
> patch adds "arctic" and retains "arc" (deprecated) bindings
>
> Signed-off-by: Brian Dodge <bdodge09@gmail.com>
> ---
>   .../bindings/leds/backlight/arcxcnn_bl.txt         | 31 +++++++++++++++-------
>   1 file changed, 21 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..4d98394 100644
> --- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> +++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
> @@ -1,8 +1,13 @@
> -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"
> +	"arc,arc2c0608" (deprecated)
> +
> +- reg:		slave address
>   
>   Optional properties:
>   - default-brightness:	brightness value on boot, value from: 0-4095
> @@ -11,19 +16,25 @@ 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
> +- arc,led-config-0:	setting for register ILED_CONFIG_0 (deprecated)
> +- arc,led-config-1:	setting for register ILED_CONFIG_1 (deprecated)
> +- arc,dim-freq:		PWM mode frequence setting (bits [3:0] used) (deprecated)
> +- arc,comp-config:	setting for register CONFIG_COMP (deprecated)
> +- arc,filter-config:	setting for register FILTER_CONFIG (deprecated)
> +- arc,trim-config:	setting for register IMAXTUNE (deprecated)
>   
>   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";


Reviewed-by: Dan Murphy <dmurphy@ti.com>

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
index 230abde..4d98394 100644
--- a/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
+++ b/Documentation/devicetree/bindings/leds/backlight/arcxcnn_bl.txt
@@ -1,8 +1,13 @@ 
-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"
+	"arc,arc2c0608" (deprecated)
+
+- reg:		slave address
 
 Optional properties:
 - default-brightness:	brightness value on boot, value from: 0-4095
@@ -11,19 +16,25 @@  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
+- arc,led-config-0:	setting for register ILED_CONFIG_0 (deprecated)
+- arc,led-config-1:	setting for register ILED_CONFIG_1 (deprecated)
+- arc,dim-freq:		PWM mode frequence setting (bits [3:0] used) (deprecated)
+- arc,comp-config:	setting for register CONFIG_COMP (deprecated)
+- arc,filter-config:	setting for register FILTER_CONFIG (deprecated)
+- arc,trim-config:	setting for register IMAXTUNE (deprecated)
 
 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";