RE: [Patch v5] dt-bindings: media: s5p-mfc: convert bindings to json-schema
From: Aakarsh Jain
Date: Tue Feb 28 2023 - 01:05:26 EST
> -----Original Message-----
> From: Krzysztof Kozlowski [mailto:krzysztof.kozlowski@xxxxxxxxxx]
> Sent: 27 February 2023 15:21
> To: Aakarsh Jain <aakarsh.jain@xxxxxxxxxxx>; linux-arm-
> kernel@xxxxxxxxxxxxxxxxxxx; linux-media@xxxxxxxxxxxxxxx; linux-
> kernel@xxxxxxxxxxxxxxx; devicetree@xxxxxxxxxxxxxxx
> Cc: m.szyprowski@xxxxxxxxxxx; andrzej.hajda@xxxxxxxxx;
> mchehab@xxxxxxxxxx; hverkuil-cisco@xxxxxxxxx;
> ezequiel@xxxxxxxxxxxxxxxxxxxx; jernej.skrabec@xxxxxxxxx;
> benjamin.gaignard@xxxxxxxxxxxxx; krzysztof.kozlowski+dt@xxxxxxxxxx;
> stanimir.varbanov@xxxxxxxxxx; dillon.minfei@xxxxxxxxx;
> david.plowman@xxxxxxxxxxxxxxx; mark.rutland@xxxxxxx;
> robh+dt@xxxxxxxxxx; krzk+dt@xxxxxxxxxx; andi@xxxxxxxxxxx;
> alim.akhtar@xxxxxxxxxxx; aswani.reddy@xxxxxxxxxxx;
> pankaj.dubey@xxxxxxxxxxx
> Subject: Re: [Patch v5] dt-bindings: media: s5p-mfc: convert bindings to json-
> schema
>
> On 27/02/2023 09:47, Aakarsh Jain wrote:
> > Convert s5p-mfc bindings to DT schema format using json-schema.
> >
> > Signed-off-by: Aakarsh Jain <aakarsh.jain@xxxxxxxxxxx>
> > ---
> > changes since v4:
> > Removed items from oneOf section
> > dropped black line
> > defined the iommus names items as
> > items:
> > -const left
> > -const right
> >
> > changes since v3:
> > fixed dt-schema warnings and errors while running make dtbs_check and
> > make dt_binding_check for ARMv7 Since, obsolete properties are not part
> of dt-node so we are not including these properties in dt-schema.
> >
> > changes since v2:
> > changed Commit message from Adds to Convert Removed text "This file
> > has moved to samsung,s5p-mfc.yaml" from s5p-mfc.txt fixed dt-schema
> > warnings and errors while running make dtbs_check and make
> > dt_binding_check
> >
> > changes since v1:
> > fixed dt-schema warnings and errors while running make dtbs_check and
> > make dt_binding_check Removed description.
> > Listed items.
> > Added allOf:if:then for restricting two items to specific compatible
> >
> > This patch is independent from the previous MFC v12 patch series for HW3
> support.
> >
> > .../devicetree/bindings/media/s5p-mfc.txt | 78 ---------
> > .../bindings/media/samsung,s5p-mfc.yaml | 148
> ++++++++++++++++++
> > 2 files changed, 148 insertions(+), 78 deletions(-) create mode
> > 100644 Documentation/devicetree/bindings/media/samsung,s5p-mfc.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/media/s5p-mfc.txt
> > b/Documentation/devicetree/bindings/media/s5p-mfc.txt
> > index 8eb90c043d5d..e69de29bb2d1 100644
> > --- a/Documentation/devicetree/bindings/media/s5p-mfc.txt
> > +++ b/Documentation/devicetree/bindings/media/s5p-mfc.txt
> > @@ -1,78 +0,0 @@
> > -* Samsung Multi Format Codec (MFC)
> > -
> > -Multi Format Codec (MFC) is the IP present in Samsung SoCs which
> > -supports high resolution decoding and encoding functionalities.
> > -The MFC device driver is a v4l2 driver which can encode/decode -video
> > raw/elementary streams and has support for all popular -video codecs.
> > -
> > -Required properties:
> > - - compatible : value should be either one among the following
> > - (a) "samsung,mfc-v5" for MFC v5 present in Exynos4 SoCs
> > - (b) "samsung,mfc-v6" for MFC v6 present in Exynos5 SoCs
> > - (c) "samsung,exynos3250-mfc", "samsung,mfc-v7" for MFC v7
> > - present in Exynos3250 SoC
> > - (d) "samsung,mfc-v7" for MFC v7 present in Exynos5420 SoC
> > - (e) "samsung,mfc-v8" for MFC v8 present in Exynos5800 SoC
> > - (f) "samsung,exynos5433-mfc" for MFC v8 present in Exynos5433 SoC
> > - (g) "samsung,mfc-v10" for MFC v10 present in Exynos7880 SoC
> > -
> > - - reg : Physical base address of the IP registers and length of memory
> > - mapped region.
> > -
> > - - interrupts : MFC interrupt number to the CPU.
> > - - clocks : from common clock binding: handle to mfc clock.
> > - - clock-names : from common clock binding: must contain "mfc",
> > - corresponding to entry in the clocks property.
> > -
> > -Optional properties:
> > - - power-domains : power-domain property defined with a phandle
> > - to respective power domain.
> > - - memory-region : from reserved memory binding: phandles to two
> reserved
> > - memory regions, first is for "left" mfc memory bus interfaces,
> > - second if for the "right" mfc memory bus, used when no SYSMMU
> > - support is available; used only by MFC v5 present in Exynos4 SoCs
> > -
> > -Obsolete properties:
> > - - samsung,mfc-r, samsung,mfc-l : support removed, please use memory-
> region
> > - property instead
> > -
> > -
> > -Example:
> > -SoC specific DT entry:
> > -
> > -mfc: codec@13400000 {
> > - compatible = "samsung,mfc-v5";
> > - reg = <0x13400000 0x10000>;
> > - interrupts = <0 94 0>;
> > - power-domains = <&pd_mfc>;
> > - clocks = <&clock 273>;
> > - clock-names = "mfc";
> > -};
> > -
> > -Reserved memory specific DT entry for given board (see reserved
> > memory binding -for more information):
> > -
> > -reserved-memory {
> > - #address-cells = <1>;
> > - #size-cells = <1>;
> > - ranges;
> > -
> > - mfc_left: region@51000000 {
> > - compatible = "shared-dma-pool";
> > - no-map;
> > - reg = <0x51000000 0x800000>;
> > - };
> > -
> > - mfc_right: region@43000000 {
> > - compatible = "shared-dma-pool";
> > - no-map;
> > - reg = <0x43000000 0x800000>;
> > - };
> > -};
> > -
> > -Board specific DT entry:
> > -
> > -codec@13400000 {
> > - memory-region = <&mfc_left>, <&mfc_right>;
> > -};
> > diff --git
> > a/Documentation/devicetree/bindings/media/samsung,s5p-mfc.yaml
> > b/Documentation/devicetree/bindings/media/samsung,s5p-mfc.yaml
> > index 000000000000..b4a289619db0
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/media/samsung,s5p-mfc.yaml
> > @@ -0,0 +1,148 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause %YAML 1.2
> > +---
> > +$id:
> > +https://protect2.fireeye.com/v1/url?k=854d051c-e4c61026-854c8e53-
> 74fe
> > +4860008a-fcfe16271c217cbf&q=1&e=3cdd6dac-7b8e-46be-97b0-
> 8dcfc73fae2d&
> >
> +u=http%3A%2F%2Fdevicetree.org%2Fschemas%2Fmedia%2Fsamsung%2Cs
> 5p-mfc.y
> > +aml%23
> > +$schema:
> > +https://protect2.fireeye.com/v1/url?k=c84eeb37-a9c5fe0d-c84f6078-74fe
> > +4860008a-c1bfcc6b2d35840d&q=1&e=3cdd6dac-7b8e-46be-97b0-
> 8dcfc73fae2d&
> > +u=http%3A%2F%2Fdevicetree.org%2Fmeta-schemas%2Fcore.yaml%23
> > +
> > +title: Samsung Exynos Multi Format Codec (MFC)
> > +
> > +maintainers:
> > + - Marek Szyprowski <m.szyprowski@xxxxxxxxxxx>
> > + - Aakarsh Jain <aakarsh.jain@xxxxxxxxxxx>
> > +
> > +description:
> > + Multi Format Codec (MFC) is the IP present in Samsung SoCs which
> > + supports high resolution decoding and encoding functionalities.
> > +
> > +properties:
> > + compatible:
> > + oneOf:
> > + - enum:
> > + - samsung,mfc-v5 # Exynos4
> > + - samsung,mfc-v6 # Exynos5
> > + - items:
> > + - enum:
> > + - samsung,exynos3250-mfc # Exynos3250
> > + - const: samsung,mfc-v7 # Fall back for Exynos3250
> > + - enum:
> > + - samsung,mfc-v7 # Exynos5420
> > + - samsung,mfc-v8 # Exynos5800
> > + - samsung,exynos5433-mfc # Exynos5433
> > + - samsung,mfc-v10 # Exynos7880
>
> Why this and first enum are separate? I didn't notice it before...
> Usually we have only one enum for one-compatible variants. Also, sort them
> by compatible.
>
okay.
I will keep it in this way
properties:
compatible:
oneOf:
- const: samsung,mfc-v5 # Exynos4
- const: samsung,mfc-v6 # Exynos5
- const: samsung,mfc-v7 # Exynos5420
- const: samsung,mfc-v8 # Exynos5800
- const: samsung,exynos5433-mfc # Exynos5433
- const: samsung,mfc-v10 # Exynos7880
- items:
- const: samsung,exynos3250-mfc # Exynos3250
- const: samsung,mfc-v7 # Fall back for Exynos3250
Will this be fine?
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + clocks:
> > + minItems: 1
> > + maxItems: 3
> > +
> > + clock-names:
> > + minItems: 1
> > + maxItems: 3
> > +
> > + interrupts:
> > + maxItems: 1
> > +
> > + iommus:
> > + minItems: 1
> > + maxItems: 2
> > +
> > + iommu-names:
> > + items:
> > + - const: left
> > + - const: right
> > +
> > + power-domains:
> > + maxItems: 1
> > +
> > + memory-region:
> > + minItems: 1
> > + maxItems: 2
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - clocks
> > + - clock-names
> > + - interrupts
> > +
> > +additionalProperties: false
> > +
> > +allOf:
> > + - if:
> > + properties:
> > + compatible:
> > + contains:
> > + enum:
> > + - samsung,mfc-v5
> > + - samsung,exynos3250-mfc
> > + then:
> > + properties:
> > + clocks:
> > + maxItems: 2
> > + clock-names:
> > + items:
> > + - const: mfc
> > + - const: sclk_mfc
> > +
> > + - if:
> > + properties:
> > + compatible:
> > + contains:
> > + enum:
> > + - samsung,mfc-v6
> > + - samsung,mfc-v8
> > + then:
> > + properties:
> > + clocks:
> > + maxItems: 1
> > + clock-names:
> > + items:
> > + - const: mfc
> > +
> > + - if:
> > + properties:
> > + compatible:
> > + contains:
> > + enum:
> > + - samsung,exynos5433-mfc
> > + then:
> > + properties:
> > + clocks:
> > + maxItems: 3
> > + clock-names:
> > + items:
> > + - const: pclk
> > + - const: aclk
> > + - const: aclk_xiu
>
> What happened to iommus? You were requiring two items, but you dropped
> that requirement. Is it on purpose?
>
Actually I thought I defined at top via items so it will cover all scenarios.
I will add it again iommus : maxItems as 2
> > +
> > + - if:
> > + properties:
> > + compatible:
> > + contains:
> > + enum:
> > + - samsung,mfc-v7
> > + then:
> > + properties:
> > + clocks:
> > + minItems: 1
> > + maxItems: 2
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/clock/exynos4.h>
> > + #include <dt-bindings/clock/exynos-audss-clk.h>
> > + #include <dt-bindings/interrupt-controller/arm-gic.h>
> > + #include <dt-bindings/interrupt-controller/irq.h>
> > +
> > + codec@13400000 {
> > + compatible = "samsung,mfc-v5";
>
> You sill have here odd indentation. Use 4 spaces for DTS example.
>
okay will rearrange .
> > + reg = <0x13400000 0x10000>;
> > + interrupts = <GIC_SPI 94 IRQ_TYPE_LEVEL_HIGH>;
> > + power-domains = <&pd_mfc>;
> > + clocks = <&clock CLK_MFC>, <&clock CLK_SCLK_MFC>;
> > + clock-names = "mfc", "sclk_mfc";
> > + iommus = <&sysmmu_mfc_l>, <&sysmmu_mfc_r>;
> > + iommu-names = "left", "right";
> > + };
>
> Best regards,
> Krzysztof
Thanks for the review.