diff mbox

[v3,2/2] dmaengine: add device tree binding documentation for the nbpfaxi driver

Message ID Pine.LNX.4.64.1405101809380.30489@axis700.grange
State Accepted, archived
Commit 94c7b6fc7cd1b29d987592ce7eecd902f6728db4
Headers show

Commit Message

Guennadi Liakhovetski May 10, 2014, 4:11 p.m. UTC
The nbpfaxi dmaengine driver doesn't define any new bindings, it only
uses standard dmaengine bindings and defines 3 flags for the 3rd parameter
of the "dmas" property.

Signed-off-by: Guennadi Liakhovetski <g.liakhovetski+renesas@gmail.com>
---

v3: split out from v2, no changes otherwise

 Documentation/devicetree/bindings/dma/nbpfaxi.txt | 61 +++++++++++++++++++++++
 include/dt-bindings/dma/nbpfaxi.h                 | 20 ++++++++
 2 files changed, 81 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/dma/nbpfaxi.txt
 create mode 100644 include/dt-bindings/dma/nbpfaxi.h

Comments

Guennadi Liakhovetski May 30, 2014, 1:57 p.m. UTC | #1
Grant, Rob,

Could you, guys, have a look at this, please? No new bindings are added, 
so, it should be a matter of 5 minutes looking over the patch. Would be a 
pity if because of these 5 minutes a new driver gets delayed until the new 
kernel version.

Thanks
Guennadi

On Sat, 10 May 2014, Guennadi Liakhovetski wrote:

> The nbpfaxi dmaengine driver doesn't define any new bindings, it only
> uses standard dmaengine bindings and defines 3 flags for the 3rd parameter
> of the "dmas" property.
> 
> Signed-off-by: Guennadi Liakhovetski <g.liakhovetski+renesas@gmail.com>
> ---
> 
> v3: split out from v2, no changes otherwise
> 
>  Documentation/devicetree/bindings/dma/nbpfaxi.txt | 61 +++++++++++++++++++++++
>  include/dt-bindings/dma/nbpfaxi.h                 | 20 ++++++++
>  2 files changed, 81 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/dma/nbpfaxi.txt
>  create mode 100644 include/dt-bindings/dma/nbpfaxi.h
> 
> diff --git a/Documentation/devicetree/bindings/dma/nbpfaxi.txt b/Documentation/devicetree/bindings/dma/nbpfaxi.txt
> new file mode 100644
> index 0000000..d5e2522
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/dma/nbpfaxi.txt
> @@ -0,0 +1,61 @@
> +* Renesas "Type-AXI" NBPFAXI* DMA controllers
> +
> +* DMA controller
> +
> +Required properties
> +
> +- compatible:	must be one of
> +		"renesas,nbpfaxi64dmac1b4"
> +		"renesas,nbpfaxi64dmac1b8"
> +		"renesas,nbpfaxi64dmac1b16"
> +		"renesas,nbpfaxi64dmac4b4"
> +		"renesas,nbpfaxi64dmac4b8"
> +		"renesas,nbpfaxi64dmac4b16"
> +		"renesas,nbpfaxi64dmac8b4"
> +		"renesas,nbpfaxi64dmac8b8"
> +		"renesas,nbpfaxi64dmac8b16"
> +- #dma-cells:	must be 2: the first integer is a terminal number, to which this
> +		slave is connected, the second one is flags. Flags is a bitmask
> +		with the following bits defined:
> +
> +#define NBPF_SLAVE_RQ_HIGH	1
> +#define NBPF_SLAVE_RQ_LOW	2
> +#define NBPF_SLAVE_RQ_LEVEL	4
> +
> +Optional properties:
> +
> +You can use dma-channels and dma-requests as described in dma.txt, although they
> +won't be used, this information is derived from the compatibility string.
> +
> +Example:
> +
> +	dma: dma-controller@48000000 {
> +		compatible = "renesas,nbpfaxi64dmac8b4";
> +		reg = <0x48000000 0x400>;
> +		interrupts = <0 12 0x4
> +			      0 13 0x4
> +			      0 14 0x4
> +			      0 15 0x4
> +			      0 16 0x4
> +			      0 17 0x4
> +			      0 18 0x4
> +			      0 19 0x4>;
> +		#dma-cells = <2>;
> +		dma-channels = <8>;
> +		dma-requests = <8>;
> +	};
> +
> +* DMA client
> +
> +Required properties:
> +
> +dmas and dma-names are required, as described in dma.txt.
> +
> +Example:
> +
> +#include <dt-bindings/dma/nbpfaxi.h>
> +
> +...
> +		dmas = <&dma 0 (NBPF_SLAVE_RQ_HIGH | NBPF_SLAVE_RQ_LEVEL)
> +			&dma 1 (NBPF_SLAVE_RQ_HIGH | NBPF_SLAVE_RQ_LEVEL)>;
> +		dma-names = "rx", "tx";
> diff --git a/include/dt-bindings/dma/nbpfaxi.h b/include/dt-bindings/dma/nbpfaxi.h
> new file mode 100644
> index 0000000..c1a5b9e
> --- /dev/null
> +++ b/include/dt-bindings/dma/nbpfaxi.h
> @@ -0,0 +1,20 @@
> +/*
> + * Copyright (C) 2013-2014 Renesas Electronics Europe Ltd.
> + * Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of version 2 of the GNU General Public License as
> + * published by the Free Software Foundation.
> + */
> +
> +#ifndef DT_BINDINGS_NBPFAXI_H
> +#define DT_BINDINGS_NBPFAXI_H
> +
> +/**
> + * Use "#dma-cells = <2>;" with the second integer defining slave DMA flags:
> + */
> +#define NBPF_SLAVE_RQ_HIGH	1
> +#define NBPF_SLAVE_RQ_LOW	2
> +#define NBPF_SLAVE_RQ_LEVEL	4
> +
> +#endif
> -- 
> 2.0.0.rc0
> 
> 
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/dma/nbpfaxi.txt b/Documentation/devicetree/bindings/dma/nbpfaxi.txt
new file mode 100644
index 0000000..d5e2522
--- /dev/null
+++ b/Documentation/devicetree/bindings/dma/nbpfaxi.txt
@@ -0,0 +1,61 @@ 
+* Renesas "Type-AXI" NBPFAXI* DMA controllers
+
+* DMA controller
+
+Required properties
+
+- compatible:	must be one of
+		"renesas,nbpfaxi64dmac1b4"
+		"renesas,nbpfaxi64dmac1b8"
+		"renesas,nbpfaxi64dmac1b16"
+		"renesas,nbpfaxi64dmac4b4"
+		"renesas,nbpfaxi64dmac4b8"
+		"renesas,nbpfaxi64dmac4b16"
+		"renesas,nbpfaxi64dmac8b4"
+		"renesas,nbpfaxi64dmac8b8"
+		"renesas,nbpfaxi64dmac8b16"
+- #dma-cells:	must be 2: the first integer is a terminal number, to which this
+		slave is connected, the second one is flags. Flags is a bitmask
+		with the following bits defined:
+
+#define NBPF_SLAVE_RQ_HIGH	1
+#define NBPF_SLAVE_RQ_LOW	2
+#define NBPF_SLAVE_RQ_LEVEL	4
+
+Optional properties:
+
+You can use dma-channels and dma-requests as described in dma.txt, although they
+won't be used, this information is derived from the compatibility string.
+
+Example:
+
+	dma: dma-controller@48000000 {
+		compatible = "renesas,nbpfaxi64dmac8b4";
+		reg = <0x48000000 0x400>;
+		interrupts = <0 12 0x4
+			      0 13 0x4
+			      0 14 0x4
+			      0 15 0x4
+			      0 16 0x4
+			      0 17 0x4
+			      0 18 0x4
+			      0 19 0x4>;
+		#dma-cells = <2>;
+		dma-channels = <8>;
+		dma-requests = <8>;
+	};
+
+* DMA client
+
+Required properties:
+
+dmas and dma-names are required, as described in dma.txt.
+
+Example:
+
+#include <dt-bindings/dma/nbpfaxi.h>
+
+...
+		dmas = <&dma 0 (NBPF_SLAVE_RQ_HIGH | NBPF_SLAVE_RQ_LEVEL)
+			&dma 1 (NBPF_SLAVE_RQ_HIGH | NBPF_SLAVE_RQ_LEVEL)>;
+		dma-names = "rx", "tx";
diff --git a/include/dt-bindings/dma/nbpfaxi.h b/include/dt-bindings/dma/nbpfaxi.h
new file mode 100644
index 0000000..c1a5b9e
--- /dev/null
+++ b/include/dt-bindings/dma/nbpfaxi.h
@@ -0,0 +1,20 @@ 
+/*
+ * Copyright (C) 2013-2014 Renesas Electronics Europe Ltd.
+ * Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of version 2 of the GNU General Public License as
+ * published by the Free Software Foundation.
+ */
+
+#ifndef DT_BINDINGS_NBPFAXI_H
+#define DT_BINDINGS_NBPFAXI_H
+
+/**
+ * Use "#dma-cells = <2>;" with the second integer defining slave DMA flags:
+ */
+#define NBPF_SLAVE_RQ_HIGH	1
+#define NBPF_SLAVE_RQ_LOW	2
+#define NBPF_SLAVE_RQ_LEVEL	4
+
+#endif