aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/networking/timestamping.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/networking/timestamping.txt')
-rw-r--r--Documentation/networking/timestamping.txt16
1 files changed, 7 insertions, 9 deletions
diff --git a/Documentation/networking/timestamping.txt b/Documentation/networking/timestamping.txt
index bc3554124903..897f942b976b 100644
--- a/Documentation/networking/timestamping.txt
+++ b/Documentation/networking/timestamping.txt
@@ -40,7 +40,7 @@ the set bits correspond to data that is available, then the control
40message will not be generated: 40message will not be generated:
41 41
42SOF_TIMESTAMPING_SOFTWARE: report systime if available 42SOF_TIMESTAMPING_SOFTWARE: report systime if available
43SOF_TIMESTAMPING_SYS_HARDWARE: report hwtimetrans if available 43SOF_TIMESTAMPING_SYS_HARDWARE: report hwtimetrans if available (deprecated)
44SOF_TIMESTAMPING_RAW_HARDWARE: report hwtimeraw if available 44SOF_TIMESTAMPING_RAW_HARDWARE: report hwtimeraw if available
45 45
46It is worth noting that timestamps may be collected for reasons other 46It is worth noting that timestamps may be collected for reasons other
@@ -88,13 +88,12 @@ hwtimeraw is the original hardware time stamp. Filled in if
88SOF_TIMESTAMPING_RAW_HARDWARE is set. No assumptions about its 88SOF_TIMESTAMPING_RAW_HARDWARE is set. No assumptions about its
89relation to system time should be made. 89relation to system time should be made.
90 90
91hwtimetrans is the hardware time stamp transformed so that it 91hwtimetrans is always zero. This field is deprecated. It used to hold
92corresponds as good as possible to system time. This correlation is 92hw timestamps converted to system time. Instead, expose the hardware
93not perfect; as a consequence, sorting packets received via different 93clock device on the NIC directly as a HW PTP clock source, to allow
94NICs by their hwtimetrans may differ from the order in which they were 94time conversion in userspace and optionally synchronize system time
95received. hwtimetrans may be non-monotonic even for the same NIC. 95with a userspace PTP stack such as linuxptp. For the PTP clock API,
96Filled in if SOF_TIMESTAMPING_SYS_HARDWARE is set. Requires support 96see Documentation/ptp/ptp.txt.
97by the network device and will be empty without that support.
98 97
99 98
100SIOCSHWTSTAMP, SIOCGHWTSTAMP: 99SIOCSHWTSTAMP, SIOCGHWTSTAMP:
@@ -185,7 +184,6 @@ struct skb_shared_hwtstamps {
185 * since arbitrary point in time 184 * since arbitrary point in time
186 */ 185 */
187 ktime_t hwtstamp; 186 ktime_t hwtstamp;
188 ktime_t syststamp; /* hwtstamp transformed to system time base */
189}; 187};
190 188
191Time stamps for outgoing packets are to be generated as follows: 189Time stamps for outgoing packets are to be generated as follows: