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