This is the preparation for updates on the bcm63xx hsspi driver. Convert
the text based bindings to json-schema per new dts requirement.
Signed-off-by: William Zhang <william.zhang@broadcom.com>
---
.../bindings/spi/brcm,bcm63xx-hsspi.yaml | 52 +++++++++++++++++++
.../bindings/spi/spi-bcm63xx-hsspi.txt | 33 ------------
2 files changed, 52 insertions(+), 33 deletions(-)
create mode 100644 Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml
delete mode 100644 Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt
diff --git a/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml b/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml
new file mode 100644
index 000000000000..45f1417b1213
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml
@@ -0,0 +1,52 @@
+# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/brcm,bcm63xx-hsspi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Broadcom BCM6328 High Speed SPI controller
+
+maintainers:
+ - Jonas Gorski <jonas.gorski@gmail.com>
+
+properties:
+ compatible:
+ const: brcm,bcm6328-hsspi
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ items:
+ - description: spi master reference clock
+ - description: spi master pll clock
+
+ clock-names:
+ items:
+ - const: hsspi
+ - const: pll
+
+ interrupts:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - clock-names
+ - interrupts
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ spi@10001000 {
+ compatible = "brcm,bcm6328-hsspi";
+ reg = <0x10001000 0x600>;
+ interrupts = <29>;
+ clocks = <&clkctl 9>, <&hsspi_pll>;
+ clock-names = "hsspi", "pll";
+ num-cs = <2>;
+ #address-cells = <1>;
+ #size-cells = <0>;
+ };
diff --git a/Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt b/Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt
deleted file mode 100644
index 37b29ee13860..000000000000
--- a/Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt
+++ /dev/null
@@ -1,33 +0,0 @@
-Binding for Broadcom BCM6328 High Speed SPI controller
-
-Required properties:
-- compatible: must contain of "brcm,bcm6328-hsspi".
-- reg: Base address and size of the controllers memory area.
-- interrupts: Interrupt for the SPI block.
-- clocks: phandles of the SPI clock and the PLL clock.
-- clock-names: must be "hsspi", "pll".
-- #address-cells: <1>, as required by generic SPI binding.
-- #size-cells: <0>, also as required by generic SPI binding.
-
-Optional properties:
-- num-cs: some controllers have less than 8 cs signals. Defaults to 8
- if absent.
-
-Child nodes as per the generic SPI binding.
-
-Example:
-
- spi@10001000 {
- compatible = "brcm,bcm6328-hsspi";
- reg = <0x10001000 0x600>;
-
- interrupts = <29>;
-
- clocks = <&clkctl 9>, <&hsspi_pll>;
- clock-names = "hsspi", "pll";
-
- num-cs = <2>;
-
- #address-cells = <1>;
- #size-cells = <0>;
- };
--
2.37.3On 06/01/2023 21:07, William Zhang wrote: > This is the preparation for updates on the bcm63xx hsspi driver. Convert > the text based bindings to json-schema per new dts requirement. > > Signed-off-by: William Zhang <william.zhang@broadcom.com> > --- > > .../bindings/spi/brcm,bcm63xx-hsspi.yaml | 52 +++++++++++++++++++ > .../bindings/spi/spi-bcm63xx-hsspi.txt | 33 ------------ > 2 files changed, 52 insertions(+), 33 deletions(-) > create mode 100644 Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml > delete mode 100644 Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt > > diff --git a/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml b/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml > new file mode 100644 > index 000000000000..45f1417b1213 > --- /dev/null > +++ b/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml > @@ -0,0 +1,52 @@ > +# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/spi/brcm,bcm63xx-hsspi.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Broadcom BCM6328 High Speed SPI controller > + > +maintainers: > + - Jonas Gorski <jonas.gorski@gmail.com> > + Missing reference to spi-controller. > +properties: > + compatible: > + const: brcm,bcm6328-hsspi > + > + reg: > + maxItems: 1 > + > + clocks: > + items: > + - description: spi master reference clock > + - description: spi master pll clock > + > + clock-names: > + items: > + - const: hsspi > + - const: pll > + > + interrupts: > + maxItems: 1 > + > +required: > + - compatible > + - reg > + - clocks > + - clock-names > + - interrupts > + > +unevaluatedProperties: false This is for cases when you have reference to other schema. Best regards, Krzysztof
On 01/07/2023 07:32 AM, Krzysztof Kozlowski wrote: > On 06/01/2023 21:07, William Zhang wrote: >> This is the preparation for updates on the bcm63xx hsspi driver. Convert >> the text based bindings to json-schema per new dts requirement. >> >> Signed-off-by: William Zhang <william.zhang@broadcom.com> >> --- >> >> .../bindings/spi/brcm,bcm63xx-hsspi.yaml | 52 +++++++++++++++++++ >> .../bindings/spi/spi-bcm63xx-hsspi.txt | 33 ------------ >> 2 files changed, 52 insertions(+), 33 deletions(-) >> create mode 100644 Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml >> delete mode 100644 Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt >> >> diff --git a/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml b/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml >> new file mode 100644 >> index 000000000000..45f1417b1213 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml >> @@ -0,0 +1,52 @@ >> +# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause >> +%YAML 1.2 >> +--- >> +$id: http://devicetree.org/schemas/spi/brcm,bcm63xx-hsspi.yaml# >> +$schema: http://devicetree.org/meta-schemas/core.yaml# >> + >> +title: Broadcom BCM6328 High Speed SPI controller >> + >> +maintainers: >> + - Jonas Gorski <jonas.gorski@gmail.com> >> + > > Missing reference to spi-controller. > This was word to word conversion from the text file. But I will update with this required reference. >> +properties: >> + compatible: >> + const: brcm,bcm6328-hsspi >> + >> + reg: >> + maxItems: 1 >> + >> + clocks: >> + items: >> + - description: spi master reference clock >> + - description: spi master pll clock >> + >> + clock-names: >> + items: >> + - const: hsspi >> + - const: pll >> + >> + interrupts: >> + maxItems: 1 >> + >> +required: >> + - compatible >> + - reg >> + - clocks >> + - clock-names >> + - interrupts >> + >> +unevaluatedProperties: false > > This is for cases when you have reference to other schema. > Will drop here. But will add back in patch 1 which produces the final version of this file and need this property. > > Best regards, > Krzysztof >
On 09/01/2023 08:52, William Zhang wrote: > > > On 01/07/2023 07:32 AM, Krzysztof Kozlowski wrote: >> On 06/01/2023 21:07, William Zhang wrote: >>> This is the preparation for updates on the bcm63xx hsspi driver. Convert >>> the text based bindings to json-schema per new dts requirement. >>> >>> Signed-off-by: William Zhang <william.zhang@broadcom.com> >>> --- >>> >>> .../bindings/spi/brcm,bcm63xx-hsspi.yaml | 52 +++++++++++++++++++ >>> .../bindings/spi/spi-bcm63xx-hsspi.txt | 33 ------------ >>> 2 files changed, 52 insertions(+), 33 deletions(-) >>> create mode 100644 Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml >>> delete mode 100644 Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt >>> >>> diff --git a/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml b/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml >>> new file mode 100644 >>> index 000000000000..45f1417b1213 >>> --- /dev/null >>> +++ b/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml >>> @@ -0,0 +1,52 @@ >>> +# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause >>> +%YAML 1.2 >>> +--- >>> +$id: http://devicetree.org/schemas/spi/brcm,bcm63xx-hsspi.yaml# >>> +$schema: http://devicetree.org/meta-schemas/core.yaml# >>> + >>> +title: Broadcom BCM6328 High Speed SPI controller >>> + >>> +maintainers: >>> + - Jonas Gorski <jonas.gorski@gmail.com> >>> + >> >> Missing reference to spi-controller. >> > This was word to word conversion from the text file. But I will update > with this required reference. > >>> +properties: >>> + compatible: >>> + const: brcm,bcm6328-hsspi >>> + >>> + reg: >>> + maxItems: 1 >>> + >>> + clocks: >>> + items: >>> + - description: spi master reference clock >>> + - description: spi master pll clock >>> + >>> + clock-names: >>> + items: >>> + - const: hsspi >>> + - const: pll >>> + >>> + interrupts: >>> + maxItems: 1 >>> + >>> +required: >>> + - compatible >>> + - reg >>> + - clocks >>> + - clock-names >>> + - interrupts >>> + >>> +unevaluatedProperties: false >> >> This is for cases when you have reference to other schema. >> > Will drop here. But will add back in patch 1 which produces the final > version of this file and need this property. When you add reference to spi-controller, keep it here. This was wrong when the reference was missing. Best regards, Krzysztof
On Fri, 06 Jan 2023 12:07:53 -0800, William Zhang wrote:
> This is the preparation for updates on the bcm63xx hsspi driver. Convert
> the text based bindings to json-schema per new dts requirement.
>
> Signed-off-by: William Zhang <william.zhang@broadcom.com>
> ---
>
> .../bindings/spi/brcm,bcm63xx-hsspi.yaml | 52 +++++++++++++++++++
> .../bindings/spi/spi-bcm63xx-hsspi.txt | 33 ------------
> 2 files changed, 52 insertions(+), 33 deletions(-)
> create mode 100644 Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml
> delete mode 100644 Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt
>
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.example.dtb: spi@10001000: Unevaluated properties are not allowed ('#address-cells', '#size-cells', 'num-cs' were unexpected)
From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/spi/brcm,bcm63xx-hsspi.yaml
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230106200809.330769-2-william.zhang@broadcom.com
The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
© 2016 - 2025 Red Hat, Inc.