From: Rodolfo Giometti <giometti@enneenne.com>
To: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Andrew Morton <akpm@linux-foundation.org>,
Greg KH <greg@kroah.com>,
corbet@lwn.net, Hall Christopher S <christopher.s.hall@intel.com>,
Mohan Subramanian <subramanian.mohan@intel.com>,
tglx@linutronix.de, andriy.shevchenko@linux.intel.com,
Dong Eddie <eddie.dong@intel.com>,
N Pandith <pandith.n@intel.com>,
T R Thejesh Reddy <thejesh.reddy.t.r@intel.com>,
Zage David <david.zage@intel.com>,
Chinnadurai Srinivasan <srinivasan.chinnadurai@intel.com>,
Rodolfo Giometti <giometti@enneenne.com>
Subject: [V1 4/4] Documentation ABI: add PPS generators documentation
Date: Fri, 18 Oct 2024 16:39:15 +0200 [thread overview]
Message-ID: <20241018143915.3877425-5-giometti@enneenne.com> (raw)
In-Reply-To: <20241018143915.3877425-1-giometti@enneenne.com>
This patch adds the documentation for the ABI between the Linux kernel
and userspace regarding the PPS generators.
Signed-off-by: Rodolfo Giometti <giometti@enneenne.com>
---
Documentation/ABI/testing/sysfs-pps-gen | 44 +++++++++++++++++++++++++
1 file changed, 44 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-pps-gen
diff --git a/Documentation/ABI/testing/sysfs-pps-gen b/Documentation/ABI/testing/sysfs-pps-gen
new file mode 100644
index 000000000000..427ba985f413
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-pps-gen
@@ -0,0 +1,44 @@
+What: /sys/class/pps-gen/
+Date: October 2024
+Contact: Rodolfo Giometti <giometti@enneenne.com>
+Description:
+ The /sys/class/pps-gen/ directory will contain files and
+ directories that will provide a unified interface to
+ the PPS generators.
+
+What: /sys/class/pps-gen/pps-genX/
+Date: October 2024
+Contact: Rodolfo Giometti <giometti@enneenne.com>
+Description:
+ The /sys/class/pps-gen/pps-genX/ directory is related to X-th
+ PPS generator into the system. Each directory will
+ contain files to manage and control its PPS generator.
+
+What: /sys/class/pps-gen/pps-genX/enable
+Date: October 2024
+Contact: Rodolfo Giometti <giometti@enneenne.com>
+Description:
+ This write-only file enables or disables generation of the
+ PPS signal.
+
+What: /sys/class/pps-gen/pps-genX/name
+Date: October 2024
+Contact: Rodolfo Giometti <giometti@enneenne.com>
+Description:
+ This read-only file reports the name of the X-th generator.
+
+What: /sys/class/pps-gen/pps-genX/system
+Date: October 2024
+Contact: Rodolfo Giometti <giometti@enneenne.com>
+Description:
+ This read-only file returns "1" if the generator takes the
+ timing from the system clock, while it returns "0" if not
+ (i.e. from a peripheral device clock).
+
+What: /sys/class/pps-gen/pps-genX/time
+Date: October 2024
+Contact: Rodolfo Giometti <giometti@enneenne.com>
+Description:
+ This read-only file contains the current time stored into the
+ generator clock as two integers representing the current time
+ seconds and nanoseconds.
--
2.34.1
next prev parent reply other threads:[~2024-10-18 14:42 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-18 14:39 [V1 0/4] Add PPS generators Rodolfo Giometti
2024-10-18 14:39 ` [V1 1/4] drivers pps: add PPS generators support Rodolfo Giometti
2024-10-18 14:39 ` [V1 2/4] drivers pps/generators: add dummy PPS generator Rodolfo Giometti
2024-10-20 17:43 ` Randy Dunlap
2024-10-18 14:39 ` [V1 3/4] Documentation pps.rst: add PPS generators documentation Rodolfo Giometti
2024-10-20 17:48 ` Randy Dunlap
2024-10-18 14:39 ` Rodolfo Giometti [this message]
2024-10-18 14:56 ` [V1 4/4] Documentation ABI: " Andy Shevchenko
2024-10-20 17:54 ` Randy Dunlap
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=20241018143915.3877425-5-giometti@enneenne.com \
--to=giometti@enneenne.com \
--cc=akpm@linux-foundation.org \
--cc=andriy.shevchenko@linux.intel.com \
--cc=christopher.s.hall@intel.com \
--cc=corbet@lwn.net \
--cc=david.zage@intel.com \
--cc=eddie.dong@intel.com \
--cc=greg@kroah.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pandith.n@intel.com \
--cc=srinivasan.chinnadurai@intel.com \
--cc=subramanian.mohan@intel.com \
--cc=tglx@linutronix.de \
--cc=thejesh.reddy.t.r@intel.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
all inboxes | Powered by JetHome®