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 AVF_QUEUE_SZ_MAX                4096
  26 #define AVF_QUEUE_SZ_MIN                64
  27
  28 #define AVF_AQ_ENQ_SUSPEND_TIME         50e-6
  29 #define AVF_AQ_ENQ_MAX_WAIT_TIME        250e-3
  30
  31 #define AVF_RESET_SUSPEND_TIME          20e-3
  32 #define AVF_RESET_MAX_WAIT_TIME         1
  33
  34 #define AVF_SEND_TO_PF_SUSPEND_TIME     10e-3
  35 #define AVF_SEND_TO_PF_MAX_WAIT_TIME    1
  36
  37 #define AVF_RXD_STATUS(x)               (1ULL << x)
  38 #define AVF_RXD_STATUS_DD               AVF_RXD_STATUS(0)
  39 #define AVF_RXD_STATUS_EOP              AVF_RXD_STATUS(1)
  40 #define AVF_RXD_ERROR_SHIFT             19
  41 #define AVF_RXD_PTYPE_SHIFT             30
  42 #define AVF_RXD_LEN_SHIFT               38
  43 #define AVF_RX_MAX_DESC_IN_CHAIN        5
  44
  45 #define AVF_RXD_ERROR_IPE               (1ULL << (AVF_RXD_ERROR_SHIFT + 3))
  46 #define AVF_RXD_ERROR_L4E               (1ULL << (AVF_RXD_ERROR_SHIFT + 4))
  47
  48 #define AVF_TXD_CMD(x)                  (1 << (x + 4))
  49 #define AVF_TXD_CMD_EOP                 AVF_TXD_CMD(0)
  50 #define AVF_TXD_CMD_RS                  AVF_TXD_CMD(1)
  51 #define AVF_TXD_CMD_RSV                 AVF_TXD_CMD(2)
  52
  53 extern vlib_log_class_registration_t avf_log;
  54
  55 #define avf_log_err(dev, f, ...)                        \
  56   vlib_log (VLIB_LOG_LEVEL_ERR, avf_log.class, "%U: " f, \
  57             format_vlib_pci_addr, &dev->pci_addr, \
  58             ## __VA_ARGS__)
  59
  60 #define avf_log_warn(dev, f, ...)                        \
  61   vlib_log (VLIB_LOG_LEVEL_WARNING, avf_log.class, "%U: " f, \
  62             format_vlib_pci_addr, &dev->pci_addr, \
  63             ## __VA_ARGS__)
  64
  65 #define avf_log_debug(dev, f, ...)                        \
  66   vlib_log (VLIB_LOG_LEVEL_DEBUG, avf_log.class, "%U: " f, \
  67             format_vlib_pci_addr, &dev->pci_addr, \
  68             ## __VA_ARGS__)
  69
  70 #define foreach_avf_device_flags \
  71   _(0, INITIALIZED, "initialized") \
  72   _(1, ERROR, "error") \
  73   _(2, ADMIN_UP, "admin-up") \
  74   _(3, VA_DMA, "vaddr-dma") \
  75   _(4, LINK_UP, "link-up") \
  76   _(5, SHARED_TXQ_LOCK, "shared-txq-lock") \
  77   _(6, ELOG, "elog") \
  78   _(7, PROMISC, "promisc") \
  79   _(8, RX_INT, "rx-interrupts")
  80
  81 enum
  82 {
  83 #define _(a, b, c) AVF_DEVICE_F_##b = (1 << a),
  84   foreach_avf_device_flags
  85 #undef _
  86 };
  87
  88 typedef volatile struct
  89 {
  90   union
  91   {
  92     struct
  93     {
  94       u64 mirr:13;
  95       u64 rsv1:3;
  96       u64 l2tag1:16;
  97       u64 filter_status:32;
  98       u64 status:19;
  99       u64 error:8;
 100       u64 rsv2:3;
 101       u64 ptype:8;
 102       u64 length:26;
 103     };
 104     u64 qword[4];
 105 #ifdef CLIB_HAVE_VEC256
 106     u64x4 as_u64x4;
 107 #endif
 108   };
 109 } avf_rx_desc_t;
 110
 111 STATIC_ASSERT_SIZEOF (avf_rx_desc_t, 32);
 112
 113 typedef volatile struct
 114 {
 115   union
 116   {
 117     u64 qword[2];
 118 #ifdef CLIB_HAVE_VEC128
 119     u64x2 as_u64x2;
 120 #endif
 121   };
 122 } avf_tx_desc_t;
 123
 124 STATIC_ASSERT_SIZEOF (avf_tx_desc_t, 16);
 125
 126 typedef struct
 127 {
 128   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 129   volatile u32 *qrx_tail;
 130   u16 next;
 131   u16 size;
 132   avf_rx_desc_t *descs;
 133   u32 *bufs;
 134   u16 n_enqueued;
 135   u8 int_mode;
 136   u8 buffer_pool_index;
 137 } avf_rxq_t;
 138
 139 typedef struct
 140 {
 141   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 142   volatile u32 *qtx_tail;
 143   u16 next;
 144   u16 size;
 145   clib_spinlock_t lock;
 146   avf_tx_desc_t *descs;
 147   u32 *bufs;
 148   u16 n_enqueued;
 149   u16 *rs_slots;
 150 } avf_txq_t;
 151
 152 typedef struct
 153 {
 154   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 155   u32 flags;
 156   u32 per_interface_next_index;
 157
 158   u32 dev_instance;
 159   u32 sw_if_index;
 160   u32 hw_if_index;
 161   vlib_pci_dev_handle_t pci_dev_handle;
 162   u32 numa_node;
 163   void *bar0;
 164   u8 *name;
 165
 166   /* queues */
 167   avf_rxq_t *rxqs;
 168   avf_txq_t *txqs;
 169   u16 n_tx_queues;
 170   u16 n_rx_queues;
 171
 172   /* Admin queues */
 173   avf_aq_desc_t *atq;
 174   avf_aq_desc_t *arq;
 175   void *atq_bufs;
 176   void *arq_bufs;
 177   u64 atq_bufs_pa;
 178   u64 arq_bufs_pa;
 179   u16 atq_next_slot;
 180   u16 arq_next_slot;
 181   virtchnl_pf_event_t *events;
 182
 183   u16 vsi_id;
 184   u32 feature_bitmap;
 185   u8 hwaddr[6];
 186   u16 num_queue_pairs;
 187   u16 max_vectors;
 188   u16 n_rx_irqs;
 189   u16 max_mtu;
 190   u32 rss_key_size;
 191   u32 rss_lut_size;
 192   virtchnl_link_speed_t link_speed;
 193   vlib_pci_addr_t pci_addr;
 194
 195   /* stats */
 196   virtchnl_eth_stats_t eth_stats;
 197   virtchnl_eth_stats_t last_cleared_eth_stats;
 198
 199   /* error */
 200   clib_error_t *error;
 201 } avf_device_t;
 202
 203 #define AVF_RX_VECTOR_SZ VLIB_FRAME_SIZE
 204
 205 typedef enum
 206 {
 207   AVF_PROCESS_EVENT_START = 1,
 208   AVF_PROCESS_EVENT_DELETE_IF = 2,
 209   AVF_PROCESS_EVENT_AQ_INT = 3,
 210   AVF_PROCESS_EVENT_REQ = 4,
 211 } avf_process_event_t;
 212
 213 typedef enum
 214 {
 215   AVF_PROCESS_REQ_ADD_DEL_ETH_ADDR = 1,
 216   AVF_PROCESS_REQ_CONFIG_PROMISC_MDDE = 2,
 217 } avf_process_req_type_t;
 218
 219 typedef struct
 220 {
 221   avf_process_req_type_t type;
 222   u32 dev_instance;
 223   u32 calling_process_index;
 224   u8 eth_addr[6];
 225   int is_add, is_enable;
 226   clib_error_t *error;
 227 } avf_process_req_t;
 228
 229 typedef struct
 230 {
 231   u64 qw1s[AVF_RX_MAX_DESC_IN_CHAIN - 1];
 232   u32 buffers[AVF_RX_MAX_DESC_IN_CHAIN - 1];
 233 } avf_rx_tail_t;
 234
 235 typedef struct
 236 {
 237   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 238   vlib_buffer_t *bufs[AVF_RX_VECTOR_SZ];
 239   u64 qw1s[AVF_RX_VECTOR_SZ];
 240   avf_rx_tail_t tails[AVF_RX_VECTOR_SZ];
 241   vlib_buffer_t buffer_template;
 242 } avf_per_thread_data_t;
 243
 244 typedef struct
 245 {
 246   u16 msg_id_base;
 247
 248   avf_device_t **devices;
 249   avf_per_thread_data_t *per_thread_data;
 250 } avf_main_t;
 251
 252 extern avf_main_t avf_main;
 253
 254 typedef struct
 255 {
 256   vlib_pci_addr_t addr;
 257   u8 *name;
 258   int enable_elog;
 259   u16 rxq_num;
 260   u16 rxq_size;
 261   u16 txq_size;
 262   /* return */
 263   int rv;
 264   u32 sw_if_index;
 265   clib_error_t *error;
 266 } avf_create_if_args_t;
 267
 268 void avf_create_if (vlib_main_t * vm, avf_create_if_args_t * args);
 269
 270 extern vlib_node_registration_t avf_input_node;
 271 extern vlib_node_registration_t avf_process_node;
 272 extern vnet_device_class_t avf_device_class;
 273
 274 /* format.c */
 275 format_function_t format_avf_device;
 276 format_function_t format_avf_device_name;
 277 format_function_t format_avf_input_trace;
 278
 279 static_always_inline avf_device_t *
 280 avf_get_device (u32 dev_instance)
 281 {
 282   return pool_elt_at_index (avf_main.devices, dev_instance)[0];
 283 }
 284
 285 static inline u32
 286 avf_get_u32 (void *start, int offset)
 287 {
 288   return *(u32 *) (((u8 *) start) + offset);
 289 }
 290
 291 static inline u64
 292 avf_get_u64 (void *start, int offset)
 293 {
 294   return *(u64 *) (((u8 *) start) + offset);
 295 }
 296
 297 static inline u32
 298 avf_get_u32_bits (void *start, int offset, int first, int last)
 299 {
 300   u32 value = avf_get_u32 (start, offset);
 301   if ((last == 0) && (first == 31))
 302     return value;
 303   value >>= last;
 304   value &= (1 << (first - last + 1)) - 1;
 305   return value;
 306 }
 307
 308 static inline u64
 309 avf_get_u64_bits (void *start, int offset, int first, int last)
 310 {
 311   u64 value = avf_get_u64 (start, offset);
 312   if ((last == 0) && (first == 63))
 313     return value;
 314   value >>= last;
 315   value &= (1 << (first - last + 1)) - 1;
 316   return value;
 317 }
 318
 319 static inline void
 320 avf_set_u32 (void *start, int offset, u32 value)
 321 {
 322   (*(u32 *) (((u8 *) start) + offset)) = value;
 323 }
 324
 325 static inline void
 326 avf_reg_write (avf_device_t * ad, u32 addr, u32 val)
 327 {
 328   *(volatile u32 *) ((u8 *) ad->bar0 + addr) = val;
 329 }
 330
 331 static inline u32
 332 avf_reg_read (avf_device_t * ad, u32 addr)
 333 {
 334   return *(volatile u32 *) (ad->bar0 + addr);
 335 }
 336
 337 static inline void
 338 avf_reg_flush (avf_device_t * ad)
 339 {
 340   avf_reg_read (ad, AVFGEN_RSTAT);
 341   asm volatile ("":::"memory");
 342 }
 343
 344 static_always_inline int
 345 avf_rxd_is_not_eop (avf_rx_desc_t * d)
 346 {
 347   return (d->qword[1] & AVF_RXD_STATUS_EOP) == 0;
 348 }
 349
 350 static_always_inline int
 351 avf_rxd_is_not_dd (avf_rx_desc_t * d)
 352 {
 353   return (d->qword[1] & AVF_RXD_STATUS_DD) == 0;
 354 }
 355
 356 typedef struct
 357 {
 358   u16 qid;
 359   u16 next_index;
 360   u32 hw_if_index;
 361   u64 qw1s[AVF_RX_MAX_DESC_IN_CHAIN];
 362 } avf_input_trace_t;
 363
 364 #define foreach_avf_tx_func_error              \
 365   _(SEGMENT_SIZE_EXCEEDED, "segment size exceeded")     \
 366   _(NO_FREE_SLOTS, "no free tx slots")
 367
 368 typedef enum
 369 {
 370 #define _(f,s) AVF_TX_ERROR_##f,
 371   foreach_avf_tx_func_error
 372 #undef _
 373     AVF_TX_N_ERROR,
 374 } avf_tx_func_error_t;
 375
 376 #endif /* AVF_H */
 377
 378 /*
 379  * fd.io coding-style-patch-verification: ON
 380  *
 381  * Local Variables:
 382  * eval: (c-set-style "gnu")
 383  * End:
 384  */