docs: ABI: update OCP TimeCard sysfs entries
authorVadim Fedorenko <vadfed@meta.com>
Thu, 29 Aug 2024 18:36:03 +0000 (11:36 -0700)
committerPaolo Abeni <pabeni@redhat.com>
Tue, 3 Sep 2024 13:37:48 +0000 (15:37 +0200)
Update documentation according to the changes in the driver.

New attributes group tty is exposed and ttyGNSS, ttyGNSS2, ttyMAC and
ttyNMEA are moved to this group. Also, these attributes are no more
links to the devices but rather simple text files containing names of
tty devices.

Signed-off-by: Vadim Fedorenko <vadfed@meta.com>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Paolo Abeni <pabeni@redhat.com>
Documentation/ABI/testing/sysfs-timecard

index 2204781562970720e8bd2389418119e525a37643..3ae41b7634ac9ee813993debf3cf0412ac263fef 100644 (file)
@@ -258,24 +258,29 @@ Description:      (RW) When retrieving the PHC with the PTP SYS_OFFSET_EXTENDED
                the estimated point where the FPGA latches the PHC time.  This
                value may be changed by writing an unsigned integer.
 
-What:          /sys/class/timecard/ocpN/ttyGNSS
-What:          /sys/class/timecard/ocpN/ttyGNSS2
-Date:          September 2021
+What:          /sys/class/timecard/ocpN/tty
+Date:          August 2024
+Contact:       Vadim Fedorenko <vadim.fedorenko@linux.dev>
+Description:   (RO) Directory containing the sysfs nodes for TTY attributes
+
+What:          /sys/class/timecard/ocpN/tty/ttyGNSS
+What:          /sys/class/timecard/ocpN/tty/ttyGNSS2
+Date:          August 2024
 Contact:       Jonathan Lemon <jonathan.lemon@gmail.com>
-Description:   These optional attributes link to the TTY serial ports
-               associated with the GNSS devices.
+Description:   (RO) These optional attributes contain names of the TTY serial
+               ports associated with the GNSS devices.
 
-What:          /sys/class/timecard/ocpN/ttyMAC
-Date:          September 2021
+What:          /sys/class/timecard/ocpN/tty/ttyMAC
+Date:          August 2024
 Contact:       Jonathan Lemon <jonathan.lemon@gmail.com>
-Description:   This optional attribute links to the TTY serial port
-               associated with the Miniature Atomic Clock.
+Description:   (RO) This optional attribute contains name of the TTY serial
+               port associated with the Miniature Atomic Clock.
 
-What:          /sys/class/timecard/ocpN/ttyNMEA
-Date:          September 2021
+What:          /sys/class/timecard/ocpN/tty/ttyNMEA
+Date:          August 2024
 Contact:       Jonathan Lemon <jonathan.lemon@gmail.com>
-Description:   This optional attribute links to the TTY serial port
-               which outputs the PHC time in NMEA ZDA format.
+Description:   (RO) This optional attribute contains name of the TTY serial
+               port which outputs the PHC time in NMEA ZDA format.
 
 What:          /sys/class/timecard/ocpN/utc_tai_offset
 Date:          September 2021