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