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