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