if_ether.h revision 1.85
1 /* $NetBSD: if_ether.h,v 1.85 2021/02/13 07:28:04 roy 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. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)if_ether.h 8.1 (Berkeley) 6/10/93 32 */ 33 34 #ifndef _NET_IF_ETHER_H_ 35 #define _NET_IF_ETHER_H_ 36 37 #ifdef _KERNEL 38 #ifdef _KERNEL_OPT 39 #include "opt_mbuftrace.h" 40 #endif 41 #include <sys/mbuf.h> 42 #endif 43 44 #ifndef _STANDALONE 45 #include <net/if.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 #define EVL_VLANOFTAG(tag) ((tag) & 4095) /* VLAN ID */ 64 #define EVL_PRIOFTAG(tag) (((tag) >> 13) & 7) /* Priority */ 65 #define EVL_CFIOFTAG(tag) (((tag) >> 12) & 1) /* CFI */ 66 #define ETHER_PPPOE_ENCAP_LEN 8 /* length of PPPoE encapsulation */ 67 68 /* 69 * Mbuf adjust factor to force 32-bit alignment of IP header. 70 * Drivers should do m_adj(m, ETHER_ALIGN) when setting up a 71 * receive so the upper layers get the IP header properly aligned 72 * past the 14-byte Ethernet header. 73 */ 74 #define ETHER_ALIGN 2 /* driver adjust for IP hdr alignment */ 75 76 /* 77 * Ethernet address - 6 octets 78 * this is only used by the ethers(3) functions. 79 */ 80 struct ether_addr { 81 uint8_t ether_addr_octet[ETHER_ADDR_LEN]; 82 }; 83 84 /* 85 * Structure of a 10Mb/s Ethernet header. 86 */ 87 struct ether_header { 88 uint8_t ether_dhost[ETHER_ADDR_LEN]; 89 uint8_t ether_shost[ETHER_ADDR_LEN]; 90 uint16_t ether_type; 91 }; 92 #ifdef __NO_STRICT_ALIGNMENT 93 #define ETHER_HDR_ALIGNED_P(eh) 1 94 #else 95 #define ETHER_HDR_ALIGNED_P(eh) ((((vaddr_t) (eh)) & 3) == 0) 96 #endif 97 #ifdef __CTASSERT 98 __CTASSERT(sizeof(struct ether_addr) == 6); 99 __CTASSERT(sizeof(struct ether_header) == 14); 100 #endif 101 102 #include <net/ethertypes.h> 103 104 #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */ 105 #define ETHER_IS_LOCAL(addr) (*(addr) & 0x02) /* is address local? */ 106 107 #define ETHERMTU_JUMBO (ETHER_MAX_LEN_JUMBO - ETHER_HDR_LEN - ETHER_CRC_LEN) 108 #define ETHERMTU (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 109 #define ETHERMIN (ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 110 111 /* 112 * Compute the maximum frame size based on ethertype (i.e. possible 113 * encapsulation) and whether or not an FCS is present. 114 */ 115 #define ETHER_MAX_FRAME(ifp, etype, hasfcs) \ 116 ((ifp)->if_mtu + ETHER_HDR_LEN + \ 117 ((hasfcs) ? ETHER_CRC_LEN : 0) + \ 118 (((etype) == ETHERTYPE_VLAN) ? ETHER_VLAN_ENCAP_LEN : 0) + \ 119 (((etype) == ETHERTYPE_PPPOE) ? ETHER_PPPOE_ENCAP_LEN : 0)) 120 121 /* 122 * Ethernet CRC32 polynomials (big- and little-endian verions). 123 */ 124 #define ETHER_CRC_POLY_LE 0xedb88320 125 #define ETHER_CRC_POLY_BE 0x04c11db6 126 127 #ifndef _STANDALONE 128 129 /* 130 * Ethernet-specific mbuf flags. 131 */ 132 #define M_HASFCS M_LINK0 /* FCS included at end of frame */ 133 #define M_PROMISC M_LINK1 /* this packet is not for us */ 134 135 #ifdef _KERNEL 136 /* 137 * Macro to map an IP multicast address to an Ethernet multicast address. 138 * The high-order 25 bits of the Ethernet address are statically assigned, 139 * and the low-order 23 bits are taken from the low end of the IP address. 140 */ 141 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \ 142 /* const struct in_addr *ipaddr; */ \ 143 /* uint8_t enaddr[ETHER_ADDR_LEN]; */ \ 144 do { \ 145 (enaddr)[0] = 0x01; \ 146 (enaddr)[1] = 0x00; \ 147 (enaddr)[2] = 0x5e; \ 148 (enaddr)[3] = ((const uint8_t *)ipaddr)[1] & 0x7f; \ 149 (enaddr)[4] = ((const uint8_t *)ipaddr)[2]; \ 150 (enaddr)[5] = ((const uint8_t *)ipaddr)[3]; \ 151 } while (/*CONSTCOND*/0) 152 /* 153 * Macro to map an IP6 multicast address to an Ethernet multicast address. 154 * The high-order 16 bits of the Ethernet address are statically assigned, 155 * and the low-order 32 bits are taken from the low end of the IP6 address. 156 */ 157 #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr) \ 158 /* struct in6_addr *ip6addr; */ \ 159 /* uint8_t enaddr[ETHER_ADDR_LEN]; */ \ 160 { \ 161 (enaddr)[0] = 0x33; \ 162 (enaddr)[1] = 0x33; \ 163 (enaddr)[2] = ((const uint8_t *)ip6addr)[12]; \ 164 (enaddr)[3] = ((const uint8_t *)ip6addr)[13]; \ 165 (enaddr)[4] = ((const uint8_t *)ip6addr)[14]; \ 166 (enaddr)[5] = ((const uint8_t *)ip6addr)[15]; \ 167 } 168 #endif 169 170 struct mii_data; 171 172 struct ethercom; 173 174 typedef int (*ether_cb_t)(struct ethercom *); 175 typedef int (*ether_vlancb_t)(struct ethercom *, uint16_t, bool); 176 177 /* 178 * Structure shared between the ethernet driver modules and 179 * the multicast list code. For example, each ec_softc or il_softc 180 * begins with this structure. 181 */ 182 struct ethercom { 183 struct ifnet ec_if; /* network-visible interface */ 184 LIST_HEAD(, ether_multi) ec_multiaddrs; /* list of ether multicast 185 addrs */ 186 int ec_multicnt; /* length of ec_multiaddrs 187 list */ 188 int ec_capabilities; /* capabilities, provided by 189 driver */ 190 int ec_capenable; /* tells hardware which 191 capabilities to enable */ 192 193 int ec_nvlans; /* # VLANs on this interface */ 194 SIMPLEQ_HEAD(, vlanid_list) ec_vids; /* list of VLAN IDs */ 195 /* The device handle for the MII bus child device. */ 196 struct mii_data *ec_mii; 197 struct ifmedia *ec_ifmedia; 198 /* 199 * Called after a change to ec_if.if_flags. Returns 200 * ENETRESET if the device should be reinitialized with 201 * ec_if.if_init, 0 on success, not 0 on failure. 202 */ 203 ether_cb_t ec_ifflags_cb; 204 /* 205 * Called whenever a vlan interface is configured or unconfigured. 206 * Args include the vlan tag and a flag indicating whether the tag is 207 * being added or removed. 208 */ 209 ether_vlancb_t ec_vlan_cb; 210 kmutex_t *ec_lock; 211 /* Flags used only by the kernel */ 212 int ec_flags; 213 #ifdef MBUFTRACE 214 struct mowner ec_rx_mowner; /* mbufs received */ 215 struct mowner ec_tx_mowner; /* mbufs transmitted */ 216 #endif 217 }; 218 219 #define ETHERCAP_VLAN_MTU 0x00000001 /* VLAN-compatible MTU */ 220 #define ETHERCAP_VLAN_HWTAGGING 0x00000002 /* hardware VLAN tag support */ 221 #define ETHERCAP_JUMBO_MTU 0x00000004 /* 9000 byte MTU supported */ 222 #define ETHERCAP_VLAN_HWFILTER 0x00000008 /* iface hw can filter vlan tag */ 223 #define ETHERCAP_EEE 0x00000010 /* Energy Efficiency Ethernet */ 224 #define ETHERCAP_MASK 0x0000001f 225 226 #define ECCAPBITS \ 227 "\020" \ 228 "\1VLAN_MTU" \ 229 "\2VLAN_HWTAGGING" \ 230 "\3JUMBO_MTU" \ 231 "\4VLAN_HWFILTER" \ 232 "\5EEE" 233 234 /* ioctl() for Ethernet capabilities */ 235 struct eccapreq { 236 char eccr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 237 int eccr_capabilities; /* supported capabiliites */ 238 int eccr_capenable; /* capabilities enabled */ 239 }; 240 241 /* sysctl for Ethernet multicast addresses */ 242 struct ether_multi_sysctl { 243 u_int enm_refcount; 244 uint8_t enm_addrlo[ETHER_ADDR_LEN]; 245 uint8_t enm_addrhi[ETHER_ADDR_LEN]; 246 }; 247 248 #ifdef _KERNEL 249 /* 250 * Flags for ec_flags 251 */ 252 /* Store IFF_ALLMULTI in ec_flags instead of if_flags to avoid data races. */ 253 #define ETHER_F_ALLMULTI __BIT(0) 254 255 extern const uint8_t etherbroadcastaddr[ETHER_ADDR_LEN]; 256 extern const uint8_t ethermulticastaddr_slowprotocols[ETHER_ADDR_LEN]; 257 extern const uint8_t ether_ipmulticast_min[ETHER_ADDR_LEN]; 258 extern const uint8_t ether_ipmulticast_max[ETHER_ADDR_LEN]; 259 260 void ether_set_ifflags_cb(struct ethercom *, ether_cb_t); 261 void ether_set_vlan_cb(struct ethercom *, ether_vlancb_t); 262 int ether_ioctl(struct ifnet *, u_long, void *); 263 int ether_addmulti(const struct sockaddr *, struct ethercom *); 264 int ether_delmulti(const struct sockaddr *, struct ethercom *); 265 int ether_multiaddr(const struct sockaddr *, uint8_t[], uint8_t[]); 266 void ether_input(struct ifnet *, struct mbuf *); 267 268 /* 269 * Ethernet multicast address structure. There is one of these for each 270 * multicast address or range of multicast addresses that we are supposed 271 * to listen to on a particular interface. They are kept in a linked list, 272 * rooted in the interface's ethercom structure. 273 */ 274 struct ether_multi { 275 uint8_t enm_addrlo[ETHER_ADDR_LEN]; /* low or only address of range */ 276 uint8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */ 277 u_int enm_refcount; /* no. claims to this addr/range */ 278 LIST_ENTRY(ether_multi) enm_list; 279 }; 280 281 /* 282 * Structure used by macros below to remember position when stepping through 283 * all of the ether_multi records. 284 */ 285 struct ether_multistep { 286 struct ether_multi *e_enm; 287 }; 288 289 /* 290 * lookup the ether_multi record for a given range of Ethernet 291 * multicast addresses connected to a given ethercom structure. 292 * If no matching record is found, NULL is returned. 293 */ 294 static __inline struct ether_multi * 295 ether_lookup_multi(const uint8_t *addrlo, const uint8_t *addrhi, 296 const struct ethercom *ec) 297 { 298 struct ether_multi *enm; 299 300 LIST_FOREACH(enm, &ec->ec_multiaddrs, enm_list) { 301 if (memcmp(enm->enm_addrlo, addrlo, ETHER_ADDR_LEN) != 0) 302 continue; 303 if (memcmp(enm->enm_addrhi, addrhi, ETHER_ADDR_LEN) != 0) 304 continue; 305 306 break; 307 } 308 309 return enm; 310 } 311 312 /* 313 * step through all of the ether_multi records, one at a time. 314 * The current position is remembered in "step", which the caller must 315 * provide. ether_first_multi(), below, must be called to initialize "step" 316 * and get the first record. Both functions return a NULL when there 317 * are no remaining records. 318 */ 319 static __inline struct ether_multi * 320 ether_next_multi(struct ether_multistep *step) 321 { 322 struct ether_multi *enm; 323 324 enm = step->e_enm; 325 if (enm != NULL) 326 step->e_enm = LIST_NEXT(enm, enm_list); 327 328 return enm; 329 } 330 #define ETHER_NEXT_MULTI(step, enm) \ 331 /* struct ether_multistep step; */ \ 332 /* struct ether_multi *enm; */ \ 333 (enm) = ether_next_multi(&(step)) 334 335 static __inline struct ether_multi * 336 ether_first_multi(struct ether_multistep *step, const struct ethercom *ec) 337 { 338 339 step->e_enm = LIST_FIRST(&ec->ec_multiaddrs); 340 341 return ether_next_multi(step); 342 } 343 344 #define ETHER_FIRST_MULTI(step, ec, enm) \ 345 /* struct ether_multistep step; */ \ 346 /* struct ethercom *ec; */ \ 347 /* struct ether_multi *enm; */ \ 348 (enm) = ether_first_multi(&(step), (ec)) 349 350 #define ETHER_LOCK(ec) mutex_enter((ec)->ec_lock) 351 #define ETHER_UNLOCK(ec) mutex_exit((ec)->ec_lock) 352 353 /* 354 * Ethernet 802.1Q VLAN structures. 355 */ 356 357 /* for ethercom */ 358 struct vlanid_list { 359 uint16_t vid; 360 SIMPLEQ_ENTRY(vlanid_list) vid_list; 361 }; 362 363 /* add VLAN tag to input/received packet */ 364 static __inline void 365 vlan_set_tag(struct mbuf *m, uint16_t vlantag) 366 { 367 /* VLAN tag contains priority, CFI and VLAN ID */ 368 KASSERT((m->m_flags & M_PKTHDR) != 0); 369 m->m_pkthdr.ether_vtag = vlantag; 370 m->m_flags |= M_VLANTAG; 371 return; 372 } 373 374 static __inline bool 375 vlan_has_tag(struct mbuf *m) 376 { 377 return (m->m_flags & M_VLANTAG) != 0; 378 } 379 380 /* extract VLAN ID value from a VLAN tag */ 381 static __inline uint16_t 382 vlan_get_tag(struct mbuf *m) 383 { 384 KASSERT((m->m_flags & M_PKTHDR) != 0); 385 KASSERT(m->m_flags & M_VLANTAG); 386 return m->m_pkthdr.ether_vtag; 387 } 388 389 /* test if any VLAN is configured for this interface */ 390 #define VLAN_ATTACHED(ec) ((ec)->ec_nvlans > 0) 391 392 void etherinit(void); 393 void ether_ifattach(struct ifnet *, const uint8_t *); 394 void ether_ifdetach(struct ifnet *); 395 int ether_mediachange(struct ifnet *); 396 void ether_mediastatus(struct ifnet *, struct ifmediareq *); 397 398 char *ether_sprintf(const uint8_t *); 399 char *ether_snprintf(char *, size_t, const uint8_t *); 400 401 uint32_t ether_crc32_le(const uint8_t *, size_t); 402 uint32_t ether_crc32_be(const uint8_t *, size_t); 403 404 int ether_aton_r(u_char *, size_t, const char *); 405 int ether_enable_vlan_mtu(struct ifnet *); 406 int ether_disable_vlan_mtu(struct ifnet *); 407 #else 408 /* 409 * Prototype ethers(3) functions. 410 */ 411 #include <sys/cdefs.h> 412 __BEGIN_DECLS 413 char * ether_ntoa(const struct ether_addr *); 414 struct ether_addr * 415 ether_aton(const char *); 416 int ether_ntohost(char *, const struct ether_addr *); 417 int ether_hostton(const char *, struct ether_addr *); 418 int ether_line(const char *, struct ether_addr *, char *); 419 __END_DECLS 420 #endif 421 422 #endif /* _STANDALONE */ 423 424 #endif /* !_NET_IF_ETHER_H_ */ 425
Indexes created Fri Oct 03 02:09:57 GMT 2025