common/mlx5: mark internal symbols
[dpdk.git] / drivers / common / mlx5 / mlx5_devx_cmds.h
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 /* devX creation object */
13 struct mlx5_devx_obj {
14         struct mlx5dv_devx_obj *obj; /* The DV object. */
15         int id; /* The object ID. */
16 };
17
18 /* UMR memory buffer used to define 1 entry in indirect mkey. */
19 struct mlx5_klm {
20         uint32_t byte_count;
21         uint32_t mkey;
22         uint64_t address;
23 };
24
25 /* This is limitation of libibverbs: in length variable type is u16. */
26 #define MLX5_DEVX_MAX_KLM_ENTRIES ((UINT16_MAX - \
27                 MLX5_ST_SZ_DW(create_mkey_in) * 4) / (MLX5_ST_SZ_DW(klm) * 4))
28
29 struct mlx5_devx_mkey_attr {
30         uint64_t addr;
31         uint64_t size;
32         uint32_t umem_id;
33         uint32_t pd;
34         uint32_t log_entity_size;
35         uint32_t pg_access:1;
36         uint32_t relaxed_ordering:1;
37         struct mlx5_klm *klm_array;
38         int klm_num;
39 };
40
41 /* HCA qos attributes. */
42 struct mlx5_hca_qos_attr {
43         uint32_t sup:1; /* Whether QOS is supported. */
44         uint32_t srtcm_sup:1; /* Whether srTCM mode is supported. */
45         uint32_t flow_meter_reg_share:1;
46         /* Whether reg_c share is supported. */
47         uint8_t log_max_flow_meter;
48         /* Power of the maximum supported meters. */
49         uint8_t flow_meter_reg_c_ids;
50         /* Bitmap of the reg_Cs available for flow meter to use. */
51
52 };
53
54 struct mlx5_hca_vdpa_attr {
55         uint8_t virtio_queue_type;
56         uint32_t valid:1;
57         uint32_t desc_tunnel_offload_type:1;
58         uint32_t eth_frame_offload_type:1;
59         uint32_t virtio_version_1_0:1;
60         uint32_t tso_ipv4:1;
61         uint32_t tso_ipv6:1;
62         uint32_t tx_csum:1;
63         uint32_t rx_csum:1;
64         uint32_t event_mode:3;
65         uint32_t log_doorbell_stride:5;
66         uint32_t log_doorbell_bar_size:5;
67         uint32_t max_num_virtio_queues;
68         struct {
69                 uint32_t a;
70                 uint32_t b;
71         } umems[3];
72         uint64_t doorbell_bar_offset;
73 };
74
75 /* HCA supports this number of time periods for LRO. */
76 #define MLX5_LRO_NUM_SUPP_PERIODS 4
77
78 /* HCA attributes. */
79 struct mlx5_hca_attr {
80         uint32_t eswitch_manager:1;
81         uint32_t flow_counters_dump:1;
82         uint32_t log_max_rqt_size:5;
83         uint8_t flow_counter_bulk_alloc_bitmap;
84         uint32_t eth_net_offloads:1;
85         uint32_t eth_virt:1;
86         uint32_t wqe_vlan_insert:1;
87         uint32_t wqe_inline_mode:2;
88         uint32_t vport_inline_mode:3;
89         uint32_t tunnel_stateless_geneve_rx:1;
90         uint32_t geneve_max_opt_len:1; /* 0x0: 14DW, 0x1: 63DW */
91         uint32_t tunnel_stateless_gtp:1;
92         uint32_t lro_cap:1;
93         uint32_t tunnel_lro_gre:1;
94         uint32_t tunnel_lro_vxlan:1;
95         uint32_t lro_max_msg_sz_mode:2;
96         uint32_t lro_timer_supported_periods[MLX5_LRO_NUM_SUPP_PERIODS];
97         uint32_t flex_parser_protocols;
98         uint32_t hairpin:1;
99         uint32_t log_max_hairpin_queues:5;
100         uint32_t log_max_hairpin_wq_data_sz:5;
101         uint32_t log_max_hairpin_num_packets:5;
102         uint32_t vhca_id:16;
103         struct mlx5_hca_qos_attr qos;
104         struct mlx5_hca_vdpa_attr vdpa;
105 };
106
107 struct mlx5_devx_wq_attr {
108         uint32_t wq_type:4;
109         uint32_t wq_signature:1;
110         uint32_t end_padding_mode:2;
111         uint32_t cd_slave:1;
112         uint32_t hds_skip_first_sge:1;
113         uint32_t log2_hds_buf_size:3;
114         uint32_t page_offset:5;
115         uint32_t lwm:16;
116         uint32_t pd:24;
117         uint32_t uar_page:24;
118         uint64_t dbr_addr;
119         uint32_t hw_counter;
120         uint32_t sw_counter;
121         uint32_t log_wq_stride:4;
122         uint32_t log_wq_pg_sz:5;
123         uint32_t log_wq_sz:5;
124         uint32_t dbr_umem_valid:1;
125         uint32_t wq_umem_valid:1;
126         uint32_t log_hairpin_num_packets:5;
127         uint32_t log_hairpin_data_sz:5;
128         uint32_t single_wqe_log_num_of_strides:4;
129         uint32_t two_byte_shift_en:1;
130         uint32_t single_stride_log_num_of_bytes:3;
131         uint32_t dbr_umem_id;
132         uint32_t wq_umem_id;
133         uint64_t wq_umem_offset;
134 };
135
136 /* Create RQ attributes structure, used by create RQ operation. */
137 struct mlx5_devx_create_rq_attr {
138         uint32_t rlky:1;
139         uint32_t delay_drop_en:1;
140         uint32_t scatter_fcs:1;
141         uint32_t vsd:1;
142         uint32_t mem_rq_type:4;
143         uint32_t state:4;
144         uint32_t flush_in_error_en:1;
145         uint32_t hairpin:1;
146         uint32_t user_index:24;
147         uint32_t cqn:24;
148         uint32_t counter_set_id:8;
149         uint32_t rmpn:24;
150         struct mlx5_devx_wq_attr wq_attr;
151 };
152
153 /* Modify RQ attributes structure, used by modify RQ operation. */
154 struct mlx5_devx_modify_rq_attr {
155         uint32_t rqn:24;
156         uint32_t rq_state:4; /* Current RQ state. */
157         uint32_t state:4; /* Required RQ state. */
158         uint32_t scatter_fcs:1;
159         uint32_t vsd:1;
160         uint32_t counter_set_id:8;
161         uint32_t hairpin_peer_sq:24;
162         uint32_t hairpin_peer_vhca:16;
163         uint64_t modify_bitmask;
164         uint32_t lwm:16; /* Contained WQ lwm. */
165 };
166
167 struct mlx5_rx_hash_field_select {
168         uint32_t l3_prot_type:1;
169         uint32_t l4_prot_type:1;
170         uint32_t selected_fields:30;
171 };
172
173 /* TIR attributes structure, used by TIR operations. */
174 struct mlx5_devx_tir_attr {
175         uint32_t disp_type:4;
176         uint32_t lro_timeout_period_usecs:16;
177         uint32_t lro_enable_mask:4;
178         uint32_t lro_max_msg_sz:8;
179         uint32_t inline_rqn:24;
180         uint32_t rx_hash_symmetric:1;
181         uint32_t tunneled_offload_en:1;
182         uint32_t indirect_table:24;
183         uint32_t rx_hash_fn:4;
184         uint32_t self_lb_block:2;
185         uint32_t transport_domain:24;
186         uint8_t rx_hash_toeplitz_key[MLX5_RSS_HASH_KEY_LEN];
187         struct mlx5_rx_hash_field_select rx_hash_field_selector_outer;
188         struct mlx5_rx_hash_field_select rx_hash_field_selector_inner;
189 };
190
191 /* RQT attributes structure, used by RQT operations. */
192 struct mlx5_devx_rqt_attr {
193         uint8_t rq_type;
194         uint32_t rqt_max_size:16;
195         uint32_t rqt_actual_size:16;
196         uint32_t rq_list[];
197 };
198
199 /* TIS attributes structure. */
200 struct mlx5_devx_tis_attr {
201         uint32_t strict_lag_tx_port_affinity:1;
202         uint32_t tls_en:1;
203         uint32_t lag_tx_port_affinity:4;
204         uint32_t prio:4;
205         uint32_t transport_domain:24;
206 };
207
208 /* SQ attributes structure, used by SQ create operation. */
209 struct mlx5_devx_create_sq_attr {
210         uint32_t rlky:1;
211         uint32_t cd_master:1;
212         uint32_t fre:1;
213         uint32_t flush_in_error_en:1;
214         uint32_t allow_multi_pkt_send_wqe:1;
215         uint32_t min_wqe_inline_mode:3;
216         uint32_t state:4;
217         uint32_t reg_umr:1;
218         uint32_t allow_swp:1;
219         uint32_t hairpin:1;
220         uint32_t user_index:24;
221         uint32_t cqn:24;
222         uint32_t packet_pacing_rate_limit_index:16;
223         uint32_t tis_lst_sz:16;
224         uint32_t tis_num:24;
225         struct mlx5_devx_wq_attr wq_attr;
226 };
227
228 /* SQ attributes structure, used by SQ modify operation. */
229 struct mlx5_devx_modify_sq_attr {
230         uint32_t sq_state:4;
231         uint32_t state:4;
232         uint32_t hairpin_peer_rq:24;
233         uint32_t hairpin_peer_vhca:16;
234 };
235
236
237 /* CQ attributes structure, used by CQ operations. */
238 struct mlx5_devx_cq_attr {
239         uint32_t q_umem_valid:1;
240         uint32_t db_umem_valid:1;
241         uint32_t use_first_only:1;
242         uint32_t overrun_ignore:1;
243         uint32_t log_cq_size:5;
244         uint32_t log_page_size:5;
245         uint32_t uar_page_id;
246         uint32_t q_umem_id;
247         uint64_t q_umem_offset;
248         uint32_t db_umem_id;
249         uint64_t db_umem_offset;
250         uint32_t eqn;
251         uint64_t db_addr;
252 };
253
254 /* Virtq attributes structure, used by VIRTQ operations. */
255 struct mlx5_devx_virtq_attr {
256         uint16_t hw_available_index;
257         uint16_t hw_used_index;
258         uint16_t q_size;
259         uint32_t virtio_version_1_0:1;
260         uint32_t tso_ipv4:1;
261         uint32_t tso_ipv6:1;
262         uint32_t tx_csum:1;
263         uint32_t rx_csum:1;
264         uint32_t event_mode:3;
265         uint32_t state:4;
266         uint32_t dirty_bitmap_dump_enable:1;
267         uint32_t dirty_bitmap_mkey;
268         uint32_t dirty_bitmap_size;
269         uint32_t mkey;
270         uint32_t qp_id;
271         uint32_t queue_index;
272         uint32_t tis_id;
273         uint64_t dirty_bitmap_addr;
274         uint64_t type;
275         uint64_t desc_addr;
276         uint64_t used_addr;
277         uint64_t available_addr;
278         struct {
279                 uint32_t id;
280                 uint32_t size;
281                 uint64_t offset;
282         } umems[3];
283 };
284
285
286 struct mlx5_devx_qp_attr {
287         uint32_t pd:24;
288         uint32_t uar_index:24;
289         uint32_t cqn:24;
290         uint32_t log_page_size:5;
291         uint32_t rq_size:17; /* Must be power of 2. */
292         uint32_t log_rq_stride:3;
293         uint32_t sq_size:17; /* Must be power of 2. */
294         uint32_t dbr_umem_valid:1;
295         uint32_t dbr_umem_id;
296         uint64_t dbr_address;
297         uint32_t wq_umem_id;
298         uint64_t wq_umem_offset;
299 };
300
301 /* mlx5_devx_cmds.c */
302
303 __rte_internal
304 struct mlx5_devx_obj *mlx5_devx_cmd_flow_counter_alloc(struct ibv_context *ctx,
305                                                        uint32_t bulk_sz);
306 __rte_internal
307 int mlx5_devx_cmd_destroy(struct mlx5_devx_obj *obj);
308 __rte_internal
309 int mlx5_devx_cmd_flow_counter_query(struct mlx5_devx_obj *dcs,
310                                      int clear, uint32_t n_counters,
311                                      uint64_t *pkts, uint64_t *bytes,
312                                      uint32_t mkey, void *addr,
313                                      struct mlx5dv_devx_cmd_comp *cmd_comp,
314                                      uint64_t async_id);
315 __rte_internal
316 int mlx5_devx_cmd_query_hca_attr(struct ibv_context *ctx,
317                                  struct mlx5_hca_attr *attr);
318 __rte_internal
319 struct mlx5_devx_obj *mlx5_devx_cmd_mkey_create(struct ibv_context *ctx,
320                                               struct mlx5_devx_mkey_attr *attr);
321 __rte_internal
322 int mlx5_devx_get_out_command_status(void *out);
323 __rte_internal
324 int mlx5_devx_cmd_qp_query_tis_td(struct ibv_qp *qp, uint32_t tis_num,
325                                   uint32_t *tis_td);
326 __rte_internal
327 struct mlx5_devx_obj *mlx5_devx_cmd_create_rq(struct ibv_context *ctx,
328                                        struct mlx5_devx_create_rq_attr *rq_attr,
329                                        int socket);
330 __rte_internal
331 int mlx5_devx_cmd_modify_rq(struct mlx5_devx_obj *rq,
332                             struct mlx5_devx_modify_rq_attr *rq_attr);
333 __rte_internal
334 struct mlx5_devx_obj *mlx5_devx_cmd_create_tir(struct ibv_context *ctx,
335                                            struct mlx5_devx_tir_attr *tir_attr);
336 __rte_internal
337 struct mlx5_devx_obj *mlx5_devx_cmd_create_rqt(struct ibv_context *ctx,
338                                            struct mlx5_devx_rqt_attr *rqt_attr);
339 __rte_internal
340 struct mlx5_devx_obj *mlx5_devx_cmd_create_sq(struct ibv_context *ctx,
341                                       struct mlx5_devx_create_sq_attr *sq_attr);
342 __rte_internal
343 int mlx5_devx_cmd_modify_sq(struct mlx5_devx_obj *sq,
344                             struct mlx5_devx_modify_sq_attr *sq_attr);
345 __rte_internal
346 struct mlx5_devx_obj *mlx5_devx_cmd_create_tis(struct ibv_context *ctx,
347                                            struct mlx5_devx_tis_attr *tis_attr);
348 __rte_internal
349 struct mlx5_devx_obj *mlx5_devx_cmd_create_td(struct ibv_context *ctx);
350 __rte_internal
351 int mlx5_devx_cmd_flow_dump(void *fdb_domain, void *rx_domain, void *tx_domain,
352                             FILE *file);
353 __rte_internal
354 struct mlx5_devx_obj *mlx5_devx_cmd_create_cq(struct ibv_context *ctx,
355                                               struct mlx5_devx_cq_attr *attr);
356 __rte_internal
357 struct mlx5_devx_obj *mlx5_devx_cmd_create_virtq(struct ibv_context *ctx,
358                                              struct mlx5_devx_virtq_attr *attr);
359 __rte_internal
360 int mlx5_devx_cmd_modify_virtq(struct mlx5_devx_obj *virtq_obj,
361                                struct mlx5_devx_virtq_attr *attr);
362 __rte_internal
363 int mlx5_devx_cmd_query_virtq(struct mlx5_devx_obj *virtq_obj,
364                               struct mlx5_devx_virtq_attr *attr);
365 __rte_internal
366 struct mlx5_devx_obj *mlx5_devx_cmd_create_qp(struct ibv_context *ctx,
367                                               struct mlx5_devx_qp_attr *attr);
368 __rte_internal
369 int mlx5_devx_cmd_modify_qp_state(struct mlx5_devx_obj *qp,
370                                   uint32_t qp_st_mod_op, uint32_t remote_qp_id);
371 __rte_internal
372 int mlx5_devx_cmd_modify_rqt(struct mlx5_devx_obj *rqt,
373                              struct mlx5_devx_rqt_attr *rqt_attr);
374
375 #endif /* RTE_PMD_MLX5_DEVX_CMDS_H_ */