Branch data Line data Source code
1 : : /* SPDX-License-Identifier: BSD-3-Clause
2 : : * Copyright 2019 Mellanox Technologies, Ltd
3 : : */
4 : :
5 : : #ifndef RTE_PMD_MLX5_COMMON_H_
6 : : #define RTE_PMD_MLX5_COMMON_H_
7 : :
8 : : #include <stdio.h>
9 : :
10 : : #include <rte_compat.h>
11 : : #include <rte_pci.h>
12 : : #include <bus_pci_driver.h>
13 : : #include <rte_debug.h>
14 : : #include <rte_atomic.h>
15 : : #include <rte_rwlock.h>
16 : : #include <rte_log.h>
17 : : #include <rte_kvargs.h>
18 : : #include <rte_devargs.h>
19 : : #include <rte_bitops.h>
20 : : #include <rte_lcore.h>
21 : : #include <rte_spinlock.h>
22 : : #include <rte_os_shim.h>
23 : :
24 : : #include "mlx5_prm.h"
25 : : #include "mlx5_devx_cmds.h"
26 : : #include "mlx5_common_os.h"
27 : : #include "mlx5_common_mr.h"
28 : :
29 : : /* Reported driver name. */
30 : : #define MLX5_PCI_DRIVER_NAME "mlx5_pci"
31 : : #define MLX5_AUXILIARY_DRIVER_NAME "mlx5_auxiliary"
32 : :
33 : : /* Bit-field manipulation. */
34 : : #define BITFIELD_DECLARE(bf, type, size) \
35 : : type bf[(((size_t)(size) / (sizeof(type) * CHAR_BIT)) + \
36 : : !!((size_t)(size) % (sizeof(type) * CHAR_BIT)))]
37 : : #define BITFIELD_DEFINE(bf, type, size) \
38 : : BITFIELD_DECLARE((bf), type, (size)) = { 0 }
39 : : #define BITFIELD_SET(bf, b) \
40 : : (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] |= \
41 : : ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT))))
42 : : #define BITFIELD_RESET(bf, b) \
43 : : (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] &= \
44 : : ~((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT))))
45 : : #define BITFIELD_ISSET(bf, b) \
46 : : !!(((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] & \
47 : : ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT)))))
48 : :
49 : : /*
50 : : * Helper macros to work around __VA_ARGS__ limitations in a C99 compliant
51 : : * manner.
52 : : */
53 : : #define PMD_DRV_LOG_STRIP(a, b) a
54 : : #define PMD_DRV_LOG_OPAREN (
55 : : #define PMD_DRV_LOG_CPAREN )
56 : : #define PMD_DRV_LOG_COMMA ,
57 : :
58 : : /* Return the file name part of a path. */
59 : : static inline const char *
60 : : pmd_drv_log_basename(const char *s)
61 : : {
62 : : const char *n = s;
63 : :
64 : : while (*n)
65 : : if (*(n++) == '/')
66 : : s = n;
67 : : return s;
68 : : }
69 : :
70 : : #define PMD_DRV_LOG___(level, type, name, ...) \
71 : : rte_log(RTE_LOG_ ## level, \
72 : : type, \
73 : : RTE_FMT(name ": " \
74 : : RTE_FMT_HEAD(__VA_ARGS__,), \
75 : : RTE_FMT_TAIL(__VA_ARGS__,)))
76 : :
77 : : #ifdef RTE_PMD_MLX5_DEBUG
78 : :
79 : : #define PMD_DRV_LOG__(level, type, name, ...) \
80 : : PMD_DRV_LOG___(level, type, name, "%s:%u: %s(): " __VA_ARGS__)
81 : : #define PMD_DRV_LOG_(level, type, name, s, ...) \
82 : : PMD_DRV_LOG__(level, type, name,\
83 : : s "\n" PMD_DRV_LOG_COMMA \
84 : : pmd_drv_log_basename(__FILE__) PMD_DRV_LOG_COMMA \
85 : : __LINE__ PMD_DRV_LOG_COMMA \
86 : : __func__, \
87 : : __VA_ARGS__)
88 : :
89 : : #else /* RTE_PMD_MLX5_DEBUG */
90 : : #define PMD_DRV_LOG__(level, type, name, ...) \
91 : : PMD_DRV_LOG___(level, type, name, __VA_ARGS__)
92 : : #define PMD_DRV_LOG_(level, type, name, s, ...) \
93 : : PMD_DRV_LOG__(level, type, name, s "\n", __VA_ARGS__)
94 : :
95 : : #endif /* RTE_PMD_MLX5_DEBUG */
96 : :
97 : : /* claim_zero() does not perform any check when debugging is disabled. */
98 : : #ifdef RTE_PMD_MLX5_DEBUG
99 : :
100 : : #define MLX5_ASSERT(exp) RTE_VERIFY(exp)
101 : : #define claim_zero(...) MLX5_ASSERT((__VA_ARGS__) == 0)
102 : : #define claim_nonzero(...) MLX5_ASSERT((__VA_ARGS__) != 0)
103 : :
104 : : #else /* RTE_PMD_MLX5_DEBUG */
105 : :
106 : : #define MLX5_ASSERT(exp) RTE_ASSERT(exp)
107 : : #define claim_zero(...) (__VA_ARGS__)
108 : : #define claim_nonzero(...) (__VA_ARGS__)
109 : :
110 : : #endif /* RTE_PMD_MLX5_DEBUG */
111 : :
112 : : /**
113 : : * Returns true if debug mode is enabled for fast path operations.
114 : : */
115 : : static inline bool
116 : 0 : mlx5_fp_debug_enabled(void)
117 : : {
118 : : #ifdef RTE_PMD_MLX5_DEBUG
119 : : return true;
120 : : #else
121 : 0 : return false;
122 : : #endif
123 : : }
124 : :
125 : : /* Allocate a buffer on the stack and fill it with a printf format string. */
126 : : #define MKSTR(name, ...) \
127 : : int mkstr_size_##name = snprintf(NULL, 0, "" __VA_ARGS__); \
128 : : char *name = alloca(mkstr_size_##name + 1); \
129 : : \
130 : : memset(name, 0, mkstr_size_##name + 1); \
131 : : snprintf(name, mkstr_size_##name + 1, "" __VA_ARGS__)
132 : :
133 : : enum {
134 : : PCI_VENDOR_ID_MELLANOX = 0x15b3,
135 : : };
136 : :
137 : : enum {
138 : : PCI_DEVICE_ID_MELLANOX_CONNECTX4 = 0x1013,
139 : : PCI_DEVICE_ID_MELLANOX_CONNECTX4VF = 0x1014,
140 : : PCI_DEVICE_ID_MELLANOX_CONNECTX4LX = 0x1015,
141 : : PCI_DEVICE_ID_MELLANOX_CONNECTX4LXVF = 0x1016,
142 : : PCI_DEVICE_ID_MELLANOX_CONNECTX5 = 0x1017,
143 : : PCI_DEVICE_ID_MELLANOX_CONNECTX5VF = 0x1018,
144 : : PCI_DEVICE_ID_MELLANOX_CONNECTX5EX = 0x1019,
145 : : PCI_DEVICE_ID_MELLANOX_CONNECTX5EXVF = 0x101a,
146 : : PCI_DEVICE_ID_MELLANOX_BLUEFIELD = 0xa2d2,
147 : : PCI_DEVICE_ID_MELLANOX_BLUEFIELDVF = 0xa2d3,
148 : : PCI_DEVICE_ID_MELLANOX_CONNECTX6 = 0x101b,
149 : : PCI_DEVICE_ID_MELLANOX_CONNECTX6VF = 0x101c,
150 : : PCI_DEVICE_ID_MELLANOX_CONNECTX6DX = 0x101d,
151 : : PCI_DEVICE_ID_MELLANOX_CONNECTXVF = 0x101e,
152 : : PCI_DEVICE_ID_MELLANOX_BLUEFIELD2 = 0xa2d6,
153 : : PCI_DEVICE_ID_MELLANOX_CONNECTX6LX = 0x101f,
154 : : PCI_DEVICE_ID_MELLANOX_CONNECTX7 = 0x1021,
155 : : PCI_DEVICE_ID_MELLANOX_BLUEFIELD3 = 0Xa2dc,
156 : : PCI_DEVICE_ID_MELLANOX_CONNECTX8 = 0x1023,
157 : : PCI_DEVICE_ID_MELLANOX_CONNECTX9 = 0x1025,
158 : : PCI_DEVICE_ID_MELLANOX_BLUEFIELD4 = 0xa2df,
159 : : PCI_DEVICE_ID_MELLANOX_CONNECTX10 = 0x1027,
160 : : };
161 : :
162 : : /* Maximum number of simultaneous unicast MAC addresses. */
163 : : #define MLX5_MAX_UC_MAC_ADDRESSES 128
164 : : /* Maximum number of simultaneous Multicast MAC addresses. */
165 : : #define MLX5_MAX_MC_MAC_ADDRESSES 128
166 : : /* Maximum number of simultaneous MAC addresses. */
167 : : #define MLX5_MAX_MAC_ADDRESSES \
168 : : (MLX5_MAX_UC_MAC_ADDRESSES + MLX5_MAX_MC_MAC_ADDRESSES)
169 : :
170 : : /* Recognized Infiniband device physical port name types. */
171 : : enum mlx5_nl_phys_port_name_type {
172 : : MLX5_PHYS_PORT_NAME_TYPE_NOTSET = 0, /* Not set. */
173 : : MLX5_PHYS_PORT_NAME_TYPE_LEGACY, /* before kernel ver < 5.0 */
174 : : MLX5_PHYS_PORT_NAME_TYPE_UPLINK, /* p0, kernel ver >= 5.0 */
175 : : MLX5_PHYS_PORT_NAME_TYPE_PFVF, /* pf0vf0, kernel ver >= 5.0 */
176 : : MLX5_PHYS_PORT_NAME_TYPE_PFHPF, /* pf0, kernel ver >= 5.7, HPF rep */
177 : : MLX5_PHYS_PORT_NAME_TYPE_PFSF, /* pf0sf0, kernel ver >= 5.0 */
178 : : MLX5_PHYS_PORT_NAME_TYPE_UNKNOWN, /* Unrecognized. */
179 : : };
180 : :
181 : : struct mlx5_port_nl_info {
182 : : uint32_t ifindex;
183 : : uint8_t valid;
184 : : };
185 : :
186 : : struct mlx5_dev_info {
187 : : uint32_t port_num;
188 : : uint32_t ibindex;
189 : : char ibname[MLX5_FS_NAME_MAX];
190 : : uint8_t probe_opt;
191 : : uint8_t async_mon_ready;
192 : : struct mlx5_port_nl_info *port_info;
193 : : };
194 : :
195 : : /** Switch information returned by mlx5_nl_switch_info(). */
196 : : struct mlx5_switch_info {
197 : : uint32_t master:1; /**< Master device. */
198 : : uint32_t representor:1; /**< Representor device. */
199 : : enum mlx5_nl_phys_port_name_type name_type; /** < Port name type. */
200 : : int32_t ctrl_num; /**< Controller number (valid for c#pf#vf# format). */
201 : : int32_t pf_num; /**< PF number (valid for pfxvfx format only). */
202 : : int32_t port_name; /**< Representor port name. */
203 : : int32_t mpesw_owner; /**< MPESW owner port number. */
204 : : uint64_t switch_id; /**< Switch identifier. */
205 : : };
206 : :
207 : : /* CQE status. */
208 : : enum mlx5_cqe_status {
209 : : MLX5_CQE_STATUS_SW_OWN = -1,
210 : : MLX5_CQE_STATUS_HW_OWN = -2,
211 : : MLX5_CQE_STATUS_ERR = -3,
212 : : };
213 : :
214 : : /**
215 : : * Check whether CQE has an error opcode.
216 : : *
217 : : * @param op_code
218 : : * Opcode to check.
219 : : *
220 : : * @return
221 : : * The CQE status.
222 : : */
223 : : static __rte_always_inline enum mlx5_cqe_status
224 : : check_cqe_error(const uint8_t op_code)
225 : : {
226 : : /* Prevent speculative reading of other fields in CQE until
227 : : * CQE is valid.
228 : : */
229 : : rte_atomic_thread_fence(rte_memory_order_acquire);
230 : :
231 [ # # # # : 0 : if (unlikely(op_code == MLX5_CQE_RESP_ERR ||
# # # # #
# # # # #
# # # # #
# # # ]
232 : : op_code == MLX5_CQE_REQ_ERR))
233 : 0 : return MLX5_CQE_STATUS_ERR;
234 : : return MLX5_CQE_STATUS_SW_OWN;
235 : : }
236 : :
237 : : /**
238 : : * Check whether CQE is valid using owner bit.
239 : : *
240 : : * @param cqe
241 : : * Pointer to CQE.
242 : : * @param cqes_n
243 : : * Size of completion queue.
244 : : * @param ci
245 : : * Consumer index.
246 : : *
247 : : * @return
248 : : * The CQE status.
249 : : */
250 : : static __rte_always_inline enum mlx5_cqe_status
251 : : check_cqe(volatile struct mlx5_cqe *cqe, const uint16_t cqes_n,
252 : : const uint16_t ci)
253 : : {
254 : 0 : const uint16_t idx = ci & cqes_n;
255 : 0 : const uint8_t op_own = cqe->op_own;
256 : 0 : const uint8_t op_owner = MLX5_CQE_OWNER(op_own);
257 : 0 : const uint8_t op_code = MLX5_CQE_OPCODE(op_own);
258 : :
259 [ # # # # : 0 : if (unlikely((op_owner != (!!(idx))) ||
# # # # #
# # # # #
# # # # #
# # # #
# ]
260 : : (op_code == MLX5_CQE_INVALID)))
261 : : return MLX5_CQE_STATUS_HW_OWN;
262 : : return check_cqe_error(op_code);
263 : : }
264 : :
265 : : /**
266 : : * Check whether CQE is valid using validity iteration count.
267 : : *
268 : : * @param cqe
269 : : * Pointer to CQE.
270 : : * @param cqes_n
271 : : * Log 2 of completion queue size.
272 : : * @param ci
273 : : * Consumer index.
274 : : *
275 : : * @return
276 : : * The CQE status.
277 : : */
278 : : static __rte_always_inline enum mlx5_cqe_status
279 : : check_cqe_iteration(volatile struct mlx5_cqe *cqe, const uint16_t cqes_n,
280 : : const uint32_t ci)
281 : : {
282 : 0 : const uint8_t op_own = cqe->op_own;
283 : 0 : const uint8_t op_code = MLX5_CQE_OPCODE(op_own);
284 : 0 : const uint8_t vic = ci >> cqes_n;
285 : :
286 [ # # # # : 0 : if (unlikely((cqe->validity_iteration_count != vic) ||
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
287 : : (op_code == MLX5_CQE_INVALID)))
288 : : return MLX5_CQE_STATUS_HW_OWN;
289 : : return check_cqe_error(op_code);
290 : : }
291 : :
292 : : /*
293 : : * Get PCI address <DBDF> string from EAL device.
294 : : *
295 : : * @param[out] addr
296 : : * The output address buffer string
297 : : * @param[in] size
298 : : * The output buffer size
299 : : * @return
300 : : * - 0 on success.
301 : : * - Negative value and rte_errno is set otherwise.
302 : : */
303 : : __rte_internal
304 : : int mlx5_dev_to_pci_str(const struct rte_device *dev, char *addr, size_t size);
305 : :
306 : : /*
307 : : * Get PCI address from sysfs of a PCI-related device.
308 : : *
309 : : * @param[in] dev_path
310 : : * The sysfs path should not point to the direct plain PCI device.
311 : : * Instead, the node "/device/" is used to access the real device.
312 : : * @param[out] pci_addr
313 : : * Parsed PCI address.
314 : : *
315 : : * @return
316 : : * - 0 on success.
317 : : * - Negative value and rte_errno is set otherwise.
318 : : */
319 : : __rte_internal
320 : : int mlx5_get_pci_addr(const char *dev_path, struct rte_pci_addr *pci_addr);
321 : :
322 : : /*
323 : : * Get kernel network interface name from sysfs IB device path.
324 : : *
325 : : * @param[in] ibdev_path
326 : : * The sysfs path to IB device.
327 : : * @param[out] ifname
328 : : * Interface name output of size IF_NAMESIZE.
329 : : *
330 : : * @return
331 : : * - 0 on success.
332 : : * - Negative value and rte_errno is set otherwise.
333 : : */
334 : : __rte_internal
335 : : int mlx5_get_ifname_sysfs(const char *ibdev_path, char *ifname);
336 : :
337 : : __rte_internal
338 : : int mlx5_auxiliary_get_child_name(const char *dev, const char *node,
339 : : char *child, size_t size);
340 : :
341 : : enum mlx5_class {
342 : : MLX5_CLASS_INVALID,
343 : : MLX5_CLASS_ETH = RTE_BIT64(0),
344 : : MLX5_CLASS_VDPA = RTE_BIT64(1),
345 : : MLX5_CLASS_REGEX = RTE_BIT64(2),
346 : : MLX5_CLASS_COMPRESS = RTE_BIT64(3),
347 : : MLX5_CLASS_CRYPTO = RTE_BIT64(4),
348 : : };
349 : :
350 : : #define MLX5_DBR_SIZE RTE_CACHE_LINE_SIZE
351 : :
352 : : /* devX creation object */
353 : : struct mlx5_devx_obj {
354 : : void *obj; /* The DV object. */
355 : : int id; /* The object ID. */
356 : : };
357 : :
358 : : /* UMR memory buffer used to define 1 entry in indirect mkey. */
359 : : struct mlx5_klm {
360 : : uint32_t byte_count;
361 : : uint32_t mkey;
362 : : uint64_t address;
363 : : };
364 : :
365 : : /** Control for key/values list. */
366 : : struct mlx5_kvargs_ctrl {
367 : : struct rte_kvargs *kvlist; /* Structure containing list of key/values.*/
368 : : bool is_used[RTE_KVARGS_MAX]; /* Indicator which devargs were used. */
369 : : };
370 : :
371 : : /**
372 : : * Call a handler function for each key/value in the list of keys.
373 : : *
374 : : * For each key/value association that matches the given key, calls the
375 : : * handler function with the for a given arg_name passing the value on the
376 : : * dictionary for that key and a given extra argument.
377 : : *
378 : : * @param mkvlist
379 : : * The mlx5_kvargs structure.
380 : : * @param keys
381 : : * A list of keys to process (table of const char *, the last must be NULL).
382 : : * @param handler
383 : : * The function to call for each matching key.
384 : : * @param opaque_arg
385 : : * A pointer passed unchanged to the handler.
386 : : *
387 : : * @return
388 : : * - 0 on success
389 : : * - Negative on error
390 : : */
391 : : __rte_internal
392 : : int
393 : : mlx5_kvargs_process(struct mlx5_kvargs_ctrl *mkvlist, const char *const keys[],
394 : : arg_handler_t handler, void *opaque_arg);
395 : :
396 : : /* All UAR arguments using doorbell register in datapath. */
397 : : struct mlx5_uar_data {
398 : : uint64_t *db;
399 : : /* The doorbell's virtual address mapped to the relevant HW UAR space.*/
400 : : #ifndef RTE_ARCH_64
401 : : rte_spinlock_t *sl_p;
402 : : /* Pointer to UAR access lock required for 32bit implementations. */
403 : : #endif /* RTE_ARCH_64 */
404 : : };
405 : :
406 : : /* DevX UAR control structure. */
407 : : struct mlx5_uar {
408 : : struct mlx5_uar_data bf_db; /* UAR data for Blueflame register. */
409 : : struct mlx5_uar_data cq_db; /* UAR data for CQ arm db register. */
410 : : void *obj; /* DevX UAR object. */
411 : : bool dbnc; /* Doorbell mapped to non-cached region. */
412 : : #ifndef RTE_ARCH_64
413 : : rte_spinlock_t bf_sl;
414 : : rte_spinlock_t cq_sl;
415 : : /* UAR access locks required for 32bit implementations. */
416 : : #endif /* RTE_ARCH_64 */
417 : : };
418 : :
419 : : /**
420 : : * Ring a doorbell and flush the update if requested.
421 : : *
422 : : * @param uar
423 : : * Pointer to UAR data structure.
424 : : * @param val
425 : : * value to write in big endian format.
426 : : * @param index
427 : : * Index of doorbell record.
428 : : * @param db_rec
429 : : * Address of doorbell record.
430 : : * @param flash
431 : : * Decide whether to flush the DB writing using a memory barrier.
432 : : */
433 : : static __rte_always_inline void
434 : : mlx5_doorbell_ring(struct mlx5_uar_data *uar, uint64_t val, uint32_t index,
435 : : volatile uint32_t *db_rec, bool flash)
436 : : {
437 : 0 : rte_io_wmb();
438 [ # # # # : 0 : *db_rec = rte_cpu_to_be_32(index);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ]
439 : : /* Ensure ordering between DB record actual update and UAR access. */
440 : : rte_wmb();
441 : : #ifdef RTE_ARCH_64
442 : 0 : *uar->db = val;
443 : : #else /* !RTE_ARCH_64 */
444 : : rte_spinlock_lock(uar->sl_p);
445 : : *(volatile uint32_t *)uar->db = val;
446 : : rte_io_wmb();
447 : : *((volatile uint32_t *)uar->db + 1) = val >> 32;
448 : : rte_spinlock_unlock(uar->sl_p);
449 : : #endif
450 [ # # # # : 0 : if (flash)
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ]
451 : : rte_wmb();
452 : : }
453 : :
454 : : /**
455 : : * Get the doorbell register mapping type.
456 : : *
457 : : * @param uar_mmap_offset
458 : : * Mmap offset of Verbs/DevX UAR.
459 : : * @param page_size
460 : : * System page size
461 : : *
462 : : * @return
463 : : * 1 for non-cached, 0 otherwise.
464 : : */
465 : : static inline uint16_t
466 : : mlx5_db_map_type_get(off_t uar_mmap_offset, size_t page_size)
467 : : {
468 : 0 : off_t cmd = uar_mmap_offset / page_size;
469 : :
470 : 0 : cmd >>= MLX5_UAR_MMAP_CMD_SHIFT;
471 : 0 : cmd &= MLX5_UAR_MMAP_CMD_MASK;
472 [ # # ]: 0 : if (cmd == MLX5_MMAP_GET_NC_PAGES_CMD)
473 : 0 : return 1;
474 : : return 0;
475 : : }
476 : :
477 : : __rte_internal
478 : : void mlx5_translate_port_name(const char *port_name_in,
479 : : struct mlx5_switch_info *port_info_out);
480 : : void mlx5_glue_constructor(void);
481 : : extern uint8_t mlx5_haswell_broadwell_cpu;
482 : :
483 : : __rte_internal
484 : : void mlx5_common_init(void);
485 : :
486 : : /*
487 : : * Common Driver Interface
488 : : *
489 : : * ConnectX common driver supports multiple classes: net, vDPA, regex, crypto
490 : : * and compress devices. This layer enables creating such multiple classes
491 : : * on a single device by allowing to bind multiple class-specific device
492 : : * drivers to attach to the common driver.
493 : : *
494 : : * ------------ ------------- -------------- ----------------- ------------
495 : : * | mlx5 net | | mlx5 vdpa | | mlx5 regex | | mlx5 compress | | mlx5 ... |
496 : : * | driver | | driver | | driver | | driver | | drivers |
497 : : * ------------ ------------- -------------- ----------------- ------------
498 : : * ||
499 : : * -----------------
500 : : * | mlx5 |
501 : : * | common driver |
502 : : * -----------------
503 : : * | |
504 : : * ----------- -----------------
505 : : * | mlx5 | | mlx5 |
506 : : * | pci dev | | auxiliary dev |
507 : : * ----------- -----------------
508 : : *
509 : : * - mlx5 PCI bus driver binds to mlx5 PCI devices defined by PCI ID table
510 : : * of all related devices.
511 : : * - mlx5 class driver such as net, vDPA, regex defines its specific
512 : : * PCI ID table and mlx5 bus driver probes matching class drivers.
513 : : * - mlx5 common driver is central place that validates supported
514 : : * class combinations.
515 : : * - mlx5 common driver hides bus difference by resolving device address
516 : : * from devargs, locating target RDMA device and probing with it.
517 : : */
518 : :
519 : : /*
520 : : * Device configuration structure.
521 : : *
522 : : * Merged configuration from:
523 : : *
524 : : * - Device capabilities,
525 : : * - User device parameters disabled features.
526 : : */
527 : : struct mlx5_common_dev_config {
528 : : struct mlx5_hca_attr hca_attr; /* HCA attributes. */
529 : : int dbnc; /* Skip doorbell register write barrier. */
530 : : int device_fd; /* Device file descriptor for importation. */
531 : : int pd_handle; /* Protection Domain handle for importation. */
532 : : unsigned int devx:1; /* Whether devx interface is available or not. */
533 : : unsigned int sys_mem_en:1; /* The default memory allocator. */
534 : : unsigned int probe_opt:1; /* Optimize probing . */
535 : : unsigned int mr_mempool_reg_en:1;
536 : : /* Allow/prevent implicit mempool memory registration. */
537 : : unsigned int mr_ext_memseg_en:1;
538 : : /* Whether memseg should be extended for MR creation. */
539 : : };
540 : :
541 : : struct mlx5_common_device {
542 : : struct rte_device *dev;
543 : : TAILQ_ENTRY(mlx5_common_device) next;
544 : : uint32_t classes_loaded;
545 : : void *ctx; /* Verbs/DV/DevX context. */
546 : : void *pd; /* Protection Domain. */
547 : : struct mlx5_dev_info dev_info; /* Device port info queried via netlink. */
548 : : uint32_t pdn; /* Protection Domain Number. */
549 : : struct mlx5_mr_share_cache mr_scache; /* Global shared MR cache. */
550 : : struct mlx5_common_dev_config config; /* Device configuration. */
551 : : };
552 : :
553 : : /**
554 : : * Indicates whether PD and CTX are imported from another process,
555 : : * or created by this process.
556 : : *
557 : : * @param cdev
558 : : * Pointer to common device.
559 : : *
560 : : * @return
561 : : * True if PD and CTX are imported from another process, False otherwise.
562 : : */
563 : : static inline bool
564 : : mlx5_imported_pd_and_ctx(struct mlx5_common_device *cdev)
565 : : {
566 [ # # # # ]: 0 : return cdev->config.device_fd != MLX5_ARG_UNSET &&
567 [ # # ]: 0 : cdev->config.pd_handle != MLX5_ARG_UNSET;
568 : : }
569 : :
570 : : /**
571 : : * Initialization function for the driver called during device probing.
572 : : */
573 : : typedef int (mlx5_class_driver_probe_t)(struct mlx5_common_device *cdev,
574 : : struct mlx5_kvargs_ctrl *mkvlist);
575 : :
576 : : /**
577 : : * Uninitialization function for the driver called during hot-unplugging.
578 : : */
579 : : typedef int (mlx5_class_driver_remove_t)(struct mlx5_common_device *cdev);
580 : :
581 : : /**
582 : : * A structure describing a mlx5 common class driver.
583 : : */
584 : : struct mlx5_class_driver {
585 : : TAILQ_ENTRY(mlx5_class_driver) next;
586 : : enum mlx5_class drv_class; /**< Class of this driver. */
587 : : const char *name; /**< Driver name. */
588 : : mlx5_class_driver_probe_t *probe; /**< Device probe function. */
589 : : mlx5_class_driver_remove_t *remove; /**< Device remove function. */
590 : : const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
591 : : uint32_t probe_again:1;
592 : : /**< Device already probed can be probed again to check new device. */
593 : : uint32_t intr_lsc:1; /**< Supports link state interrupt. */
594 : : uint32_t intr_rmv:1; /**< Supports device remove interrupt. */
595 : : };
596 : :
597 : : /**
598 : : * Register a mlx5 device driver.
599 : : *
600 : : * @param driver
601 : : * A pointer to a mlx5_driver structure describing the driver
602 : : * to be registered.
603 : : */
604 : : __rte_internal
605 : : void
606 : : mlx5_class_driver_register(struct mlx5_class_driver *driver);
607 : :
608 : : /**
609 : : * Test device is a PCI bus device.
610 : : *
611 : : * @param dev
612 : : * Pointer to device.
613 : : *
614 : : * @return
615 : : * - True on device devargs is a PCI bus device.
616 : : * - False otherwise.
617 : : */
618 : : __rte_internal
619 : : bool
620 : : mlx5_dev_is_pci(const struct rte_device *dev);
621 : :
622 : : /**
623 : : * Test PCI device is a VF device.
624 : : *
625 : : * @param pci_dev
626 : : * Pointer to PCI device.
627 : : *
628 : : * @return
629 : : * - True on PCI device is a VF device.
630 : : * - False otherwise.
631 : : */
632 : : __rte_internal
633 : : bool
634 : : mlx5_dev_is_vf_pci(const struct rte_pci_device *pci_dev);
635 : :
636 : : __rte_internal
637 : : int
638 : : mlx5_dev_mempool_subscribe(struct mlx5_common_device *cdev);
639 : :
640 : : __rte_internal
641 : : void
642 : : mlx5_dev_mempool_unregister(struct mlx5_common_device *cdev,
643 : : struct rte_mempool *mp);
644 : :
645 : : __rte_internal
646 : : int
647 : : mlx5_devx_uar_prepare(struct mlx5_common_device *cdev, struct mlx5_uar *uar);
648 : :
649 : : __rte_internal
650 : : void
651 : : mlx5_devx_uar_release(struct mlx5_uar *uar);
652 : :
653 : : /* mlx5_common_os.c */
654 : :
655 : : __rte_internal
656 : : void *
657 : : mlx5_os_get_physical_device_ctx(struct mlx5_common_device *cdev);
658 : :
659 : : int mlx5_os_open_device(struct mlx5_common_device *cdev, uint32_t classes);
660 : : int mlx5_os_pd_prepare(struct mlx5_common_device *cdev);
661 : : int mlx5_os_pd_release(struct mlx5_common_device *cdev);
662 : : int mlx5_os_remote_pd_and_ctx_validate(struct mlx5_common_dev_config *config);
663 : :
664 : : /* mlx5 PMD wrapped MR struct. */
665 : : struct mlx5_pmd_wrapped_mr {
666 : : uint32_t lkey;
667 : : void *addr;
668 : : size_t len;
669 : : void *obj; /* verbs mr object or devx umem object. */
670 : : void *imkey; /* DevX indirect mkey object. */
671 : : };
672 : :
673 : : __rte_internal
674 : : int
675 : : mlx5_os_wrapped_mkey_create(void *ctx, void *pd, uint32_t pdn, void *addr,
676 : : size_t length, struct mlx5_pmd_wrapped_mr *pmd_mr);
677 : :
678 : : __rte_internal
679 : : void
680 : : mlx5_os_wrapped_mkey_destroy(struct mlx5_pmd_wrapped_mr *pmd_mr);
681 : :
682 : : #endif /* RTE_PMD_MLX5_COMMON_H_ */
|
