linux-arm-kernel.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation: dt: list all compatible strings for at91
@ 2014-03-19 10:26 Alexandre Belloni
  2014-03-19 10:33 ` Nicolas Ferre
  2014-03-19 16:14 ` Rob Herring
  0 siblings, 2 replies; 6+ messages in thread
From: Alexandre Belloni @ 2014-03-19 10:26 UTC (permalink / raw)
  To: linux-arm-kernel

Avoids getting the newly introduced warning:
WARNING: DT compatible string "atmel,at91sam9g45-adc" appears un-documented -- check ./Documentation/devicetree/bindings/
+				compatible = "atmel,at91sam9g45-adc";

Introduced by:
bff5da433525 checkpatch: add DT compatible string documentation checks

Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>
---
 Documentation/devicetree/bindings/arm/atmel-aic.txt      |  3 +--
 Documentation/devicetree/bindings/arm/atmel-at91.txt     | 10 ++++------
 Documentation/devicetree/bindings/dma/atmel-dma.txt      |  2 +-
 Documentation/devicetree/bindings/gpio/gpio_atmel.txt    |  2 +-
 Documentation/devicetree/bindings/iio/adc/at91_adc.txt   |  4 ++--
 Documentation/devicetree/bindings/serial/atmel-usart.txt | 10 ++++------
 6 files changed, 13 insertions(+), 18 deletions(-)

diff --git a/Documentation/devicetree/bindings/arm/atmel-aic.txt b/Documentation/devicetree/bindings/arm/atmel-aic.txt
index 2742e9cfd6b1..95f75fd097ba 100644
--- a/Documentation/devicetree/bindings/arm/atmel-aic.txt
+++ b/Documentation/devicetree/bindings/arm/atmel-aic.txt
@@ -1,8 +1,7 @@
 * Advanced Interrupt Controller (AIC)
 
 Required properties:
-- compatible: Should be "atmel,<chip>-aic"
-  <chip> can be "at91rm9200" or "sama5d3"
+- compatible: "atmel,at91rm9200-aic", "atmel,sama5d3-aic"
 - interrupt-controller: Identifies the node as an interrupt controller.
 - interrupt-parent: For single AIC system, it is an empty property.
 - #interrupt-cells: The number of cells to define the interrupts. It should be 3.
diff --git a/Documentation/devicetree/bindings/arm/atmel-at91.txt b/Documentation/devicetree/bindings/arm/atmel-at91.txt
index 16f60b41c147..e79a33315e4f 100644
--- a/Documentation/devicetree/bindings/arm/atmel-at91.txt
+++ b/Documentation/devicetree/bindings/arm/atmel-at91.txt
@@ -14,8 +14,7 @@ System Timer (ST) required properties:
   shared across all System Controller members.
 
 TC/TCLIB Timer required properties:
-- compatible: Should be "atmel,<chip>-tcb".
-  <chip> can be "at91rm9200" or "at91sam9x5"
+- compatible: "atmel,at91rm9200-tcb", "atmel,at91sam9x5-tcb"
 - reg: Should contain registers location and length
 - interrupts: Should contain all interrupts for the TC block
   Note that you can specify several interrupt cells if the TC
@@ -46,8 +45,7 @@ One interrupt per TC channel in a TC block:
 	};
 
 RSTC Reset Controller required properties:
-- compatible: Should be "atmel,<chip>-rstc".
-  <chip> can be "at91sam9260" or "at91sam9g45"
+- compatible: "atmel,at91sam9260-rstc", "atmel,at91sam9g45-rstc"
 - reg: Should contain registers location and length
 
 Example:
@@ -80,8 +78,8 @@ Examples:
 SHDWC Shutdown Controller
 
 required properties:
-- compatible: Should be "atmel,<chip>-shdwc".
-  <chip> can be "at91sam9260", "at91sam9rl" or "at91sam9x5".
+- compatible: "atmel,at91sam9260-shdwc", "atmel,at91sam9rl-shdwc",
+	"atmel,at91sam9x5-shdwc"
 - reg: Should contain registers location and length
 
 optional properties:
diff --git a/Documentation/devicetree/bindings/dma/atmel-dma.txt b/Documentation/devicetree/bindings/dma/atmel-dma.txt
index f69bcf5a6343..410bff989949 100644
--- a/Documentation/devicetree/bindings/dma/atmel-dma.txt
+++ b/Documentation/devicetree/bindings/dma/atmel-dma.txt
@@ -1,7 +1,7 @@
 * Atmel Direct Memory Access Controller (DMA)
 
 Required properties:
-- compatible: Should be "atmel,<chip>-dma".
+- compatible: "atmel,at91sam9rl-dma", "atmel,at91sam9g45-dma"
 - reg: Should contain DMA registers location and length.
 - interrupts: Should contain DMA interrupt.
 - #dma-cells: Must be <2>, used to represent the number of integer cells in
diff --git a/Documentation/devicetree/bindings/gpio/gpio_atmel.txt b/Documentation/devicetree/bindings/gpio/gpio_atmel.txt
index 85f8c0d084fa..1fa10565adcc 100644
--- a/Documentation/devicetree/bindings/gpio/gpio_atmel.txt
+++ b/Documentation/devicetree/bindings/gpio/gpio_atmel.txt
@@ -1,7 +1,7 @@
 * Atmel GPIO controller (PIO)
 
 Required properties:
-- compatible: "atmel,<chip>-gpio", where <chip> is at91rm9200 or at91sam9x5.
+- compatible: "atmel,at91rm9200-gpio", "atmel,at91rm9x5-gpio"
 - reg: Should contain GPIO controller registers location and length
 - interrupts: Should be the port interrupt shared by all the pins.
 - #gpio-cells: Should be two.  The first cell is the pin number and
diff --git a/Documentation/devicetree/bindings/iio/adc/at91_adc.txt b/Documentation/devicetree/bindings/iio/adc/at91_adc.txt
index 82061c7e4fea..ac26cc13dd9f 100644
--- a/Documentation/devicetree/bindings/iio/adc/at91_adc.txt
+++ b/Documentation/devicetree/bindings/iio/adc/at91_adc.txt
@@ -1,8 +1,8 @@
 * AT91's Analog to Digital Converter (ADC)
 
 Required properties:
-  - compatible: Should be "atmel,<chip>-adc"
-    <chip> can be "at91sam9260", "at91sam9g45" or "at91sam9x5"
+  - compatible: "atmel,at91sam9260-adc", "atmel,at91sam9rl-adc",
+  		"atmel,at91sam9g45-adc", "atmel,at91sam9x5-adc",
   - reg: Should contain ADC registers location and length
   - interrupts: Should contain the IRQ line for the ADC
   - atmel,adc-channels-used: Bitmask of the channels muxed and enabled for this
diff --git a/Documentation/devicetree/bindings/serial/atmel-usart.txt b/Documentation/devicetree/bindings/serial/atmel-usart.txt
index 9c5d19ac935c..ebc5b0cb7669 100644
--- a/Documentation/devicetree/bindings/serial/atmel-usart.txt
+++ b/Documentation/devicetree/bindings/serial/atmel-usart.txt
@@ -1,9 +1,7 @@
 * Atmel Universal Synchronous Asynchronous Receiver/Transmitter (USART)
 
 Required properties:
-- compatible: Should be "atmel,<chip>-usart"
-  The compatible <chip> indicated will be the first SoC to support an
-  additional mode or an USART new feature.
+- compatible: Should be "atmel,at91rm9200-usart", "atmel,at91sam9260-usart",
 - reg: Should contain registers location and length
 - interrupts: Should contain interrupt
 - clock-names: tuple listing input clock names.
@@ -19,9 +17,9 @@ Optional properties:
 		Refer to dma.txt and atmel-dma.txt for details.
 	- dma-names: "rx" for RX channel, "tx" for TX channel.
 
-<chip> compatible description:
-- at91rm9200:  legacy USART support
-- at91sam9260: generic USART implementation for SAM9 SoCs
+compatible description:
+- atmel,at91rm9200-usart:  legacy USART support
+- atmel,at91sam9260-usart: generic USART implementation for SAM9 SoCs
 
 Example:
 - use PDC:
-- 
1.8.3.2

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH] Documentation: dt: list all compatible strings for at91
  2014-03-19 10:26 [PATCH] Documentation: dt: list all compatible strings for at91 Alexandre Belloni
@ 2014-03-19 10:33 ` Nicolas Ferre
  2014-03-19 10:46   ` Alexandre Belloni
  2014-03-19 16:14 ` Rob Herring
  1 sibling, 1 reply; 6+ messages in thread
From: Nicolas Ferre @ 2014-03-19 10:33 UTC (permalink / raw)
  To: linux-arm-kernel

On 19/03/2014 11:26, Alexandre Belloni :
> Avoids getting the newly introduced warning:
> WARNING: DT compatible string "atmel,at91sam9g45-adc" appears un-documented -- check ./Documentation/devicetree/bindings/
> +				compatible = "atmel,at91sam9g45-adc";
> 
> Introduced by:
> bff5da433525 checkpatch: add DT compatible string documentation checks
> 
> Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>

Ok, if it is needed.

Acked-by: Nicolas Ferre <nicolas.ferre@atmel.com>

BTW, I do not see the devicetree maintainers in the list of CC. If it is
done for other architectures, I am fine with it, but if we are the only
one to start this move, I would like them to be aware.

Best regards,

> ---
>  Documentation/devicetree/bindings/arm/atmel-aic.txt      |  3 +--
>  Documentation/devicetree/bindings/arm/atmel-at91.txt     | 10 ++++------
>  Documentation/devicetree/bindings/dma/atmel-dma.txt      |  2 +-
>  Documentation/devicetree/bindings/gpio/gpio_atmel.txt    |  2 +-
>  Documentation/devicetree/bindings/iio/adc/at91_adc.txt   |  4 ++--
>  Documentation/devicetree/bindings/serial/atmel-usart.txt | 10 ++++------
>  6 files changed, 13 insertions(+), 18 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/arm/atmel-aic.txt b/Documentation/devicetree/bindings/arm/atmel-aic.txt
> index 2742e9cfd6b1..95f75fd097ba 100644
> --- a/Documentation/devicetree/bindings/arm/atmel-aic.txt
> +++ b/Documentation/devicetree/bindings/arm/atmel-aic.txt
> @@ -1,8 +1,7 @@
>  * Advanced Interrupt Controller (AIC)
>  
>  Required properties:
> -- compatible: Should be "atmel,<chip>-aic"
> -  <chip> can be "at91rm9200" or "sama5d3"
> +- compatible: "atmel,at91rm9200-aic", "atmel,sama5d3-aic"
>  - interrupt-controller: Identifies the node as an interrupt controller.
>  - interrupt-parent: For single AIC system, it is an empty property.
>  - #interrupt-cells: The number of cells to define the interrupts. It should be 3.
> diff --git a/Documentation/devicetree/bindings/arm/atmel-at91.txt b/Documentation/devicetree/bindings/arm/atmel-at91.txt
> index 16f60b41c147..e79a33315e4f 100644
> --- a/Documentation/devicetree/bindings/arm/atmel-at91.txt
> +++ b/Documentation/devicetree/bindings/arm/atmel-at91.txt
> @@ -14,8 +14,7 @@ System Timer (ST) required properties:
>    shared across all System Controller members.
>  
>  TC/TCLIB Timer required properties:
> -- compatible: Should be "atmel,<chip>-tcb".
> -  <chip> can be "at91rm9200" or "at91sam9x5"
> +- compatible: "atmel,at91rm9200-tcb", "atmel,at91sam9x5-tcb"
>  - reg: Should contain registers location and length
>  - interrupts: Should contain all interrupts for the TC block
>    Note that you can specify several interrupt cells if the TC
> @@ -46,8 +45,7 @@ One interrupt per TC channel in a TC block:
>  	};
>  
>  RSTC Reset Controller required properties:
> -- compatible: Should be "atmel,<chip>-rstc".
> -  <chip> can be "at91sam9260" or "at91sam9g45"
> +- compatible: "atmel,at91sam9260-rstc", "atmel,at91sam9g45-rstc"
>  - reg: Should contain registers location and length
>  
>  Example:
> @@ -80,8 +78,8 @@ Examples:
>  SHDWC Shutdown Controller
>  
>  required properties:
> -- compatible: Should be "atmel,<chip>-shdwc".
> -  <chip> can be "at91sam9260", "at91sam9rl" or "at91sam9x5".
> +- compatible: "atmel,at91sam9260-shdwc", "atmel,at91sam9rl-shdwc",
> +	"atmel,at91sam9x5-shdwc"
>  - reg: Should contain registers location and length
>  
>  optional properties:
> diff --git a/Documentation/devicetree/bindings/dma/atmel-dma.txt b/Documentation/devicetree/bindings/dma/atmel-dma.txt
> index f69bcf5a6343..410bff989949 100644
> --- a/Documentation/devicetree/bindings/dma/atmel-dma.txt
> +++ b/Documentation/devicetree/bindings/dma/atmel-dma.txt
> @@ -1,7 +1,7 @@
>  * Atmel Direct Memory Access Controller (DMA)
>  
>  Required properties:
> -- compatible: Should be "atmel,<chip>-dma".
> +- compatible: "atmel,at91sam9rl-dma", "atmel,at91sam9g45-dma"
>  - reg: Should contain DMA registers location and length.
>  - interrupts: Should contain DMA interrupt.
>  - #dma-cells: Must be <2>, used to represent the number of integer cells in
> diff --git a/Documentation/devicetree/bindings/gpio/gpio_atmel.txt b/Documentation/devicetree/bindings/gpio/gpio_atmel.txt
> index 85f8c0d084fa..1fa10565adcc 100644
> --- a/Documentation/devicetree/bindings/gpio/gpio_atmel.txt
> +++ b/Documentation/devicetree/bindings/gpio/gpio_atmel.txt
> @@ -1,7 +1,7 @@
>  * Atmel GPIO controller (PIO)
>  
>  Required properties:
> -- compatible: "atmel,<chip>-gpio", where <chip> is at91rm9200 or at91sam9x5.
> +- compatible: "atmel,at91rm9200-gpio", "atmel,at91rm9x5-gpio"
>  - reg: Should contain GPIO controller registers location and length
>  - interrupts: Should be the port interrupt shared by all the pins.
>  - #gpio-cells: Should be two.  The first cell is the pin number and
> diff --git a/Documentation/devicetree/bindings/iio/adc/at91_adc.txt b/Documentation/devicetree/bindings/iio/adc/at91_adc.txt
> index 82061c7e4fea..ac26cc13dd9f 100644
> --- a/Documentation/devicetree/bindings/iio/adc/at91_adc.txt
> +++ b/Documentation/devicetree/bindings/iio/adc/at91_adc.txt
> @@ -1,8 +1,8 @@
>  * AT91's Analog to Digital Converter (ADC)
>  
>  Required properties:
> -  - compatible: Should be "atmel,<chip>-adc"
> -    <chip> can be "at91sam9260", "at91sam9g45" or "at91sam9x5"
> +  - compatible: "atmel,at91sam9260-adc", "atmel,at91sam9rl-adc",
> +  		"atmel,at91sam9g45-adc", "atmel,at91sam9x5-adc",
>    - reg: Should contain ADC registers location and length
>    - interrupts: Should contain the IRQ line for the ADC
>    - atmel,adc-channels-used: Bitmask of the channels muxed and enabled for this
> diff --git a/Documentation/devicetree/bindings/serial/atmel-usart.txt b/Documentation/devicetree/bindings/serial/atmel-usart.txt
> index 9c5d19ac935c..ebc5b0cb7669 100644
> --- a/Documentation/devicetree/bindings/serial/atmel-usart.txt
> +++ b/Documentation/devicetree/bindings/serial/atmel-usart.txt
> @@ -1,9 +1,7 @@
>  * Atmel Universal Synchronous Asynchronous Receiver/Transmitter (USART)
>  
>  Required properties:
> -- compatible: Should be "atmel,<chip>-usart"
> -  The compatible <chip> indicated will be the first SoC to support an
> -  additional mode or an USART new feature.
> +- compatible: Should be "atmel,at91rm9200-usart", "atmel,at91sam9260-usart",
>  - reg: Should contain registers location and length
>  - interrupts: Should contain interrupt
>  - clock-names: tuple listing input clock names.
> @@ -19,9 +17,9 @@ Optional properties:
>  		Refer to dma.txt and atmel-dma.txt for details.
>  	- dma-names: "rx" for RX channel, "tx" for TX channel.
>  
> -<chip> compatible description:
> -- at91rm9200:  legacy USART support
> -- at91sam9260: generic USART implementation for SAM9 SoCs
> +compatible description:
> +- atmel,at91rm9200-usart:  legacy USART support
> +- atmel,at91sam9260-usart: generic USART implementation for SAM9 SoCs
>  
>  Example:
>  - use PDC:
> 


-- 
Nicolas Ferre

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH] Documentation: dt: list all compatible strings for at91
  2014-03-19 10:33 ` Nicolas Ferre
@ 2014-03-19 10:46   ` Alexandre Belloni
  0 siblings, 0 replies; 6+ messages in thread
From: Alexandre Belloni @ 2014-03-19 10:46 UTC (permalink / raw)
  To: linux-arm-kernel

On 19/03/2014 at 11:33:34 +0100, Nicolas Ferre wrote :
> On 19/03/2014 11:26, Alexandre Belloni :
> > Avoids getting the newly introduced warning:
> > WARNING: DT compatible string "atmel,at91sam9g45-adc" appears un-documented -- check ./Documentation/devicetree/bindings/
> > +				compatible = "atmel,at91sam9g45-adc";
> > 
> > Introduced by:
> > bff5da433525 checkpatch: add DT compatible string documentation checks
> > 
> > Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>
> 
> Ok, if it is needed.
> 
> Acked-by: Nicolas Ferre <nicolas.ferre@atmel.com>
> 
> BTW, I do not see the devicetree maintainers in the list of CC. If it is
> done for other architectures, I am fine with it, but if we are the only
> one to start this move, I would like them to be aware.
> 

Right, I'll resend.

Marvell is already listing all their compatibles but there is still the
issue for nvidia and fsl.

-- 
Alexandre Belloni, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH] Documentation: dt: list all compatible strings for at91
  2014-03-19 10:26 [PATCH] Documentation: dt: list all compatible strings for at91 Alexandre Belloni
  2014-03-19 10:33 ` Nicolas Ferre
@ 2014-03-19 16:14 ` Rob Herring
  2014-03-20 16:21   ` Alexandre Belloni
  1 sibling, 1 reply; 6+ messages in thread
From: Rob Herring @ 2014-03-19 16:14 UTC (permalink / raw)
  To: linux-arm-kernel

On Wed, Mar 19, 2014 at 5:26 AM, Alexandre Belloni
<alexandre.belloni@free-electrons.com> wrote:
> Avoids getting the newly introduced warning:
> WARNING: DT compatible string "atmel,at91sam9g45-adc" appears un-documented -- check ./Documentation/devicetree/bindings/
> +                               compatible = "atmel,at91sam9g45-adc";
>
> Introduced by:
> bff5da433525 checkpatch: add DT compatible string documentation checks

We should fix checkpatch instead. There are some fixes in progress,
but I don't think it covers this issue. I'm puzzled by this one as I
thought I checked for this case.

Rob

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH] Documentation: dt: list all compatible strings for at91
  2014-03-19 16:14 ` Rob Herring
@ 2014-03-20 16:21   ` Alexandre Belloni
  2014-03-21 11:14     ` Alexandre Belloni
  0 siblings, 1 reply; 6+ messages in thread
From: Alexandre Belloni @ 2014-03-20 16:21 UTC (permalink / raw)
  To: linux-arm-kernel

Hi Rob,

On 19/03/2014 at 11:14:43 -0500, Rob Herring wrote :
> On Wed, Mar 19, 2014 at 5:26 AM, Alexandre Belloni
> <alexandre.belloni@free-electrons.com> wrote:
> > Avoids getting the newly introduced warning:
> > WARNING: DT compatible string "atmel,at91sam9g45-adc" appears un-documented -- check ./Documentation/devicetree/bindings/
> > +                               compatible = "atmel,at91sam9g45-adc";
> >
> > Introduced by:
> > bff5da433525 checkpatch: add DT compatible string documentation checks
> 
> We should fix checkpatch instead. There are some fixes in progress,
> but I don't think it covers this issue. I'm puzzled by this one as I
> thought I checked for this case.
> 

Will someone take care of it ? I'm not sure how you want to handle that
as <chip> is replacing different values depending on the context. Also,
while for atmel and freescale, it is replacing the full chip name, that
is not the case for nvidia...

-- 
Alexandre Belloni, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH] Documentation: dt: list all compatible strings for at91
  2014-03-20 16:21   ` Alexandre Belloni
@ 2014-03-21 11:14     ` Alexandre Belloni
  0 siblings, 0 replies; 6+ messages in thread
From: Alexandre Belloni @ 2014-03-21 11:14 UTC (permalink / raw)
  To: linux-arm-kernel

Hi,

On 20/03/2014 at 17:21:00 +0100, Alexandre Belloni wrote :
> Hi Rob,
> 
> On 19/03/2014 at 11:14:43 -0500, Rob Herring wrote :
> > On Wed, Mar 19, 2014 at 5:26 AM, Alexandre Belloni
> > <alexandre.belloni@free-electrons.com> wrote:
> > > Avoids getting the newly introduced warning:
> > > WARNING: DT compatible string "atmel,at91sam9g45-adc" appears un-documented -- check ./Documentation/devicetree/bindings/
> > > +                               compatible = "atmel,at91sam9g45-adc";
> > >
> > > Introduced by:
> > > bff5da433525 checkpatch: add DT compatible string documentation checks
> > 
> > We should fix checkpatch instead. There are some fixes in progress,
> > but I don't think it covers this issue. I'm puzzled by this one as I
> > thought I checked for this case.
> > 
> 
> Will someone take care of it ? I'm not sure how you want to handle that
> as <chip> is replacing different values depending on the context. Also,
> while for atmel and freescale, it is replacing the full chip name, that
> is not the case for nvidia...
> 

Also, I found that naughty one:
WARNING: DT compatible string vendor "fixed-clock" appears un-documented -- check ./Documentation/devicetree/bindings/vendor-prefixes.txt

and

WARNING: DT compatible string vendor "fixed-factor-clock" appears un-documented -- check ./Documentation/devicetree/bindings/vendor-prefixes.txt

-- 
Alexandre Belloni, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2014-03-21 11:14 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-03-19 10:26 [PATCH] Documentation: dt: list all compatible strings for at91 Alexandre Belloni
2014-03-19 10:33 ` Nicolas Ferre
2014-03-19 10:46   ` Alexandre Belloni
2014-03-19 16:14 ` Rob Herring
2014-03-20 16:21   ` Alexandre Belloni
2014-03-21 11:14     ` Alexandre Belloni

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).