From: Conor Dooley <conor@kernel.org>
To: Durai Manickam KR <durai.manickamkr@microchip.com>
Cc: Vinod Koul <vkoul@kernel.org>, Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
Conor Dooley <conor+dt@kernel.org>,
Nicolas Ferre <nicolas.ferre@microchip.com>,
Alexandre Belloni <alexandre.belloni@bootlin.com>,
Claudiu Beznea <claudiu.beznea@tuxon.dev>,
dmaengine@vger.kernel.org, devicetree@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] dt-bindings: dma: convert atmel-xdma.txt to YAML
Date: Thu, 15 Feb 2024 19:34:39 +0000 [thread overview]
Message-ID: <20240215-snowstorm-quack-fdb7f9c35c2e@spud> (raw)
In-Reply-To: <20240215-xdma-v1-1-1139960cf096@microchip.com>
[-- Attachment #1: Type: text/plain, Size: 6228 bytes --]
On Thu, Feb 15, 2024 at 04:25:15PM +0530, Durai Manickam KR wrote:
> Added a description, required properties and appropriate compatibles
> for all the SoCs that are supported by microchip for the XDMAC.
>
> Signed-off-by: Durai Manickam KR <durai.manickamkr@microchip.com>
> ---
> .../devicetree/bindings/dma/atmel-xdma.txt | 54 ---------------
> .../bindings/dma/microchip,at91-xdma.yaml | 77 ++++++++++++++++++++++
> 2 files changed, 77 insertions(+), 54 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/dma/atmel-xdma.txt b/Documentation/devicetree/bindings/dma/atmel-xdma.txt
> deleted file mode 100644
> index 76d649b3a25d..000000000000
> --- a/Documentation/devicetree/bindings/dma/atmel-xdma.txt
> +++ /dev/null
> @@ -1,54 +0,0 @@
> -* Atmel Extensible Direct Memory Access Controller (XDMAC)
> -
> -* XDMA Controller
> -- interrupts: Should contain DMA interrupt.
> -- #dma-cells: Must be <1>, used to represent the number of integer cells in
> -the dmas property of client devices.
> - - The 1st cell specifies the channel configuration register:
> - - bit 13: SIF, source interface identifier, used to get the memory
> - interface identifier,
> - - bit 14: DIF, destination interface identifier, used to get the peripheral
> - interface identifier,
> - - bit 30-24: PERID, peripheral identifier.
> -
> -Example:
> -
> -dma1: dma-controller@f0004000 {
> - compatible = "atmel,sama5d4-dma";
> - reg = <0xf0004000 0x200>;
> - interrupts = <50 4 0>;
> - #dma-cells = <1>;
> -};
> -
> -
> -* DMA clients
> -DMA clients connected to the Atmel XDMA controller must use the format
> -described in the dma.txt file, using a one-cell specifier for each channel.
> -The two cells in order are:
> -1. A phandle pointing to the DMA controller.
> -2. Channel configuration register. Configurable fields are:
> - - bit 13: SIF, source interface identifier, used to get the memory
> - interface identifier,
> - - bit 14: DIF, destination interface identifier, used to get the peripheral
> - interface identifier,
> - - bit 30-24: PERID, peripheral identifier.
> -
> -Example:
> -
> -i2c2: i2c@f8024000 {
> - compatible = "atmel,at91sam9x5-i2c";
> - reg = <0xf8024000 0x4000>;
> - interrupts = <34 4 6>;
> - dmas = <&dma1
> - (AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)
> - | AT91_XDMAC_DT_PERID(6))>,
> - <&dma1
> - (AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)
> - | AT91_XDMAC_DT_PERID(7))>;
> - dma-names = "tx", "rx";
> -};
> diff --git a/Documentation/devicetree/bindings/dma/microchip,at91-xdma.yaml b/Documentation/devicetree/bindings/dma/microchip,at91-xdma.yaml
> new file mode 100644
> index 000000000000..0bd79c7b5e6f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/dma/microchip,at91-xdma.yaml
> @@ -0,0 +1,77 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/dma/microchip,at91-xdma.yaml#
Filename matching a compatible please.
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Atmel Extensible Direct Memory Access Controller (XDMAC)
> +
> +maintainers:
> + - Durai Manickam KR <durai.manickamkr@microchip.com>
> +
> +description: |
The | is not needed, you've no formatting to preserve.
> + The Atmel Extensible Direct Memory Access Controller (XDMAC) performs peripheral
> + data transfer and memory move operations over one or two bus ports through the
> + unidirectional communication channel. Each channel is fully programmable and
> + provides both peripheral or memory-to-memory transfers.
> +
> +properties:
> + compatible:
> + oneOf:
> + - enum:
> + - atmel,sama5d4-dma
> + - microchip,sama7g5-dma
> + - microchip,sam9x7-dma
The text binding says:
> -- compatible: Should be "atmel,sama5d4-dma", "microchip,sam9x60-dma" or
> - "microchip,sama7g5-dma" or
> - "microchip,sam9x7-dma", "atmel,sama5d4-dma".
That's not what you have here at all.
> + - items:
> + - const: atmel,sama5d4-dma
> + - const: microchip,sam9x60-dma
This looks backwards.
> + reg:
> + description: Should contain DMA registers location and length.
> + maxItems: 1
Same comments here about descriptions for well known properties as the
other DMA controller.
> +
> + interrupts:
> + description: Should contain the DMA interrupts associated to the DMA channels.
> + maxItems: 1
> +
> + "#dma-cells":
> + description: |
> + Must be <1>, used to represent the number of integer cells in the dmas
> + property of client device.
> + -The 1st cell specifies the channel configuration register:
> + -bit 13: SIF, source interface identifier, used to get the memory
> + interface identifier,
> + -bit 14: DIF, destination interface identifier, used to get the peripheral
> + interface identifier,
> + -bit 30-24: PERID, peripheral identifier.
> + const: 1
> +
> + clocks:
> + description: Should contain a clock specifier for each entry in clock-names.
> + maxItems: 1
And here about adding properties. Please explain in your commit message
where the new properties came from.
> +
> + clock-names:
> + description: Should contain the clock of the DMA controller.
> + const: dma_clk
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - "#dma-cells"
> + - clocks
> + - clock-names
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + dma0: dma-controller@f0004000 {
And same here about the label :)
Cheers,
Conor.
> + compatible = "atmel,sama5d4-dma";
> + reg = <0xffffec00 0x200>;
> + interrupts = <50 4 0>;
> + #dma-cells = <1>;
> + clocks = <&pmc 2 20>;
> + clock-names = "dma_clk";
> + };
> +
> +...
>
> ---
> base-commit: 8d3dea210042f54b952b481838c1e7dfc4ec751d
> change-id: 20240215-xdma-36e8bdbf8141
>
> Best regards,
> --
> Durai Manickam KR <durai.manickamkr@microchip.com>
>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
prev parent reply other threads:[~2024-02-15 19:34 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-15 10:55 [PATCH] dt-bindings: dma: convert atmel-xdma.txt to YAML Durai Manickam KR
2024-02-15 19:34 ` Conor Dooley [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240215-snowstorm-quack-fdb7f9c35c2e@spud \
--to=conor@kernel.org \
--cc=alexandre.belloni@bootlin.com \
--cc=claudiu.beznea@tuxon.dev \
--cc=conor+dt@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=dmaengine@vger.kernel.org \
--cc=durai.manickamkr@microchip.com \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nicolas.ferre@microchip.com \
--cc=robh+dt@kernel.org \
--cc=vkoul@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 read-only IMAP folder(s) and NNTP newsgroup(s).