[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 _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,

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

/* 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];
};

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