4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
40 * Ethernet Helpers in RTE
49 #include <rte_memcpy.h>
50 #include <rte_random.h>
52 #define ETHER_ADDR_LEN 6 /**< Length of Ethernet address. */
53 #define ETHER_TYPE_LEN 2 /**< Length of Ethernet type field. */
54 #define ETHER_CRC_LEN 4 /**< Length of Ethernet CRC. */
55 #define ETHER_HDR_LEN \
56 (ETHER_ADDR_LEN * 2 + ETHER_TYPE_LEN) /**< Length of Ethernet header. */
57 #define ETHER_MIN_LEN 64 /**< Minimum frame len, including CRC. */
58 #define ETHER_MAX_LEN 1518 /**< Maximum frame len, including CRC. */
60 (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) /**< Ethernet MTU. */
62 #define ETHER_MAX_VLAN_FRAME_LEN \
63 (ETHER_MAX_LEN + 4) /**< Maximum VLAN frame length, including CRC. */
65 #define ETHER_MAX_JUMBO_FRAME_LEN \
66 0x3F00 /**< Maximum Jumbo frame length, including CRC. */
68 #define ETHER_MAX_VLAN_ID 4095 /**< Maximum VLAN ID. */
72 * A universally administered address is uniquely assigned to a device by its
73 * manufacturer. The first three octets (in transmission order) contain the
74 * Organizationally Unique Identifier (OUI). The following three (MAC-48 and
75 * EUI-48) octets are assigned by that organization with the only constraint
77 * A locally administered address is assigned to a device by a network
78 * administrator and does not contain OUIs.
79 * See http://standards.ieee.org/regauth/groupmac/tutorial.html
82 uint8_t addr_bytes[ETHER_ADDR_LEN]; /**< Address bytes in transmission order */
83 } __attribute__((__packed__));
85 #define ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
86 #define ETHER_GROUP_ADDR 0x01 /**< Multicast or broadcast Eth. address. */
89 * Check if an Ethernet address is filled with zeros.
92 * A pointer to a ether_addr structure containing the ethernet address
95 * True (1) if the given ethernet address is filled with zeros;
96 * false (0) otherwise.
98 static inline int is_zero_ether_addr(const struct ether_addr *ea)
101 for (i = 0; i < ETHER_ADDR_LEN; i++)
102 if (ea->addr_bytes[i] != 0x00)
108 * Check if an Ethernet address is a unicast address.
111 * A pointer to a ether_addr structure containing the ethernet address
114 * True (1) if the given ethernet address is a unicast address;
115 * false (0) otherwise.
117 static inline int is_unicast_ether_addr(const struct ether_addr *ea)
119 return ((ea->addr_bytes[0] & ETHER_GROUP_ADDR) == 0);
123 * Check if an Ethernet address is a multicast address.
126 * A pointer to a ether_addr structure containing the ethernet address
129 * True (1) if the given ethernet address is a multicast address;
130 * false (0) otherwise.
132 static inline int is_multicast_ether_addr(const struct ether_addr *ea)
134 return (ea->addr_bytes[0] & ETHER_GROUP_ADDR);
138 * Check if an Ethernet address is a broadcast address.
141 * A pointer to a ether_addr structure containing the ethernet address
144 * True (1) if the given ethernet address is a broadcast address;
145 * false (0) otherwise.
147 static inline int is_broadcast_ether_addr(const struct ether_addr *ea)
149 const uint16_t *ea_words = (const uint16_t *)ea;
151 return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
152 ea_words[2] == 0xFFFF);
156 * Check if an Ethernet address is a universally assigned address.
159 * A pointer to a ether_addr structure containing the ethernet address
162 * True (1) if the given ethernet address is a universally assigned address;
163 * false (0) otherwise.
165 static inline int is_universal_ether_addr(const struct ether_addr *ea)
167 return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 0);
171 * Check if an Ethernet address is a locally assigned address.
174 * A pointer to a ether_addr structure containing the ethernet address
177 * True (1) if the given ethernet address is a locally assigned address;
178 * false (0) otherwise.
180 static inline int is_local_admin_ether_addr(const struct ether_addr *ea)
182 return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 1);
186 * Check if an Ethernet address is a valid address. Checks that the address is a
187 * unicast address and is not filled with zeros.
190 * A pointer to a ether_addr structure containing the ethernet address
193 * True (1) if the given ethernet address is valid;
194 * false (0) otherwise.
196 static inline int is_valid_assigned_ether_addr(const struct ether_addr *ea)
198 return (is_unicast_ether_addr(ea) && (! is_zero_ether_addr(ea)));
202 * Generate a random Ethernet address that is locally administered
205 * A pointer to Ethernet address.
207 static inline void eth_random_addr(uint8_t *addr)
209 uint64_t rand = rte_rand();
210 uint8_t *p = (uint8_t*)&rand;
212 rte_memcpy(addr, p, ETHER_ADDR_LEN);
213 addr[0] &= ~ETHER_GROUP_ADDR; /* clear multicast bit */
214 addr[0] |= ETHER_LOCAL_ADMIN_ADDR; /* set local assignment bit */
218 * Fast copy an Ethernet address.
221 * A pointer to a ether_addr structure holding the Ethernet address to copy.
223 * A pointer to a ether_addr structure where to copy the Ethernet address.
225 static inline void ether_addr_copy(const struct ether_addr *ea_from,
226 struct ether_addr *ea_to)
228 #ifdef __INTEL_COMPILER
229 uint16_t *from_words = (uint16_t *)(ea_from->addr_bytes);
230 uint16_t *to_words = (uint16_t *)(ea_to->addr_bytes);
232 to_words[0] = from_words[0];
233 to_words[1] = from_words[1];
234 to_words[2] = from_words[2];
237 * Use the common way, because of a strange gcc warning.
244 * Ethernet header: Contains the destination address, source address
248 struct ether_addr d_addr; /**< Destination address. */
249 struct ether_addr s_addr; /**< Source address. */
250 uint16_t ether_type; /**< Frame type. */
251 } __attribute__((__packed__));
254 * Ethernet VLAN Header.
255 * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
256 * of the encapsulated frame.
259 uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
260 uint16_t eth_proto;/**< Ethernet type of encapsulated frame. */
261 } __attribute__((__packed__));
263 /* Ethernet frame types */
264 #define ETHER_TYPE_IPv4 0x0800 /**< IPv4 Protocol. */
265 #define ETHER_TYPE_IPv6 0x86DD /**< IPv6 Protocol. */
266 #define ETHER_TYPE_ARP 0x0806 /**< Arp Protocol. */
267 #define ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
268 #define ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
269 #define ETHER_TYPE_1588 0x88F7 /**< IEEE 802.1AS 1588 Precise Time Protocol. */
275 #endif /* _RTE_ETHER_H_ */