src/plugins/avf/avf.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2018 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <avf/virtchnl.h>
  19
  20 #include <vlib/log.h>
  21
  22 #define foreach_avf_device_flags \
  23   _(0, INITIALIZED, "initialized") \
  24   _(1, ERROR, "error") \
  25   _(2, ADMIN_UP, "admin-up") \
  26   _(3, IOVA, "iova") \
  27   _(4, LINK_UP, "link-up") \
  28   _(5, SHARED_TXQ_LOCK, "shared-txq-lock") \
  29   _(6, ELOG, "elog")
  30
  31 enum
  32 {
  33 #define _(a, b, c) AVF_DEVICE_F_##b = (1 << a),
  34   foreach_avf_device_flags
  35 #undef _
  36 };
  37
  38 typedef struct
  39 {
  40   u64 qword[4];
  41 } avf_rx_desc_t;
  42
  43 STATIC_ASSERT_SIZEOF (avf_rx_desc_t, 32);
  44
  45 typedef struct
  46 {
  47   union
  48   {
  49     u64 qword[2];
  50     u64x2 as_u64x2;
  51   };
  52 } avf_tx_desc_t;
  53
  54 STATIC_ASSERT_SIZEOF (avf_tx_desc_t, 16);
  55
  56 typedef struct
  57 {
  58   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  59   volatile u32 *qrx_tail;
  60   u16 next;
  61   u16 size;
  62   avf_rx_desc_t *descs;
  63   u32 *bufs;
  64   u16 n_bufs;
  65 } avf_rxq_t;
  66
  67 typedef struct
  68 {
  69   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  70   volatile u32 *qtx_tail;
  71   u16 next;
  72   u16 size;
  73   clib_spinlock_t lock;
  74   avf_tx_desc_t *descs;
  75   u32 *bufs;
  76   u16 n_bufs;
  77 } avf_txq_t;
  78
  79 typedef struct
  80 {
  81   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  82   u32 flags;
  83   u32 per_interface_next_index;
  84
  85   u32 dev_instance;
  86   u32 sw_if_index;
  87   u32 hw_if_index;
  88   vlib_pci_dev_handle_t pci_dev_handle;
  89   void *bar0;
  90
  91   /* queues */
  92   avf_rxq_t *rxqs;
  93   avf_txq_t *txqs;
  94
  95   /* Admin queues */
  96   avf_aq_desc_t *atq;
  97   avf_aq_desc_t *arq;
  98   void *atq_bufs;
  99   void *arq_bufs;
 100   u64 atq_bufs_pa;
 101   u64 arq_bufs_pa;
 102   u16 atq_next_slot;
 103   u16 arq_next_slot;
 104   virtchnl_pf_event_t *events;
 105
 106   u16 vsi_id;
 107   u32 feature_bitmap;
 108   u8 hwaddr[6];
 109   u16 num_queue_pairs;
 110   u16 max_vectors;
 111   u16 max_mtu;
 112   u32 rss_key_size;
 113   u32 rss_lut_size;
 114   virtchnl_link_speed_t link_speed;
 115
 116   /* stats */
 117   virtchnl_eth_stats_t eth_stats;
 118
 119   /* error */
 120   clib_error_t *error;
 121 } avf_device_t;
 122
 123 typedef struct
 124 {
 125   u32 bi;
 126   u32 status;
 127   u16 length;
 128   u16 tail_length;
 129   u8 ptype;
 130   u8 error;
 131 } avf_rx_vector_entry_t;
 132
 133 STATIC_ASSERT_SIZEOF (avf_rx_vector_entry_t, 16);
 134
 135 #define AVF_RX_VECTOR_SZ VLIB_FRAME_SIZE
 136
 137 enum
 138 {
 139   AVF_PROCESS_EVENT_START = 1,
 140   AVF_PROCESS_EVENT_STOP = 2,
 141   AVF_PROCESS_EVENT_AQ_INT = 3,
 142 } avf_process_event_t;
 143
 144 typedef struct
 145 {
 146   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 147   avf_rx_vector_entry_t rx_vector[AVF_RX_VECTOR_SZ];
 148   u32 *to_free;
 149 } avf_per_thread_data_t;
 150
 151 typedef struct
 152 {
 153   u8 next_node;
 154   i8 buffer_advance;
 155   u32 flags;
 156 } avf_ptype_t;
 157
 158 STATIC_ASSERT (VNET_DEVICE_INPUT_N_NEXT_NODES < 256, "too many next nodes");
 159
 160 typedef struct
 161 {
 162   avf_device_t *devices;
 163   avf_per_thread_data_t *per_thread_data;
 164   vlib_physmem_region_index_t physmem_region;
 165   int physmem_region_alloc;
 166
 167   vlib_log_class_t log_class;
 168
 169   /* 256 element array for ptype based lookup */
 170   avf_ptype_t *ptypes;
 171 } avf_main_t;
 172
 173 extern avf_main_t avf_main;
 174
 175 typedef struct
 176 {
 177   vlib_pci_addr_t addr;
 178   int enable_elog;
 179   /* return */
 180   int rv;
 181   clib_error_t *error;
 182 } avf_create_if_args_t;
 183
 184 void avf_create_if (vlib_main_t * vm, avf_create_if_args_t * args);
 185 void avf_delete_if (vlib_main_t * vm, avf_device_t * ad);
 186
 187 extern vlib_node_registration_t avf_input_node;
 188 extern vnet_device_class_t avf_device_class;
 189 uword avf_interface_tx (vlib_main_t * vm, vlib_node_runtime_t * node,
 190                         vlib_frame_t * frame);
 191
 192 /* format.c */
 193 format_function_t format_avf_device;
 194 format_function_t format_avf_device_name;
 195 format_function_t format_avf_input_trace;
 196
 197 static inline u32
 198 avf_get_u32 (void *start, int offset)
 199 {
 200   return *(u32 *) (((u8 *) start) + offset);
 201 }
 202
 203 static inline u64
 204 avf_get_u64 (void *start, int offset)
 205 {
 206   return *(u64 *) (((u8 *) start) + offset);
 207 }
 208
 209 static inline u32
 210 avf_get_u32_bits (void *start, int offset, int first, int last)
 211 {
 212   u32 value = avf_get_u32 (start, offset);
 213   if ((last == 0) && (first == 31))
 214     return value;
 215   value >>= last;
 216   value &= (1 << (first - last + 1)) - 1;
 217   return value;
 218 }
 219
 220 static inline u64
 221 avf_get_u64_bits (void *start, int offset, int first, int last)
 222 {
 223   u64 value = avf_get_u64 (start, offset);
 224   if ((last == 0) && (first == 63))
 225     return value;
 226   value >>= last;
 227   value &= (1 << (first - last + 1)) - 1;
 228   return value;
 229 }
 230
 231 static inline void
 232 avf_set_u32 (void *start, int offset, u32 value)
 233 {
 234   (*(u32 *) (((u8 *) start) + offset)) = value;
 235 }
 236
 237 static inline void
 238 avf_reg_write (avf_device_t * ad, u32 addr, u32 val)
 239 {
 240   *(volatile u32 *) ((u8 *) ad->bar0 + addr) = val;
 241 }
 242
 243 static inline u32
 244 avf_reg_read (avf_device_t * ad, u32 addr)
 245 {
 246   return *(volatile u32 *) (ad->bar0 + addr);
 247 }
 248
 249 static inline void
 250 avf_reg_flush (avf_device_t * ad)
 251 {
 252   avf_reg_read (ad, AVFGEN_RSTAT);
 253   asm volatile ("":::"memory");
 254 }
 255
 256 typedef struct
 257 {
 258   u32 next_index;
 259   u32 hw_if_index;
 260   avf_rx_vector_entry_t rxve;
 261 } avf_input_trace_t;
 262
 263 /*
 264  * fd.io coding-style-patch-verification: ON
 265  *
 266  * Local Variables:
 267  * eval: (c-set-style "gnu")
 268  * End:
 269  */