[deliverable/linux.git] / include / linux / ptp_classify.h

/*
 * PTP 1588 support
 *
 * This file implements a BPF that recognizes PTP event messages.
 *
 * Copyright (C) 2010 OMICRON electronics GmbH
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef _PTP_CLASSIFY_H_
#define _PTP_CLASSIFY_H_

#include <linux/if_ether.h>
#include <linux/if_vlan.h>
#include <linux/ip.h>
#include <linux/filter.h>
#ifdef __KERNEL__
#include <linux/in.h>
#else
#include <netinet/in.h>
#endif

#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    0x30 /* event in a L2 packet */
#define PTP_CLASS_VLAN  0x40 /* event in a VLAN tagged L2 packet */
#define PTP_CLASS_PMASK 0xf0 /* mask for the packet type field */

#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_EV_PORT 319

#define OFF_ETYPE	12
#define OFF_IHL		14
#define OFF_FRAG	20
#define OFF_PROTO4	23
#define OFF_NEXT	6
#define OFF_UDP_DST	2

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

#define IPV4_HLEN(data) (((struct iphdr *)(data + OFF_IHL))->ihl << 2)

#define IP6_HLEN	40
#define UDP_HLEN	8

#define RELOFF_DST4	(ETH_HLEN + OFF_UDP_DST)
#define OFF_DST6	(ETH_HLEN + IP6_HLEN + OFF_UDP_DST)
#define OFF_PTP6	(ETH_HLEN + IP6_HLEN + UDP_HLEN)

#define OP_AND	(BPF_ALU | BPF_AND  | BPF_K)
#define OP_JEQ	(BPF_JMP | BPF_JEQ  | BPF_K)
#define OP_JSET	(BPF_JMP | BPF_JSET | BPF_K)
#define OP_LDB	(BPF_LD  | BPF_B    | BPF_ABS)
#define OP_LDH	(BPF_LD  | BPF_H    | BPF_ABS)
#define OP_LDHI	(BPF_LD  | BPF_H    | BPF_IND)
#define OP_LDX	(BPF_LDX | BPF_B    | BPF_MSH)
#define OP_OR	(BPF_ALU | BPF_OR   | BPF_K)
#define OP_RETA	(BPF_RET | BPF_A)
#define OP_RETK	(BPF_RET | BPF_K)

static inline int ptp_filter_init(struct sock_filter *f, int len)
{
	if (OP_LDH == f[0].code)
		return sk_chk_filter(f, len);
	else
		return 0;
}

#define PTP_FILTER \
	{OP_LDH,	0,   0, OFF_ETYPE		}, /*              */ \
	{OP_JEQ,	0,  12, ETH_P_IP		}, /* f goto L20   */ \
	{OP_LDB,	0,   0, OFF_PROTO4		}, /*              */ \
	{OP_JEQ,	0,   9, IPPROTO_UDP		}, /* f goto L10   */ \
	{OP_LDH,	0,   0, OFF_FRAG		}, /*              */ \
	{OP_JSET,	7,   0, 0x1fff			}, /* t goto L11   */ \
	{OP_LDX,	0,   0, OFF_IHL			}, /*              */ \
	{OP_LDHI,	0,   0, RELOFF_DST4		}, /*              */ \
	{OP_JEQ,	0,   4, PTP_EV_PORT		}, /* f goto L12   */ \
	{OP_LDHI,	0,   0, ETH_HLEN + UDP_HLEN	}, /*              */ \
	{OP_AND,	0,   0, PTP_CLASS_VMASK		}, /*              */ \
	{OP_OR,		0,   0, PTP_CLASS_IPV4		}, /*              */ \
	{OP_RETA,	0,   0, 0			}, /*              */ \
/*L1x*/	{OP_RETK,	0,   0, PTP_CLASS_NONE		}, /*              */ \
/*L20*/	{OP_JEQ,	0,   9, ETH_P_IPV6		}, /* f goto L40   */ \
	{OP_LDB,	0,   0, ETH_HLEN + OFF_NEXT	}, /*              */ \
	{OP_JEQ,	0,   6, IPPROTO_UDP		}, /* f goto L30   */ \
	{OP_LDH,	0,   0, OFF_DST6		}, /*              */ \
	{OP_JEQ,	0,   4, PTP_EV_PORT		}, /* f goto L31   */ \
	{OP_LDH,	0,   0, OFF_PTP6		}, /*              */ \
	{OP_AND,	0,   0, PTP_CLASS_VMASK		}, /*              */ \
	{OP_OR,		0,   0, PTP_CLASS_IPV6		}, /*              */ \
	{OP_RETA,	0,   0, 0			}, /*              */ \
/*L3x*/	{OP_RETK,	0,   0, PTP_CLASS_NONE		}, /*              */ \
/*L40*/	{OP_JEQ,	0,   6, ETH_P_8021Q		}, /* f goto L50   */ \
	{OP_LDH,	0,   0, OFF_ETYPE + 4		}, /*              */ \
	{OP_JEQ,	0,   9, ETH_P_1588		}, /* f goto L60   */ \
	{OP_LDH,	0,   0, ETH_HLEN + VLAN_HLEN	}, /*              */ \
	{OP_AND,	0,   0, PTP_CLASS_VMASK		}, /*              */ \
	{OP_OR,		0,   0, PTP_CLASS_VLAN		}, /*              */ \
	{OP_RETA,	0,   0, 0			}, /*              */ \
/*L50*/	{OP_JEQ,	0,   4, ETH_P_1588		}, /* f goto L61   */ \
	{OP_LDH,	0,   0, ETH_HLEN		}, /*              */ \
	{OP_AND,	0,   0, PTP_CLASS_VMASK		}, /*              */ \
	{OP_OR,		0,   0, PTP_CLASS_L2		}, /*              */ \
	{OP_RETA,	0,   0, 0			}, /*              */ \
/*L6x*/	{OP_RETK,	0,   0, PTP_CLASS_NONE		},

#endif
Commit	Line	Data
15f0127d RC	1	/*
	2	* PTP 1588 support
	3	*
	4	* This file implements a BPF that recognizes PTP event messages.
	5	*
	6	* Copyright (C) 2010 OMICRON electronics GmbH
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	21	*/
	22
	23	#ifndef _PTP_CLASSIFY_H_
	24	#define _PTP_CLASSIFY_H_
	25
	26	#include <linux/if_ether.h>
	27	#include <linux/if_vlan.h>
d94ba80e	28	#include <linux/ip.h>
15f0127d RC	29	#include <linux/filter.h>
	30	#ifdef __KERNEL__
	31	#include <linux/in.h>
	32	#else
	33	#include <netinet/in.h>
	34	#endif
	35
	36	#define PTP_CLASS_NONE 0x00 /* not a PTP event message */
	37	#define PTP_CLASS_V1 0x01 /* protocol version 1 */
	38	#define PTP_CLASS_V2 0x02 /* protocol version 2 */
	39	#define PTP_CLASS_VMASK 0x0f /* max protocol version is 15 */
	40	#define PTP_CLASS_IPV4 0x10 /* event in an IPV4 UDP packet */
	41	#define PTP_CLASS_IPV6 0x20 /* event in an IPV6 UDP packet */
	42	#define PTP_CLASS_L2 0x30 /* event in a L2 packet */
	43	#define PTP_CLASS_VLAN 0x40 /* event in a VLAN tagged L2 packet */
	44	#define PTP_CLASS_PMASK 0xf0 /* mask for the packet type field */
	45
	46	#define PTP_CLASS_V1_IPV4 (PTP_CLASS_V1 \| PTP_CLASS_IPV4)
	47	#define PTP_CLASS_V1_IPV6 (PTP_CLASS_V1 \| PTP_CLASS_IPV6) /probably DNE/
	48	#define PTP_CLASS_V2_IPV4 (PTP_CLASS_V2 \| PTP_CLASS_IPV4)
	49	#define PTP_CLASS_V2_IPV6 (PTP_CLASS_V2 \| PTP_CLASS_IPV6)
	50	#define PTP_CLASS_V2_L2 (PTP_CLASS_V2 \| PTP_CLASS_L2)
	51	#define PTP_CLASS_V2_VLAN (PTP_CLASS_V2 \| PTP_CLASS_VLAN)
	52
	53	#define PTP_EV_PORT 319
	54
	55	#define OFF_ETYPE 12
	56	#define OFF_IHL 14
	57	#define OFF_FRAG 20
	58	#define OFF_PROTO4 23
	59	#define OFF_NEXT 6
	60	#define OFF_UDP_DST 2
	61
d94ba80e RC	62	#define OFF_PTP_SOURCE_UUID 22 /* PTPv1 only */
	63	#define OFF_PTP_SEQUENCE_ID 30
	64	#define OFF_PTP_CONTROL 32 /* PTPv1 only */
	65
	66	#define IPV4_HLEN(data) (((struct iphdr *)(data + OFF_IHL))->ihl << 2)
	67
15f0127d RC	68	#define IP6_HLEN 40
	69	#define UDP_HLEN 8
	70
	71	#define RELOFF_DST4 (ETH_HLEN + OFF_UDP_DST)
	72	#define OFF_DST6 (ETH_HLEN + IP6_HLEN + OFF_UDP_DST)
	73	#define OFF_PTP6 (ETH_HLEN + IP6_HLEN + UDP_HLEN)
	74
	75	#define OP_AND (BPF_ALU \| BPF_AND \| BPF_K)
	76	#define OP_JEQ (BPF_JMP \| BPF_JEQ \| BPF_K)
	77	#define OP_JSET (BPF_JMP \| BPF_JSET \| BPF_K)
	78	#define OP_LDB (BPF_LD \| BPF_B \| BPF_ABS)
	79	#define OP_LDH (BPF_LD \| BPF_H \| BPF_ABS)
	80	#define OP_LDHI (BPF_LD \| BPF_H \| BPF_IND)
	81	#define OP_LDX (BPF_LDX \| BPF_B \| BPF_MSH)
	82	#define OP_OR (BPF_ALU \| BPF_OR \| BPF_K)
	83	#define OP_RETA (BPF_RET \| BPF_A)
	84	#define OP_RETK (BPF_RET \| BPF_K)
	85
	86	static inline int ptp_filter_init(struct sock_filter *f, int len)
	87	{
	88	if (OP_LDH == f[0].code)
	89	return sk_chk_filter(f, len);
	90	else
	91	return 0;
	92	}
	93
	94	#define PTP_FILTER \
	95	{OP_LDH, 0, 0, OFF_ETYPE }, /* */ \
	96	{OP_JEQ, 0, 12, ETH_P_IP }, /* f goto L20 */ \
	97	{OP_LDB, 0, 0, OFF_PROTO4 }, /* */ \
	98	{OP_JEQ, 0, 9, IPPROTO_UDP }, /* f goto L10 */ \
	99	{OP_LDH, 0, 0, OFF_FRAG }, /* */ \
	100	{OP_JSET, 7, 0, 0x1fff }, /* t goto L11 */ \
	101	{OP_LDX, 0, 0, OFF_IHL }, /* */ \
	102	{OP_LDHI, 0, 0, RELOFF_DST4 }, /* */ \
	103	{OP_JEQ, 0, 4, PTP_EV_PORT }, /* f goto L12 */ \
	104	{OP_LDHI, 0, 0, ETH_HLEN + UDP_HLEN }, /* */ \
	105	{OP_AND, 0, 0, PTP_CLASS_VMASK }, /* */ \
	106	{OP_OR, 0, 0, PTP_CLASS_IPV4 }, /* */ \
	107	{OP_RETA, 0, 0, 0 }, /* */ \
	108	/L1x/ {OP_RETK, 0, 0, PTP_CLASS_NONE }, /* */ \
	109	/L20/ {OP_JEQ, 0, 9, ETH_P_IPV6 }, /* f goto L40 */ \
	110	{OP_LDB, 0, 0, ETH_HLEN + OFF_NEXT }, /* */ \
	111	{OP_JEQ, 0, 6, IPPROTO_UDP }, /* f goto L30 */ \
	112	{OP_LDH, 0, 0, OFF_DST6 }, /* */ \
	113	{OP_JEQ, 0, 4, PTP_EV_PORT }, /* f goto L31 */ \
	114	{OP_LDH, 0, 0, OFF_PTP6 }, /* */ \
	115	{OP_AND, 0, 0, PTP_CLASS_VMASK }, /* */ \
	116	{OP_OR, 0, 0, PTP_CLASS_IPV6 }, /* */ \
	117	{OP_RETA, 0, 0, 0 }, /* */ \
	118	/L3x/ {OP_RETK, 0, 0, PTP_CLASS_NONE }, /* */ \
	119	/L40/ {OP_JEQ, 0, 6, ETH_P_8021Q }, /* f goto L50 */ \
	120	{OP_LDH, 0, 0, OFF_ETYPE + 4 }, /* */ \
	121	{OP_JEQ, 0, 9, ETH_P_1588 }, /* f goto L60 */ \
	122	{OP_LDH, 0, 0, ETH_HLEN + VLAN_HLEN }, /* */ \
	123	{OP_AND, 0, 0, PTP_CLASS_VMASK }, /* */ \
	124	{OP_OR, 0, 0, PTP_CLASS_VLAN }, /* */ \
	125	{OP_RETA, 0, 0, 0 }, /* */ \
	126	/L50/ {OP_JEQ, 0, 4, ETH_P_1588 }, /* f goto L61 */ \
	127	{OP_LDH, 0, 0, ETH_HLEN }, /* */ \
	128	{OP_AND, 0, 0, PTP_CLASS_VMASK }, /* */ \
	129	{OP_OR, 0, 0, PTP_CLASS_L2 }, /* */ \
	130	{OP_RETA, 0, 0, 0 }, /* */ \
	131	/L6x/ {OP_RETK, 0, 0, PTP_CLASS_NONE },
132
133	#endif