mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Alexander Shishkin <alexander.shishkin@linux.intel.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Mathieu Poirier <mathieu.poirier@linaro.org>,
	linux-kernel@vger.kernel.org,
	Alexander Shishkin <alexander.shishkin@linux.intel.com>
Subject: [GIT PULL 10/16] stm class: p_sys-t: Document the configfs interface
Date: Fri,  5 Oct 2018 15:43:00 +0300	[thread overview]
Message-ID: <20181005124306.54870-11-alexander.shishkin@linux.intel.com> (raw)
In-Reply-To: <20181005124306.54870-1-alexander.shishkin@linux.intel.com>

This adds ABI documentation for the new configfs attributes that come
with the MIPI SyS-T protocol driver.

Signed-off-by: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Tested-by: Mathieu Poirier <mathieu.poirier@linaro.org>
---
 .../ABI/testing/configfs-stp-policy-p_sys-t   | 41 +++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 Documentation/ABI/testing/configfs-stp-policy-p_sys-t

diff --git a/Documentation/ABI/testing/configfs-stp-policy-p_sys-t b/Documentation/ABI/testing/configfs-stp-policy-p_sys-t
new file mode 100644
index 000000000000..b290d1c00dcf
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-stp-policy-p_sys-t
@@ -0,0 +1,41 @@
+What:		/config/stp-policy/<device>:p_sys-t.<policy>/<node>/uuid
+Date:		June 2018
+KernelVersion:	4.19
+Description:
+		UUID source identifier string, RW.
+		Default value is randomly generated at the mkdir <node> time.
+		Data coming from trace sources that use this <node> will be
+		tagged with this UUID in the MIPI SyS-T packet stream, to
+		allow the decoder to discern between different sources
+		within the same master/channel range, and identify the
+		higher level decoders that may be needed for each source.
+
+What:		/config/stp-policy/<device>:p_sys-t.<policy>/<node>/do_len
+Date:		June 2018
+KernelVersion:	4.19
+Description:
+		Include payload length in the MIPI SyS-T header, boolean.
+		If enabled, the SyS-T protocol encoder will include payload
+		length in each packet's metadata. This is normally redundant
+		if the underlying transport protocol supports marking message
+		boundaries (which STP does), so this is off by default.
+
+What:		/config/stp-policy/<device>:p_sys-t.<policy>/<node>/ts_interval
+Date:		June 2018
+KernelVersion:	4.19
+Description:
+		Time interval in milliseconds. Include a timestamp in the
+		MIPI SyS-T packet metadata, if this many milliseconds have
+		passed since the previous packet from this source. Zero is
+		the default and stands for "never send the timestamp".
+
+What:		/config/stp-policy/<device>:p_sys-t.<policy>/<node>/clocksync_interval
+Date:		June 2018
+KernelVersion:	4.19
+Description:
+		Time interval in milliseconds. Send a CLOCKSYNC packet if
+		this many milliseconds have passed since the previous
+		CLOCKSYNC packet from this source. Zero is the default and
+		stands for "never send the CLOCKSYNC". It makes sense to
+		use this option with sources that generate constant and/or
+		periodic data, like stm_heartbeat.
-- 
2.19.0


  parent reply	other threads:[~2018-10-05 12:44 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-05 12:42 [GIT PULL 00/16] stm class: Updates for 4.20 Alexander Shishkin
2018-10-05 12:42 ` [GIT PULL 01/16] stm class: Rework policy node fallback Alexander Shishkin
2018-10-05 12:42 ` [GIT PULL 02/16] stm class: Clarify configfs root type/operations names Alexander Shishkin
2018-10-05 12:42 ` [GIT PULL 03/16] stm class: Clean up stp_configfs_init Alexander Shishkin
2018-10-05 12:42 ` [GIT PULL 04/16] stm class: Introduce framing protocol drivers Alexander Shishkin
2018-10-05 12:42 ` [GIT PULL 05/16] stm class: Add a helper for writing data packets Alexander Shishkin
2018-10-05 12:42 ` [GIT PULL 06/16] stm class: Factor out default framing protocol Alexander Shishkin
2018-10-05 12:42 ` [GIT PULL 07/16] stm class: Switch over to the protocol driver Alexander Shishkin
2018-10-05 12:42 ` [GIT PULL 08/16] stm class: Add MIPI SyS-T protocol support Alexander Shishkin
2018-10-05 12:42 ` [GIT PULL 09/16] stm class: p_sys-t: Add support for CLOCKSYNC packets Alexander Shishkin
2018-10-05 12:43 ` Alexander Shishkin [this message]
2018-10-05 12:43 ` [GIT PULL 11/16] stm class: Document the MIPI SyS-T protocol usage Alexander Shishkin
2018-10-06 16:38   ` Randy Dunlap
2018-10-08 11:39     ` Alexander Shishkin
2018-10-08 15:42       ` Randy Dunlap
2018-10-05 12:43 ` [GIT PULL 12/16] stm class: Update documentation to match the new identification rules Alexander Shishkin
2018-10-05 12:43 ` [GIT PULL 13/16] stm class: SPDX-ify the documentation Alexander Shishkin
2018-10-05 12:43 ` [GIT PULL 14/16] stm class: heartbeat: Fix whitespace Alexander Shishkin
2018-10-05 12:43 ` [GIT PULL 15/16] lib: Add memcat_p(): paste 2 pointer arrays together Alexander Shishkin
2018-10-05 12:43 ` [GIT PULL 16/16] stm class: Use memcat_p() Alexander Shishkin

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=20181005124306.54870-11-alexander.shishkin@linux.intel.com \
    --to=alexander.shishkin@linux.intel.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mathieu.poirier@linaro.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

all inboxes | Powered by JetHome®