Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <9303ad19-b047-9710-8c35-9911e9a47bc9@linaro.org>
Date:   Mon, 4 Jul 2022 12:03:08 +0200
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.10.0
Subject: Re: [PATCH] dt-bindings: qcom: readme: document preferred compatible
 naming
Content-Language: en-US
To:     Rob Herring <robh@kernel.org>
Cc:     Andy Gross <agross@kernel.org>,
        Bjorn Andersson <bjorn.andersson@linaro.org>,
        Konrad Dybcio <konrad.dybcio@somainline.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        linux-arm-msm@vger.kernel.org, devicetree@vger.kernel.org,
        linux-kernel@vger.kernel.org,
        Srinivas Kandagatla <srinivas.kandagatla@linaro.org>,
        Dmitry Baryshkov <dmitry.baryshkov@linaro.org>,
        Vinod Koul <vkoul@kernel.org>, Alex Elder <elder@linaro.org>,
        Robert Foss <robert.foss@linaro.org>,
        Bhupesh Sharma <bhupesh.sharma@linaro.org>
References: <20220701074659.12680-1-krzysztof.kozlowski@linaro.org>
 <20220701204218.GA1478943-robh@kernel.org>
From:   Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
In-Reply-To: <20220701204218.GA1478943-robh@kernel.org>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 01/07/2022 22:42, Rob Herring wrote:
> On Fri, Jul 01, 2022 at 09:46:59AM +0200, Krzysztof Kozlowski wrote:
>> Compatibles can come in two formats.  Either "vendor,ip-soc" or
>> "vendor,soc-ip".  Qualcomm bindings were mixing both of usages, so add a
>> readme file documenting preferred policy.
> 
> Is this all I needed to do to stop this from QCom? </sarcasm>
> 
> This convention is not QCom specific, though the error mostly is. 
> Perhaps this should be documented generically.

Good point. I can this to writing-bindings.rst.

> 
>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>>
>> ---
>>
>> Cc: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
>> Cc: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
>> Cc: Vinod Koul <vkoul@kernel.org>
>> Cc: Alex Elder <elder@linaro.org>
>> Cc: Robert Foss <robert.foss@linaro.org>
>> Cc: Bhupesh Sharma <bhupesh.sharma@linaro.org>
>> ---
>>  .../devicetree/bindings/soc/qcom/README.rst      | 16 ++++++++++++++++
>>  1 file changed, 16 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/soc/qcom/README.rst
>>
>> diff --git a/Documentation/devicetree/bindings/soc/qcom/README.rst b/Documentation/devicetree/bindings/soc/qcom/README.rst
>> new file mode 100644
>> index 000000000000..322b329ac7c1
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/soc/qcom/README.rst
>> @@ -0,0 +1,16 @@
>> +.. SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
>> +
>> +Qualcomm SoC compatibles naming convention
>> +==========================================
>> +1. When adding new compatibles in new bindings, use the format:
>> +   ::
>> +
>> +     qcom,SoC-IP
>> +
>> +   For example:
>> +   ::
>> +
>> +     qcom,sdm845-llcc-bwmon
> 
> Assuming the list of possible SoCs was maintained, you could make this a 
> schema. Though there might be false positives.

Indeed it works, although I need some exceptions for existing compatibles.


Best regards,
Krzysztof