diff mbox series

[v2] scsi: ufs: qcom: dt-bindings: Add MCQ properties

Message ID 1694675158-38301-1-git-send-email-quic_ziqichen@quicinc.com (mailing list archive)
State Not Applicable
Headers show
Series [v2] scsi: ufs: qcom: dt-bindings: Add MCQ properties | expand

Commit Message

Ziqi Chen Sept. 14, 2023, 7:05 a.m. UTC
Remove the maxItem limitation to property 'reg',
and add description for the property 'msi-parent'.

Signed-off-by: Ziqi Chen <quic_ziqichen@quicinc.com>
---
 Documentation/devicetree/bindings/ufs/qcom,ufs.yaml | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

Comments

Krzysztof Kozlowski Sept. 14, 2023, 7:16 a.m. UTC | #1
On 14/09/2023 09:05, Ziqi Chen wrote:
> Remove the maxItem limitation to property 'reg',
> and add description for the property 'msi-parent'.
> 
> Signed-off-by: Ziqi Chen <quic_ziqichen@quicinc.com>
> ---
>  Documentation/devicetree/bindings/ufs/qcom,ufs.yaml | 12 +++++++++++-
>  1 file changed, 11 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
> index bdfa86a..5ec2717 100644
> --- a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
> +++ b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
> @@ -77,7 +77,13 @@ properties:
>  
>    reg:
>      minItems: 1
> -    maxItems: 2

So 20 items are allowed? No, that's not correct.


> +    description:
> +      Register base addresses and lengths of the UFS areas.

Drop description - it's useless and redundant.

> +
> +  reg-names:
> +    minItems: 1
> +    description:
> +      Names of the reg areas to use during resource lookup.

Drop such description it's useless, instead list and describe items.

Also, why all devices now have two regs? No, this is just wrong. And
haven't we been here with two items?


>  
>    required-opps:
>      maxItems: 1
> @@ -97,6 +103,10 @@ properties:
>      description:
>        GPIO connected to the RESET pin of the UFS memory device.
>  
> +  msi-parent:
> +    description:
> +      Pointer to the hardware entity that serves as the MSI controller for thi UFS controller.

typo in "thi". Not wrapped according to Linux coding style (as written
in coding style document). BTW, this is usually just "true" and without
need for description.


Best regards,
Krzysztof
Krzysztof Kozlowski Sept. 14, 2023, 7:17 a.m. UTC | #2
On 14/09/2023 09:16, Krzysztof Kozlowski wrote:
> On 14/09/2023 09:05, Ziqi Chen wrote:
>> Remove the maxItem limitation to property 'reg',

Your commit should answer to "why". Not "what".

>> and add description for the property 'msi-parent'.
>>
>> Signed-off-by: Ziqi Chen <quic_ziqichen@quicinc.com>
>> ---
>>  Documentation/devicetree/bindings/ufs/qcom,ufs.yaml | 12 +++++++++++-
>>  1 file changed, 11 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
>> index bdfa86a..5ec2717 100644
>> --- a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
>> +++ b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
>> @@ -77,7 +77,13 @@ properties:
>>  
>>    reg:
>>      minItems: 1
>> -    maxItems: 2
> 
> So 20 items are allowed? No, that's not correct.
> 
> 
>> +    description:
>> +      Register base addresses and lengths of the UFS areas.
> 
> Drop description - it's useless and redundant.
> 
>> +
>> +  reg-names:
>> +    minItems: 1
>> +    description:
>> +      Names of the reg areas to use during resource lookup.
> 
> Drop such description it's useless, instead list and describe items.
> 
> Also, why all devices now have two regs? No, this is just wrong. And
> haven't we been here with two items?
> 
> 
>>  
>>    required-opps:
>>      maxItems: 1
>> @@ -97,6 +103,10 @@ properties:
>>      description:
>>        GPIO connected to the RESET pin of the UFS memory device.
>>  
>> +  msi-parent:
>> +    description:
>> +      Pointer to the hardware entity that serves as the MSI controller for thi UFS controller.
> 
> typo in "thi". Not wrapped according to Linux coding style (as written
> in coding style document). BTW, this is usually just "true" and without
> need for description.
> 

BTW, for both my comments - for reg/reg-names and this property - where
is the user? Except adding this to example, I expect to see users somewhere.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
index bdfa86a..5ec2717 100644
--- a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
+++ b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
@@ -77,7 +77,13 @@  properties:
 
   reg:
     minItems: 1
-    maxItems: 2
+    description:
+      Register base addresses and lengths of the UFS areas.
+
+  reg-names:
+    minItems: 1
+    description:
+      Names of the reg areas to use during resource lookup.
 
   required-opps:
     maxItems: 1
@@ -97,6 +103,10 @@  properties:
     description:
       GPIO connected to the RESET pin of the UFS memory device.
 
+  msi-parent:
+    description:
+      Pointer to the hardware entity that serves as the MSI controller for thi UFS controller.
+
 required:
   - compatible
   - reg