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