devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: <atull@opensource.altera.com>
To: gregkh@linuxfoundation.org
Cc: Moritz Fischer <moritz.fischer@ettus.com>,
	Josh Cartwright <joshc@ni.com>,
	monstr@monstr.eu, michal.simek@xilinx.com,
	Rob Herring <robh+dt@kernel.org>, Pawel Moll <pawel.moll@arm.com>,
	Mark Rutland <mark.rutland@arm.com>,
	Ian Campbell <ijc+devicetree@hellion.org.uk>,
	Kumar Gala <galak@codeaurora.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
	linux-doc@vger.kernel.org, pantelis.antoniou@konsulko.com,
	delicious.quinoa@gmail.com, dinguyen@opensource.altera.com,
	Alan Tull <atull@opensource.altera.com>,
	Matthew Gerlach <mgerlach@altera.com>
Subject: [PATCH v12 5/6] ARM: socfpga: add bindings document for fpga bridge drivers
Date: Tue, 27 Oct 2015 17:09:14 -0500	[thread overview]
Message-ID: <1445983755-24007-6-git-send-email-atull@opensource.altera.com> (raw)
In-Reply-To: <1445983755-24007-1-git-send-email-atull@opensource.altera.com>

From: Alan Tull <atull@opensource.altera.com>

Add bindings documentation for Altera SOCFPGA bridges:
 * fpga2sdram
 * fpga2hps
 * hps2fpga
 * lwhps2fpga

Signed-off-by: Alan Tull <dinguyen@opensource.altera.com>
Signed-off-by: Dinh Nguyen <dinguyen@opensource.altera.com>
Signed-off-by: Matthew Gerlach <mgerlach@altera.com>
---
v2:  separate into 2 documents for the 2 drivers
v12: bump version to line up with simple-fpga-bus version
     remove Linux specific notes such as references to sysfs
     move non-DT specific documentation elsewhere
     remove bindings that would have been used to pass configuration
     clean up formatting
---
 .../bindings/fpga/altera-fpga2sdram-bridge.txt     |   18 ++++++++++
 .../bindings/fpga/altera-hps2fpga-bridge.txt       |   36 ++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt
 create mode 100644 Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt

diff --git a/Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt b/Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt
new file mode 100644
index 0000000..11eb5b7
--- /dev/null
+++ b/Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt
@@ -0,0 +1,18 @@
+Altera FPGA To SDRAM Bridge Driver
+
+Required properties:
+- compatible		: Should contain "altr,socfpga-fpga2sdram-bridge"
+
+Optional properties:
+- label			: User-readable name for this bridge.
+			  Default is br<device#>
+- init-val		: 0 if driver should disable bridge at startup
+			  1 if driver should enable bridge at startup
+			  Default is to leave bridge in current state.
+
+Example:
+	fpga2sdram_br: fpgabridge@3 {
+		compatible = "altr,socfpga-fpga2sdram-bridge";
+		label = "fpga2sdram";
+		init-val = <0>;
+	};
diff --git a/Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt b/Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt
new file mode 100644
index 0000000..eb52f3b
--- /dev/null
+++ b/Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt
@@ -0,0 +1,36 @@
+Altera FPGA/HPS Bridge Driver
+
+Required properties:
+- compatible	: Should contain one of:
+		  "altr,socfpga-hps2fpga-bridge",
+		  "altr,socfpga-lwhps2fpga-bridge", or
+		  "altr,socfpga-fpga2hps-bridge"
+- clocks	: Clocks used by this module.
+
+Optional properties:
+- label		: User-readable name for this bridge.
+		  Default is br<device#>
+- init-val	: 0 if driver should disable bridge at startup.
+		  1 if driver should enable bridge at startup.
+		  Default is to leave bridge in its current state.
+
+Example:
+	hps_fpgabridge0: fpgabridge@0 {
+		compatible = "altr,socfpga-hps2fpga-bridge";
+		label = "hps2fpga";
+		clocks = <&l4_main_clk>;
+		init-val = <1>;
+	};
+
+	hps_fpgabridge1: fpgabridge@1 {
+		compatible = "altr,socfpga-lwhps2fpga-bridge";
+		label = "lwhps2fpga";
+		clocks = <&l4_main_clk>;
+		init-val = <0>;
+	};
+
+	hps_fpgabridge2: fpgabridge@2 {
+		compatible = "altr,socfpga-fpga2hps-bridge";
+		label = "fpga2hps";
+		clocks = <&l4_main_clk>;
+	};
-- 
1.7.9.5

  parent reply	other threads:[~2015-10-27 22:09 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-27 22:09 [PATCH v12 0/6] simple fpga bus and fpga bridge framework atull
2015-10-27 22:09 ` [PATCH v12 1/6] fpga: add usage documentation for simple fpga bus atull
     [not found]   ` <1445983755-24007-2-git-send-email-atull-yzvPICuk2ABMcg4IHK0kFoH6Mc4MB0Vx@public.gmane.org>
2015-10-28  0:23     ` Moritz Fischer
2015-10-28 14:59       ` atull
2015-10-27 22:09 ` [PATCH v12 2/6] fpga: add bindings document " atull
2015-10-28  9:00   ` Steffen Trumtrar
2015-10-28 14:53     ` atull
2015-10-28 15:18       ` Moritz Fischer
2015-10-28 15:34         ` atull
2015-10-28  9:40   ` Steffen Trumtrar
2015-10-28 19:45     ` atull
2015-10-28 23:40   ` Rob Herring
2015-10-29 16:02     ` atull
2015-10-30 17:58       ` Rob Herring
2015-11-03 16:28         ` atull
2015-11-03 19:56           ` Rob Herring
2015-10-27 22:09 ` [PATCH v12 3/6] fpga: add simple-fpga-bus atull
2015-10-28  9:43   ` Steffen Trumtrar
2015-10-28 15:39     ` atull
2015-10-28 10:07   ` Josh Cartwright
2015-10-28 12:41     ` atull
2015-10-28 15:37     ` Moritz Fischer
2015-10-28 16:18       ` Josh Cartwright
     [not found]         ` <20151028161859.GJ8245-ew3lsbMjNqt5wtABiV/Xjqyly8cj88Ttqxv4g6HH51o@public.gmane.org>
2015-10-28 16:28           ` Moritz Fischer
2015-10-28 17:03             ` atull
2015-10-28 17:41               ` atull
2015-10-28 17:59               ` Josh Cartwright
2015-10-28 18:02                 ` Josh Cartwright
2015-10-28 18:22                 ` atull
2015-10-28 20:33                 ` Moritz Fischer
2015-10-29  4:04         ` Rob Herring
2015-10-27 22:09 ` [PATCH v12 4/6] fpga: add fpga bridge framework atull
     [not found]   ` <1445983755-24007-5-git-send-email-atull-yzvPICuk2ABMcg4IHK0kFoH6Mc4MB0Vx@public.gmane.org>
2015-10-28  9:50     ` Steffen Trumtrar
2015-10-28 15:31       ` atull
2015-10-27 22:09 ` atull [this message]
2015-10-28  9:29   ` [PATCH v12 5/6] ARM: socfpga: add bindings document for fpga bridge drivers Steffen Trumtrar
2015-10-28 15:53     ` atull
2015-10-28 23:44   ` Rob Herring
2015-10-29 15:04     ` atull
2015-10-27 22:09 ` [PATCH v12 6/6] ARM: socfpga: fpga bridge driver support atull
2015-10-28 10:13   ` Steffen Trumtrar
2015-10-28 12:51     ` atull

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=1445983755-24007-6-git-send-email-atull@opensource.altera.com \
    --to=atull@opensource.altera.com \
    --cc=corbet@lwn.net \
    --cc=delicious.quinoa@gmail.com \
    --cc=devicetree@vger.kernel.org \
    --cc=dinguyen@opensource.altera.com \
    --cc=galak@codeaurora.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=ijc+devicetree@hellion.org.uk \
    --cc=joshc@ni.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=mgerlach@altera.com \
    --cc=michal.simek@xilinx.com \
    --cc=monstr@monstr.eu \
    --cc=moritz.fischer@ettus.com \
    --cc=pantelis.antoniou@konsulko.com \
    --cc=pawel.moll@arm.com \
    --cc=robh+dt@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 NNTP newsgroup(s).