[mirror_ubuntu-artful-kernel.git] / include / uapi / linux / net_tstamp.h

/*
 * Userspace API for hardware time stamping of network packets
 *
 * Copyright (C) 2008,2009 Intel Corporation
 * Author: Patrick Ohly <patrick.ohly@intel.com>
 *
 */

#ifndef _NET_TIMESTAMPING_H
#define _NET_TIMESTAMPING_H

#include <linux/types.h>
#include <linux/socket.h>   /* for SO_TIMESTAMPING */

/* SO_TIMESTAMPING gets an integer bit field comprised of these values */
enum {
	SOF_TIMESTAMPING_TX_HARDWARE = (1<<0),
	SOF_TIMESTAMPING_TX_SOFTWARE = (1<<1),
	SOF_TIMESTAMPING_RX_HARDWARE = (1<<2),
	SOF_TIMESTAMPING_RX_SOFTWARE = (1<<3),
	SOF_TIMESTAMPING_SOFTWARE = (1<<4),
	SOF_TIMESTAMPING_SYS_HARDWARE = (1<<5),
	SOF_TIMESTAMPING_RAW_HARDWARE = (1<<6),
	SOF_TIMESTAMPING_OPT_ID = (1<<7),
	SOF_TIMESTAMPING_TX_SCHED = (1<<8),
	SOF_TIMESTAMPING_TX_ACK = (1<<9),
	SOF_TIMESTAMPING_OPT_CMSG = (1<<10),
	SOF_TIMESTAMPING_OPT_TSONLY = (1<<11),
	SOF_TIMESTAMPING_OPT_STATS = (1<<12),
	SOF_TIMESTAMPING_OPT_PKTINFO = (1<<13),
	SOF_TIMESTAMPING_OPT_TX_SWHW = (1<<14),

	SOF_TIMESTAMPING_LAST = SOF_TIMESTAMPING_OPT_TX_SWHW,
	SOF_TIMESTAMPING_MASK = (SOF_TIMESTAMPING_LAST - 1) |
				 SOF_TIMESTAMPING_LAST
};

/*
 * SO_TIMESTAMPING flags are either for recording a packet timestamp or for
 * reporting the timestamp to user space.
 * Recording flags can be set both via socket options and control messages.
 */
#define SOF_TIMESTAMPING_TX_RECORD_MASK	(SOF_TIMESTAMPING_TX_HARDWARE | \
					 SOF_TIMESTAMPING_TX_SOFTWARE | \
					 SOF_TIMESTAMPING_TX_SCHED | \
					 SOF_TIMESTAMPING_TX_ACK)

/**
 * struct hwtstamp_config - %SIOCGHWTSTAMP and %SIOCSHWTSTAMP parameter
 *
 * @flags:	no flags defined right now, must be zero for %SIOCSHWTSTAMP
 * @tx_type:	one of HWTSTAMP_TX_*
 * @rx_filter:	one of HWTSTAMP_FILTER_*
 *
 * %SIOCGHWTSTAMP and %SIOCSHWTSTAMP expect a &struct ifreq with a
 * ifr_data pointer to this structure.  For %SIOCSHWTSTAMP, if the
 * driver or hardware does not support the requested @rx_filter value,
 * the driver may use a more general filter mode.  In this case
 * @rx_filter will indicate the actual mode on return.
 */
struct hwtstamp_config {
	int flags;
	int tx_type;
	int rx_filter;
};

/* possible values for hwtstamp_config->tx_type */
enum hwtstamp_tx_types {
	/*
	 * No outgoing packet will need hardware time stamping;
	 * should a packet arrive which asks for it, no hardware
	 * time stamping will be done.
	 */
	HWTSTAMP_TX_OFF,

	/*
	 * Enables hardware time stamping for outgoing packets;
	 * the sender of the packet decides which are to be
	 * time stamped by setting %SOF_TIMESTAMPING_TX_SOFTWARE
	 * before sending the packet.
	 */
	HWTSTAMP_TX_ON,

	/*
	 * Enables time stamping for outgoing packets just as
	 * HWTSTAMP_TX_ON does, but also enables time stamp insertion
	 * directly into Sync packets. In this case, transmitted Sync
	 * packets will not received a time stamp via the socket error
	 * queue.
	 */
	HWTSTAMP_TX_ONESTEP_SYNC,
};

/* possible values for hwtstamp_config->rx_filter */
enum hwtstamp_rx_filters {
	/* time stamp no incoming packet at all */
	HWTSTAMP_FILTER_NONE,

	/* time stamp any incoming packet */
	HWTSTAMP_FILTER_ALL,

	/* return value: time stamp all packets requested plus some others */
	HWTSTAMP_FILTER_SOME,

	/* PTP v1, UDP, any kind of event packet */
	HWTSTAMP_FILTER_PTP_V1_L4_EVENT,
	/* PTP v1, UDP, Sync packet */
	HWTSTAMP_FILTER_PTP_V1_L4_SYNC,
	/* PTP v1, UDP, Delay_req packet */
	HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ,
	/* PTP v2, UDP, any kind of event packet */
	HWTSTAMP_FILTER_PTP_V2_L4_EVENT,
	/* PTP v2, UDP, Sync packet */
	HWTSTAMP_FILTER_PTP_V2_L4_SYNC,
	/* PTP v2, UDP, Delay_req packet */
	HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ,

	/* 802.AS1, Ethernet, any kind of event packet */
	HWTSTAMP_FILTER_PTP_V2_L2_EVENT,
	/* 802.AS1, Ethernet, Sync packet */
	HWTSTAMP_FILTER_PTP_V2_L2_SYNC,
	/* 802.AS1, Ethernet, Delay_req packet */
	HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ,

	/* PTP v2/802.AS1, any layer, any kind of event packet */
	HWTSTAMP_FILTER_PTP_V2_EVENT,
	/* PTP v2/802.AS1, any layer, Sync packet */
	HWTSTAMP_FILTER_PTP_V2_SYNC,
	/* PTP v2/802.AS1, any layer, Delay_req packet */
	HWTSTAMP_FILTER_PTP_V2_DELAY_REQ,

	/* NTP, UDP, all versions and packet modes */
	HWTSTAMP_FILTER_NTP_ALL,
};

/* SCM_TIMESTAMPING_PKTINFO control message */
struct scm_ts_pktinfo {
	__u32 if_index;
	__u32 pkt_length;
	__u32 reserved[2];
};

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