linux-kernel - [V2 4/4] Documentation ABI: add PPS generators documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20241031163508.259522-5-giometti@enneenne.com>
Date: Thu, 31 Oct 2024 17:35:08 +0100
From: Rodolfo Giometti <giometti@...eenne.com>
To: linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org
Cc: Andrew Morton <akpm@...ux-foundation.org>,
	Greg KH <greg@...ah.com>,
	corbet@....net,
	Hall Christopher S <christopher.s.hall@...el.com>,
	Mohan Subramanian <subramanian.mohan@...el.com>,
	tglx@...utronix.de,
	Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
	Dong Eddie <eddie.dong@...el.com>,
	N Pandith <pandith.n@...el.com>,
	T R Thejesh Reddy <thejesh.reddy.t.r@...el.com>,
	Zage David <david.zage@...el.com>,
	Chinnadurai Srinivasan <srinivasan.chinnadurai@...el.com>,
	Randy Dunlap <rdunlap@...radead.org>,
	Rodolfo Giometti <giometti@...eenne.com>
Subject: [V2 4/4] Documentation ABI: add PPS generators documentation

This patch adds the documentation for the ABI between the Linux kernel
and userspace regarding the PPS generators.

Signed-off-by: Rodolfo Giometti <giometti@...eenne.com>
---
 Documentation/ABI/testing/sysfs-pps-gen | 38 +++++++++++++++++++++++++
 MAINTAINERS                             |  1 +
 2 files changed, 39 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..7effe495d062
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-pps-gen
@@ -0,0 +1,38 @@
+What:		/sys/class/pps-gen/
+Date:		February 2025
+Contact:	Rodolfo Giometti <giometti@...eenne.com>
+Description:
+		The /sys/class/pps-gen/ directory contains files and
+		directories that provide a unified interface to the PPS
+		generators.
+
+What:		/sys/class/pps-gen/pps-genX/
+Date:		February 2025
+Contact:	Rodolfo Giometti <giometti@...eenne.com>
+Description:
+		The /sys/class/pps-gen/pps-genX/ directory is related to X-th
+		PPS generator in the system. Each directory contain files to
+		manage and control its PPS generator.
+
+What:		/sys/class/pps-gen/pps-genX/enable
+Date:		February 2025
+Contact:	Rodolfo Giometti <giometti@...eenne.com>
+Description:
+		This write-only file enables or disables generation of the
+		PPS signal.
+
+What:		/sys/class/pps-gen/pps-genX/system
+Date:		February 2025
+Contact:	Rodolfo Giometti <giometti@...eenne.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:		February 2025
+Contact:	Rodolfo Giometti <giometti@...eenne.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.
diff --git a/MAINTAINERS b/MAINTAINERS
index 63871eb816eb..d0b628c973f7 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -18532,6 +18532,7 @@ L:	linuxpps@...enneenne.com (subscribers-only)
 S:	Maintained
 W:	http://wiki.enneenne.com/index.php/LinuxPPS_support
 F:	Documentation/ABI/testing/sysfs-pps
+F:	Documentation/ABI/testing/sysfs-pps-gen
 F:	Documentation/devicetree/bindings/pps/pps-gpio.yaml
 F:	Documentation/driver-api/pps.rst
 F:	drivers/pps/
-- 
2.34.1