[linux-block.git] / include / uapi / linux / net_tstamp.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 * Userspace API for hardware time stamping of network packets
 *
 * Copyright (C) 2008,2009 Intel Corporation
 * Author: Patrick Ohly <patrick.ohly@intel.com>
 *
 */

#ifndef _UAPI_NET_TIMESTAMPING_H
#define _UAPI_NET_TIMESTAMPING_H

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

/*
 * Possible type of hwtstamp provider. Mainly "precise" the default one
 * is for IEEE 1588 quality and "approx" is for NICs DMA point.
 */
enum hwtstamp_provider_qualifier {
	HWTSTAMP_PROVIDER_QUALIFIER_PRECISE,
	HWTSTAMP_PROVIDER_QUALIFIER_APPROX,

	HWTSTAMP_PROVIDER_QUALIFIER_CNT,
};

/* SO_TIMESTAMPING flags */
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_BIND_PHC = (1 << 15),
	SOF_TIMESTAMPING_OPT_ID_TCP = (1 << 16),
	SOF_TIMESTAMPING_OPT_RX_FILTER = (1 << 17),
	SOF_TIMESTAMPING_TX_COMPLETION = (1 << 18),

	SOF_TIMESTAMPING_LAST = SOF_TIMESTAMPING_TX_COMPLETION,
	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 | \
					 SOF_TIMESTAMPING_TX_COMPLETION)

/**
 * struct so_timestamping - SO_TIMESTAMPING parameter
 *
 * @flags:	SO_TIMESTAMPING flags
 * @bind_phc:	Index of PTP virtual clock bound to sock. This is available
 *		if flag SOF_TIMESTAMPING_BIND_PHC is set.
 */
struct so_timestamping {
	int flags;
	int bind_phc;
};

/**
 * struct hwtstamp_config - %SIOCGHWTSTAMP and %SIOCSHWTSTAMP parameter
 *
 * @flags:	one of HWTSTAMP_FLAG_*
 * @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->flags */
enum hwtstamp_flags {
	/*
	 * With this flag, the user could get bond active interface's
	 * PHC index. Note this PHC index is not stable as when there
	 * is a failover, the bond active interface will be changed, so
	 * will be the PHC index.
	 */
	HWTSTAMP_FLAG_BONDED_PHC_INDEX = (1<<0),
#define HWTSTAMP_FLAG_BONDED_PHC_INDEX	HWTSTAMP_FLAG_BONDED_PHC_INDEX

	HWTSTAMP_FLAG_LAST = HWTSTAMP_FLAG_BONDED_PHC_INDEX,
	HWTSTAMP_FLAG_MASK = (HWTSTAMP_FLAG_LAST - 1) | HWTSTAMP_FLAG_LAST
};

/* 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,

	/*
	 * Same as HWTSTAMP_TX_ONESTEP_SYNC, but also enables time
	 * stamp insertion directly into PDelay_Resp packets. In this
	 * case, neither transmitted Sync nor PDelay_Resp packets will
	 * receive a time stamp via the socket error queue.
	 */
	HWTSTAMP_TX_ONESTEP_P2P,

	/* add new constants above here */
	__HWTSTAMP_TX_CNT
};

/* 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,

	/* add new constants above here */
	__HWTSTAMP_FILTER_CNT
};

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

/*
 * SO_TXTIME gets a struct sock_txtime with flags being an integer bit
 * field comprised of these values.
 */
enum txtime_flags {
	SOF_TXTIME_DEADLINE_MODE = (1 << 0),
	SOF_TXTIME_REPORT_ERRORS = (1 << 1),

	SOF_TXTIME_FLAGS_LAST = SOF_TXTIME_REPORT_ERRORS,
	SOF_TXTIME_FLAGS_MASK = (SOF_TXTIME_FLAGS_LAST - 1) |
				 SOF_TXTIME_FLAGS_LAST
};

struct sock_txtime {
	__kernel_clockid_t	clockid;/* reference clockid */
	__u32			flags;	/* as defined by enum txtime_flags */
};

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