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