include/uapi/linux/net_tstamp.h

   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/types.h>
  13 #include <linux/socket.h>   /* for SO_TIMESTAMPING */
  14
  15 /* SO_TIMESTAMPING gets an integer bit field comprised of these values */
  16 enum {
  17         SOF_TIMESTAMPING_TX_HARDWARE = (1<<0),
  18         SOF_TIMESTAMPING_TX_SOFTWARE = (1<<1),
  19         SOF_TIMESTAMPING_RX_HARDWARE = (1<<2),
  20         SOF_TIMESTAMPING_RX_SOFTWARE = (1<<3),
  21         SOF_TIMESTAMPING_SOFTWARE = (1<<4),
  22         SOF_TIMESTAMPING_SYS_HARDWARE = (1<<5),
  23         SOF_TIMESTAMPING_RAW_HARDWARE = (1<<6),
  24         SOF_TIMESTAMPING_OPT_ID = (1<<7),
  25         SOF_TIMESTAMPING_TX_SCHED = (1<<8),
  26         SOF_TIMESTAMPING_TX_ACK = (1<<9),
  27         SOF_TIMESTAMPING_OPT_CMSG = (1<<10),
  28         SOF_TIMESTAMPING_OPT_TSONLY = (1<<11),
  29         SOF_TIMESTAMPING_OPT_STATS = (1<<12),
  30         SOF_TIMESTAMPING_OPT_PKTINFO = (1<<13),
  31
  32         SOF_TIMESTAMPING_LAST = SOF_TIMESTAMPING_OPT_PKTINFO,
  33         SOF_TIMESTAMPING_MASK = (SOF_TIMESTAMPING_LAST - 1) |
  34                                  SOF_TIMESTAMPING_LAST
  35 };
  36
  37 /*
  38  * SO_TIMESTAMPING flags are either for recording a packet timestamp or for
  39  * reporting the timestamp to user space.
  40  * Recording flags can be set both via socket options and control messages.
  41  */
  42 #define SOF_TIMESTAMPING_TX_RECORD_MASK (SOF_TIMESTAMPING_TX_HARDWARE | \
  43                                          SOF_TIMESTAMPING_TX_SOFTWARE | \
  44                                          SOF_TIMESTAMPING_TX_SCHED | \
  45                                          SOF_TIMESTAMPING_TX_ACK)
  46
  47 /**
  48  * struct hwtstamp_config - %SIOCGHWTSTAMP and %SIOCSHWTSTAMP parameter
  49  *
  50  * @flags:      no flags defined right now, must be zero for %SIOCSHWTSTAMP
  51  * @tx_type:    one of HWTSTAMP_TX_*
  52  * @rx_filter:  one of HWTSTAMP_FILTER_*
  53  *
  54  * %SIOCGHWTSTAMP and %SIOCSHWTSTAMP expect a &struct ifreq with a
  55  * ifr_data pointer to this structure.  For %SIOCSHWTSTAMP, if the
  56  * driver or hardware does not support the requested @rx_filter value,
  57  * the driver may use a more general filter mode.  In this case
  58  * @rx_filter will indicate the actual mode on return.
  59  */
  60 struct hwtstamp_config {
  61         int flags;
  62         int tx_type;
  63         int rx_filter;
  64 };
  65
  66 /* possible values for hwtstamp_config->tx_type */
  67 enum hwtstamp_tx_types {
  68         /*
  69          * No outgoing packet will need hardware time stamping;
  70          * should a packet arrive which asks for it, no hardware
  71          * time stamping will be done.
  72          */
  73         HWTSTAMP_TX_OFF,
  74
  75         /*
  76          * Enables hardware time stamping for outgoing packets;
  77          * the sender of the packet decides which are to be
  78          * time stamped by setting %SOF_TIMESTAMPING_TX_SOFTWARE
  79          * before sending the packet.
  80          */
  81         HWTSTAMP_TX_ON,
  82
  83         /*
  84          * Enables time stamping for outgoing packets just as
  85          * HWTSTAMP_TX_ON does, but also enables time stamp insertion
  86          * directly into Sync packets. In this case, transmitted Sync
  87          * packets will not received a time stamp via the socket error
  88          * queue.
  89          */
  90         HWTSTAMP_TX_ONESTEP_SYNC,
  91 };
  92
  93 /* possible values for hwtstamp_config->rx_filter */
  94 enum hwtstamp_rx_filters {
  95         /* time stamp no incoming packet at all */
  96         HWTSTAMP_FILTER_NONE,
  97
  98         /* time stamp any incoming packet */
  99         HWTSTAMP_FILTER_ALL,
 100
 101         /* return value: time stamp all packets requested plus some others */
 102         HWTSTAMP_FILTER_SOME,
 103
 104         /* PTP v1, UDP, any kind of event packet */
 105         HWTSTAMP_FILTER_PTP_V1_L4_EVENT,
 106         /* PTP v1, UDP, Sync packet */
 107         HWTSTAMP_FILTER_PTP_V1_L4_SYNC,
 108         /* PTP v1, UDP, Delay_req packet */
 109         HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ,
 110         /* PTP v2, UDP, any kind of event packet */
 111         HWTSTAMP_FILTER_PTP_V2_L4_EVENT,
 112         /* PTP v2, UDP, Sync packet */
 113         HWTSTAMP_FILTER_PTP_V2_L4_SYNC,
 114         /* PTP v2, UDP, Delay_req packet */
 115         HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ,
 116
 117         /* 802.AS1, Ethernet, any kind of event packet */
 118         HWTSTAMP_FILTER_PTP_V2_L2_EVENT,
 119         /* 802.AS1, Ethernet, Sync packet */
 120         HWTSTAMP_FILTER_PTP_V2_L2_SYNC,
 121         /* 802.AS1, Ethernet, Delay_req packet */
 122         HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ,
 123
 124         /* PTP v2/802.AS1, any layer, any kind of event packet */
 125         HWTSTAMP_FILTER_PTP_V2_EVENT,
 126         /* PTP v2/802.AS1, any layer, Sync packet */
 127         HWTSTAMP_FILTER_PTP_V2_SYNC,
 128         /* PTP v2/802.AS1, any layer, Delay_req packet */
 129         HWTSTAMP_FILTER_PTP_V2_DELAY_REQ,
 130
 131         /* NTP, UDP, all versions and packet modes */
 132         HWTSTAMP_FILTER_NTP_ALL,
 133 };
 134
 135 /* SCM_TIMESTAMPING_PKTINFO control message */
 136 struct scm_ts_pktinfo {
 137         __u32 if_index;
 138         __u32 pkt_length;
 139         __u32 reserved[2];
 140 };
 141
 142 #endif /* _NET_TIMESTAMPING_H */