[linux.git] / include / linux / if_ether.h

/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Global definitions for the Ethernet IEEE 802.3 interface.
 *
 * Version:	@(#)if_ether.h	1.0.1a	02/08/94
 *
 * Author:	Fred N. van Kempen, <[email protected]>
 *		Donald Becker, <[email protected]>
 *		Alan Cox, <[email protected]>
 *		Steve Whitehouse, <[email protected]>
 *
 *		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.
 */

#ifndef _LINUX_IF_ETHER_H
#define _LINUX_IF_ETHER_H

#include <linux/types.h>

/*
 *	IEEE 802.3 Ethernet magic constants.  The frame sizes omit the preamble
 *	and FCS/CRC (frame check sequence).
 */

#define ETH_ALEN	6		/* Octets in one ethernet addr	 */
#define ETH_HLEN	14		/* Total octets in header.	 */
#define ETH_ZLEN	60		/* Min. octets in frame sans FCS */
#define ETH_DATA_LEN	1500		/* Max. octets in payload	 */
#define ETH_FRAME_LEN	1514		/* Max. octets in frame sans FCS */
#define ETH_FCS_LEN	4		/* Octets in the FCS		 */

/*
 *	These are the defined Ethernet Protocol ID's.
 */

#define ETH_P_LOOP	0x0060		/* Ethernet Loopback packet	*/
#define ETH_P_PUP	0x0200		/* Xerox PUP packet		*/
#define ETH_P_PUPAT	0x0201		/* Xerox PUP Addr Trans packet	*/
#define ETH_P_IP	0x0800		/* Internet Protocol packet	*/
#define ETH_P_X25	0x0805		/* CCITT X.25			*/
#define ETH_P_ARP	0x0806		/* Address Resolution packet	*/
#define	ETH_P_BPQ	0x08FF		/* G8BPQ AX.25 Ethernet Packet	[ NOT AN OFFICIALLY REGISTERED ID ] */
#define ETH_P_IEEEPUP	0x0a00		/* Xerox IEEE802.3 PUP packet */
#define ETH_P_IEEEPUPAT	0x0a01		/* Xerox IEEE802.3 PUP Addr Trans packet */
#define ETH_P_DEC       0x6000          /* DEC Assigned proto           */
#define ETH_P_DNA_DL    0x6001          /* DEC DNA Dump/Load            */
#define ETH_P_DNA_RC    0x6002          /* DEC DNA Remote Console       */
#define ETH_P_DNA_RT    0x6003          /* DEC DNA Routing              */
#define ETH_P_LAT       0x6004          /* DEC LAT                      */
#define ETH_P_DIAG      0x6005          /* DEC Diagnostics              */
#define ETH_P_CUST      0x6006          /* DEC Customer use             */
#define ETH_P_SCA       0x6007          /* DEC Systems Comms Arch       */
#define ETH_P_TEB	0x6558		/* Trans Ether Bridging		*/
#define ETH_P_RARP      0x8035		/* Reverse Addr Res packet	*/
#define ETH_P_ATALK	0x809B		/* Appletalk DDP		*/
#define ETH_P_AARP	0x80F3		/* Appletalk AARP		*/
#define ETH_P_8021Q	0x8100          /* 802.1Q VLAN Extended Header  */
#define ETH_P_IPX	0x8137		/* IPX over DIX			*/
#define ETH_P_IPV6	0x86DD		/* IPv6 over bluebook		*/
#define ETH_P_PAUSE	0x8808		/* IEEE Pause frames. See 802.3 31B */
#define ETH_P_SLOW	0x8809		/* Slow Protocol. See 802.3ad 43B */
#define ETH_P_WCCP	0x883E		/* Web-cache coordination protocol
					 * defined in draft-wilson-wrec-wccp-v2-00.txt */
#define ETH_P_PPP_DISC	0x8863		/* PPPoE discovery messages     */
#define ETH_P_PPP_SES	0x8864		/* PPPoE session messages	*/
#define ETH_P_MPLS_UC	0x8847		/* MPLS Unicast traffic		*/
#define ETH_P_MPLS_MC	0x8848		/* MPLS Multicast traffic	*/
#define ETH_P_ATMMPOA	0x884c		/* MultiProtocol Over ATM	*/
#define ETH_P_LINK_CTL	0x886c		/* HPNA, wlan link local tunnel */
#define ETH_P_ATMFATE	0x8884		/* Frame-based ATM Transport
					 * over Ethernet
					 */
#define ETH_P_PAE	0x888E		/* Port Access Entity (IEEE 802.1X) */
#define ETH_P_AOE	0x88A2		/* ATA over Ethernet		*/
#define ETH_P_8021AD	0x88A8          /* 802.1ad Service VLAN		*/
#define ETH_P_802_EX1	0x88B5		/* 802.1 Local Experimental 1.  */
#define ETH_P_TIPC	0x88CA		/* TIPC 			*/
#define ETH_P_8021AH	0x88E7          /* 802.1ah Backbone Service Tag */
#define ETH_P_1588	0x88F7		/* IEEE 1588 Timesync */
#define ETH_P_FCOE	0x8906		/* Fibre Channel over Ethernet  */
#define ETH_P_TDLS	0x890D          /* TDLS */
#define ETH_P_FIP	0x8914		/* FCoE Initialization Protocol */
#define ETH_P_QINQ1	0x9100		/* deprecated QinQ VLAN [ NOT AN OFFICIALLY REGISTERED ID ] */
#define ETH_P_QINQ2	0x9200		/* deprecated QinQ VLAN [ NOT AN OFFICIALLY REGISTERED ID ] */
#define ETH_P_QINQ3	0x9300		/* deprecated QinQ VLAN [ NOT AN OFFICIALLY REGISTERED ID ] */
#define ETH_P_EDSA	0xDADA		/* Ethertype DSA [ NOT AN OFFICIALLY REGISTERED ID ] */
#define ETH_P_AF_IUCV   0xFBFB		/* IBM af_iucv [ NOT AN OFFICIALLY REGISTERED ID ] */

/*
 *	Non DIX types. Won't clash for 1500 types.
 */

#define ETH_P_802_3	0x0001		/* Dummy type for 802.3 frames  */
#define ETH_P_AX25	0x0002		/* Dummy protocol id for AX.25  */
#define ETH_P_ALL	0x0003		/* Every packet (be careful!!!) */
#define ETH_P_802_2	0x0004		/* 802.2 frames 		*/
#define ETH_P_SNAP	0x0005		/* Internal only		*/
#define ETH_P_DDCMP     0x0006          /* DEC DDCMP: Internal only     */
#define ETH_P_WAN_PPP   0x0007          /* Dummy type for WAN PPP frames*/
#define ETH_P_PPP_MP    0x0008          /* Dummy type for PPP MP frames */
#define ETH_P_LOCALTALK 0x0009		/* Localtalk pseudo type 	*/
#define ETH_P_CAN	0x000C		/* CAN: Controller Area Network */
#define ETH_P_CANFD	0x000D		/* CANFD: CAN flexible data rate*/
#define ETH_P_PPPTALK	0x0010		/* Dummy type for Atalk over PPP*/
#define ETH_P_TR_802_2	0x0011		/* 802.2 frames 		*/
#define ETH_P_MOBITEX	0x0015		/* Mobitex ([email protected])	*/
#define ETH_P_CONTROL	0x0016		/* Card specific control frames */
#define ETH_P_IRDA	0x0017		/* Linux-IrDA			*/
#define ETH_P_ECONET	0x0018		/* Acorn Econet			*/
#define ETH_P_HDLC	0x0019		/* HDLC frames			*/
#define ETH_P_ARCNET	0x001A		/* 1A for ArcNet :-)            */
#define ETH_P_DSA	0x001B		/* Distributed Switch Arch.	*/
#define ETH_P_TRAILER	0x001C		/* Trailer switch tagging	*/
#define ETH_P_PHONET	0x00F5		/* Nokia Phonet frames          */
#define ETH_P_IEEE802154 0x00F6		/* IEEE802.15.4 frame		*/
#define ETH_P_CAIF	0x00F7		/* ST-Ericsson CAIF protocol	*/

/*
 *	This is an Ethernet frame header.
 */

struct ethhdr {
	unsigned char	h_dest[ETH_ALEN];	/* destination eth addr	*/
	unsigned char	h_source[ETH_ALEN];	/* source ether addr	*/
	__be16		h_proto;		/* packet type ID field	*/
} __attribute__((packed));

#ifdef __KERNEL__
#include <linux/skbuff.h>

static inline struct ethhdr *eth_hdr(const struct sk_buff *skb)
{
	return (struct ethhdr *)skb_mac_header(skb);
}

int eth_header_parse(const struct sk_buff *skb, unsigned char *haddr);

int mac_pton(const char *s, u8 *mac);
extern ssize_t sysfs_format_mac(char *buf, const unsigned char *addr, int len);

#endif

#endif	/* _LINUX_IF_ETHER_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* INET An implementation of the TCP/IP protocol suite for the LINUX
	3	* operating system. INET is implemented using the BSD Socket
	4	* interface as the means of communication with the user level.
	5	*
	6	* Global definitions for the Ethernet IEEE 802.3 interface.
	7	*
	8	* Version: @(#)if_ether.h 1.0.1a 02/08/94
	9	*
	10	* Author: Fred N. van Kempen, <[email protected]>
	11	* Donald Becker, <[email protected]>
113aa838	12	* Alan Cox, <[email protected]>
1da177e4 LT	13	* Steve Whitehouse, <[email protected]>
	14	*
	15	* This program is free software; you can redistribute it and/or
	16	* modify it under the terms of the GNU General Public License
	17	* as published by the Free Software Foundation; either version
	18	* 2 of the License, or (at your option) any later version.
	19	*/
fe2918b0	20
1da177e4 LT	21	#ifndef _LINUX_IF_ETHER_H
	22	#define _LINUX_IF_ETHER_H
	23
ac57d042 PR	24	#include <linux/types.h>
ac57d042 PR	25
1da177e4 LT	26	/*
1da177e4 LT	27	* IEEE 802.3 Ethernet magic constants. The frame sizes omit the preamble
fe2918b0	28	* and FCS/CRC (frame check sequence).
1da177e4 LT	29	*/
	30
	31	#define ETH_ALEN 6 /* Octets in one ethernet addr */
	32	#define ETH_HLEN 14 /* Total octets in header. */
	33	#define ETH_ZLEN 60 /* Min. octets in frame sans FCS */
	34	#define ETH_DATA_LEN 1500 /* Max. octets in payload */
	35	#define ETH_FRAME_LEN 1514 /* Max. octets in frame sans FCS */
2053ed02	36	#define ETH_FCS_LEN 4 /* Octets in the FCS */
1da177e4 LT	37
	38	/*
	39	* These are the defined Ethernet Protocol ID's.
	40	*/
	41
	42	#define ETH_P_LOOP 0x0060 /* Ethernet Loopback packet */
	43	#define ETH_P_PUP 0x0200 /* Xerox PUP packet */
	44	#define ETH_P_PUPAT 0x0201 /* Xerox PUP Addr Trans packet */
	45	#define ETH_P_IP 0x0800 /* Internet Protocol packet */
	46	#define ETH_P_X25 0x0805 /* CCITT X.25 */
	47	#define ETH_P_ARP 0x0806 /* Address Resolution packet */
	48	#define ETH_P_BPQ 0x08FF /* G8BPQ AX.25 Ethernet Packet [ NOT AN OFFICIALLY REGISTERED ID ] */
	49	#define ETH_P_IEEEPUP 0x0a00 /* Xerox IEEE802.3 PUP packet */
	50	#define ETH_P_IEEEPUPAT 0x0a01 /* Xerox IEEE802.3 PUP Addr Trans packet */
	51	#define ETH_P_DEC 0x6000 /* DEC Assigned proto */
	52	#define ETH_P_DNA_DL 0x6001 /* DEC DNA Dump/Load */
	53	#define ETH_P_DNA_RC 0x6002 /* DEC DNA Remote Console */
	54	#define ETH_P_DNA_RT 0x6003 /* DEC DNA Routing */
	55	#define ETH_P_LAT 0x6004 /* DEC LAT */
	56	#define ETH_P_DIAG 0x6005 /* DEC Diagnostics */
	57	#define ETH_P_CUST 0x6006 /* DEC Customer use */
	58	#define ETH_P_SCA 0x6007 /* DEC Systems Comms Arch */
e1a80002	59	#define ETH_P_TEB 0x6558 /* Trans Ether Bridging */
1da177e4 LT	60	#define ETH_P_RARP 0x8035 /* Reverse Addr Res packet */
	61	#define ETH_P_ATALK 0x809B /* Appletalk DDP */
	62	#define ETH_P_AARP 0x80F3 /* Appletalk AARP */
	63	#define ETH_P_8021Q 0x8100 /* 802.1Q VLAN Extended Header */
	64	#define ETH_P_IPX 0x8137 /* IPX over DIX */
	65	#define ETH_P_IPV6 0x86DD /* IPv6 over bluebook */
2111f8b9	66	#define ETH_P_PAUSE 0x8808 /* IEEE Pause frames. See 802.3 31B */
8f903c70	67	#define ETH_P_SLOW 0x8809 /* Slow Protocol. See 802.3ad 43B */
1da177e4 LT	68	#define ETH_P_WCCP 0x883E /* Web-cache coordination protocol
	69	* defined in draft-wilson-wrec-wccp-v2-00.txt */
	70	#define ETH_P_PPP_DISC 0x8863 /* PPPoE discovery messages */
	71	#define ETH_P_PPP_SES 0x8864 /* PPPoE session messages */
	72	#define ETH_P_MPLS_UC 0x8847 /* MPLS Unicast traffic */
	73	#define ETH_P_MPLS_MC 0x8848 /* MPLS Multicast traffic */
	74	#define ETH_P_ATMMPOA 0x884c /* MultiProtocol Over ATM */
238c8558	75	#define ETH_P_LINK_CTL 0x886c /* HPNA, wlan link local tunnel */
1da177e4 LT	76	#define ETH_P_ATMFATE 0x8884 /* Frame-based ATM Transport
	77	* over Ethernet
	78	*/
fef1643b	79	#define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
1da177e4	80	#define ETH_P_AOE 0x88A2 /* ATA over Ethernet */
178edcbc	81	#define ETH_P_8021AD 0x88A8 /* 802.1ad Service VLAN */
63afe12f	82	#define ETH_P_802_EX1 0x88B5 /* 802.1 Local Experimental 1. */
33a9c4da	83	#define ETH_P_TIPC 0x88CA /* TIPC */
178edcbc	84	#define ETH_P_8021AH 0x88E7 /* 802.1ah Backbone Service Tag */
887b5ea3	85	#define ETH_P_1588 0x88F7 /* IEEE 1588 Timesync */
211c738d	86	#define ETH_P_FCOE 0x8906 /* Fibre Channel over Ethernet */
dfe018bf	87	#define ETH_P_TDLS 0x890D /* TDLS */
226c7ffe	88	#define ETH_P_FIP 0x8914 /* FCoE Initialization Protocol */
178edcbc DL	89	#define ETH_P_QINQ1 0x9100 /* deprecated QinQ VLAN [ NOT AN OFFICIALLY REGISTERED ID ] */
	90	#define ETH_P_QINQ2 0x9200 /* deprecated QinQ VLAN [ NOT AN OFFICIALLY REGISTERED ID ] */
	91	#define ETH_P_QINQ3 0x9300 /* deprecated QinQ VLAN [ NOT AN OFFICIALLY REGISTERED ID ] */
91da11f8	92	#define ETH_P_EDSA 0xDADA /* Ethertype DSA [ NOT AN OFFICIALLY REGISTERED ID ] */
4dc83dfd	93	#define ETH_P_AF_IUCV 0xFBFB /* IBM af_iucv [ NOT AN OFFICIALLY REGISTERED ID ] */
1da177e4 LT	94
	95	/*
	96	* Non DIX types. Won't clash for 1500 types.
	97	*/
fe2918b0	98
1da177e4 LT	99	#define ETH_P_802_3 0x0001 /* Dummy type for 802.3 frames */
	100	#define ETH_P_AX25 0x0002 /* Dummy protocol id for AX.25 */
	101	#define ETH_P_ALL 0x0003 /* Every packet (be careful!!!) */
	102	#define ETH_P_802_2 0x0004 /* 802.2 frames */
	103	#define ETH_P_SNAP 0x0005 /* Internal only */
	104	#define ETH_P_DDCMP 0x0006 /* DEC DDCMP: Internal only */
	105	#define ETH_P_WAN_PPP 0x0007 /* Dummy type for WAN PPP frames*/
	106	#define ETH_P_PPP_MP 0x0008 /* Dummy type for PPP MP frames */
	107	#define ETH_P_LOCALTALK 0x0009 /* Localtalk pseudo type */
7c941636 OH	108	#define ETH_P_CAN 0x000C /* CAN: Controller Area Network */
7c941636 OH	109	#define ETH_P_CANFD 0x000D /* CANFD: CAN flexible data rate*/
1da177e4 LT	110	#define ETH_P_PPPTALK 0x0010 /* Dummy type for Atalk over PPP*/
	111	#define ETH_P_TR_802_2 0x0011 /* 802.2 frames */
	112	#define ETH_P_MOBITEX 0x0015 /* Mobitex ([email protected]) */
	113	#define ETH_P_CONTROL 0x0016 /* Card specific control frames */
	114	#define ETH_P_IRDA 0x0017 /* Linux-IrDA */
	115	#define ETH_P_ECONET 0x0018 /* Acorn Econet */
	116	#define ETH_P_HDLC 0x0019 /* HDLC frames */
	117	#define ETH_P_ARCNET 0x001A /* 1A for ArcNet :-) */
cf85d08f	118	#define ETH_P_DSA 0x001B /* Distributed Switch Arch. */
396138f0	119	#define ETH_P_TRAILER 0x001C /* Trailer switch tagging */
bce7b154	120	#define ETH_P_PHONET 0x00F5 /* Nokia Phonet frames */
fcb94e42	121	#define ETH_P_IEEE802154 0x00F6 /* IEEE802.15.4 frame */
70596b61	122	#define ETH_P_CAIF 0x00F7 /* ST-Ericsson CAIF protocol */
1da177e4 LT	123
	124	/*
	125	* This is an Ethernet frame header.
	126	*/
fe2918b0	127
1da177e4 LT	128	struct ethhdr {
	129	unsigned char h_dest[ETH_ALEN]; /* destination eth addr */
	130	unsigned char h_source[ETH_ALEN]; /* source ether addr */
ac57d042	131	__be16 h_proto; /* packet type ID field */
09cd2b99	132	} __attribute__((packed));
1da177e4 LT	133
	134	#ifdef __KERNEL__
	135	#include <linux/skbuff.h>
	136
	137	static inline struct ethhdr eth_hdr(const struct sk_buff skb)
	138	{
98e399f8	139	return (struct ethhdr *)skb_mac_header(skb);
1da177e4	140	}
20380731	141
3b04ddde SH	142	int eth_header_parse(const struct sk_buff skb, unsigned char haddr);
3b04ddde SH	143
4940fc88	144	int mac_pton(const char s, u8 mac);
7ffc49a6 MC	145	extern ssize_t sysfs_format_mac(char buf, const unsigned char addr, int len);
7ffc49a6 MC	146
2fab35d7	147	#endif
1da177e4 LT	148
1da177e4 LT	149	#endif /* _LINUX_IF_ETHER_H */