if_ether.h revision 1.31
1 /* $NetBSD: if_ether.h,v 1.31 2003/06/23 11:02:10 martin 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 #ifndef _NET_IF_ETHER_H_ 39 #define _NET_IF_ETHER_H_ 40 41 #ifdef _KERNEL 42 #include "opt_mbuftrace.h" 43 #include <sys/mbuf.h> 44 #endif 45 46 /* 47 * Some basic Ethernet constants. 48 */ 49 #define ETHER_ADDR_LEN 6 /* length of an Ethernet address */ 50 #define ETHER_TYPE_LEN 2 /* length of the Ethernet type field */ 51 #define ETHER_CRC_LEN 4 /* length of the Ethernet CRC */ 52 #define ETHER_HDR_LEN ((ETHER_ADDR_LEN * 2) + ETHER_TYPE_LEN) 53 #define ETHER_MIN_LEN 64 /* minimum frame length, including CRC */ 54 #define ETHER_MAX_LEN 1518 /* maximum frame length, including CRC */ 55 #define ETHER_MAX_LEN_JUMBO 9018 /* maximum jumbo frame len, including CRC */ 56 57 /* 58 * Some Ethernet extensions. 59 */ 60 #define ETHER_VLAN_ENCAP_LEN 4 /* length of 802.1Q VLAN encapsulation */ 61 62 /* 63 * Ethernet address - 6 octets 64 * this is only used by the ethers(3) functions. 65 */ 66 struct ether_addr { 67 u_int8_t ether_addr_octet[ETHER_ADDR_LEN]; 68 } __attribute__((__packed__)); 69 70 /* 71 * Structure of a 10Mb/s Ethernet header. 72 */ 73 struct ether_header { 74 u_int8_t ether_dhost[ETHER_ADDR_LEN]; 75 u_int8_t ether_shost[ETHER_ADDR_LEN]; 76 u_int16_t ether_type; 77 } __attribute__((__packed__)); 78 79 #include <net/ethertypes.h> 80 81 #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */ 82 83 #define ETHERMTU_JUMBO (ETHER_MAX_LEN_JUMBO - ETHER_HDR_LEN - ETHER_CRC_LEN) 84 #define ETHERMTU (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 85 #define ETHERMIN (ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 86 87 /* 88 * Compute the maximum frame size based on ethertype (i.e. possible 89 * encapsulation) and whether or not an FCS is present. 90 */ 91 #define ETHER_MAX_FRAME(ifp, etype, hasfcs) \ 92 ((ifp)->if_mtu + ETHER_HDR_LEN + \ 93 ((hasfcs) ? ETHER_CRC_LEN : 0) + \ 94 (((etype) == ETHERTYPE_VLAN) ? ETHER_VLAN_ENCAP_LEN : 0)) 95 96 /* 97 * Ethernet CRC32 polynomials (big- and little-endian verions). 98 */ 99 #define ETHER_CRC_POLY_LE 0xedb88320 100 #define ETHER_CRC_POLY_BE 0x04c11db6 101 102 #ifndef _STANDALONE 103 104 /* 105 * Ethernet-specific mbuf flags. 106 */ 107 #define M_HASFCS M_LINK0 /* FCS included at end of frame */ 108 #define M_PROMISC M_LINK1 /* this packet is not for us */ 109 110 #ifdef _KERNEL 111 /* 112 * Macro to map an IP multicast address to an Ethernet multicast address. 113 * The high-order 25 bits of the Ethernet address are statically assigned, 114 * and the low-order 23 bits are taken from the low end of the IP address. 115 */ 116 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \ 117 /* struct in_addr *ipaddr; */ \ 118 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 119 { \ 120 (enaddr)[0] = 0x01; \ 121 (enaddr)[1] = 0x00; \ 122 (enaddr)[2] = 0x5e; \ 123 (enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f; \ 124 (enaddr)[4] = ((u_int8_t *)ipaddr)[2]; \ 125 (enaddr)[5] = ((u_int8_t *)ipaddr)[3]; \ 126 } 127 /* 128 * Macro to map an IP6 multicast address to an Ethernet multicast address. 129 * The high-order 16 bits of the Ethernet address are statically assigned, 130 * and the low-order 32 bits are taken from the low end of the IP6 address. 131 */ 132 #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr) \ 133 /* struct in6_addr *ip6addr; */ \ 134 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 135 { \ 136 (enaddr)[0] = 0x33; \ 137 (enaddr)[1] = 0x33; \ 138 (enaddr)[2] = ((u_int8_t *)ip6addr)[12]; \ 139 (enaddr)[3] = ((u_int8_t *)ip6addr)[13]; \ 140 (enaddr)[4] = ((u_int8_t *)ip6addr)[14]; \ 141 (enaddr)[5] = ((u_int8_t *)ip6addr)[15]; \ 142 } 143 #endif 144 145 /* 146 * Structure shared between the ethernet driver modules and 147 * the multicast list code. For example, each ec_softc or il_softc 148 * begins with this structure. 149 */ 150 struct ethercom { 151 struct ifnet ec_if; /* network-visible interface */ 152 LIST_HEAD(, ether_multi) ec_multiaddrs; /* list of ether multicast 153 addrs */ 154 int ec_multicnt; /* length of ec_multiaddrs 155 list */ 156 int ec_capabilities; /* capabilities, provided by 157 driver */ 158 int ec_capenable; /* tells hardware which 159 capabilities to enable */ 160 161 int ec_nvlans; /* # VLANs on this interface */ 162 #ifdef MBUFTRACE 163 struct mowner ec_rx_mowner; /* mbufs received */ 164 struct mowner ec_tx_mowner; /* mbufs transmitted */ 165 #endif 166 }; 167 168 #define ETHERCAP_VLAN_MTU 0x00000001 /* VLAN-compatible MTU */ 169 #define ETHERCAP_VLAN_HWTAGGING 0x00000002 /* hardware VLAN tag support */ 170 #define ETHERCAP_JUMBO_MTU 0x00000004 /* 9000 byte MTU supported */ 171 172 #ifdef _KERNEL 173 extern u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN]; 174 extern u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN]; 175 extern u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN]; 176 177 int ether_ioctl(struct ifnet *, u_long, caddr_t); 178 int ether_addmulti (struct ifreq *, struct ethercom *); 179 int ether_delmulti (struct ifreq *, struct ethercom *); 180 int ether_changeaddr (struct ifreq *, struct ethercom *); 181 int ether_multiaddr(struct sockaddr *, u_int8_t[], u_int8_t[]); 182 #endif /* _KERNEL */ 183 184 /* 185 * Ethernet multicast address structure. There is one of these for each 186 * multicast address or range of multicast addresses that we are supposed 187 * to listen to on a particular interface. They are kept in a linked list, 188 * rooted in the interface's ethercom structure. 189 */ 190 struct ether_multi { 191 u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low or only address of range */ 192 u_int8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */ 193 struct ethercom *enm_ec; /* back pointer to ethercom */ 194 u_int enm_refcount; /* no. claims to this addr/range */ 195 LIST_ENTRY(ether_multi) enm_list; 196 }; 197 198 /* 199 * Structure used by macros below to remember position when stepping through 200 * all of the ether_multi records. 201 */ 202 struct ether_multistep { 203 struct ether_multi *e_enm; 204 }; 205 206 /* 207 * Macro for looking up the ether_multi record for a given range of Ethernet 208 * multicast addresses connected to a given ethercom structure. If no matching 209 * record is found, "enm" returns NULL. 210 */ 211 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ec, enm) \ 212 /* u_int8_t addrlo[ETHER_ADDR_LEN]; */ \ 213 /* u_int8_t addrhi[ETHER_ADDR_LEN]; */ \ 214 /* struct ethercom *ec; */ \ 215 /* struct ether_multi *enm; */ \ 216 { \ 217 for ((enm) = LIST_FIRST(&(ec)->ec_multiaddrs); \ 218 (enm) != NULL && \ 219 (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 || \ 220 bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0); \ 221 (enm) = LIST_NEXT((enm), enm_list)); \ 222 } 223 224 /* 225 * Macro to step through all of the ether_multi records, one at a time. 226 * The current position is remembered in "step", which the caller must 227 * provide. ETHER_FIRST_MULTI(), below, must be called to initialize "step" 228 * and get the first record. Both macros return a NULL "enm" when there 229 * are no remaining records. 230 */ 231 #define ETHER_NEXT_MULTI(step, enm) \ 232 /* struct ether_multistep step; */ \ 233 /* struct ether_multi *enm; */ \ 234 { \ 235 if (((enm) = (step).e_enm) != NULL) \ 236 (step).e_enm = LIST_NEXT((enm), enm_list); \ 237 } 238 239 #define ETHER_FIRST_MULTI(step, ec, enm) \ 240 /* struct ether_multistep step; */ \ 241 /* struct ethercom *ec; */ \ 242 /* struct ether_multi *enm; */ \ 243 { \ 244 (step).e_enm = LIST_FIRST(&(ec)->ec_multiaddrs); \ 245 ETHER_NEXT_MULTI((step), (enm)); \ 246 } 247 248 #ifdef _KERNEL 249 void ether_ifattach(struct ifnet *, const u_int8_t *); 250 void ether_ifdetach(struct ifnet *); 251 252 char *ether_sprintf(const u_int8_t *); 253 254 u_int32_t ether_crc32_le(const u_int8_t *, size_t); 255 u_int32_t ether_crc32_be(const u_int8_t *, size_t); 256 257 #else 258 /* 259 * Prototype ethers(3) functions. 260 */ 261 #include <sys/cdefs.h> 262 __BEGIN_DECLS 263 char * ether_ntoa __P((const struct ether_addr *)); 264 struct ether_addr * 265 ether_aton __P((const char *)); 266 int ether_ntohost __P((char *, const struct ether_addr *)); 267 int ether_hostton __P((const char *, struct ether_addr *)); 268 int ether_line __P((const char *, struct ether_addr *, char *)); 269 __END_DECLS 270 #endif 271 272 #endif /* _STANDALONE */ 273 274 #endif /* _NET_IF_ETHER_H_ */ 275
Indexes created Mon Sep 22 13:09:51 GMT 2025