Re: [PATCH v4 1/3] dt-bindings: memory: mediatek: Convert SMI to DT

[Yong Wu <yong.wu@mediatek.com>]

On Sat, 2020-10-31 at 12:36 +0100, Krzysztof Kozlowski wrote:
> On Fri, Oct 30, 2020 at 05:12:52PM +0800, Yong Wu wrote:
> > Convert MediaTek SMI to DT schema.
> > 
> > CC: Fabien Parent <fparent@baylibre.com>
> > CC: Ming-Fan Chen <ming-fan.chen@mediatek.com>
> > CC: Matthias Brugger <matthias.bgg@gmail.com>
> > Signed-off-by: Yong Wu <yong.wu@mediatek.com>
> > ---
> >  .../mediatek,smi-common.txt                   |  50 -------
> >  .../mediatek,smi-common.yaml                  | 140 ++++++++++++++++++
> >  .../memory-controllers/mediatek,smi-larb.txt  |  50 -------
> >  .../memory-controllers/mediatek,smi-larb.yaml | 129 ++++++++++++++++
> >  4 files changed, 269 insertions(+), 100 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.txt
> 
> +Cc Honghui Zhang,

As comment [1], Honghui's address is not valid now. I will act for him.

> 
> Your Ack is needed as you contributed descriptions to the bindings and
> work is being relicensed to GPL-2.0-only OR BSD-2-Clause.

"GPL-2.0-only OR BSD-2-Clause" is required when we run check-patch.

If I still use "GPL-2.0-only", then the contributors' Ack/SoB is not
needed, right?

[1]
https://lore.kernel.org/linux-iommu/1604051256.26323.100.camel@mhfsdcap03/T/#u

> 
> 
> Best regards,
> Krzysztof
> 
> 
> 
> 
> >  create mode 100644 Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.yaml
> >  delete mode 100644 Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.txt
> >  create mode 100644 Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.txt b/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.txt
> > deleted file mode 100644
> > index dbafffe3f41e..000000000000
> > --- a/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.txt
> > +++ /dev/null
> > @@ -1,50 +0,0 @@
> > -SMI (Smart Multimedia Interface) Common
> > -
> > -The hardware block diagram please check bindings/iommu/mediatek,iommu.txt
> > -
> > -Mediatek SMI have two generations of HW architecture, here is the list
> > -which generation the SoCs use:
> > -generation 1: mt2701 and mt7623.
> > -generation 2: mt2712, mt6779, mt8167, mt8173 and mt8183.
> > -
> > -There's slight differences between the two SMI, for generation 2, the
> > -register which control the iommu port is at each larb's register base. But
> > -for generation 1, the register is at smi ao base(smi always on register
> > -base). Besides that, the smi async clock should be prepared and enabled for
> > -SMI generation 1 to transform the smi clock into emi clock domain, but that is
> > -not needed for SMI generation 2.
> > -
> > -Required properties:
> > -- compatible : must be one of :
> > -	"mediatek,mt2701-smi-common"
> > -	"mediatek,mt2712-smi-common"
> > -	"mediatek,mt6779-smi-common"
> > -	"mediatek,mt7623-smi-common", "mediatek,mt2701-smi-common"
> > -	"mediatek,mt8167-smi-common"
> > -	"mediatek,mt8173-smi-common"
> > -	"mediatek,mt8183-smi-common"
> > -- reg : the register and size of the SMI block.
> > -- power-domains : a phandle to the power domain of this local arbiter.
> > -- clocks : Must contain an entry for each entry in clock-names.
> > -- clock-names : must contain 3 entries for generation 1 smi HW and 2 entries
> > -  for generation 2 smi HW as follows:
> > -  - "apb" : Advanced Peripheral Bus clock, It's the clock for setting
> > -	    the register.
> > -  - "smi" : It's the clock for transfer data and command.
> > -	    They may be the same if both source clocks are the same.
> > -  - "async" : asynchronous clock, it help transform the smi clock into the emi
> > -	      clock domain, this clock is only needed by generation 1 smi HW.
> > -  and these 2 option clocks for generation 2 smi HW:
> > -  - "gals0": the path0 clock of GALS(Global Async Local Sync).
> > -  - "gals1": the path1 clock of GALS(Global Async Local Sync).
> > -  Here is the list which has this GALS: mt6779 and mt8183.
> > -
> > -Example:
> > -	smi_common: smi@14022000 {
> > -		compatible = "mediatek,mt8173-smi-common";
> > -		reg = <0 0x14022000 0 0x1000>;
> > -		power-domains = <&scpsys MT8173_POWER_DOMAIN_MM>;
> > -		clocks = <&mmsys CLK_MM_SMI_COMMON>,
> > -			 <&mmsys CLK_MM_SMI_COMMON>;
> > -		clock-names = "apb", "smi";
> > -	};
> > diff --git a/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.yaml b/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.yaml
> > new file mode 100644
> > index 000000000000..e050a0c2aed6
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.yaml
> > @@ -0,0 +1,140 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +# Copyright (c) 2020 MediaTek Inc.
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/memory-controllers/mediatek,smi-common.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: SMI (Smart Multimedia Interface) Common
> > +
> > +maintainers:
> > +  - Yong Wu <yong.wu@mediatek.com>
> > +
> > +description: |+
> > +  The hardware block diagram please check bindings/iommu/mediatek,iommu.yaml
> > +
> > +  MediaTek SMI have two generations of HW architecture, here is the list
> > +  which generation the SoCs use:
> > +  generation 1: mt2701 and mt7623.
> > +  generation 2: mt2712, mt6779, mt8167, mt8173 and mt8183.
> > +
> > +  There's slight differences between the two SMI, for generation 2, the
> > +  register which control the iommu port is at each larb's register base. But
> > +  for generation 1, the register is at smi ao base(smi always on register
> > +  base). Besides that, the smi async clock should be prepared and enabled for
> > +  SMI generation 1 to transform the smi clock into emi clock domain, but that is
> > +  not needed for SMI generation 2.
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - enum:
> > +          - mediatek,mt2701-smi-common
> > +          - mediatek,mt2712-smi-common
> > +          - mediatek,mt6779-smi-common
> > +          - mediatek,mt8167-smi-common
> > +          - mediatek,mt8173-smi-common
> > +          - mediatek,mt8183-smi-common
> > +
> > +      - description: for mt7623
> > +        items:
> > +          - const: mediatek,mt7623-smi-common
> > +          - const: mediatek,mt2701-smi-common
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  power-domains:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    description: |
> > +      apb and smi are mandatory. the async is only for generation 1 smi HW.
> > +      gals(global async local sync) also is optional, see below.
> > +    minItems: 2
> > +    maxItems: 4
> > +    items:
> > +      - description: apb is Advanced Peripheral Bus clock, It's the clock for
> > +          setting the register.
> > +      - description: smi is the clock for transfer data and command.
> > +      - description: async is asynchronous clock, it help transform the smi clock
> > +          into the emi clock domain.
> > +      - description: gals0 is the path0 clock of gals.
> > +      - description: gals1 is the path1 clock of gals.
> > +
> > +  clock-names:
> > +    minItems: 2
> > +    maxItems: 4
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - power-domains
> > +  - clocks
> > +  - clock-names
> > +
> > +allOf:
> > +  - if: #only for gen1 HW
> > +      properties:
> > +        compatible:
> > +          contains:
> > +            enum:
> > +              - mediatek,mt2701-smi-common
> > +    then:
> > +       properties:
> > +         clock:
> > +           items:
> > +             minItems: 3
> > +             maxItems: 3
> > +         clock-names:
> > +           items:
> > +             - const: apb
> > +             - const: smi
> > +             - const: async
> > +
> > +  - if: #for gen2 HW that have gals
> > +      properties:
> > +        compatible:
> > +            enum:
> > +              - mediatek,mt6779-smi-common
> > +              - mediatek,mt8183-smi-common
> > +
> > +    then:
> > +      properties:
> > +        clock:
> > +          items:
> > +            minItems: 4
> > +            maxItems: 4
> > +        clock-names:
> > +          items:
> > +            - const: apb
> > +            - const: smi
> > +            - const: gals0
> > +            - const: gals1
> > +
> > +    else: #for gen2 HW that don't have gals
> > +      properties:
> > +        clock:
> > +          items:
> > +            minItems: 2
> > +            maxItems: 2
> > +        clock-names:
> > +          items:
> > +            - const: apb
> > +            - const: smi
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/clock/mt8173-clk.h>
> > +    #include <dt-bindings/power/mt8173-power.h>
> > +
> > +    smi_common: smi@14022000 {
> > +            compatible = "mediatek,mt8173-smi-common";
> > +            reg = <0x14022000 0x1000>;
> > +            power-domains = <&scpsys MT8173_POWER_DOMAIN_MM>;
> > +            clocks = <&mmsys CLK_MM_SMI_COMMON>,
> > +                     <&mmsys CLK_MM_SMI_COMMON>;
> > +            clock-names = "apb", "smi";
> > +    };
> > diff --git a/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.txt b/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.txt
> > deleted file mode 100644
> > index 0c5de12b5496..000000000000
> > --- a/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.txt
> > +++ /dev/null
> > @@ -1,50 +0,0 @@
> > -SMI (Smart Multimedia Interface) Local Arbiter
> > -
> > -The hardware block diagram please check bindings/iommu/mediatek,iommu.txt
> > -
> > -Required properties:
> > -- compatible : must be one of :
> > -		"mediatek,mt2701-smi-larb"
> > -		"mediatek,mt2712-smi-larb"
> > -		"mediatek,mt6779-smi-larb"
> > -		"mediatek,mt7623-smi-larb", "mediatek,mt2701-smi-larb"
> > -		"mediatek,mt8167-smi-larb"
> > -		"mediatek,mt8173-smi-larb"
> > -		"mediatek,mt8183-smi-larb"
> > -- reg : the register and size of this local arbiter.
> > -- mediatek,smi : a phandle to the smi_common node.
> > -- power-domains : a phandle to the power domain of this local arbiter.
> > -- clocks : Must contain an entry for each entry in clock-names.
> > -- clock-names: must contain 2 entries, as follows:
> > -  - "apb" : Advanced Peripheral Bus clock, It's the clock for setting
> > -	    the register.
> > -  - "smi" : It's the clock for transfer data and command.
> > -  and this optional clock name:
> > -  - "gals": the clock for GALS(Global Async Local Sync).
> > -  Here is the list which has this GALS: mt8183.
> > -
> > -Required property for mt2701, mt2712, mt6779, mt7623 and mt8167:
> > -- mediatek,larb-id :the hardware id of this larb.
> > -
> > -Example:
> > -	larb1: larb@16010000 {
> > -		compatible = "mediatek,mt8173-smi-larb";
> > -		reg = <0 0x16010000 0 0x1000>;
> > -		mediatek,smi = <&smi_common>;
> > -		power-domains = <&scpsys MT8173_POWER_DOMAIN_VDEC>;
> > -		clocks = <&vdecsys CLK_VDEC_CKEN>,
> > -			 <&vdecsys CLK_VDEC_LARB_CKEN>;
> > -		clock-names = "apb", "smi";
> > -	};
> > -
> > -Example for mt2701:
> > -	larb0: larb@14010000 {
> > -		compatible = "mediatek,mt2701-smi-larb";
> > -		reg = <0 0x14010000 0 0x1000>;
> > -		mediatek,smi = <&smi_common>;
> > -		mediatek,larb-id = <0>;
> > -		clocks = <&mmsys CLK_MM_SMI_LARB0>,
> > -			 <&mmsys CLK_MM_SMI_LARB0>;
> > -		clock-names = "apb", "smi";
> > -		power-domains = <&scpsys MT2701_POWER_DOMAIN_DISP>;
> > -	};
> > diff --git a/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.yaml b/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.yaml
> > new file mode 100644
> > index 000000000000..a11a105e872f
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.yaml
> > @@ -0,0 +1,129 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +# Copyright (c) 2020 MediaTek Inc.
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/memory-controllers/mediatek,smi-larb.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: SMI (Smart Multimedia Interface) Local Arbiter
> > +
> > +maintainers:
> > +  - Yong Wu <yong.wu@mediatek.com>
> > +
> > +description: |+
> > +  The hardware block diagram please check bindings/iommu/mediatek,iommu.yaml
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - enum:
> > +          - mediatek,mt2701-smi-larb
> > +          - mediatek,mt2712-smi-larb
> > +          - mediatek,mt6779-smi-larb
> > +          - mediatek,mt8167-smi-larb
> > +          - mediatek,mt8173-smi-larb
> > +          - mediatek,mt8183-smi-larb
> > +
> > +      - description: for mt7623
> > +        items:
> > +          - const: mediatek,mt7623-smi-larb
> > +          - const: mediatek,mt2701-smi-larb
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    description: |
> > +      apb and smi are mandatory. gals(global async local sync) is optional.
> > +    minItems: 2
> > +    maxItems: 3
> > +    items:
> > +       - description: apb is Advanced Peripheral Bus clock, It's the clock for
> > +           setting the register.
> > +       - description: smi is the clock for transfer data and command.
> > +       - description: the clock for gals.
> > +
> > +  clock-names:
> > +    minItems: 2
> > +    maxItems: 3
> > +
> > +  power-domains:
> > +    maxItems: 1
> > +
> > +  mediatek,smi:
> > +    $ref: /schemas/types.yaml#/definitions/phandle-array
> > +    description: a phandle to the smi_common node.
> > +
> > +  mediatek,larb-id:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    minimum: 0
> > +    maximum: 31
> > +    description: the hardware id of this larb.
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - clocks
> > +  - clock-names
> > +  - power-domains
> > +
> > +allOf:
> > +  - if: # HW has gals
> > +      properties:
> > +        compatible:
> > +          enum:
> > +            - mediatek,mt8183-smi-larb
> > +
> > +    then:
> > +      properties:
> > +        clock:
> > +          items:
> > +            minItems: 3
> > +            maxItems: 3
> > +        clock-names:
> > +          items:
> > +            - const: apb
> > +            - const: smi
> > +            - const: gals
> > +
> > +    else:
> > +      properties:
> > +        clock:
> > +          items:
> > +            minItems: 2
> > +            maxItems: 2
> > +        clock-names:
> > +          items:
> > +            - const: apb
> > +            - const: smi
> > +
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          contains:
> > +            enum:
> > +              - mediatek,mt2701-smi-larb
> > +              - mediatek,mt2712-smi-larb
> > +              - mediatek,mt6779-smi-larb
> > +              - mediatek,mt8167-smi-larb
> > +
> > +    then:
> > +      required:
> > +        - mediatek,larb-id
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/clock/mt8173-clk.h>
> > +    #include <dt-bindings/power/mt8173-power.h>
> > +
> > +    larb1: larb@16010000 {
> > +      compatible = "mediatek,mt8173-smi-larb";
> > +      reg = <0x16010000 0x1000>;
> > +      mediatek,smi = <&smi_common>;
> > +      power-domains = <&scpsys MT8173_POWER_DOMAIN_VDEC>;
> > +      clocks = <&vdecsys CLK_VDEC_CKEN>,
> > +               <&vdecsys CLK_VDEC_LARB_CKEN>;
> > +      clock-names = "apb", "smi";
> > +    };
> > -- 
> > 2.18.0
> 
> _______________________________________________
> Linux-mediatek mailing list
> Linux-mediatek@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-mediatek