[linux-block.git] / include / linux / ptp_classify.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * PTP 1588 support
 *
 * This file implements a BPF that recognizes PTP event messages.
 *
 * Copyright (C) 2010 OMICRON electronics GmbH
 */

#ifndef _PTP_CLASSIFY_H_
#define _PTP_CLASSIFY_H_

#include <linux/ip.h>
#include <linux/skbuff.h>

#define PTP_CLASS_NONE  0x00 /* not a PTP event message */
#define PTP_CLASS_V1    0x01 /* protocol version 1 */
#define PTP_CLASS_V2    0x02 /* protocol version 2 */
#define PTP_CLASS_VMASK 0x0f /* max protocol version is 15 */
#define PTP_CLASS_IPV4  0x10 /* event in an IPV4 UDP packet */
#define PTP_CLASS_IPV6  0x20 /* event in an IPV6 UDP packet */
#define PTP_CLASS_L2    0x40 /* event in a L2 packet */
#define PTP_CLASS_PMASK	0x70 /* mask for the packet type field */
#define PTP_CLASS_VLAN	0x80 /* event in a VLAN tagged packet */

#define PTP_CLASS_V1_IPV4 (PTP_CLASS_V1 | PTP_CLASS_IPV4)
#define PTP_CLASS_V1_IPV6 (PTP_CLASS_V1 | PTP_CLASS_IPV6) /* probably DNE */
#define PTP_CLASS_V2_IPV4 (PTP_CLASS_V2 | PTP_CLASS_IPV4)
#define PTP_CLASS_V2_IPV6 (PTP_CLASS_V2 | PTP_CLASS_IPV6)
#define PTP_CLASS_V2_L2   (PTP_CLASS_V2 | PTP_CLASS_L2)
#define PTP_CLASS_V2_VLAN (PTP_CLASS_V2 | PTP_CLASS_VLAN)
#define PTP_CLASS_L4      (PTP_CLASS_IPV4 | PTP_CLASS_IPV6)

#define PTP_MSGTYPE_SYNC        0x0
#define PTP_MSGTYPE_DELAY_REQ   0x1
#define PTP_MSGTYPE_PDELAY_REQ  0x2
#define PTP_MSGTYPE_PDELAY_RESP 0x3

#define PTP_EV_PORT 319
#define PTP_GEN_PORT 320
#define PTP_GEN_BIT 0x08 /* indicates general message, if set in message type */

#define OFF_PTP_SOURCE_UUID	22 /* PTPv1 only */
#define OFF_PTP_SEQUENCE_ID	30

/* PTP header flag fields */
#define PTP_FLAG_TWOSTEP	BIT(1)

/* Below defines should actually be removed at some point in time. */
#define IP6_HLEN	40
#define UDP_HLEN	8
#define OFF_IHL		14
#define IPV4_HLEN(data) (((struct iphdr *)(data + OFF_IHL))->ihl << 2)

struct clock_identity {
	u8 id[8];
} __packed;

struct port_identity {
	struct clock_identity	clock_identity;
	__be16			port_number;
} __packed;

struct ptp_header {
	u8			tsmt;  /* transportSpecific | messageType */
	u8			ver;   /* reserved          | versionPTP  */
	__be16			message_length;
	u8			domain_number;
	u8			reserved1;
	u8			flag_field[2];
	__be64			correction;
	__be32			reserved2;
	struct port_identity	source_port_identity;
	__be16			sequence_id;
	u8			control;
	u8			log_message_interval;
} __packed;

#if defined(CONFIG_NET_PTP_CLASSIFY)
/**
 * ptp_classify_raw - classify a PTP packet
 * @skb: buffer
 *
 * Runs a minimal BPF dissector to classify a network packet to
 * determine the PTP class. In case the skb does not contain any
 * PTP protocol data, PTP_CLASS_NONE will be returned, otherwise
 * PTP_CLASS_V1_IPV{4,6}, PTP_CLASS_V2_IPV{4,6} or
 * PTP_CLASS_V2_{L2,VLAN}, depending on the packet content.
 */
unsigned int ptp_classify_raw(const struct sk_buff *skb);

/**
 * ptp_parse_header - Get pointer to the PTP v2 header
 * @skb: packet buffer
 * @type: type of the packet (see ptp_classify_raw())
 *
 * This function takes care of the VLAN, UDP, IPv4 and IPv6 headers. The length
 * is checked.
 *
 * Note, internally skb_mac_header() is used. Make sure that the @skb is
 * initialized accordingly.
 *
 * Return: Pointer to the ptp v2 header or NULL if not found
 */
struct ptp_header *ptp_parse_header(struct sk_buff *skb, unsigned int type);

/**
 * ptp_get_msgtype - Extract ptp message type from given header
 * @hdr: ptp header
 * @type: type of the packet (see ptp_classify_raw())
 *
 * This function returns the message type for a given ptp header. It takes care
 * of the different ptp header versions (v1 or v2).
 *
 * Return: The message type
 */
static inline u8 ptp_get_msgtype(const struct ptp_header *hdr,
				 unsigned int type)
{
	u8 msgtype;

	if (unlikely(type & PTP_CLASS_V1)) {
		/* msg type is located at the control field for ptp v1 */
		msgtype = hdr->control;
	} else {
		msgtype = hdr->tsmt & 0x0f;
	}

	return msgtype;
}

/**
 * ptp_msg_is_sync - Evaluates whether the given skb is a PTP Sync message
 * @skb: packet buffer
 * @type: type of the packet (see ptp_classify_raw())
 *
 * This function evaluates whether the given skb is a PTP Sync message.
 *
 * Return: true if sync message, false otherwise
 */
bool ptp_msg_is_sync(struct sk_buff *skb, unsigned int type);

void __init ptp_classifier_init(void);
#else
static inline void ptp_classifier_init(void)
{
}
static inline unsigned int ptp_classify_raw(struct sk_buff *skb)
{
	return PTP_CLASS_NONE;
}
static inline struct ptp_header *ptp_parse_header(struct sk_buff *skb,
						  unsigned int type)
{
	return NULL;
}
static inline u8 ptp_get_msgtype(const struct ptp_header *hdr,
				 unsigned int type)
{
	/* The return is meaningless. The stub function would not be
	 * executed since no available header from ptp_parse_header.
	 */
	return PTP_MSGTYPE_SYNC;
}
static inline bool ptp_msg_is_sync(struct sk_buff *skb, unsigned int type)
{
	return false;
}
#endif
#endif /* _PTP_CLASSIFY_H_ */
Commit	Line	Data
74ba9207	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
15f0127d RC	2	/*
	3	* PTP 1588 support
	4	*
	5	* This file implements a BPF that recognizes PTP event messages.
	6	*
	7	* Copyright (C) 2010 OMICRON electronics GmbH
15f0127d RC	8	*/
	9
	10	#ifndef _PTP_CLASSIFY_H_
	11	#define _PTP_CLASSIFY_H_
	12
d94ba80e	13	#include <linux/ip.h>
408eccce	14	#include <linux/skbuff.h>
15f0127d RC	15
	16	#define PTP_CLASS_NONE 0x00 /* not a PTP event message */
	17	#define PTP_CLASS_V1 0x01 /* protocol version 1 */
	18	#define PTP_CLASS_V2 0x02 /* protocol version 2 */
	19	#define PTP_CLASS_VMASK 0x0f /* max protocol version is 15 */
	20	#define PTP_CLASS_IPV4 0x10 /* event in an IPV4 UDP packet */
	21	#define PTP_CLASS_IPV6 0x20 /* event in an IPV6 UDP packet */
5f94c943 SS	22	#define PTP_CLASS_L2 0x40 /* event in a L2 packet */
	23	#define PTP_CLASS_PMASK 0x70 /* mask for the packet type field */
	24	#define PTP_CLASS_VLAN 0x80 /* event in a VLAN tagged packet */
15f0127d RC	25
15f0127d RC	26	#define PTP_CLASS_V1_IPV4 (PTP_CLASS_V1 \| PTP_CLASS_IPV4)
408eccce	27	#define PTP_CLASS_V1_IPV6 (PTP_CLASS_V1 \| PTP_CLASS_IPV6) /* probably DNE */
15f0127d RC	28	#define PTP_CLASS_V2_IPV4 (PTP_CLASS_V2 \| PTP_CLASS_IPV4)
	29	#define PTP_CLASS_V2_IPV6 (PTP_CLASS_V2 \| PTP_CLASS_IPV6)
	30	#define PTP_CLASS_V2_L2 (PTP_CLASS_V2 \| PTP_CLASS_L2)
	31	#define PTP_CLASS_V2_VLAN (PTP_CLASS_V2 \| PTP_CLASS_VLAN)
5f94c943	32	#define PTP_CLASS_L4 (PTP_CLASS_IPV4 \| PTP_CLASS_IPV6)
15f0127d	33
076d38b8 CE	34	#define PTP_MSGTYPE_SYNC 0x0
	35	#define PTP_MSGTYPE_DELAY_REQ 0x1
	36	#define PTP_MSGTYPE_PDELAY_REQ 0x2
	37	#define PTP_MSGTYPE_PDELAY_RESP 0x3
	38
15f0127d	39	#define PTP_EV_PORT 319
ec15baec	40	#define PTP_GEN_PORT 320
f75159e9	41	#define PTP_GEN_BIT 0x08 /* indicates general message, if set in message type */
15f0127d	42
d94ba80e RC	43	#define OFF_PTP_SOURCE_UUID 22 /* PTPv1 only */
d94ba80e RC	44	#define OFF_PTP_SEQUENCE_ID 30
d94ba80e	45
5cebb40b HK	46	/* PTP header flag fields */
	47	#define PTP_FLAG_TWOSTEP BIT(1)
	48
408eccce	49	/* Below defines should actually be removed at some point in time. */
15f0127d RC	50	#define IP6_HLEN 40
15f0127d RC	51	#define UDP_HLEN 8
408eccce	52	#define OFF_IHL 14
408eccce	53	#define IPV4_HLEN(data) (((struct iphdr *)(data + OFF_IHL))->ihl << 2)
15f0127d	54
bdfbb63c KK	55	struct clock_identity {
	56	u8 id[8];
	57	} __packed;
	58
	59	struct port_identity {
	60	struct clock_identity clock_identity;
	61	__be16 port_number;
	62	} __packed;
	63
	64	struct ptp_header {
	65	u8 tsmt; /* transportSpecific \| messageType */
	66	u8 ver; /* reserved \| versionPTP */
	67	__be16 message_length;
	68	u8 domain_number;
	69	u8 reserved1;
	70	u8 flag_field[2];
	71	__be64 correction;
	72	__be32 reserved2;
	73	struct port_identity source_port_identity;
	74	__be16 sequence_id;
	75	u8 control;
	76	u8 log_message_interval;
	77	} __packed;
	78
408eccce DB	79	#if defined(CONFIG_NET_PTP_CLASSIFY)
	80	/**
	81	* ptp_classify_raw - classify a PTP packet
	82	* @skb: buffer
	83	*
	84	* Runs a minimal BPF dissector to classify a network packet to
	85	* determine the PTP class. In case the skb does not contain any
	86	* PTP protocol data, PTP_CLASS_NONE will be returned, otherwise
	87	* PTP_CLASS_V1_IPV{4,6}, PTP_CLASS_V2_IPV{4,6} or
	88	* PTP_CLASS_V2_{L2,VLAN}, depending on the packet content.
	89	*/
164d8c66 DB	90	unsigned int ptp_classify_raw(const struct sk_buff *skb);
164d8c66 DB	91
bdfbb63c KK	92	/**
	93	* ptp_parse_header - Get pointer to the PTP v2 header
	94	* @skb: packet buffer
	95	* @type: type of the packet (see ptp_classify_raw())
	96	*
	97	* This function takes care of the VLAN, UDP, IPv4 and IPv6 headers. The length
	98	* is checked.
	99	*
	100	* Note, internally skb_mac_header() is used. Make sure that the @skb is
	101	* initialized accordingly.
	102	*
	103	* Return: Pointer to the ptp v2 header or NULL if not found
	104	*/
	105	struct ptp_header ptp_parse_header(struct sk_buff skb, unsigned int type);
	106
036c508b KK	107	/**
	108	* ptp_get_msgtype - Extract ptp message type from given header
	109	* @hdr: ptp header
	110	* @type: type of the packet (see ptp_classify_raw())
	111	*
	112	* This function returns the message type for a given ptp header. It takes care
	113	* of the different ptp header versions (v1 or v2).
	114	*
	115	* Return: The message type
	116	*/
	117	static inline u8 ptp_get_msgtype(const struct ptp_header *hdr,
	118	unsigned int type)
	119	{
	120	u8 msgtype;
	121
	122	if (unlikely(type & PTP_CLASS_V1)) {
	123	/* msg type is located at the control field for ptp v1 */
	124	msgtype = hdr->control;
	125	} else {
	126	msgtype = hdr->tsmt & 0x0f;
	127	}
	128
	129	return msgtype;
	130	}
	131
f72de02e KK	132	/**
	133	* ptp_msg_is_sync - Evaluates whether the given skb is a PTP Sync message
	134	* @skb: packet buffer
	135	* @type: type of the packet (see ptp_classify_raw())
	136	*
	137	* This function evaluates whether the given skb is a PTP Sync message.
	138	*
	139	* Return: true if sync message, false otherwise
	140	*/
	141	bool ptp_msg_is_sync(struct sk_buff *skb, unsigned int type);
	142
408eccce DB	143	void __init ptp_classifier_init(void);
	144	#else
	145	static inline void ptp_classifier_init(void)
	146	{
	147	}
052fddfb AL	148	static inline unsigned int ptp_classify_raw(struct sk_buff *skb)
	149	{
	150	return PTP_CLASS_NONE;
	151	}
bdfbb63c KK	152	static inline struct ptp_header ptp_parse_header(struct sk_buff skb,
	153	unsigned int type)
	154	{
	155	return NULL;
	156	}
e6221295 YL	157	static inline u8 ptp_get_msgtype(const struct ptp_header *hdr,
	158	unsigned int type)
	159	{
	160	/* The return is meaningless. The stub function would not be
	161	* executed since no available header from ptp_parse_header.
	162	*/
076d38b8	163	return PTP_MSGTYPE_SYNC;
e6221295	164	}
f72de02e KK	165	static inline bool ptp_msg_is_sync(struct sk_buff *skb, unsigned int type)
	166	{
	167	return false;
	168	}
15f0127d	169	#endif
408eccce	170	#endif /* _PTP_CLASSIFY_H_ */