xref: /dpdk/drivers/common/mlx5/mlx5_devx_cmds.h (revision f1a6a986c1b6065d098e79b1a26b3e867dc418f7)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2019 Mellanox Technologies, Ltd
3  */
4 
5 #ifndef RTE_PMD_MLX5_DEVX_CMDS_H_
6 #define RTE_PMD_MLX5_DEVX_CMDS_H_
7 
8 #include "mlx5_glue.h"
9 #include "mlx5_prm.h"
10 
11 
12 /* This is limitation of libibverbs: in length variable type is u16. */
13 #define MLX5_DEVX_MAX_KLM_ENTRIES ((UINT16_MAX - \
14 		MLX5_ST_SZ_DW(create_mkey_in) * 4) / (MLX5_ST_SZ_DW(klm) * 4))
15 
16 struct mlx5_devx_mkey_attr {
17 	uint64_t addr;
18 	uint64_t size;
19 	uint32_t umem_id;
20 	uint32_t pd;
21 	uint32_t log_entity_size;
22 	uint32_t pg_access:1;
23 	uint32_t relaxed_ordering:1;
24 	struct mlx5_klm *klm_array;
25 	int klm_num;
26 };
27 
28 /* HCA qos attributes. */
29 struct mlx5_hca_qos_attr {
30 	uint32_t sup:1;	/* Whether QOS is supported. */
31 	uint32_t srtcm_sup:1; /* Whether srTCM mode is supported. */
32 	uint32_t packet_pacing:1; /* Packet pacing is supported. */
33 	uint32_t wqe_rate_pp:1; /* Packet pacing WQE rate mode. */
34 	uint32_t flow_meter_reg_share:1;
35 	/* Whether reg_c share is supported. */
36 	uint8_t log_max_flow_meter;
37 	/* Power of the maximum supported meters. */
38 	uint8_t flow_meter_reg_c_ids;
39 	/* Bitmap of the reg_Cs available for flow meter to use. */
40 
41 };
42 
43 struct mlx5_hca_vdpa_attr {
44 	uint8_t virtio_queue_type;
45 	uint32_t valid:1;
46 	uint32_t desc_tunnel_offload_type:1;
47 	uint32_t eth_frame_offload_type:1;
48 	uint32_t virtio_version_1_0:1;
49 	uint32_t tso_ipv4:1;
50 	uint32_t tso_ipv6:1;
51 	uint32_t tx_csum:1;
52 	uint32_t rx_csum:1;
53 	uint32_t event_mode:3;
54 	uint32_t log_doorbell_stride:5;
55 	uint32_t log_doorbell_bar_size:5;
56 	uint32_t queue_counters_valid:1;
57 	uint32_t max_num_virtio_queues;
58 	struct {
59 		uint32_t a;
60 		uint32_t b;
61 	} umems[3];
62 	uint64_t doorbell_bar_offset;
63 };
64 
65 /* HCA supports this number of time periods for LRO. */
66 #define MLX5_LRO_NUM_SUPP_PERIODS 4
67 
68 /* HCA attributes. */
69 struct mlx5_hca_attr {
70 	uint32_t eswitch_manager:1;
71 	uint32_t flow_counters_dump:1;
72 	uint32_t log_max_rqt_size:5;
73 	uint32_t parse_graph_flex_node:1;
74 	uint8_t flow_counter_bulk_alloc_bitmap;
75 	uint32_t eth_net_offloads:1;
76 	uint32_t eth_virt:1;
77 	uint32_t wqe_vlan_insert:1;
78 	uint32_t wqe_inline_mode:2;
79 	uint32_t vport_inline_mode:3;
80 	uint32_t tunnel_stateless_geneve_rx:1;
81 	uint32_t geneve_max_opt_len:1; /* 0x0: 14DW, 0x1: 63DW */
82 	uint32_t tunnel_stateless_gtp:1;
83 	uint32_t lro_cap:1;
84 	uint32_t tunnel_lro_gre:1;
85 	uint32_t tunnel_lro_vxlan:1;
86 	uint32_t lro_max_msg_sz_mode:2;
87 	uint32_t lro_timer_supported_periods[MLX5_LRO_NUM_SUPP_PERIODS];
88 	uint16_t lro_min_mss_size;
89 	uint32_t flex_parser_protocols;
90 	uint32_t hairpin:1;
91 	uint32_t log_max_hairpin_queues:5;
92 	uint32_t log_max_hairpin_wq_data_sz:5;
93 	uint32_t log_max_hairpin_num_packets:5;
94 	uint32_t vhca_id:16;
95 	uint32_t relaxed_ordering_write:1;
96 	uint32_t relaxed_ordering_read:1;
97 	uint32_t access_register_user:1;
98 	uint32_t wqe_index_ignore:1;
99 	uint32_t cross_channel:1;
100 	uint32_t non_wire_sq:1; /* SQ with non-wire ops is supported. */
101 	uint32_t log_max_static_sq_wq:5; /* Static WQE size SQ. */
102 	uint32_t num_lag_ports:4; /* Number of ports can be bonded. */
103 	uint32_t dev_freq_khz; /* Timestamp counter frequency, kHz. */
104 	uint32_t scatter_fcs_w_decap_disable:1;
105 	uint32_t flow_hit_aso:1; /* General obj type FLOW_HIT_ASO supported. */
106 	uint32_t regex:1;
107 	uint32_t regexp_num_of_engines;
108 	uint32_t log_max_ft_sampler_num:8;
109 	struct mlx5_hca_qos_attr qos;
110 	struct mlx5_hca_vdpa_attr vdpa;
111 };
112 
113 struct mlx5_devx_wq_attr {
114 	uint32_t wq_type:4;
115 	uint32_t wq_signature:1;
116 	uint32_t end_padding_mode:2;
117 	uint32_t cd_slave:1;
118 	uint32_t hds_skip_first_sge:1;
119 	uint32_t log2_hds_buf_size:3;
120 	uint32_t page_offset:5;
121 	uint32_t lwm:16;
122 	uint32_t pd:24;
123 	uint32_t uar_page:24;
124 	uint64_t dbr_addr;
125 	uint32_t hw_counter;
126 	uint32_t sw_counter;
127 	uint32_t log_wq_stride:4;
128 	uint32_t log_wq_pg_sz:5;
129 	uint32_t log_wq_sz:5;
130 	uint32_t dbr_umem_valid:1;
131 	uint32_t wq_umem_valid:1;
132 	uint32_t log_hairpin_num_packets:5;
133 	uint32_t log_hairpin_data_sz:5;
134 	uint32_t single_wqe_log_num_of_strides:4;
135 	uint32_t two_byte_shift_en:1;
136 	uint32_t single_stride_log_num_of_bytes:3;
137 	uint32_t dbr_umem_id;
138 	uint32_t wq_umem_id;
139 	uint64_t wq_umem_offset;
140 };
141 
142 /* Create RQ attributes structure, used by create RQ operation. */
143 struct mlx5_devx_create_rq_attr {
144 	uint32_t rlky:1;
145 	uint32_t delay_drop_en:1;
146 	uint32_t scatter_fcs:1;
147 	uint32_t vsd:1;
148 	uint32_t mem_rq_type:4;
149 	uint32_t state:4;
150 	uint32_t flush_in_error_en:1;
151 	uint32_t hairpin:1;
152 	uint32_t user_index:24;
153 	uint32_t cqn:24;
154 	uint32_t counter_set_id:8;
155 	uint32_t rmpn:24;
156 	struct mlx5_devx_wq_attr wq_attr;
157 };
158 
159 /* Modify RQ attributes structure, used by modify RQ operation. */
160 struct mlx5_devx_modify_rq_attr {
161 	uint32_t rqn:24;
162 	uint32_t rq_state:4; /* Current RQ state. */
163 	uint32_t state:4; /* Required RQ state. */
164 	uint32_t scatter_fcs:1;
165 	uint32_t vsd:1;
166 	uint32_t counter_set_id:8;
167 	uint32_t hairpin_peer_sq:24;
168 	uint32_t hairpin_peer_vhca:16;
169 	uint64_t modify_bitmask;
170 	uint32_t lwm:16; /* Contained WQ lwm. */
171 };
172 
173 struct mlx5_rx_hash_field_select {
174 	uint32_t l3_prot_type:1;
175 	uint32_t l4_prot_type:1;
176 	uint32_t selected_fields:30;
177 };
178 
179 /* TIR attributes structure, used by TIR operations. */
180 struct mlx5_devx_tir_attr {
181 	uint32_t disp_type:4;
182 	uint32_t lro_timeout_period_usecs:16;
183 	uint32_t lro_enable_mask:4;
184 	uint32_t lro_max_msg_sz:8;
185 	uint32_t inline_rqn:24;
186 	uint32_t rx_hash_symmetric:1;
187 	uint32_t tunneled_offload_en:1;
188 	uint32_t indirect_table:24;
189 	uint32_t rx_hash_fn:4;
190 	uint32_t self_lb_block:2;
191 	uint32_t transport_domain:24;
192 	uint8_t rx_hash_toeplitz_key[MLX5_RSS_HASH_KEY_LEN];
193 	struct mlx5_rx_hash_field_select rx_hash_field_selector_outer;
194 	struct mlx5_rx_hash_field_select rx_hash_field_selector_inner;
195 };
196 
197 /* TIR attributes structure, used by TIR modify. */
198 struct mlx5_devx_modify_tir_attr {
199 	uint32_t tirn:24;
200 	uint64_t modify_bitmask;
201 	struct mlx5_devx_tir_attr tir;
202 };
203 
204 /* RQT attributes structure, used by RQT operations. */
205 struct mlx5_devx_rqt_attr {
206 	uint8_t rq_type;
207 	uint32_t rqt_max_size:16;
208 	uint32_t rqt_actual_size:16;
209 	uint32_t rq_list[];
210 };
211 
212 /* TIS attributes structure. */
213 struct mlx5_devx_tis_attr {
214 	uint32_t strict_lag_tx_port_affinity:1;
215 	uint32_t tls_en:1;
216 	uint32_t lag_tx_port_affinity:4;
217 	uint32_t prio:4;
218 	uint32_t transport_domain:24;
219 };
220 
221 /* SQ attributes structure, used by SQ create operation. */
222 struct mlx5_devx_create_sq_attr {
223 	uint32_t rlky:1;
224 	uint32_t cd_master:1;
225 	uint32_t fre:1;
226 	uint32_t flush_in_error_en:1;
227 	uint32_t allow_multi_pkt_send_wqe:1;
228 	uint32_t min_wqe_inline_mode:3;
229 	uint32_t state:4;
230 	uint32_t reg_umr:1;
231 	uint32_t allow_swp:1;
232 	uint32_t hairpin:1;
233 	uint32_t non_wire:1;
234 	uint32_t static_sq_wq:1;
235 	uint32_t user_index:24;
236 	uint32_t cqn:24;
237 	uint32_t packet_pacing_rate_limit_index:16;
238 	uint32_t tis_lst_sz:16;
239 	uint32_t tis_num:24;
240 	struct mlx5_devx_wq_attr wq_attr;
241 };
242 
243 /* SQ attributes structure, used by SQ modify operation. */
244 struct mlx5_devx_modify_sq_attr {
245 	uint32_t sq_state:4;
246 	uint32_t state:4;
247 	uint32_t hairpin_peer_rq:24;
248 	uint32_t hairpin_peer_vhca:16;
249 };
250 
251 
252 /* CQ attributes structure, used by CQ operations. */
253 struct mlx5_devx_cq_attr {
254 	uint32_t q_umem_valid:1;
255 	uint32_t db_umem_valid:1;
256 	uint32_t use_first_only:1;
257 	uint32_t overrun_ignore:1;
258 	uint32_t cqe_comp_en:1;
259 	uint32_t mini_cqe_res_format:2;
260 	uint32_t mini_cqe_res_format_ext:2;
261 	uint32_t cqe_size:3;
262 	uint32_t log_cq_size:5;
263 	uint32_t log_page_size:5;
264 	uint32_t uar_page_id;
265 	uint32_t q_umem_id;
266 	uint64_t q_umem_offset;
267 	uint32_t db_umem_id;
268 	uint64_t db_umem_offset;
269 	uint32_t eqn;
270 	uint64_t db_addr;
271 };
272 
273 /* Virtq attributes structure, used by VIRTQ operations. */
274 struct mlx5_devx_virtq_attr {
275 	uint16_t hw_available_index;
276 	uint16_t hw_used_index;
277 	uint16_t q_size;
278 	uint32_t pd:24;
279 	uint32_t virtio_version_1_0:1;
280 	uint32_t tso_ipv4:1;
281 	uint32_t tso_ipv6:1;
282 	uint32_t tx_csum:1;
283 	uint32_t rx_csum:1;
284 	uint32_t event_mode:3;
285 	uint32_t state:4;
286 	uint32_t dirty_bitmap_dump_enable:1;
287 	uint32_t dirty_bitmap_mkey;
288 	uint32_t dirty_bitmap_size;
289 	uint32_t mkey;
290 	uint32_t qp_id;
291 	uint32_t queue_index;
292 	uint32_t tis_id;
293 	uint32_t counters_obj_id;
294 	uint64_t dirty_bitmap_addr;
295 	uint64_t type;
296 	uint64_t desc_addr;
297 	uint64_t used_addr;
298 	uint64_t available_addr;
299 	struct {
300 		uint32_t id;
301 		uint32_t size;
302 		uint64_t offset;
303 	} umems[3];
304 	uint8_t error_type;
305 };
306 
307 
308 struct mlx5_devx_qp_attr {
309 	uint32_t pd:24;
310 	uint32_t uar_index:24;
311 	uint32_t cqn:24;
312 	uint32_t log_page_size:5;
313 	uint32_t rq_size:17; /* Must be power of 2. */
314 	uint32_t log_rq_stride:3;
315 	uint32_t sq_size:17; /* Must be power of 2. */
316 	uint32_t dbr_umem_valid:1;
317 	uint32_t dbr_umem_id;
318 	uint64_t dbr_address;
319 	uint32_t wq_umem_id;
320 	uint64_t wq_umem_offset;
321 };
322 
323 struct mlx5_devx_virtio_q_couners_attr {
324 	uint64_t received_desc;
325 	uint64_t completed_desc;
326 	uint32_t error_cqes;
327 	uint32_t bad_desc_errors;
328 	uint32_t exceed_max_chain;
329 	uint32_t invalid_buffer;
330 };
331 
332 /*
333  * graph flow match sample attributes structure,
334  * used by flex parser operations.
335  */
336 struct mlx5_devx_match_sample_attr {
337 	uint32_t flow_match_sample_en:1;
338 	uint32_t flow_match_sample_field_offset:16;
339 	uint32_t flow_match_sample_offset_mode:4;
340 	uint32_t flow_match_sample_field_offset_mask;
341 	uint32_t flow_match_sample_field_offset_shift:4;
342 	uint32_t flow_match_sample_field_base_offset:8;
343 	uint32_t flow_match_sample_tunnel_mode:3;
344 	uint32_t flow_match_sample_field_id;
345 };
346 
347 /* graph node arc attributes structure, used by flex parser operations. */
348 struct mlx5_devx_graph_arc_attr {
349 	uint32_t compare_condition_value:16;
350 	uint32_t start_inner_tunnel:1;
351 	uint32_t arc_parse_graph_node:8;
352 	uint32_t parse_graph_node_handle;
353 };
354 
355 /* Maximal number of samples per graph node. */
356 #define MLX5_GRAPH_NODE_SAMPLE_NUM 8
357 
358 /* Maximal number of input/output arcs per graph node. */
359 #define MLX5_GRAPH_NODE_ARC_NUM 8
360 
361 /* parse graph node attributes structure, used by flex parser operations. */
362 struct mlx5_devx_graph_node_attr {
363 	uint32_t modify_field_select;
364 	uint32_t header_length_mode:4;
365 	uint32_t header_length_base_value:16;
366 	uint32_t header_length_field_shift:4;
367 	uint32_t header_length_field_offset:16;
368 	uint32_t header_length_field_mask;
369 	struct mlx5_devx_match_sample_attr sample[MLX5_GRAPH_NODE_SAMPLE_NUM];
370 	uint32_t next_header_field_offset:16;
371 	uint32_t next_header_field_size:5;
372 	struct mlx5_devx_graph_arc_attr in[MLX5_GRAPH_NODE_ARC_NUM];
373 	struct mlx5_devx_graph_arc_attr out[MLX5_GRAPH_NODE_ARC_NUM];
374 };
375 
376 /* mlx5_devx_cmds.c */
377 
378 __rte_internal
379 struct mlx5_devx_obj *mlx5_devx_cmd_flow_counter_alloc(void *ctx,
380 						       uint32_t bulk_sz);
381 __rte_internal
382 int mlx5_devx_cmd_destroy(struct mlx5_devx_obj *obj);
383 __rte_internal
384 int mlx5_devx_cmd_flow_counter_query(struct mlx5_devx_obj *dcs,
385 				     int clear, uint32_t n_counters,
386 				     uint64_t *pkts, uint64_t *bytes,
387 				     uint32_t mkey, void *addr,
388 				     void *cmd_comp,
389 				     uint64_t async_id);
390 __rte_internal
391 int mlx5_devx_cmd_query_hca_attr(void *ctx,
392 				 struct mlx5_hca_attr *attr);
393 __rte_internal
394 struct mlx5_devx_obj *mlx5_devx_cmd_mkey_create(void *ctx,
395 					      struct mlx5_devx_mkey_attr *attr);
396 __rte_internal
397 int mlx5_devx_get_out_command_status(void *out);
398 __rte_internal
399 int mlx5_devx_cmd_qp_query_tis_td(void *qp, uint32_t tis_num,
400 				  uint32_t *tis_td);
401 __rte_internal
402 struct mlx5_devx_obj *mlx5_devx_cmd_create_rq(void *ctx,
403 				       struct mlx5_devx_create_rq_attr *rq_attr,
404 				       int socket);
405 __rte_internal
406 int mlx5_devx_cmd_modify_rq(struct mlx5_devx_obj *rq,
407 			    struct mlx5_devx_modify_rq_attr *rq_attr);
408 __rte_internal
409 struct mlx5_devx_obj *mlx5_devx_cmd_create_tir(void *ctx,
410 					   struct mlx5_devx_tir_attr *tir_attr);
411 __rte_internal
412 struct mlx5_devx_obj *mlx5_devx_cmd_create_rqt(void *ctx,
413 					   struct mlx5_devx_rqt_attr *rqt_attr);
414 __rte_internal
415 struct mlx5_devx_obj *mlx5_devx_cmd_create_sq(void *ctx,
416 				      struct mlx5_devx_create_sq_attr *sq_attr);
417 __rte_internal
418 int mlx5_devx_cmd_modify_sq(struct mlx5_devx_obj *sq,
419 			    struct mlx5_devx_modify_sq_attr *sq_attr);
420 __rte_internal
421 struct mlx5_devx_obj *mlx5_devx_cmd_create_tis(void *ctx,
422 					   struct mlx5_devx_tis_attr *tis_attr);
423 __rte_internal
424 struct mlx5_devx_obj *mlx5_devx_cmd_create_td(void *ctx);
425 __rte_internal
426 int mlx5_devx_cmd_flow_dump(void *fdb_domain, void *rx_domain, void *tx_domain,
427 			    FILE *file);
428 __rte_internal
429 struct mlx5_devx_obj *mlx5_devx_cmd_create_cq(void *ctx,
430 					      struct mlx5_devx_cq_attr *attr);
431 __rte_internal
432 struct mlx5_devx_obj *mlx5_devx_cmd_create_virtq(void *ctx,
433 					     struct mlx5_devx_virtq_attr *attr);
434 __rte_internal
435 int mlx5_devx_cmd_modify_virtq(struct mlx5_devx_obj *virtq_obj,
436 			       struct mlx5_devx_virtq_attr *attr);
437 __rte_internal
438 int mlx5_devx_cmd_query_virtq(struct mlx5_devx_obj *virtq_obj,
439 			      struct mlx5_devx_virtq_attr *attr);
440 __rte_internal
441 struct mlx5_devx_obj *mlx5_devx_cmd_create_qp(void *ctx,
442 					      struct mlx5_devx_qp_attr *attr);
443 __rte_internal
444 int mlx5_devx_cmd_modify_qp_state(struct mlx5_devx_obj *qp,
445 				  uint32_t qp_st_mod_op, uint32_t remote_qp_id);
446 __rte_internal
447 int mlx5_devx_cmd_modify_rqt(struct mlx5_devx_obj *rqt,
448 			     struct mlx5_devx_rqt_attr *rqt_attr);
449 __rte_internal
450 int mlx5_devx_cmd_modify_tir(struct mlx5_devx_obj *tir,
451 			     struct mlx5_devx_modify_tir_attr *tir_attr);
452 __rte_internal
453 int mlx5_devx_cmd_query_parse_samples(struct mlx5_devx_obj *flex_obj,
454 				      uint32_t ids[], uint32_t num);
455 
456 __rte_internal
457 struct mlx5_devx_obj *mlx5_devx_cmd_create_flex_parser(void *ctx,
458 					struct mlx5_devx_graph_node_attr *data);
459 
460 __rte_internal
461 int mlx5_devx_cmd_register_read(void *ctx, uint16_t reg_id,
462 				uint32_t arg, uint32_t *data, uint32_t dw_cnt);
463 /**
464  * Create virtio queue counters object DevX API.
465  *
466  * @param[in] ctx
467  *   Device context.
468 
469  * @return
470  *   The DevX object created, NULL otherwise and rte_errno is set.
471  */
472 __rte_internal
473 struct mlx5_devx_obj *mlx5_devx_cmd_create_virtio_q_counters(void *ctx);
474 
475 /**
476  * Query virtio queue counters object using DevX API.
477  *
478  * @param[in] couners_obj
479  *   Pointer to virtq object structure.
480  * @param [in/out] attr
481  *   Pointer to virtio queue counters attributes structure.
482  *
483  * @return
484  *   0 on success, a negative errno value otherwise and rte_errno is set.
485  */
486 __rte_internal
487 int mlx5_devx_cmd_query_virtio_q_counters(struct mlx5_devx_obj *couners_obj,
488 				  struct mlx5_devx_virtio_q_couners_attr *attr);
489 
490 __rte_internal
491 struct mlx5_devx_obj *mlx5_devx_cmd_create_flow_hit_aso_obj(void *ctx,
492 							    uint32_t pd);
493 
494 #endif /* RTE_PMD_MLX5_DEVX_CMDS_H_ */
495