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