devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ankit Jindal <ankit.jindal@linaro.org>
To: linux-kernel@vger.kernel.org
Cc: "Hans J. Koch" <hjk@hansjkoch.de>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	patches@apm.com, linux-arm-kernel@lists.infradead.org,
	Rob Herring <robh+dt@kernel.org>,
	Tushar Jagad <tushar.jagad@linaro.org>,
	Russell King - ARM Linux <linux@arm.linux.org.uk>,
	devicetree@vger.kernel.org, Guenter Roeck <linux@roeck-us.net>,
	Varka Bhadram <varkabhadram@gmail.com>,
	Ankit Jindal <ankit.jindal@linaro.org>
Subject: [PATCH v3 5/6] Documentation: dt-bindings: Add binding info for X-Gene QMTM UIO driver
Date: Tue, 21 Oct 2014 11:26:49 +0530	[thread overview]
Message-ID: <1413871011-4101-6-git-send-email-ankit.jindal@linaro.org> (raw)
In-Reply-To: <1413871011-4101-1-git-send-email-ankit.jindal@linaro.org>

This patch adds device tree binding documentation for
X-Gene QMTM UIO driver.

Signed-off-by: Ankit Jindal <ankit.jindal@linaro.org>
Signed-off-by: Tushar Jagad <tushar.jagad@linaro.org>
---
 .../devicetree/bindings/uio/uio_xgene_qmtm.txt     |   53 ++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/uio/uio_xgene_qmtm.txt

diff --git a/Documentation/devicetree/bindings/uio/uio_xgene_qmtm.txt b/Documentation/devicetree/bindings/uio/uio_xgene_qmtm.txt
new file mode 100644
index 0000000..288ed92
--- /dev/null
+++ b/Documentation/devicetree/bindings/uio/uio_xgene_qmtm.txt
@@ -0,0 +1,53 @@
+APM X-Gene QMTM UIO nodes
+
+The Applied Micro X-Gene SOC has on-chip QMTM (Queue manager
+and Traffic manager). It is a device for managing hardware queues.
+It also implements QoS among hardware queues hence term "traffic"
+manager is present in its name. QMTM UIO nodes are defined for user
+space access to this device using UIO framework.
+
+Required properties:
+- compatible: Should be "apm,xgene-qmtm"
+- reg: Address and length of the register set for the device. It contains the
+  information of registers in the same order as described by reg-names.
+- reg-names: Should contain the register set names
+  - "csr": QMTM control and status register address space.
+  - "fabric": QMTM memory mapped access to queue states.
+- qpool: Points to the phandle of the node defining memory location for
+	 creating QMTM queues. This could point either to the reserved-memory
+	 node (as-per reserved memory bindings) or to the node of on-chip
+	 SRAM etc. It is expected that size and location of qpool memory will
+	 be configurable via bootloader.
+- clocks: Reference to the clock entry.
+- num-queues: Number of queues under this QMTM device.
+- devid: QMTM identification number for the system having multiple QMTM devices.
+	 This is used to form a unique id (a tuple of queue number and
+	 device id) for the queues belonging to this device.
+
+Example:
+	qmtm1_uio_qpool: qmtm1_uio_qpool {
+		reg = <0x0 0x0 0x0 0x0>
+	};
+
+	qmtm1clk: qmtmclk@1f20c000 {
+		compatible = "apm,xgene-device-clock";
+		clock-output-names = "qmtm1clk";
+		status = "ok";
+	};
+
+	qmtm1_uio: qmtm_uio@1f200000 {
+		compatible = "apm,xgene-qmtm";
+		status = "disabled";
+		reg = <0x0 0x1f200000 0x0 0x10000>,
+		      <0x0 0x1b000000 0x0 0x400000>;
+		reg-names = "csr", "fabric";
+		qpool = <&qmtm1_uio_qpool>;
+		clocks = <&qmtm1clk 0>;
+		num-queues = <0x400>;
+		devid = <1>;
+	};
+
+	/* Board-specific peripheral configurations */
+	&qmtm1_uio {
+		status = "ok";
+	};
-- 
1.7.9.5

  parent reply	other threads:[~2014-10-21  5:56 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-10-21  5:56 [PATCH v3 0/6] UIO driver for APM X-Gene QMTM Ankit Jindal
2014-10-21  5:56 ` [PATCH v3 1/6] uio: code style cleanup Ankit Jindal
2014-10-21  5:56 ` [PATCH v3 2/6] uio: Add new UIO_MEM_PHYS_CACHE type for mem regions Ankit Jindal
2014-10-21  6:38   ` Kumar Gala
2014-10-31  9:30     ` Ankit Jindal
2014-10-31 13:39       ` Kumar Gala
     [not found]         ` <4B098F57-E202-412C-B54D-085A46792EDC-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org>
2014-11-05 12:55           ` Ankit Jindal
     [not found]             ` <CAPTm99UUA0Oe40uH73Rj8_hvyMYwuxcKhFvU_KVZxmKpR1jn2Q-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2014-11-05 15:09               ` Kumar Gala
2014-11-10 11:53                 ` Ankit Jindal
2014-10-31  9:35     ` Russell King - ARM Linux
2014-10-21  5:56 ` [PATCH v3 3/6] Documentation: Update documentation for UIO_MEM_PHYS_CACHE Ankit Jindal
2014-10-21  5:56 ` [PATCH v3 4/6] uio: Add X-Gene QMTM UIO driver Ankit Jindal
2014-10-21  6:04   ` Varka Bhadram
2014-10-21  6:16     ` Ankit Jindal
2014-10-21  6:17       ` Varka Bhadram
2014-10-21  6:23         ` Ankit Jindal
2014-10-21  5:56 ` Ankit Jindal [this message]
2014-10-21  9:14   ` [PATCH v3 5/6] Documentation: dt-bindings: Add binding info for " Mark Rutland
2014-10-21 10:05     ` Arnd Bergmann
2014-10-31 10:04     ` Ankit Jindal
     [not found]       ` <CAPTm99X9k+cfELMLL8_PmYN6RNn7CL7KugnV5JKcW6Jqhs8idg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2014-10-31 10:09         ` Mark Rutland
2014-10-31 10:15           ` Ankit Jindal
2014-10-21  5:56 ` [PATCH v3 6/6] MAINTAINERS: Add entry for APM " Ankit Jindal

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=1413871011-4101-6-git-send-email-ankit.jindal@linaro.org \
    --to=ankit.jindal@linaro.org \
    --cc=devicetree@vger.kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=hjk@hansjkoch.de \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@arm.linux.org.uk \
    --cc=linux@roeck-us.net \
    --cc=patches@apm.com \
    --cc=robh+dt@kernel.org \
    --cc=tushar.jagad@linaro.org \
    --cc=varkabhadram@gmail.com \
    /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 NNTP newsgroup(s).