From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 10DF1C3DA7A for ; Wed, 28 Dec 2022 10:40:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229997AbiL1Kk2 (ORCPT ); Wed, 28 Dec 2022 05:40:28 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41860 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229632AbiL1Kk1 (ORCPT ); Wed, 28 Dec 2022 05:40:27 -0500 Received: from fd01.gateway.ufhost.com (fd01.gateway.ufhost.com [61.152.239.71]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 60EEBCEB; Wed, 28 Dec 2022 02:40:22 -0800 (PST) Received: from EXMBX166.cuchost.com (unknown [175.102.18.54]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client CN "EXMBX166", Issuer "EXMBX166" (not verified)) by fd01.gateway.ufhost.com (Postfix) with ESMTP id 66CF424E102; Wed, 28 Dec 2022 18:40:19 +0800 (CST) Received: from EXMBX168.cuchost.com (172.16.6.78) by EXMBX166.cuchost.com (172.16.6.76) with Microsoft SMTP Server (TLS) id 15.0.1497.42; Wed, 28 Dec 2022 18:40:19 +0800 Received: from [192.168.120.55] (171.223.208.138) by EXMBX168.cuchost.com (172.16.6.78) with Microsoft SMTP Server (TLS) id 15.0.1497.42; Wed, 28 Dec 2022 18:40:18 +0800 Message-ID: <4cb26636-8f65-b801-9374-e8b7e9fff2fe@starfivetech.com> Date: Wed, 28 Dec 2022 18:40:18 +0800 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Thunderbird/102.6.1 Subject: Re: [PATCH v2 1/3] dt-bindings: mmc: Add bindings for StarFive To: Krzysztof Kozlowski , , , CC: Rob Herring , Krzysztof Kozlowski , Jaehoon Chung , Ulf Hansson , References: <20221227122227.460921-1-william.qiu@starfivetech.com> <20221227122227.460921-2-william.qiu@starfivetech.com> Content-Language: en-US From: William Qiu In-Reply-To: Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 7bit X-Originating-IP: [171.223.208.138] X-ClientProxiedBy: EXCAS064.cuchost.com (172.16.6.24) To EXMBX168.cuchost.com (172.16.6.78) X-YovoleRuleAgent: yovoleflag Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org On 2022/12/27 21:05, Krzysztof Kozlowski wrote: > On 27/12/2022 13:22, William Qiu wrote: >> Add documentation to describe StarFive >> designware mobile storage host controller driver. > > Please wrap commit message according to Linux coding style / submission > process (neither too early nor over the limit): > https://elixir.bootlin.com/linux/v5.18-rc4/source/Documentation/process/submitting-patches.rst#L586 > > The subject is a bit redundant and not precise. No need to mention > "bindings" twice but "StarFive" is really too generic. Do you add now > all possible devices from StarFive? I see only one. Rephrase (use git > log to find examples). > Will update >> >> Signed-off-by: William Qiu >> --- >> .../bindings/mmc/starfive,jh7110-mmc.yaml | 72 +++++++++++++++++++ >> 1 file changed, 72 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..430dd5f24933 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/mmc/starfive,jh7110-mmc.yaml >> @@ -0,0 +1,72 @@ >> +# 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 >> + >> +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,syscon: > > Name is not specific enough. What is syscon? Any syscon? This needs to > be specific. > Will update. >> + $ref: /schemas/types.yaml#/definitions/phandle-array >> + description: >> + arg0:arg0 is syscon. > > What is syscon? > Will update. >> + arg1:arg1 is syscon register offset, used to enable MMC function. > > Describe the argument, not what it is used for, e.g. "offset of XXX YYY ZZZ" > >> + arg2:arg2 is used to enable the register shift of the MMC function. >> + arg3:arg3 is used to enable the register mask of the MMC function. > > That's not how the phandle array is described. Instead: > > https://elixir.bootlin.com/linux/v5.18-rc1/source/Documentation/devicetree/bindings/soc/samsung/exynos-usi.yaml#L42 > Hi Krzysztof, Thank you for taking time to review and provide helpful comments for this patch. I will fix all the above issues in the next version. Best Regards, William Qiu > > > Best regards, > Krzysztof >