1 /* 2 * From FreeBSD 2.2.7: Fundamental constants relating to ethernet. 3 * 4 * Copyright (C) 2020, Broadcom. 5 * 6 * Unless you and Broadcom execute a separate written software license 7 * agreement governing use of this software, this software is licensed to you 8 * under the terms of the GNU General Public License version 2 (the "GPL"), 9 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 10 * following added to such license: 11 * 12 * As a special exception, the copyright holders of this software give you 13 * permission to link this software with independent modules, and to copy and 14 * distribute the resulting executable under terms of your choice, provided that 15 * you also meet, for each linked independent module, the terms and conditions of 16 * the license of that module. An independent module is a module which is not 17 * derived from this software. The special exception does not apply to any 18 * modifications of the software. 19 * 20 * 21 * <<Broadcom-WL-IPTag/Dual:>> 22 */ 23 24 #ifndef _NET_ETHERNET_H_ /* use native BSD ethernet.h when available */ 25 #define _NET_ETHERNET_H_ 26 27 #ifndef _TYPEDEFS_H_ 28 #include "typedefs.h" 29 #endif 30 31 /* This marks the start of a packed structure section. */ 32 #include <packed_section_start.h> 33 34 /* 35 * The number of bytes in an ethernet (MAC) address. 36 */ 37 #define ETHER_ADDR_LEN 6 38 39 /* 40 * The number of bytes in the type field. 41 */ 42 #define ETHER_TYPE_LEN 2 43 44 /* 45 * The number of bytes in the trailing CRC field. 46 */ 47 #define ETHER_CRC_LEN 4 48 49 /* 50 * The length of the combined header. 51 */ 52 #define ETHER_HDR_LEN (ETHER_ADDR_LEN * 2 + ETHER_TYPE_LEN) 53 54 /* 55 * The minimum packet length. 56 */ 57 #define ETHER_MIN_LEN 64 58 59 /* 60 * The minimum packet user data length. 61 */ 62 #define ETHER_MIN_DATA 46 63 64 /* 65 * The maximum packet length. 66 */ 67 #define ETHER_MAX_LEN 1518 68 69 /* 70 * The maximum packet user data length. 71 */ 72 #define ETHER_MAX_DATA 1500 73 74 /* ether types */ 75 #define ETHER_TYPE_MIN 0x0600 /* Anything less than MIN is a length */ 76 #define ETHER_TYPE_IP 0x0800 /* IP */ 77 #define ETHER_TYPE_ARP 0x0806 /* ARP */ 78 #define ETHER_TYPE_8021Q 0x8100 /* 802.1Q */ 79 #define ETHER_TYPE_IPV6 0x86dd /* IPv6 */ 80 #define ETHER_TYPE_BRCM 0x886c /* Broadcom Corp. */ 81 #define ETHER_TYPE_802_1X 0x888e /* 802.1x */ 82 #define ETHER_TYPE_802_1X_PREAUTH 0x88c7 /* 802.1x preauthentication */ 83 #define ETHER_TYPE_WAI 0x88b4 /* WAI */ 84 #define ETHER_TYPE_89_0D 0x890d /* 89-0d frame for TDLS */ 85 #define ETHER_TYPE_RRB ETHER_TYPE_89_0D /* RRB 802.11r 2008 */ 86 #define ETHER_TYPE_1905_1 0x893a /* IEEE 1905.1 MCDU */ 87 88 #define ETHER_TYPE_PPP_SES 0x8864 /* PPPoE Session */ 89 90 #define ETHER_TYPE_IAPP_L2_UPDATE 0x6 /* IAPP L2 update frame */ 91 92 /* Broadcom subtype follows ethertype; First 2 bytes are reserved; Next 2 are subtype; */ 93 #define ETHER_BRCM_SUBTYPE_LEN 4 /* Broadcom 4 byte subtype */ 94 95 /* ether header */ 96 #define ETHER_DEST_OFFSET (0 * ETHER_ADDR_LEN) /* dest address offset */ 97 #define ETHER_SRC_OFFSET (1 * ETHER_ADDR_LEN) /* src address offset */ 98 #define ETHER_TYPE_OFFSET (2 * ETHER_ADDR_LEN) /* ether type offset */ 99 100 /* 101 * A macro to validate a length with 102 */ 103 #define ETHER_IS_VALID_LEN(foo) \ 104 ((foo) >= ETHER_MIN_LEN && (foo) <= ETHER_MAX_LEN) 105 106 #define ETHER_FILL_MCAST_ADDR_FROM_IP(ea, mgrp_ip) { \ 107 ((uint8 *)ea)[0] = 0x01; \ 108 ((uint8 *)ea)[1] = 0x00; \ 109 ((uint8 *)ea)[2] = 0x5e; \ 110 ((uint8 *)ea)[3] = ((mgrp_ip) >> 16) & 0x7f; \ 111 ((uint8 *)ea)[4] = ((mgrp_ip) >> 8) & 0xff; \ 112 ((uint8 *)ea)[5] = ((mgrp_ip) >> 0) & 0xff; \ 113 } 114 115 #ifndef __INCif_etherh /* Quick and ugly hack for VxWorks */ 116 /* 117 * Structure of a 10Mb/s Ethernet header. 118 */ 119 BWL_PRE_PACKED_STRUCT struct ether_header { 120 uint8 ether_dhost[ETHER_ADDR_LEN]; 121 uint8 ether_shost[ETHER_ADDR_LEN]; 122 uint16 ether_type; 123 } BWL_POST_PACKED_STRUCT; 124 125 /* 126 * Structure of a 48-bit Ethernet address. 127 */ 128 BWL_PRE_PACKED_STRUCT struct ether_addr { 129 uint8 octet[ETHER_ADDR_LEN]; 130 } BWL_POST_PACKED_STRUCT; 131 #endif /* __INCif_etherh */ 132 #ifdef __INCif_etherh 133 #endif /* !__INCif_etherh Quick and ugly hack for VxWorks */ 134 135 /* 136 * Takes a pointer, set, test, clear, toggle locally admininistered 137 * address bit in the 48-bit Ethernet address. 138 */ 139 #define ETHER_SET_LOCALADDR(ea) (((uint8 *)(ea))[0] = (((uint8 *)(ea))[0] | 2)) 140 #define ETHER_IS_LOCALADDR(ea) (((uint8 *)(ea))[0] & 2) 141 #define ETHER_CLR_LOCALADDR(ea) (((uint8 *)(ea))[0] = (((uint8 *)(ea))[0] & 0xfd)) 142 #define ETHER_TOGGLE_LOCALADDR(ea) (((uint8 *)(ea))[0] = (((uint8 *)(ea))[0] ^ 2)) 143 144 /* Takes a pointer, marks unicast address bit in the MAC address */ 145 #define ETHER_SET_UNICAST(ea) (((uint8 *)(ea))[0] = (((uint8 *)(ea))[0] & ~1)) 146 147 /* 148 * Takes a pointer, returns true if a 48-bit multicast address 149 * (including broadcast, since it is all ones) 150 */ 151 #define ETHER_ISMULTI(ea) (((const uint8 *)(ea))[0] & 1) 152 153 /* compare two ethernet addresses - assumes the pointers can be referenced as shorts */ 154 #if defined(DONGLEBUILD) && defined(__ARM_ARCH_7A__) && !defined(BCMFUZZ) 155 #define eacmp(a, b) (((*(const uint32 *)(a)) ^ (*(const uint32 *)(b))) || \ 156 ((*(const uint16 *)(((const uint8 *)(a)) + 4)) ^ \ 157 (*(const uint16 *)(((const uint8 *)(b)) + 4)))) 158 159 #define ehcmp(a, b) ((((const uint32 *)(a))[0] ^ ((const uint32 *)(b))[0]) || \ 160 (((const uint32 *)(a))[1] ^ ((const uint32 *)(b))[1]) || \ 161 (((const uint32 *)(a))[2] ^ ((const uint32 *)(b))[2]) || \ 162 ((*(const uint16 *)(((const uint32 *)(a)) + 3)) ^ \ 163 (*(const uint16 *)(((const uint32 *)(b)) + 3)))) 164 #else 165 #define eacmp(a, b) ((((const uint16 *)(a))[0] ^ ((const uint16 *)(b))[0]) | \ 166 (((const uint16 *)(a))[1] ^ ((const uint16 *)(b))[1]) | \ 167 (((const uint16 *)(a))[2] ^ ((const uint16 *)(b))[2])) 168 169 #define ehcmp(a, b) ((((const uint16 *)(a))[0] ^ ((const uint16 *)(b))[0]) | \ 170 (((const uint16 *)(a))[1] ^ ((const uint16 *)(b))[1]) | \ 171 (((const uint16 *)(a))[2] ^ ((const uint16 *)(b))[2]) | \ 172 (((const uint16 *)(a))[3] ^ ((const uint16 *)(b))[3]) | \ 173 (((const uint16 *)(a))[4] ^ ((const uint16 *)(b))[4]) | \ 174 (((const uint16 *)(a))[5] ^ ((const uint16 *)(b))[5]) | \ 175 (((const uint16 *)(a))[6] ^ ((const uint16 *)(b))[6])) 176 #endif /* DONGLEBUILD && __ARM_ARCH_7A__ */ 177 178 #define ether_cmp(a, b) eacmp(a, b) 179 180 /* copy an ethernet address - assumes the pointers can be referenced as shorts */ 181 #if defined(DONGLEBUILD) && defined(__ARM_ARCH_7A__) && !defined(BCMFUZZ) 182 #define eacopy(s, d) \ 183 do { \ 184 (*(uint32 *)(d)) = (*(const uint32 *)(s)); \ 185 (*(uint16 *)(((uint8 *)(d)) + 4)) = (*(const uint16 *)(((const uint8 *)(s)) + 4)); \ 186 } while (0) 187 #else 188 #define eacopy(s, d) \ 189 do { \ 190 ((uint16 *)(d))[0] = ((const uint16 *)(s))[0]; \ 191 ((uint16 *)(d))[1] = ((const uint16 *)(s))[1]; \ 192 ((uint16 *)(d))[2] = ((const uint16 *)(s))[2]; \ 193 } while (0) 194 #endif /* DONGLEBUILD && __ARM_ARCH_7A__ */ 195 196 #define ether_copy(s, d) eacopy(s, d) 197 198 /* Copy an ethernet address in reverse order */ 199 #define ether_rcopy(s, d) \ 200 do { \ 201 ((uint16 *)(d))[2] = ((uint16 *)(s))[2]; \ 202 ((uint16 *)(d))[1] = ((uint16 *)(s))[1]; \ 203 ((uint16 *)(d))[0] = ((uint16 *)(s))[0]; \ 204 } while (0) 205 206 /* Copy 14B ethernet header: 32bit aligned source and destination. */ 207 #define ehcopy32(s, d) \ 208 do { \ 209 ((uint32 *)(d))[0] = ((const uint32 *)(s))[0]; \ 210 ((uint32 *)(d))[1] = ((const uint32 *)(s))[1]; \ 211 ((uint32 *)(d))[2] = ((const uint32 *)(s))[2]; \ 212 ((uint16 *)(d))[6] = ((const uint16 *)(s))[6]; \ 213 } while (0) 214 215 /* Dongles use bcmutils functions instead of macros. 216 * Possibly slower but saves over 800 bytes off THUMB dongle image. 217 */ 218 219 extern const struct ether_addr ether_bcast; 220 extern const struct ether_addr ether_null; 221 extern const struct ether_addr ether_ipv6_mcast; 222 223 extern int ether_isbcast(const void *ea); 224 extern int ether_isnulladdr(const void *ea); 225 226 #define ETHER_ISBCAST(ea) ether_isbcast(ea) 227 228 #if defined(__ARM_ARCH_7A__) && !defined(BCMFUZZ) 229 #define ETHER_ISNULLADDR(ea) (((*(const uint32 *)(ea)) | \ 230 (*(const uint16 *)(((const uint8 *)(ea)) + 4))) == 0) 231 #else 232 #define ETHER_ISNULLADDR(ea) ether_isnulladdr(ea) 233 #endif /* __ARM_ARCH_7A__ */ 234 235 #define ETHER_ISNULLDEST(da) ((((const uint16 *)(da))[0] | \ 236 ((const uint16 *)(da))[1] | \ 237 ((const uint16 *)(da))[2]) == 0) 238 #define ETHER_ISNULLSRC(sa) ETHER_ISNULLDEST(sa) 239 240 #define ETHER_MOVE_HDR(d, s) \ 241 do { \ 242 struct ether_header t; \ 243 t = *(struct ether_header *)(s); \ 244 *(struct ether_header *)(d) = t; \ 245 } while (0) 246 247 #define ETHER_ISUCAST(ea) ((((uint8 *)(ea))[0] & 0x01) == 0) 248 249 /* This marks the end of a packed structure section. */ 250 #include <packed_section_end.h> 251 252 #endif /* _NET_ETHERNET_H_ */ 253