1 /* 2 * Userspace API for hardware time stamping of network packets 3 * 4 * Copyright (C) 2008,2009 Intel Corporation 5 * Author: Patrick Ohly <patrick.ohly@intel.com> 6 * 7 */ 8 9 #ifndef _NET_TIMESTAMPING_H 10 #define _NET_TIMESTAMPING_H 11 12 #include <linux/socket.h> /* for SO_TIMESTAMPING */ 13 14 /* SO_TIMESTAMPING gets an integer bit field comprised of these values */ 15 enum { 16 SOF_TIMESTAMPING_TX_HARDWARE = (1<<0), 17 SOF_TIMESTAMPING_TX_SOFTWARE = (1<<1), 18 SOF_TIMESTAMPING_RX_HARDWARE = (1<<2), 19 SOF_TIMESTAMPING_RX_SOFTWARE = (1<<3), 20 SOF_TIMESTAMPING_SOFTWARE = (1<<4), 21 SOF_TIMESTAMPING_SYS_HARDWARE = (1<<5), 22 SOF_TIMESTAMPING_RAW_HARDWARE = (1<<6), 23 SOF_TIMESTAMPING_OPT_ID = (1<<7), 24 SOF_TIMESTAMPING_TX_SCHED = (1<<8), 25 SOF_TIMESTAMPING_TX_ACK = (1<<9), 26 27 SOF_TIMESTAMPING_LAST = SOF_TIMESTAMPING_TX_ACK, 28 SOF_TIMESTAMPING_MASK = (SOF_TIMESTAMPING_LAST - 1) | 29 SOF_TIMESTAMPING_LAST 30 }; 31 32 /** 33 * struct hwtstamp_config - %SIOCGHWTSTAMP and %SIOCSHWTSTAMP parameter 34 * 35 * @flags: no flags defined right now, must be zero for %SIOCSHWTSTAMP 36 * @tx_type: one of HWTSTAMP_TX_* 37 * @rx_filter: one of HWTSTAMP_FILTER_* 38 * 39 * %SIOCGHWTSTAMP and %SIOCSHWTSTAMP expect a &struct ifreq with a 40 * ifr_data pointer to this structure. For %SIOCSHWTSTAMP, if the 41 * driver or hardware does not support the requested @rx_filter value, 42 * the driver may use a more general filter mode. In this case 43 * @rx_filter will indicate the actual mode on return. 44 */ 45 struct hwtstamp_config { 46 int flags; 47 int tx_type; 48 int rx_filter; 49 }; 50 51 /* possible values for hwtstamp_config->tx_type */ 52 enum hwtstamp_tx_types { 53 /* 54 * No outgoing packet will need hardware time stamping; 55 * should a packet arrive which asks for it, no hardware 56 * time stamping will be done. 57 */ 58 HWTSTAMP_TX_OFF, 59 60 /* 61 * Enables hardware time stamping for outgoing packets; 62 * the sender of the packet decides which are to be 63 * time stamped by setting %SOF_TIMESTAMPING_TX_SOFTWARE 64 * before sending the packet. 65 */ 66 HWTSTAMP_TX_ON, 67 68 /* 69 * Enables time stamping for outgoing packets just as 70 * HWTSTAMP_TX_ON does, but also enables time stamp insertion 71 * directly into Sync packets. In this case, transmitted Sync 72 * packets will not received a time stamp via the socket error 73 * queue. 74 */ 75 HWTSTAMP_TX_ONESTEP_SYNC, 76 }; 77 78 /* possible values for hwtstamp_config->rx_filter */ 79 enum hwtstamp_rx_filters { 80 /* time stamp no incoming packet at all */ 81 HWTSTAMP_FILTER_NONE, 82 83 /* time stamp any incoming packet */ 84 HWTSTAMP_FILTER_ALL, 85 86 /* return value: time stamp all packets requested plus some others */ 87 HWTSTAMP_FILTER_SOME, 88 89 /* PTP v1, UDP, any kind of event packet */ 90 HWTSTAMP_FILTER_PTP_V1_L4_EVENT, 91 /* PTP v1, UDP, Sync packet */ 92 HWTSTAMP_FILTER_PTP_V1_L4_SYNC, 93 /* PTP v1, UDP, Delay_req packet */ 94 HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ, 95 /* PTP v2, UDP, any kind of event packet */ 96 HWTSTAMP_FILTER_PTP_V2_L4_EVENT, 97 /* PTP v2, UDP, Sync packet */ 98 HWTSTAMP_FILTER_PTP_V2_L4_SYNC, 99 /* PTP v2, UDP, Delay_req packet */ 100 HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ, 101 102 /* 802.AS1, Ethernet, any kind of event packet */ 103 HWTSTAMP_FILTER_PTP_V2_L2_EVENT, 104 /* 802.AS1, Ethernet, Sync packet */ 105 HWTSTAMP_FILTER_PTP_V2_L2_SYNC, 106 /* 802.AS1, Ethernet, Delay_req packet */ 107 HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ, 108 109 /* PTP v2/802.AS1, any layer, any kind of event packet */ 110 HWTSTAMP_FILTER_PTP_V2_EVENT, 111 /* PTP v2/802.AS1, any layer, Sync packet */ 112 HWTSTAMP_FILTER_PTP_V2_SYNC, 113 /* PTP v2/802.AS1, any layer, Delay_req packet */ 114 HWTSTAMP_FILTER_PTP_V2_DELAY_REQ, 115 }; 116 117 #endif /* _NET_TIMESTAMPING_H */ 118