diff mbox series

[V3,1/5] dt-bindings: soc: imx: Add binding doc for spba bus

Message ID 20201106111543.1806809-1-aford173@gmail.com
State New
Headers show
Series [V3,1/5] dt-bindings: soc: imx: Add binding doc for spba bus | expand

Commit Message

Adam Ford Nov. 6, 2020, 11:15 a.m. UTC
Add binding doc for fsl,spba-bus.

Signed-off-by: Adam Ford <aford173@gmail.com>
---
V3:  New to series

Comments

Rob Herring (Arm) Nov. 6, 2020, 4:18 p.m. UTC | #1
On Fri, 06 Nov 2020 05:15:39 -0600, Adam Ford wrote:
> Add binding doc for fsl,spba-bus.

> 

> Signed-off-by: Adam Ford <aford173@gmail.com>

> ---

> V3:  New to series

> 



My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
./Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml: $id: relative path/filename doesn't match actual path or filename
	expected: http://devicetree.org/schemas/bus/fsl,spba-bus.yaml#
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml: duplicate '$id' value 'http://devicetree.org/schemas/bus/simple-pm-bus.yaml#'


See https://patchwork.ozlabs.org/patch/1395626

The base for the patch is generally the last rc1. Any dependencies
should be noted.

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.
Rob Herring (Arm) Nov. 6, 2020, 4:19 p.m. UTC | #2
On Fri, Nov 06, 2020 at 05:15:39AM -0600, Adam Ford wrote:
> Add binding doc for fsl,spba-bus.

> 

> Signed-off-by: Adam Ford <aford173@gmail.com>

> ---

> V3:  New to series


Please implement my review comments from the last version you sent.

> 

> diff --git a/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml

> new file mode 100644

> index 000000000000..0a2add841145

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml

> @@ -0,0 +1,56 @@

> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/bus/simple-pm-bus.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +

> +title: Shared Peripherals Bus Interface

> +

> +maintainers:

> +  - Shawn Guo <shawnguo@kernel.org>

> +

> +description: |

> +  A simple bus enabling access to shared peripherals.

> +

> +  The "spba-bus" follows the "simple-bus" set of properties, as

> +  specified in the Devicetree Specification.  It is an extension of

> +  "simple-bus" because the SDMA controller uses this compatible flag to

> +  determine which peripherals are available to it and the range over which

> +  the SDMA can access.  There are no special clocks for the bus, because

> +  the SDMA controller itself has its interrupt, and clock assignments.

> +

> +properties:

> +  $nodename:

> +    pattern: "^bus(@[0-9a-f]+)?$"

> +

> +  compatible:

> +    contains:

> +      const: fsl,spba-bus

> +    description:

> +      Shall contain "fsl,spba-bus" in addition to "simple-bus"

> +      compatible strings.

> +

> +  '#address-cells':

> +    enum: [ 1, 2 ]

> +

> +  '#size-cells':

> +    enum: [ 1, 2 ]

> +

> +  ranges: true

> +

> +required:

> +  - compatible

> +  - '#address-cells'

> +  - '#size-cells'

> +  - ranges

> +

> +additionalProperties: true

> +

> +examples:

> +  - |

> +    bus {

> +        compatible = "fsl,spba-bus", "simple-bus";

> +        #address-cells = <1>;

> +        #size-cells = <1>;

> +        ranges;

> +    };

> -- 

> 2.25.1

>
Adam Ford Nov. 6, 2020, 4:28 p.m. UTC | #3
On Fri, Nov 6, 2020 at 10:19 AM Rob Herring <robh@kernel.org> wrote:
>

> On Fri, Nov 06, 2020 at 05:15:39AM -0600, Adam Ford wrote:

> > Add binding doc for fsl,spba-bus.

> >

> > Signed-off-by: Adam Ford <aford173@gmail.com>

> > ---

> > V3:  New to series

>

> Please implement my review comments from the last version you sent.


Sorry about that.  I grabbed from the wrong branch.  I implemented
them, but apparently I did it on the wrong branch.

I'll send a V4.

Sorry for the noise.

adam
>

> >

> > diff --git a/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml

> > new file mode 100644

> > index 000000000000..0a2add841145

> > --- /dev/null

> > +++ b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml

> > @@ -0,0 +1,56 @@

> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> > +%YAML 1.2

> > +---

> > +$id: http://devicetree.org/schemas/bus/simple-pm-bus.yaml#

> > +$schema: http://devicetree.org/meta-schemas/core.yaml#

> > +

> > +title: Shared Peripherals Bus Interface

> > +

> > +maintainers:

> > +  - Shawn Guo <shawnguo@kernel.org>

> > +

> > +description: |

> > +  A simple bus enabling access to shared peripherals.

> > +

> > +  The "spba-bus" follows the "simple-bus" set of properties, as

> > +  specified in the Devicetree Specification.  It is an extension of

> > +  "simple-bus" because the SDMA controller uses this compatible flag to

> > +  determine which peripherals are available to it and the range over which

> > +  the SDMA can access.  There are no special clocks for the bus, because

> > +  the SDMA controller itself has its interrupt, and clock assignments.

> > +

> > +properties:

> > +  $nodename:

> > +    pattern: "^bus(@[0-9a-f]+)?$"

> > +

> > +  compatible:

> > +    contains:

> > +      const: fsl,spba-bus

> > +    description:

> > +      Shall contain "fsl,spba-bus" in addition to "simple-bus"

> > +      compatible strings.

> > +

> > +  '#address-cells':

> > +    enum: [ 1, 2 ]

> > +

> > +  '#size-cells':

> > +    enum: [ 1, 2 ]

> > +

> > +  ranges: true

> > +

> > +required:

> > +  - compatible

> > +  - '#address-cells'

> > +  - '#size-cells'

> > +  - ranges

> > +

> > +additionalProperties: true

> > +

> > +examples:

> > +  - |

> > +    bus {

> > +        compatible = "fsl,spba-bus", "simple-bus";

> > +        #address-cells = <1>;

> > +        #size-cells = <1>;

> > +        ranges;

> > +    };

> > --

> > 2.25.1

> >
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml
new file mode 100644
index 000000000000..0a2add841145
--- /dev/null
+++ b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml
@@ -0,0 +1,56 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/bus/simple-pm-bus.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Shared Peripherals Bus Interface
+
+maintainers:
+  - Shawn Guo <shawnguo@kernel.org>
+
+description: |
+  A simple bus enabling access to shared peripherals.
+
+  The "spba-bus" follows the "simple-bus" set of properties, as
+  specified in the Devicetree Specification.  It is an extension of
+  "simple-bus" because the SDMA controller uses this compatible flag to
+  determine which peripherals are available to it and the range over which
+  the SDMA can access.  There are no special clocks for the bus, because
+  the SDMA controller itself has its interrupt, and clock assignments.
+
+properties:
+  $nodename:
+    pattern: "^bus(@[0-9a-f]+)?$"
+
+  compatible:
+    contains:
+      const: fsl,spba-bus
+    description:
+      Shall contain "fsl,spba-bus" in addition to "simple-bus"
+      compatible strings.
+
+  '#address-cells':
+    enum: [ 1, 2 ]
+
+  '#size-cells':
+    enum: [ 1, 2 ]
+
+  ranges: true
+
+required:
+  - compatible
+  - '#address-cells'
+  - '#size-cells'
+  - ranges
+
+additionalProperties: true
+
+examples:
+  - |
+    bus {
+        compatible = "fsl,spba-bus", "simple-bus";
+        #address-cells = <1>;
+        #size-cells = <1>;
+        ranges;
+    };