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@enneenne.com>
Link: https://lore.kernel.org/r/20241108073115.759039-5-giometti@enneenne.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/Documentation/ABI/testing/sysfs-pps-gen b/Documentation/ABI/testing/sysfs-pps-gen
new file mode 100644 (file)
index 0000000..2519207
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-pps-gen
@@ -0,0 +1,43 @@
+What:          /sys/class/pps-gen/
+Date:          February 2025
+KernelVersion:  6.13
+Contact:       Rodolfo Giometti <giometti@enneenne.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
+KernelVersion:  6.13
+Contact:       Rodolfo Giometti <giometti@enneenne.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
+KernelVersion:  6.13
+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/system
+Date:          February 2025
+KernelVersion:  6.13
+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:          February 2025
+KernelVersion:  6.13
+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.

diff --git a/MAINTAINERS b/MAINTAINERS
index 530eca8..668ccb9 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -18715,6 +18715,7 @@ L:      linuxpps@ml.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/