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