diff mbox series

[v4,1/2] dt-bindings: dma: add schema for altr,msgdma

Message ID YIq/qObuYw+8ikxg@orolia.com (mailing list archive)
State Changes Requested
Headers show
Series [v4,1/2] dt-bindings: dma: add schema for altr,msgdma | expand

Commit Message

Olivier Dautricourt April 29, 2021, 2:16 p.m. UTC 
- add schema for Altera mSGDMA bindings in devicetree.
- add myself as 'Odd fixes' maintainer for this driver

Signed-off-by: Olivier Dautricourt <olivier.dautricourt@orolia.com>
---

Notes:
    Changes in v2:
     - fix reg size in dt example
     - fix dt_binding check warning
     - add list in MAINTAINERS entry

    Changes from v2 to v3:
     none

    Changes from v3 to v4:
     none

 .../devicetree/bindings/dma/altr,msgdma.yaml  | 62 +++++++++++++++++++
 MAINTAINERS                                   |  7 +++
 2 files changed, 69 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/dma/altr,msgdma.yaml

--
2.31.0.rc2

Comments

Stefan Roese April 30, 2021, 8:55 a.m. UTC | #1 
On 29.04.21 16:16, Olivier Dautricourt wrote:
> - add schema for Altera mSGDMA bindings in devicetree.
> - add myself as 'Odd fixes' maintainer for this driver
> 
> Signed-off-by: Olivier Dautricourt <olivier.dautricourt@orolia.com>

Reviewed-by: Stefan Roese <sr@denx.de>

Thanks,
Stefan

> ---
> 
> Notes:
>      Changes in v2:
>       - fix reg size in dt example
>       - fix dt_binding check warning
>       - add list in MAINTAINERS entry
> 
>      Changes from v2 to v3:
>       none
> 
>      Changes from v3 to v4:
>       none
> 
>   .../devicetree/bindings/dma/altr,msgdma.yaml  | 62 +++++++++++++++++++
>   MAINTAINERS                                   |  7 +++
>   2 files changed, 69 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> 
> diff --git a/Documentation/devicetree/bindings/dma/altr,msgdma.yaml b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> new file mode 100644
> index 000000000000..295e46c84bf9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> @@ -0,0 +1,62 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/dma/altr,msgdma.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Altera mSGDMA IP core
> +
> +maintainers:
> +  - Olivier Dautricourt <olivier.dautricourt@orolia.com>
> +
> +description: |
> +  Altera / Intel modular Scatter-Gather Direct Memory Access (mSGDMA)
> +  intellectual property (IP)
> +
> +allOf:
> +  - $ref: "dma-controller.yaml#"
> +
> +properties:
> +  compatible:
> +    const: altr,msgdma
> +
> +  reg:
> +    description:
> +      csr, desc, resp resgisters
> +    maxItems: 3
> +    minItems: 3
> +
> +  reg-names:
> +    items:
> +      - const: csr
> +      - const: desc
> +      - const: resp
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  "#dma-cells":
> +    description: |
> +      The dma controller discards the argument but one must be specified
> +      to keep compatibility with dma-controller schema.
> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - reg-names
> +  - interrupts
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    msgdma_controller: dma-controller@ff200b00 {
> +        compatible = "altr,msgdma";
> +        reg = <0xff200b00 0x100>, <0xff200c00 0x100>, <0xff200d00 0x100>;
> +        reg-names = "csr", "desc", "resp";
> +        interrupts = <0 67 IRQ_TYPE_LEVEL_HIGH>;
> +        #dma-cells = <1>;
> +    };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 5c90148f0369..359ab4877024 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -782,6 +782,13 @@ M:	Ley Foon Tan <ley.foon.tan@intel.com>
>   S:	Maintained
>   F:	drivers/mailbox/mailbox-altera.c
> 
> +ALTERA MSGDMA IP CORE DRIVER
> +M:	Olivier Dautricourt <olivier.dautricourt@orolia.com>
> +L:	dmaengine@vger.kernel.org
> +S:	Odd Fixes
> +F:	Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> +F:	drivers/dma/altera-msgdma.c
> +
>   ALTERA PIO DRIVER
>   M:	Joyce Ooi <joyce.ooi@intel.com>
>   L:	linux-gpio@vger.kernel.org
> --
> 2.31.0.rc2
> 


Viele Grüße,
Stefan
Rob Herring May 3, 2021, 10:06 p.m. UTC | #2 
On Thu, Apr 29, 2021 at 9:16 AM Olivier Dautricourt
<olivier.dautricourt@orolia.com> wrote:
>
> - add schema for Altera mSGDMA bindings in devicetree.
> - add myself as 'Odd fixes' maintainer for this driver

While I guess valid, the tools (b4) don't like the '/' in your
message-id. Lore will escape it fine, but then you have to escape the
url. Would be nice to avoid all that, but maybe this is Exchange's
doing?

> Signed-off-by: Olivier Dautricourt <olivier.dautricourt@orolia.com>
> ---
>
> Notes:
>     Changes in v2:
>      - fix reg size in dt example
>      - fix dt_binding check warning
>      - add list in MAINTAINERS entry
>
>     Changes from v2 to v3:
>      none
>
>     Changes from v3 to v4:
>      none
>
>  .../devicetree/bindings/dma/altr,msgdma.yaml  | 62 +++++++++++++++++++
>  MAINTAINERS                                   |  7 +++
>  2 files changed, 69 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/dma/altr,msgdma.yaml
>
> diff --git a/Documentation/devicetree/bindings/dma/altr,msgdma.yaml b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> new file mode 100644
> index 000000000000..295e46c84bf9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> @@ -0,0 +1,62 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/dma/altr,msgdma.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Altera mSGDMA IP core
> +
> +maintainers:
> +  - Olivier Dautricourt <olivier.dautricourt@orolia.com>
> +
> +description: |
> +  Altera / Intel modular Scatter-Gather Direct Memory Access (mSGDMA)
> +  intellectual property (IP)
> +
> +allOf:
> +  - $ref: "dma-controller.yaml#"
> +
> +properties:
> +  compatible:
> +    const: altr,msgdma

Needs an SoC specific compatible.

> +
> +  reg:
> +    description:
> +      csr, desc, resp resgisters

Expand what each region is:

reg:
  items:
    - description: ...
    - description: ...
    - description: ...

> +    maxItems: 3
> +    minItems: 3

And then drop this.

> +
> +  reg-names:
> +    items:
> +      - const: csr
> +      - const: desc
> +      - const: resp
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  "#dma-cells":
> +    description: |
> +      The dma controller discards the argument but one must be specified
> +      to keep compatibility with dma-controller schema.
> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - reg-names
> +  - interrupts
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    msgdma_controller: dma-controller@ff200b00 {
> +        compatible = "altr,msgdma";
> +        reg = <0xff200b00 0x100>, <0xff200c00 0x100>, <0xff200d00 0x100>;
> +        reg-names = "csr", "desc", "resp";
> +        interrupts = <0 67 IRQ_TYPE_LEVEL_HIGH>;
> +        #dma-cells = <1>;
> +    };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 5c90148f0369..359ab4877024 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -782,6 +782,13 @@ M: Ley Foon Tan <ley.foon.tan@intel.com>
>  S:     Maintained
>  F:     drivers/mailbox/mailbox-altera.c
>
> +ALTERA MSGDMA IP CORE DRIVER
> +M:     Olivier Dautricourt <olivier.dautricourt@orolia.com>
> +L:     dmaengine@vger.kernel.org
> +S:     Odd Fixes
> +F:     Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> +F:     drivers/dma/altera-msgdma.c
> +
>  ALTERA PIO DRIVER
>  M:     Joyce Ooi <joyce.ooi@intel.com>
>  L:     linux-gpio@vger.kernel.org
> --
> 2.31.0.rc2
>
Olivier Dautricourt May 4, 2021, 1:50 p.m. UTC | #3 
Hello Rob,

The 05/03/2021 17:06, Rob Herring wrote:
> On Thu, Apr 29, 2021 at 9:16 AM Olivier Dautricourt
> <olivier.dautricourt@orolia.com> wrote:
> >
> > - add schema for Altera mSGDMA bindings in devicetree.
> > - add myself as 'Odd fixes' maintainer for this driver
>
> While I guess valid, the tools (b4) don't like the '/' in your
> message-id. Lore will escape it fine, but then you have to escape the
> url. Would be nice to avoid all that, but maybe this is Exchange's
> doing?

Yes it must be Exchange's doing, i'm not sure if i can
configure this but i'll check.. Thanks for noticing.

> > Signed-off-by: Olivier Dautricourt <olivier.dautricourt@orolia.com>
> > ---
> >
> > Notes:
> >     Changes in v2:
> >      - fix reg size in dt example
> >      - fix dt_binding check warning
> >      - add list in MAINTAINERS entry
> >
> >     Changes from v2 to v3:
> >      none
> >
> >     Changes from v3 to v4:
> >      none
> >
> >  .../devicetree/bindings/dma/altr,msgdma.yaml  | 62 +++++++++++++++++++
> >  MAINTAINERS                                   |  7 +++
> >  2 files changed, 69 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/dma/altr,msgdma.yaml b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> > new file mode 100644
> > index 000000000000..295e46c84bf9
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> > @@ -0,0 +1,62 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/dma/altr,msgdma.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Altera mSGDMA IP core
> > +
> > +maintainers:
> > +  - Olivier Dautricourt <olivier.dautricourt@orolia.com>
> > +
> > +description: |
> > +  Altera / Intel modular Scatter-Gather Direct Memory Access (mSGDMA)
> > +  intellectual property (IP)
> > +
> > +allOf:
> > +  - $ref: "dma-controller.yaml#"
> > +
> > +properties:
> > +  compatible:
> > +    const: altr,msgdma
>
> Needs an SoC specific compatible.
>

It should be compatible with altera's socfpga family.
Should i leave a general compatible field such as "altr,msgdma" ?

example:
  compatible:
    enum:
      - altr,socfpga-msgdma
      - altr,msgdma


Thanks,

Olivier
Vinod Koul May 10, 2021, 4:14 p.m. UTC | #4 
On 29-04-21, 16:16, Olivier Dautricourt wrote:
> - add schema for Altera mSGDMA bindings in devicetree.
> - add myself as 'Odd fixes' maintainer for this driver

These should be two separate patches... Also threading in your patches
in broken and the 2/2 patch doesnt appear along with this in thread, pls
fix that as well

> 
> Signed-off-by: Olivier Dautricourt <olivier.dautricourt@orolia.com>
> ---
> 
> Notes:
>     Changes in v2:
>      - fix reg size in dt example
>      - fix dt_binding check warning
>      - add list in MAINTAINERS entry
> 
>     Changes from v2 to v3:
>      none
> 
>     Changes from v3 to v4:
>      none
> 
>  .../devicetree/bindings/dma/altr,msgdma.yaml  | 62 +++++++++++++++++++
>  MAINTAINERS                                   |  7 +++
>  2 files changed, 69 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> 
> diff --git a/Documentation/devicetree/bindings/dma/altr,msgdma.yaml b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> new file mode 100644
> index 000000000000..295e46c84bf9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> @@ -0,0 +1,62 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/dma/altr,msgdma.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Altera mSGDMA IP core
> +
> +maintainers:
> +  - Olivier Dautricourt <olivier.dautricourt@orolia.com>
> +
> +description: |
> +  Altera / Intel modular Scatter-Gather Direct Memory Access (mSGDMA)
> +  intellectual property (IP)
> +
> +allOf:
> +  - $ref: "dma-controller.yaml#"
> +
> +properties:
> +  compatible:
> +    const: altr,msgdma
> +
> +  reg:
> +    description:
> +      csr, desc, resp resgisters
> +    maxItems: 3
> +    minItems: 3
> +
> +  reg-names:
> +    items:
> +      - const: csr
> +      - const: desc
> +      - const: resp
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  "#dma-cells":
> +    description: |
> +      The dma controller discards the argument but one must be specified
> +      to keep compatibility with dma-controller schema.

we can skip this

> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - reg-names
> +  - interrupts
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    msgdma_controller: dma-controller@ff200b00 {
> +        compatible = "altr,msgdma";
> +        reg = <0xff200b00 0x100>, <0xff200c00 0x100>, <0xff200d00 0x100>;
> +        reg-names = "csr", "desc", "resp";
> +        interrupts = <0 67 IRQ_TYPE_LEVEL_HIGH>;
> +        #dma-cells = <1>;
> +    };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 5c90148f0369..359ab4877024 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -782,6 +782,13 @@ M:	Ley Foon Tan <ley.foon.tan@intel.com>
>  S:	Maintained
>  F:	drivers/mailbox/mailbox-altera.c
> 
> +ALTERA MSGDMA IP CORE DRIVER
> +M:	Olivier Dautricourt <olivier.dautricourt@orolia.com>
> +L:	dmaengine@vger.kernel.org
> +S:	Odd Fixes
> +F:	Documentation/devicetree/bindings/dma/altr,msgdma.yaml
> +F:	drivers/dma/altera-msgdma.c
> +
>  ALTERA PIO DRIVER
>  M:	Joyce Ooi <joyce.ooi@intel.com>
>  L:	linux-gpio@vger.kernel.org
> --
> 2.31.0.rc2
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/dma/altr,msgdma.yaml b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
new file mode 100644
index 000000000000..295e46c84bf9
--- /dev/null
+++ b/Documentation/devicetree/bindings/dma/altr,msgdma.yaml
@@ -0,0 +1,62 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/dma/altr,msgdma.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Altera mSGDMA IP core
+
+maintainers:
+  - Olivier Dautricourt <olivier.dautricourt@orolia.com>
+
+description: |
+  Altera / Intel modular Scatter-Gather Direct Memory Access (mSGDMA)
+  intellectual property (IP)
+
+allOf:
+  - $ref: "dma-controller.yaml#"
+
+properties:
+  compatible:
+    const: altr,msgdma
+
+  reg:
+    description:
+      csr, desc, resp resgisters
+    maxItems: 3
+    minItems: 3
+
+  reg-names:
+    items:
+      - const: csr
+      - const: desc
+      - const: resp
+
+  interrupts:
+    maxItems: 1
+
+  "#dma-cells":
+    description: |
+      The dma controller discards the argument but one must be specified
+      to keep compatibility with dma-controller schema.
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - interrupts
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    msgdma_controller: dma-controller@ff200b00 {
+        compatible = "altr,msgdma";
+        reg = <0xff200b00 0x100>, <0xff200c00 0x100>, <0xff200d00 0x100>;
+        reg-names = "csr", "desc", "resp";
+        interrupts = <0 67 IRQ_TYPE_LEVEL_HIGH>;
+        #dma-cells = <1>;
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index 5c90148f0369..359ab4877024 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -782,6 +782,13 @@  M:	Ley Foon Tan <ley.foon.tan@intel.com>
 S:	Maintained
 F:	drivers/mailbox/mailbox-altera.c

+ALTERA MSGDMA IP CORE DRIVER
+M:	Olivier Dautricourt <olivier.dautricourt@orolia.com>
+L:	dmaengine@vger.kernel.org
+S:	Odd Fixes
+F:	Documentation/devicetree/bindings/dma/altr,msgdma.yaml
+F:	drivers/dma/altera-msgdma.c
+
 ALTERA PIO DRIVER
 M:	Joyce Ooi <joyce.ooi@intel.com>
 L:	linux-gpio@vger.kernel.org