4 * Copyright(c) 2010-2013 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 #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. */
57 (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) /**< Ethernet MTU. */
59 #define ETHER_MAX_VLAN_FRAME_LEN \
60 (ETHER_MAX_LEN + 4) /**< Maximum VLAN frame length, including CRC. */
62 #define ETHER_MAX_JUMBO_FRAME_LEN \
63 0x3F00 /**< Maximum Jumbo frame length, including CRC. */
65 #define ETHER_MAX_VLAN_ID 4095 /**< Maximum VLAN ID. */
69 * A universally administered address is uniquely assigned to a device by its
70 * manufacturer. The first three octets (in transmission order) contain the
71 * Organizationally Unique Identifier (OUI). The following three (MAC-48 and
72 * EUI-48) octets are assigned by that organization with the only constraint
74 * A locally administered address is assigned to a device by a network
75 * administrator and does not contain OUIs.
76 * See http://standards.ieee.org/regauth/groupmac/tutorial.html
79 uint8_t addr_bytes[ETHER_ADDR_LEN]; /**< Address bytes in transmission order */
80 } __attribute__((__packed__));
82 #define ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
83 #define ETHER_GROUP_ADDR 0x01 /**< Multicast or broadcast Eth. address. */
86 * Check if an Ethernet address is filled with zeros.
89 * A pointer to a ether_addr structure containing the ethernet address
92 * True (1) if the given ethernet address is filled with zeros;
93 * false (0) otherwise.
95 static inline int is_zero_ether_addr(const struct ether_addr *ea)
98 for (i = 0; i < ETHER_ADDR_LEN; i++)
99 if (ea->addr_bytes[i] != 0x00)
105 * Check if an Ethernet address is a unicast address.
108 * A pointer to a ether_addr structure containing the ethernet address
111 * True (1) if the given ethernet address is a unicast address;
112 * false (0) otherwise.
114 static inline int is_unicast_ether_addr(const struct ether_addr *ea)
116 return ((ea->addr_bytes[0] & ETHER_GROUP_ADDR) == 0);
120 * Check if an Ethernet address is a multicast address.
123 * A pointer to a ether_addr structure containing the ethernet address
126 * True (1) if the given ethernet address is a multicast address;
127 * false (0) otherwise.
129 static inline int is_multicast_ether_addr(const struct ether_addr *ea)
131 return (ea->addr_bytes[0] & ETHER_GROUP_ADDR);
135 * Check if an Ethernet address is a broadcast address.
138 * A pointer to a ether_addr structure containing the ethernet address
141 * True (1) if the given ethernet address is a broadcast address;
142 * false (0) otherwise.
144 static inline int is_broadcast_ether_addr(const struct ether_addr *ea)
146 const uint16_t *ea_words = (const uint16_t *)ea;
148 return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
149 ea_words[2] == 0xFFFF);
153 * Check if an Ethernet address is a universally assigned address.
156 * A pointer to a ether_addr structure containing the ethernet address
159 * True (1) if the given ethernet address is a universally assigned address;
160 * false (0) otherwise.
162 static inline int is_universal_ether_addr(const struct ether_addr *ea)
164 return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 0);
168 * Check if an Ethernet address is a locally assigned address.
171 * A pointer to a ether_addr structure containing the ethernet address
174 * True (1) if the given ethernet address is a locally assigned address;
175 * false (0) otherwise.
177 static inline int is_local_admin_ether_addr(const struct ether_addr *ea)
179 return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 1);
183 * Check if an Ethernet address is a valid address. Checks that the address is a
184 * unicast address and is not filled with zeros.
187 * A pointer to a ether_addr structure containing the ethernet address
190 * True (1) if the given ethernet address is valid;
191 * false (0) otherwise.
193 static inline int is_valid_assigned_ether_addr(const struct ether_addr *ea)
195 return (is_unicast_ether_addr(ea) && (! is_zero_ether_addr(ea)));
199 * Fast copy an Ethernet address.
202 * A pointer to a ether_addr structure holding the Ethernet address to copy.
204 * A pointer to a ether_addr structure where to copy the Ethernet address.
206 static inline void ether_addr_copy(const struct ether_addr *ea_from,
207 struct ether_addr *ea_to)
209 #ifdef __INTEL_COMPILER
210 uint16_t *from_words = (uint16_t *)(ea_from->addr_bytes);
211 uint16_t *to_words = (uint16_t *)(ea_to->addr_bytes);
213 to_words[0] = from_words[0];
214 to_words[1] = from_words[1];
215 to_words[2] = from_words[2];
218 * Use the common way, because of a strange gcc warning.
225 * Ethernet header: Contains the destination address, source address
229 struct ether_addr d_addr; /**< Destination address. */
230 struct ether_addr s_addr; /**< Source address. */
231 uint16_t ether_type; /**< Frame type. */
232 } __attribute__((__packed__));
235 * Ethernet VLAN Header.
236 * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
237 * of the encapsulated frame.
240 uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
241 uint16_t eth_proto;/**< Ethernet type of encapsulated frame. */
242 } __attribute__((__packed__));
244 /* Ethernet frame types */
245 #define ETHER_TYPE_IPv4 0x0800 /**< IPv4 Protocol. */
246 #define ETHER_TYPE_IPv6 0x86DD /**< IPv6 Protocol. */
247 #define ETHER_TYPE_ARP 0x0806 /**< Arp Protocol. */
248 #define ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
249 #define ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
250 #define ETHER_TYPE_1588 0x88F7 /**< IEEE 802.1AS 1588 Precise Time Protocol. */
256 #endif /* _RTE_ETHER_H_ */