net_tstamp.h 3.6 KB

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