diff mbox

[v2,1/5] mmc: dt: add compatible into eSDHC required properties

Message ID 1493894940-47452-2-git-send-email-yangbo.lu@nxp.com (mailing list archive)
State New, archived
Headers show

Commit Message

Yangbo Lu May 4, 2017, 10:48 a.m. UTC
This patch is to add compatible into eSDHC required properties.

Signed-off-by: Yangbo Lu <yangbo.lu@nxp.com>
---
Changes for v2:
	- Added this patch.
---
 Documentation/devicetree/bindings/mmc/fsl-esdhc.txt | 1 +
 1 file changed, 1 insertion(+)

Comments

Shawn Guo May 5, 2017, 2:36 a.m. UTC | #1
On Thu, May 04, 2017 at 06:48:56PM +0800, Yangbo Lu wrote:
> This patch is to add compatible into eSDHC required properties.
> 
> Signed-off-by: Yangbo Lu <yangbo.lu@nxp.com>
> ---
> Changes for v2:
> 	- Added this patch.
> ---
>  Documentation/devicetree/bindings/mmc/fsl-esdhc.txt | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> index dedfb02..b04b248 100644
> --- a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> +++ b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> @@ -7,6 +7,7 @@ This file documents differences between the core properties described
>  by mmc.txt and the properties used by the sdhci-esdhc driver.
>  
>  Required properties:
> +  - compatible : should be "fsl,esdhc", or "fsl,<chip>-esdhc".

I think either supported <chip> or the compatible should be listed
explicitly.

Shawn

>    - interrupt-parent : interrupt source phandle.
>    - clock-frequency : specifies eSDHC base clock frequency.
>  
> -- 
> 2.1.0.27.g96db324
> 
> 
> _______________________________________________
> linux-arm-kernel mailing list
> linux-arm-kernel@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Yangbo Lu May 5, 2017, 3:01 a.m. UTC | #2
Hi Shawn,


> -----Original Message-----
> From: Shawn Guo [mailto:shawnguo@kernel.org]
> Sent: Friday, May 05, 2017 10:37 AM
> To: Y.B. Lu
> Cc: devicetree@vger.kernel.org; linux-arm-kernel@lists.infradead.org;
> ulf.hansson@linaro.org; Rob Herring; Catalin Marinas; Harninder Rai;
> Xiaobo Xie
> Subject: Re: [v2, 1/5] mmc: dt: add compatible into eSDHC required
> properties
> 
> On Thu, May 04, 2017 at 06:48:56PM +0800, Yangbo Lu wrote:
> > This patch is to add compatible into eSDHC required properties.
> >
> > Signed-off-by: Yangbo Lu <yangbo.lu@nxp.com>
> > ---
> > Changes for v2:
> > 	- Added this patch.
> > ---
> >  Documentation/devicetree/bindings/mmc/fsl-esdhc.txt | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > index dedfb02..b04b248 100644
> > --- a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > +++ b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > @@ -7,6 +7,7 @@ This file documents differences between the core
> > properties described  by mmc.txt and the properties used by the sdhci-
> esdhc driver.
> >
> >  Required properties:
> > +  - compatible : should be "fsl,esdhc", or "fsl,<chip>-esdhc".
> 
> I think either supported <chip> or the compatible should be listed
> explicitly.
> 

[Lu Yangbo-B47093] I think the reason we use <chip> is to avoid listing too much chips, and to avoid doc updating if new chips are added.
The checkpatch script also had considered that.

Currently there're about 20 platforms with "fsl,<chip>-esdhc" compatible in kernel dts.
And the doc also provide an example.
Example:

sdhci@2e000 {
        compatible = "fsl,mpc8378-esdhc", "fsl,esdhc";

Should we still need to list all ?

Thanks.

> Shawn
> 
> >    - interrupt-parent : interrupt source phandle.
> >    - clock-frequency : specifies eSDHC base clock frequency.
> >
> > --
> > 2.1.0.27.g96db324
> >
> >
> > _______________________________________________
> > linux-arm-kernel mailing list
> > linux-arm-kernel@lists.infradead.org
> > http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Shawn Guo May 5, 2017, 3:18 a.m. UTC | #3
On Fri, May 05, 2017 at 03:01:04AM +0000, Y.B. Lu wrote:
> > > diff --git a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > index dedfb02..b04b248 100644
> > > --- a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > +++ b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > @@ -7,6 +7,7 @@ This file documents differences between the core
> > > properties described  by mmc.txt and the properties used by the sdhci-
> > esdhc driver.
> > >
> > >  Required properties:
> > > +  - compatible : should be "fsl,esdhc", or "fsl,<chip>-esdhc".
> > 
> > I think either supported <chip> or the compatible should be listed
> > explicitly.
> > 
> 
> [Lu Yangbo-B47093] I think the reason we use <chip> is to avoid listing too much chips, and to avoid doc updating if new chips are added.
> The checkpatch script also had considered that.
> 
> Currently there're about 20 platforms with "fsl,<chip>-esdhc" compatible in kernel dts.
> And the doc also provide an example.
> Example:
> 
> sdhci@2e000 {
>         compatible = "fsl,mpc8378-esdhc", "fsl,esdhc";
> 
> Should we still need to list all ?

I anyway need an ACK from Rob on this patch.  Let's see what he would
say.

Shawn
Rob Herring May 8, 2017, 4:36 p.m. UTC | #4
On Fri, May 05, 2017 at 03:01:04AM +0000, Y.B. Lu wrote:
> Hi Shawn,
> 
> 
> > -----Original Message-----
> > From: Shawn Guo [mailto:shawnguo@kernel.org]
> > Sent: Friday, May 05, 2017 10:37 AM
> > To: Y.B. Lu
> > Cc: devicetree@vger.kernel.org; linux-arm-kernel@lists.infradead.org;
> > ulf.hansson@linaro.org; Rob Herring; Catalin Marinas; Harninder Rai;
> > Xiaobo Xie
> > Subject: Re: [v2, 1/5] mmc: dt: add compatible into eSDHC required
> > properties
> > 
> > On Thu, May 04, 2017 at 06:48:56PM +0800, Yangbo Lu wrote:
> > > This patch is to add compatible into eSDHC required properties.
> > >
> > > Signed-off-by: Yangbo Lu <yangbo.lu@nxp.com>
> > > ---
> > > Changes for v2:
> > > 	- Added this patch.
> > > ---
> > >  Documentation/devicetree/bindings/mmc/fsl-esdhc.txt | 1 +
> > >  1 file changed, 1 insertion(+)
> > >
> > > diff --git a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > index dedfb02..b04b248 100644
> > > --- a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > +++ b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > @@ -7,6 +7,7 @@ This file documents differences between the core
> > > properties described  by mmc.txt and the properties used by the sdhci-
> > esdhc driver.
> > >
> > >  Required properties:
> > > +  - compatible : should be "fsl,esdhc", or "fsl,<chip>-esdhc".
> > 
> > I think either supported <chip> or the compatible should be listed
> > explicitly.
> > 
> 
> [Lu Yangbo-B47093] I think the reason we use <chip> is to avoid listing too much chips, and to avoid doc updating if new chips are added.
> The checkpatch script also had considered that.
> 
> Currently there're about 20 platforms with "fsl,<chip>-esdhc" compatible in kernel dts.

Yes, but it's generally preferred to list possible values of <chip>.

Rob
Yangbo Lu May 9, 2017, 2:51 a.m. UTC | #5
> -----Original Message-----
> From: Rob Herring [mailto:robh@kernel.org]
> Sent: Tuesday, May 09, 2017 12:36 AM
> To: Y.B. Lu
> Cc: Shawn Guo; devicetree@vger.kernel.org; linux-arm-
> kernel@lists.infradead.org; ulf.hansson@linaro.org; Catalin Marinas;
> Harninder Rai; Xiaobo Xie
> Subject: Re: [v2, 1/5] mmc: dt: add compatible into eSDHC required
> properties
> 
> On Fri, May 05, 2017 at 03:01:04AM +0000, Y.B. Lu wrote:
> > Hi Shawn,
> >
> >
> > > -----Original Message-----
> > > From: Shawn Guo [mailto:shawnguo@kernel.org]
> > > Sent: Friday, May 05, 2017 10:37 AM
> > > To: Y.B. Lu
> > > Cc: devicetree@vger.kernel.org;
> > > linux-arm-kernel@lists.infradead.org;
> > > ulf.hansson@linaro.org; Rob Herring; Catalin Marinas; Harninder Rai;
> > > Xiaobo Xie
> > > Subject: Re: [v2, 1/5] mmc: dt: add compatible into eSDHC required
> > > properties
> > >
> > > On Thu, May 04, 2017 at 06:48:56PM +0800, Yangbo Lu wrote:
> > > > This patch is to add compatible into eSDHC required properties.
> > > >
> > > > Signed-off-by: Yangbo Lu <yangbo.lu@nxp.com>
> > > > ---
> > > > Changes for v2:
> > > > 	- Added this patch.
> > > > ---
> > > >  Documentation/devicetree/bindings/mmc/fsl-esdhc.txt | 1 +
> > > >  1 file changed, 1 insertion(+)
> > > >
> > > > diff --git a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > > b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > > index dedfb02..b04b248 100644
> > > > --- a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > > +++ b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
> > > > @@ -7,6 +7,7 @@ This file documents differences between the core
> > > > properties described  by mmc.txt and the properties used by the
> > > > sdhci-
> > > esdhc driver.
> > > >
> > > >  Required properties:
> > > > +  - compatible : should be "fsl,esdhc", or "fsl,<chip>-esdhc".
> > >
> > > I think either supported <chip> or the compatible should be listed
> > > explicitly.
> > >
> >
> > [Lu Yangbo-B47093] I think the reason we use <chip> is to avoid listing
> too much chips, and to avoid doc updating if new chips are added.
> > The checkpatch script also had considered that.
> >
> > Currently there're about 20 platforms with "fsl,<chip>-esdhc"
> compatible in kernel dts.
> 
> Yes, but it's generally preferred to list possible values of <chip>.
> 

[Lu Yangbo-B47093] Ok, thanks for your suggestions, Rob and Shawn.
I will send out the new version soon :)

> Rob
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
index dedfb02..b04b248 100644
--- a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
+++ b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
@@ -7,6 +7,7 @@  This file documents differences between the core properties described
 by mmc.txt and the properties used by the sdhci-esdhc driver.
 
 Required properties:
+  - compatible : should be "fsl,esdhc", or "fsl,<chip>-esdhc".
   - interrupt-parent : interrupt source phandle.
   - clock-frequency : specifies eSDHC base clock frequency.