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: mark.rutland@arm.com, linux-doc@vger.kernel.org,
rubini@gnudd.com, pantelis.antoniou@konsulko.com,
s.trumtrar@pengutronix.de, devel@driverdev.osuosl.org,
sameo@linux.intel.com, nico@linaro.org,
ijc+devicetree@hellion.org.uk, kyle.teske@ni.com,
grant.likely@linaro.org, davidb@codeaurora.org,
linus.walleij@linaro.org, cesarb@cesarb.net,
devicetree@vger.kernel.org, jason@lakedaemon.net,
pawel.moll@arm.com, iws@ovro.caltech.edu,
Alan Tull <atull@opensource.altera.com>,
broonie@kernel.org, philip@balister.org,
dinguyen@opensource.altera.com, pavel@denx.de,
yvanderv@opensource.altera.com, linux-kernel@vger.kernel.org,
balbi@ti.com, delicious.quinoa@gmail.com, robh+dt@kernel.org,
rob@landley.net, galak@codeaurora.org, akpm@linux-foundation.org,
davem@davemloft.net, m.chehab@samsung.com
Subject: [PATCH v6 2/4] fpga manager: add sysfs interface document
Date: Thu, 18 Dec 2014 16:29:06 -0600 [thread overview]
Message-ID: <1418941748-16111-3-git-send-email-atull@opensource.altera.com> (raw)
In-Reply-To: <1418941748-16111-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
v6 : No change in this patch for v6 of the patch set
---
.../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-18 22:29 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-18 22:29 [PATCH v6 0/4] FPGA Manager Framework atull
2014-12-18 22:29 ` [PATCH v6 1/4] doc: add bindings document for altera fpga manager atull
2014-12-18 22:29 ` atull [this message]
2014-12-18 22:29 ` [PATCH v6 3/4] staging: fpga manager: framework core atull
2014-12-19 14:08 ` Michal Simek
2014-12-18 22:29 ` [PATCH v6 4/4] staging: fpga manager: add driver for socfpga fpga manager atull
2014-12-19 8:55 ` Steffen Trumtrar
2014-12-19 14:05 ` Michal Simek
2014-12-19 15:07 ` Steffen Trumtrar
2014-12-19 15:55 ` atull
2014-12-19 16:15 ` Steffen Trumtrar
2014-12-19 14:20 ` [PATCH v6 0/4] FPGA Manager Framework Michal Simek
2014-12-19 15:38 ` Greg KH
2014-12-19 15:47 ` atull
2014-12-19 16:49 ` Greg KH
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=1418941748-16111-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).