2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * ethernet/packet.h: ethernet packet format.
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #ifndef included_ethernet_packet_h
41 #define included_ethernet_packet_h
43 #include <vnet/interface.h>
47 #define ethernet_type(n,s) ETHERNET_TYPE_##s = n,
48 #include <vnet/ethernet/types.def>
54 /* Source/destination address. */
62 #define ETHERNET_ADDRESS_UNICAST 0
63 #define ETHERNET_ADDRESS_MULTICAST 1
65 /* I/G bit: individual (unicast)/group (broadcast/multicast). */
67 ethernet_address_cast (u8 * a)
69 return (a[0] >> 0) & 1;
73 ethernet_address_is_broadcast (u8 * a)
75 return clib_mem_unaligned (a, u32) == 0xffffffff &&
76 clib_mem_unaligned (a + 4, u16) == 0xffff;
80 ethernet_address_is_locally_administered (u8 * a)
82 return (a[0] >> 1) & 1;
86 ethernet_address_set_locally_administered (u8 * a)
92 eh_dst_addr_to_rx_ctype (ethernet_header_t * eh)
94 if (PREDICT_TRUE (ethernet_address_cast (eh->dst_address) ==
95 ETHERNET_ADDRESS_UNICAST))
97 return VNET_INTERFACE_COUNTER_RX_UNICAST;
99 else if (ethernet_address_is_broadcast (eh->dst_address))
101 return VNET_INTERFACE_COUNTER_RX_BROADCAST;
105 return VNET_INTERFACE_COUNTER_RX_MULTICAST;
110 eh_dst_addr_to_tx_ctype (ethernet_header_t * eh)
112 if (PREDICT_TRUE (ethernet_address_cast (eh->dst_address) ==
113 ETHERNET_ADDRESS_UNICAST))
115 return VNET_INTERFACE_COUNTER_TX_UNICAST;
117 else if (ethernet_address_is_broadcast (eh->dst_address))
119 return VNET_INTERFACE_COUNTER_TX_BROADCAST;
123 return VNET_INTERFACE_COUNTER_TX_MULTICAST;
127 /* For VLAN ethernet type. */
130 /* 3 bit priority, 1 bit CFI and 12 bit vlan id. */
131 u16 priority_cfi_and_id;
133 #define ETHERNET_N_VLAN (1 << 12)
135 /* Inner ethernet type. */
137 } ethernet_vlan_header_t;
140 ethernet_vlan_header_set_priority_net_order (ethernet_vlan_header_t * h,
143 u8 *bytes = (u8 *) (&h->priority_cfi_and_id);
146 bytes[0] |= (prio & 0xf) << 4;
150 ethernet_vlan_header_get_priority_net_order (ethernet_vlan_header_t * h)
152 u8 *bytes = (u8 *) (&h->priority_cfi_and_id);
154 return (bytes[0] >> 4);
157 /* VLAN with ethertype first and vlan id second */
163 /* 3 bit priority, 1 bit CFI and 12 bit vlan id. */
164 u16 priority_cfi_and_id;
165 } ethernet_vlan_header_tv_t;
167 /* PBB header with B-TAG - backbone VLAN indicator and I-TAG - service encapsulation */
170 /* Backbone source/destination address. */
176 /* 3 bit priority, 1 bit DEI and 12 bit vlan id */
181 /* 3 bit priority, 1 bit DEI, 1 bit UCA, 3 bit RES and 24 bit I_SID (service identifier) */
182 u32 priority_dei_uca_res_sid;
184 #define ETHERNET_N_PBB (1 << 24)
185 } ethernet_pbb_header_t;
188 typedef CLIB_PACKED (struct
190 /* Backbone source/destination address. */
196 /* 3 bit priority, 1 bit DEI and 12 bit vlan id */
201 /* 3 bit priority, 1 bit DEI, 1 bit UCA, 3 bit RES and 24 bit I_SID (service identifier) */
202 u32 priority_dei_uca_res_sid;
203 }) ethernet_pbb_header_packed_t;
206 #endif /* included_ethernet_packet_h */
209 * fd.io coding-style-patch-verification: ON
212 * eval: (c-set-style "gnu")