* [PATCH] dt-bindings: misc: axi-fifo: Add binding for AXI-Stream FIFO
@ 2024-06-20 1:06 Mark Watson
2024-06-20 2:22 ` Rob Herring (Arm)
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Mark Watson @ 2024-06-20 1:06 UTC (permalink / raw)
To: robh, krzk+dt, conor+dt, devicetree, linux-kernel
This resolves a checkpatch warning in drivers/staging/axis-fifo
regarding a missing devie-tree binding. The full warning is included
below.
WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.1" appears
un-documented -- check ./Documentation/devicetree/bindings/
+ { .compatible = "xlnx,axi-fifo-mm-s-4.1", },
Signed-off-by: Mark Watson <markus.c.watson@gmail.com>
---
.../bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml | 214 ++++++++++++++++++
1 file changed, 214 insertions(+)
create mode 100644 Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml
diff --git a/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml b/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml
new file mode 100644
index 000000000000..cfb335752054
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml
@@ -0,0 +1,214 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/misc/xlnx,axi-fifo-mm-s-4.1.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx AXI-Stream FIFO v4.1 IP core
+
+description: |
+ The Xilinx AXI-Stream FIFO v4.1 IP core has read and write AXI-Stream FIFOs,
+ the contents of which can be accessed from the AXI4 memory-mapped interface.
+ This is useful for transferring data from a processor into the FPGA fabric.
+ The driver creates a character device that can be read/written to with
+ standard open/read/write/close operations.
+
+ See Xilinx PG080 document for IP details.
+
+ Currently supports only store-forward mode with a 32-bit AXI4-Lite
+ interface.
+
+ DOES NOT support:
+ - cut-through mode
+ - AXI4 (non-lite)
+
+properties:
+ compatible:
+ const: xlnx,axi-fifo-mm-s-4.1
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ interrupt-names:
+ items:
+ - const: interrupt
+
+ interrupt-parent:
+ $ref: /schemas/types.yaml#/definitions/phandle
+
+ xlnx,axi-str-rxd-protocol:
+ const: XIL_AXI_STREAM_ETH_DATA
+
+ xlnx,axi-str-rxd-tdata-width:
+ const: 0x20
+
+ xlnx,axi-str-txc-protocol:
+ const: XIL_AXI_STREAM_ETH_CTRL
+
+ xlnx,axi-str-txc-tdata-width:
+ const: 0x20
+
+ xlnx,axi-str-txd-protocol:
+ const: XIL_AXI_STREAM_ETH_DATA
+
+ xlnx,axi-str-txd-tdata-width:
+ const: 0x20
+
+ xlnx,axis-tdest-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,axis-tid-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,axis-tuser-width:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,data-interface-type:
+ const: 0x0
+
+ xlnx,has-axis-tdest:
+ const: 0x0
+
+ xlnx,has-axis-tid:
+ const: 0x0
+
+ xlnx,has-axis-tkeep:
+ const: 0x1
+
+ xlnx,has-axis-tstrb:
+ const: 0x0
+
+ xlnx,has-axis-tuser:
+ const: 0x0
+
+ xlnx,rx-fifo-depth:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,rx-fifo-pe-threshold:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,rx-fifo-pf-threshold:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,s-axi-id-width:
+ const: 0x4
+
+ xlnx,s-axi4-data-width:
+ const: 0x20
+
+ xlnx,select-xpm:
+ const: 0x0
+
+ xlnx,tx-fifo-depth:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,tx-fifo-pe-threshold:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,tx-fifo-pf-threshold:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,use-rx-cut-through:
+ const: 0x0
+
+ xlnx,use-rx-data:
+ const: 0x1
+
+ xlnx,use-tx-ctrl:
+ const: 0x0
+
+ xlnx,use-tx-cut-through:
+ const: 0x0
+
+ xlnx,use-tx-data:
+ const: 0x1
+
+ xlnx,tx-max-pkt-size:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ xlnx,rx-min-pkt-size:
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+required:
+ - compatible
+ - reg
+ - interrupts
+ - interrupt-names
+ - interrupt-parent
+ - xlnx,axi-str-rxd-protocol
+ - xlnx,axi-str-rxd-tdata-width
+ - xlnx,axi-str-txc-protocol
+ - xlnx,axi-str-txc-tdata-width
+ - xlnx,axi-str-txd-protocol
+ - xlnx,axi-str-txd-tdata-width
+ - xlnx,axis-tdest-width
+ - xlnx,axis-tid-width
+ - xlnx,axis-tuser-width
+ - xlnx,data-interface-type
+ - xlnx,has-axis-tdest
+ - xlnx,has-axis-tid
+ - xlnx,has-axis-tkeep
+ - xlnx,has-axis-tstrb
+ - xlnx,has-axis-tuser
+ - xlnx,rx-fifo-depth
+ - xlnx,rx-fifo-pe-threshold
+ - xlnx,rx-fifo-pf-threshold
+ - xlnx,s-axi-id-width
+ - xlnx,s-axi4-data-width
+ - xlnx,select-xpm
+ - xlnx,tx-fifo-depth
+ - xlnx,tx-fifo-pe-threshold
+ - xlnx,tx-fifo-pf-threshold
+ - xlnx,use-rx-cut-through
+ - xlnx,use-rx-data
+ - xlnx,use-tx-ctrl
+ - xlnx,use-tx-cut-through
+ - xlnx,use-tx-data
+ - xlnx,tx-max-pkt-size
+ - xlnx,rx-min-pkt-size
+
+additionalProperties: false
+
+examples:
+ - |
+ axi_fifo_mm_s_0: axi_fifo_mm_s@43c00000 {
+ compatible = "xlnx,axi-fifo-mm-s-4.1";
+ interrupt-names = "interrupt";
+ interrupt-parent = <&intc>;
+ interrupts = <0 29 4>;
+ reg = <0x43c00000 0x10000>;
+ xlnx,axi-str-rxd-protocol = "XIL_AXI_STREAM_ETH_DATA";
+ xlnx,axi-str-rxd-tdata-width = <0x20>;
+ xlnx,axi-str-txc-protocol = "XIL_AXI_STREAM_ETH_CTRL";
+ xlnx,axi-str-txc-tdata-width = <0x20>;
+ xlnx,axi-str-txd-protocol = "XIL_AXI_STREAM_ETH_DATA";
+ xlnx,axi-str-txd-tdata-width = <0x20>;
+ xlnx,axis-tdest-width = <0x4>;
+ xlnx,axis-tid-width = <0x4>;
+ xlnx,axis-tuser-width = <0x4>;
+ xlnx,data-interface-type = <0x0>;
+ xlnx,has-axis-tdest = <0x0>;
+ xlnx,has-axis-tid = <0x0>;
+ xlnx,has-axis-tkeep = <0x1>;
+ xlnx,has-axis-tstrb = <0x0>;
+ xlnx,has-axis-tuser = <0x0>;
+ xlnx,rx-fifo-depth = <0x200>;
+ xlnx,rx-fifo-pe-threshold = <0x2>;
+ xlnx,rx-fifo-pf-threshold = <0x1fb>;
+ xlnx,s-axi-id-width = <0x4>;
+ xlnx,s-axi4-data-width = <0x20>;
+ xlnx,select-xpm = <0x0>;
+ xlnx,tx-fifo-depth = <0x8000>;
+ xlnx,tx-fifo-pe-threshold = <0x200>;
+ xlnx,tx-fifo-pf-threshold = <0x7ffb>;
+ xlnx,use-rx-cut-through = <0x0>;
+ xlnx,use-rx-data = <0x0>;
+ xlnx,use-tx-ctrl = <0x0>;
+ xlnx,use-tx-cut-through = <0x0>;
+ xlnx,use-tx-data = <0x1>;
+ xlnx,tx-max-pkt-size = <257>;
+ xlnx,rx-min-pkt-size = <255>;
+ };
--
2.34.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] dt-bindings: misc: axi-fifo: Add binding for AXI-Stream FIFO
2024-06-20 1:06 [PATCH] dt-bindings: misc: axi-fifo: Add binding for AXI-Stream FIFO Mark Watson
@ 2024-06-20 2:22 ` Rob Herring (Arm)
2024-06-20 2:32 ` kernel test robot
2024-06-20 6:49 ` Krzysztof Kozlowski
2 siblings, 0 replies; 4+ messages in thread
From: Rob Herring (Arm) @ 2024-06-20 2:22 UTC (permalink / raw)
To: Mark Watson; +Cc: conor+dt, devicetree, linux-kernel, krzk+dt
On Wed, 19 Jun 2024 22:06:08 -0300, Mark Watson wrote:
> This resolves a checkpatch warning in drivers/staging/axis-fifo
> regarding a missing devie-tree binding. The full warning is included
> below.
>
> WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.1" appears
> un-documented -- check ./Documentation/devicetree/bindings/
> + { .compatible = "xlnx,axi-fifo-mm-s-4.1", },
>
> Signed-off-by: Mark Watson <markus.c.watson@gmail.com>
> ---
> .../bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml | 214 ++++++++++++++++++
> 1 file changed, 214 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml
>
My bot found errors running 'make dt_binding_check' on your patch:
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: 'maintainers' is a required property
hint: Metaschema for devicetree binding documentation
from schema $id: http://devicetree.org/meta-schemas/base.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:interrupt-parent: False schema does not allow {'$ref': '/schemas/types.yaml#/definitions/phandle'}
from schema $id: http://devicetree.org/meta-schemas/interrupts.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,rx-fifo-pe-threshold: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,tx-fifo-depth: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,rx-min-pkt-size: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,tx-fifo-pf-threshold: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,axis-tdest-width: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,rx-fifo-pf-threshold: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,axis-tuser-width: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,tx-max-pkt-size: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,rx-fifo-depth: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,tx-fifo-pe-threshold: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: properties:xlnx,axis-tid-width: 'anyOf' conditional failed, one must be fixed:
'description' is a dependency of '$ref'
'/schemas/types.yaml#/definitions/uint32' does not match '^#/(definitions|\\$defs)/'
hint: A vendor property can have a $ref to a a $defs schema
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#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,axi-str-rxd-tdata-width: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,axi-str-txc-tdata-width: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,axi-str-txd-tdata-width: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,data-interface-type: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tdest: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tid: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tkeep: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tstrb: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tuser: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,s-axi-id-width: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,s-axi4-data-width: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,select-xpm: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-rx-cut-through: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-rx-data: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-tx-ctrl: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-tx-cut-through: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-tx-data: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.example.dtb: axi_fifo_mm_s@43c00000: xlnx,use-rx-data:0:0: 1 was expected
from schema $id: http://devicetree.org/schemas/misc/xlnx,axi-fifo-mm-s-4.1.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.example.dtb: axi_fifo_mm_s@43c00000: 'interrupt-parent' is a required property
from schema $id: http://devicetree.org/schemas/misc/xlnx,axi-fifo-mm-s-4.1.yaml#
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/ZnOAgM+zacF6u1x7@laptop
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.
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] dt-bindings: misc: axi-fifo: Add binding for AXI-Stream FIFO
2024-06-20 1:06 [PATCH] dt-bindings: misc: axi-fifo: Add binding for AXI-Stream FIFO Mark Watson
2024-06-20 2:22 ` Rob Herring (Arm)
@ 2024-06-20 2:32 ` kernel test robot
2024-06-20 6:49 ` Krzysztof Kozlowski
2 siblings, 0 replies; 4+ messages in thread
From: kernel test robot @ 2024-06-20 2:32 UTC (permalink / raw)
To: Mark Watson, robh, krzk+dt, conor+dt, devicetree, linux-kernel
Cc: oe-kbuild-all
Hi Mark,
kernel test robot noticed the following build warnings:
[auto build test WARNING on robh/for-next]
[also build test WARNING on linus/master v6.10-rc4 next-20240619]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Mark-Watson/dt-bindings-misc-axi-fifo-Add-binding-for-AXI-Stream-FIFO/20240620-090916
base: https://git.kernel.org/pub/scm/linux/kernel/git/robh/linux.git for-next
patch link: https://lore.kernel.org/r/ZnOAgM%2BzacF6u1x7%40laptop
patch subject: [PATCH] dt-bindings: misc: axi-fifo: Add binding for AXI-Stream FIFO
config: arc-randconfig-051-20240620 (https://download.01.org/0day-ci/archive/20240620/202406201053.hc3wOYdz-lkp@intel.com/config)
compiler: arceb-elf-gcc (GCC) 13.2.0
dtschema version: 2024.6.dev1+g833054f
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240620/202406201053.hc3wOYdz-lkp@intel.com/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202406201053.hc3wOYdz-lkp@intel.com/
dtcheck warnings: (new ones prefixed by >>)
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,axi-str-rxd-tdata-width: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,axi-str-txc-tdata-width: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,axi-str-txd-tdata-width: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,data-interface-type: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tdest: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tid: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tkeep: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tstrb: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,has-axis-tuser: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,s-axi-id-width: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,s-axi4-data-width: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,select-xpm: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-rx-cut-through: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-rx-data: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-tx-ctrl: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-tx-cut-through: missing type definition
>> Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml: xlnx,use-tx-data: missing type definition
Documentation/devicetree/bindings/net/snps,dwmac.yaml: mac-mode: missing type definition
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] dt-bindings: misc: axi-fifo: Add binding for AXI-Stream FIFO
2024-06-20 1:06 [PATCH] dt-bindings: misc: axi-fifo: Add binding for AXI-Stream FIFO Mark Watson
2024-06-20 2:22 ` Rob Herring (Arm)
2024-06-20 2:32 ` kernel test robot
@ 2024-06-20 6:49 ` Krzysztof Kozlowski
2 siblings, 0 replies; 4+ messages in thread
From: Krzysztof Kozlowski @ 2024-06-20 6:49 UTC (permalink / raw)
To: Mark Watson, robh, krzk+dt, conor+dt, devicetree, linux-kernel
On 20/06/2024 03:06, Mark Watson wrote:
> This resolves a checkpatch warning in drivers/staging/axis-fifo
> regarding a missing devie-tree binding. The full warning is included
> below.
>
> WARNING: DT compatible string "xlnx,axi-fifo-mm-s-4.1" appears
> un-documented -- check ./Documentation/devicetree/bindings/
> + { .compatible = "xlnx,axi-fifo-mm-s-4.1", },
That's not needed. Drop above reasoning but instead say that you add new
bindings for foo bar (explain what is the hardware).
You did not test your code, so limited review follows.
There is a binding. Just grep for compatible. You might want to do
conversion but then:
Thank you for your patch. There are no DTS users of this binding, so
while such conversions are useful, they have significantly smaller
impact. In the future, please consider converting bindings from active
platforms (arm64 defconfig, arm multi_v7). This would have significantly
bigger impact.
See also:
https://lore.kernel.org/all/6552bcb8-e046-4882-91da-1094fff3d239@linaro.org/
>
> Signed-off-by: Mark Watson <markus.c.watson@gmail.com>
> ---
> .../bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml | 214 ++++++++++++++++++
> 1 file changed, 214 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml
>
> diff --git a/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml b/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml
> new file mode 100644
> index 000000000000..cfb335752054
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/misc/xlnx,axi-fifo-mm-s-4.1.yaml
> @@ -0,0 +1,214 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/misc/xlnx,axi-fifo-mm-s-4.1.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Xilinx AXI-Stream FIFO v4.1 IP core
> +
Missing maintainers. Why would we care about hardware if there is no one
to interested in it?
> +description: |
> + The Xilinx AXI-Stream FIFO v4.1 IP core has read and write AXI-Stream FIFOs,
> + the contents of which can be accessed from the AXI4 memory-mapped interface.
> + This is useful for transferring data from a processor into the FPGA fabric.
> + The driver creates a character device that can be read/written to with
> + standard open/read/write/close operations.
> +
> + See Xilinx PG080 document for IP details.
> +
> + Currently supports only store-forward mode with a 32-bit AXI4-Lite
> + interface.
> +
> + DOES NOT support:
> + - cut-through mode
> + - AXI4 (non-lite)
> +
> +properties:
> + compatible:
> + const: xlnx,axi-fifo-mm-s-4.1
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + interrupt-names:
> + items:
> + - const: interrupt
No, drop entire property.
> +
> + interrupt-parent:
> + $ref: /schemas/types.yaml#/definitions/phandle
Drop property.
> +
> + xlnx,axi-str-rxd-protocol:
> + const: XIL_AXI_STREAM_ETH_DATA
> +
> + xlnx,axi-str-rxd-tdata-width:
> + const: 0x20
> +
> + xlnx,axi-str-txc-protocol:
> + const: XIL_AXI_STREAM_ETH_CTRL
> +
> + xlnx,axi-str-txc-tdata-width:
> + const: 0x20
> +
> + xlnx,axi-str-txd-protocol:
> + const: XIL_AXI_STREAM_ETH_DATA
> +
> + xlnx,axi-str-txd-tdata-width:
> + const: 0x20
Drop all these.
> +
> + xlnx,axis-tdest-width:
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + xlnx,axis-tid-width:
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + xlnx,axis-tuser-width:
> + $ref: /schemas/types.yaml#/definitions/uint32
No clue what are these. Drop.
> +
> + xlnx,data-interface-type:
> + const: 0x0
> +
> + xlnx,has-axis-tdest:
> + const: 0x0
> +
> + xlnx,has-axis-tid:
> + const: 0x0
> +
> + xlnx,has-axis-tkeep:
> + const: 0x1
> +
> + xlnx,has-axis-tstrb:
> + const: 0x0
> +
> + xlnx,has-axis-tuser:
> + const: 0x0
Drop everything above.
> +
> + xlnx,rx-fifo-depth:
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + xlnx,rx-fifo-pe-threshold:
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + xlnx,rx-fifo-pf-threshold:
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + xlnx,s-axi-id-width:
> + const: 0x4
> +
> + xlnx,s-axi4-data-width:
> + const: 0x20
> +
> + xlnx,select-xpm:
> + const: 0x0
> +
> + xlnx,tx-fifo-depth:
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + xlnx,tx-fifo-pe-threshold:
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + xlnx,tx-fifo-pf-threshold:
> + $ref: /schemas/types.yaml#/definitions/uint32
No standard properties?
> +
> + xlnx,use-rx-cut-through:
> + const: 0x0
> +
> + xlnx,use-rx-data:
> + const: 0x1
> +
> + xlnx,use-tx-ctrl:
> + const: 0x0
> +
> + xlnx,use-tx-cut-through:
> + const: 0x0
> +
> + xlnx,use-tx-data:
> + const: 0x1
> +
> + xlnx,tx-max-pkt-size:
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + xlnx,rx-min-pkt-size:
> + $ref: /schemas/types.yaml#/definitions/uint32
No, drop all these.
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - interrupt-names
> + - interrupt-parent
> + - xlnx,axi-str-rxd-protocol
> + - xlnx,axi-str-rxd-tdata-width
> + - xlnx,axi-str-txc-protocol
> + - xlnx,axi-str-txc-tdata-width
> + - xlnx,axi-str-txd-protocol
> + - xlnx,axi-str-txd-tdata-width
> + - xlnx,axis-tdest-width
> + - xlnx,axis-tid-width
> + - xlnx,axis-tuser-width
> + - xlnx,data-interface-type
> + - xlnx,has-axis-tdest
> + - xlnx,has-axis-tid
> + - xlnx,has-axis-tkeep
> + - xlnx,has-axis-tstrb
> + - xlnx,has-axis-tuser
> + - xlnx,rx-fifo-depth
> + - xlnx,rx-fifo-pe-threshold
> + - xlnx,rx-fifo-pf-threshold
> + - xlnx,s-axi-id-width
> + - xlnx,s-axi4-data-width
> + - xlnx,select-xpm
> + - xlnx,tx-fifo-depth
> + - xlnx,tx-fifo-pe-threshold
> + - xlnx,tx-fifo-pf-threshold
> + - xlnx,use-rx-cut-through
> + - xlnx,use-rx-data
> + - xlnx,use-tx-ctrl
> + - xlnx,use-tx-cut-through
> + - xlnx,use-tx-data
> + - xlnx,tx-max-pkt-size
> + - xlnx,rx-min-pkt-size
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + axi_fifo_mm_s_0: axi_fifo_mm_s@43c00000 {
Drop label. No underscores in node names.
Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
> + compatible = "xlnx,axi-fifo-mm-s-4.1";
> + interrupt-names = "interrupt";
> + interrupt-parent = <&intc>;
> + interrupts = <0 29 4>;
Use proper defines.
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2024-06-20 6:49 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-06-20 1:06 [PATCH] dt-bindings: misc: axi-fifo: Add binding for AXI-Stream FIFO Mark Watson
2024-06-20 2:22 ` Rob Herring (Arm)
2024-06-20 2:32 ` kernel test robot
2024-06-20 6:49 ` Krzysztof Kozlowski
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).