[linux-2.6-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_EV_PORT 319
#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

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

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 0;
}
#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 RC	33
15f0127d RC	34	#define PTP_EV_PORT 319
f75159e9	35	#define PTP_GEN_BIT 0x08 /* indicates general message, if set in message type */
15f0127d	36
d94ba80e RC	37	#define OFF_PTP_SOURCE_UUID 22 /* PTPv1 only */
d94ba80e RC	38	#define OFF_PTP_SEQUENCE_ID 30
d94ba80e	39
408eccce	40	/* Below defines should actually be removed at some point in time. */
15f0127d RC	41	#define IP6_HLEN 40
15f0127d RC	42	#define UDP_HLEN 8
408eccce	43	#define OFF_IHL 14
408eccce	44	#define IPV4_HLEN(data) (((struct iphdr *)(data + OFF_IHL))->ihl << 2)
15f0127d	45
bdfbb63c KK	46	struct clock_identity {
	47	u8 id[8];
	48	} __packed;
	49
	50	struct port_identity {
	51	struct clock_identity clock_identity;
	52	__be16 port_number;
	53	} __packed;
	54
	55	struct ptp_header {
	56	u8 tsmt; /* transportSpecific \| messageType */
	57	u8 ver; /* reserved \| versionPTP */
	58	__be16 message_length;
	59	u8 domain_number;
	60	u8 reserved1;
	61	u8 flag_field[2];
	62	__be64 correction;
	63	__be32 reserved2;
	64	struct port_identity source_port_identity;
	65	__be16 sequence_id;
	66	u8 control;
	67	u8 log_message_interval;
	68	} __packed;
	69
408eccce DB	70	#if defined(CONFIG_NET_PTP_CLASSIFY)
	71	/**
	72	* ptp_classify_raw - classify a PTP packet
	73	* @skb: buffer
	74	*
	75	* Runs a minimal BPF dissector to classify a network packet to
	76	* determine the PTP class. In case the skb does not contain any
	77	* PTP protocol data, PTP_CLASS_NONE will be returned, otherwise
	78	* PTP_CLASS_V1_IPV{4,6}, PTP_CLASS_V2_IPV{4,6} or
	79	* PTP_CLASS_V2_{L2,VLAN}, depending on the packet content.
	80	*/
164d8c66 DB	81	unsigned int ptp_classify_raw(const struct sk_buff *skb);
164d8c66 DB	82
bdfbb63c KK	83	/**
	84	* ptp_parse_header - Get pointer to the PTP v2 header
	85	* @skb: packet buffer
	86	* @type: type of the packet (see ptp_classify_raw())
	87	*
	88	* This function takes care of the VLAN, UDP, IPv4 and IPv6 headers. The length
	89	* is checked.
	90	*
	91	* Note, internally skb_mac_header() is used. Make sure that the @skb is
	92	* initialized accordingly.
	93	*
	94	* Return: Pointer to the ptp v2 header or NULL if not found
	95	*/
	96	struct ptp_header ptp_parse_header(struct sk_buff skb, unsigned int type);
	97
036c508b KK	98	/**
	99	* ptp_get_msgtype - Extract ptp message type from given header
	100	* @hdr: ptp header
	101	* @type: type of the packet (see ptp_classify_raw())
	102	*
	103	* This function returns the message type for a given ptp header. It takes care
	104	* of the different ptp header versions (v1 or v2).
	105	*
	106	* Return: The message type
	107	*/
	108	static inline u8 ptp_get_msgtype(const struct ptp_header *hdr,
	109	unsigned int type)
	110	{
	111	u8 msgtype;
	112
	113	if (unlikely(type & PTP_CLASS_V1)) {
	114	/* msg type is located at the control field for ptp v1 */
	115	msgtype = hdr->control;
	116	} else {
	117	msgtype = hdr->tsmt & 0x0f;
	118	}
	119
	120	return msgtype;
	121	}
	122
408eccce DB	123	void __init ptp_classifier_init(void);
	124	#else
	125	static inline void ptp_classifier_init(void)
	126	{
	127	}
052fddfb AL	128	static inline unsigned int ptp_classify_raw(struct sk_buff *skb)
	129	{
	130	return PTP_CLASS_NONE;
	131	}
bdfbb63c KK	132	static inline struct ptp_header ptp_parse_header(struct sk_buff skb,
	133	unsigned int type)
	134	{
	135	return NULL;
	136	}
e6221295 YL	137	static inline u8 ptp_get_msgtype(const struct ptp_header *hdr,
	138	unsigned int type)
	139	{
	140	/* The return is meaningless. The stub function would not be
	141	* executed since no available header from ptp_parse_header.
	142	*/
	143	return 0;
	144	}
15f0127d	145	#endif
408eccce	146	#endif /* _PTP_CLASSIFY_H_ */