Skip to content

Commit 40bec57

Browse files
vvfedorenkoPaolo Abeni
authored andcommitted
docs: ABI: update OCP TimeCard sysfs entries
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 <[email protected]> Reviewed-by: Greg Kroah-Hartman <[email protected]> Signed-off-by: Paolo Abeni <[email protected]>
1 parent 82ace0c commit 40bec57

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

Documentation/ABI/testing/sysfs-timecard

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -258,24 +258,29 @@ Description: (RW) When retrieving the PHC with the PTP SYS_OFFSET_EXTENDED
258258
the estimated point where the FPGA latches the PHC time. This
259259
value may be changed by writing an unsigned integer.
260260

261-
What: /sys/class/timecard/ocpN/ttyGNSS
262-
What: /sys/class/timecard/ocpN/ttyGNSS2
263-
Date: September 2021
261+
What: /sys/class/timecard/ocpN/tty
262+
Date: August 2024
263+
Contact: Vadim Fedorenko <[email protected]>
264+
Description: (RO) Directory containing the sysfs nodes for TTY attributes
265+
266+
What: /sys/class/timecard/ocpN/tty/ttyGNSS
267+
What: /sys/class/timecard/ocpN/tty/ttyGNSS2
268+
Date: August 2024
264269
Contact: Jonathan Lemon <[email protected]>
265-
Description: These optional attributes link to the TTY serial ports
266-
associated with the GNSS devices.
270+
Description: (RO) These optional attributes contain names of the TTY serial
271+
ports associated with the GNSS devices.
267272

268-
What: /sys/class/timecard/ocpN/ttyMAC
269-
Date: September 2021
273+
What: /sys/class/timecard/ocpN/tty/ttyMAC
274+
Date: August 2024
270275
Contact: Jonathan Lemon <[email protected]>
271-
Description: This optional attribute links to the TTY serial port
272-
associated with the Miniature Atomic Clock.
276+
Description: (RO) This optional attribute contains name of the TTY serial
277+
port associated with the Miniature Atomic Clock.
273278

274-
What: /sys/class/timecard/ocpN/ttyNMEA
275-
Date: September 2021
279+
What: /sys/class/timecard/ocpN/tty/ttyNMEA
280+
Date: August 2024
276281
Contact: Jonathan Lemon <[email protected]>
277-
Description: This optional attribute links to the TTY serial port
278-
which outputs the PHC time in NMEA ZDA format.
282+
Description: (RO) This optional attribute contains name of the TTY serial
283+
port which outputs the PHC time in NMEA ZDA format.
279284

280285
What: /sys/class/timecard/ocpN/utc_tai_offset
281286
Date: September 2021

0 commit comments

Comments
 (0)