diff mbox series

[V5] dt-bindings: soc: imx: Add binding doc for spba bus

Message ID 20201118230414.121316-1-aford173@gmail.com
State Accepted
Commit c4cacb5b80f4f1d83b8bcd6e16672d6732982414
Headers show
Series [V5] dt-bindings: soc: imx: Add binding doc for spba bus | expand

Commit Message

Adam Ford Nov. 18, 2020, 11:04 p.m. UTC
Add binding doc for fsl,spba-bus.

Signed-off-by: Adam Ford <aford173@gmail.com>
---
make dt_binding_check -j8 |grep spba
  DTEX    Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dts
  DTC     Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dt.yaml
  CHECK   Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dt.yaml

V5:  Rebase on 5.10-rc2 to be able to check yaml
     Add Reg entry

V4:  Remove an accidental makefile change
     Move type:object under additional properties

V3:  Rebase sample from aips-bus example
     Split off from series adding i.MX8M Nano functions to reduce noise

V2:  Attempted to update yaml from feedback

Comments

Adam Ford Nov. 26, 2020, 1:50 p.m. UTC | #1
On Wed, Nov 18, 2020 at 5:04 PM Adam Ford <aford173@gmail.com> wrote:
>

> Add binding doc for fsl,spba-bus.

>

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


Rob,

Sorry to be a pest.  I have a series for the i.MX8M Nano that's
waiting on this.  Have you had time to review my latest attempt?

adam
> ---

> make dt_binding_check -j8 |grep spba

>   DTEX    Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dts

>   DTC     Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dt.yaml

>   CHECK   Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dt.yaml

>

> V5:  Rebase on 5.10-rc2 to be able to check yaml

>      Add Reg entry

>

> V4:  Remove an accidental makefile change

>      Move type:object under additional properties

>

> V3:  Rebase sample from aips-bus example

>      Split off from series adding i.MX8M Nano functions to reduce noise

>

> V2:  Attempted to update yaml from feedback

>

> 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..e9f77ecae3d3

> --- /dev/null

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

> @@ -0,0 +1,68 @@

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

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/bus/fsl,spba-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.

> +

> +select:

> +  properties:

> +    compatible:

> +      contains:

> +        const: fsl,spba-bus

> +  required:

> +    - compatible

> +

> +properties:

> +  $nodename:

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

> +

> +  compatible:

> +    items:

> +      - const: fsl,spba-bus

> +      - const: simple-bus

> +

> +  '#address-cells':

> +    enum: [ 1, 2 ]

> +

> +  '#size-cells':

> +    enum: [ 1, 2 ]

> +

> +  reg:

> +    maxItems: 1

> +

> +  ranges: true

> +

> +required:

> +  - compatible

> +  - '#address-cells'

> +  - '#size-cells'

> +  - reg

> +  - ranges

> +

> +additionalProperties:

> +  type: object

> +

> +examples:

> +  - |

> +    bus@30000000 {

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

> +        #address-cells = <1>;

> +        #size-cells = <1>;

> +        reg = <0x30000000 0x100000>;

> +        ranges;

> +    };

> --

> 2.25.1

>
Rob Herring Nov. 30, 2020, 10:02 p.m. UTC | #2
On Wed, 18 Nov 2020 17:04:14 -0600, Adam Ford wrote:
> Add binding doc for fsl,spba-bus.

> 

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

> ---

> make dt_binding_check -j8 |grep spba

>   DTEX    Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dts

>   DTC     Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dt.yaml

>   CHECK   Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dt.yaml

> 

> V5:  Rebase on 5.10-rc2 to be able to check yaml

>      Add Reg entry

> 

> V4:  Remove an accidental makefile change

>      Move type:object under additional properties

> 

> V3:  Rebase sample from aips-bus example

>      Split off from series adding i.MX8M Nano functions to reduce noise

> 

> V2:  Attempted to update yaml from feedback

> 


Applied, thanks!
Adam Ford April 1, 2021, 9:19 p.m. UTC | #3
On Mon, Nov 30, 2020 at 4:02 PM Rob Herring <robh@kernel.org> wrote:
>

> On Wed, 18 Nov 2020 17:04:14 -0600, Adam Ford wrote:

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

> >

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

> > ---

> > make dt_binding_check -j8 |grep spba

> >   DTEX    Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dts

> >   DTC     Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dt.yaml

> >   CHECK   Documentation/devicetree/bindings/bus/fsl,spba-bus.example.dt.yaml

> >

> > V5:  Rebase on 5.10-rc2 to be able to check yaml

> >      Add Reg entry

> >

> > V4:  Remove an accidental makefile change

> >      Move type:object under additional properties

> >

> > V3:  Rebase sample from aips-bus example

> >      Split off from series adding i.MX8M Nano functions to reduce noise

> >

> > V2:  Attempted to update yaml from feedback

> >

>

> Applied, thanks!


Rob,

I am not seeing this anywhere.  Can you tell me where this was
applied?  It's not appearing in Linux-next

adam
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..e9f77ecae3d3
--- /dev/null
+++ b/Documentation/devicetree/bindings/bus/fsl,spba-bus.yaml
@@ -0,0 +1,68 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/bus/fsl,spba-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.
+
+select:
+  properties:
+    compatible:
+      contains:
+        const: fsl,spba-bus
+  required:
+    - compatible
+
+properties:
+  $nodename:
+    pattern: "^bus(@[0-9a-f]+)?$"
+
+  compatible:
+    items:
+      - const: fsl,spba-bus
+      - const: simple-bus
+
+  '#address-cells':
+    enum: [ 1, 2 ]
+
+  '#size-cells':
+    enum: [ 1, 2 ]
+
+  reg:
+    maxItems: 1
+
+  ranges: true
+
+required:
+  - compatible
+  - '#address-cells'
+  - '#size-cells'
+  - reg
+  - ranges
+
+additionalProperties:
+  type: object
+
+examples:
+  - |
+    bus@30000000 {
+        compatible = "fsl,spba-bus", "simple-bus";
+        #address-cells = <1>;
+        #size-cells = <1>;
+        reg = <0x30000000 0x100000>;
+        ranges;
+    };