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