if_ether.h revision 1.18 1 1.18 enami /* $NetBSD: if_ether.h,v 1.18 2000/09/28 07:15:27 enami Exp $ */
2 1.2 is
3 1.2 is /*
4 1.2 is * Copyright (c) 1982, 1986, 1993
5 1.2 is * The Regents of the University of California. All rights reserved.
6 1.2 is *
7 1.2 is * Redistribution and use in source and binary forms, with or without
8 1.2 is * modification, are permitted provided that the following conditions
9 1.2 is * are met:
10 1.2 is * 1. Redistributions of source code must retain the above copyright
11 1.2 is * notice, this list of conditions and the following disclaimer.
12 1.2 is * 2. Redistributions in binary form must reproduce the above copyright
13 1.2 is * notice, this list of conditions and the following disclaimer in the
14 1.2 is * documentation and/or other materials provided with the distribution.
15 1.2 is * 3. All advertising materials mentioning features or use of this software
16 1.2 is * must display the following acknowledgement:
17 1.2 is * This product includes software developed by the University of
18 1.2 is * California, Berkeley and its contributors.
19 1.2 is * 4. Neither the name of the University nor the names of its contributors
20 1.2 is * may be used to endorse or promote products derived from this software
21 1.2 is * without specific prior written permission.
22 1.2 is *
23 1.2 is * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 1.2 is * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 1.2 is * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 1.2 is * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 1.2 is * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 1.2 is * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 1.2 is * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 1.2 is * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 1.2 is * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 1.2 is * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 1.2 is * SUCH DAMAGE.
34 1.2 is *
35 1.2 is * @(#)if_ether.h 8.1 (Berkeley) 6/10/93
36 1.2 is */
37 1.2 is
38 1.4 perry #ifndef _NET_IF_ETHER_H_
39 1.4 perry #define _NET_IF_ETHER_H_
40 1.4 perry
41 1.2 is /*
42 1.7 thorpej * Some basic Ethernet constants.
43 1.7 thorpej */
44 1.7 thorpej #define ETHER_ADDR_LEN 6 /* length of an Ethernet address */
45 1.7 thorpej #define ETHER_TYPE_LEN 2 /* length of the Ethernet type field */
46 1.7 thorpej #define ETHER_CRC_LEN 4 /* length of the Ethernet CRC */
47 1.7 thorpej #define ETHER_HDR_LEN ((ETHER_ADDR_LEN * 2) + ETHER_TYPE_LEN)
48 1.7 thorpej #define ETHER_MIN_LEN 64 /* minimum frame length, including CRC */
49 1.7 thorpej #define ETHER_MAX_LEN 1518 /* maximum frame length, including CRC */
50 1.7 thorpej
51 1.7 thorpej /*
52 1.2 is * Ethernet address - 6 octets
53 1.2 is * this is only used by the ethers(3) functions.
54 1.2 is */
55 1.2 is struct ether_addr {
56 1.7 thorpej u_int8_t ether_addr_octet[ETHER_ADDR_LEN];
57 1.13 thorpej } __attribute__((__packed__));
58 1.2 is
59 1.2 is /*
60 1.2 is * Structure of a 10Mb/s Ethernet header.
61 1.2 is */
62 1.2 is struct ether_header {
63 1.2 is u_int8_t ether_dhost[ETHER_ADDR_LEN];
64 1.2 is u_int8_t ether_shost[ETHER_ADDR_LEN];
65 1.2 is u_int16_t ether_type;
66 1.13 thorpej } __attribute__((__packed__));
67 1.2 is
68 1.2 is #include <net/ethertypes.h>
69 1.2 is
70 1.2 is #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */
71 1.2 is
72 1.7 thorpej #define ETHERMTU (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
73 1.7 thorpej #define ETHERMIN (ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
74 1.2 is
75 1.14 thorpej /*
76 1.14 thorpej * Ethernet CRC32 polynomials (big- and little-endian verions).
77 1.14 thorpej */
78 1.14 thorpej #define ETHER_CRC_POLY_LE 0xedb88320
79 1.14 thorpej #define ETHER_CRC_POLY_BE 0x04c11db6
80 1.14 thorpej
81 1.8 drochner #ifndef _STANDALONE
82 1.10 thorpej
83 1.10 thorpej /*
84 1.10 thorpej * Ethernet-specific mbuf flags.
85 1.10 thorpej */
86 1.11 thorpej #define M_HASFCS M_LINK0 /* FCS included at end of frame */
87 1.8 drochner
88 1.2 is #ifdef _KERNEL
89 1.2 is /*
90 1.2 is * Macro to map an IP multicast address to an Ethernet multicast address.
91 1.2 is * The high-order 25 bits of the Ethernet address are statically assigned,
92 1.2 is * and the low-order 23 bits are taken from the low end of the IP address.
93 1.2 is */
94 1.2 is #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \
95 1.2 is /* struct in_addr *ipaddr; */ \
96 1.2 is /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \
97 1.2 is { \
98 1.2 is (enaddr)[0] = 0x01; \
99 1.2 is (enaddr)[1] = 0x00; \
100 1.2 is (enaddr)[2] = 0x5e; \
101 1.2 is (enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f; \
102 1.2 is (enaddr)[4] = ((u_int8_t *)ipaddr)[2]; \
103 1.2 is (enaddr)[5] = ((u_int8_t *)ipaddr)[3]; \
104 1.9 itojun }
105 1.9 itojun /*
106 1.9 itojun * Macro to map an IP6 multicast address to an Ethernet multicast address.
107 1.9 itojun * The high-order 16 bits of the Ethernet address are statically assigned,
108 1.9 itojun * and the low-order 32 bits are taken from the low end of the IP6 address.
109 1.9 itojun */
110 1.9 itojun #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr) \
111 1.9 itojun /* struct in6_addr *ip6addr; */ \
112 1.12 thorpej /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \
113 1.9 itojun { \
114 1.9 itojun (enaddr)[0] = 0x33; \
115 1.9 itojun (enaddr)[1] = 0x33; \
116 1.12 thorpej (enaddr)[2] = ((u_int8_t *)ip6addr)[12]; \
117 1.12 thorpej (enaddr)[3] = ((u_int8_t *)ip6addr)[13]; \
118 1.12 thorpej (enaddr)[4] = ((u_int8_t *)ip6addr)[14]; \
119 1.12 thorpej (enaddr)[5] = ((u_int8_t *)ip6addr)[15]; \
120 1.2 is }
121 1.2 is #endif
122 1.2 is
123 1.2 is /*
124 1.2 is * Structure shared between the ethernet driver modules and
125 1.2 is * the multicast list code. For example, each ec_softc or il_softc
126 1.2 is * begins with this structure.
127 1.2 is */
128 1.2 is struct ethercom {
129 1.2 is struct ifnet ec_if; /* network-visible interface */
130 1.2 is LIST_HEAD(, ether_multi) ec_multiaddrs; /* list of ether multicast addrs */
131 1.16 enami int ec_multicnt; /* length of ec_multiaddrs list */
132 1.2 is };
133 1.2 is
134 1.2 is #ifdef _KERNEL
135 1.15 simonb extern u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN];
136 1.15 simonb extern u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN];
137 1.15 simonb extern u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN];
138 1.2 is
139 1.17 matt int ether_addmulti (struct ifreq *, struct ethercom *);
140 1.17 matt int ether_delmulti (struct ifreq *, struct ethercom *);
141 1.17 matt int ether_changeaddr (struct ifreq *, struct ethercom *);
142 1.18 enami int ether_multiaddr(struct sockaddr *, u_int8_t[], u_int8_t[]);
143 1.2 is #endif /* _KERNEL */
144 1.2 is
145 1.2 is /*
146 1.2 is * Ethernet multicast address structure. There is one of these for each
147 1.2 is * multicast address or range of multicast addresses that we are supposed
148 1.2 is * to listen to on a particular interface. They are kept in a linked list,
149 1.5 is * rooted in the interface's ethercom structure.
150 1.2 is */
151 1.2 is struct ether_multi {
152 1.2 is u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low or only address of range */
153 1.2 is u_int8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */
154 1.2 is struct ethercom *enm_ec; /* back pointer to ethercom */
155 1.2 is u_int enm_refcount; /* no. claims to this addr/range */
156 1.2 is LIST_ENTRY(ether_multi) enm_list;
157 1.2 is };
158 1.2 is
159 1.2 is /*
160 1.2 is * Structure used by macros below to remember position when stepping through
161 1.2 is * all of the ether_multi records.
162 1.2 is */
163 1.2 is struct ether_multistep {
164 1.2 is struct ether_multi *e_enm;
165 1.2 is };
166 1.2 is
167 1.2 is /*
168 1.2 is * Macro for looking up the ether_multi record for a given range of Ethernet
169 1.2 is * multicast addresses connected to a given ethercom structure. If no matching
170 1.2 is * record is found, "enm" returns NULL.
171 1.2 is */
172 1.2 is #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ec, enm) \
173 1.2 is /* u_int8_t addrlo[ETHER_ADDR_LEN]; */ \
174 1.2 is /* u_int8_t addrhi[ETHER_ADDR_LEN]; */ \
175 1.2 is /* struct ethercom *ec; */ \
176 1.2 is /* struct ether_multi *enm; */ \
177 1.2 is { \
178 1.2 is for ((enm) = (ec)->ec_multiaddrs.lh_first; \
179 1.2 is (enm) != NULL && \
180 1.2 is (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 || \
181 1.2 is bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0); \
182 1.2 is (enm) = (enm)->enm_list.le_next); \
183 1.2 is }
184 1.2 is
185 1.2 is /*
186 1.2 is * Macro to step through all of the ether_multi records, one at a time.
187 1.2 is * The current position is remembered in "step", which the caller must
188 1.2 is * provide. ETHER_FIRST_MULTI(), below, must be called to initialize "step"
189 1.2 is * and get the first record. Both macros return a NULL "enm" when there
190 1.2 is * are no remaining records.
191 1.2 is */
192 1.2 is #define ETHER_NEXT_MULTI(step, enm) \
193 1.2 is /* struct ether_multistep step; */ \
194 1.2 is /* struct ether_multi *enm; */ \
195 1.2 is { \
196 1.2 is if (((enm) = (step).e_enm) != NULL) \
197 1.2 is (step).e_enm = (enm)->enm_list.le_next; \
198 1.2 is }
199 1.2 is
200 1.2 is #define ETHER_FIRST_MULTI(step, ec, enm) \
201 1.2 is /* struct ether_multistep step; */ \
202 1.2 is /* struct ethercom *ec; */ \
203 1.2 is /* struct ether_multi *enm; */ \
204 1.2 is { \
205 1.2 is (step).e_enm = (ec)->ec_multiaddrs.lh_first; \
206 1.2 is ETHER_NEXT_MULTI((step), (enm)); \
207 1.2 is }
208 1.2 is
209 1.14 thorpej #ifdef _KERNEL
210 1.17 matt u_int32_t ether_crc32_le (const u_int8_t *, size_t);
211 1.17 matt u_int32_t ether_crc32_be (const u_int8_t *, size_t);
212 1.14 thorpej #else
213 1.2 is /*
214 1.2 is * Prototype ethers(3) functions.
215 1.2 is */
216 1.2 is #include <sys/cdefs.h>
217 1.2 is __BEGIN_DECLS
218 1.2 is char * ether_ntoa __P((struct ether_addr *));
219 1.2 is struct ether_addr *
220 1.3 lukem ether_aton __P((const char *));
221 1.2 is int ether_ntohost __P((char *, struct ether_addr *));
222 1.3 lukem int ether_hostton __P((const char *, struct ether_addr *));
223 1.3 lukem int ether_line __P((const char *, struct ether_addr *, char *));
224 1.2 is __END_DECLS
225 1.2 is #endif
226 1.8 drochner
227 1.8 drochner #endif /* _STANDALONE */
228 1.4 perry
229 1.4 perry #endif /* _NET_IF_ETHER_H_ */
230