xref: /netbsd-src/sys/netinet/if_ether.h (revision ce0bb6e8d2e560ecacbe865a848624f94498063b)
1 /*	$NetBSD: if_ether.h,v 1.17 1995/04/17 05:32:54 cgd Exp $	*/
2 
3 /*
4  * Copyright (c) 1982, 1986, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)if_ether.h	8.1 (Berkeley) 6/10/93
36  */
37 
38 /*
39  * Ethernet address - 6 octets
40  * this is only used by the ethers(3) functions.
41  */
42 struct ether_addr {
43 	u_int8_t ether_addr_octet[6];
44 };
45 
46 /*
47  * Structure of a 10Mb/s Ethernet header.
48  */
49 struct	ether_header {
50 	u_int8_t  ether_dhost[6];
51 	u_int8_t  ether_shost[6];
52 	u_int16_t ether_type;
53 };
54 
55 #define	ETHERTYPE_PUP		0x0200	/* PUP protocol */
56 #define	ETHERTYPE_IP		0x0800	/* IP protocol */
57 #define	ETHERTYPE_ARP		0x0806	/* address resolution protocol */
58 #define	ETHERTYPE_REVARP	0x8035	/* reverse addr resolution protocol */
59 
60 /*
61  * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
62  * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
63  * by an ETHER type (as given above) and then the (variable-length) header.
64  */
65 #define	ETHERTYPE_TRAIL		0x1000		/* Trailer packet */
66 #define	ETHERTYPE_NTRAILER	16
67 
68 #define	ETHERMTU	1500
69 #define	ETHERMIN	(60-14)
70 
71 #ifdef _KERNEL
72 /*
73  * Macro to map an IP multicast address to an Ethernet multicast address.
74  * The high-order 25 bits of the Ethernet address are statically assigned,
75  * and the low-order 23 bits are taken from the low end of the IP address.
76  */
77 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \
78 	/* struct in_addr *ipaddr; */ \
79 	/* u_int8_t enaddr[6];     */ \
80 { \
81 	(enaddr)[0] = 0x01; \
82 	(enaddr)[1] = 0x00; \
83 	(enaddr)[2] = 0x5e; \
84 	(enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f; \
85 	(enaddr)[4] = ((u_int8_t *)ipaddr)[2]; \
86 	(enaddr)[5] = ((u_int8_t *)ipaddr)[3]; \
87 }
88 #endif
89 
90 /*
91  * Ethernet Address Resolution Protocol.
92  *
93  * See RFC 826 for protocol description.  Structure below is adapted
94  * to resolving internet addresses.  Field names used correspond to
95  * RFC 826.
96  */
97 struct	ether_arp {
98 	struct	 arphdr ea_hdr;	/* fixed-size header */
99 	u_int8_t arp_sha[6];	/* sender hardware address */
100 	u_int8_t arp_spa[4];	/* sender protocol address */
101 	u_int8_t arp_tha[6];	/* target hardware address */
102 	u_int8_t arp_tpa[4];	/* target protocol address */
103 };
104 #define	arp_hrd	ea_hdr.ar_hrd
105 #define	arp_pro	ea_hdr.ar_pro
106 #define	arp_hln	ea_hdr.ar_hln
107 #define	arp_pln	ea_hdr.ar_pln
108 #define	arp_op	ea_hdr.ar_op
109 
110 /*
111  * Structure shared between the ethernet driver modules and
112  * the address resolution code.  For example, each ec_softc or il_softc
113  * begins with this structure.
114  */
115 struct	arpcom {
116 	struct	 ifnet ac_if;		/* network-visible interface */
117 	u_int8_t ac_enaddr[6];		/* ethernet hardware address */
118 	struct	 in_addr ac_ipaddr;	/* copy of ip address- XXX */
119 	struct	 ether_multi *ac_multiaddrs; /* list of ether multicast addrs */
120 	int	 ac_multicnt;		/* length of ac_multiaddrs list */
121 };
122 
123 struct llinfo_arp {
124 	struct	llinfo_arp *la_next;
125 	struct	llinfo_arp *la_prev;
126 	struct	rtentry *la_rt;
127 	struct	mbuf *la_hold;		/* last packet until resolved/timeout */
128 	long	la_asked;		/* last time we QUERIED for this addr */
129 #define la_timer la_rt->rt_rmx.rmx_expire /* deletion time in seconds */
130 };
131 
132 struct sockaddr_inarp {
133 	u_int8_t  sin_len;
134 	u_int8_t  sin_family;
135 	u_int16_t sin_port;
136 	struct	  in_addr sin_addr;
137 	struct	  in_addr sin_srcaddr;
138 	u_int16_t sin_tos;
139 	u_int16_t sin_other;
140 #define SIN_PROXY 1
141 };
142 
143 /*
144  * IP and ethernet specific routing flags
145  */
146 #define	RTF_USETRAILERS	RTF_PROTO1	/* use trailers */
147 #define	RTF_ANNOUNCE	RTF_PROTO2	/* announce new arp entry */
148 
149 #ifdef	_KERNEL
150 u_int8_t etherbroadcastaddr[6];
151 u_int8_t ether_ipmulticast_min[6];
152 u_int8_t ether_ipmulticast_max[6];
153 struct	ifqueue arpintrq;
154 
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_ifinit __P((struct arpcom *, struct ifaddr *));
162 void	arp_rtrequest __P((int, struct rtentry *, struct sockaddr *));
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_int8_t enm_addrlo[6];		/* low  or only address of range */
177 	u_int8_t 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_int8_t addrlo[6]; */ \
198 	/* u_int8_t 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