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