FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
avf.h
Go to the documentation of this file.
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),
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;
91  u64 status:19;
93  u64 rsv2:3;
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 
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 
118 
119 typedef struct
120 {
121  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
122  volatile u32 *qrx_tail;
130 } avf_rxq_t;
131 
132 typedef struct
133 {
134  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
135  volatile u32 *qtx_tail;
143 } avf_txq_t;
144 
145 typedef struct
146 {
147  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
150 
156  void *bar0;
158 
159  /* queues */
164 
165  /* Admin queues */
168  void *atq_bufs;
169  void *arq_bufs;
175 
178  u8 hwaddr[6];
185  vlib_pci_addr_t pci_addr;
186 
187  /* stats */
190 
191  /* error */
193 } avf_device_t;
194 
195 #define AVF_RX_VECTOR_SZ VLIB_FRAME_SIZE
196 
197 typedef enum
198 {
203 
204 typedef struct
205 {
208 } avf_rx_tail_t;
209 
210 typedef struct
211 {
212  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
218 
219 typedef struct
220 {
222 
225 
227 } avf_main_t;
228 
229 extern avf_main_t avf_main;
230 
231 typedef struct
232 {
233  vlib_pci_addr_t addr;
239  /* return */
240  int rv;
244 
247 
250 
251 /* format.c */
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
298 {
299  *(volatile u32 *) ((u8 *) ad->bar0 + addr) = val;
300 }
301 
302 static inline u32
304 {
305  return *(volatile u32 *) (ad->bar0 + addr);
306 }
307 
308 static inline void
310 {
312  asm volatile ("":::"memory");
313 }
314 
317 {
318  return (d->qword[1] & AVF_RXD_STATUS_EOP) == 0;
319 }
320 
323 {
324  return (d->qword[1] & AVF_RXD_STATUS_DD) == 0;
325 }
326 
327 typedef struct
328 {
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,
343 #undef _
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  */
u8 int_mode
Definition: avf.h:128
u32 hw_if_index
Definition: avf.h:153
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
static u64 avf_get_u64_bits(void *start, int offset, int first, int last)
Definition: avf.h:280
clib_error_t * error
Definition: avf.h:192
u64 mirr
Definition: avf.h:87
u64 atq_bufs_pa
Definition: avf.h:170
unsigned long u64
Definition: types.h:89
virtchnl_link_speed_t link_speed
Definition: avf.h:184
static u64 avf_get_u64(void *start, int offset)
Definition: avf.h:263
static heap_elt_t * last(heap_header_t *h)
Definition: heap.c:53
format_function_t format_avf_device
Definition: avf.h:252
vlib_pci_addr_t addr
Definition: avf.h:233
u32 dev_instance
Definition: avf.h:151
virtchnl_link_speed_t
Definition: virtchnl.h:205
#define AVF_RXD_STATUS_DD
Definition: avf.h:35
avf_device_t * devices
Definition: avf.h:223
struct _vnet_device_class vnet_device_class_t
format_function_t format_avf_input_trace
Definition: avf.h:254
vhost_vring_addr_t addr
Definition: vhost_user.h:147
volatile u32 * qtx_tail
Definition: avf.h:135
#define foreach_avf_device_flags
Definition: avf.h:65
unsigned char u8
Definition: types.h:56
vnet_device_class_t avf_device_class
u8 buffer_pool_index
Definition: avf.h:129
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
u32 vlib_log_class_t
Definition: vlib.h:51
u16 * rs_slots
Definition: avf.h:142
#define static_always_inline
Definition: clib.h:99
clib_spinlock_t lock
Definition: avf.h:138
static u32 avf_reg_read(avf_device_t *ad, u32 addr)
Definition: avf.h:303
static u32 avf_get_u32_bits(void *start, int offset, int first, int last)
Definition: avf.h:269
volatile u32 * qrx_tail
Definition: avf.h:122
unsigned int u32
Definition: types.h:88
vlib_pci_dev_handle_t pci_dev_handle
Definition: avf.h:154
void * arq_bufs
Definition: avf.h:169
avf_aq_desc_t * arq
Definition: avf.h:167
epu8_epi32 epu16_epi32 u64x2
Definition: vector_sse42.h:674
void avf_create_if(vlib_main_t *vm, avf_create_if_args_t *args)
Definition: device.c:1322
static heap_elt_t * first(heap_header_t *h)
Definition: heap.c:59
u16 next_index
Definition: avf.h:330
u32 hw_if_index
Definition: avf.h:331
u8 * name
Definition: avf.h:157
virtchnl_eth_stats_t last_cleared_eth_stats
Definition: avf.h:189
static u32 avf_get_u32(void *start, int offset)
Definition: avf.h:257
unsigned short u16
Definition: types.h:57
u64 qword[4]
Definition: avf.h:97
#define AVF_RX_VECTOR_SZ
Definition: avf.h:195
static void avf_reg_flush(avf_device_t *ad)
Definition: avf.h:309
u32 vlib_pci_dev_handle_t
Definition: pci.h:97
#define AVF_RXD_STATUS_EOP
Definition: avf.h:36
vlib_main_t * vm
Definition: in2out_ed.c:1810
u16 n_rx_queues
Definition: avf.h:163
u16 atq_next_slot
Definition: avf.h:172
u32 numa_node
Definition: avf.h:155
vlib_node_registration_t avf_input_node
(constructor) VLIB_REGISTER_NODE (avf_input_node)
Definition: input.c:463
static_always_inline int avf_rxd_is_not_dd(avf_rx_desc_t *d)
Definition: avf.h:322
u64 length
Definition: avf.h:95
avf_tx_func_error_t
Definition: avf.h:339
Definition: avf.h:119
u64 l2tag1
Definition: avf.h:89
vlib_log_class_t log_class
Definition: avf.h:226
avf_tx_desc_t * descs
Definition: avf.h:139
u64 status
Definition: avf.h:91
u64 rsv1
Definition: avf.h:88
u64 filter_status
Definition: avf.h:90
u16 vsi_id
Definition: avf.h:176
u32 per_interface_next_index
Definition: avf.h:149
u32 feature_bitmap
Definition: avf.h:177
u32 * bufs
Definition: avf.h:140
u8 value
Definition: qos.api:54
avf_aq_desc_t * atq
Definition: avf.h:166
u32 flags
Definition: avf.h:148
Definition: avf.h:132
static void avf_set_u32(void *start, int offset, u32 value)
Definition: avf.h:291
u32 * bufs
Definition: avf.h:126
void * bar0
Definition: avf.h:156
vlib_buffer_t buffer_template
Definition: avf.h:216
u16 n_enqueued
Definition: avf.h:141
u16 n_enqueued
Definition: avf.h:127
virtchnl_pf_event_t * events
Definition: avf.h:174
static void avf_reg_write(avf_device_t *ad, u32 addr, u32 val)
Definition: avf.h:297
avf_main_t avf_main
Definition: device.c:37
virtchnl_eth_stats_t eth_stats
Definition: avf.h:188
void * atq_bufs
Definition: avf.h:168
#define AVFGEN_RSTAT
Definition: virtchnl.h:49
u16 msg_id_base
Definition: avf.h:221
u16 num_queue_pairs
Definition: avf.h:179
u16 next
Definition: avf.h:136
struct _vlib_node_registration vlib_node_registration_t
template key/value backing page structure
Definition: bihash_doc.h:44
avf_process_event_t
Definition: avf.h:197
void avf_delete_if(vlib_main_t *vm, avf_device_t *ad)
Definition: device.c:1265
u32 rss_lut_size
Definition: avf.h:183
u16 n_tx_queues
Definition: avf.h:162
format_function_t format_avf_device_name
Definition: avf.h:253
VLIB buffer representation.
Definition: buffer.h:102
#define foreach_avf_tx_func_error
Definition: avf.h:335
u16 size
Definition: avf.h:124
u16 arq_next_slot
Definition: avf.h:173
avf_rxq_t * rxqs
Definition: avf.h:160
u64 error
Definition: avf.h:92
struct clib_bihash_value offset
template key/value backing page structure
u64x4
Definition: vector_avx2.h:121
clib_error_t * error
Definition: avf.h:242
avf_per_thread_data_t * per_thread_data
Definition: avf.h:224
u16 size
Definition: avf.h:137
vlib_pci_addr_t pci_addr
Definition: avf.h:185
u32 sw_if_index
Definition: avf.h:152
u64 rsv2
Definition: avf.h:93
u64 arq_bufs_pa
Definition: avf.h:171
u64 ptype
Definition: avf.h:94
static_always_inline int avf_rxd_is_not_eop(avf_rx_desc_t *d)
Definition: avf.h:316
STATIC_ASSERT_SIZEOF(avf_rx_desc_t, 32)
#define AVF_RX_MAX_DESC_IN_CHAIN
Definition: avf.h:40
u16 next
Definition: avf.h:123
avf_txq_t * txqs
Definition: avf.h:161
avf_rx_desc_t * descs
Definition: avf.h:125
u16 max_vectors
Definition: avf.h:180
u32 rss_key_size
Definition: avf.h:182
u16 max_mtu
Definition: avf.h:181