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 #ifndef _AVF_H_
  19 #define _AVF_H_
  20
  21 #include <avf/virtchnl.h>
  22
  23 #include <vlib/log.h>
  24
  25 #define foreach_avf_device_flags \
  26   _(0, INITIALIZED, "initialized") \
  27   _(1, ERROR, "error") \
  28   _(2, ADMIN_UP, "admin-up") \
  29   _(3, IOVA, "iova") \
  30   _(4, LINK_UP, "link-up") \
  31   _(5, SHARED_TXQ_LOCK, "shared-txq-lock") \
  32   _(6, ELOG, "elog")
  33
  34 enum
  35 {
  36 #define _(a, b, c) AVF_DEVICE_F_##b = (1 << a),
  37   foreach_avf_device_flags
  38 #undef _
  39 };
  40
  41 typedef volatile struct
  42 {
  43   union
  44   {
  45     struct
  46     {
  47       u64 mirr:13;
  48       u64 rsv1:3;
  49       u64 l2tag1:16;
  50       u64 filter_status:32;
  51       u64 status:19;
  52       u64 error:8;
  53       u64 rsv2:3;
  54       u64 ptype:8;
  55       u64 length:26;
  56     };
  57     u64 qword[4];
  58 #ifdef CLIB_HAVE_VEC256
  59     u64x4 as_u64x4;
  60 #endif
  61   };
  62 } avf_rx_desc_t;
  63
  64 STATIC_ASSERT_SIZEOF (avf_rx_desc_t, 32);
  65
  66 typedef volatile struct
  67 {
  68   union
  69   {
  70     u64 qword[2];
  71 #ifdef CLIB_HAVE_VEC128
  72     u64x2 as_u64x2;
  73 #endif
  74   };
  75 } avf_tx_desc_t;
  76
  77 STATIC_ASSERT_SIZEOF (avf_tx_desc_t, 16);
  78
  79 typedef struct
  80 {
  81   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  82   volatile u32 *qrx_tail;
  83   u16 next;
  84   u16 size;
  85   avf_rx_desc_t *descs;
  86   u32 *bufs;
  87   u16 n_enqueued;
  88   u8 int_mode;
  89 } avf_rxq_t;
  90
  91 typedef struct
  92 {
  93   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  94   volatile u32 *qtx_tail;
  95   u16 next;
  96   u16 size;
  97   clib_spinlock_t lock;
  98   avf_tx_desc_t *descs;
  99   u32 *bufs;
 100   u16 n_enqueued;
 101 } avf_txq_t;
 102
 103 typedef struct
 104 {
 105   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 106   u32 flags;
 107   u32 per_interface_next_index;
 108
 109   u32 dev_instance;
 110   u32 sw_if_index;
 111   u32 hw_if_index;
 112   vlib_pci_dev_handle_t pci_dev_handle;
 113   void *bar0;
 114
 115   /* queues */
 116   avf_rxq_t *rxqs;
 117   avf_txq_t *txqs;
 118   u16 n_tx_queues;
 119   u16 n_rx_queues;
 120
 121   /* Admin queues */
 122   avf_aq_desc_t *atq;
 123   avf_aq_desc_t *arq;
 124   void *atq_bufs;
 125   void *arq_bufs;
 126   u64 atq_bufs_pa;
 127   u64 arq_bufs_pa;
 128   u16 atq_next_slot;
 129   u16 arq_next_slot;
 130   virtchnl_pf_event_t *events;
 131
 132   u16 vsi_id;
 133   u32 feature_bitmap;
 134   u8 hwaddr[6];
 135   u16 num_queue_pairs;
 136   u16 max_vectors;
 137   u16 max_mtu;
 138   u32 rss_key_size;
 139   u32 rss_lut_size;
 140   virtchnl_link_speed_t link_speed;
 141
 142   /* stats */
 143   virtchnl_eth_stats_t eth_stats;
 144
 145   /* error */
 146   clib_error_t *error;
 147 } avf_device_t;
 148
 149 typedef struct
 150 {
 151   u32 status;
 152   u16 length;
 153   u8 ptype;
 154   u8 error;
 155 } avf_rx_vector_entry_t;
 156
 157 STATIC_ASSERT_SIZEOF (avf_rx_vector_entry_t, 8);
 158
 159 #define AVF_RX_VECTOR_SZ VLIB_FRAME_SIZE
 160
 161 enum
 162 {
 163   AVF_PROCESS_EVENT_START = 1,
 164   AVF_PROCESS_EVENT_STOP = 2,
 165   AVF_PROCESS_EVENT_AQ_INT = 3,
 166 } avf_process_event_t;
 167
 168 typedef struct
 169 {
 170   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 171   avf_rx_vector_entry_t rx_vector[AVF_RX_VECTOR_SZ];
 172   u32 *to_free;
 173   vlib_buffer_t buffer_template;
 174 } avf_per_thread_data_t;
 175
 176 typedef struct
 177 {
 178   u8 next_node;
 179   i8 buffer_advance;
 180   u32 flags;
 181 } avf_ptype_t;
 182
 183 STATIC_ASSERT (VNET_DEVICE_INPUT_N_NEXT_NODES < 256, "too many next nodes");
 184
 185 typedef struct
 186 {
 187   u16 msg_id_base;
 188
 189   avf_device_t *devices;
 190   avf_per_thread_data_t *per_thread_data;
 191   vlib_physmem_region_index_t physmem_region;
 192   int physmem_region_alloc;
 193
 194   vlib_log_class_t log_class;
 195
 196   /* 256 element array for ptype based lookup */
 197   avf_ptype_t *ptypes;
 198 } avf_main_t;
 199
 200 extern avf_main_t avf_main;
 201
 202 typedef struct
 203 {
 204   vlib_pci_addr_t addr;
 205   int enable_elog;
 206   u16 rxq_num;
 207   u16 rxq_size;
 208   u16 txq_size;
 209   /* return */
 210   int rv;
 211   u32 sw_if_index;
 212   clib_error_t *error;
 213 } avf_create_if_args_t;
 214
 215 void avf_create_if (vlib_main_t * vm, avf_create_if_args_t * args);
 216 void avf_delete_if (vlib_main_t * vm, avf_device_t * ad);
 217
 218 extern vlib_node_registration_t avf_input_node;
 219 extern vnet_device_class_t avf_device_class;
 220
 221 /* format.c */
 222 format_function_t format_avf_device;
 223 format_function_t format_avf_device_name;
 224 format_function_t format_avf_input_trace;
 225
 226 static inline u32
 227 avf_get_u32 (void *start, int offset)
 228 {
 229   return *(u32 *) (((u8 *) start) + offset);
 230 }
 231
 232 static inline u64
 233 avf_get_u64 (void *start, int offset)
 234 {
 235   return *(u64 *) (((u8 *) start) + offset);
 236 }
 237
 238 static inline u32
 239 avf_get_u32_bits (void *start, int offset, int first, int last)
 240 {
 241   u32 value = avf_get_u32 (start, offset);
 242   if ((last == 0) && (first == 31))
 243     return value;
 244   value >>= last;
 245   value &= (1 << (first - last + 1)) - 1;
 246   return value;
 247 }
 248
 249 static inline u64
 250 avf_get_u64_bits (void *start, int offset, int first, int last)
 251 {
 252   u64 value = avf_get_u64 (start, offset);
 253   if ((last == 0) && (first == 63))
 254     return value;
 255   value >>= last;
 256   value &= (1 << (first - last + 1)) - 1;
 257   return value;
 258 }
 259
 260 static inline void
 261 avf_set_u32 (void *start, int offset, u32 value)
 262 {
 263   (*(u32 *) (((u8 *) start) + offset)) = value;
 264 }
 265
 266 static inline void
 267 avf_reg_write (avf_device_t * ad, u32 addr, u32 val)
 268 {
 269   *(volatile u32 *) ((u8 *) ad->bar0 + addr) = val;
 270 }
 271
 272 static inline u32
 273 avf_reg_read (avf_device_t * ad, u32 addr)
 274 {
 275   return *(volatile u32 *) (ad->bar0 + addr);
 276 }
 277
 278 static inline void
 279 avf_reg_flush (avf_device_t * ad)
 280 {
 281   avf_reg_read (ad, AVFGEN_RSTAT);
 282   asm volatile ("":::"memory");
 283 }
 284
 285 typedef struct
 286 {
 287   u32 next_index;
 288   u32 hw_if_index;
 289   avf_rx_vector_entry_t rxve;
 290 } avf_input_trace_t;
 291
 292 #define foreach_avf_tx_func_error              \
 293 _(NO_FREE_SLOTS, "no free tx slots")
 294
 295 typedef enum
 296 {
 297 #define _(f,s) AVF_TX_ERROR_##f,
 298   foreach_avf_tx_func_error
 299 #undef _
 300     AVF_TX_N_ERROR,
 301 } avf_tx_func_error_t;
 302
 303 #endif /* AVF_H */
 304
 305 /*
 306  * fd.io coding-style-patch-verification: ON
 307  *
 308  * Local Variables:
 309  * eval: (c-set-style "gnu")
 310  * End:
 311  */