Skip to content

Commit

Permalink
Documentation ABI: add PPS generators documentation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Rodolfo Giometti authored and Greg Kroah-Hartman committed Jan 8, 2025
1 parent b14aea0 commit b3b9b3c
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
43 changes: 43 additions & 0 deletions Documentation/ABI/testing/sysfs-pps-gen
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions MAINTAINERS
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down

0 comments on commit b3b9b3c

Please sign in to comment.