1 /* $OpenBSD: if_ether.h,v 1.76 2019/07/17 16:46:18 mpi Exp $ */ 2 /* $NetBSD: if_ether.h,v 1.22 1996/05/11 13:00:00 mycroft Exp $ */ 3 4 /* 5 * Copyright (c) 1982, 1986, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)if_ether.h 8.1 (Berkeley) 6/10/93 33 */ 34 35 #ifndef _NETINET_IF_ETHER_H_ 36 #define _NETINET_IF_ETHER_H_ 37 38 /* 39 * Some basic Ethernet constants. 40 */ 41 #define ETHER_ADDR_LEN 6 /* Ethernet address length */ 42 #define ETHER_TYPE_LEN 2 /* Ethernet type field length */ 43 #define ETHER_CRC_LEN 4 /* Ethernet CRC length */ 44 #define ETHER_HDR_LEN ((ETHER_ADDR_LEN * 2) + ETHER_TYPE_LEN) 45 #define ETHER_MIN_LEN 64 /* Minimum frame length, CRC included */ 46 #define ETHER_MAX_LEN 1518 /* Maximum frame length, CRC included */ 47 #define ETHER_MAX_DIX_LEN 1536 /* Maximum DIX frame length */ 48 49 /* 50 * Some Ethernet extensions. 51 */ 52 #define ETHER_VLAN_ENCAP_LEN 4 /* len of 802.1Q VLAN encapsulation */ 53 54 /* 55 * Mbuf adjust factor to force 32-bit alignment of IP header. 56 * Drivers should do m_adj(m, ETHER_ALIGN) when setting up a 57 * receive so the upper layers get the IP header properly aligned 58 * past the 14-byte Ethernet header. 59 */ 60 #define ETHER_ALIGN 2 /* driver adjust for IP hdr alignment */ 61 62 /* 63 * The maximum supported Ethernet length and some space for encapsulation. 64 */ 65 #define ETHER_MAX_HARDMTU_LEN 65435 66 67 /* 68 * Ethernet address - 6 octets 69 */ 70 struct ether_addr { 71 u_int8_t ether_addr_octet[ETHER_ADDR_LEN]; 72 }; 73 74 /* 75 * The length of the combined header. 76 */ 77 struct ether_header { 78 u_int8_t ether_dhost[ETHER_ADDR_LEN]; 79 u_int8_t ether_shost[ETHER_ADDR_LEN]; 80 u_int16_t ether_type; 81 }; 82 83 /* 84 * VLAN headers. 85 */ 86 87 struct ether_vlan_header { 88 u_char evl_dhost[ETHER_ADDR_LEN]; 89 u_char evl_shost[ETHER_ADDR_LEN]; 90 u_int16_t evl_encap_proto; 91 u_int16_t evl_tag; 92 u_int16_t evl_proto; 93 }; 94 95 #define EVL_VLID_MASK 0xFFF 96 #define EVL_VLID_NULL 0x000 97 /* 0x000 and 0xfff are reserved */ 98 #define EVL_VLID_MIN 0x001 99 #define EVL_VLID_MAX 0xFFE 100 #define EVL_VLANOFTAG(tag) ((tag) & EVL_VLID_MASK) 101 102 #define EVL_PRIO_MAX 7 103 #define EVL_PRIO_BITS 13 104 #define EVL_PRIOFTAG(tag) (((tag) >> EVL_PRIO_BITS) & 7) 105 106 #define EVL_ENCAPLEN 4 /* length in octets of encapsulation */ 107 108 #include <net/ethertypes.h> 109 110 #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */ 111 #define ETHER_IS_BROADCAST(addr) \ 112 (((addr)[0] & (addr)[1] & (addr)[2] & \ 113 (addr)[3] & (addr)[4] & (addr)[5]) == 0xff) 114 #define ETHER_IS_ANYADDR(addr) \ 115 (((addr)[0] | (addr)[1] | (addr)[2] | \ 116 (addr)[3] | (addr)[4] | (addr)[5]) == 0x00) 117 #define ETHER_IS_EQ(a1, a2) (memcmp((a1), (a2), ETHER_ADDR_LEN) == 0) 118 119 #define ETHERMTU (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 120 #define ETHERMIN (ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 121 122 /* 123 * Ethernet CRC32 polynomials (big- and little-endian verions). 124 */ 125 #define ETHER_CRC_POLY_LE 0xedb88320 126 #define ETHER_CRC_POLY_BE 0x04c11db6 127 128 /* 129 * Ethernet Address Resolution Protocol. 130 * 131 * See RFC 826 for protocol description. Structure below is adapted 132 * to resolving internet addresses. Field names used correspond to 133 * RFC 826. 134 */ 135 struct ether_arp { 136 struct arphdr ea_hdr; /* fixed-size header */ 137 u_int8_t arp_sha[ETHER_ADDR_LEN]; /* sender hardware address */ 138 u_int8_t arp_spa[4]; /* sender protocol address */ 139 u_int8_t arp_tha[ETHER_ADDR_LEN]; /* target hardware address */ 140 u_int8_t arp_tpa[4]; /* target protocol address */ 141 }; 142 #define arp_hrd ea_hdr.ar_hrd 143 #define arp_pro ea_hdr.ar_pro 144 #define arp_hln ea_hdr.ar_hln 145 #define arp_pln ea_hdr.ar_pln 146 #define arp_op ea_hdr.ar_op 147 148 struct sockaddr_inarp { 149 u_int8_t sin_len; 150 u_int8_t sin_family; 151 u_int16_t sin_port; 152 struct in_addr sin_addr; 153 struct in_addr sin_srcaddr; 154 u_int16_t sin_tos; 155 u_int16_t sin_other; 156 #define SIN_PROXY 1 157 }; 158 159 /* 160 * IP and ethernet specific routing flags 161 */ 162 #define RTF_USETRAILERS RTF_PROTO1 /* use trailers */ 163 #define RTF_PERMANENT_ARP RTF_PROTO3 /* only manual overwrite of entry */ 164 165 #ifdef _KERNEL 166 /* 167 * Macro to map an IP multicast address to an Ethernet multicast address. 168 * The high-order 25 bits of the Ethernet address are statically assigned, 169 * and the low-order 23 bits are taken from the low end of the IP address. 170 */ 171 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \ 172 /* struct in_addr *ipaddr; */ \ 173 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 174 do { \ 175 (enaddr)[0] = 0x01; \ 176 (enaddr)[1] = 0x00; \ 177 (enaddr)[2] = 0x5e; \ 178 (enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f; \ 179 (enaddr)[4] = ((u_int8_t *)ipaddr)[2]; \ 180 (enaddr)[5] = ((u_int8_t *)ipaddr)[3]; \ 181 } while (/* CONSTCOND */ 0) 182 183 /* 184 * Macro to map an IPv6 multicast address to an Ethernet multicast address. 185 * The high-order 16 bits of the Ethernet address are statically assigned, 186 * and the low-order 32 bits are taken from the low end of the IPv6 address. 187 */ 188 #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr) \ 189 /* struct in6_addr *ip6addr; */ \ 190 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 191 do { \ 192 (enaddr)[0] = 0x33; \ 193 (enaddr)[1] = 0x33; \ 194 (enaddr)[2] = ((u_int8_t *)ip6addr)[12]; \ 195 (enaddr)[3] = ((u_int8_t *)ip6addr)[13]; \ 196 (enaddr)[4] = ((u_int8_t *)ip6addr)[14]; \ 197 (enaddr)[5] = ((u_int8_t *)ip6addr)[15]; \ 198 } while (/* CONSTCOND */ 0) 199 200 #include <net/if_var.h> /* for "struct ifnet" */ 201 202 /* 203 * Structure shared between the ethernet driver modules and 204 * the address resolution code. For example, each ec_softc or il_softc 205 * begins with this structure. 206 */ 207 struct arpcom { 208 struct ifnet ac_if; /* network-visible interface */ 209 u_int8_t ac_enaddr[ETHER_ADDR_LEN]; /* ethernet hardware address */ 210 char ac__pad[2]; /* pad for some machines */ 211 LIST_HEAD(, ether_multi) ac_multiaddrs; /* list of multicast addrs */ 212 int ac_multicnt; /* length of ac_multiaddrs */ 213 int ac_multirangecnt; /* number of mcast ranges */ 214 215 void *ac_trunkport; 216 }; 217 218 extern int arpt_keep; /* arp resolved cache expire */ 219 extern int arpt_down; /* arp down cache expire */ 220 221 extern u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN]; 222 extern u_int8_t etheranyaddr[ETHER_ADDR_LEN]; 223 extern u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN]; 224 extern u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN]; 225 226 #ifdef NFSCLIENT 227 extern unsigned int revarp_ifidx; 228 #endif /* NFSCLIENT */ 229 230 void revarpinput(struct ifnet *, struct mbuf *); 231 void revarprequest(struct ifnet *); 232 int revarpwhoarewe(struct ifnet *, struct in_addr *, struct in_addr *); 233 int revarpwhoami(struct in_addr *, struct ifnet *); 234 235 void arpinput(struct ifnet *, struct mbuf *); 236 void arprequest(struct ifnet *, u_int32_t *, u_int32_t *, u_int8_t *); 237 void arpwhohas(struct arpcom *, struct in_addr *); 238 int arpproxy(struct in_addr, unsigned int); 239 int arpresolve(struct ifnet *, struct rtentry *, struct mbuf *, 240 struct sockaddr *, u_char *); 241 void arp_rtrequest(struct ifnet *, int, struct rtentry *); 242 243 void ether_fakeaddr(struct ifnet *); 244 int ether_addmulti(struct ifreq *, struct arpcom *); 245 int ether_delmulti(struct ifreq *, struct arpcom *); 246 int ether_multiaddr(struct sockaddr *, u_int8_t[], u_int8_t[]); 247 void ether_ifattach(struct ifnet *); 248 void ether_ifdetach(struct ifnet *); 249 int ether_ioctl(struct ifnet *, struct arpcom *, u_long, caddr_t); 250 int ether_input(struct ifnet *, struct mbuf *, void *); 251 int ether_resolve(struct ifnet *, struct mbuf *, struct sockaddr *, 252 struct rtentry *, struct ether_header *); 253 struct mbuf * 254 ether_encap(struct ifnet *, struct mbuf *, struct sockaddr *, 255 struct rtentry *, int *); 256 int ether_output(struct ifnet *, struct mbuf *, struct sockaddr *, 257 struct rtentry *); 258 void ether_rtrequest(struct ifnet *, int, struct rtentry *); 259 char *ether_sprintf(u_char *); 260 261 262 /* 263 * Ethernet multicast address structure. There is one of these for each 264 * multicast address or range of multicast addresses that we are supposed 265 * to listen to on a particular interface. They are kept in a linked list, 266 * rooted in the interface's arpcom structure. (This really has nothing to 267 * do with ARP, or with the Internet address family, but this appears to be 268 * the minimally-disrupting place to put it.) 269 */ 270 struct ether_multi { 271 u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low or only address of range */ 272 u_int8_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 * Macro for looking up the ether_multi record for a given range of Ethernet 287 * multicast addresses connected to a given arpcom structure. If no matching 288 * record is found, "enm" returns NULL. 289 */ 290 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \ 291 /* u_int8_t addrlo[ETHER_ADDR_LEN]; */ \ 292 /* u_int8_t addrhi[ETHER_ADDR_LEN]; */ \ 293 /* struct arpcom *ac; */ \ 294 /* struct ether_multi *enm; */ \ 295 do { \ 296 for ((enm) = LIST_FIRST(&(ac)->ac_multiaddrs); \ 297 (enm) != NULL && \ 298 (memcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 ||\ 299 memcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0); \ 300 (enm) = LIST_NEXT((enm), enm_list)); \ 301 } while (/* CONSTCOND */ 0) 302 303 /* 304 * Macro to 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 macros return a NULL "enm" when there 308 * are no remaining records. 309 */ 310 #define ETHER_NEXT_MULTI(step, enm) \ 311 /* struct ether_multistep step; */ \ 312 /* struct ether_multi *enm; */ \ 313 do { \ 314 if (((enm) = (step).e_enm) != NULL) \ 315 (step).e_enm = LIST_NEXT((enm), enm_list); \ 316 } while (/* CONSTCOND */ 0) 317 318 #define ETHER_FIRST_MULTI(step, ac, enm) \ 319 /* struct ether_multistep step; */ \ 320 /* struct arpcom *ac; */ \ 321 /* struct ether_multi *enm; */ \ 322 do { \ 323 (step).e_enm = LIST_FIRST(&(ac)->ac_multiaddrs); \ 324 ETHER_NEXT_MULTI((step), (enm)); \ 325 } while (/* CONSTCOND */ 0) 326 327 u_int32_t ether_crc32_le_update(u_int32_t crc, const u_int8_t *, size_t); 328 u_int32_t ether_crc32_be_update(u_int32_t crc, const u_int8_t *, size_t); 329 u_int32_t ether_crc32_le(const u_int8_t *, size_t); 330 u_int32_t ether_crc32_be(const u_int8_t *, size_t); 331 332 #else /* _KERNEL */ 333 334 __BEGIN_DECLS 335 char *ether_ntoa(struct ether_addr *); 336 struct ether_addr *ether_aton(const char *); 337 int ether_ntohost(char *, struct ether_addr *); 338 int ether_hostton(const char *, struct ether_addr *); 339 int ether_line(const char *, struct ether_addr *, char *); 340 __END_DECLS 341 342 #endif /* _KERNEL */ 343 #endif /* _NETINET_IF_ETHER_H_ */ 344