[PATCH] scsi: ufs: qcom: dt-bindings: Add MCQ ESI property

[PATCH] scsi: ufs: qcom: dt-bindings: Add MCQ ESI property

[Ziqi Chen]

Document the description for the qcom,esi-affinity-mask.

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

diff --git a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
index bdfa86a..323595f 100644
--- a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
+++ b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
@@ -97,6 +97,10 @@ properties:
     description:
       GPIO connected to the RESET pin of the UFS memory device.
 
+  qcom,esi-affinity-mask:
+    description:
+       UFS MCQ ESI affinity mask. Affine ESI on registration according to this CPU mask.
+
 required:
   - compatible
   - reg
-- 
2.7.4

Re: [PATCH] scsi: ufs: qcom: dt-bindings: Add MCQ ESI property

[Rob Herring]

On Fri, 08 Sep 2023 16:53:23 +0800, Ziqi Chen wrote:
> Document the description for the qcom,esi-affinity-mask.
> 
> Signed-off-by: Ziqi Chen <quic_ziqichen@quicinc.com>
> ---
>  Documentation/devicetree/bindings/ufs/qcom,ufs.yaml | 4 ++++
>  1 file changed, 4 insertions(+)
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:
./Documentation/devicetree/bindings/ufs/qcom,ufs.yaml:102:8: [warning] wrong indentation: expected 6 but found 7 (indentation)

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml: properties:qcom,esi-affinity-mask: 'oneOf' conditional failed, one must be fixed:
	'type' is a required property
		hint: A vendor boolean property can use "type: boolean"
	/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml: properties:qcom,esi-affinity-mask: 'oneOf' conditional failed, one must be fixed:
		'enum' is a required property
		'const' is a required property
		hint: A vendor string property with exact values has an implicit type
		from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
	/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml: properties:qcom,esi-affinity-mask: 'oneOf' conditional failed, one must be fixed:
		'$ref' is a required property
		'allOf' is a required property
		hint: A vendor property needs a $ref to types.yaml
		from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
	hint: Vendor specific properties must have a type and description unless they have a defined, common suffix.
	from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/1694163203-39123-1-git-send-email-quic_ziqichen@quicinc.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.

Re: [PATCH] scsi: ufs: qcom: dt-bindings: Add MCQ ESI property

[Neil Armstrong]

Hi,

On 08/09/2023 10:53, Ziqi Chen wrote:
> Document the description for the qcom,esi-affinity-mask.

Do you plan to add all the other MCQ and ESI properties ? (reg, reg-names, msi-parent)

Thanks,
Neil

> 
> Signed-off-by: Ziqi Chen <quic_ziqichen@quicinc.com>
> ---
>   Documentation/devicetree/bindings/ufs/qcom,ufs.yaml | 4 ++++
>   1 file changed, 4 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
> index bdfa86a..323595f 100644
> --- a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
> +++ b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
> @@ -97,6 +97,10 @@ properties:
>       description:
>         GPIO connected to the RESET pin of the UFS memory device.
>   
> +  qcom,esi-affinity-mask:
> +    description:
> +       UFS MCQ ESI affinity mask. Affine ESI on registration according to this CPU mask.
> +
>   required:
>     - compatible
>     - reg

Re: [PATCH] scsi: ufs: qcom: dt-bindings: Add MCQ ESI property

[Ziqi Chen]

Hi Neil，

Yes，I will post reg-name and msi-parent properties in next version as soon.
reg is required property and already exist. but I will make some changes
on this property.
As for qcom,esi-affinity-mask, we will put it off.

Thanks,
Ziqi

On 9/8/2023 5:35 PM, Neil Armstrong wrote:
> Hi,
> 
> On 08/09/2023 10:53, Ziqi Chen wrote:
>> Document the description for the qcom,esi-affinity-mask.
> 
> Do you plan to add all the other MCQ and ESI properties ? (reg, 
> reg-names, msi-parent)
> 
> Thanks,
> Neil
> 
>>
>> Signed-off-by: Ziqi Chen <quic_ziqichen@quicinc.com>
>> ---
>>   Documentation/devicetree/bindings/ufs/qcom,ufs.yaml | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml 
>> b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
>> index bdfa86a..323595f 100644
>> --- a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
>> +++ b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
>> @@ -97,6 +97,10 @@ properties:
>>       description:
>>         GPIO connected to the RESET pin of the UFS memory device.
>> +  qcom,esi-affinity-mask:
>> +    description:
>> +       UFS MCQ ESI affinity mask. Affine ESI on registration 
>> according to this CPU mask.
>> +
>>   required:
>>     - compatible
>>     - reg
> 

Re: [PATCH] scsi: ufs: qcom: dt-bindings: Add MCQ ESI property

[Krzysztof Kozlowski]

On 08/09/2023 10:53, Ziqi Chen wrote:
> Document the description for the qcom,esi-affinity-mask.

This tells me nothing what is this feature for.

> 
> Signed-off-by: Ziqi Chen <quic_ziqichen@quicinc.com>
> ---
>  Documentation/devicetree/bindings/ufs/qcom,ufs.yaml | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
> index bdfa86a..323595f 100644
> --- a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
> +++ b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
> @@ -97,6 +97,10 @@ properties:
>      description:
>        GPIO connected to the RESET pin of the UFS memory device.
>  
> +  qcom,esi-affinity-mask:

Not tested. You also miss proper type.

> +    description:
> +       UFS MCQ ESI affinity mask. Affine ESI on registration according to this CPU mask.

And why is this a property of DT? Aren't you now describing driver?



Best regards,
Krzysztof

Re: [PATCH] scsi: ufs: qcom: dt-bindings: Add MCQ ESI property

[Ziqi Chen]

Hi Krzysztof，

Thanks for your comment very much ~
I will remove this property in next patch version.
We just plan to post "msi-parent" property for MCQ.


Best Regards,
Ziqi

On 9/11/2023 2:27 PM, Krzysztof Kozlowski wrote:
> On 08/09/2023 10:53, Ziqi Chen wrote:
>> Document the description for the qcom,esi-affinity-mask.
> 
> This tells me nothing what is this feature for.
> 
>>
>> Signed-off-by: Ziqi Chen <quic_ziqichen@quicinc.com>
>> ---
>>   Documentation/devicetree/bindings/ufs/qcom,ufs.yaml | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
>> index bdfa86a..323595f 100644
>> --- a/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
>> +++ b/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
>> @@ -97,6 +97,10 @@ properties:
>>       description:
>>         GPIO connected to the RESET pin of the UFS memory device.
>>   
>> +  qcom,esi-affinity-mask:
> 
> Not tested. You also miss proper type.
> 
>> +    description:
>> +       UFS MCQ ESI affinity mask. Affine ESI on registration according to this CPU mask.
> 
> And why is this a property of DT? Aren't you now describing driver?
> 
> 
> 
> Best regards,
> Krzysztof
>