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