package/broadcom-57xx/src/proto/ethernet.h

   1 /*
   2  * From FreeBSD 2.2.7: Fundamental constants relating to ethernet.
   3  *
   4  * Copyright 2007, Broadcom Corporation
   5  * All Rights Reserved.
   6  *
   7  * THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
   8  * KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
   9  * SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
  10  * FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
  11  *
  12  */
  13
  14 #ifndef _NET_ETHERNET_H_            /* use native BSD ethernet.h when available */
  15 #define _NET_ETHERNET_H_
  16
  17 #ifndef _TYPEDEFS_H_
  18 #include "typedefs.h"
  19 #endif
  20
  21 /* enable structure packing */
  22 #if defined(__GNUC__)
  23 #define PACKED  __attribute__((packed))
  24 #else
  25 #pragma pack(1)
  26 #define PACKED
  27 #endif
  28
  29 /*
  30  * The number of bytes in an ethernet (MAC) address.
  31  */
  32 #define ETHER_ADDR_LEN          6
  33
  34 /*
  35  * The number of bytes in the type field.
  36  */
  37 #define ETHER_TYPE_LEN          2
  38
  39 /*
  40  * The number of bytes in the trailing CRC field.
  41  */
  42 #define ETHER_CRC_LEN           4
  43
  44 /*
  45  * The length of the combined header.
  46  */
  47 #define ETHER_HDR_LEN           (ETHER_ADDR_LEN * 2 + ETHER_TYPE_LEN)
  48
  49 /*
  50  * The minimum packet length.
  51  */
  52 #define ETHER_MIN_LEN           64
  53
  54 /*
  55  * The minimum packet user data length.
  56  */
  57 #define ETHER_MIN_DATA          46
  58
  59 /*
  60  * The maximum packet length.
  61  */
  62 #define ETHER_MAX_LEN           1518
  63
  64 /*
  65  * The maximum packet user data length.
  66  */
  67 #define ETHER_MAX_DATA          1500
  68
  69 /* ether types */
  70 #define ETHER_TYPE_MIN          0x0600          /* Anything less than MIN is a length */
  71 #define ETHER_TYPE_IP           0x0800          /* IP */
  72 #define ETHER_TYPE_ARP          0x0806          /* ARP */
  73 #define ETHER_TYPE_8021Q        0x8100          /* 802.1Q */
  74 #define ETHER_TYPE_BRCM         0x886c          /* Broadcom Corp. */
  75 #define ETHER_TYPE_802_1X       0x888e          /* 802.1x */
  76 #ifdef BCMWPA2
  77 #define ETHER_TYPE_802_1X_PREAUTH 0x88c7        /* 802.1x preauthentication */
  78 #endif
  79
  80 /* Broadcom subtype follows ethertype;  First 2 bytes are reserved; Next 2 are subtype; */
  81 #define ETHER_BRCM_SUBTYPE_LEN  4               /* Broadcom 4 byte subtype */
  82 #define ETHER_BRCM_CRAM         0x1             /* Broadcom subtype cram protocol */
  83
  84 /* ether header */
  85 #define ETHER_DEST_OFFSET       (0 * ETHER_ADDR_LEN)    /* dest address offset */
  86 #define ETHER_SRC_OFFSET        (1 * ETHER_ADDR_LEN)    /* src address offset */
  87 #define ETHER_TYPE_OFFSET       (2 * ETHER_ADDR_LEN)    /* ether type offset */
  88
  89 /*
  90  * A macro to validate a length with
  91  */
  92 #define ETHER_IS_VALID_LEN(foo) \
  93         ((foo) >= ETHER_MIN_LEN && (foo) <= ETHER_MAX_LEN)
  94
  95
  96 #ifndef __INCif_etherh     /* Quick and ugly hack for VxWorks */
  97 /*
  98  * Structure of a 10Mb/s Ethernet header.
  99  */
 100 struct  ether_header {
 101         uint8   ether_dhost[ETHER_ADDR_LEN];
 102         uint8   ether_shost[ETHER_ADDR_LEN];
 103         uint16  ether_type;
 104 } PACKED;
 105
 106 /*
 107  * Structure of a 48-bit Ethernet address.
 108  */
 109 struct  ether_addr {
 110         uint8 octet[ETHER_ADDR_LEN];
 111 } PACKED;
 112 #endif  /* !__INCif_etherh Quick and ugly hack for VxWorks */
 113
 114 /*
 115  * Takes a pointer, set, test, clear, toggle locally admininistered
 116  * address bit in the 48-bit Ethernet address.
 117  */
 118 #define ETHER_SET_LOCALADDR(ea) (((uint8 *)(ea))[0] = (((uint8 *)(ea))[0] | 2))
 119 #define ETHER_IS_LOCALADDR(ea)  (((uint8 *)(ea))[0] & 2)
 120 #define ETHER_CLR_LOCALADDR(ea) (((uint8 *)(ea))[0] = (((uint8 *)(ea))[0] & 0xd))
 121 #define ETHER_TOGGLE_LOCALADDR(ea)      (((uint8 *)(ea))[0] = (((uint8 *)(ea))[0] ^ 2))
 122
 123 /* Takes a pointer, marks unicast address bit in the MAC address */
 124 #define ETHER_SET_UNICAST(ea)   (((uint8 *)(ea))[0] = (((uint8 *)(ea))[0] & ~1))
 125
 126 /*
 127  * Takes a pointer, returns true if a 48-bit multicast address
 128  * (including broadcast, since it is all ones)
 129  */
 130 #define ETHER_ISMULTI(ea) (((const uint8 *)(ea))[0] & 1)
 131
 132
 133 /* compare two ethernet addresses - assumes the pointers can be referenced as shorts */
 134 #define ether_cmp(a, b) (!(((short*)a)[0] == ((short*)b)[0]) | \
 135                          !(((short*)a)[1] == ((short*)b)[1]) | \
 136                          !(((short*)a)[2] == ((short*)b)[2]))
 137
 138 /* copy an ethernet address - assumes the pointers can be referenced as shorts */
 139 #define ether_copy(s, d) { \
 140                 ((short*)d)[0] = ((short*)s)[0]; \
 141                 ((short*)d)[1] = ((short*)s)[1]; \
 142                 ((short*)d)[2] = ((short*)s)[2]; }
 143
 144 /*
 145  * Takes a pointer, returns true if a 48-bit broadcast (all ones)
 146  */
 147 #define ETHER_ISBCAST(ea) ((((uint8 *)(ea))[0] &                \
 148                             ((uint8 *)(ea))[1] &                \
 149                             ((uint8 *)(ea))[2] &                \
 150                             ((uint8 *)(ea))[3] &                \
 151                             ((uint8 *)(ea))[4] &                \
 152                             ((uint8 *)(ea))[5]) == 0xff)
 153
 154 static const struct ether_addr ether_bcast = {{255, 255, 255, 255, 255, 255}};
 155 static const struct ether_addr ether_null = {{0, 0, 0, 0, 0, 0}};
 156
 157 /*
 158  * Takes a pointer, returns true if a 48-bit null address (all zeros)
 159  */
 160 #define ETHER_ISNULLADDR(ea) ((((uint8 *)(ea))[0] |             \
 161                             ((uint8 *)(ea))[1] |                \
 162                             ((uint8 *)(ea))[2] |                \
 163                             ((uint8 *)(ea))[3] |                \
 164                             ((uint8 *)(ea))[4] |                \
 165                             ((uint8 *)(ea))[5]) == 0)
 166
 167 #undef PACKED
 168 #if !defined(__GNUC__)
 169 #pragma pack()
 170 #endif
 171
 172 #endif /* _NET_ETHERNET_H_ */