summaryrefslogtreecommitdiff
path: root/Documentation/ABI/testing/sysfs-ptp
blob: d40d2b55050239cd2669095ab909f287208f8f24 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
What:		/sys/class/ptp/
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This directory contains files and directories
		providing a standardized interface to the ancillary
		features of PTP hardware clocks.

What:		/sys/class/ptp/ptpN/
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This directory contains the attributes of the Nth PTP
		hardware clock registered into the PTP class driver
		subsystem.

What:		/sys/class/ptp/ptpN/clock_name
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This file contains the name of the PTP hardware clock
		as a human readable string.

What:		/sys/class/ptp/ptpN/max_adjustment
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This file contains the PTP hardware clock's maximum
		frequency adjustment value (a positive integer) in
		parts per billion.

What:		/sys/class/ptp/ptpN/n_alarms
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This file contains the number of periodic or one shot
		alarms offer by the PTP hardware clock.

What:		/sys/class/ptp/ptpN/n_external_timestamps
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This file contains the number of external timestamp
		channels offered by the PTP hardware clock.

What:		/sys/class/ptp/ptpN/n_periodic_outputs
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This file contains the number of programmable periodic
		output channels offered by the PTP hardware clock.

What:		/sys/class/ptp/ptpN/pps_avaiable
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This file indicates whether the PTP hardware clock
		supports a Pulse Per Second to the host CPU. Reading
		"1" means that the PPS is supported, while "0" means
		not supported.

What:		/sys/class/ptp/ptpN/extts_enable
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This write-only file enables or disables external
		timestamps. To enable external timestamps, write the
		channel index followed by a "1" into the file.
		To disable external timestamps, write the channel
		index followed by a "0" into the file.

What:		/sys/class/ptp/ptpN/fifo
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This file provides timestamps on external events, in
		the form of three integers: channel index, seconds,
		and nanoseconds.

What:		/sys/class/ptp/ptpN/period
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This write-only file enables or disables periodic
		outputs. To enable a periodic output, write five
		integers into the file: channel index, start time
		seconds, start time nanoseconds, period seconds, and
		period nanoseconds. To disable a periodic output, set
		all the seconds and nanoseconds values to zero.

What:		/sys/class/ptp/ptpN/pps_enable
Date:		September 2010
Contact:	Richard Cochran <richardcochran@gmail.com>
Description:
		This write-only file enables or disables delivery of
		PPS events to the Linux PPS subsystem. To enable PPS
		events, write a "1" into the file. To disable events,
		write a "0" into the file.