dev: caps and rx/tx offload support
[vpp.git] / src / vnet / dev / dev.h
1 /* SPDX-License-Identifier: Apache-2.0
2  * Copyright (c) 2023 Cisco Systems, Inc.
3  */
4
5 #ifndef _VNET_DEV_H_
6 #define _VNET_DEV_H_
7
8 #include <vppinfra/clib.h>
9 #include <vppinfra/error_bootstrap.h>
10 #include <vppinfra/format.h>
11 #include <vnet/vnet.h>
12 #include <vnet/dev/types.h>
13 #include <vnet/dev/args.h>
14
15 #define VNET_DEV_DEVICE_ID_PREFIX_DELIMITER "/"
16
17 #define foreach_vnet_dev_port_type                                            \
18   _ (0, UNKNOWN)                                                              \
19   _ (1, ETHERNET)
20
21 typedef enum
22 {
23 #define _(b, n) VNET_DEV_PORT_TYPE_##n = (1U << (b)),
24   foreach_vnet_dev_port_type
25 #undef _
26 } vnet_dev_port_type_t;
27
28 #define foreach_vnet_dev_port_caps                                            \
29   _ (interrupt_mode)                                                          \
30   _ (rss)                                                                     \
31   _ (change_max_rx_frame_size)                                                \
32   _ (mac_filter)
33
34 #define foreach_vnet_dev_port_rx_offloads _ (ip4_cksum)
35
36 #define foreach_vnet_dev_port_tx_offloads                                     \
37   _ (ip4_cksum)                                                               \
38   _ (tcp_gso)                                                                 \
39   _ (udp_gso)
40
41 typedef union
42 {
43   struct
44   {
45 #define _(n) u8 n : 1;
46     foreach_vnet_dev_port_caps
47 #undef _
48   };
49   u8 as_number;
50 } vnet_dev_port_caps_t;
51
52 typedef union
53 {
54   struct
55   {
56 #define _(n) u8 n : 1;
57     foreach_vnet_dev_port_rx_offloads
58 #undef _
59   };
60   u8 as_number;
61 } vnet_dev_port_rx_offloads_t;
62
63 typedef union
64 {
65   struct
66   {
67 #define _(n) u8 n : 1;
68     foreach_vnet_dev_port_tx_offloads
69 #undef _
70   };
71   u8 as_number;
72 } vnet_dev_port_tx_offloads_t;
73
74 typedef union
75 {
76   u8 eth_mac[6];
77   u8 raw[8];
78 } vnet_dev_hw_addr_t;
79
80 typedef struct vnet_dev_bus_registration vnet_dev_bus_registration_t;
81 typedef struct vnet_dev_driver_registration vnet_dev_driver_registration_t;
82
83 typedef struct vnet_dev vnet_dev_t;
84 typedef struct vnet_dev_port vnet_dev_port_t;
85 typedef struct vnet_dev_rx_queue vnet_dev_rx_queue_t;
86 typedef struct vnet_dev_tx_queue vnet_dev_tx_queue_t;
87 typedef struct vnet_dev_bus_registration vnet_dev_bus_registration_t;
88 typedef struct vnet_dev_driver_registration vnet_dev_driver_registration_t;
89 typedef struct vnet_dev_counter vnet_dev_counter_t;
90 typedef struct vnet_dev_counter_main vnet_dev_counter_main_t;
91 typedef struct vnet_dev_port_cfg_change_req vnet_dev_port_cfg_change_req_t;
92
93 typedef vnet_dev_rv_t (vnet_dev_op_t) (vlib_main_t *, vnet_dev_t *);
94 typedef vnet_dev_rv_t (vnet_dev_port_op_t) (vlib_main_t *, vnet_dev_port_t *);
95 typedef vnet_dev_rv_t (vnet_dev_port_cfg_change_op_t) (
96   vlib_main_t *, vnet_dev_port_t *, vnet_dev_port_cfg_change_req_t *);
97 typedef vnet_dev_rv_t (vnet_dev_rx_queue_op_t) (vlib_main_t *,
98                                                 vnet_dev_rx_queue_t *);
99 typedef vnet_dev_rv_t (vnet_dev_tx_queue_op_t) (vlib_main_t *,
100                                                 vnet_dev_tx_queue_t *);
101 typedef void (vnet_dev_op_no_rv_t) (vlib_main_t *, vnet_dev_t *);
102 typedef void (vnet_dev_port_op_no_rv_t) (vlib_main_t *, vnet_dev_port_t *);
103 typedef void (vnet_dev_rx_queue_op_no_rv_t) (vlib_main_t *,
104                                              vnet_dev_rx_queue_t *);
105 typedef void (vnet_dev_tx_queue_op_no_rv_t) (vlib_main_t *,
106                                              vnet_dev_tx_queue_t *);
107
108 typedef u16 vnet_dev_queue_id_t;
109 typedef u16 vnet_dev_bus_index_t;
110 typedef u16 vnet_dev_driver_index_t;
111
112 typedef struct
113 {
114   vnet_dev_rx_queue_op_t *alloc;
115   vnet_dev_rx_queue_op_t *start;
116   vnet_dev_rx_queue_op_no_rv_t *stop;
117   vnet_dev_rx_queue_op_no_rv_t *free;
118 } vnet_dev_rx_queue_ops_t;
119
120 typedef struct
121 {
122   vnet_dev_tx_queue_op_t *alloc;
123   vnet_dev_tx_queue_op_t *start;
124   vnet_dev_tx_queue_op_no_rv_t *stop;
125   vnet_dev_tx_queue_op_no_rv_t *free;
126 } vnet_dev_tx_queue_ops_t;
127
128 typedef struct
129 {
130   u16 data_size;
131   u16 min_size;
132   u16 max_size;
133   u16 default_size;
134   u8 multiplier;
135   u8 size_is_power_of_two : 1;
136 } vnet_dev_queue_config_t;
137
138 #define foreach_vnet_dev_port_cfg_type                                        \
139   _ (PROMISC_MODE)                                                            \
140   _ (MAX_RX_FRAME_SIZE)                                                       \
141   _ (CHANGE_PRIMARY_HW_ADDR)                                                  \
142   _ (ADD_SECONDARY_HW_ADDR)                                                   \
143   _ (REMOVE_SECONDARY_HW_ADDR)                                                \
144   _ (RXQ_INTR_MODE_ENABLE)                                                    \
145   _ (RXQ_INTR_MODE_DISABLE)
146
147 typedef enum
148 {
149   VNET_DEV_PORT_CFG_UNKNOWN,
150 #define _(n) VNET_DEV_PORT_CFG_##n,
151   foreach_vnet_dev_port_cfg_type
152 #undef _
153 } __clib_packed vnet_dev_port_cfg_type_t;
154
155 typedef struct vnet_dev_port_cfg_change_req
156 {
157   vnet_dev_port_cfg_type_t type;
158   u8 validated : 1;
159   u8 all_queues : 1;
160
161   union
162   {
163     u8 promisc : 1;
164     vnet_dev_hw_addr_t addr;
165     u16 max_rx_frame_size;
166     vnet_dev_queue_id_t queue_id;
167   };
168
169 } vnet_dev_port_cfg_change_req_t;
170
171 typedef struct
172 {
173   vnet_dev_hw_addr_t hw_addr;
174   u16 max_rx_queues;
175   u16 max_tx_queues;
176   u16 max_supported_rx_frame_size;
177   vnet_dev_port_type_t type;
178   vnet_dev_port_caps_t caps;
179   vnet_dev_port_rx_offloads_t rx_offloads;
180   vnet_dev_port_tx_offloads_t tx_offloads;
181 } vnet_dev_port_attr_t;
182
183 typedef enum
184 {
185   VNET_DEV_PERIODIC_OP_TYPE_DEV = 1,
186   VNET_DEV_PERIODIC_OP_TYPE_PORT = 2,
187 } __clib_packed vnet_dev_periodic_op_type_t;
188
189 typedef struct
190 {
191   f64 interval;
192   f64 last_run;
193   vnet_dev_periodic_op_type_t type;
194   union
195   {
196     vnet_dev_t *dev;
197     vnet_dev_port_t *port;
198     void *arg;
199   };
200   union
201   {
202     vnet_dev_op_no_rv_t *dev_op;
203     vnet_dev_port_op_no_rv_t *port_op;
204     void *op;
205   };
206 } vnet_dev_periodic_op_t;
207
208 typedef struct
209 {
210   struct _vlib_node_fn_registration *registrations;
211   format_function_t *format_trace;
212   vlib_error_desc_t *error_counters;
213   u16 n_error_counters;
214 } vnet_dev_node_t;
215
216 typedef struct
217 {
218   vnet_dev_op_t *alloc;
219   vnet_dev_op_t *init;
220   vnet_dev_op_no_rv_t *deinit;
221   vnet_dev_op_t *reset;
222   vnet_dev_op_no_rv_t *free;
223   u8 *(*probe) (vlib_main_t *, vnet_dev_bus_index_t, void *);
224   format_function_t *format_info;
225 } vnet_dev_ops_t;
226
227 typedef struct
228 {
229   vnet_dev_port_op_t *alloc;
230   vnet_dev_port_op_t *init;
231   vnet_dev_port_cfg_change_op_t *config_change;
232   vnet_dev_port_cfg_change_op_t *config_change_validate;
233   vnet_dev_port_op_t *start;
234   vnet_dev_port_op_no_rv_t *stop;
235   vnet_dev_port_op_no_rv_t *deinit;
236   vnet_dev_port_op_no_rv_t *free;
237   format_function_t *format_status;
238 } vnet_dev_port_ops_t;
239
240 typedef union
241 {
242   struct
243   {
244     u8 update_next_index : 1;
245     u8 update_feature_arc : 1;
246     u8 suspend_off : 1;
247     u8 suspend_on : 1;
248   };
249   u8 as_number;
250 } vnet_dev_rx_queue_rt_req_t;
251
252 typedef struct vnet_dev_rx_queue
253 {
254   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
255   vnet_dev_port_t *port;
256   u16 rx_thread_index;
257   u16 index;
258   vnet_dev_counter_main_t *counter_main;
259   CLIB_CACHE_LINE_ALIGN_MARK (runtime0);
260   vnet_dev_rx_queue_t *next_on_thread;
261   u8 interrupt_mode : 1;
262   u8 enabled : 1;
263   u8 started : 1;
264   u8 suspended : 1;
265   vnet_dev_queue_id_t queue_id;
266   u16 size;
267   u16 next_index;
268   vnet_dev_rx_queue_rt_req_t runtime_request;
269   CLIB_CACHE_LINE_ALIGN_MARK (runtime1);
270   vlib_buffer_template_t buffer_template;
271   CLIB_CACHE_LINE_ALIGN_MARK (driver_data);
272   u8 data[];
273 } vnet_dev_rx_queue_t;
274
275 STATIC_ASSERT_SIZEOF (vnet_dev_rx_queue_t, 3 * CLIB_CACHE_LINE_BYTES);
276
277 typedef struct vnet_dev_tx_queue
278 {
279   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
280   vnet_dev_port_t *port;
281   clib_bitmap_t *assigned_threads;
282   u16 index;
283   vnet_dev_counter_main_t *counter_main;
284   CLIB_CACHE_LINE_ALIGN_MARK (runtime0);
285   vnet_dev_queue_id_t queue_id;
286   u8 started : 1;
287   u8 enabled : 1;
288   u8 lock_needed : 1;
289   u8 lock;
290   u16 size;
291   CLIB_ALIGN_MARK (private_data, 16);
292   u8 data[];
293 } vnet_dev_tx_queue_t;
294
295 STATIC_ASSERT_SIZEOF (vnet_dev_tx_queue_t, 2 * CLIB_CACHE_LINE_BYTES);
296
297 typedef struct vnet_dev_port
298 {
299   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
300   vnet_dev_t *dev;
301   vnet_dev_port_id_t port_id;
302   vnet_dev_driver_index_t driver_index;
303   u8 initialized : 1;
304   u8 started : 1;
305   u8 link_up : 1;
306   u8 promisc : 1;
307   u8 interface_created : 1;
308   u8 rx_node_assigned : 1;
309   vnet_dev_counter_main_t *counter_main;
310   vnet_dev_queue_config_t rx_queue_config;
311   vnet_dev_queue_config_t tx_queue_config;
312   vnet_dev_port_attr_t attr;
313   u32 max_rx_frame_size;
314   vnet_dev_hw_addr_t primary_hw_addr;
315   vnet_dev_hw_addr_t *secondary_hw_addr;
316   u32 index;
317   u32 speed;
318   vnet_dev_rx_queue_t **rx_queues;
319   vnet_dev_tx_queue_t **tx_queues;
320   vnet_dev_port_ops_t port_ops;
321   vnet_dev_arg_t *args;
322   vnet_dev_rx_queue_ops_t rx_queue_ops;
323   vnet_dev_tx_queue_ops_t tx_queue_ops;
324   vnet_dev_node_t rx_node;
325   vnet_dev_node_t tx_node;
326
327   struct
328   {
329     vnet_dev_if_name_t name;
330     u32 dev_instance;
331     u32 rx_node_index;
332     u32 current_config_index;
333     u16 rx_next_index;
334     u16 redirect_to_node_next_index;
335     u8 feature_arc_index;
336     u8 feature_arc : 1;
337     u8 redirect_to_node : 1;
338     u8 default_is_intr_mode : 1;
339     u32 tx_node_index;
340     u32 hw_if_index;
341     u32 sw_if_index;
342     u16 num_rx_queues;
343     u16 num_tx_queues;
344     u16 txq_sz;
345     u16 rxq_sz;
346   } intf;
347
348   CLIB_CACHE_LINE_ALIGN_MARK (data0);
349   u8 data[];
350 } vnet_dev_port_t;
351
352 typedef struct vnet_dev
353 {
354   vnet_dev_device_id_t device_id;
355   u16 initialized : 1;
356   u16 not_first_init : 1;
357   u16 va_dma : 1;
358   u16 process_node_quit : 1;
359   u16 process_node_periodic : 1;
360   u16 poll_stats : 1;
361   u16 bus_index;
362   u8 numa_node;
363   u16 max_rx_queues;
364   u16 max_tx_queues;
365   vnet_dev_driver_index_t driver_index;
366   u32 index;
367   u32 process_node_index;
368   u8 bus_data[32] __clib_aligned (16);
369   vnet_dev_ops_t ops;
370   vnet_dev_port_t **ports;
371   vnet_dev_periodic_op_t *periodic_ops;
372   u8 *description;
373   vnet_dev_arg_t *args;
374   u8 __clib_aligned (16)
375   data[];
376 } vnet_dev_t;
377
378 typedef struct
379 {
380   u16 vendor_id, device_id;
381   char *description;
382 } vnet_dev_match_t;
383
384 #define VNET_DEV_MATCH(...)                                                   \
385   (vnet_dev_match_t[])                                                        \
386   {                                                                           \
387     __VA_ARGS__, {}                                                           \
388   }
389
390 typedef struct
391 {
392   vnet_dev_op_t *device_open;
393   vnet_dev_op_no_rv_t *device_close;
394   vnet_dev_rv_t (*dma_mem_alloc_fn) (vlib_main_t *, vnet_dev_t *, u32, u32,
395                                      void **);
396   void (*dma_mem_free_fn) (vlib_main_t *, vnet_dev_t *, void *);
397   void *(*get_device_info) (vlib_main_t *, char *);
398   void (*free_device_info) (vlib_main_t *, void *);
399   format_function_t *format_device_info;
400   format_function_t *format_device_addr;
401 } vnet_dev_bus_ops_t;
402
403 struct vnet_dev_bus_registration
404 {
405   vnet_dev_bus_registration_t *next_registration;
406   vnet_dev_driver_name_t name;
407   u16 device_data_size;
408   vnet_dev_bus_ops_t ops;
409 };
410
411 struct vnet_dev_driver_registration
412 {
413   vnet_dev_driver_registration_t *next_registration;
414   u8 bus_master_enable : 1;
415   vnet_dev_driver_name_t name;
416   vnet_dev_bus_name_t bus;
417   u16 device_data_sz;
418   u16 runtime_temp_space_sz;
419   vnet_dev_match_t *match;
420   int priority;
421   vnet_dev_ops_t ops;
422   vnet_dev_arg_t *args;
423 };
424
425 typedef struct
426 {
427   u32 index;
428   vnet_dev_bus_registration_t *registration;
429   vnet_dev_bus_ops_t ops;
430 } vnet_dev_bus_t;
431
432 typedef struct
433 {
434   u32 index;
435   void *dev_data;
436   vnet_dev_driver_registration_t *registration;
437   u32 dev_class_index;
438   vnet_dev_bus_index_t bus_index;
439   vnet_dev_ops_t ops;
440 } vnet_dev_driver_t;
441
442 typedef struct
443 {
444   vnet_dev_bus_t *buses;
445   vnet_dev_driver_t *drivers;
446   vnet_dev_t **devices;
447   vnet_dev_port_t **ports_by_dev_instance;
448   vnet_dev_bus_registration_t *bus_registrations;
449   vnet_dev_driver_registration_t *driver_registrations;
450   void *runtime_temp_spaces;
451   u32 log2_runtime_temp_space_sz;
452   u32 *free_process_node_indices;
453   u32 *free_rx_node_indices;
454   uword *device_index_by_id;
455
456   u8 *startup_config;
457   u16 next_rx_queue_thread;
458   u8 eth_port_rx_feature_arc_index;
459 } vnet_dev_main_t;
460
461 extern vnet_dev_main_t vnet_dev_main;
462
463 typedef struct
464 {
465   struct
466   {
467     vnet_dev_port_attr_t attr;
468     vnet_dev_port_ops_t ops;
469     vnet_dev_arg_t *args;
470     u16 data_size;
471     void *initial_data;
472   } port;
473
474   vnet_dev_node_t *rx_node;
475   vnet_dev_node_t *tx_node;
476
477   struct
478   {
479     vnet_dev_queue_config_t config;
480     vnet_dev_rx_queue_ops_t ops;
481   } rx_queue;
482
483   struct
484   {
485     vnet_dev_queue_config_t config;
486     vnet_dev_tx_queue_ops_t ops;
487   } tx_queue;
488 } vnet_dev_port_add_args_t;
489
490 typedef struct
491 {
492   union
493   {
494     struct
495     {
496       u8 link_speed : 1;
497       u8 link_state : 1;
498       u8 link_duplex : 1;
499     };
500     u8 any;
501   } change;
502   u8 link_state : 1;
503   u8 full_duplex : 1;
504   u32 link_speed;
505 } vnet_dev_port_state_changes_t;
506
507 /* args.c */
508 vnet_dev_rv_t vnet_dev_arg_parse (vlib_main_t *, vnet_dev_t *,
509                                   vnet_dev_arg_t *, u8 *);
510 void vnet_dev_arg_free (vnet_dev_arg_t **);
511 void vnet_dev_arg_clear_value (vnet_dev_arg_t *);
512 format_function_t format_vnet_dev_arg_type;
513 format_function_t format_vnet_dev_arg_value;
514 format_function_t format_vnet_dev_args;
515
516 /* dev.c */
517 vnet_dev_t *vnet_dev_alloc (vlib_main_t *, vnet_dev_device_id_t,
518                             vnet_dev_driver_t *);
519 void vnet_dev_free (vlib_main_t *, vnet_dev_t *);
520 vnet_dev_rv_t vnet_dev_init (vlib_main_t *, vnet_dev_t *);
521 void vnet_dev_deinit (vlib_main_t *, vnet_dev_t *);
522 vnet_dev_rv_t vnet_dev_reset (vlib_main_t *, vnet_dev_t *);
523 void vnet_dev_detach (vlib_main_t *, vnet_dev_t *);
524 vnet_dev_rv_t vnet_dev_port_add (vlib_main_t *, vnet_dev_t *,
525                                  vnet_dev_port_id_t,
526                                  vnet_dev_port_add_args_t *);
527 vnet_dev_rv_t vnet_dev_dma_mem_alloc (vlib_main_t *, vnet_dev_t *, u32, u32,
528                                       void **);
529 void vnet_dev_dma_mem_free (vlib_main_t *, vnet_dev_t *, void *);
530 vnet_dev_bus_t *vnet_dev_find_device_bus (vlib_main_t *, vnet_dev_device_id_t);
531 void *vnet_dev_get_device_info (vlib_main_t *, vnet_dev_device_id_t);
532
533 /* error.c */
534 clib_error_t *vnet_dev_port_err (vlib_main_t *, vnet_dev_port_t *,
535                                  vnet_dev_rv_t, char *, ...);
536
537 /* handlers.c */
538 clib_error_t *vnet_dev_port_set_max_frame_size (vnet_main_t *,
539                                                 vnet_hw_interface_t *, u32);
540 u32 vnet_dev_port_eth_flag_change (vnet_main_t *, vnet_hw_interface_t *, u32);
541 clib_error_t *vnet_dev_port_mac_change (vnet_hw_interface_t *, const u8 *,
542                                         const u8 *);
543 clib_error_t *vnet_dev_add_del_mac_address (vnet_hw_interface_t *, const u8 *,
544                                             u8);
545 int vnet_dev_flow_ops_fn (vnet_main_t *, vnet_flow_dev_op_t, u32, u32,
546                           uword *);
547 clib_error_t *vnet_dev_interface_set_rss_queues (vnet_main_t *,
548                                                  vnet_hw_interface_t *,
549                                                  clib_bitmap_t *);
550 void vnet_dev_clear_hw_interface_counters (u32);
551 void vnet_dev_set_interface_next_node (vnet_main_t *, u32, u32);
552
553 /* port.c */
554 vnet_dev_rv_t vnet_dev_port_start (vlib_main_t *, vnet_dev_port_t *);
555 vnet_dev_rv_t vnet_dev_port_start_all_rx_queues (vlib_main_t *,
556                                                  vnet_dev_port_t *);
557 vnet_dev_rv_t vnet_dev_port_start_all_tx_queues (vlib_main_t *,
558                                                  vnet_dev_port_t *);
559 void vnet_dev_port_stop (vlib_main_t *, vnet_dev_port_t *);
560 void vnet_dev_port_deinit (vlib_main_t *, vnet_dev_port_t *);
561 void vnet_dev_port_free (vlib_main_t *, vnet_dev_port_t *);
562 void vnet_dev_port_add_counters (vlib_main_t *, vnet_dev_port_t *,
563                                  vnet_dev_counter_t *, u16);
564 void vnet_dev_port_free_counters (vlib_main_t *, vnet_dev_port_t *);
565 void vnet_dev_port_update_tx_node_runtime (vlib_main_t *, vnet_dev_port_t *);
566 void vnet_dev_port_state_change (vlib_main_t *, vnet_dev_port_t *,
567                                  vnet_dev_port_state_changes_t);
568 void vnet_dev_port_clear_counters (vlib_main_t *, vnet_dev_port_t *);
569 vnet_dev_rv_t
570 vnet_dev_port_cfg_change_req_validate (vlib_main_t *, vnet_dev_port_t *,
571                                        vnet_dev_port_cfg_change_req_t *);
572 vnet_dev_rv_t vnet_dev_port_cfg_change (vlib_main_t *, vnet_dev_port_t *,
573                                         vnet_dev_port_cfg_change_req_t *);
574 vnet_dev_rv_t vnet_dev_port_if_create (vlib_main_t *, vnet_dev_port_t *);
575 vnet_dev_rv_t vnet_dev_port_if_remove (vlib_main_t *, vnet_dev_port_t *);
576
577 /* queue.c */
578 vnet_dev_rv_t vnet_dev_rx_queue_alloc (vlib_main_t *, vnet_dev_port_t *, u16);
579 vnet_dev_rv_t vnet_dev_tx_queue_alloc (vlib_main_t *, vnet_dev_port_t *, u16);
580 void vnet_dev_rx_queue_free (vlib_main_t *, vnet_dev_rx_queue_t *);
581 void vnet_dev_tx_queue_free (vlib_main_t *, vnet_dev_tx_queue_t *);
582 void vnet_dev_rx_queue_add_counters (vlib_main_t *, vnet_dev_rx_queue_t *,
583                                      vnet_dev_counter_t *, u16);
584 void vnet_dev_rx_queue_free_counters (vlib_main_t *, vnet_dev_rx_queue_t *);
585 void vnet_dev_tx_queue_add_counters (vlib_main_t *, vnet_dev_tx_queue_t *,
586                                      vnet_dev_counter_t *, u16);
587 void vnet_dev_tx_queue_free_counters (vlib_main_t *, vnet_dev_tx_queue_t *);
588 vnet_dev_rv_t vnet_dev_rx_queue_start (vlib_main_t *, vnet_dev_rx_queue_t *);
589 vnet_dev_rv_t vnet_dev_tx_queue_start (vlib_main_t *, vnet_dev_tx_queue_t *);
590 void vnet_dev_rx_queue_stop (vlib_main_t *, vnet_dev_rx_queue_t *);
591 void vnet_dev_tx_queue_stop (vlib_main_t *, vnet_dev_tx_queue_t *);
592
593 /* process.c */
594 vnet_dev_rv_t vnet_dev_process_create (vlib_main_t *, vnet_dev_t *);
595 vnet_dev_rv_t vnet_dev_process_call_op (vlib_main_t *, vnet_dev_t *,
596                                         vnet_dev_op_t *);
597 vnet_dev_rv_t vnet_dev_process_call_op_no_rv (vlib_main_t *, vnet_dev_t *,
598                                               vnet_dev_op_no_rv_t *);
599 void vnet_dev_process_call_op_no_wait (vlib_main_t *, vnet_dev_t *,
600                                        vnet_dev_op_no_rv_t *);
601 vnet_dev_rv_t vnet_dev_process_call_port_op (vlib_main_t *, vnet_dev_port_t *,
602                                              vnet_dev_port_op_t *);
603 vnet_dev_rv_t vnet_dev_process_call_port_op_no_rv (vlib_main_t *vm,
604                                                    vnet_dev_port_t *,
605                                                    vnet_dev_port_op_no_rv_t *);
606 void vnet_dev_process_call_port_op_no_wait (vlib_main_t *, vnet_dev_port_t *,
607                                             vnet_dev_port_op_no_rv_t *);
608 vnet_dev_rv_t
609 vnet_dev_process_port_cfg_change_req (vlib_main_t *, vnet_dev_port_t *,
610                                       vnet_dev_port_cfg_change_req_t *);
611 void vnet_dev_process_quit (vlib_main_t *, vnet_dev_t *);
612 void vnet_dev_poll_dev_add (vlib_main_t *, vnet_dev_t *, f64,
613                             vnet_dev_op_no_rv_t *);
614 void vnet_dev_poll_dev_remove (vlib_main_t *, vnet_dev_t *,
615                                vnet_dev_op_no_rv_t *);
616 void vnet_dev_poll_port_add (vlib_main_t *, vnet_dev_port_t *, f64,
617                              vnet_dev_port_op_no_rv_t *);
618 void vnet_dev_poll_port_remove (vlib_main_t *, vnet_dev_port_t *,
619                                 vnet_dev_port_op_no_rv_t *);
620
621 typedef struct
622 {
623   u16 thread_index;
624   u8 completed;
625   u8 in_order;
626   vnet_dev_port_t *port;
627 } vnet_dev_rt_op_t;
628
629 vnet_dev_rv_t vnet_dev_rt_exec_ops (vlib_main_t *, vnet_dev_t *,
630                                     vnet_dev_rt_op_t *, u32);
631
632 /* format.c */
633 typedef struct
634 {
635   u8 counters : 1;
636   u8 show_zero_counters : 1;
637   u8 debug : 1;
638 } vnet_dev_format_args_t;
639
640 format_function_t format_vnet_dev_addr;
641 format_function_t format_vnet_dev_flags;
642 format_function_t format_vnet_dev_hw_addr;
643 format_function_t format_vnet_dev_info;
644 format_function_t format_vnet_dev_interface_info;
645 format_function_t format_vnet_dev_interface_name;
646 format_function_t format_vnet_dev_log;
647 format_function_t format_vnet_dev_port_caps;
648 format_function_t format_vnet_dev_port_flags;
649 format_function_t format_vnet_dev_port_info;
650 format_function_t format_vnet_dev_port_rx_offloads;
651 format_function_t format_vnet_dev_port_tx_offloads;
652 format_function_t format_vnet_dev_rv;
653 format_function_t format_vnet_dev_rx_queue_info;
654 format_function_t format_vnet_dev_tx_queue_info;
655 unformat_function_t unformat_vnet_dev_flags;
656 unformat_function_t unformat_vnet_dev_port_flags;
657
658 typedef struct
659 {
660   vnet_dev_rx_queue_t *first_rx_queue;
661 } vnet_dev_rx_node_runtime_t;
662
663 STATIC_ASSERT (sizeof (vnet_dev_rx_node_runtime_t) <=
664                  VLIB_NODE_RUNTIME_DATA_SIZE,
665                "must fit into runtime data");
666
667 #define foreach_vnet_dev_port_rx_next                                         \
668   _ (ETH_INPUT, "ethernet-input")                                             \
669   _ (DROP, "error-drop")
670
671 typedef enum
672 {
673 #define _(n, s) VNET_DEV_ETH_RX_PORT_NEXT_##n,
674   foreach_vnet_dev_port_rx_next
675 #undef _
676     VNET_DEV_ETH_RX_PORT_N_NEXTS
677 } vnet_dev_eth_port_rx_next_t;
678
679 extern u16 vnet_dev_default_next_index_by_port_type[];
680 extern vlib_node_registration_t port_rx_eth_node;
681
682 typedef vnet_interface_output_runtime_t vnet_dev_tx_node_runtime_t;
683
684 STATIC_ASSERT (sizeof (vnet_dev_tx_node_runtime_t) <=
685                  VLIB_NODE_RUNTIME_DATA_SIZE,
686                "must fit into runtime data");
687
688 #define VNET_DEV_REGISTER_BUS(x, ...)                                         \
689   __VA_ARGS__ vnet_dev_bus_registration_t __vnet_dev_bus_registration_##x;    \
690   static void __clib_constructor __vnet_dev_bus_registration_fn_##x (void)    \
691   {                                                                           \
692     vnet_dev_main_t *dm = &vnet_dev_main;                                     \
693     __vnet_dev_bus_registration_##x.next_registration =                       \
694       dm->bus_registrations;                                                  \
695     dm->bus_registrations = &__vnet_dev_bus_registration_##x;                 \
696   }                                                                           \
697   __VA_ARGS__ vnet_dev_bus_registration_t __vnet_dev_bus_registration_##x
698
699 #define VNET_DEV_REGISTER_DRIVER(x, ...)                                      \
700   __VA_ARGS__ vnet_dev_driver_registration_t                                  \
701     __vnet_dev_driver_registration_##x;                                       \
702   static void __clib_constructor __vnet_dev_driver_registration_fn_##x (void) \
703   {                                                                           \
704     vnet_dev_main_t *dm = &vnet_dev_main;                                     \
705     __vnet_dev_driver_registration_##x.next_registration =                    \
706       dm->driver_registrations;                                               \
707     dm->driver_registrations = &__vnet_dev_driver_registration_##x;           \
708   }                                                                           \
709   __VA_ARGS__ vnet_dev_driver_registration_t __vnet_dev_driver_registration_##x
710
711 #define VNET_DEV_NODE_FN(node)                                                \
712   uword CLIB_MARCH_SFX (node##_fn) (vlib_main_t *, vlib_node_runtime_t *,     \
713                                     vlib_frame_t *);                          \
714   static vlib_node_fn_registration_t CLIB_MARCH_SFX (                         \
715     node##_fn_registration) = {                                               \
716     .function = &CLIB_MARCH_SFX (node##_fn),                                  \
717   };                                                                          \
718                                                                               \
719   static void __clib_constructor CLIB_MARCH_SFX (                             \
720     node##_fn_multiarch_register) (void)                                      \
721   {                                                                           \
722     extern vnet_dev_node_t node;                                              \
723     vlib_node_fn_registration_t *r;                                           \
724     r = &CLIB_MARCH_SFX (node##_fn_registration);                             \
725     r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE);              \
726     r->next_registration = (node).registrations;                              \
727     (node).registrations = r;                                                 \
728   }                                                                           \
729   uword CLIB_MARCH_SFX (node##_fn)
730
731 #define foreach_vnet_dev_port(p, d) pool_foreach_pointer (p, d->ports)
732 #define foreach_vnet_dev_port_rx_queue(q, p)                                  \
733   pool_foreach_pointer (q, p->rx_queues)
734 #define foreach_vnet_dev_port_tx_queue(q, p)                                  \
735   pool_foreach_pointer (q, p->tx_queues)
736
737 #include <vnet/dev/dev_funcs.h>
738
739 #endif /* _VNET_DEV_H_ */