Commit 40bec579 authored by Vadim Fedorenko's avatar Vadim Fedorenko Committed by Paolo Abeni
Browse files

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: default avatarVadim Fedorenko <vadfed@meta.com>
Reviewed-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: default avatarPaolo Abeni <pabeni@redhat.com>
parent 82ace0c8

Documentation/ABI/testing/sysfs-timecard

+18 −13
Original line number Diff line number Diff line
@@ -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