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