dt-bindings: misc: brcm,kona-smc: convert to YAML

Message ID 20230504190250.GA10108@standask-GA-A55M-S2HP
State New
Headers
Series dt-bindings: misc: brcm,kona-smc: convert to YAML |

Commit Message

Stanislav Jakubek May 4, 2023, 7:02 p.m. UTC
  Convert Broadcom Kona family Secure Monitor bounce buffer bindings
to DT schema.

Change during conversion:
  - add used, but previously undocumented SoC-specific compatibles

Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
---
 .../bindings/misc/brcm,kona-smc.txt           | 15 -------
 .../bindings/misc/brcm,kona-smc.yaml          | 44 +++++++++++++++++++
 2 files changed, 44 insertions(+), 15 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.txt
 create mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml
  

Comments

Krzysztof Kozlowski May 5, 2023, 6:49 a.m. UTC | #1
On 04/05/2023 21:02, Stanislav Jakubek wrote:
> Convert Broadcom Kona family Secure Monitor bounce buffer bindings
> to DT schema.
> 
> Change during conversion:
>   - add used, but previously undocumented SoC-specific compatibles
> 
> Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
> ---
>  .../bindings/misc/brcm,kona-smc.txt           | 15 -------
>  .../bindings/misc/brcm,kona-smc.yaml          | 44 +++++++++++++++++++

Please put SMC stuff in firmware subdirectory.

>  2 files changed, 44 insertions(+), 15 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.txt
>  create mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml
> 
> 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
> -	};
> diff --git a/Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml b/Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml
> new file mode 100644
> index 000000000000..ba0312a20083
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml
> @@ -0,0 +1,44 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/misc/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
> +      - items:
> +          - const: bcm,bcm11351-smc
> +          - const: bcm,kona-smc
> +        deprecated: true

That's not correct. You deprecate the same set as you allow before. I
think you wanted to deprecated kona-smc alone.

> +
> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg

Best regards,
Krzysztof
  
Stanislav Jakubek May 5, 2023, 7:18 a.m. UTC | #2
On Fri, May 05, 2023 at 08:49:55AM +0200, Krzysztof Kozlowski wrote:
> On 04/05/2023 21:02, Stanislav Jakubek wrote:
> > Convert Broadcom Kona family Secure Monitor bounce buffer bindings
> > to DT schema.
> > 
> > Change during conversion:
> >   - add used, but previously undocumented SoC-specific compatibles
> > 
> > Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
> > ---
> >  .../bindings/misc/brcm,kona-smc.txt           | 15 -------
> >  .../bindings/misc/brcm,kona-smc.yaml          | 44 +++++++++++++++++++
> 
> Please put SMC stuff in firmware subdirectory.

Ok, will move it there in V2.

> 
> >  2 files changed, 44 insertions(+), 15 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.txt
> >  create mode 100644 Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml
> > 
> > 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
> > -	};
> > diff --git a/Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml b/Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml
> > new file mode 100644
> > index 000000000000..ba0312a20083
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml
> > @@ -0,0 +1,44 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/misc/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
> > +      - items:
> > +          - const: bcm,bcm11351-smc
> > +          - const: bcm,kona-smc
> > +        deprecated: true
> 
> That's not correct. You deprecate the same set as you allow before. I
> think you wanted to deprecated kona-smc alone.

What I'm trying to do here is to deprecate both compatibles with the
"bcm" vendor prefix, as these were initially introduced in [1]. bcm11351 is the
only one that ever had the "bcm" prefix, both bcm21664 [2] and bcm23550 [3]
were introduced with the "brcm" prefix (though they were never documented).

[1] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit?id=7f6c62e2695bcb1547afdeb4ad3bcdf8c610be2c
[2] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit?id=2eba905e860f8aed5f2743b45259bb2e92548a55
[3] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit?id=fcd4138653f049c8fa45b48dc5f2806ced68e304

Regards,
Stanislav

> 
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> 
> Best regards,
> Krzysztof
>
  
Krzysztof Kozlowski May 5, 2023, 10:36 a.m. UTC | #3
On 05/05/2023 09:18, Stanislav Jakubek wrote:

>>> +      - items:
>>> +          - enum:
>>> +              - brcm,bcm11351-smc
>>> +              - brcm,bcm21664-smc
>>> +              - brcm,bcm23550-smc
>>> +          - const: brcm,kona-smc
>>> +      - items:
>>> +          - const: bcm,bcm11351-smc
>>> +          - const: bcm,kona-smc
>>> +        deprecated: true
>>
>> That's not correct. You deprecate the same set as you allow before. I
>> think you wanted to deprecated kona-smc alone.
> 
> What I'm trying to do here is to deprecate both compatibles with the
> "bcm" vendor prefix, as these were initially introduced in [1]. bcm11351 is the
> only one that ever had the "bcm" prefix, both bcm21664 [2] and bcm23550 [3]
> were introduced with the "brcm" prefix (though they were never documented).
> 
> [1] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit?id=7f6c62e2695bcb1547afdeb4ad3bcdf8c610be2c
> [2] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit?id=2eba905e860f8aed5f2743b45259bb2e92548a55
> [3] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit?id=fcd4138653f049c8fa45b48dc5f2806ced68e304

Ah, right, I missed the difference in prefix. I propose to just drop it.
It was deprecated 10 years ago!

Best regards,
Krzysztof
  

Patch

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
-	};
diff --git a/Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml b/Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml
new file mode 100644
index 000000000000..ba0312a20083
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/brcm,kona-smc.yaml
@@ -0,0 +1,44 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/misc/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
+      - items:
+          - const: bcm,bcm11351-smc
+          - const: bcm,kona-smc
+        deprecated: true
+
+  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 */
+    };
+...