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