src/vnet/ethernet/packet.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 /*
  16  * ethernet/packet.h: ethernet packet format.
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  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:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  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.
  38  */
  39
  40 #ifndef included_ethernet_packet_h
  41 #define included_ethernet_packet_h
  42
  43 typedef enum
  44 {
  45 #define ethernet_type(n,s) ETHERNET_TYPE_##s = n,
  46 #include <vnet/ethernet/types.def>
  47 #undef ethernet_type
  48 } ethernet_type_t;
  49
  50 typedef struct
  51 {
  52   /* Source/destination address. */
  53   u8 dst_address[6];
  54   u8 src_address[6];
  55
  56   /* Ethernet type. */
  57   u16 type;
  58 } ethernet_header_t;
  59
  60 #define ETHERNET_ADDRESS_UNICAST 0
  61 #define ETHERNET_ADDRESS_MULTICAST 1
  62
  63 /* I/G bit: individual (unicast)/group (broadcast/multicast). */
  64 always_inline uword
  65 ethernet_address_cast (u8 * a)
  66 {
  67   return (a[0] >> 0) & 1;
  68 }
  69
  70 always_inline uword
  71 ethernet_address_is_locally_administered (u8 * a)
  72 {
  73   return (a[0] >> 1) & 1;
  74 }
  75
  76 always_inline void
  77 ethernet_address_set_locally_administered (u8 * a)
  78 {
  79   a[0] |= 1 << 1;
  80 }
  81
  82 /* For VLAN ethernet type. */
  83 typedef struct
  84 {
  85   /* 3 bit priority, 1 bit CFI and 12 bit vlan id. */
  86   u16 priority_cfi_and_id;
  87
  88 #define ETHERNET_N_VLAN (1 << 12)
  89
  90   /* Inner ethernet type. */
  91   u16 type;
  92 } ethernet_vlan_header_t;
  93
  94 always_inline void
  95 ethernet_vlan_header_set_priority_net_order (ethernet_vlan_header_t * h,
  96                                              u8 prio)
  97 {
  98   u8 *bytes = (u8 *) (&h->priority_cfi_and_id);
  99
 100   bytes[0] &= 0x1f;
 101   bytes[0] |= (prio & 0x7) << 5;
 102 }
 103
 104 /* VLAN with ethertype first and vlan id second */
 105 typedef struct
 106 {
 107   /* vlan type */
 108   u16 type;
 109
 110   /* 3 bit priority, 1 bit CFI and 12 bit vlan id. */
 111   u16 priority_cfi_and_id;
 112 } ethernet_vlan_header_tv_t;
 113
 114 /* PBB header with B-TAG - backbone VLAN indicator and I-TAG - service encapsulation */
 115 typedef struct
 116 {
 117   /* Backbone source/destination address. */
 118   u8 b_dst_address[6];
 119   u8 b_src_address[6];
 120
 121   /* B-tag */
 122   u16 b_type;
 123   /* 3 bit priority, 1 bit DEI and 12 bit vlan id */
 124   u16 priority_dei_id;
 125
 126   /* I-tag */
 127   u16 i_type;
 128   /* 3 bit priority, 1 bit DEI, 1 bit UCA, 3 bit RES and 24 bit I_SID (service identifier) */
 129   u32 priority_dei_uca_res_sid;
 130
 131 #define ETHERNET_N_PBB (1 << 24)
 132 } ethernet_pbb_header_t;
 133
 134 /* *INDENT-OFF* */
 135 typedef CLIB_PACKED (struct
 136 {
 137   /* Backbone source/destination address. */
 138   u8 b_dst_address[6];
 139   u8 b_src_address[6];
 140
 141   /* B-tag */
 142   u16 b_type;
 143   /* 3 bit priority, 1 bit DEI and 12 bit vlan id */
 144   u16 priority_dei_id;
 145
 146   /* I-tag */
 147   u16 i_type;
 148   /* 3 bit priority, 1 bit DEI, 1 bit UCA, 3 bit RES and 24 bit I_SID (service identifier) */
 149   u32 priority_dei_uca_res_sid;
 150 }) ethernet_pbb_header_packed_t;
 151 /* *INDENT-ON* */
 152
 153 #endif /* included_ethernet_packet_h */
 154
 155 /*
 156  * fd.io coding-style-patch-verification: ON
 157  *
 158  * Local Variables:
 159  * eval: (c-set-style "gnu")
 160  * End:
 161  */