diff mbox series

[v2] dt-bindings: firmware: brcm,kona-smc: convert to YAML

Message ID	20230508081053.GA4675@standask-GA-A55M-S2HP
State	New
Headers	Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Date: Mon, 8 May 2023 10:10:53 +0200 From: Stanislav Jakubek <stano.jakubek@gmail.com> To: Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Florian Fainelli <f.fainelli@gmail.com>, Ray Jui <rjui@broadcom.com>, Scott Branden <sbranden@broadcom.com> Cc: bcm-kernel-feedback-list@broadcom.com, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2] dt-bindings: firmware: brcm,kona-smc: convert to YAML Message-ID: <20230508081053.GA4675@standask-GA-A55M-S2HP> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Precedence: bulk
Series	[v2] dt-bindings: firmware: brcm,kona-smc: convert to YAML \| [v2] dt-bindings: firmware: brcm,kona-smc: convert to YAML

Commit Message

Stanislav Jakubek May 8, 2023, 8:10 a.m. UTC

  Convert Broadcom Kona family Secure Monitor bounce buffer bindings
to DT schema.

Changes during conversion:
  - move from misc to firmware subdirectory
  - add used, but previously undocumented SoC-specific compatibles
  - drop deprecated compatibles (they've been deprecated for ~10 years)

Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
---

Changes in V2:
  - move to firmware subdirectory (Krzysztof)
  - drop deprecated compatibles (Krzysztof)
  - adjusted commit message to reflect the above changes
  
 .../bindings/firmware/brcm,kona-smc.yaml      | 40 +++++++++++++++++++
 .../bindings/misc/brcm,kona-smc.txt           | 15 -------
 2 files changed, 40 insertions(+), 15 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
 delete mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.txt

Comments

Krzysztof Kozlowski May 8, 2023, 9:23 a.m. UTC | #1

On 08/05/2023 10:10, Stanislav Jakubek wrote:
> Convert Broadcom Kona family Secure Monitor bounce buffer bindings
> to DT schema.
> 
> Changes during conversion:
>   - move from misc to firmware subdirectory
>   - add used, but previously undocumented SoC-specific compatibles
>   - drop deprecated compatibles (they've been deprecated for ~10 years)
> 
> Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
> ---
> 
> Changes in V2:
>   - move to firmware subdirectory (Krzysztof)
>   - drop deprecated compatibles (Krzysztof)
>   - adjusted commit message to reflect the above changes
>   
>  .../bindings/firmware/brcm,kona-smc.yaml      | 40 +++++++++++++++++++
>  .../bindings/misc/brcm,kona-smc.txt           | 15 -------
>  2 files changed, 40 insertions(+), 15 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
>  delete mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.txt
> 
> diff --git a/Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml b/Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
> new file mode 100644
> index 000000000000..16c7928a0daa
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
> @@ -0,0 +1,40 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/firmware/brcm,kona-smc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Broadcom Kona family Secure Monitor bounce buffer
> +
> +description:
> +  A bounce buffer used for non-secure to secure communications.
> +
> +maintainers:
> +  - Florian Fainelli <f.fainelli@gmail.com>
> +
> +properties:
> +  compatible:
> +    oneOf:

You do not need oneOf.


Best regards,
Krzysztof

Rob Herring May 8, 2023, 9:27 a.m. UTC | #2

On Mon, 08 May 2023 10:10:53 +0200, Stanislav Jakubek wrote:
> Convert Broadcom Kona family Secure Monitor bounce buffer bindings
> to DT schema.
> 
> Changes during conversion:
>   - move from misc to firmware subdirectory
>   - add used, but previously undocumented SoC-specific compatibles
>   - drop deprecated compatibles (they've been deprecated for ~10 years)
> 
> Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
> ---
> 
> Changes in V2:
>   - move to firmware subdirectory (Krzysztof)
>   - drop deprecated compatibles (Krzysztof)
>   - adjusted commit message to reflect the above changes
> 
>  .../bindings/firmware/brcm,kona-smc.yaml      | 40 +++++++++++++++++++
>  .../bindings/misc/brcm,kona-smc.txt           | 15 -------
>  2 files changed, 40 insertions(+), 15 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
>  delete mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.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/media/i2c/ovti,ov2685.example.dtb: camera-sensor@3c: port:endpoint:data-lanes: [[1]] is too short
	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/media/i2c/ovti,ov2685.yaml
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/media/rockchip-isp1.example.dtb: camera@3c: port:endpoint:data-lanes: [[1]] is too short
	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/media/i2c/ovti,ov2685.yaml
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/pci/fsl,imx6q-pcie-ep.example.dtb: pcie-ep@33800000: Unevaluated properties are not allowed ('assigned-clock-parents', 'assigned-clock-rates', 'assigned-clocks' were unexpected)
	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/pci/fsl,imx6q-pcie-ep.yaml

doc reference errors (make refcheckdocs):
Documentation/usb/gadget_uvc.rst: Documentation/userspace-api/media/v4l/pixfmt-packed.yuv.rst
MAINTAINERS: Documentation/devicetree/bindings/pwm/pwm-apple.yaml

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230508081053.GA4675@standask-GA-A55M-S2HP

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.

Stanislav Jakubek May 8, 2023, 9:41 a.m. UTC | #3

On Mon, May 08, 2023 at 11:23:52AM +0200, Krzysztof Kozlowski wrote:
> On 08/05/2023 10:10, Stanislav Jakubek wrote:
> > Convert Broadcom Kona family Secure Monitor bounce buffer bindings
> > to DT schema.
> > 
> > Changes during conversion:
> >   - move from misc to firmware subdirectory
> >   - add used, but previously undocumented SoC-specific compatibles
> >   - drop deprecated compatibles (they've been deprecated for ~10 years)
> > 
> > Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
> > ---
> > 
> > Changes in V2:
> >   - move to firmware subdirectory (Krzysztof)
> >   - drop deprecated compatibles (Krzysztof)
> >   - adjusted commit message to reflect the above changes
> >   
> >  .../bindings/firmware/brcm,kona-smc.yaml      | 40 +++++++++++++++++++
> >  .../bindings/misc/brcm,kona-smc.txt           | 15 -------
> >  2 files changed, 40 insertions(+), 15 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
> >  delete mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml b/Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
> > new file mode 100644
> > index 000000000000..16c7928a0daa
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
> > @@ -0,0 +1,40 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/firmware/brcm,kona-smc.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Broadcom Kona family Secure Monitor bounce buffer
> > +
> > +description:
> > +  A bounce buffer used for non-secure to secure communications.
> > +
> > +maintainers:
> > +  - Florian Fainelli <f.fainelli@gmail.com>
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> 
> You do not need oneOf.

Nice catch! Seems I forgot to remove it when removing the deprecated
compatibles. Will fix in V3.

Stanislav

> 
> 
> Best regards,
> Krzysztof
>

diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml b/Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
new file mode 100644
index 000000000000..16c7928a0daa
--- /dev/null
+++ b/Documentation/devicetree/bindings/firmware/brcm,kona-smc.yaml
@@ -0,0 +1,40 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/firmware/brcm,kona-smc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Broadcom Kona family Secure Monitor bounce buffer
+
+description:
+  A bounce buffer used for non-secure to secure communications.
+
+maintainers:
+  - Florian Fainelli <f.fainelli@gmail.com>
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - enum:
+              - brcm,bcm11351-smc
+              - brcm,bcm21664-smc
+              - brcm,bcm23550-smc
+          - const: brcm,kona-smc
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    smc@3404c000 {
+        compatible = "brcm,bcm11351-smc", "brcm,kona-smc";
+        reg = <0x3404c000 0x400>; /* 1 KiB in SRAM */
+    };
+...
diff --git a/Documentation/devicetree/bindings/misc/brcm,kona-smc.txt b/Documentation/devicetree/bindings/misc/brcm,kona-smc.txt
deleted file mode 100644
index 05b47232ed9e..000000000000
--- a/Documentation/devicetree/bindings/misc/brcm,kona-smc.txt
+++ /dev/null
@@ -1,15 +0,0 @@ 
-Broadcom Secure Monitor Bounce buffer
------------------------------------------------------
-This binding defines the location of the bounce buffer
-used for non-secure to secure communications.
-
-Required properties:
-- compatible : "brcm,kona-smc"
-- DEPRECATED: compatible : "bcm,kona-smc"
-- reg : Location and size of bounce buffer
-
-Example:
-	smc@3404c000 {
-		compatible = "brcm,bcm11351-smc", "brcm,kona-smc";
-		reg = <0x3404c000 0x400>; //1 KiB in SRAM
-	};