diff mbox series

[4/7] spi: cadence: Change dt-bindings documentation for Cadence XSPI controller

Message ID 20221219144254.20883-5-wsadowski@marvell.com
State New
Headers show
Series Support for Marvell modifications for Cadence XSPI | expand

Commit Message

Witold Sadowski Dec. 19, 2022, 2:42 p.m. UTC
Add parameter cdns,read-size.
Parameter is controlling SDMA read size length.

Signed-off-by: Witold Sadowski <wsadowski@marvell.com>
---
 Documentation/devicetree/bindings/spi/cdns,xspi.yaml | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Mark Brown Dec. 19, 2022, 6:14 p.m. UTC | #1
On Mon, Dec 19, 2022 at 06:42:51AM -0800, Witold Sadowski wrote:

> Add parameter cdns,read-size.
> Parameter is controlling SDMA read size length.

Why is this something we would want to configure statically in DT?
Rob Herring Dec. 19, 2022, 9:22 p.m. UTC | #2
On Mon, 19 Dec 2022 06:42:51 -0800, Witold Sadowski wrote:
> Add parameter cdns,read-size.
> Parameter is controlling SDMA read size length.
> 
> Signed-off-by: Witold Sadowski <wsadowski@marvell.com>
> ---
>  Documentation/devicetree/bindings/spi/cdns,xspi.yaml | 5 +++++
>  1 file changed, 5 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:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/spi/cdns,xspi.yaml: properties:cdns,read-size: 'oneOf' conditional failed, one must be fixed:
	'type' is a required property
		hint: A vendor boolean property can use "type: boolean"
	'description' is a required property
		hint: A vendor boolean property can use "type: boolean"
	Additional properties are not allowed ('items' was unexpected)
		hint: A vendor boolean property can use "type: boolean"
	/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/spi/cdns,xspi.yaml: properties:cdns,read-size: '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/spi/cdns,xspi.yaml: properties:cdns,read-size: '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/20221219144254.20883-5-wsadowski@marvell.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.
Krzysztof Kozlowski Dec. 20, 2022, 2:09 p.m. UTC | #3
On 19/12/2022 15:42, Witold Sadowski wrote:
> Add parameter cdns,read-size.
> Parameter is controlling SDMA read size length.

Use subject prefixes matching the subsystem (git log --oneline -- ...).

Please use scripts/get_maintainers.pl to get a list of necessary people
and lists to CC.  It might happen, that command when run on an older
kernel, gives you outdated entries.  Therefore please be sure you base
your patches on recent Linux kernel.

> 
> Signed-off-by: Witold Sadowski <wsadowski@marvell.com>
> ---
>  Documentation/devicetree/bindings/spi/cdns,xspi.yaml | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/spi/cdns,xspi.yaml b/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
> index f71a9c74e2ca..1274e3bf68e6 100644
> --- a/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
> +++ b/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
> @@ -37,6 +37,10 @@ properties:
>    interrupts:
>      maxItems: 1
>  
> +  cdns,read-size:
> +    items:
> +      - description: size of single SDMA read operation

Why is this a property of DT?

> +
>  required:
>    - compatible
>    - reg
> @@ -60,6 +64,7 @@ examples:
>              reg-names = "io", "sdma", "aux";
>              interrupts = <0 90 IRQ_TYPE_LEVEL_HIGH>;
>              interrupt-parent = <&gic>;
> +            cdns,read-size=<0>;

That's not DT coding style.

>  
>              flash@0 {
>                  compatible = "jedec,spi-nor";

Best regards,
Krzysztof
Witold Sadowski April 29, 2024, 3:13 p.m. UTC | #4
> ----------------------------------------------------------------------
> On 19/12/2022 15:42, Witold Sadowski wrote:
> > Add parameter cdns,read-size.
> > Parameter is controlling SDMA read size length.
> 
> Use subject prefixes matching the subsystem (git log --oneline -- ...).
> 
> Please use scripts/get_maintainers.pl to get a list of necessary people
> and lists to CC.  It might happen, that command when run on an older
> kernel, gives you outdated entries.  Therefore please be sure you base
> your patches on recent Linux kernel.
> 
> >
> > Signed-off-by: Witold Sadowski <wsadowski@marvell.com>
> > ---
> >  Documentation/devicetree/bindings/spi/cdns,xspi.yaml | 5 +++++
> >  1 file changed, 5 insertions(+)
> >
> > diff --git a/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
> > b/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
> > index f71a9c74e2ca..1274e3bf68e6 100644
> > --- a/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
> > +++ b/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
> > @@ -37,6 +37,10 @@ properties:
> >    interrupts:
> >      maxItems: 1
> >
> > +  cdns,read-size:
> > +    items:
> > +      - description: size of single SDMA read operation
> 
> Why is this a property of DT?

Removed, read size check will be based on matching.
The problem is internal bus connection to xSPI IP.

> 
> > +
> >  required:
> >    - compatible
> >    - reg
> > @@ -60,6 +64,7 @@ examples:
> >              reg-names = "io", "sdma", "aux";
> >              interrupts = <0 90 IRQ_TYPE_LEVEL_HIGH>;
> >              interrupt-parent = <&gic>;
> > +            cdns,read-size=<0>;
> 
> That's not DT coding style.
> 
> >
> >              flash@0 {
> >                  compatible = "jedec,spi-nor";
> 
> Best regards,
> Krzysztof

Regards
Witek
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/spi/cdns,xspi.yaml b/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
index f71a9c74e2ca..1274e3bf68e6 100644
--- a/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
+++ b/Documentation/devicetree/bindings/spi/cdns,xspi.yaml
@@ -37,6 +37,10 @@  properties:
   interrupts:
     maxItems: 1
 
+  cdns,read-size:
+    items:
+      - description: size of single SDMA read operation
+
 required:
   - compatible
   - reg
@@ -60,6 +64,7 @@  examples:
             reg-names = "io", "sdma", "aux";
             interrupts = <0 90 IRQ_TYPE_LEVEL_HIGH>;
             interrupt-parent = <&gic>;
+            cdns,read-size=<0>;
 
             flash@0 {
                 compatible = "jedec,spi-nor";