[v4,1/4] dt-bindings: mmc: Add StarFive MMC module

  Add documentation to describe StarFive designware mobile storage
host controller driver.

Signed-off-by: William Qiu <william.qiu@starfivetech.com>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
---
 .../bindings/mmc/starfive,jh7110-mmc.yaml     | 77 +++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
  

Hello William,

Are you sure changing driver is better than changing yaml bindings? All

previous version sent was syscon and sysreg seems not consistent with

other codes.

Best regards,

Shengyu

> Add documentation to describe StarFive designware mobile storage
> host controller driver.
>
> Signed-off-by: William Qiu <william.qiu@starfivetech.com>
> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> ---
>   .../bindings/mmc/starfive,jh7110-mmc.yaml     | 77 +++++++++++++++++++
>   1 file changed, 77 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>
> diff --git a/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
> new file mode 100644
> index 000000000000..51e1b04e799f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
> @@ -0,0 +1,77 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mmc/starfive,jh7110-mmc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: StarFive Designware Mobile Storage Host Controller
> +
> +description:
> +  StarFive uses the Synopsys designware mobile storage host controller
> +  to interface a SoC with storage medium such as eMMC or SD/MMC cards.
> +
> +allOf:
> +  - $ref: synopsys-dw-mshc-common.yaml#
> +
> +maintainers:
> +  - William Qiu <william.qiu@starfivetech.com>
> +
> +properties:
> +  compatible:
> +    const: starfive,jh7110-mmc
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    items:
> +      - description: biu clock
> +      - description: ciu clock
> +
> +  clock-names:
> +    items:
> +      - const: biu
> +      - const: ciu
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  starfive,sysreg:
> +    $ref: /schemas/types.yaml#/definitions/phandle-array
> +    items:
> +      - items:
> +          - description: phandle to System Register Controller syscon node
> +          - description: offset of SYS_SYSCONSAIF__SYSCFG register for MMC controller
> +          - description: shift of SYS_SYSCONSAIF__SYSCFG register for MMC controller
> +          - description: mask of SYS_SYSCONSAIF__SYSCFG register for MMC controller
> +    description:
> +      Should be four parameters, the phandle to System Register Controller
> +      syscon node and the offset/shift/mask of SYS_SYSCONSAIF__SYSCFG register
> +      for MMC controller.
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - clock-names
> +  - interrupts
> +  - starfive,sysreg
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    mmc@16010000 {
> +        compatible = "starfive,jh7110-mmc";
> +        reg = <0x16010000 0x10000>;
> +        clocks = <&syscrg 91>,
> +                 <&syscrg 93>;
> +        clock-names = "biu","ciu";
> +        resets = <&syscrg 64>;
> +        reset-names = "reset";
> +        interrupts = <74>;
> +        fifo-depth = <32>;
> +        fifo-watermark-aligned;
> +        data-addr = <0>;
> +        starfive,sysreg = <&sys_syscon 0x14 0x1a 0x7c000000>;
> +    };
  

Sorry, forgot what I said. I didn't see Krzysztof's reply on V3 serires.

Best regards,

Shengyu

> Hello William,
>
> Are you sure changing driver is better than changing yaml bindings? All
>
> previous version sent was syscon and sysreg seems not consistent with
>
> other codes.
>
> Best regards,
>
> Shengyu
>
>> Add documentation to describe StarFive designware mobile storage
>> host controller driver.
>>
>> Signed-off-by: William Qiu <william.qiu@starfivetech.com>
>> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>> ---
>>   .../bindings/mmc/starfive,jh7110-mmc.yaml     | 77 +++++++++++++++++++
>>   1 file changed, 77 insertions(+)
>>   create mode 100644 
>> Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>>
>> diff --git 
>> a/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml 
>> b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>> new file mode 100644
>> index 000000000000..51e1b04e799f
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>> @@ -0,0 +1,77 @@
>> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/mmc/starfive,jh7110-mmc.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: StarFive Designware Mobile Storage Host Controller
>> +
>> +description:
>> +  StarFive uses the Synopsys designware mobile storage host controller
>> +  to interface a SoC with storage medium such as eMMC or SD/MMC cards.
>> +
>> +allOf:
>> +  - $ref: synopsys-dw-mshc-common.yaml#
>> +
>> +maintainers:
>> +  - William Qiu <william.qiu@starfivetech.com>
>> +
>> +properties:
>> +  compatible:
>> +    const: starfive,jh7110-mmc
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  clocks:
>> +    items:
>> +      - description: biu clock
>> +      - description: ciu clock
>> +
>> +  clock-names:
>> +    items:
>> +      - const: biu
>> +      - const: ciu
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  starfive,sysreg:
>> +    $ref: /schemas/types.yaml#/definitions/phandle-array
>> +    items:
>> +      - items:
>> +          - description: phandle to System Register Controller 
>> syscon node
>> +          - description: offset of SYS_SYSCONSAIF__SYSCFG register 
>> for MMC controller
>> +          - description: shift of SYS_SYSCONSAIF__SYSCFG register 
>> for MMC controller
>> +          - description: mask of SYS_SYSCONSAIF__SYSCFG register for 
>> MMC controller
>> +    description:
>> +      Should be four parameters, the phandle to System Register 
>> Controller
>> +      syscon node and the offset/shift/mask of 
>> SYS_SYSCONSAIF__SYSCFG register
>> +      for MMC controller.
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - clocks
>> +  - clock-names
>> +  - interrupts
>> +  - starfive,sysreg
>> +
>> +unevaluatedProperties: false
>> +
>> +examples:
>> +  - |
>> +    mmc@16010000 {
>> +        compatible = "starfive,jh7110-mmc";
>> +        reg = <0x16010000 0x10000>;
>> +        clocks = <&syscrg 91>,
>> +                 <&syscrg 93>;
>> +        clock-names = "biu","ciu";
>> +        resets = <&syscrg 64>;
>> +        reset-names = "reset";
>> +        interrupts = <74>;
>> +        fifo-depth = <32>;
>> +        fifo-watermark-aligned;
>> +        data-addr = <0>;
>> +        starfive,sysreg = <&sys_syscon 0x14 0x1a 0x7c000000>;
>> +    };
  

On 2023/2/15 19:59, Shengyu Qu wrote:
> Hello William,
> 
> Are you sure changing driver is better than changing yaml bindings? All
> 
> previous version sent was syscon and sysreg seems not consistent with
> 
> other codes.
> 
> Best regards,
> 
> Shengyu
>

Hi Shengyu,

After discussing with colleagues, we decided to restore the lable name to 
sys_syscon, and sysreg was just a unique name for the functionality of MMC,
which will be used in all future versions.

Thanks for taking time reviewing this patch series.

Best Regards
William

>> Add documentation to describe StarFive designware mobile storage
>> host controller driver.
>>
>> Signed-off-by: William Qiu <william.qiu@starfivetech.com>
>> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>> ---
>>   .../bindings/mmc/starfive,jh7110-mmc.yaml     | 77 +++++++++++++++++++
>>   1 file changed, 77 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>> new file mode 100644
>> index 000000000000..51e1b04e799f
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>> @@ -0,0 +1,77 @@
>> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/mmc/starfive,jh7110-mmc.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: StarFive Designware Mobile Storage Host Controller
>> +
>> +description:
>> +  StarFive uses the Synopsys designware mobile storage host controller
>> +  to interface a SoC with storage medium such as eMMC or SD/MMC cards.
>> +
>> +allOf:
>> +  - $ref: synopsys-dw-mshc-common.yaml#
>> +
>> +maintainers:
>> +  - William Qiu <william.qiu@starfivetech.com>
>> +
>> +properties:
>> +  compatible:
>> +    const: starfive,jh7110-mmc
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  clocks:
>> +    items:
>> +      - description: biu clock
>> +      - description: ciu clock
>> +
>> +  clock-names:
>> +    items:
>> +      - const: biu
>> +      - const: ciu
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  starfive,sysreg:
>> +    $ref: /schemas/types.yaml#/definitions/phandle-array
>> +    items:
>> +      - items:
>> +          - description: phandle to System Register Controller syscon node
>> +          - description: offset of SYS_SYSCONSAIF__SYSCFG register for MMC controller
>> +          - description: shift of SYS_SYSCONSAIF__SYSCFG register for MMC controller
>> +          - description: mask of SYS_SYSCONSAIF__SYSCFG register for MMC controller
>> +    description:
>> +      Should be four parameters, the phandle to System Register Controller
>> +      syscon node and the offset/shift/mask of SYS_SYSCONSAIF__SYSCFG register
>> +      for MMC controller.
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - clocks
>> +  - clock-names
>> +  - interrupts
>> +  - starfive,sysreg
>> +
>> +unevaluatedProperties: false
>> +
>> +examples:
>> +  - |
>> +    mmc@16010000 {
>> +        compatible = "starfive,jh7110-mmc";
>> +        reg = <0x16010000 0x10000>;
>> +        clocks = <&syscrg 91>,
>> +                 <&syscrg 93>;
>> +        clock-names = "biu","ciu";
>> +        resets = <&syscrg 64>;
>> +        reset-names = "reset";
>> +        interrupts = <74>;
>> +        fifo-depth = <32>;
>> +        fifo-watermark-aligned;
>> +        data-addr = <0>;
>> +        starfive,sysreg = <&sys_syscon 0x14 0x1a 0x7c000000>;
>> +    };
  

Hello William,

Thanks for your reply. So there's v5 series? Btw, please fix maintainer 
information:

https://patchwork.kernel.org/project/linux-riscv/patch/20230215080203.27445-1-lukas.bulwahn@gmail.com/

Best regards,

Shengyu

>
> On 2023/2/15 19:59, Shengyu Qu wrote:
>> Hello William,
>>
>> Are you sure changing driver is better than changing yaml bindings? All
>>
>> previous version sent was syscon and sysreg seems not consistent with
>>
>> other codes.
>>
>> Best regards,
>>
>> Shengyu
>>
> Hi Shengyu,
>
> After discussing with colleagues, we decided to restore the lable name to
> sys_syscon, and sysreg was just a unique name for the functionality of MMC,
> which will be used in all future versions.
>
> Thanks for taking time reviewing this patch series.
>
> Best Regards
> William
>
>>> Add documentation to describe StarFive designware mobile storage
>>> host controller driver.
>>>
>>> Signed-off-by: William Qiu <william.qiu@starfivetech.com>
>>> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>>> ---
>>>    .../bindings/mmc/starfive,jh7110-mmc.yaml     | 77 +++++++++++++++++++
>>>    1 file changed, 77 insertions(+)
>>>    create mode 100644 Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>>>
>>> diff --git a/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>>> new file mode 100644
>>> index 000000000000..51e1b04e799f
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>>> @@ -0,0 +1,77 @@
>>> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
>>> +%YAML 1.2
>>> +---
>>> +$id: http://devicetree.org/schemas/mmc/starfive,jh7110-mmc.yaml#
>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>> +
>>> +title: StarFive Designware Mobile Storage Host Controller
>>> +
>>> +description:
>>> +  StarFive uses the Synopsys designware mobile storage host controller
>>> +  to interface a SoC with storage medium such as eMMC or SD/MMC cards.
>>> +
>>> +allOf:
>>> +  - $ref: synopsys-dw-mshc-common.yaml#
>>> +
>>> +maintainers:
>>> +  - William Qiu <william.qiu@starfivetech.com>
>>> +
>>> +properties:
>>> +  compatible:
>>> +    const: starfive,jh7110-mmc
>>> +
>>> +  reg:
>>> +    maxItems: 1
>>> +
>>> +  clocks:
>>> +    items:
>>> +      - description: biu clock
>>> +      - description: ciu clock
>>> +
>>> +  clock-names:
>>> +    items:
>>> +      - const: biu
>>> +      - const: ciu
>>> +
>>> +  interrupts:
>>> +    maxItems: 1
>>> +
>>> +  starfive,sysreg:
>>> +    $ref: /schemas/types.yaml#/definitions/phandle-array
>>> +    items:
>>> +      - items:
>>> +          - description: phandle to System Register Controller syscon node
>>> +          - description: offset of SYS_SYSCONSAIF__SYSCFG register for MMC controller
>>> +          - description: shift of SYS_SYSCONSAIF__SYSCFG register for MMC controller
>>> +          - description: mask of SYS_SYSCONSAIF__SYSCFG register for MMC controller
>>> +    description:
>>> +      Should be four parameters, the phandle to System Register Controller
>>> +      syscon node and the offset/shift/mask of SYS_SYSCONSAIF__SYSCFG register
>>> +      for MMC controller.
>>> +
>>> +required:
>>> +  - compatible
>>> +  - reg
>>> +  - clocks
>>> +  - clock-names
>>> +  - interrupts
>>> +  - starfive,sysreg
>>> +
>>> +unevaluatedProperties: false
>>> +
>>> +examples:
>>> +  - |
>>> +    mmc@16010000 {
>>> +        compatible = "starfive,jh7110-mmc";
>>> +        reg = <0x16010000 0x10000>;
>>> +        clocks = <&syscrg 91>,
>>> +                 <&syscrg 93>;
>>> +        clock-names = "biu","ciu";
>>> +        resets = <&syscrg 64>;
>>> +        reset-names = "reset";
>>> +        interrupts = <74>;
>>> +        fifo-depth = <32>;
>>> +        fifo-watermark-aligned;
>>> +        data-addr = <0>;
>>> +        starfive,sysreg = <&sys_syscon 0x14 0x1a 0x7c000000>;
>>> +    };
  

On 2023/2/16 0:49, Shengyu Qu wrote:
> Hello William,
> 
> Thanks for your reply. So there's v5 series? Btw, please fix maintainer information:
> 
> https://patchwork.kernel.org/project/linux-riscv/patch/20230215080203.27445-1-lukas.bulwahn@gmail.com/
> 
> Best regards,
> 
> Shengyu
> 
Hi Shengyu,

Here is v4 series, and I fixed the maintainer information in this series which
Uffe would merge in his next branch.
Thanks for taking time to review this patch series.

Best Regards
William
>>
>> On 2023/2/15 19:59, Shengyu Qu wrote:
>>> Hello William,
>>>
>>> Are you sure changing driver is better than changing yaml bindings? All
>>>
>>> previous version sent was syscon and sysreg seems not consistent with
>>>
>>> other codes.
>>>
>>> Best regards,
>>>
>>> Shengyu
>>>
>> Hi Shengyu,
>>
>> After discussing with colleagues, we decided to restore the lable name to
>> sys_syscon, and sysreg was just a unique name for the functionality of MMC,
>> which will be used in all future versions.
>>
>> Thanks for taking time reviewing this patch series.
>>
>> Best Regards
>> William
>>
>>>> Add documentation to describe StarFive designware mobile storage
>>>> host controller driver.
>>>>
>>>> Signed-off-by: William Qiu <william.qiu@starfivetech.com>
>>>> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>>>> ---
>>>>    .../bindings/mmc/starfive,jh7110-mmc.yaml     | 77 +++++++++++++++++++
>>>>    1 file changed, 77 insertions(+)
>>>>    create mode 100644 Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>>>> new file mode 100644
>>>> index 000000000000..51e1b04e799f
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml
>>>> @@ -0,0 +1,77 @@
>>>> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
>>>> +%YAML 1.2
>>>> +---
>>>> +$id: http://devicetree.org/schemas/mmc/starfive,jh7110-mmc.yaml#
>>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>>> +
>>>> +title: StarFive Designware Mobile Storage Host Controller
>>>> +
>>>> +description:
>>>> +  StarFive uses the Synopsys designware mobile storage host controller
>>>> +  to interface a SoC with storage medium such as eMMC or SD/MMC cards.
>>>> +
>>>> +allOf:
>>>> +  - $ref: synopsys-dw-mshc-common.yaml#
>>>> +
>>>> +maintainers:
>>>> +  - William Qiu <william.qiu@starfivetech.com>
>>>> +
>>>> +properties:
>>>> +  compatible:
>>>> +    const: starfive,jh7110-mmc
>>>> +
>>>> +  reg:
>>>> +    maxItems: 1
>>>> +
>>>> +  clocks:
>>>> +    items:
>>>> +      - description: biu clock
>>>> +      - description: ciu clock
>>>> +
>>>> +  clock-names:
>>>> +    items:
>>>> +      - const: biu
>>>> +      - const: ciu
>>>> +
>>>> +  interrupts:
>>>> +    maxItems: 1
>>>> +
>>>> +  starfive,sysreg:
>>>> +    $ref: /schemas/types.yaml#/definitions/phandle-array
>>>> +    items:
>>>> +      - items:
>>>> +          - description: phandle to System Register Controller syscon node
>>>> +          - description: offset of SYS_SYSCONSAIF__SYSCFG register for MMC controller
>>>> +          - description: shift of SYS_SYSCONSAIF__SYSCFG register for MMC controller
>>>> +          - description: mask of SYS_SYSCONSAIF__SYSCFG register for MMC controller
>>>> +    description:
>>>> +      Should be four parameters, the phandle to System Register Controller
>>>> +      syscon node and the offset/shift/mask of SYS_SYSCONSAIF__SYSCFG register
>>>> +      for MMC controller.
>>>> +
>>>> +required:
>>>> +  - compatible
>>>> +  - reg
>>>> +  - clocks
>>>> +  - clock-names
>>>> +  - interrupts
>>>> +  - starfive,sysreg
>>>> +
>>>> +unevaluatedProperties: false
>>>> +
>>>> +examples:
>>>> +  - |
>>>> +    mmc@16010000 {
>>>> +        compatible = "starfive,jh7110-mmc";
>>>> +        reg = <0x16010000 0x10000>;
>>>> +        clocks = <&syscrg 91>,
>>>> +                 <&syscrg 93>;
>>>> +        clock-names = "biu","ciu";
>>>> +        resets = <&syscrg 64>;
>>>> +        reset-names = "reset";
>>>> +        interrupts = <74>;
>>>> +        fifo-depth = <32>;
>>>> +        fifo-watermark-aligned;
>>>> +        data-addr = <0>;
>>>> +        starfive,sysreg = <&sys_syscon 0x14 0x1a 0x7c000000>;
>>>> +    };
  

On 15/02/2023 12:59, Shengyu Qu wrote:
> Hello William,
> 
> Are you sure changing driver is better than changing yaml bindings? All

What do you mean - changing driver? This is new driver, new code, isn't it?



Best regards,
Krzysztof
  

On Thu, Feb 16, 2023 at 11:21:16AM +0100, Krzysztof Kozlowski wrote:
> On 15/02/2023 12:59, Shengyu Qu wrote:
> > Hello William,
> > 
> > Are you sure changing driver is better than changing yaml bindings? All
> 
> What do you mean - changing driver? This is new driver, new code, isn't it?

Changing w.r.t. the v3 that was applied I suppose.
The v3 was dropped and patches 1 & 2 here have been applied instead, so
this request from Shengyu is moot now anyway.

Cheers,
Conor.
  

> On Thu, Feb 16, 2023 at 11:21:16AM +0100, Krzysztof Kozlowski wrote:
>> On 15/02/2023 12:59, Shengyu Qu wrote:
>>> Hello William,
>>>
>>> Are you sure changing driver is better than changing yaml bindings? All
>> What do you mean - changing driver? This is new driver, new code, isn't it?
> Changing w.r.t. the v3 that was applied I suppose.
> The v3 was dropped and patches 1 & 2 here have been applied instead, so
> this request from Shengyu is moot now anyway.
>
> Cheers,
> Conor.

That's my mistake. I misunderstood current situation :(

Best regards,

Shengyu