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