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