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