xref: /xnu-8792.81.2/bsd/netinet/if_ether.h (revision 19c3b8c28c31cb8130e034cfb5df6bf9ba342d90)
1*19c3b8c2SApple OSS Distributions /*
2*19c3b8c2SApple OSS Distributions  * Copyright (c) 2000-2011 Apple Inc. All rights reserved.
3*19c3b8c2SApple OSS Distributions  *
4*19c3b8c2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*19c3b8c2SApple OSS Distributions  *
6*19c3b8c2SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*19c3b8c2SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*19c3b8c2SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*19c3b8c2SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*19c3b8c2SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*19c3b8c2SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*19c3b8c2SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*19c3b8c2SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*19c3b8c2SApple OSS Distributions  *
15*19c3b8c2SApple OSS Distributions  * Please obtain a copy of the License at
16*19c3b8c2SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*19c3b8c2SApple OSS Distributions  *
18*19c3b8c2SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*19c3b8c2SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*19c3b8c2SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*19c3b8c2SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*19c3b8c2SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*19c3b8c2SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*19c3b8c2SApple OSS Distributions  * limitations under the License.
25*19c3b8c2SApple OSS Distributions  *
26*19c3b8c2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*19c3b8c2SApple OSS Distributions  */
28*19c3b8c2SApple OSS Distributions /*
29*19c3b8c2SApple OSS Distributions  * Copyright (c) 1982, 1986, 1993
30*19c3b8c2SApple OSS Distributions  *	The Regents of the University of California.  All rights reserved.
31*19c3b8c2SApple OSS Distributions  *
32*19c3b8c2SApple OSS Distributions  * Redistribution and use in source and binary forms, with or without
33*19c3b8c2SApple OSS Distributions  * modification, are permitted provided that the following conditions
34*19c3b8c2SApple OSS Distributions  * are met:
35*19c3b8c2SApple OSS Distributions  * 1. Redistributions of source code must retain the above copyright
36*19c3b8c2SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer.
37*19c3b8c2SApple OSS Distributions  * 2. Redistributions in binary form must reproduce the above copyright
38*19c3b8c2SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer in the
39*19c3b8c2SApple OSS Distributions  *    documentation and/or other materials provided with the distribution.
40*19c3b8c2SApple OSS Distributions  * 3. All advertising materials mentioning features or use of this software
41*19c3b8c2SApple OSS Distributions  *    must display the following acknowledgement:
42*19c3b8c2SApple OSS Distributions  *	This product includes software developed by the University of
43*19c3b8c2SApple OSS Distributions  *	California, Berkeley and its contributors.
44*19c3b8c2SApple OSS Distributions  * 4. Neither the name of the University nor the names of its contributors
45*19c3b8c2SApple OSS Distributions  *    may be used to endorse or promote products derived from this software
46*19c3b8c2SApple OSS Distributions  *    without specific prior written permission.
47*19c3b8c2SApple OSS Distributions  *
48*19c3b8c2SApple OSS Distributions  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49*19c3b8c2SApple OSS Distributions  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50*19c3b8c2SApple OSS Distributions  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51*19c3b8c2SApple OSS Distributions  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52*19c3b8c2SApple OSS Distributions  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53*19c3b8c2SApple OSS Distributions  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54*19c3b8c2SApple OSS Distributions  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55*19c3b8c2SApple OSS Distributions  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56*19c3b8c2SApple OSS Distributions  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57*19c3b8c2SApple OSS Distributions  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58*19c3b8c2SApple OSS Distributions  * SUCH DAMAGE.
59*19c3b8c2SApple OSS Distributions  *
60*19c3b8c2SApple OSS Distributions  *	@(#)if_ether.h	8.3 (Berkeley) 5/2/95
61*19c3b8c2SApple OSS Distributions  * $FreeBSD: src/sys/netinet/if_ether.h,v 1.24 1999/12/29 04:40:58 peter Exp $
62*19c3b8c2SApple OSS Distributions  */
63*19c3b8c2SApple OSS Distributions 
64*19c3b8c2SApple OSS Distributions #ifndef _NETINET_IF_ETHER_H_
65*19c3b8c2SApple OSS Distributions #define _NETINET_IF_ETHER_H_
66*19c3b8c2SApple OSS Distributions #include <sys/appleapiopts.h>
67*19c3b8c2SApple OSS Distributions 
68*19c3b8c2SApple OSS Distributions #include <net/ethernet.h>
69*19c3b8c2SApple OSS Distributions 
70*19c3b8c2SApple OSS Distributions #include <netinet/in.h>
71*19c3b8c2SApple OSS Distributions #include <net/if_arp.h>
72*19c3b8c2SApple OSS Distributions #define ea_byte ether_addr_octet
73*19c3b8c2SApple OSS Distributions 
74*19c3b8c2SApple OSS Distributions /*
75*19c3b8c2SApple OSS Distributions  * Macro to map an IP multicast address to an Ethernet multicast address.
76*19c3b8c2SApple OSS Distributions  * The high-order 25 bits of the Ethernet address are statically assigned,
77*19c3b8c2SApple OSS Distributions  * and the low-order 23 bits are taken from the low end of the IP address.
78*19c3b8c2SApple OSS Distributions  */
79*19c3b8c2SApple OSS Distributions #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \
80*19c3b8c2SApple OSS Distributions 	/* struct in_addr *ipaddr; */ \
81*19c3b8c2SApple OSS Distributions 	/* u_char enaddr[ETHER_ADDR_LEN];	   */ \
82*19c3b8c2SApple OSS Distributions { \
83*19c3b8c2SApple OSS Distributions 	(enaddr)[0] = 0x01; \
84*19c3b8c2SApple OSS Distributions 	(enaddr)[1] = 0x00; \
85*19c3b8c2SApple OSS Distributions 	(enaddr)[2] = 0x5e; \
86*19c3b8c2SApple OSS Distributions 	(enaddr)[3] = ((const u_char *)ipaddr)[1] & 0x7f; \
87*19c3b8c2SApple OSS Distributions 	(enaddr)[4] = ((const u_char *)ipaddr)[2]; \
88*19c3b8c2SApple OSS Distributions 	(enaddr)[5] = ((const u_char *)ipaddr)[3]; \
89*19c3b8c2SApple OSS Distributions }
90*19c3b8c2SApple OSS Distributions /*
91*19c3b8c2SApple OSS Distributions  * Macro to map an IP6 multicast address to an Ethernet multicast address.
92*19c3b8c2SApple OSS Distributions  * The high-order 16 bits of the Ethernet address are statically assigned,
93*19c3b8c2SApple OSS Distributions  * and the low-order 32 bits are taken from the low end of the IP6 address.
94*19c3b8c2SApple OSS Distributions  */
95*19c3b8c2SApple OSS Distributions #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr)                       \
96*19c3b8c2SApple OSS Distributions /* struct	in6_addr *ip6addr; */                                   \
97*19c3b8c2SApple OSS Distributions /* u_char	enaddr[ETHER_ADDR_LEN]; */                              \
98*19c3b8c2SApple OSS Distributions {                                                                       \
99*19c3b8c2SApple OSS Distributions 	(enaddr)[0] = 0x33;                                             \
100*19c3b8c2SApple OSS Distributions 	(enaddr)[1] = 0x33;                                             \
101*19c3b8c2SApple OSS Distributions 	(enaddr)[2] = ((const u_char *)ip6addr)[12];                            \
102*19c3b8c2SApple OSS Distributions 	(enaddr)[3] = ((const u_char *)ip6addr)[13];                            \
103*19c3b8c2SApple OSS Distributions 	(enaddr)[4] = ((const u_char *)ip6addr)[14];                            \
104*19c3b8c2SApple OSS Distributions 	(enaddr)[5] = ((const u_char *)ip6addr)[15];                            \
105*19c3b8c2SApple OSS Distributions }
106*19c3b8c2SApple OSS Distributions 
107*19c3b8c2SApple OSS Distributions /*
108*19c3b8c2SApple OSS Distributions  * Ethernet Address Resolution Protocol.
109*19c3b8c2SApple OSS Distributions  *
110*19c3b8c2SApple OSS Distributions  * See RFC 826 for protocol description.  Structure below is adapted
111*19c3b8c2SApple OSS Distributions  * to resolving internet addresses.  Field names used correspond to
112*19c3b8c2SApple OSS Distributions  * RFC 826.
113*19c3b8c2SApple OSS Distributions  */
114*19c3b8c2SApple OSS Distributions struct  ether_arp {
115*19c3b8c2SApple OSS Distributions 	struct  arphdr ea_hdr;  /* fixed-size header */
116*19c3b8c2SApple OSS Distributions 	u_char  arp_sha[ETHER_ADDR_LEN];        /* sender hardware address */
117*19c3b8c2SApple OSS Distributions 	u_char  arp_spa[4];     /* sender protocol address */
118*19c3b8c2SApple OSS Distributions 	u_char  arp_tha[ETHER_ADDR_LEN];        /* target hardware address */
119*19c3b8c2SApple OSS Distributions 	u_char  arp_tpa[4];     /* target protocol address */
120*19c3b8c2SApple OSS Distributions };
121*19c3b8c2SApple OSS Distributions #define arp_hrd ea_hdr.ar_hrd
122*19c3b8c2SApple OSS Distributions #define arp_pro ea_hdr.ar_pro
123*19c3b8c2SApple OSS Distributions #define arp_hln ea_hdr.ar_hln
124*19c3b8c2SApple OSS Distributions #define arp_pln ea_hdr.ar_pln
125*19c3b8c2SApple OSS Distributions #define arp_op  ea_hdr.ar_op
126*19c3b8c2SApple OSS Distributions 
127*19c3b8c2SApple OSS Distributions struct sockaddr_inarp {
128*19c3b8c2SApple OSS Distributions 	u_char  sin_len;
129*19c3b8c2SApple OSS Distributions 	u_char  sin_family;
130*19c3b8c2SApple OSS Distributions 	u_short sin_port;
131*19c3b8c2SApple OSS Distributions 	struct  in_addr sin_addr;
132*19c3b8c2SApple OSS Distributions 	struct  in_addr sin_srcaddr;
133*19c3b8c2SApple OSS Distributions 	u_short sin_tos;
134*19c3b8c2SApple OSS Distributions 	u_short sin_other;
135*19c3b8c2SApple OSS Distributions #define SIN_PROXY       0x1
136*19c3b8c2SApple OSS Distributions #define SIN_ROUTER      0x2
137*19c3b8c2SApple OSS Distributions };
138*19c3b8c2SApple OSS Distributions /*
139*19c3b8c2SApple OSS Distributions  * IP and ethernet specific routing flags
140*19c3b8c2SApple OSS Distributions  */
141*19c3b8c2SApple OSS Distributions #define RTF_USETRAILERS RTF_PROTO1      /* use trailers */
142*19c3b8c2SApple OSS Distributions #define RTF_ANNOUNCE    RTF_PROTO2      /* announce new arp entry */
143*19c3b8c2SApple OSS Distributions 
144*19c3b8c2SApple OSS Distributions #ifdef BSD_KERNEL_PRIVATE
145*19c3b8c2SApple OSS Distributions extern u_char   ether_ipmulticast_min[ETHER_ADDR_LEN];
146*19c3b8c2SApple OSS Distributions extern u_char   ether_ipmulticast_max[ETHER_ADDR_LEN];
147*19c3b8c2SApple OSS Distributions extern struct   ifqueue arpintrq;
148*19c3b8c2SApple OSS Distributions 
149*19c3b8c2SApple OSS Distributions int     arpresolve(struct ifnet *, struct rtentry *, struct mbuf *,
150*19c3b8c2SApple OSS Distributions     struct sockaddr *, u_char *, struct rtentry *);
151*19c3b8c2SApple OSS Distributions void    arp_ifinit(struct ifnet *, struct ifaddr *);
152*19c3b8c2SApple OSS Distributions #endif /* BSD_KERNEL_PRIVATE */
153*19c3b8c2SApple OSS Distributions 
154*19c3b8c2SApple OSS Distributions #endif /* _NETINET_IF_ETHER_H_ */
155