[v5,1/2] dt-bindings: dma: Add Loongson-1 DMA

Commit Message

Keguang Zhang Sept. 28, 2023, 12:19 p.m. UTC

Add devicetree binding document for Loongson-1 DMA.

Signed-off-by: Keguang Zhang <[e-mail]>
---
V4 -> V5:
   A newly added patch

 .../bindings/dma/loongson,ls1x-dma.yaml       | 64 +++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml

Comments

Conor Dooley Sept. 28, 2023, 4:42 p.m. UTC | #1

Hey,

On Thu, Sep 28, 2023 at 08:19:52PM +0800, Keguang Zhang wrote:
> Add devicetree binding document for Loongson-1 DMA.
> 
> Signed-off-by: Keguang Zhang <[e-mail]>
> ---
> V4 -> V5:
>    A newly added patch
> 
>  .../bindings/dma/loongson,ls1x-dma.yaml       | 64 +++++++++++++++++++
>  1 file changed, 64 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
> 
> diff --git a/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml b/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
> new file mode 100644
> index 000000000000..51b45d998a58
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
> @@ -0,0 +1,64 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/dma/loongson,ls1x-dma.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Loongson-1 DMA Controller
> +
> +maintainers:
> +  - Keguang Zhang <[e-mail]>
> +
> +description: |

This | isn't required as you have no formatting to preserve here.

> +  Loongson-1 DMA controller provides 3 independent channels for
> +  peripherals such as NAND and AC97.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - loongson,ls1b-dma
> +      - loongson,ls1c-dma

From a skim of the driver, these two devices seem to be compatible,
and therefore one should fall back to the other.

> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    description: Each channel has a dedicated interrupt line.
> +    minItems: 1
> +    maxItems: 3
> +
> +  interrupt-names:
> +    minItems: 1
> +    items:
> +      - pattern: ch0
> +      - pattern: ch1
> +      - pattern: ch2
> +
> +  '#dma-cells':
> +    description: The single cell represents the channel index.

This description is unnecessary.

> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - interrupt-names
> +  - '#dma-cells'
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    dma: dma-controller@1fd01160 {

This label is unused.

> +        compatible = "loongson,ls1b-dma";
> +        reg = <0x1fd01160 0x18>;
> +
> +        interrupt-parent = <&intc0>;
> +        interrupts = <13 IRQ_TYPE_EDGE_RISING>,
> +        	     <14 IRQ_TYPE_EDGE_RISING>,
> +        	     <15 IRQ_TYPE_EDGE_RISING>;

Odd mixed indentation here. Bindings use spaces only.

Thanks,
Conor.

> +        interrupt-names = "ch0", "ch1", "ch2";
> +
> +        #dma-cells = <1>;
> +    };
> -- 
> 2.39.2
>

Keguang Zhang Oct. 7, 2023, 5:45 a.m. UTC | #2

On Fri, Sep 29, 2023 at 12:42 AM Conor Dooley <[e-mail]> wrote:
>
> Hey,
>
> On Thu, Sep 28, 2023 at 08:19:52PM +0800, Keguang Zhang wrote:
> > Add devicetree binding document for Loongson-1 DMA.
> >
> > Signed-off-by: Keguang Zhang <[e-mail]>
> > ---
> > V4 -> V5:
> >    A newly added patch
> >
> >  .../bindings/dma/loongson,ls1x-dma.yaml       | 64 +++++++++++++++++++
> >  1 file changed, 64 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml b/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
> > new file mode 100644
> > index 000000000000..51b45d998a58
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
> > @@ -0,0 +1,64 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/dma/loongson,ls1x-dma.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Loongson-1 DMA Controller
> > +
> > +maintainers:
> > +  - Keguang Zhang <[e-mail]>
> > +
> > +description: |
>
> This | isn't required as you have no formatting to preserve here.
>
Will remove '|'.

> > +  Loongson-1 DMA controller provides 3 independent channels for
> > +  peripherals such as NAND and AC97.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - loongson,ls1b-dma
> > +      - loongson,ls1c-dma
>
> From a skim of the driver, these two devices seem to be compatible,
> and therefore one should fall back to the other.
>
Got it. How about changing to one const?
  compatible:
    const: loongson,ls1-dma

> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    description: Each channel has a dedicated interrupt line.
> > +    minItems: 1
> > +    maxItems: 3
> > +
> > +  interrupt-names:
> > +    minItems: 1
> > +    items:
> > +      - pattern: ch0
> > +      - pattern: ch1
> > +      - pattern: ch2
> > +
> > +  '#dma-cells':
> > +    description: The single cell represents the channel index.
>
> This description is unnecessary.
>
Will delete the description.

> > +    const: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - interrupt-names
> > +  - '#dma-cells'
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> > +    dma: dma-controller@1fd01160 {
>
> This label is unused.
>
Will delete the lablel.

> > +        compatible = "loongson,ls1b-dma";
> > +        reg = <0x1fd01160 0x18>;
> > +
> > +        interrupt-parent = <&intc0>;
> > +        interrupts = <13 IRQ_TYPE_EDGE_RISING>,
> > +                  <14 IRQ_TYPE_EDGE_RISING>,
> > +                  <15 IRQ_TYPE_EDGE_RISING>;
>
> Odd mixed indentation here. Bindings use spaces only.
>
Will fix the indentation.

> Thanks,
> Conor.
>
> > +        interrupt-names = "ch0", "ch1", "ch2";
> > +
> > +        #dma-cells = <1>;
> > +    };
> > --
> > 2.39.2
> >



--
Best regards,

Keguang Zhang

Conor Dooley Oct. 7, 2023, 10:34 a.m. UTC | #3

On Sat, Oct 07, 2023 at 01:45:23PM +0800, Keguang Zhang wrote:
> On Fri, Sep 29, 2023 at 12:42 AM Conor Dooley <[e-mail]> wrote:
> >
> > Hey,
> >
> > On Thu, Sep 28, 2023 at 08:19:52PM +0800, Keguang Zhang wrote:
> > > Add devicetree binding document for Loongson-1 DMA.
> > >
> > > Signed-off-by: Keguang Zhang <[e-mail]>
> > > ---
> > > V4 -> V5:
> > >    A newly added patch
> > >
> > >  .../bindings/dma/loongson,ls1x-dma.yaml       | 64 +++++++++++++++++++
> > >  1 file changed, 64 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
> > >
> > > diff --git a/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml b/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
> > > new file mode 100644
> > > index 000000000000..51b45d998a58
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
> > > @@ -0,0 +1,64 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/dma/loongson,ls1x-dma.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Loongson-1 DMA Controller
> > > +
> > > +maintainers:
> > > +  - Keguang Zhang <[e-mail]>
> > > +
> > > +description: |
> >
> > This | isn't required as you have no formatting to preserve here.
> >
> Will remove '|'.
> 
> > > +  Loongson-1 DMA controller provides 3 independent channels for
> > > +  peripherals such as NAND and AC97.
> > > +
> > > +properties:
> > > +  compatible:
> > > +    enum:
> > > +      - loongson,ls1b-dma
> > > +      - loongson,ls1c-dma
> >
> > From a skim of the driver, these two devices seem to be compatible,
> > and therefore one should fall back to the other.
> >
> Got it. How about changing to one const?
>   compatible:
>     const: loongson,ls1-dma

No, keep the compatibles you have & set up a fallback please.
Too many of these loongson bindings have got in with overly generic
compatibles...

Krzysztof Kozlowski Oct. 8, 2023, 11:15 a.m. UTC | #4

On 07/10/2023 07:45, Keguang Zhang wrote:

> 
>>> +  Loongson-1 DMA controller provides 3 independent channels for
>>> +  peripherals such as NAND and AC97.
>>> +
>>> +properties:
>>> +  compatible:
>>> +    enum:
>>> +      - loongson,ls1b-dma
>>> +      - loongson,ls1c-dma
>>
>> From a skim of the driver, these two devices seem to be compatible,
>> and therefore one should fall back to the other.
>>
> Got it. How about changing to one const?
>   compatible:
>     const: loongson,ls1-dma

No, because there is no fallback here.


Best regards,
Krzysztof

Patch

diff --git a/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml b/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
new file mode 100644
index 000000000000..51b45d998a58
--- /dev/null
+++ b/Documentation/devicetree/bindings/dma/loongson,ls1x-dma.yaml
@@ -0,0 +1,64 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/dma/loongson,ls1x-dma.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Loongson-1 DMA Controller
+
+maintainers:
+  - Keguang Zhang <[e-mail]>
+
+description: |
+  Loongson-1 DMA controller provides 3 independent channels for
+  peripherals such as NAND and AC97.
+
+properties:
+  compatible:
+    enum:
+      - loongson,ls1b-dma
+      - loongson,ls1c-dma
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    description: Each channel has a dedicated interrupt line.
+    minItems: 1
+    maxItems: 3
+
+  interrupt-names:
+    minItems: 1
+    items:
+      - pattern: ch0
+      - pattern: ch1
+      - pattern: ch2
+
+  '#dma-cells':
+    description: The single cell represents the channel index.
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - interrupt-names
+  - '#dma-cells'
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    dma: dma-controller@1fd01160 {
+        compatible = "loongson,ls1b-dma";
+        reg = <0x1fd01160 0x18>;
+
+        interrupt-parent = <&intc0>;
+        interrupts = <13 IRQ_TYPE_EDGE_RISING>,
+        	     <14 IRQ_TYPE_EDGE_RISING>,
+        	     <15 IRQ_TYPE_EDGE_RISING>;
+        interrupt-names = "ch0", "ch1", "ch2";
+
+        #dma-cells = <1>;
+    };