1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux 1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /* 2 /*
3 * Userspace API for hardware time stamping of 3 * Userspace API for hardware time stamping of network packets
4 * 4 *
5 * Copyright (C) 2008,2009 Intel Corporation 5 * Copyright (C) 2008,2009 Intel Corporation
6 * Author: Patrick Ohly <patrick.ohly@intel.co 6 * Author: Patrick Ohly <patrick.ohly@intel.com>
7 * 7 *
8 */ 8 */
9 9
10 #ifndef _NET_TIMESTAMPING_H 10 #ifndef _NET_TIMESTAMPING_H
11 #define _NET_TIMESTAMPING_H 11 #define _NET_TIMESTAMPING_H
12 12
13 #include <linux/types.h> 13 #include <linux/types.h>
14 #include <linux/socket.h> /* for SO_TIMESTAM 14 #include <linux/socket.h> /* for SO_TIMESTAMPING */
15 15
16 /* SO_TIMESTAMPING flags */ 16 /* SO_TIMESTAMPING flags */
17 enum { 17 enum {
18 SOF_TIMESTAMPING_TX_HARDWARE = (1<<0), 18 SOF_TIMESTAMPING_TX_HARDWARE = (1<<0),
19 SOF_TIMESTAMPING_TX_SOFTWARE = (1<<1), 19 SOF_TIMESTAMPING_TX_SOFTWARE = (1<<1),
20 SOF_TIMESTAMPING_RX_HARDWARE = (1<<2), 20 SOF_TIMESTAMPING_RX_HARDWARE = (1<<2),
21 SOF_TIMESTAMPING_RX_SOFTWARE = (1<<3), 21 SOF_TIMESTAMPING_RX_SOFTWARE = (1<<3),
22 SOF_TIMESTAMPING_SOFTWARE = (1<<4), 22 SOF_TIMESTAMPING_SOFTWARE = (1<<4),
23 SOF_TIMESTAMPING_SYS_HARDWARE = (1<<5) 23 SOF_TIMESTAMPING_SYS_HARDWARE = (1<<5),
24 SOF_TIMESTAMPING_RAW_HARDWARE = (1<<6) 24 SOF_TIMESTAMPING_RAW_HARDWARE = (1<<6),
25 SOF_TIMESTAMPING_OPT_ID = (1<<7), 25 SOF_TIMESTAMPING_OPT_ID = (1<<7),
26 SOF_TIMESTAMPING_TX_SCHED = (1<<8), 26 SOF_TIMESTAMPING_TX_SCHED = (1<<8),
27 SOF_TIMESTAMPING_TX_ACK = (1<<9), 27 SOF_TIMESTAMPING_TX_ACK = (1<<9),
28 SOF_TIMESTAMPING_OPT_CMSG = (1<<10), 28 SOF_TIMESTAMPING_OPT_CMSG = (1<<10),
29 SOF_TIMESTAMPING_OPT_TSONLY = (1<<11), 29 SOF_TIMESTAMPING_OPT_TSONLY = (1<<11),
30 SOF_TIMESTAMPING_OPT_STATS = (1<<12), 30 SOF_TIMESTAMPING_OPT_STATS = (1<<12),
31 SOF_TIMESTAMPING_OPT_PKTINFO = (1<<13) 31 SOF_TIMESTAMPING_OPT_PKTINFO = (1<<13),
32 SOF_TIMESTAMPING_OPT_TX_SWHW = (1<<14) 32 SOF_TIMESTAMPING_OPT_TX_SWHW = (1<<14),
33 SOF_TIMESTAMPING_BIND_PHC = (1 << 15), 33 SOF_TIMESTAMPING_BIND_PHC = (1 << 15),
34 SOF_TIMESTAMPING_OPT_ID_TCP = (1 << 16 <<
35 SOF_TIMESTAMPING_OPT_RX_FILTER = (1 << <<
36 34
37 SOF_TIMESTAMPING_LAST = SOF_TIMESTAMPI !! 35 SOF_TIMESTAMPING_LAST = SOF_TIMESTAMPING_BIND_PHC,
38 SOF_TIMESTAMPING_MASK = (SOF_TIMESTAMP 36 SOF_TIMESTAMPING_MASK = (SOF_TIMESTAMPING_LAST - 1) |
39 SOF_TIMESTAMP 37 SOF_TIMESTAMPING_LAST
40 }; 38 };
41 39
42 /* 40 /*
43 * SO_TIMESTAMPING flags are either for record 41 * SO_TIMESTAMPING flags are either for recording a packet timestamp or for
44 * reporting the timestamp to user space. 42 * reporting the timestamp to user space.
45 * Recording flags can be set both via socket 43 * Recording flags can be set both via socket options and control messages.
46 */ 44 */
47 #define SOF_TIMESTAMPING_TX_RECORD_MASK (SOF_T 45 #define SOF_TIMESTAMPING_TX_RECORD_MASK (SOF_TIMESTAMPING_TX_HARDWARE | \
48 SOF_T 46 SOF_TIMESTAMPING_TX_SOFTWARE | \
49 SOF_T 47 SOF_TIMESTAMPING_TX_SCHED | \
50 SOF_T 48 SOF_TIMESTAMPING_TX_ACK)
51 49
52 /** 50 /**
53 * struct so_timestamping - SO_TIMESTAMPING pa 51 * struct so_timestamping - SO_TIMESTAMPING parameter
54 * 52 *
55 * @flags: SO_TIMESTAMPING flags 53 * @flags: SO_TIMESTAMPING flags
56 * @bind_phc: Index of PTP virtual clock bou 54 * @bind_phc: Index of PTP virtual clock bound to sock. This is available
57 * if flag SOF_TIMESTAMPING_BIND_ 55 * if flag SOF_TIMESTAMPING_BIND_PHC is set.
58 */ 56 */
59 struct so_timestamping { 57 struct so_timestamping {
60 int flags; 58 int flags;
61 int bind_phc; 59 int bind_phc;
62 }; 60 };
63 61
64 /** 62 /**
65 * struct hwtstamp_config - %SIOCGHWTSTAMP and 63 * struct hwtstamp_config - %SIOCGHWTSTAMP and %SIOCSHWTSTAMP parameter
66 * 64 *
67 * @flags: one of HWTSTAMP_FLAG_* !! 65 * @flags: no flags defined right now, must be zero for %SIOCSHWTSTAMP
68 * @tx_type: one of HWTSTAMP_TX_* 66 * @tx_type: one of HWTSTAMP_TX_*
69 * @rx_filter: one of HWTSTAMP_FILTER_* 67 * @rx_filter: one of HWTSTAMP_FILTER_*
70 * 68 *
71 * %SIOCGHWTSTAMP and %SIOCSHWTSTAMP expect a 69 * %SIOCGHWTSTAMP and %SIOCSHWTSTAMP expect a &struct ifreq with a
72 * ifr_data pointer to this structure. For %S 70 * ifr_data pointer to this structure. For %SIOCSHWTSTAMP, if the
73 * driver or hardware does not support the req 71 * driver or hardware does not support the requested @rx_filter value,
74 * the driver may use a more general filter mo 72 * the driver may use a more general filter mode. In this case
75 * @rx_filter will indicate the actual mode on 73 * @rx_filter will indicate the actual mode on return.
76 */ 74 */
77 struct hwtstamp_config { 75 struct hwtstamp_config {
78 int flags; 76 int flags;
79 int tx_type; 77 int tx_type;
80 int rx_filter; 78 int rx_filter;
81 }; <<
82 <<
83 /* possible values for hwtstamp_config->flags <<
84 enum hwtstamp_flags { <<
85 /* <<
86 * With this flag, the user could get <<
87 * PHC index. Note this PHC index is n <<
88 * is a failover, the bond active inte <<
89 * will be the PHC index. <<
90 */ <<
91 HWTSTAMP_FLAG_BONDED_PHC_INDEX = (1<<0 <<
92 #define HWTSTAMP_FLAG_BONDED_PHC_INDEX HWTSTA <<
93 <<
94 HWTSTAMP_FLAG_LAST = HWTSTAMP_FLAG_BON <<
95 HWTSTAMP_FLAG_MASK = (HWTSTAMP_FLAG_LA <<
96 }; 79 };
97 80
98 /* possible values for hwtstamp_config->tx_typ 81 /* possible values for hwtstamp_config->tx_type */
99 enum hwtstamp_tx_types { 82 enum hwtstamp_tx_types {
100 /* 83 /*
101 * No outgoing packet will need hardwa 84 * No outgoing packet will need hardware time stamping;
102 * should a packet arrive which asks f 85 * should a packet arrive which asks for it, no hardware
103 * time stamping will be done. 86 * time stamping will be done.
104 */ 87 */
105 HWTSTAMP_TX_OFF, 88 HWTSTAMP_TX_OFF,
106 89
107 /* 90 /*
108 * Enables hardware time stamping for 91 * Enables hardware time stamping for outgoing packets;
109 * the sender of the packet decides wh 92 * the sender of the packet decides which are to be
110 * time stamped by setting %SOF_TIMEST 93 * time stamped by setting %SOF_TIMESTAMPING_TX_SOFTWARE
111 * before sending the packet. 94 * before sending the packet.
112 */ 95 */
113 HWTSTAMP_TX_ON, 96 HWTSTAMP_TX_ON,
114 97
115 /* 98 /*
116 * Enables time stamping for outgoing 99 * Enables time stamping for outgoing packets just as
117 * HWTSTAMP_TX_ON does, but also enabl 100 * HWTSTAMP_TX_ON does, but also enables time stamp insertion
118 * directly into Sync packets. In this 101 * directly into Sync packets. In this case, transmitted Sync
119 * packets will not received a time st 102 * packets will not received a time stamp via the socket error
120 * queue. 103 * queue.
121 */ 104 */
122 HWTSTAMP_TX_ONESTEP_SYNC, 105 HWTSTAMP_TX_ONESTEP_SYNC,
123 106
124 /* 107 /*
125 * Same as HWTSTAMP_TX_ONESTEP_SYNC, b 108 * Same as HWTSTAMP_TX_ONESTEP_SYNC, but also enables time
126 * stamp insertion directly into PDela 109 * stamp insertion directly into PDelay_Resp packets. In this
127 * case, neither transmitted Sync nor 110 * case, neither transmitted Sync nor PDelay_Resp packets will
128 * receive a time stamp via the socket 111 * receive a time stamp via the socket error queue.
129 */ 112 */
130 HWTSTAMP_TX_ONESTEP_P2P, 113 HWTSTAMP_TX_ONESTEP_P2P,
131 114
132 /* add new constants above here */ 115 /* add new constants above here */
133 __HWTSTAMP_TX_CNT 116 __HWTSTAMP_TX_CNT
134 }; 117 };
135 118
136 /* possible values for hwtstamp_config->rx_fil 119 /* possible values for hwtstamp_config->rx_filter */
137 enum hwtstamp_rx_filters { 120 enum hwtstamp_rx_filters {
138 /* time stamp no incoming packet at al 121 /* time stamp no incoming packet at all */
139 HWTSTAMP_FILTER_NONE, 122 HWTSTAMP_FILTER_NONE,
140 123
141 /* time stamp any incoming packet */ 124 /* time stamp any incoming packet */
142 HWTSTAMP_FILTER_ALL, 125 HWTSTAMP_FILTER_ALL,
143 126
144 /* return value: time stamp all packet 127 /* return value: time stamp all packets requested plus some others */
145 HWTSTAMP_FILTER_SOME, 128 HWTSTAMP_FILTER_SOME,
146 129
147 /* PTP v1, UDP, any kind of event pack 130 /* PTP v1, UDP, any kind of event packet */
148 HWTSTAMP_FILTER_PTP_V1_L4_EVENT, 131 HWTSTAMP_FILTER_PTP_V1_L4_EVENT,
149 /* PTP v1, UDP, Sync packet */ 132 /* PTP v1, UDP, Sync packet */
150 HWTSTAMP_FILTER_PTP_V1_L4_SYNC, 133 HWTSTAMP_FILTER_PTP_V1_L4_SYNC,
151 /* PTP v1, UDP, Delay_req packet */ 134 /* PTP v1, UDP, Delay_req packet */
152 HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ, 135 HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ,
153 /* PTP v2, UDP, any kind of event pack 136 /* PTP v2, UDP, any kind of event packet */
154 HWTSTAMP_FILTER_PTP_V2_L4_EVENT, 137 HWTSTAMP_FILTER_PTP_V2_L4_EVENT,
155 /* PTP v2, UDP, Sync packet */ 138 /* PTP v2, UDP, Sync packet */
156 HWTSTAMP_FILTER_PTP_V2_L4_SYNC, 139 HWTSTAMP_FILTER_PTP_V2_L4_SYNC,
157 /* PTP v2, UDP, Delay_req packet */ 140 /* PTP v2, UDP, Delay_req packet */
158 HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ, 141 HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ,
159 142
160 /* 802.AS1, Ethernet, any kind of even 143 /* 802.AS1, Ethernet, any kind of event packet */
161 HWTSTAMP_FILTER_PTP_V2_L2_EVENT, 144 HWTSTAMP_FILTER_PTP_V2_L2_EVENT,
162 /* 802.AS1, Ethernet, Sync packet */ 145 /* 802.AS1, Ethernet, Sync packet */
163 HWTSTAMP_FILTER_PTP_V2_L2_SYNC, 146 HWTSTAMP_FILTER_PTP_V2_L2_SYNC,
164 /* 802.AS1, Ethernet, Delay_req packet 147 /* 802.AS1, Ethernet, Delay_req packet */
165 HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ, 148 HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ,
166 149
167 /* PTP v2/802.AS1, any layer, any kind 150 /* PTP v2/802.AS1, any layer, any kind of event packet */
168 HWTSTAMP_FILTER_PTP_V2_EVENT, 151 HWTSTAMP_FILTER_PTP_V2_EVENT,
169 /* PTP v2/802.AS1, any layer, Sync pac 152 /* PTP v2/802.AS1, any layer, Sync packet */
170 HWTSTAMP_FILTER_PTP_V2_SYNC, 153 HWTSTAMP_FILTER_PTP_V2_SYNC,
171 /* PTP v2/802.AS1, any layer, Delay_re 154 /* PTP v2/802.AS1, any layer, Delay_req packet */
172 HWTSTAMP_FILTER_PTP_V2_DELAY_REQ, 155 HWTSTAMP_FILTER_PTP_V2_DELAY_REQ,
173 156
174 /* NTP, UDP, all versions and packet m 157 /* NTP, UDP, all versions and packet modes */
175 HWTSTAMP_FILTER_NTP_ALL, 158 HWTSTAMP_FILTER_NTP_ALL,
176 159
177 /* add new constants above here */ 160 /* add new constants above here */
178 __HWTSTAMP_FILTER_CNT 161 __HWTSTAMP_FILTER_CNT
179 }; 162 };
180 163
181 /* SCM_TIMESTAMPING_PKTINFO control message */ 164 /* SCM_TIMESTAMPING_PKTINFO control message */
182 struct scm_ts_pktinfo { 165 struct scm_ts_pktinfo {
183 __u32 if_index; 166 __u32 if_index;
184 __u32 pkt_length; 167 __u32 pkt_length;
185 __u32 reserved[2]; 168 __u32 reserved[2];
186 }; 169 };
187 170
188 /* 171 /*
189 * SO_TXTIME gets a struct sock_txtime with fl 172 * SO_TXTIME gets a struct sock_txtime with flags being an integer bit
190 * field comprised of these values. 173 * field comprised of these values.
191 */ 174 */
192 enum txtime_flags { 175 enum txtime_flags {
193 SOF_TXTIME_DEADLINE_MODE = (1 << 0), 176 SOF_TXTIME_DEADLINE_MODE = (1 << 0),
194 SOF_TXTIME_REPORT_ERRORS = (1 << 1), 177 SOF_TXTIME_REPORT_ERRORS = (1 << 1),
195 178
196 SOF_TXTIME_FLAGS_LAST = SOF_TXTIME_REP 179 SOF_TXTIME_FLAGS_LAST = SOF_TXTIME_REPORT_ERRORS,
197 SOF_TXTIME_FLAGS_MASK = (SOF_TXTIME_FL 180 SOF_TXTIME_FLAGS_MASK = (SOF_TXTIME_FLAGS_LAST - 1) |
198 SOF_TXTIME_FL 181 SOF_TXTIME_FLAGS_LAST
199 }; 182 };
200 183
201 struct sock_txtime { 184 struct sock_txtime {
202 __kernel_clockid_t clockid;/* ref 185 __kernel_clockid_t clockid;/* reference clockid */
203 __u32 flags; /* as 186 __u32 flags; /* as defined by enum txtime_flags */
204 }; 187 };
205 188
206 #endif /* _NET_TIMESTAMPING_H */ 189 #endif /* _NET_TIMESTAMPING_H */
207 190
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.