avf.h revision c33eddeb
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
68enum
69{
70#define _(a, b, c) AVF_DEVICE_F_##b = (1 << a),
71  foreach_avf_device_flags
72#undef _
73};
74
75typedef 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  };
96} avf_rx_desc_t;
97
98STATIC_ASSERT_SIZEOF (avf_rx_desc_t, 32);
99
100typedef 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
111STATIC_ASSERT_SIZEOF (avf_tx_desc_t, 16);
112
113typedef struct
114{
115  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
116  volatile u32 *qrx_tail;
117  u16 next;
118  u16 size;
119  avf_rx_desc_t *descs;
120  u32 *bufs;
121  u16 n_enqueued;
122  u8 int_mode;
123  u8 buffer_pool_index;
124} avf_rxq_t;
125
126typedef struct
127{
128  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
129  volatile u32 *qtx_tail;
130  u16 next;
131  u16 size;
132  clib_spinlock_t lock;
133  avf_tx_desc_t *descs;
134  u32 *bufs;
135  u16 n_enqueued;
136  u16 *rs_slots;
137} avf_txq_t;
138
139typedef struct
140{
141  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
142  u32 flags;
143  u32 per_interface_next_index;
144
145  u32 dev_instance;
146  u32 sw_if_index;
147  u32 hw_if_index;
148  vlib_pci_dev_handle_t pci_dev_handle;
149  u32 numa_node;
150  void *bar0;
151  u8 *name;
152
153  /* queues */
154  avf_rxq_t *rxqs;
155  avf_txq_t *txqs;
156  u16 n_tx_queues;
157  u16 n_rx_queues;
158
159  /* Admin queues */
160  avf_aq_desc_t *atq;
161  avf_aq_desc_t *arq;
162  void *atq_bufs;
163  void *arq_bufs;
164  u64 atq_bufs_pa;
165  u64 arq_bufs_pa;
166  u16 atq_next_slot;
167  u16 arq_next_slot;
168  virtchnl_pf_event_t *events;
169
170  u16 vsi_id;
171  u32 feature_bitmap;
172  u8 hwaddr[6];
173  u16 num_queue_pairs;
174  u16 max_vectors;
175  u16 max_mtu;
176  u32 rss_key_size;
177  u32 rss_lut_size;
178  virtchnl_link_speed_t link_speed;
179  vlib_pci_addr_t pci_addr;
180
181  /* stats */
182  virtchnl_eth_stats_t eth_stats;
183  virtchnl_eth_stats_t last_cleared_eth_stats;
184
185  /* error */
186  clib_error_t *error;
187} avf_device_t;
188
189#define AVF_RX_VECTOR_SZ VLIB_FRAME_SIZE
190
191typedef enum
192{
193  AVF_PROCESS_EVENT_START = 1,
194  AVF_PROCESS_EVENT_STOP = 2,
195  AVF_PROCESS_EVENT_AQ_INT = 3,
196} avf_process_event_t;
197
198typedef struct
199{
200  u64 qw1s[AVF_RX_MAX_DESC_IN_CHAIN - 1];
201  u32 buffers[AVF_RX_MAX_DESC_IN_CHAIN - 1];
202} avf_rx_tail_t;
203
204typedef struct
205{
206  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
207  vlib_buffer_t *bufs[AVF_RX_VECTOR_SZ];
208  u64 qw1s[AVF_RX_VECTOR_SZ];
209  avf_rx_tail_t tails[AVF_RX_VECTOR_SZ];
210  vlib_buffer_t buffer_template;
211} avf_per_thread_data_t;
212
213typedef struct
214{
215  u16 msg_id_base;
216
217  avf_device_t *devices;
218  avf_per_thread_data_t *per_thread_data;
219
220  vlib_log_class_t log_class;
221} avf_main_t;
222
223extern avf_main_t avf_main;
224
225typedef struct
226{
227  vlib_pci_addr_t addr;
228  u8 *name;
229  int enable_elog;
230  u16 rxq_num;
231  u16 rxq_size;
232  u16 txq_size;
233  /* return */
234  int rv;
235  u32 sw_if_index;
236  clib_error_t *error;
237} avf_create_if_args_t;
238
239void avf_create_if (vlib_main_t * vm, avf_create_if_args_t * args);
240void avf_delete_if (vlib_main_t * vm, avf_device_t * ad);
241
242extern vlib_node_registration_t avf_input_node;
243extern vnet_device_class_t avf_device_class;
244
245/* format.c */
246format_function_t format_avf_device;
247format_function_t format_avf_device_name;
248format_function_t format_avf_input_trace;
249
250static inline u32
251avf_get_u32 (void *start, int offset)
252{
253  return *(u32 *) (((u8 *) start) + offset);
254}
255
256static inline u64
257avf_get_u64 (void *start, int offset)
258{
259  return *(u64 *) (((u8 *) start) + offset);
260}
261
262static inline u32
263avf_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
273static inline u64
274avf_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
284static inline void
285avf_set_u32 (void *start, int offset, u32 value)
286{
287  (*(u32 *) (((u8 *) start) + offset)) = value;
288}
289
290static inline void
291avf_reg_write (avf_device_t * ad, u32 addr, u32 val)
292{
293  *(volatile u32 *) ((u8 *) ad->bar0 + addr) = val;
294}
295
296static inline u32
297avf_reg_read (avf_device_t * ad, u32 addr)
298{
299  return *(volatile u32 *) (ad->bar0 + addr);
300}
301
302static inline void
303avf_reg_flush (avf_device_t * ad)
304{
305  avf_reg_read (ad, AVFGEN_RSTAT);
306  asm volatile ("":::"memory");
307}
308
309static_always_inline int
310avf_rxd_is_not_eop (avf_rx_desc_t * d)
311{
312  return (d->qword[1] & AVF_RXD_STATUS_EOP) == 0;
313}
314
315static_always_inline int
316avf_rxd_is_not_dd (avf_rx_desc_t * d)
317{
318  return (d->qword[1] & AVF_RXD_STATUS_DD) == 0;
319}
320
321typedef struct
322{
323  u16 qid;
324  u16 next_index;
325  u32 hw_if_index;
326  u64 qw1s[AVF_RX_MAX_DESC_IN_CHAIN];
327} avf_input_trace_t;
328
329#define foreach_avf_tx_func_error	       \
330_(NO_FREE_SLOTS, "no free tx slots")
331
332typedef enum
333{
334#define _(f,s) AVF_TX_ERROR_##f,
335  foreach_avf_tx_func_error
336#undef _
337    AVF_TX_N_ERROR,
338} avf_tx_func_error_t;
339
340#endif /* AVF_H */
341
342/*
343 * fd.io coding-style-patch-verification: ON
344 *
345 * Local Variables:
346 * eval: (c-set-style "gnu")
347 * End:
348 */
349