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