xref: /freebsd/sys/netinet/if_ether.h (revision 0c43d89a0d8e976ca494d4837f4c1f3734d2c300)
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.1 (Berkeley) 6/10/93
34  * $Id: if_ether.h,v 1.3 1994/08/18 22:35:27 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 #define	ETHERTYPE_PUP		0x0200	/* PUP protocol */
50 #define	ETHERTYPE_IP		0x0800	/* IP protocol */
51 #define ETHERTYPE_ARP		0x0806	/* Addr. resolution protocol */
52 #define ETHERTYPE_REVARP	0x8035	/* reverse Addr. resolution protocol */
53 
54 /*
55  * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
56  * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
57  * by an ETHER type (as given above) and then the (variable-length) header.
58  */
59 #define	ETHERTYPE_TRAIL		0x1000		/* Trailer packet */
60 #define	ETHERTYPE_NTRAILER	16
61 
62 #define	ETHERMTU	1500
63 #define	ETHERMIN	(60-14)
64 
65 #ifdef KERNEL
66 /*
67  * Macro to map an IP multicast address to an Ethernet multicast address.
68  * The high-order 25 bits of the Ethernet address are statically assigned,
69  * and the low-order 23 bits are taken from the low end of the IP address.
70  */
71 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \
72 	/* struct in_addr *ipaddr; */ \
73 	/* u_char enaddr[6];	   */ \
74 { \
75 	(enaddr)[0] = 0x01; \
76 	(enaddr)[1] = 0x00; \
77 	(enaddr)[2] = 0x5e; \
78 	(enaddr)[3] = ((u_char *)ipaddr)[1] & 0x7f; \
79 	(enaddr)[4] = ((u_char *)ipaddr)[2]; \
80 	(enaddr)[5] = ((u_char *)ipaddr)[3]; \
81 }
82 #endif
83 
84 /*
85  * Ethernet Address Resolution Protocol.
86  *
87  * See RFC 826 for protocol description.  Structure below is adapted
88  * to resolving internet addresses.  Field names used correspond to
89  * RFC 826.
90  */
91 struct	ether_arp {
92 	struct	arphdr ea_hdr;	/* fixed-size header */
93 	u_char	arp_sha[6];	/* sender hardware address */
94 	u_char	arp_spa[4];	/* sender protocol address */
95 	u_char	arp_tha[6];	/* target hardware address */
96 	u_char	arp_tpa[4];	/* target protocol address */
97 };
98 #define	arp_hrd	ea_hdr.ar_hrd
99 #define	arp_pro	ea_hdr.ar_pro
100 #define	arp_hln	ea_hdr.ar_hln
101 #define	arp_pln	ea_hdr.ar_pln
102 #define	arp_op	ea_hdr.ar_op
103 
104 
105 /*
106  * Structure shared between the ethernet driver modules and
107  * the address resolution code.  For example, each ec_softc or il_softc
108  * begins with this structure.
109  */
110 struct	arpcom {
111 	struct 	ifnet ac_if;		/* network-visible interface */
112 	u_char	ac_enaddr[6];		/* ethernet hardware address */
113 	struct	in_addr ac_ipaddr;	/* copy of ip address- XXX */
114 	struct	ether_multi *ac_multiaddrs; /* list of ether multicast addrs */
115 	int	ac_multicnt;		/* length of ac_multiaddrs list */
116 };
117 
118 struct llinfo_arp {
119 	struct	llinfo_arp *la_next;
120 	struct	llinfo_arp *la_prev;
121 	struct	rtentry *la_rt;
122 	struct	mbuf *la_hold;		/* last packet until resolved/timeout */
123 	long	la_asked;		/* last time we QUERIED for this addr */
124 #define la_timer la_rt->rt_rmx.rmx_expire /* deletion time in seconds */
125 };
126 
127 struct sockaddr_inarp {
128 	u_char	sin_len;
129 	u_char	sin_family;
130 	u_short sin_port;
131 	struct	in_addr sin_addr;
132 	struct	in_addr sin_srcaddr;
133 	u_short	sin_tos;
134 	u_short	sin_other;
135 #define SIN_PROXY 1
136 };
137 /*
138  * IP and ethernet specific routing flags
139  */
140 #define	RTF_USETRAILERS	RTF_PROTO1	/* use trailers */
141 #define RTF_ANNOUNCE	RTF_PROTO2	/* announce new arp entry */
142 
143 #ifdef	KERNEL
144 extern u_char	etherbroadcastaddr[6];
145 extern u_char	ether_ipmulticast_min[6];
146 extern u_char	ether_ipmulticast_max[6];
147 extern struct	ifqueue arpintrq;
148 
149 struct	llinfo_arp *arptnew __P((struct in_addr *));
150 extern struct	llinfo_arp llinfo_arp;		/* head of the llinfo queue */
151 
152 void	arpwhohas __P((struct arpcom *, struct in_addr *));
153 void	arpintr __P((void));
154 int	arpresolve __P((struct arpcom *,
155 	   struct rtentry *, struct mbuf *, struct sockaddr *, u_char *));
156 void	arp_rtrequest __P((int, struct rtentry *, struct sockaddr *));
157 
158 int	ether_addmulti __P((struct ifreq *, struct arpcom *));
159 int	ether_delmulti __P((struct ifreq *, struct arpcom *));
160 
161 /*
162  * Ethernet multicast address structure.  There is one of these for each
163  * multicast address or range of multicast addresses that we are supposed
164  * to listen to on a particular interface.  They are kept in a linked list,
165  * rooted in the interface's arpcom structure.  (This really has nothing to
166  * do with ARP, or with the Internet address family, but this appears to be
167  * the minimally-disrupting place to put it.)
168  */
169 struct ether_multi {
170 	u_char	enm_addrlo[6];		/* low  or only address of range */
171 	u_char	enm_addrhi[6];		/* high or only address of range */
172 	struct	arpcom *enm_ac;		/* back pointer to arpcom */
173 	u_int	enm_refcount;		/* no. claims to this addr/range */
174 	struct	ether_multi *enm_next;	/* ptr to next ether_multi */
175 };
176 
177 /*
178  * Structure used by macros below to remember position when stepping through
179  * all of the ether_multi records.
180  */
181 struct ether_multistep {
182 	struct ether_multi  *e_enm;
183 };
184 
185 /*
186  * Macro for looking up the ether_multi record for a given range of Ethernet
187  * multicast addresses connected to a given arpcom structure.  If no matching
188  * record is found, "enm" returns NULL.
189  */
190 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \
191 	/* u_char addrlo[6]; */ \
192 	/* u_char addrhi[6]; */ \
193 	/* struct arpcom *ac; */ \
194 	/* struct ether_multi *enm; */ \
195 { \
196 	for ((enm) = (ac)->ac_multiaddrs; \
197 	    (enm) != NULL && \
198 	    (bcmp((enm)->enm_addrlo, (addrlo), 6) != 0 || \
199 	     bcmp((enm)->enm_addrhi, (addrhi), 6) != 0); \
200 		(enm) = (enm)->enm_next); \
201 }
202 
203 /*
204  * Macro to step through all of the ether_multi records, one at a time.
205  * The current position is remembered in "step", which the caller must
206  * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
207  * and get the first record.  Both macros return a NULL "enm" when there
208  * are no remaining records.
209  */
210 #define ETHER_NEXT_MULTI(step, enm) \
211 	/* struct ether_multistep step; */  \
212 	/* struct ether_multi *enm; */  \
213 { \
214 	if (((enm) = (step).e_enm) != NULL) \
215 		(step).e_enm = (enm)->enm_next; \
216 }
217 
218 #define ETHER_FIRST_MULTI(step, ac, enm) \
219 	/* struct ether_multistep step; */ \
220 	/* struct arpcom *ac; */ \
221 	/* struct ether_multi *enm; */ \
222 { \
223 	(step).e_enm = (ac)->ac_multiaddrs; \
224 	ETHER_NEXT_MULTI((step), (enm)); \
225 }
226 
227 #endif
228 
229 #endif
230