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