From: <atull@opensource.altera.com>
To: gregkh@linuxfoundation.org, jgunthorpe@obsidianresearch.com,
hpa@zytor.com, monstr@monstr.eu, michal.simek@xilinx.com,
rdunlap@infradead.org
Cc: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
pantelis.antoniou@konsulko.com, robh+dt@kernel.org,
grant.likely@linaro.org, iws@ovro.caltech.edu,
linux-doc@vger.kernel.org, pavel@denx.de, broonie@kernel.org,
philip@balister.org, rubini@gnudd.com, s.trumtrar@pengutronix.de,
jason@lakedaemon.net, kyle.teske@ni.com, nico@linaro.org,
balbi@ti.com, m.chehab@samsung.com, davidb@codeaurora.org,
rob@landley.net, davem@davemloft.net, cesarb@cesarb.net,
sameo@linux.intel.com, akpm@linux-foundation.org,
linus.walleij@linaro.org, pawel.moll@arm.com,
mark.rutland@arm.com, ijc+devicetree@hellion.org.uk,
galak@codeaurora.org, devel@driverdev.osuosl.org,
delicious.quinoa@gmail.com, dinguyen@opensource.altera.com,
yvanderv@opensource.altera.com,
Alan Tull <atull@opensource.altera.com>
Subject: [PATCH v5 2/6] fpga manager: add sysfs interface document
Date: Wed, 17 Dec 2014 10:54:45 -0600 [thread overview]
Message-ID: <1418835289-15752-3-git-send-email-atull@opensource.altera.com> (raw)
In-Reply-To: <1418835289-15752-1-git-send-email-atull@opensource.altera.com>
From: Alan Tull <atull@opensource.altera.com>
Add documentation under drivers/staging for new fpga manager's
sysfs interface.
Signed-off-by: Alan Tull <atull@opensource.altera.com>
---
v5 : (actually second version, but keeping version numbers
aligned with rest of patch series)
Move document to drivers/staging/fpga/Documentation/ABI
---
.../Documentation/ABI/sysfs-class-fpga-manager | 38 ++++++++++++++++++++
1 file changed, 38 insertions(+)
create mode 100644 drivers/staging/fpga/Documentation/ABI/sysfs-class-fpga-manager
diff --git a/drivers/staging/fpga/Documentation/ABI/sysfs-class-fpga-manager b/drivers/staging/fpga/Documentation/ABI/sysfs-class-fpga-manager
new file mode 100644
index 0000000..eb600f2
--- /dev/null
+++ b/drivers/staging/fpga/Documentation/ABI/sysfs-class-fpga-manager
@@ -0,0 +1,38 @@
+What: /sys/class/fpga_manager/<fpga>/name
+Date: October 2014
+KernelVersion: 3.18
+Contact: Alan Tull <atull@opensource.altera.com>
+Description: Name of low level driver.
+
+What: /sys/class/fpga_manager/<fpga>/firmware
+Date: October 2014
+KernelVersion: 3.18
+Contact: Alan Tull <atull@opensource.altera.com>
+Description: Name of the FPGA image file to load using firmware class.
+
+What: /sys/class/fpga_manager/<fpga>/reset
+Date: October 2014
+KernelVersion: 3.18
+Contact: Alan Tull <atull@opensource.altera.com>
+Description: Write 1 to reset the FPGA
+
+What: /sys/class/fpga_manager/<fpga>/state
+Date: October 2014
+KernelVersion: 3.18
+Contact: Alan Tull <atull@opensource.altera.com>
+Description: Read state of fpga framework state machine as a string.
+ Valid states may vary by manufacturer; superset is:
+ * unknown = can't determine state
+ * power_off = FPGA power is off
+ * power_up = FPGA reports power is up
+ * reset = FPGA held in reset state
+ * firmware_request = firmware class request in progress
+ * firmware_request_err = firmware request failed
+ * write_init = FPGA being prepared for programming
+ * write_init_err = Error while preparing FPGA for
+ programming
+ * write = FPGA ready to receive image data
+ * write_err = Error while programming
+ * write_complete = Doing post programming steps
+ * write_complete_err = Error while doing post programming
+ * operating = FPGA is programmed and operating
--
1.7.9.5
next prev parent reply other threads:[~2014-12-17 16:54 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-17 16:54 [PATCH v5 0/6] FPGA Manager Framework atull
[not found] ` <1418835289-15752-1-git-send-email-atull-yzvPICuk2ABMcg4IHK0kFoH6Mc4MB0Vx@public.gmane.org>
2014-12-17 16:54 ` [PATCH v5 1/6] doc: add bindings document for altera fpga manager atull-yzvPICuk2ABMcg4IHK0kFoH6Mc4MB0Vx
2014-12-17 16:54 ` [PATCH v5 3/6] staging: fpga manager: framework core atull-yzvPICuk2ABMcg4IHK0kFoH6Mc4MB0Vx
2014-12-18 18:16 ` Michal Simek
2014-12-18 20:46 ` atull
2014-12-19 7:22 ` Michal Simek
2014-12-17 16:54 ` [PATCH v5 4/6] staging: fpga manager: add driver for socfpga fpga manager atull-yzvPICuk2ABMcg4IHK0kFoH6Mc4MB0Vx
2014-12-18 15:31 ` Michal Simek
2014-12-18 20:59 ` atull
2014-12-19 7:30 ` Michal Simek
2014-12-17 16:54 ` atull [this message]
2014-12-17 16:54 ` [PATCH v5 5/6] arm: dts: socfpga: add altera " atull
2014-12-17 16:54 ` [PATCH v5 6/6] ARM: socfpga: defconfig: enable " atull
2014-12-17 17:32 ` Greg KH
[not found] ` <20141217173216.GA24913-U8xfFu+wG4EAvxtiuMwx3w@public.gmane.org>
2014-12-17 18:33 ` Michal Simek
2014-12-17 19:41 ` atull
2014-12-17 18:46 ` Jason Cooper
2014-12-17 22:00 ` Pavel Machek
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=1418835289-15752-3-git-send-email-atull@opensource.altera.com \
--to=atull@opensource.altera.com \
--cc=akpm@linux-foundation.org \
--cc=balbi@ti.com \
--cc=broonie@kernel.org \
--cc=cesarb@cesarb.net \
--cc=davem@davemloft.net \
--cc=davidb@codeaurora.org \
--cc=delicious.quinoa@gmail.com \
--cc=devel@driverdev.osuosl.org \
--cc=devicetree@vger.kernel.org \
--cc=dinguyen@opensource.altera.com \
--cc=galak@codeaurora.org \
--cc=grant.likely@linaro.org \
--cc=gregkh@linuxfoundation.org \
--cc=hpa@zytor.com \
--cc=ijc+devicetree@hellion.org.uk \
--cc=iws@ovro.caltech.edu \
--cc=jason@lakedaemon.net \
--cc=jgunthorpe@obsidianresearch.com \
--cc=kyle.teske@ni.com \
--cc=linus.walleij@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=m.chehab@samsung.com \
--cc=mark.rutland@arm.com \
--cc=michal.simek@xilinx.com \
--cc=monstr@monstr.eu \
--cc=nico@linaro.org \
--cc=pantelis.antoniou@konsulko.com \
--cc=pavel@denx.de \
--cc=pawel.moll@arm.com \
--cc=philip@balister.org \
--cc=rdunlap@infradead.org \
--cc=rob@landley.net \
--cc=robh+dt@kernel.org \
--cc=rubini@gnudd.com \
--cc=s.trumtrar@pengutronix.de \
--cc=sameo@linux.intel.com \
--cc=yvanderv@opensource.altera.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).