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 <vppinfra/types.h>
  24 #include <vppinfra/error_bootstrap.h>
  25 #include <vppinfra/lock.h>
  26
  27 #include <vlib/log.h>
  28 #include <vlib/pci/pci.h>
  29
  30 #include <vnet/interface.h>
  31
  32 #include <vnet/devices/devices.h>
  33 #include <vnet/flow/flow.h>
  34
  35 #define AVF_QUEUE_SZ_MAX                4096
  36 #define AVF_QUEUE_SZ_MIN                64
  37
  38 #define AVF_AQ_ENQ_SUSPEND_TIME         50e-6
  39 #define AVF_AQ_ENQ_MAX_WAIT_TIME        250e-3
  40
  41 #define AVF_RESET_SUSPEND_TIME          20e-3
  42 #define AVF_RESET_MAX_WAIT_TIME         1
  43
  44 #define AVF_SEND_TO_PF_SUSPEND_TIME     10e-3
  45 #define AVF_SEND_TO_PF_MAX_WAIT_TIME    1
  46
  47 #define AVF_RXD_STATUS(x)               (1ULL << x)
  48 #define AVF_RXD_STATUS_DD               AVF_RXD_STATUS(0)
  49 #define AVF_RXD_STATUS_EOP              AVF_RXD_STATUS(1)
  50 #define AVF_RXD_STATUS_FLM              AVF_RXD_STATUS (11)
  51 #define AVF_RXD_ERROR_SHIFT             19
  52 #define AVF_RXD_PTYPE_SHIFT             30
  53 #define AVF_RXD_LEN_SHIFT               38
  54 #define AVF_RX_MAX_DESC_IN_CHAIN        5
  55
  56 #define AVF_RXD_ERROR_IPE               (1ULL << (AVF_RXD_ERROR_SHIFT + 3))
  57 #define AVF_RXD_ERROR_L4E               (1ULL << (AVF_RXD_ERROR_SHIFT + 4))
  58
  59 #define AVF_TXD_CMD(x)                  (1 << (x + 4))
  60 #define AVF_TXD_CMD_EXT(x, val)         ((u64)val << (x + 4))
  61 #define AVF_TXD_CMD_EOP                 AVF_TXD_CMD(0)
  62 #define AVF_TXD_CMD_RS                  AVF_TXD_CMD(1)
  63 #define AVF_TXD_CMD_RSV                 AVF_TXD_CMD(2)
  64
  65 #define AVF_TXD_CMD_IIPT_NONE           AVF_TXD_CMD_EXT(5, 0)
  66 #define AVF_TXD_CMD_IIPT_IPV6           AVF_TXD_CMD_EXT(5, 1)
  67 #define AVF_TXD_CMD_IIPT_IPV4_NO_CSUM   AVF_TXD_CMD_EXT(5, 2)
  68 #define AVF_TXD_CMD_IIPT_IPV4           AVF_TXD_CMD_EXT(5, 3)
  69
  70 #define AVF_TXD_CMD_L4T_UNKNOWN         AVF_TXD_CMD_EXT(8, 0)
  71 #define AVF_TXD_CMD_L4T_TCP             AVF_TXD_CMD_EXT(8, 1)
  72 #define AVF_TXD_CMD_L4T_SCTP            AVF_TXD_CMD_EXT(8, 2)
  73 #define AVF_TXD_CMD_L4T_UDP             AVF_TXD_CMD_EXT(8, 3)
  74
  75 #define AVF_TXD_OFFSET(x,factor,val)    (((u64)val/(u64)factor) << (16 + x))
  76 #define AVF_TXD_OFFSET_MACLEN(val)      AVF_TXD_OFFSET( 0, 2, val)
  77 #define AVF_TXD_OFFSET_IPLEN(val)       AVF_TXD_OFFSET( 7, 4, val)
  78 #define AVF_TXD_OFFSET_L4LEN(val)       AVF_TXD_OFFSET(14, 4, val)
  79
  80 #define AVF_TXD_DTYP_CTX                0x1ULL
  81 #define AVF_TXD_CTX_CMD_TSO             AVF_TXD_CMD(0)
  82 #define AVF_TXD_CTX_SEG(val,x)          (((u64)val) << (30 + x))
  83 #define AVF_TXD_CTX_SEG_TLEN(val)       AVF_TXD_CTX_SEG(val,0)
  84 #define AVF_TXD_CTX_SEG_MSS(val)        AVF_TXD_CTX_SEG(val,20)
  85
  86
  87 extern vlib_log_class_registration_t avf_log;
  88
  89 #define avf_log_err(dev, f, ...)                        \
  90   vlib_log (VLIB_LOG_LEVEL_ERR, avf_log.class, "%U: " f, \
  91             format_vlib_pci_addr, &dev->pci_addr, \
  92             ## __VA_ARGS__)
  93
  94 #define avf_log_warn(dev, f, ...)                        \
  95   vlib_log (VLIB_LOG_LEVEL_WARNING, avf_log.class, "%U: " f, \
  96             format_vlib_pci_addr, &dev->pci_addr, \
  97             ## __VA_ARGS__)
  98
  99 #define avf_log_debug(dev, f, ...)                        \
 100   vlib_log (VLIB_LOG_LEVEL_DEBUG, avf_log.class, "%U: " f, \
 101             format_vlib_pci_addr, &dev->pci_addr, \
 102             ## __VA_ARGS__)
 103
 104 #define foreach_avf_device_flags                                              \
 105   _ (0, INITIALIZED, "initialized")                                           \
 106   _ (1, ERROR, "error")                                                       \
 107   _ (2, ADMIN_UP, "admin-up")                                                 \
 108   _ (3, VA_DMA, "vaddr-dma")                                                  \
 109   _ (4, LINK_UP, "link-up")                                                   \
 110   _ (5, SHARED_TXQ_LOCK, "shared-txq-lock")                                   \
 111   _ (6, ELOG, "elog")                                                         \
 112   _ (7, PROMISC, "promisc")                                                   \
 113   _ (8, RX_INT, "rx-interrupts")                                              \
 114   _ (9, RX_FLOW_OFFLOAD, "rx-flow-offload")
 115
 116 enum
 117 {
 118 #define _(a, b, c) AVF_DEVICE_F_##b = (1 << a),
 119   foreach_avf_device_flags
 120 #undef _
 121 };
 122
 123 typedef volatile struct
 124 {
 125   union
 126   {
 127     struct
 128     {
 129       u64 mirr:13;
 130       u64 rsv1:3;
 131       u64 l2tag1:16;
 132       u64 filter_status:32;
 133       u64 status:19;
 134       u64 error:8;
 135       u64 rsv2:3;
 136       u64 ptype:8;
 137       u64 length:26;
 138
 139       u64 rsv3 : 64;
 140       u32 flex_lo;
 141       u32 fdid_flex_hi;
 142     };
 143     u64 qword[4];
 144 #ifdef CLIB_HAVE_VEC256
 145     u64x4 as_u64x4;
 146 #endif
 147   };
 148 } avf_rx_desc_t;
 149
 150 STATIC_ASSERT_SIZEOF (avf_rx_desc_t, 32);
 151
 152 typedef volatile struct
 153 {
 154   union
 155   {
 156     u64 qword[2];
 157 #ifdef CLIB_HAVE_VEC128
 158     u64x2 as_u64x2;
 159 #endif
 160   };
 161 } avf_tx_desc_t;
 162
 163 STATIC_ASSERT_SIZEOF (avf_tx_desc_t, 16);
 164
 165 typedef struct
 166 {
 167   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 168   volatile u32 *qrx_tail;
 169   u16 next;
 170   u16 size;
 171   avf_rx_desc_t *descs;
 172   u32 *bufs;
 173   u16 n_enqueued;
 174   u8 int_mode;
 175   u8 buffer_pool_index;
 176   u32 queue_index;
 177 } avf_rxq_t;
 178
 179 typedef struct
 180 {
 181   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 182   volatile u32 *qtx_tail;
 183   u16 next;
 184   u16 size;
 185   u32 ctx_desc_placeholder_bi;
 186   clib_spinlock_t lock;
 187   avf_tx_desc_t *descs;
 188   u32 *bufs;
 189   u16 n_enqueued;
 190   u16 *rs_slots;
 191 } avf_txq_t;
 192
 193 typedef struct
 194 {
 195   u32 flow_index;
 196   u32 mark;
 197   struct avf_fdir_conf *rcfg;
 198 } avf_flow_entry_t;
 199
 200 typedef struct
 201 {
 202   u32 flow_id;
 203   u16 next_index;
 204   i16 buffer_advance;
 205 } avf_flow_lookup_entry_t;
 206
 207 typedef struct
 208 {
 209   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 210   u32 flags;
 211   u32 per_interface_next_index;
 212
 213   u32 dev_instance;
 214   u32 sw_if_index;
 215   u32 hw_if_index;
 216   vlib_pci_dev_handle_t pci_dev_handle;
 217   u32 numa_node;
 218   void *bar0;
 219   u8 *name;
 220
 221   /* queues */
 222   avf_rxq_t *rxqs;
 223   avf_txq_t *txqs;
 224   u16 n_tx_queues;
 225   u16 n_rx_queues;
 226
 227   /* Admin queues */
 228   avf_aq_desc_t *atq;
 229   avf_aq_desc_t *arq;
 230   void *atq_bufs;
 231   void *arq_bufs;
 232   u64 atq_bufs_pa;
 233   u64 arq_bufs_pa;
 234   u16 atq_next_slot;
 235   u16 arq_next_slot;
 236   virtchnl_pf_event_t *events;
 237
 238   u16 vsi_id;
 239   u32 cap_flags;
 240   u8 hwaddr[6];
 241   u16 num_queue_pairs;
 242   u16 max_vectors;
 243   u16 n_rx_irqs;
 244   u16 max_mtu;
 245   u32 rss_key_size;
 246   u32 rss_lut_size;
 247   virtchnl_link_speed_t link_speed;
 248   vlib_pci_addr_t pci_addr;
 249
 250   /* flow */
 251   avf_flow_entry_t *flow_entries;               /* pool */
 252   avf_flow_lookup_entry_t *flow_lookup_entries; /* pool */
 253
 254   /* stats */
 255   virtchnl_eth_stats_t eth_stats;
 256   virtchnl_eth_stats_t last_cleared_eth_stats;
 257
 258   /* error */
 259   clib_error_t *error;
 260 } avf_device_t;
 261
 262 #define AVF_RX_VECTOR_SZ VLIB_FRAME_SIZE
 263
 264 typedef enum
 265 {
 266   AVF_PROCESS_EVENT_START = 1,
 267   AVF_PROCESS_EVENT_DELETE_IF = 2,
 268   AVF_PROCESS_EVENT_AQ_INT = 3,
 269   AVF_PROCESS_EVENT_REQ = 4,
 270 } avf_process_event_t;
 271
 272 typedef enum
 273 {
 274   AVF_PROCESS_REQ_ADD_DEL_ETH_ADDR = 1,
 275   AVF_PROCESS_REQ_CONFIG_PROMISC_MDDE = 2,
 276   AVF_PROCESS_REQ_PROGRAM_FLOW = 3,
 277 } avf_process_req_type_t;
 278
 279 typedef struct
 280 {
 281   avf_process_req_type_t type;
 282   u32 dev_instance;
 283   u32 calling_process_index;
 284   u8 eth_addr[6];
 285   int is_add, is_enable;
 286
 287   /* below parameters are used for 'program flow' event */
 288   u8 *rule;
 289   u32 rule_len;
 290   u8 *program_status;
 291   u32 status_len;
 292
 293   clib_error_t *error;
 294 } avf_process_req_t;
 295
 296 typedef struct
 297 {
 298   u64 qw1s[AVF_RX_MAX_DESC_IN_CHAIN - 1];
 299   u32 buffers[AVF_RX_MAX_DESC_IN_CHAIN - 1];
 300 } avf_rx_tail_t;
 301
 302 typedef struct
 303 {
 304   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 305   vlib_buffer_t *bufs[AVF_RX_VECTOR_SZ];
 306   u16 next[AVF_RX_VECTOR_SZ];
 307   u64 qw1s[AVF_RX_VECTOR_SZ];
 308   u32 flow_ids[AVF_RX_VECTOR_SZ];
 309   avf_rx_tail_t tails[AVF_RX_VECTOR_SZ];
 310   vlib_buffer_t buffer_template;
 311 } avf_per_thread_data_t;
 312
 313 typedef struct
 314 {
 315   u16 msg_id_base;
 316
 317   avf_device_t **devices;
 318   avf_per_thread_data_t *per_thread_data;
 319 } avf_main_t;
 320
 321 extern avf_main_t avf_main;
 322
 323 typedef struct
 324 {
 325   vlib_pci_addr_t addr;
 326   u8 *name;
 327   int enable_elog;
 328   u16 rxq_num;
 329   u16 rxq_size;
 330   u16 txq_size;
 331   /* return */
 332   int rv;
 333   u32 sw_if_index;
 334   clib_error_t *error;
 335 } avf_create_if_args_t;
 336
 337 void avf_create_if (vlib_main_t * vm, avf_create_if_args_t * args);
 338
 339 extern vlib_node_registration_t avf_input_node;
 340 extern vlib_node_registration_t avf_process_node;
 341 extern vnet_device_class_t avf_device_class;
 342
 343 clib_error_t *avf_program_flow (u32 dev_instance, int is_add, u8 *rule,
 344                                 u32 rule_len, u8 *program_status,
 345                                 u32 status_len);
 346
 347 /* format.c */
 348 format_function_t format_avf_device;
 349 format_function_t format_avf_device_name;
 350 format_function_t format_avf_input_trace;
 351 format_function_t format_avf_vf_cap_flags;
 352 vnet_flow_dev_ops_function_t avf_flow_ops_fn;
 353
 354 static_always_inline avf_device_t *
 355 avf_get_device (u32 dev_instance)
 356 {
 357   return pool_elt_at_index (avf_main.devices, dev_instance)[0];
 358 }
 359
 360 static inline u32
 361 avf_get_u32 (void *start, int offset)
 362 {
 363   return *(u32 *) (((u8 *) start) + offset);
 364 }
 365
 366 static inline u64
 367 avf_get_u64 (void *start, int offset)
 368 {
 369   return *(u64 *) (((u8 *) start) + offset);
 370 }
 371
 372 static inline u32
 373 avf_get_u32_bits (void *start, int offset, int first, int last)
 374 {
 375   u32 value = avf_get_u32 (start, offset);
 376   if ((last == 0) && (first == 31))
 377     return value;
 378   value >>= last;
 379   value &= (1 << (first - last + 1)) - 1;
 380   return value;
 381 }
 382
 383 static inline u64
 384 avf_get_u64_bits (void *start, int offset, int first, int last)
 385 {
 386   u64 value = avf_get_u64 (start, offset);
 387   if ((last == 0) && (first == 63))
 388     return value;
 389   value >>= last;
 390   value &= (1 << (first - last + 1)) - 1;
 391   return value;
 392 }
 393
 394 static inline void
 395 avf_set_u32 (void *start, int offset, u32 value)
 396 {
 397   (*(u32 *) (((u8 *) start) + offset)) = value;
 398 }
 399
 400 static inline void
 401 avf_reg_write (avf_device_t * ad, u32 addr, u32 val)
 402 {
 403   *(volatile u32 *) ((u8 *) ad->bar0 + addr) = val;
 404 }
 405
 406 static inline u32
 407 avf_reg_read (avf_device_t * ad, u32 addr)
 408 {
 409   return *(volatile u32 *) (ad->bar0 + addr);
 410 }
 411
 412 static inline void
 413 avf_reg_flush (avf_device_t * ad)
 414 {
 415   avf_reg_read (ad, AVFGEN_RSTAT);
 416   asm volatile ("":::"memory");
 417 }
 418
 419 static inline void
 420 avf_tail_write (volatile u32 *addr, u32 val)
 421 {
 422 #ifdef __MOVDIRI__
 423   _mm_sfence ();
 424   _directstoreu_u32 ((void *) addr, val);
 425 #else
 426   clib_atomic_store_rel_n (addr, val);
 427 #endif
 428 }
 429
 430 static_always_inline int
 431 avf_rxd_is_not_eop (avf_rx_desc_t * d)
 432 {
 433   return (d->qword[1] & AVF_RXD_STATUS_EOP) == 0;
 434 }
 435
 436 static_always_inline int
 437 avf_rxd_is_not_dd (avf_rx_desc_t * d)
 438 {
 439   return (d->qword[1] & AVF_RXD_STATUS_DD) == 0;
 440 }
 441
 442 typedef struct
 443 {
 444   u16 qid;
 445   u16 next_index;
 446   u32 hw_if_index;
 447   u32 flow_id;
 448   u64 qw1s[AVF_RX_MAX_DESC_IN_CHAIN];
 449 } avf_input_trace_t;
 450
 451 #define foreach_avf_tx_func_error              \
 452   _(SEGMENT_SIZE_EXCEEDED, "segment size exceeded")     \
 453   _(NO_FREE_SLOTS, "no free tx slots")
 454
 455 typedef enum
 456 {
 457 #define _(f,s) AVF_TX_ERROR_##f,
 458   foreach_avf_tx_func_error
 459 #undef _
 460     AVF_TX_N_ERROR,
 461 } avf_tx_func_error_t;
 462
 463 #endif /* AVF_H */
 464
 465 /*
 466  * fd.io coding-style-patch-verification: ON
 467  *
 468  * Local Variables:
 469  * eval: (c-set-style "gnu")
 470  * End:
 471  */