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