[apple/xnu.git] / bsd / net / ethernet.h

/*
 * Copyright (c) 2000,2009 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Fundamental constants relating to ethernet.
 *
 */

#ifndef _NET_ETHERNET_H_
#define _NET_ETHERNET_H_
#include <sys/appleapiopts.h>
#include <sys/types.h>		/* u_ types */

/*
 * The number of bytes in an ethernet (MAC) address.
 */
#define	ETHER_ADDR_LEN		6

/*
 * The number of bytes in the type field.
 */
#define	ETHER_TYPE_LEN		2

/*
 * The number of bytes in the trailing CRC field.
 */
#define	ETHER_CRC_LEN		4

/*
 * The length of the combined header.
 */
#define	ETHER_HDR_LEN		(ETHER_ADDR_LEN*2+ETHER_TYPE_LEN)

/*
 * The minimum packet length.
 */
#define	ETHER_MIN_LEN		64

/*
 * The maximum packet length.
 */
#define	ETHER_MAX_LEN		1518

/*
 * A macro to validate a length with
 */
#define	ETHER_IS_VALID_LEN(foo)	\
	((foo) >= ETHER_MIN_LEN && (foo) <= ETHER_MAX_LEN)

/*
 * Structure of a 10Mb/s Ethernet header.
 */
struct	ether_header {
	u_char	ether_dhost[ETHER_ADDR_LEN];
	u_char	ether_shost[ETHER_ADDR_LEN];
	u_short	ether_type;
};

/*
 * Structure of a 48-bit Ethernet address.
 */
struct	ether_addr {
	u_char octet[ETHER_ADDR_LEN];
};

#define ether_addr_octet octet

#define	ETHERTYPE_PUP		0x0200	/* PUP protocol */
#define	ETHERTYPE_IP		0x0800	/* IP protocol */
#define ETHERTYPE_ARP		0x0806	/* Addr. resolution protocol */
#define ETHERTYPE_REVARP	0x8035	/* reverse Addr. resolution protocol */
#define	ETHERTYPE_VLAN		0x8100	/* IEEE 802.1Q VLAN tagging */
#define ETHERTYPE_IPV6		0x86dd	/* IPv6 */
#define ETHERTYPE_PAE		0x888e  /* EAPOL PAE/802.1x */
#define ETHERTYPE_RSN_PREAUTH	0x88c7  /* 802.11i / RSN Pre-Authentication */
#define	ETHERTYPE_LOOPBACK	0x9000	/* used to test interfaces */
/* XXX - add more useful types here */

/*
 * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
 * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
 * by an ETHER type (as given above) and then the (variable-length) header.
 */
#define	ETHERTYPE_TRAIL		0x1000		/* Trailer packet */
#define	ETHERTYPE_NTRAILER	16

#define	ETHERMTU	(ETHER_MAX_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
#define	ETHERMIN	(ETHER_MIN_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)

#ifdef KERNEL_PRIVATE
/*
 * The following are used by ethernet interfaces.
 */

struct	ether_addr *ether_aton(const char *);

#ifdef BSD_KERNEL_PRIVATE
extern u_char	etherbroadcastaddr[ETHER_ADDR_LEN];
#endif

#define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */

#endif /* KERNEL_PRIVATE */

#ifndef KERNEL
#include <sys/cdefs.h>

/*
 * Ethernet address conversion/parsing routines.
 */
__BEGIN_DECLS

int	ether_hostton(const char *, struct ether_addr *);
int	ether_line(const char *, struct ether_addr *, char *);
char 	*ether_ntoa(const struct ether_addr *);
struct	ether_addr *ether_aton(const char *);
int	ether_ntohost(char *, const struct ether_addr *);
__END_DECLS
#endif /* !KERNEL */

#endif /* !_NET_ETHERNET_H_ */
Commit	Line	Data
1c79356b	1	/*
b7266188	2	* Copyright (c) 2000,2009 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* Fundamental constants relating to ethernet.
	30	*
	31	*/
	32
	33	#ifndef _NET_ETHERNET_H_
	34	#define _NET_ETHERNET_H_
9bccf70c	35	#include <sys/appleapiopts.h>
2d21ac55	36	#include <sys/types.h> /* u_ types */
1c79356b A	37
	38	/*
	39	* The number of bytes in an ethernet (MAC) address.
	40	*/
	41	#define ETHER_ADDR_LEN 6
	42
	43	/*
	44	* The number of bytes in the type field.
	45	*/
	46	#define ETHER_TYPE_LEN 2
	47
	48	/*
	49	* The number of bytes in the trailing CRC field.
	50	*/
	51	#define ETHER_CRC_LEN 4
	52
	53	/*
	54	* The length of the combined header.
	55	*/
	56	#define ETHER_HDR_LEN (ETHER_ADDR_LEN*2+ETHER_TYPE_LEN)
	57
	58	/*
	59	* The minimum packet length.
	60	*/
	61	#define ETHER_MIN_LEN 64
	62
	63	/*
	64	* The maximum packet length.
	65	*/
	66	#define ETHER_MAX_LEN 1518
	67
	68	/*
	69	* A macro to validate a length with
	70	*/
	71	#define ETHER_IS_VALID_LEN(foo) \
	72	((foo) >= ETHER_MIN_LEN && (foo) <= ETHER_MAX_LEN)
	73
	74	/*
	75	* Structure of a 10Mb/s Ethernet header.
	76	*/
	77	struct ether_header {
	78	u_char ether_dhost[ETHER_ADDR_LEN];
	79	u_char ether_shost[ETHER_ADDR_LEN];
	80	u_short ether_type;
	81	};
	82
	83	/*
	84	* Structure of a 48-bit Ethernet address.
	85	*/
	86	struct ether_addr {
	87	u_char octet[ETHER_ADDR_LEN];
	88	};
	89
	90	#define ether_addr_octet octet
	91
	92	#define ETHERTYPE_PUP 0x0200 /* PUP protocol */
	93	#define ETHERTYPE_IP 0x0800 /* IP protocol */
	94	#define ETHERTYPE_ARP 0x0806 /* Addr. resolution protocol */
	95	#define ETHERTYPE_REVARP 0x8035 /* reverse Addr. resolution protocol */
	96	#define ETHERTYPE_VLAN 0x8100 /* IEEE 802.1Q VLAN tagging */
	97	#define ETHERTYPE_IPV6 0x86dd /* IPv6 */
b7266188 A	98	#define ETHERTYPE_PAE 0x888e /* EAPOL PAE/802.1x */
b7266188 A	99	#define ETHERTYPE_RSN_PREAUTH 0x88c7 /* 802.11i / RSN Pre-Authentication */
1c79356b A	100	#define ETHERTYPE_LOOPBACK 0x9000 /* used to test interfaces */
	101	/* XXX - add more useful types here */
	102
	103	/*
	104	* The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
	105	* (type-ETHERTYPE_TRAIL)*512 bytes of data followed
	106	* by an ETHER type (as given above) and then the (variable-length) header.
	107	*/
	108	#define ETHERTYPE_TRAIL 0x1000 /* Trailer packet */
	109	#define ETHERTYPE_NTRAILER 16
	110
	111	#define ETHERMTU (ETHER_MAX_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
	112	#define ETHERMIN (ETHER_MIN_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
	113
91447636 A	114	#ifdef KERNEL_PRIVATE
	115	/*
	116	* The following are used by ethernet interfaces.
	117	*/
	118
	119	struct ether_addr ether_aton(const char );
	120
	121	#ifdef BSD_KERNEL_PRIVATE
	122	extern u_char etherbroadcastaddr[ETHER_ADDR_LEN];
1c79356b	123	#endif
b7266188 A	124
	125	#define ETHER_IS_MULTICAST(addr) ((addr) & 0x01) / is address mcast/bcast? */
	126
91447636	127	#endif /* KERNEL_PRIVATE */
1c79356b	128
9bccf70c	129	#ifndef KERNEL
1c79356b A	130	#include <sys/cdefs.h>
	131
	132	/*
	133	* Ethernet address conversion/parsing routines.
	134	*/
	135	__BEGIN_DECLS
	136
91447636 A	137	int ether_hostton(const char , struct ether_addr );
	138	int ether_line(const char , struct ether_addr , char *);
	139	char ether_ntoa(const struct ether_addr );
	140	struct ether_addr ether_aton(const char );
	141	int ether_ntohost(char , const struct ether_addr );
1c79356b A	142	__END_DECLS
	143	#endif /* !KERNEL */
	144
	145	#endif /* !_NET_ETHERNET_H_ */