lib/librte_ether/rte_ether.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_ETHER_H_
  35 #define _RTE_ETHER_H_
  36
  37 /**
  38  * @file
  39  *
  40  * Ethernet Helpers in RTE
  41  */
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #include <stdint.h>
  48
  49 #define ETHER_ADDR_LEN  6 /**< Length of Ethernet address. */
  50 #define ETHER_TYPE_LEN  2 /**< Length of Ethernet type field. */
  51 #define ETHER_CRC_LEN   4 /**< Length of Ethernet CRC. */
  52 #define ETHER_HDR_LEN   \
  53         (ETHER_ADDR_LEN * 2 + ETHER_TYPE_LEN) /**< Length of Ethernet header. */
  54 #define ETHER_MIN_LEN   64    /**< Minimum frame len, including CRC. */
  55 #define ETHER_MAX_LEN   1518  /**< Maximum frame len, including CRC. */
  56 #define ETHER_MTU       \
  57         (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) /**< Ethernet MTU. */
  58
  59 #define ETHER_MAX_VLAN_FRAME_LEN \
  60         (ETHER_MAX_LEN + 4) /**< Maximum VLAN frame length, including CRC. */
  61
  62 #define ETHER_MAX_JUMBO_FRAME_LEN \
  63         0x3F00 /**< Maximum Jumbo frame length, including CRC. */
  64
  65 /**
  66  * Ethernet address:
  67  * A universally administered address is uniquely assigned to a device by its
  68  * manufacturer. The first three octets (in transmission order) contain the
  69  * Organizationally Unique Identifier (OUI). The following three (MAC-48 and
  70  * EUI-48) octets are assigned by that organization with the only constraint
  71  * of uniqueness.
  72  * A locally administered address is assigned to a device by a network
  73  * administrator and does not contain OUIs.
  74  * See http://standards.ieee.org/regauth/groupmac/tutorial.html
  75  */
  76 struct ether_addr {
  77         uint8_t addr_bytes[ETHER_ADDR_LEN]; /**< Address bytes in transmission order */
  78 } __attribute__((__packed__));
  79
  80 #define ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
  81 #define ETHER_GROUP_ADDR       0x01 /**< Multicast or broadcast Eth. address. */
  82
  83 /**
  84  * Check if an Ethernet address is filled with zeros.
  85  *
  86  * @param ea
  87  *   A pointer to a ether_addr structure containing the ethernet address
  88  *   to check.
  89  * @return
  90  *   True  (1) if the given ethernet address is filled with zeros;
  91  *   false (0) otherwise.
  92  */
  93 static inline int is_zero_ether_addr(const struct ether_addr *ea)
  94 {
  95         int i;
  96         for (i = 0; i < ETHER_ADDR_LEN; i++)
  97                 if (ea->addr_bytes[i] != 0x00)
  98                         return 0;
  99         return 1;
 100 }
 101
 102 /**
 103  * Check if an Ethernet address is a unicast address.
 104  *
 105  * @param ea
 106  *   A pointer to a ether_addr structure containing the ethernet address
 107  *   to check.
 108  * @return
 109  *   True  (1) if the given ethernet address is a unicast address;
 110  *   false (0) otherwise.
 111  */
 112 static inline int is_unicast_ether_addr(const struct ether_addr *ea)
 113 {
 114         return ((ea->addr_bytes[0] & ETHER_GROUP_ADDR) == 0);
 115 }
 116
 117 /**
 118  * Check if an Ethernet address is a multicast address.
 119  *
 120  * @param ea
 121  *   A pointer to a ether_addr structure containing the ethernet address
 122  *   to check.
 123  * @return
 124  *   True  (1) if the given ethernet address is a multicast address;
 125  *   false (0) otherwise.
 126  */
 127 static inline int is_multicast_ether_addr(const struct ether_addr *ea)
 128 {
 129         return (ea->addr_bytes[0] & ETHER_GROUP_ADDR);
 130 }
 131
 132 /**
 133  * Check if an Ethernet address is a broadcast address.
 134  *
 135  * @param ea
 136  *   A pointer to a ether_addr structure containing the ethernet address
 137  *   to check.
 138  * @return
 139  *   True  (1) if the given ethernet address is a broadcast address;
 140  *   false (0) otherwise.
 141  */
 142 static inline int is_broadcast_ether_addr(const struct ether_addr *ea)
 143 {
 144         const uint16_t *ea_words = (const uint16_t *)ea;
 145
 146         return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
 147                 ea_words[2] == 0xFFFF);
 148 }
 149
 150 /**
 151  * Check if an Ethernet address is a universally assigned address.
 152  *
 153  * @param ea
 154  *   A pointer to a ether_addr structure containing the ethernet address
 155  *   to check.
 156  * @return
 157  *   True  (1) if the given ethernet address is a universally assigned address;
 158  *   false (0) otherwise.
 159  */
 160 static inline int is_universal_ether_addr(const struct ether_addr *ea)
 161 {
 162         return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 0);
 163 }
 164
 165 /**
 166  * Check if an Ethernet address is a locally assigned address.
 167  *
 168  * @param ea
 169  *   A pointer to a ether_addr structure containing the ethernet address
 170  *   to check.
 171  * @return
 172  *   True  (1) if the given ethernet address is a locally assigned address;
 173  *   false (0) otherwise.
 174  */
 175 static inline int is_local_admin_ether_addr(const struct ether_addr *ea)
 176 {
 177         return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 1);
 178 }
 179
 180 /**
 181  * Check if an Ethernet address is a valid address. Checks that the address is a
 182  * unicast address and is not filled with zeros.
 183  *
 184  * @param ea
 185  *   A pointer to a ether_addr structure containing the ethernet address
 186  *   to check.
 187  * @return
 188  *   True  (1) if the given ethernet address is valid;
 189  *   false (0) otherwise.
 190  */
 191 static inline int is_valid_assigned_ether_addr(const struct ether_addr *ea)
 192 {
 193         return (is_unicast_ether_addr(ea) && (! is_zero_ether_addr(ea)));
 194 }
 195
 196 /**
 197  * Fast copy an Ethernet address.
 198  *
 199  * @param ea_from
 200  *   A pointer to a ether_addr structure holding the Ethernet address to copy.
 201  * @param ea_to
 202  *   A pointer to a ether_addr structure where to copy the Ethernet address.
 203  */
 204 static inline void ether_addr_copy(const struct ether_addr *ea_from,
 205                                    struct ether_addr *ea_to)
 206 {
 207 #ifdef __INTEL_COMPILER
 208         uint16_t *from_words = (uint16_t *)(ea_from->addr_bytes);
 209         uint16_t *to_words   = (uint16_t *)(ea_to->addr_bytes);
 210
 211         to_words[0] = from_words[0];
 212         to_words[1] = from_words[1];
 213         to_words[2] = from_words[2];
 214 #else
 215         /*
 216          * Use the common way, because of a strange gcc warning.
 217          */
 218         *ea_to = *ea_from;
 219 #endif
 220 }
 221
 222 /**
 223  * Ethernet header: Contains the destination address, source address
 224  * and frame type.
 225  */
 226 struct ether_hdr {
 227         struct ether_addr d_addr; /**< Destination address. */
 228         struct ether_addr s_addr; /**< Source address. */
 229         uint16_t ether_type;      /**< Frame type. */
 230 } __attribute__((__packed__));
 231
 232 /**
 233  * Ethernet VLAN Header.
 234  * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
 235  * of the encapsulated frame.
 236  */
 237 struct vlan_hdr {
 238         uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
 239         uint16_t eth_proto;/**< Ethernet type of encapsulated frame. */
 240 } __attribute__((__packed__));
 241
 242 /* Ethernet frame types */
 243 #define ETHER_TYPE_IPv4 0x0800 /**< IPv4 Protocol. */
 244 #define ETHER_TYPE_IPv6 0x86DD /**< IPv6 Protocol. */
 245 #define ETHER_TYPE_ARP  0x0806 /**< Arp Protocol. */
 246 #define ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
 247 #define ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
 248 #define ETHER_TYPE_1588 0x88F7 /**< IEEE 802.1AS 1588 Precise Time Protocol. */
 249
 250 #ifdef __cplusplus
 251 }
 252 #endif
 253
 254 #endif /* _RTE_ETHER_H_ */