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