xref: /freebsd/sys/netinet/if_ether.h (revision 8e6b01171e30297084bb0b4457c4183c2746aacc)
1 /*
2  * Copyright (c) 1982, 1986, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)if_ether.h	8.3 (Berkeley) 5/2/95
34  *	$Id: if_ether.h,v 1.10 1995/09/21 17:39:51 wollman Exp $
35  */
36 
37 #ifndef _NETINET_IF_ETHER_H_
38 #define _NETINET_IF_ETHER_H_
39 
40 /*
41  * Structure of a 10Mb/s Ethernet header.
42  */
43 struct	ether_header {
44 	u_char	ether_dhost[6];
45 	u_char	ether_shost[6];
46 	u_short	ether_type;
47 };
48 
49 /*
50  * Structure of a 48-bit Ethernet address.
51  */
52 struct	ether_addr {
53 	u_char octet[6];
54 };
55 
56 #define	ETHERTYPE_PUP		0x0200	/* PUP protocol */
57 #define	ETHERTYPE_IP		0x0800	/* IP protocol */
58 #define ETHERTYPE_ARP		0x0806	/* Addr. resolution protocol */
59 #define ETHERTYPE_REVARP	0x8035	/* reverse Addr. resolution protocol */
60 
61 /*
62  * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
63  * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
64  * by an ETHER type (as given above) and then the (variable-length) header.
65  */
66 #define	ETHERTYPE_TRAIL		0x1000		/* Trailer packet */
67 #define	ETHERTYPE_NTRAILER	16
68 
69 #define	ETHERMTU	1500
70 #define	ETHERMIN	(60-14)
71 
72 #ifdef KERNEL
73 /*
74  * Macro to map an IP multicast address to an Ethernet multicast address.
75  * The high-order 25 bits of the Ethernet address are statically assigned,
76  * and the low-order 23 bits are taken from the low end of the IP address.
77  */
78 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \
79 	/* struct in_addr *ipaddr; */ \
80 	/* u_char enaddr[6];	   */ \
81 { \
82 	(enaddr)[0] = 0x01; \
83 	(enaddr)[1] = 0x00; \
84 	(enaddr)[2] = 0x5e; \
85 	(enaddr)[3] = ((u_char *)ipaddr)[1] & 0x7f; \
86 	(enaddr)[4] = ((u_char *)ipaddr)[2]; \
87 	(enaddr)[5] = ((u_char *)ipaddr)[3]; \
88 }
89 #endif
90 
91 /*
92  * Ethernet Address Resolution Protocol.
93  *
94  * See RFC 826 for protocol description.  Structure below is adapted
95  * to resolving internet addresses.  Field names used correspond to
96  * RFC 826.
97  */
98 struct	ether_arp {
99 	struct	arphdr ea_hdr;	/* fixed-size header */
100 	u_char	arp_sha[6];	/* sender hardware address */
101 	u_char	arp_spa[4];	/* sender protocol address */
102 	u_char	arp_tha[6];	/* target hardware address */
103 	u_char	arp_tpa[4];	/* target protocol address */
104 };
105 #define	arp_hrd	ea_hdr.ar_hrd
106 #define	arp_pro	ea_hdr.ar_pro
107 #define	arp_hln	ea_hdr.ar_hln
108 #define	arp_pln	ea_hdr.ar_pln
109 #define	arp_op	ea_hdr.ar_op
110 
111 
112 /*
113  * Structure shared between the ethernet driver modules and
114  * the address resolution code.  For example, each ec_softc or il_softc
115  * begins with this structure.
116  */
117 struct	arpcom {
118 	struct 	ifnet ac_if;		/* network-visible interface */
119 	u_char	ac_enaddr[6];		/* ethernet hardware address */
120 	struct	in_addr ac_ipaddr;	/* copy of ip address- XXX */
121 	struct	ether_multi *ac_multiaddrs; /* list of ether multicast addrs */
122 	int	ac_multicnt;		/* length of ac_multiaddrs list */
123 };
124 
125 struct sockaddr_inarp {
126 	u_char	sin_len;
127 	u_char	sin_family;
128 	u_short sin_port;
129 	struct	in_addr sin_addr;
130 	struct	in_addr sin_srcaddr;
131 	u_short	sin_tos;
132 	u_short	sin_other;
133 #define SIN_PROXY 1
134 };
135 /*
136  * IP and ethernet specific routing flags
137  */
138 #define	RTF_USETRAILERS	RTF_PROTO1	/* use trailers */
139 #define RTF_ANNOUNCE	RTF_PROTO2	/* announce new arp entry */
140 
141 #ifdef	KERNEL
142 extern u_char	etherbroadcastaddr[6];
143 extern u_char	ether_ipmulticast_min[6];
144 extern u_char	ether_ipmulticast_max[6];
145 extern struct	ifqueue arpintrq;
146 
147 void	arpintr __P((void));
148 int	arpresolve __P((struct arpcom *, struct rtentry *, struct mbuf *,
149 			struct sockaddr *, u_char *, struct rtentry *));
150 void	arpwhohas __P((struct arpcom *, struct in_addr *));
151 void	arp_ifinit __P((struct arpcom *, struct ifaddr *));
152 
153 int	ether_addmulti __P((struct ifreq *, struct arpcom *));
154 int	ether_delmulti __P((struct ifreq *, struct arpcom *));
155 
156 /*
157  * Ethernet multicast address structure.  There is one of these for each
158  * multicast address or range of multicast addresses that we are supposed
159  * to listen to on a particular interface.  They are kept in a linked list,
160  * rooted in the interface's arpcom structure.  (This really has nothing to
161  * do with ARP, or with the Internet address family, but this appears to be
162  * the minimally-disrupting place to put it.)
163  */
164 struct ether_multi {
165 	u_char	enm_addrlo[6];		/* low  or only address of range */
166 	u_char	enm_addrhi[6];		/* high or only address of range */
167 	struct	arpcom *enm_ac;		/* back pointer to arpcom */
168 	u_int	enm_refcount;		/* no. claims to this addr/range */
169 	struct	ether_multi *enm_next;	/* ptr to next ether_multi */
170 };
171 
172 /*
173  * Structure used by macros below to remember position when stepping through
174  * all of the ether_multi records.
175  */
176 struct ether_multistep {
177 	struct ether_multi  *e_enm;
178 };
179 
180 /*
181  * Macro for looking up the ether_multi record for a given range of Ethernet
182  * multicast addresses connected to a given arpcom structure.  If no matching
183  * record is found, "enm" returns NULL.
184  */
185 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \
186 	/* u_char addrlo[6]; */ \
187 	/* u_char addrhi[6]; */ \
188 	/* struct arpcom *ac; */ \
189 	/* struct ether_multi *enm; */ \
190 { \
191 	for ((enm) = (ac)->ac_multiaddrs; \
192 	    (enm) != NULL && \
193 	    (bcmp((enm)->enm_addrlo, (addrlo), 6) != 0 || \
194 	     bcmp((enm)->enm_addrhi, (addrhi), 6) != 0); \
195 		(enm) = (enm)->enm_next); \
196 }
197 
198 /*
199  * Macro to step through all of the ether_multi records, one at a time.
200  * The current position is remembered in "step", which the caller must
201  * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
202  * and get the first record.  Both macros return a NULL "enm" when there
203  * are no remaining records.
204  */
205 #define ETHER_NEXT_MULTI(step, enm) \
206 	/* struct ether_multistep step; */  \
207 	/* struct ether_multi *enm; */  \
208 { \
209 	if (((enm) = (step).e_enm) != NULL) \
210 		(step).e_enm = (enm)->enm_next; \
211 }
212 
213 #define ETHER_FIRST_MULTI(step, ac, enm) \
214 	/* struct ether_multistep step; */ \
215 	/* struct arpcom *ac; */ \
216 	/* struct ether_multi *enm; */ \
217 { \
218 	(step).e_enm = (ac)->ac_multiaddrs; \
219 	ETHER_NEXT_MULTI((step), (enm)); \
220 }
221 
222 #endif
223 
224 #endif
225