RE: [PATCH v2 1/4] Documentation: fsl-quadspi: Add fsl,ls2080a-dspi compatible string

[Yao Yuan]

On Thu, Dec 31, 2015 at 10:35PM, Yao Yuan <yao.yuan@xxxxxxx> wrote:
> On Wed, Dec 30, 2015 at 11:20 PM, Rob Herring wrote:
> > On Tue, Dec 29, 2015 at 9:17 PM, Yao Yuan <yao.yuan@xxxxxxx> wrote:
> > > Hi Rob,
> > >
> > > Thanks for your review.
> > > So you mean that I should add the commit message for why I add this
> > > new
> > compatible?
> >
> > Please don't top post on the lists.
> >
> > No, the binding doc should explain what are valid combinations of
> > compatible strings and the order when the dts can have multiple
> > strings. For example, is this valid:
> >
> > compatible = "fsl,vf610-dspi", "fsl,ls2080a-dspi";
> >
> > In other words, I should be able to check a dts file against what the
> > binding doc says.
> >
> > Rob
> 
> OK, I got it.
> The "fsl,vf610-dspi", "fsl,ls1021a-v1.0-dspi", "fsl,ls2085a-dspi" is valid and used
> in driver.
> But "fsl,ls2080a-dspi" is just used for platform flag.
> Could you help to give an example that how can I explain it in Documents?
> Or should I not write this compatible in Document.
> 
> I find that many compatible strings like this (not valid just a platform flag) for
> other driver are not record in document.
> 
> Thanks.
> 
> Yuan Yao

Hi Rob,
How about like this:
diff --git a/Documentation/devicetree/bindings/mtd/fsl-quadspi.txt b/Documentation/devicetree/bindings/mtd/fsl-quadspi.txt
index 00c587b..7a9a523 100644
--- a/Documentation/devicetree/bindings/mtd/fsl-quadspi.txt
+++ b/Documentation/devicetree/bindings/mtd/fsl-quadspi.txt
@@ -4,6 +4,8 @@ Required properties:
   - compatible : Should be "fsl,vf610-qspi", "fsl,imx6sx-qspi",
                 "fsl,imx7d-qspi", "fsl,imx6ul-qspi",
                 "fsl,ls1021-qspi"
+       Invalid compatible just for SOC flag:
+               "fsl,ls2080a-qspi"
   - reg : the first contains the register location and length,
           the second contains the memory mapping address and length
   - reg-names: Should contain the reg names "QuadSPI" and "QuadSPI-memory"

Thanks for your review.

> 
> >
> > > On Wed, Dec 30, 2015 at 02:35AM, Rob Herring wrote:
> > >> On Thu, Dec 24, 2015 at 07:01:00PM +0800, Yuan Yao wrote:
> > >> > new compatible string: "fsl,ls2080a-qspi".
> > >> >
> > >> > Signed-off-by: Yuan Yao <yao.yuan@xxxxxxx>
> > >> > ---
> > >> > Changed in v2:
> > >> > Update my email to <yao.yuan@xxxxxxx>
> > >> > ---
> > >> >  Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt | 3 ++-
> > >> >  1 file changed, 2 insertions(+), 1 deletion(-)
> > >> >
> > >> > diff --git
> > >> > a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt
> > >> b/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt
> > >> > index fa77f87..2fe51d6 100644
> > >> > --- a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt
> > >> > +++ b/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt
> > >> > @@ -1,7 +1,8 @@
> > >> >  ARM Freescale DSPI controller
> > >> >
> > >> >  Required properties:
> > >> > -- compatible : "fsl,vf610-dspi", "fsl,ls1021a-v1.0-dspi", "fsl,ls2085a-dspi"
> > >> > +- compatible : "fsl,vf610-dspi", "fsl,ls1021a-v1.0-dspi",
> > >> > +           "fsl,ls2085a-dspi", "fsl,ls2080a-dspi"
> > >>
> > >> You should explain what combinations of compatible strings are valid.
> > >>
> > >> Rob