1 /* $OpenBSD: if_ether.h,v 1.73 2016/11/29 10:09:57 reyk 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 112 #define ETHERMTU (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 113 #define ETHERMIN (ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 114 115 /* 116 * Ethernet CRC32 polynomials (big- and little-endian verions). 117 */ 118 #define ETHER_CRC_POLY_LE 0xedb88320 119 #define ETHER_CRC_POLY_BE 0x04c11db6 120 121 /* 122 * Ethernet Address Resolution Protocol. 123 * 124 * See RFC 826 for protocol description. Structure below is adapted 125 * to resolving internet addresses. Field names used correspond to 126 * RFC 826. 127 */ 128 struct ether_arp { 129 struct arphdr ea_hdr; /* fixed-size header */ 130 u_int8_t arp_sha[ETHER_ADDR_LEN]; /* sender hardware address */ 131 u_int8_t arp_spa[4]; /* sender protocol address */ 132 u_int8_t arp_tha[ETHER_ADDR_LEN]; /* target hardware address */ 133 u_int8_t arp_tpa[4]; /* target protocol address */ 134 }; 135 #define arp_hrd ea_hdr.ar_hrd 136 #define arp_pro ea_hdr.ar_pro 137 #define arp_hln ea_hdr.ar_hln 138 #define arp_pln ea_hdr.ar_pln 139 #define arp_op ea_hdr.ar_op 140 141 struct sockaddr_inarp { 142 u_int8_t sin_len; 143 u_int8_t sin_family; 144 u_int16_t sin_port; 145 struct in_addr sin_addr; 146 struct in_addr sin_srcaddr; 147 u_int16_t sin_tos; 148 u_int16_t sin_other; 149 #define SIN_PROXY 1 150 }; 151 152 /* 153 * IP and ethernet specific routing flags 154 */ 155 #define RTF_USETRAILERS RTF_PROTO1 /* use trailers */ 156 #define RTF_PERMANENT_ARP RTF_PROTO3 /* only manual overwrite of entry */ 157 158 #ifdef _KERNEL 159 /* 160 * Macro to map an IP multicast address to an Ethernet multicast address. 161 * The high-order 25 bits of the Ethernet address are statically assigned, 162 * and the low-order 23 bits are taken from the low end of the IP address. 163 */ 164 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \ 165 /* struct in_addr *ipaddr; */ \ 166 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 167 do { \ 168 (enaddr)[0] = 0x01; \ 169 (enaddr)[1] = 0x00; \ 170 (enaddr)[2] = 0x5e; \ 171 (enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f; \ 172 (enaddr)[4] = ((u_int8_t *)ipaddr)[2]; \ 173 (enaddr)[5] = ((u_int8_t *)ipaddr)[3]; \ 174 } while (/* CONSTCOND */ 0) 175 176 /* 177 * Macro to map an IPv6 multicast address to an Ethernet multicast address. 178 * The high-order 16 bits of the Ethernet address are statically assigned, 179 * and the low-order 32 bits are taken from the low end of the IPv6 address. 180 */ 181 #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr) \ 182 /* struct in6_addr *ip6addr; */ \ 183 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 184 do { \ 185 (enaddr)[0] = 0x33; \ 186 (enaddr)[1] = 0x33; \ 187 (enaddr)[2] = ((u_int8_t *)ip6addr)[12]; \ 188 (enaddr)[3] = ((u_int8_t *)ip6addr)[13]; \ 189 (enaddr)[4] = ((u_int8_t *)ip6addr)[14]; \ 190 (enaddr)[5] = ((u_int8_t *)ip6addr)[15]; \ 191 } while (/* CONSTCOND */ 0) 192 193 #include <net/if_var.h> /* for "struct ifnet" */ 194 195 /* 196 * Structure shared between the ethernet driver modules and 197 * the address resolution code. For example, each ec_softc or il_softc 198 * begins with this structure. 199 */ 200 struct arpcom { 201 struct ifnet ac_if; /* network-visible interface */ 202 u_int8_t ac_enaddr[ETHER_ADDR_LEN]; /* ethernet hardware address */ 203 char ac__pad[2]; /* pad for some machines */ 204 LIST_HEAD(, ether_multi) ac_multiaddrs; /* list of multicast addrs */ 205 int ac_multicnt; /* length of ac_multiaddrs */ 206 int ac_multirangecnt; /* number of mcast ranges */ 207 208 }; 209 210 extern int arpt_keep; /* arp resolved cache expire */ 211 extern int arpt_down; /* arp down cache expire */ 212 213 extern u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN]; 214 extern u_int8_t etheranyaddr[ETHER_ADDR_LEN]; 215 extern u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN]; 216 extern u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN]; 217 218 #ifdef NFSCLIENT 219 extern unsigned int revarp_ifidx; 220 #endif /* NFSCLIENT */ 221 222 void revarpinput(struct ifnet *, struct mbuf *); 223 void revarprequest(struct ifnet *); 224 int revarpwhoarewe(struct ifnet *, struct in_addr *, struct in_addr *); 225 int revarpwhoami(struct in_addr *, struct ifnet *); 226 227 void arpinput(struct ifnet *, struct mbuf *); 228 void arprequest(struct ifnet *, u_int32_t *, u_int32_t *, u_int8_t *); 229 void arpwhohas(struct arpcom *, struct in_addr *); 230 int arpproxy(struct in_addr, unsigned int); 231 int arpresolve(struct ifnet *, struct rtentry *, struct mbuf *, 232 struct sockaddr *, u_char *); 233 void arp_rtrequest(struct ifnet *, int, struct rtentry *); 234 235 void ether_fakeaddr(struct ifnet *); 236 int ether_addmulti(struct ifreq *, struct arpcom *); 237 int ether_delmulti(struct ifreq *, struct arpcom *); 238 int ether_multiaddr(struct sockaddr *, u_int8_t[], u_int8_t[]); 239 void ether_ifattach(struct ifnet *); 240 void ether_ifdetach(struct ifnet *); 241 int ether_ioctl(struct ifnet *, struct arpcom *, u_long, caddr_t); 242 int ether_input(struct ifnet *, struct mbuf *, void *); 243 int ether_output(struct ifnet *, 244 struct mbuf *, struct sockaddr *, struct rtentry *); 245 void ether_rtrequest(struct ifnet *, int, struct rtentry *); 246 char *ether_sprintf(u_char *); 247 248 249 /* 250 * Ethernet multicast address structure. There is one of these for each 251 * multicast address or range of multicast addresses that we are supposed 252 * to listen to on a particular interface. They are kept in a linked list, 253 * rooted in the interface's arpcom structure. (This really has nothing to 254 * do with ARP, or with the Internet address family, but this appears to be 255 * the minimally-disrupting place to put it.) 256 */ 257 struct ether_multi { 258 u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low or only address of range */ 259 u_int8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */ 260 u_int enm_refcount; /* no. claims to this addr/range */ 261 LIST_ENTRY(ether_multi) enm_list; 262 }; 263 264 /* 265 * Structure used by macros below to remember position when stepping through 266 * all of the ether_multi records. 267 */ 268 struct ether_multistep { 269 struct ether_multi *e_enm; 270 }; 271 272 /* 273 * Macro for looking up the ether_multi record for a given range of Ethernet 274 * multicast addresses connected to a given arpcom structure. If no matching 275 * record is found, "enm" returns NULL. 276 */ 277 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \ 278 /* u_int8_t addrlo[ETHER_ADDR_LEN]; */ \ 279 /* u_int8_t addrhi[ETHER_ADDR_LEN]; */ \ 280 /* struct arpcom *ac; */ \ 281 /* struct ether_multi *enm; */ \ 282 do { \ 283 for ((enm) = LIST_FIRST(&(ac)->ac_multiaddrs); \ 284 (enm) != NULL && \ 285 (memcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 ||\ 286 memcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0); \ 287 (enm) = LIST_NEXT((enm), enm_list)); \ 288 } while (/* CONSTCOND */ 0) 289 290 /* 291 * Macro to step through all of the ether_multi records, one at a time. 292 * The current position is remembered in "step", which the caller must 293 * provide. ETHER_FIRST_MULTI(), below, must be called to initialize "step" 294 * and get the first record. Both macros return a NULL "enm" when there 295 * are no remaining records. 296 */ 297 #define ETHER_NEXT_MULTI(step, enm) \ 298 /* struct ether_multistep step; */ \ 299 /* struct ether_multi *enm; */ \ 300 do { \ 301 if (((enm) = (step).e_enm) != NULL) \ 302 (step).e_enm = LIST_NEXT((enm), enm_list); \ 303 } while (/* CONSTCOND */ 0) 304 305 #define ETHER_FIRST_MULTI(step, ac, enm) \ 306 /* struct ether_multistep step; */ \ 307 /* struct arpcom *ac; */ \ 308 /* struct ether_multi *enm; */ \ 309 do { \ 310 (step).e_enm = LIST_FIRST(&(ac)->ac_multiaddrs); \ 311 ETHER_NEXT_MULTI((step), (enm)); \ 312 } while (/* CONSTCOND */ 0) 313 314 u_int32_t ether_crc32_le_update(u_int32_t crc, const u_int8_t *, size_t); 315 u_int32_t ether_crc32_be_update(u_int32_t crc, const u_int8_t *, size_t); 316 u_int32_t ether_crc32_le(const u_int8_t *, size_t); 317 u_int32_t ether_crc32_be(const u_int8_t *, size_t); 318 319 #else /* _KERNEL */ 320 321 __BEGIN_DECLS 322 char *ether_ntoa(struct ether_addr *); 323 struct ether_addr *ether_aton(const char *); 324 int ether_ntohost(char *, struct ether_addr *); 325 int ether_hostton(const char *, struct ether_addr *); 326 int ether_line(const char *, struct ether_addr *, char *); 327 __END_DECLS 328 329 #endif /* _KERNEL */ 330 #endif /* _NETINET_IF_ETHER_H_ */ 331