| Message ID | 20210315121518.3710171-1-kuldeep.singh@nxp.com |
|---|---|
| State | New |
| Headers | show |
| Series | dt-bindings: spi: Convert Freescale DSPI to json schema | expand |
+Cc mtd list Hi, On 15/03/21 05:45PM, Kuldeep Singh wrote: > Convert the Freescale DSPI binding to DT schema format using json-schema. > > Signed-off-by: Kuldeep Singh <kuldeep.singh@nxp.com> > --- > Hi Rob, > This patch is checked with following commands with no warnings observed. > make distclean; make allmodconfig; > make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml; > make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml When I add the "fsl,spi-cs-sck-delay" property under the flash@0 node in the example and run dt_binding_check, I see the below error: /home/pratyush/src/linux/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.example.dt.yaml: flash@0: 'fsl,spi-cs-sck-delay' does not match any of the regexes: '^partition@', 'pinctrl-[0-9]+' From schema: /home/pratyush/src/lin/Documentation/devicetree/bindings/mtd/jedec,spi-nor.yaml I am trying to solve a similar problem for the Cadence QSPI controller binding and I wonder what the best solution for this is. The obvious one would be to add these properties to jedec,spi-nor.yaml. I haven't managed to come up with any other solution to this problem. Rob, all, any suggestions on how to best model this? > > .../bindings/spi/fsl,spi-fsl-dspi.yaml | 131 ++++++++++++++++++ > .../devicetree/bindings/spi/spi-fsl-dspi.txt | 65 --------- > MAINTAINERS | 2 +- > 3 files changed, 132 insertions(+), 66 deletions(-) > create mode 100644 Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > delete mode 100644 Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt > > diff --git a/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml b/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > new file mode 100644 > index 000000000000..15ffc83bdba6 > --- /dev/null > +++ b/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > @@ -0,0 +1,131 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/spi/fsl,spi-fsl-dspi.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Freescale DSPI Controller > + > +maintainers: > + - Vladimir Oltean <olteanv@gmail.com> > + > +allOf: > + - $ref: "spi-controller.yaml#" > + > +properties: > + compatible: > + oneOf: > + - enum: > + - fsl,vf610-dspi > + - fsl,ls1021a-v1.0-dspi > + - fsl,ls1028a-dspi > + - fsl,ls2085a-dspi > + - fsl,lx2160a-dspi > + - items: > + - enum: > + - fsl,ls1012a-dspi > + - fsl,ls1028a-dspi > + - fsl,ls1043a-dspi > + - fsl,ls1046a-dspi > + - fsl,ls1088a-dspi > + - const: fsl,ls1021a-v1.0-dspi > + - items: > + - enum: > + - fsl,ls2080a-dspi > + - fsl,lx2160a-dspi > + - const: fsl,ls2085a-dspi > + > + reg: > + maxItems: 1 > + description: Offset and length of registers > + > + interrupts: > + maxItems: 1 > + > + clocks: > + items: > + - description: SoC dspi clock > + > + clock-names: > + items: > + - const: dspi > + > + pinctrl-names: > + minItems: 1 > + items: > + - const: default > + description: > + Names for the pin configuration must be "default" > + > + dmas: > + maxItems: 2 > + > + dma-names: > + items: > + - const: tx > + - const: rx > + > + spi-num-chipselects: > + maxItems: 1 > + description: Number of the chipselect signals > + > + bus-num: > + items: > + - description: Slave chip chipselect signal number > + > +patternProperties: > + "@[0-9a-f]+": > + type: object > + > + properties: > + fsl,spi-cs-sck-delay: > + description: > + Delay in nanoseconds between activating chip select and the start of > + clock signal, at the start of a transfer. > + $ref: /schemas/types.yaml#/definitions/uint32 > + > + fsl,spi-sck-cs-delay: > + description: > + Delay in nanoseconds between stopping the clock signal and > + deactivating chip select, at the end of a transfer. > + $ref: /schemas/types.yaml#/definitions/uint32 > + > +required: > + - compatible > + - reg > + - interrupts > + - clocks > + - clock-names > + - spi-num-chipselects > + > +unevaluatedProperties: false > + > +examples: > + - | > + #include <dt-bindings/clock/fsl,qoriq-clockgen.h> > + #include <dt-bindings/interrupt-controller/arm-gic.h> > + > + soc { > + #address-cells = <2>; > + #size-cells = <2>; > + > + spi@2100000 { > + compatible = "fsl,ls1028a-dspi", "fsl,ls1021a-v1.0-dspi"; > + #address-cells = <1>; > + #size-cells = <0>; > + reg = <0x0 0x2100000 0x0 0x10000>; > + interrupts = <GIC_SPI 26 IRQ_TYPE_LEVEL_HIGH>; > + clock-names = "dspi"; > + clocks = <&clockgen QORIQ_CLK_PLATFORM_PLL QORIQ_CLK_PLL_DIV(2)>; > + dmas = <&edma0 0 62>, <&edma0 0 60>; > + dma-names = "tx", "rx"; > + spi-num-chipselects = <4>; > + little-endian; > + > + flash@0 { > + compatible = "jedec,spi-nor"; > + spi-max-frequency = <10000000>; > + reg = <0>; > + }; > + }; > + }; > diff --git a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt b/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt > deleted file mode 100644 > index 30a79da9c039..000000000000 > --- a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt > +++ /dev/null > @@ -1,65 +0,0 @@ > -ARM Freescale DSPI controller > - > -Required properties: > -- compatible : must be one of: > - "fsl,vf610-dspi", > - "fsl,ls1021a-v1.0-dspi", > - "fsl,ls1012a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), > - "fsl,ls1028a-dspi", > - "fsl,ls1043a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), > - "fsl,ls1046a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), > - "fsl,ls1088a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), > - "fsl,ls2080a-dspi" (optionally followed by "fsl,ls2085a-dspi"), > - "fsl,ls2085a-dspi", > - "fsl,lx2160a-dspi", > -- reg : Offset and length of the register set for the device > -- interrupts : Should contain SPI controller interrupt > -- clocks: from common clock binding: handle to dspi clock. > -- clock-names: from common clock binding: Shall be "dspi". > -- pinctrl-0: pin control group to be used for this controller. > -- pinctrl-names: must contain a "default" entry. > -- spi-num-chipselects : the number of the chipselect signals. > - > -Optional property: > -- big-endian: If present the dspi device's registers are implemented > - in big endian mode. > -- bus-num : the slave chip chipselect signal number. > - > -Optional SPI slave node properties: > -- fsl,spi-cs-sck-delay: a delay in nanoseconds between activating chip > - select and the start of clock signal, at the start of a transfer. > -- fsl,spi-sck-cs-delay: a delay in nanoseconds between stopping the clock > - signal and deactivating chip select, at the end of a transfer. > - > -Example: > - > -dspi0@4002c000 { > - #address-cells = <1>; > - #size-cells = <0>; > - compatible = "fsl,vf610-dspi"; > - reg = <0x4002c000 0x1000>; > - interrupts = <0 67 0x04>; > - clocks = <&clks VF610_CLK_DSPI0>; > - clock-names = "dspi"; > - spi-num-chipselects = <5>; > - bus-num = <0>; > - pinctrl-names = "default"; > - pinctrl-0 = <&pinctrl_dspi0_1>; > - big-endian; > - > - sflash: at26df081a@0 { > - #address-cells = <1>; > - #size-cells = <1>; > - compatible = "atmel,at26df081a"; > - spi-max-frequency = <16000000>; > - spi-cpol; > - spi-cpha; > - reg = <0>; > - linux,modalias = "m25p80"; > - modal = "at26df081a"; > - fsl,spi-cs-sck-delay = <100>; > - fsl,spi-sck-cs-delay = <50>; > - }; > -}; > - > - > diff --git a/MAINTAINERS b/MAINTAINERS > index d92f85ca831d..e2c5b7367db9 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -7060,7 +7060,7 @@ FREESCALE DSPI DRIVER > M: Vladimir Oltean <olteanv@gmail.com> > L: linux-spi@vger.kernel.org > S: Maintained > -F: Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt > +F: Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > F: drivers/spi/spi-fsl-dspi.c > F: include/linux/spi/spi-fsl-dspi.h > > -- > 2.17.1 >
> -----Original Message----- > From: Pratyush Yadav <p.yadav@ti.com> > Sent: Tuesday, March 16, 2021 12:01 AM > To: Kuldeep Singh <kuldeep.singh@nxp.com> > Cc: linux-spi@vger.kernel.org; devicetree@vger.kernel.org; linux- > kernel@vger.kernel.org; Mark Brown <broonie@kernel.org>; Rob Herring > <robh+dt@kernel.org>; Vladimir Oltean <olteanv@gmail.com>; linux- > mtd@lists.infradead.org > Subject: [EXT] Re: [PATCH] dt-bindings: spi: Convert Freescale DSPI to json schema > > Caution: EXT Email > > +Cc mtd list > > Hi, > > On 15/03/21 05:45PM, Kuldeep Singh wrote: > > Convert the Freescale DSPI binding to DT schema format using json-schema. > > > > Signed-off-by: Kuldeep Singh <kuldeep.singh@nxp.com> > > --- > > Hi Rob, > > This patch is checked with following commands with no warnings observed. > > make distclean; make allmodconfig; > > make dt_binding_check > > DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi > > .yaml; make dtbs_check > > DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi > > .yaml > > When I add the "fsl,spi-cs-sck-delay" property under the flash@0 node in the > example and run dt_binding_check, I see the below error: > > /home/pratyush/src/linux/Documentation/devicetree/bindings/spi/fsl,spi-fsl- > dspi.example.dt.yaml: flash@0: 'fsl,spi-cs-sck-delay' does not match any of the > regexes: '^partition@', 'pinctrl-[0-9]+' > From schema: > /home/pratyush/src/lin/Documentation/devicetree/bindings/mtd/jedec,spi- > nor.yaml Hi Pratyush, Thanks for mentioning, I just noticed the same error after adding fsl,spi-cs-sck-delay property. Since my example is not using the property, the error went unnoticed. Taking example of nvidia qspi bindings i.e https://lore.kernel.org/linux-devicetree/1608585459-17250-3-git-send-email-skomatineni@nvidia.com/ I constructed other properties in similar fashion and later noticed that example in nvidia bindings uses compatibes as "spi-nor" instead of "jedec,spi-nor" and therefore passes "make dt_binding_check". > I am trying to solve a similar problem for the Cadence QSPI controller binding and > I wonder what the best solution for this is. The obvious one would be to add > these properties to jedec,spi-nor.yaml. I haven't managed to come up with any > other solution to this problem. I agree with the solution to add properties in jedec,spi-nor.yaml and adding properties particular to specific controllers for flashes in generic jedec,spi-nor.yaml may not be a good solution though. Please let me know your views. Other approach is to add these properties in same binding itself (if possible) so as to limit the scope of these properties. Looking forward for more suggestions. Regards Kuldeep
Hi Vladimir, > -----Original Message----- > From: Vladimir Oltean <olteanv@gmail.com> > Sent: Tuesday, March 16, 2021 2:25 AM > To: Kuldeep Singh <kuldeep.singh@nxp.com> > Cc: linux-spi@vger.kernel.org; devicetree@vger.kernel.org; linux- > kernel@vger.kernel.org; Mark Brown <broonie@kernel.org>; Rob Herring > <robh+dt@kernel.org> > Subject: [EXT] Re: [PATCH] dt-bindings: spi: Convert Freescale DSPI to json schema > > Caution: EXT Email > > Hi Kuldeep, > > On Mon, Mar 15, 2021 at 05:45:18PM +0530, Kuldeep Singh wrote: > > Convert the Freescale DSPI binding to DT schema format using json-schema. > > > > Signed-off-by: Kuldeep Singh <kuldeep.singh@nxp.com> > > --- [...] > > + > > +allOf: > > + - $ref: "spi-controller.yaml#" > > + > > +properties: > > + compatible: > > + oneOf: > > + - enum: > > + - fsl,vf610-dspi > > + - fsl,ls1021a-v1.0-dspi > > + - fsl,ls1028a-dspi > > + - fsl,ls2085a-dspi > > + - fsl,lx2160a-dspi > > + - items: > > + - enum: > > + - fsl,ls1012a-dspi > > + - fsl,ls1028a-dspi > > + - fsl,ls1043a-dspi > > + - fsl,ls1046a-dspi > > + - fsl,ls1088a-dspi > > + - const: fsl,ls1021a-v1.0-dspi > > + - items: > > + - enum: > > + - fsl,ls2080a-dspi > > + - fsl,lx2160a-dspi > > + - const: fsl,ls2085a-dspi > > Can this simply be: > compatible: > oneOf: > - enum: > - fsl,vf610-dspi > - fsl,ls1021a-v1.0-dspi > - fsl,ls1012a-dspi > - fsl,ls1028a-dspi > - fsl,ls1043a-dspi > - fsl,ls1046a-dspi > - fsl,ls1088a-dspi > - fsl,ls2080a-dspi > - fsl,ls2085a-dspi > - fsl,lx2160a-dspi > ? Compatible entries in conjugation require enum and const pair. For example, ls1012a.dtsi uses compatible = "fsl,ls1012a-dspi","fsl,ls1021a-v1.0-dspi"; Same goes for LS1028 as well. Therefore, can't mention the compatible entry as single entity otherwise it may fail "make dt_binding_check" and "make dtbs_check". > > > +examples: > > + - | > > + #include <dt-bindings/clock/fsl,qoriq-clockgen.h> > > + #include <dt-bindings/interrupt-controller/arm-gic.h> > > + > > + soc { > > + #address-cells = <2>; > > + #size-cells = <2>; > > + > > + spi@2100000 { > > + compatible = "fsl,ls1028a-dspi", "fsl,ls1021a-v1.0-dspi"; > > This doesn't need the "fsl,ls1021a-v1.0-dspi" compatible, can you please remove > it? I have taken this example from LS1028a.dtsi and it uses these compatibles in conjugation. If "fsl,ls1021a-v1.0-dspi" is not required, then it should also be removed from device-tree As well as from bindings both. > > > + #address-cells = <1>; > > + #size-cells = <0>; > > + reg = <0x0 0x2100000 0x0 0x10000>; > > + interrupts = <GIC_SPI 26 IRQ_TYPE_LEVEL_HIGH>; > > + clock-names = "dspi"; > > + clocks = <&clockgen QORIQ_CLK_PLATFORM_PLL > QORIQ_CLK_PLL_DIV(2)>; > > + dmas = <&edma0 0 62>, <&edma0 0 60>; > > + dma-names = "tx", "rx"; > > + spi-num-chipselects = <4>; > > + little-endian; > > + > > + flash@0 { > > + compatible = "jedec,spi-nor"; > > + spi-max-frequency = <10000000>; > > + reg = <0>; > > + }; > > + }; > > + }; > > (...) > > > -Optional property: > > -- big-endian: If present the dspi device's registers are implemented > > - in big endian mode. > > I don't see "big-endian" being covered in any common yaml, could you please not > delete it? The driver calls of_device_is_big_endian. Thanks for mentioning. Will consider this in next version after receiving feedback on other thread. Regards Kuldeep
On Tue, Mar 16, 2021 at 06:08:17AM +0000, Kuldeep Singh wrote: > Compatible entries in conjugation require enum and const pair. > For example, ls1012a.dtsi uses compatible = "fsl,ls1012a-dspi","fsl,ls1021a-v1.0-dspi"; > Same goes for LS1028 as well. > > Therefore, can't mention the compatible entry as single entity otherwise > it may fail "make dt_binding_check" and "make dtbs_check". > > > > > > +examples: > > > + - | > > > + #include <dt-bindings/clock/fsl,qoriq-clockgen.h> > > > + #include <dt-bindings/interrupt-controller/arm-gic.h> > > > + > > > + soc { > > > + #address-cells = <2>; > > > + #size-cells = <2>; > > > + > > > + spi@2100000 { > > > + compatible = "fsl,ls1028a-dspi", "fsl,ls1021a-v1.0-dspi"; > > > > This doesn't need the "fsl,ls1021a-v1.0-dspi" compatible, can you please remove > > it? > > I have taken this example from LS1028a.dtsi and it uses these compatibles in conjugation. > If "fsl,ls1021a-v1.0-dspi" is not required, then it should also be removed from device-tree > As well as from bindings both. Yes, the second compatible is never required by the driver and should be removed from existing device trees if that makes "make dtbs_check" fail.
Am 2021-03-15 19:30, schrieb Pratyush Yadav: .. >> +patternProperties: >> + "@[0-9a-f]+": Shouldn't this be "^.*@[0-9a-f]+$"? >> + type: object >> + >> + properties: >> + fsl,spi-cs-sck-delay: >> + description: >> + Delay in nanoseconds between activating chip select and the >> start of >> + clock signal, at the start of a transfer. >> + $ref: /schemas/types.yaml#/definitions/uint32 >> + >> + fsl,spi-sck-cs-delay: >> + description: >> + Delay in nanoseconds between stopping the clock signal and >> + deactivating chip select, at the end of a transfer. >> + $ref: /schemas/types.yaml#/definitions/uint32 >> + .. -michael
On 16/03/21 06:45PM, Michael Walle wrote: > Am 2021-03-15 19:30, schrieb Pratyush Yadav: > > .. > > > +patternProperties: > > > + "@[0-9a-f]+": > > Shouldn't this be "^.*@[0-9a-f]+$"? The pattern has to match _anywhere_ in the string so both should match the flash node. Your pattern is more "strict" or "precise". See the note at [0]. [0] https://json-schema.org/understanding-json-schema/reference/string.html#regular-expressions > > > > + type: object > > > + > > > + properties: > > > + fsl,spi-cs-sck-delay: > > > + description: > > > + Delay in nanoseconds between activating chip select and > > > the start of > > > + clock signal, at the start of a transfer. > > > + $ref: /schemas/types.yaml#/definitions/uint32 > > > + > > > + fsl,spi-sck-cs-delay: > > > + description: > > > + Delay in nanoseconds between stopping the clock signal and > > > + deactivating chip select, at the end of a transfer. > > > + $ref: /schemas/types.yaml#/definitions/uint32 > > > + > .. > > -michael
Am 2021-03-16 19:06, schrieb Pratyush Yadav: > On 16/03/21 06:45PM, Michael Walle wrote: >> Am 2021-03-15 19:30, schrieb Pratyush Yadav: >> >> .. >> > > +patternProperties: >> > > + "@[0-9a-f]+": >> >> Shouldn't this be "^.*@[0-9a-f]+$"? > > The pattern has to match _anywhere_ in the string so both should match > the flash node. Your pattern is more "strict" or "precise". See the > note > at [0]. I know, but specifying the whole line is widely used in the bindings. -michael
On Tue, Mar 16, 2021 at 07:22:56PM +0100, Michael Walle wrote: > Am 2021-03-16 19:06, schrieb Pratyush Yadav: > > On 16/03/21 06:45PM, Michael Walle wrote: > > > Am 2021-03-15 19:30, schrieb Pratyush Yadav: > > > > > > .. > > > > > +patternProperties: > > > > > + "@[0-9a-f]+": > > > > > > Shouldn't this be "^.*@[0-9a-f]+$"? > > > > The pattern has to match _anywhere_ in the string so both should match > > the flash node. Your pattern is more "strict" or "precise". See the note > > at [0]. > > I know, but specifying the whole line is widely used in the bindings. It should be '@[0-9a-f]+$' which is equivalent to Michael's suggestion. Rob
On Tue, Mar 16, 2021 at 12:00:52AM +0530, Pratyush Yadav wrote: > +Cc mtd list > > Hi, > > On 15/03/21 05:45PM, Kuldeep Singh wrote: > > Convert the Freescale DSPI binding to DT schema format using json-schema. > > > > Signed-off-by: Kuldeep Singh <kuldeep.singh@nxp.com> > > --- > > Hi Rob, > > This patch is checked with following commands with no warnings observed. > > make distclean; make allmodconfig; > > make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml; > > make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > > When I add the "fsl,spi-cs-sck-delay" property under the flash@0 node in > the example and run dt_binding_check, I see the below error: > > /home/pratyush/src/linux/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.example.dt.yaml: flash@0: 'fsl,spi-cs-sck-delay' does not match any of the regexes: '^partition@', 'pinctrl-[0-9]+' > From schema: /home/pratyush/src/lin/Documentation/devicetree/bindings/mtd/jedec,spi-nor.yaml > > I am trying to solve a similar problem for the Cadence QSPI controller > binding and I wonder what the best solution for this is. The obvious one > would be to add these properties to jedec,spi-nor.yaml. I haven't > managed to come up with any other solution to this problem. > > Rob, all, any suggestions on how to best model this? I'm aware of the issue, but I don't have a solution for this situation. It's a problem anywhere we have a parent or bus binding defining properties for child nodes. For now, I'd just avoid it in the examples and we'll figure out how to deal with actual dts files later. For this one in particular, CS to clock timing isn't any FSL or controller specific, but is device specific. So this probably should have been a generic spi bus property (if not implicit). That's somewhat easier to work-around than potentially adding controller specific properties to every slave device schema. Rob
On Tue, Mar 16, 2021 at 12:15:06PM +0200, Vladimir Oltean wrote: > On Tue, Mar 16, 2021 at 06:08:17AM +0000, Kuldeep Singh wrote: > > Compatible entries in conjugation require enum and const pair. > > For example, ls1012a.dtsi uses compatible = "fsl,ls1012a-dspi","fsl,ls1021a-v1.0-dspi"; > > Same goes for LS1028 as well. > > > > Therefore, can't mention the compatible entry as single entity otherwise > > it may fail "make dt_binding_check" and "make dtbs_check". > > > > > > > > > +examples: > > > > + - | > > > > + #include <dt-bindings/clock/fsl,qoriq-clockgen.h> > > > > + #include <dt-bindings/interrupt-controller/arm-gic.h> > > > > + > > > > + soc { > > > > + #address-cells = <2>; > > > > + #size-cells = <2>; > > > > + > > > > + spi@2100000 { > > > > + compatible = "fsl,ls1028a-dspi", "fsl,ls1021a-v1.0-dspi"; > > > > > > This doesn't need the "fsl,ls1021a-v1.0-dspi" compatible, can you please remove > > > it? > > > > I have taken this example from LS1028a.dtsi and it uses these compatibles in conjugation. > > If "fsl,ls1021a-v1.0-dspi" is not required, then it should also be removed from device-tree > > As well as from bindings both. > > Yes, the second compatible is never required by the driver and should be > removed from existing device trees if that makes "make dtbs_check" fail. Can you say that is true for every possible driver implementation? u-boot, *BSD, etc.? Rob
On Mon, Mar 15, 2021 at 05:45:18PM +0530, Kuldeep Singh wrote: > Convert the Freescale DSPI binding to DT schema format using json-schema. > > Signed-off-by: Kuldeep Singh <kuldeep.singh@nxp.com> > --- > Hi Rob, > This patch is checked with following commands with no warnings observed. > make distclean; make allmodconfig; > make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml; > make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > > .../bindings/spi/fsl,spi-fsl-dspi.yaml | 131 ++++++++++++++++++ > .../devicetree/bindings/spi/spi-fsl-dspi.txt | 65 --------- > MAINTAINERS | 2 +- > 3 files changed, 132 insertions(+), 66 deletions(-) > create mode 100644 Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > delete mode 100644 Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt > > diff --git a/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml b/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > new file mode 100644 > index 000000000000..15ffc83bdba6 > --- /dev/null > +++ b/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > @@ -0,0 +1,131 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/spi/fsl,spi-fsl-dspi.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Freescale DSPI Controller > + > +maintainers: > + - Vladimir Oltean <olteanv@gmail.com> > + > +allOf: > + - $ref: "spi-controller.yaml#" > + > +properties: > + compatible: > + oneOf: > + - enum: > + - fsl,vf610-dspi > + - fsl,ls1021a-v1.0-dspi > + - fsl,ls1028a-dspi > + - fsl,ls2085a-dspi > + - fsl,lx2160a-dspi > + - items: > + - enum: > + - fsl,ls1012a-dspi > + - fsl,ls1028a-dspi > + - fsl,ls1043a-dspi > + - fsl,ls1046a-dspi > + - fsl,ls1088a-dspi > + - const: fsl,ls1021a-v1.0-dspi > + - items: > + - enum: > + - fsl,ls2080a-dspi > + - fsl,lx2160a-dspi > + - const: fsl,ls2085a-dspi > + > + reg: > + maxItems: 1 > + description: Offset and length of registers > + > + interrupts: > + maxItems: 1 > + > + clocks: > + items: > + - description: SoC dspi clock > + > + clock-names: > + items: > + - const: dspi > + > + pinctrl-names: > + minItems: 1 Implied by the length of 'items'. > + items: > + - const: default > + description: > + Names for the pin configuration must be "default" Just repeating what the schema says. Drop. > + > + dmas: > + maxItems: 2 > + > + dma-names: > + items: > + - const: tx > + - const: rx > + > + spi-num-chipselects: > + maxItems: 1 An array? This needs a type ref. > + description: Number of the chipselect signals > + > + bus-num: > + items: > + - description: Slave chip chipselect signal number An array? Also needs a type ref. > + > +patternProperties: > + "@[0-9a-f]+": > + type: object > + > + properties: > + fsl,spi-cs-sck-delay: > + description: > + Delay in nanoseconds between activating chip select and the start of > + clock signal, at the start of a transfer. > + $ref: /schemas/types.yaml#/definitions/uint32 > + > + fsl,spi-sck-cs-delay: > + description: > + Delay in nanoseconds between stopping the clock signal and > + deactivating chip select, at the end of a transfer. > + $ref: /schemas/types.yaml#/definitions/uint32 > + > +required: > + - compatible > + - reg > + - interrupts > + - clocks > + - clock-names > + - spi-num-chipselects > + > +unevaluatedProperties: false > + > +examples: > + - | > + #include <dt-bindings/clock/fsl,qoriq-clockgen.h> > + #include <dt-bindings/interrupt-controller/arm-gic.h> > + > + soc { > + #address-cells = <2>; > + #size-cells = <2>; > + > + spi@2100000 { > + compatible = "fsl,ls1028a-dspi", "fsl,ls1021a-v1.0-dspi"; > + #address-cells = <1>; > + #size-cells = <0>; > + reg = <0x0 0x2100000 0x0 0x10000>; > + interrupts = <GIC_SPI 26 IRQ_TYPE_LEVEL_HIGH>; > + clock-names = "dspi"; > + clocks = <&clockgen QORIQ_CLK_PLATFORM_PLL QORIQ_CLK_PLL_DIV(2)>; > + dmas = <&edma0 0 62>, <&edma0 0 60>; > + dma-names = "tx", "rx"; > + spi-num-chipselects = <4>; > + little-endian; > + > + flash@0 { > + compatible = "jedec,spi-nor"; > + spi-max-frequency = <10000000>; > + reg = <0>; > + }; > + }; > + }; > diff --git a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt b/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt > deleted file mode 100644 > index 30a79da9c039..000000000000 > --- a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt > +++ /dev/null > @@ -1,65 +0,0 @@ > -ARM Freescale DSPI controller > - > -Required properties: > -- compatible : must be one of: > - "fsl,vf610-dspi", > - "fsl,ls1021a-v1.0-dspi", > - "fsl,ls1012a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), > - "fsl,ls1028a-dspi", > - "fsl,ls1043a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), > - "fsl,ls1046a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), > - "fsl,ls1088a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), > - "fsl,ls2080a-dspi" (optionally followed by "fsl,ls2085a-dspi"), > - "fsl,ls2085a-dspi", > - "fsl,lx2160a-dspi", > -- reg : Offset and length of the register set for the device > -- interrupts : Should contain SPI controller interrupt > -- clocks: from common clock binding: handle to dspi clock. > -- clock-names: from common clock binding: Shall be "dspi". > -- pinctrl-0: pin control group to be used for this controller. > -- pinctrl-names: must contain a "default" entry. > -- spi-num-chipselects : the number of the chipselect signals. > - > -Optional property: > -- big-endian: If present the dspi device's registers are implemented > - in big endian mode. > -- bus-num : the slave chip chipselect signal number. > - > -Optional SPI slave node properties: > -- fsl,spi-cs-sck-delay: a delay in nanoseconds between activating chip > - select and the start of clock signal, at the start of a transfer. > -- fsl,spi-sck-cs-delay: a delay in nanoseconds between stopping the clock > - signal and deactivating chip select, at the end of a transfer. > - > -Example: > - > -dspi0@4002c000 { > - #address-cells = <1>; > - #size-cells = <0>; > - compatible = "fsl,vf610-dspi"; > - reg = <0x4002c000 0x1000>; > - interrupts = <0 67 0x04>; > - clocks = <&clks VF610_CLK_DSPI0>; > - clock-names = "dspi"; > - spi-num-chipselects = <5>; > - bus-num = <0>; > - pinctrl-names = "default"; > - pinctrl-0 = <&pinctrl_dspi0_1>; > - big-endian; > - > - sflash: at26df081a@0 { > - #address-cells = <1>; > - #size-cells = <1>; > - compatible = "atmel,at26df081a"; > - spi-max-frequency = <16000000>; > - spi-cpol; > - spi-cpha; > - reg = <0>; > - linux,modalias = "m25p80"; > - modal = "at26df081a"; > - fsl,spi-cs-sck-delay = <100>; > - fsl,spi-sck-cs-delay = <50>; > - }; > -}; > - > - > diff --git a/MAINTAINERS b/MAINTAINERS > index d92f85ca831d..e2c5b7367db9 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -7060,7 +7060,7 @@ FREESCALE DSPI DRIVER > M: Vladimir Oltean <olteanv@gmail.com> > L: linux-spi@vger.kernel.org > S: Maintained > -F: Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt > +F: Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml > F: drivers/spi/spi-fsl-dspi.c > F: include/linux/spi/spi-fsl-dspi.h > > -- > 2.17.1 >
On Wed, Mar 24, 2021 at 12:14:03PM -0600, Rob Herring wrote: > On Tue, Mar 16, 2021 at 12:15:06PM +0200, Vladimir Oltean wrote: > > On Tue, Mar 16, 2021 at 06:08:17AM +0000, Kuldeep Singh wrote: > > > Compatible entries in conjugation require enum and const pair. > > > For example, ls1012a.dtsi uses compatible = "fsl,ls1012a-dspi","fsl,ls1021a-v1.0-dspi"; > > > Same goes for LS1028 as well. > > > > > > Therefore, can't mention the compatible entry as single entity otherwise > > > it may fail "make dt_binding_check" and "make dtbs_check". > > > > > > > > > > > > +examples: > > > > > + - | > > > > > + #include <dt-bindings/clock/fsl,qoriq-clockgen.h> > > > > > + #include <dt-bindings/interrupt-controller/arm-gic.h> > > > > > + > > > > > + soc { > > > > > + #address-cells = <2>; > > > > > + #size-cells = <2>; > > > > > + > > > > > + spi@2100000 { > > > > > + compatible = "fsl,ls1028a-dspi", "fsl,ls1021a-v1.0-dspi"; > > > > > > > > This doesn't need the "fsl,ls1021a-v1.0-dspi" compatible, can you please remove > > > > it? > > > > > > I have taken this example from LS1028a.dtsi and it uses these compatibles in conjugation. > > > If "fsl,ls1021a-v1.0-dspi" is not required, then it should also be removed from device-tree > > > As well as from bindings both. > > > > Yes, the second compatible is never required by the driver and should be > > removed from existing device trees if that makes "make dtbs_check" fail. > > Can you say that is true for every possible driver implementation? > u-boot, *BSD, etc.? I don't think other systems are required to follow Linux conventions, so I'm not sure why it matters.
On Wed, Mar 24, 2021 at 12:53 PM Vladimir Oltean <olteanv@gmail.com> wrote: > > On Wed, Mar 24, 2021 at 12:14:03PM -0600, Rob Herring wrote: > > On Tue, Mar 16, 2021 at 12:15:06PM +0200, Vladimir Oltean wrote: > > > On Tue, Mar 16, 2021 at 06:08:17AM +0000, Kuldeep Singh wrote: > > > > Compatible entries in conjugation require enum and const pair. > > > > For example, ls1012a.dtsi uses compatible = "fsl,ls1012a-dspi","fsl,ls1021a-v1.0-dspi"; > > > > Same goes for LS1028 as well. > > > > > > > > Therefore, can't mention the compatible entry as single entity otherwise > > > > it may fail "make dt_binding_check" and "make dtbs_check". > > > > > > > > > > > > > > > +examples: > > > > > > + - | > > > > > > + #include <dt-bindings/clock/fsl,qoriq-clockgen.h> > > > > > > + #include <dt-bindings/interrupt-controller/arm-gic.h> > > > > > > + > > > > > > + soc { > > > > > > + #address-cells = <2>; > > > > > > + #size-cells = <2>; > > > > > > + > > > > > > + spi@2100000 { > > > > > > + compatible = "fsl,ls1028a-dspi", "fsl,ls1021a-v1.0-dspi"; > > > > > > > > > > This doesn't need the "fsl,ls1021a-v1.0-dspi" compatible, can you please remove > > > > > it? > > > > > > > > I have taken this example from LS1028a.dtsi and it uses these compatibles in conjugation. > > > > If "fsl,ls1021a-v1.0-dspi" is not required, then it should also be removed from device-tree > > > > As well as from bindings both. > > > > > > Yes, the second compatible is never required by the driver and should be > > > removed from existing device trees if that makes "make dtbs_check" fail. > > > > Can you say that is true for every possible driver implementation? > > u-boot, *BSD, etc.? > > I don't think other systems are required to follow Linux conventions, so > I'm not sure why it matters. Not required, but other projects do in fact use both bindings and dts files. Bindings and dts files are stored in the kernel tree for convenience as that's where the most activity is, but they are not "Linux bindings" or "Linux DT" files. In addition, "fsl,ls1088a-dspi" is not known by the Linux driver, so a fallback is needed. Rob
diff --git a/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml b/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml new file mode 100644 index 000000000000..15ffc83bdba6 --- /dev/null +++ b/Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml @@ -0,0 +1,131 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/spi/fsl,spi-fsl-dspi.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Freescale DSPI Controller + +maintainers: + - Vladimir Oltean <olteanv@gmail.com> + +allOf: + - $ref: "spi-controller.yaml#" + +properties: + compatible: + oneOf: + - enum: + - fsl,vf610-dspi + - fsl,ls1021a-v1.0-dspi + - fsl,ls1028a-dspi + - fsl,ls2085a-dspi + - fsl,lx2160a-dspi + - items: + - enum: + - fsl,ls1012a-dspi + - fsl,ls1028a-dspi + - fsl,ls1043a-dspi + - fsl,ls1046a-dspi + - fsl,ls1088a-dspi + - const: fsl,ls1021a-v1.0-dspi + - items: + - enum: + - fsl,ls2080a-dspi + - fsl,lx2160a-dspi + - const: fsl,ls2085a-dspi + + reg: + maxItems: 1 + description: Offset and length of registers + + interrupts: + maxItems: 1 + + clocks: + items: + - description: SoC dspi clock + + clock-names: + items: + - const: dspi + + pinctrl-names: + minItems: 1 + items: + - const: default + description: + Names for the pin configuration must be "default" + + dmas: + maxItems: 2 + + dma-names: + items: + - const: tx + - const: rx + + spi-num-chipselects: + maxItems: 1 + description: Number of the chipselect signals + + bus-num: + items: + - description: Slave chip chipselect signal number + +patternProperties: + "@[0-9a-f]+": + type: object + + properties: + fsl,spi-cs-sck-delay: + description: + Delay in nanoseconds between activating chip select and the start of + clock signal, at the start of a transfer. + $ref: /schemas/types.yaml#/definitions/uint32 + + fsl,spi-sck-cs-delay: + description: + Delay in nanoseconds between stopping the clock signal and + deactivating chip select, at the end of a transfer. + $ref: /schemas/types.yaml#/definitions/uint32 + +required: + - compatible + - reg + - interrupts + - clocks + - clock-names + - spi-num-chipselects + +unevaluatedProperties: false + +examples: + - | + #include <dt-bindings/clock/fsl,qoriq-clockgen.h> + #include <dt-bindings/interrupt-controller/arm-gic.h> + + soc { + #address-cells = <2>; + #size-cells = <2>; + + spi@2100000 { + compatible = "fsl,ls1028a-dspi", "fsl,ls1021a-v1.0-dspi"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x0 0x2100000 0x0 0x10000>; + interrupts = <GIC_SPI 26 IRQ_TYPE_LEVEL_HIGH>; + clock-names = "dspi"; + clocks = <&clockgen QORIQ_CLK_PLATFORM_PLL QORIQ_CLK_PLL_DIV(2)>; + dmas = <&edma0 0 62>, <&edma0 0 60>; + dma-names = "tx", "rx"; + spi-num-chipselects = <4>; + little-endian; + + flash@0 { + compatible = "jedec,spi-nor"; + spi-max-frequency = <10000000>; + reg = <0>; + }; + }; + }; diff --git a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt b/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt deleted file mode 100644 index 30a79da9c039..000000000000 --- a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt +++ /dev/null @@ -1,65 +0,0 @@ -ARM Freescale DSPI controller - -Required properties: -- compatible : must be one of: - "fsl,vf610-dspi", - "fsl,ls1021a-v1.0-dspi", - "fsl,ls1012a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), - "fsl,ls1028a-dspi", - "fsl,ls1043a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), - "fsl,ls1046a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), - "fsl,ls1088a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"), - "fsl,ls2080a-dspi" (optionally followed by "fsl,ls2085a-dspi"), - "fsl,ls2085a-dspi", - "fsl,lx2160a-dspi", -- reg : Offset and length of the register set for the device -- interrupts : Should contain SPI controller interrupt -- clocks: from common clock binding: handle to dspi clock. -- clock-names: from common clock binding: Shall be "dspi". -- pinctrl-0: pin control group to be used for this controller. -- pinctrl-names: must contain a "default" entry. -- spi-num-chipselects : the number of the chipselect signals. - -Optional property: -- big-endian: If present the dspi device's registers are implemented - in big endian mode. -- bus-num : the slave chip chipselect signal number. - -Optional SPI slave node properties: -- fsl,spi-cs-sck-delay: a delay in nanoseconds between activating chip - select and the start of clock signal, at the start of a transfer. -- fsl,spi-sck-cs-delay: a delay in nanoseconds between stopping the clock - signal and deactivating chip select, at the end of a transfer. - -Example: - -dspi0@4002c000 { - #address-cells = <1>; - #size-cells = <0>; - compatible = "fsl,vf610-dspi"; - reg = <0x4002c000 0x1000>; - interrupts = <0 67 0x04>; - clocks = <&clks VF610_CLK_DSPI0>; - clock-names = "dspi"; - spi-num-chipselects = <5>; - bus-num = <0>; - pinctrl-names = "default"; - pinctrl-0 = <&pinctrl_dspi0_1>; - big-endian; - - sflash: at26df081a@0 { - #address-cells = <1>; - #size-cells = <1>; - compatible = "atmel,at26df081a"; - spi-max-frequency = <16000000>; - spi-cpol; - spi-cpha; - reg = <0>; - linux,modalias = "m25p80"; - modal = "at26df081a"; - fsl,spi-cs-sck-delay = <100>; - fsl,spi-sck-cs-delay = <50>; - }; -}; - - diff --git a/MAINTAINERS b/MAINTAINERS index d92f85ca831d..e2c5b7367db9 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7060,7 +7060,7 @@ FREESCALE DSPI DRIVER M: Vladimir Oltean <olteanv@gmail.com> L: linux-spi@vger.kernel.org S: Maintained -F: Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt +F: Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml F: drivers/spi/spi-fsl-dspi.c F: include/linux/spi/spi-fsl-dspi.h
Convert the Freescale DSPI binding to DT schema format using json-schema. Signed-off-by: Kuldeep Singh <kuldeep.singh@nxp.com> --- Hi Rob, This patch is checked with following commands with no warnings observed. make distclean; make allmodconfig; make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml; make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml .../bindings/spi/fsl,spi-fsl-dspi.yaml | 131 ++++++++++++++++++ .../devicetree/bindings/spi/spi-fsl-dspi.txt | 65 --------- MAINTAINERS | 2 +- 3 files changed, 132 insertions(+), 66 deletions(-) create mode 100644 Documentation/devicetree/bindings/spi/fsl,spi-fsl-dspi.yaml delete mode 100644 Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt