From: Christopher Bostic <cbostic@linux.vnet.ibm.com>
To: robh+dt@kernel.org, mark.rutland@arm.com, linux@armlinux.org.uk,
rostedt@goodmis.org, mingo@redhat.com,
gregkh@linuxfoundation.org, devicetree@vger.kernel.org,
linux-arm-kernel@lists.infradead.org
Cc: Christopher Bostic <cbostic@linux.vnet.ibm.com>,
joel@jms.id.au, linux-kernel@vger.kernel.org, andrew@aj.id.au,
alistair@popple.id.au, benh@kernel.crashing.org
Subject: [PATCH v8 18/24] drivers/fsi: Document FSI master sysfs files in ABI
Date: Tue, 6 Jun 2017 16:08:53 -0500 [thread overview]
Message-ID: <20170606210859.80431-19-cbostic@linux.vnet.ibm.com> (raw)
In-Reply-To: <20170606210859.80431-1-cbostic@linux.vnet.ibm.com>
Add info for sysfs scan file in Documentaiton ABI/testing
Signed-off-by: Christopher Bostic <cbostic@linux.vnet.ibm.com>
---
v7 - Rename scan file to 'rescan'
- Add 'raw' file details
- Add 'term' file details
- Add 'break' file details
- Update kernel version for each file to 4.12
---
Documentation/ABI/testing/sysfs-bus-fsi | 38 +++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-fsi
diff --git a/Documentation/ABI/testing/sysfs-bus-fsi b/Documentation/ABI/testing/sysfs-bus-fsi
new file mode 100644
index 0000000..57c8063
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-fsi
@@ -0,0 +1,38 @@
+What: /sys/bus/platform/devices/fsi-master/rescan
+Date: May 2017
+KernelVersion: 4.12
+Contact: cbostic@linux.vnet.ibm.com
+Description:
+ Initiates a FSI master scan for all connected slave devices
+ on its links.
+
+What: /sys/bus/platform/devices/fsi-master/break
+Date: May 2017
+KernelVersion: 4.12
+Contact: cbostic@linux.vnet.ibm.com
+Description:
+ Sends an FSI BREAK command on a master's communication
+ link to any connnected slaves. A BREAK resets connected
+ device's logic and preps it to receive further commands
+ from the master.
+
+What: /sys/bus/platform/devices/fsi-master/slave@00:00/term
+Date: May 2017
+KernelVersion: 4.12
+Contact: cbostic@linux.vnet.ibm.com
+Description:
+ Sends an FSI terminate command from the master to its
+ connected slave. A terminate resets the slave's state machines
+ that control access to the internally connected engines. In
+ addition the slave freezes its internal error register for
+ debugging purposes. This command is also needed to abort any
+ ongoing operation in case of an expired 'Master Time Out'
+ timer.
+
+What: /sys/bus/platform/devices/fsi-master/slave@00:00/raw
+Date: May 2017
+KernelVersion: 4.12
+Contact: cbostic@linux.vnet.ibm.com
+Description:
+ Provides a means of reading/writing a 32 bit value from/to a
+ specified FSI bus address.
--
1.8.2.2
next prev parent reply other threads:[~2017-06-06 21:08 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-06 21:08 [PATCH v8 00/24] FSI device driver implementation Christopher Bostic
[not found] ` <20170606210859.80431-1-cbostic-23VcF4HTsmIX0ybBhKVfKdBPR1lH4CV8@public.gmane.org>
2017-06-06 21:08 ` [PATCH v8 01/24] drivers/fsi: Add fsi master definition Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 02/24] drivers/fsi: Add slave definition Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 06/24] drivers/fsi: Set up links for slave communication Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 07/24] drivers/fsi: Implement slave initialisation Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 13/24] drivers/fsi: Add client driver register utilities Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 15/24] drivers/fsi: expose direct-access slave API Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 03/24] drivers/fsi: Add empty master scan Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 04/24] lib: Add crc4 module Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 05/24] drivers/fsi: Add slave & master read/write APIs Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 08/24] drivers/fsi: Set slave SMODE to init communication Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 09/24] drivers/fsi: scan slaves & register devices Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 10/24] drivers/fsi: Add device read/write/peek API Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 11/24] drivers/fsi: Add master unscan Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 12/24] drivers/fsi: Add documentation for GPIO bindings Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 14/24] drivers/fsi: Add sysfs files for FSI master & slave accesses Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 16/24] drivers/fsi: Add tracepoints for low-level operations Christopher Bostic
2017-06-07 19:16 ` Steven Rostedt
[not found] ` <20170607151610.52f7bc88-f9ZlEuEWxVcJvu8Pb33WZ0EMvNT87kid@public.gmane.org>
2017-06-08 2:06 ` Jeremy Kerr
2017-06-06 21:08 ` [PATCH v8 17/24] drivers/fsi: Add error handling for slave Christopher Bostic
2017-06-06 21:08 ` Christopher Bostic [this message]
2017-06-06 21:08 ` [PATCH v8 19/24] drivers/fsi: Add GPIO based FSI master Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 20/24] drivers/fsi/gpio: Add tracepoints for GPIO master Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 21/24] drivers/fsi: Add SCOM FSI client device driver Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 22/24] drivers/fsi: Add hub master support Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 23/24] drivers/fsi: Use asynchronous slave mode Christopher Bostic
2017-06-06 21:08 ` [PATCH v8 24/24] drivers/fsi: Add module license to core driver Christopher Bostic
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=20170606210859.80431-19-cbostic@linux.vnet.ibm.com \
--to=cbostic@linux.vnet.ibm.com \
--cc=alistair@popple.id.au \
--cc=andrew@aj.id.au \
--cc=benh@kernel.crashing.org \
--cc=devicetree@vger.kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=joel@jms.id.au \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=mark.rutland@arm.com \
--cc=mingo@redhat.com \
--cc=robh+dt@kernel.org \
--cc=rostedt@goodmis.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).