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 : : PCI_DEVICE_ID_MELLANOX_CONNECTX10C2C = 0x2101,
161 : : };
162 : :
163 : : /* Maximum number of simultaneous unicast MAC addresses. */
164 : : #define MLX5_MAX_UC_MAC_ADDRESSES 128
165 : : /* Maximum number of simultaneous Multicast MAC addresses. */
166 : : #define MLX5_MAX_MC_MAC_ADDRESSES 128
167 : : /* Maximum number of simultaneous MAC addresses. */
168 : : #define MLX5_MAX_MAC_ADDRESSES \
169 : : (MLX5_MAX_UC_MAC_ADDRESSES + MLX5_MAX_MC_MAC_ADDRESSES)
170 : :
171 : : /* Recognized Infiniband device physical port name types. */
172 : : enum mlx5_nl_phys_port_name_type {
173 : : MLX5_PHYS_PORT_NAME_TYPE_NOTSET = 0, /* Not set. */
174 : : MLX5_PHYS_PORT_NAME_TYPE_LEGACY, /* before kernel ver < 5.0 */
175 : : MLX5_PHYS_PORT_NAME_TYPE_UPLINK, /* p0, kernel ver >= 5.0 */
176 : : MLX5_PHYS_PORT_NAME_TYPE_PFVF, /* pf0vf0, kernel ver >= 5.0 */
177 : : MLX5_PHYS_PORT_NAME_TYPE_PFHPF, /* pf0, kernel ver >= 5.7, HPF rep */
178 : : MLX5_PHYS_PORT_NAME_TYPE_PFSF, /* pf0sf0, kernel ver >= 5.0 */
179 : : MLX5_PHYS_PORT_NAME_TYPE_UNKNOWN, /* Unrecognized. */
180 : : };
181 : :
182 : : struct mlx5_port_nl_info {
183 : : uint32_t ifindex;
184 : : uint8_t valid;
185 : : };
186 : :
187 : : struct mlx5_dev_info {
188 : : uint32_t port_num;
189 : : uint32_t ibindex;
190 : : char ibname[MLX5_FS_NAME_MAX];
191 : : uint8_t probe_opt;
192 : : uint8_t async_mon_ready;
193 : : struct mlx5_port_nl_info *port_info;
194 : : };
195 : :
196 : : /** Switch information returned by mlx5_nl_switch_info(). */
197 : : struct mlx5_switch_info {
198 : : uint32_t master:1; /**< Master device. */
199 : : uint32_t representor:1; /**< Representor device. */
200 : : enum mlx5_nl_phys_port_name_type name_type; /** < Port name type. */
201 : : int32_t ctrl_num; /**< Controller number (valid for c#pf#vf# format). */
202 : : int32_t pf_num; /**< PF number (valid for pfxvfx format only). */
203 : : int32_t port_name; /**< Representor port name. */
204 : : int32_t mpesw_owner; /**< MPESW owner port number. */
205 : : uint64_t switch_id; /**< Switch identifier. */
206 : : };
207 : :
208 : : /* CQE status. */
209 : : enum mlx5_cqe_status {
210 : : MLX5_CQE_STATUS_SW_OWN = -1,
211 : : MLX5_CQE_STATUS_HW_OWN = -2,
212 : : MLX5_CQE_STATUS_ERR = -3,
213 : : };
214 : :
215 : : /**
216 : : * Check whether CQE has an error opcode.
217 : : *
218 : : * @param op_code
219 : : * Opcode to check.
220 : : *
221 : : * @return
222 : : * The CQE status.
223 : : */
224 : : static __rte_always_inline enum mlx5_cqe_status
225 : : check_cqe_error(const uint8_t op_code)
226 : : {
227 : : /* Prevent speculative reading of other fields in CQE until
228 : : * CQE is valid.
229 : : */
230 : : rte_atomic_thread_fence(rte_memory_order_acquire);
231 : :
232 [ # # # # : 0 : if (unlikely(op_code == MLX5_CQE_RESP_ERR ||
# # # # #
# # # # #
# # # # #
# # # ]
233 : : op_code == MLX5_CQE_REQ_ERR))
234 : 0 : return MLX5_CQE_STATUS_ERR;
235 : : return MLX5_CQE_STATUS_SW_OWN;
236 : : }
237 : :
238 : : /**
239 : : * Check whether CQE is valid using owner bit.
240 : : *
241 : : * @param cqe
242 : : * Pointer to CQE.
243 : : * @param cqes_n
244 : : * Size of completion queue.
245 : : * @param ci
246 : : * Consumer index.
247 : : *
248 : : * @return
249 : : * The CQE status.
250 : : */
251 : : static __rte_always_inline enum mlx5_cqe_status
252 : : check_cqe(volatile struct mlx5_cqe *cqe, const uint16_t cqes_n,
253 : : const uint16_t ci)
254 : : {
255 : 0 : const uint16_t idx = ci & cqes_n;
256 : 0 : const uint8_t op_own = cqe->op_own;
257 : 0 : const uint8_t op_owner = MLX5_CQE_OWNER(op_own);
258 : 0 : const uint8_t op_code = MLX5_CQE_OPCODE(op_own);
259 : :
260 [ # # # # : 0 : if (unlikely((op_owner != (!!(idx))) ||
# # # # #
# # # # #
# # # # #
# # # #
# ]
261 : : (op_code == MLX5_CQE_INVALID)))
262 : : return MLX5_CQE_STATUS_HW_OWN;
263 : : return check_cqe_error(op_code);
264 : : }
265 : :
266 : : /**
267 : : * Check whether CQE is valid using validity iteration count.
268 : : *
269 : : * @param cqe
270 : : * Pointer to CQE.
271 : : * @param cqes_n
272 : : * Log 2 of completion queue size.
273 : : * @param ci
274 : : * Consumer index.
275 : : *
276 : : * @return
277 : : * The CQE status.
278 : : */
279 : : static __rte_always_inline enum mlx5_cqe_status
280 : : check_cqe_iteration(volatile struct mlx5_cqe *cqe, const uint16_t cqes_n,
281 : : const uint32_t ci)
282 : : {
283 : 0 : const uint8_t op_own = cqe->op_own;
284 : 0 : const uint8_t op_code = MLX5_CQE_OPCODE(op_own);
285 : 0 : const uint8_t vic = ci >> cqes_n;
286 : :
287 [ # # # # : 0 : if (unlikely((cqe->validity_iteration_count != vic) ||
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
288 : : (op_code == MLX5_CQE_INVALID)))
289 : : return MLX5_CQE_STATUS_HW_OWN;
290 : : return check_cqe_error(op_code);
291 : : }
292 : :
293 : : /*
294 : : * Get PCI address <DBDF> string from EAL device.
295 : : *
296 : : * @param[out] addr
297 : : * The output address buffer string
298 : : * @param[in] size
299 : : * The output buffer size
300 : : * @return
301 : : * - 0 on success.
302 : : * - Negative value and rte_errno is set otherwise.
303 : : */
304 : : __rte_internal
305 : : int mlx5_dev_to_pci_str(const struct rte_device *dev, char *addr, size_t size);
306 : :
307 : : /*
308 : : * Get PCI address from sysfs of a PCI-related device.
309 : : *
310 : : * @param[in] dev_path
311 : : * The sysfs path should not point to the direct plain PCI device.
312 : : * Instead, the node "/device/" is used to access the real device.
313 : : * @param[out] pci_addr
314 : : * Parsed PCI address.
315 : : *
316 : : * @return
317 : : * - 0 on success.
318 : : * - Negative value and rte_errno is set otherwise.
319 : : */
320 : : __rte_internal
321 : : int mlx5_get_pci_addr(const char *dev_path, struct rte_pci_addr *pci_addr);
322 : :
323 : : /*
324 : : * Get kernel network interface name from sysfs IB device path.
325 : : *
326 : : * @param[in] ibdev_path
327 : : * The sysfs path to IB device.
328 : : * @param[out] ifname
329 : : * Interface name output of size IF_NAMESIZE.
330 : : *
331 : : * @return
332 : : * - 0 on success.
333 : : * - Negative value and rte_errno is set otherwise.
334 : : */
335 : : __rte_internal
336 : : int mlx5_get_ifname_sysfs(const char *ibdev_path, char *ifname);
337 : :
338 : : __rte_internal
339 : : int mlx5_auxiliary_get_child_name(const char *dev, const char *node,
340 : : char *child, size_t size);
341 : :
342 : : enum mlx5_class {
343 : : MLX5_CLASS_INVALID,
344 : : MLX5_CLASS_ETH = RTE_BIT64(0),
345 : : MLX5_CLASS_VDPA = RTE_BIT64(1),
346 : : MLX5_CLASS_REGEX = RTE_BIT64(2),
347 : : MLX5_CLASS_COMPRESS = RTE_BIT64(3),
348 : : MLX5_CLASS_CRYPTO = RTE_BIT64(4),
349 : : };
350 : :
351 : : #define MLX5_DBR_SIZE RTE_CACHE_LINE_SIZE
352 : :
353 : : /* devX creation object */
354 : : struct mlx5_devx_obj {
355 : : void *obj; /* The DV object. */
356 : : int id; /* The object ID. */
357 : : };
358 : :
359 : : /* UMR memory buffer used to define 1 entry in indirect mkey. */
360 : : struct mlx5_klm {
361 : : uint32_t byte_count;
362 : : uint32_t mkey;
363 : : uint64_t address;
364 : : };
365 : :
366 : : /** Control for key/values list. */
367 : : struct mlx5_kvargs_ctrl {
368 : : struct rte_kvargs *kvlist; /* Structure containing list of key/values.*/
369 : : bool is_used[RTE_KVARGS_MAX]; /* Indicator which devargs were used. */
370 : : };
371 : :
372 : : /**
373 : : * Call a handler function for each key/value in the list of keys.
374 : : *
375 : : * For each key/value association that matches the given key, calls the
376 : : * handler function with the for a given arg_name passing the value on the
377 : : * dictionary for that key and a given extra argument.
378 : : *
379 : : * @param mkvlist
380 : : * The mlx5_kvargs structure.
381 : : * @param keys
382 : : * A list of keys to process (table of const char *, the last must be NULL).
383 : : * @param handler
384 : : * The function to call for each matching key.
385 : : * @param opaque_arg
386 : : * A pointer passed unchanged to the handler.
387 : : *
388 : : * @return
389 : : * - 0 on success
390 : : * - Negative on error
391 : : */
392 : : __rte_internal
393 : : int
394 : : mlx5_kvargs_process(struct mlx5_kvargs_ctrl *mkvlist, const char *const keys[],
395 : : arg_handler_t handler, void *opaque_arg);
396 : :
397 : : /* All UAR arguments using doorbell register in datapath. */
398 : : struct mlx5_uar_data {
399 : : uint64_t *db;
400 : : /* The doorbell's virtual address mapped to the relevant HW UAR space.*/
401 : : #ifndef RTE_ARCH_64
402 : : rte_spinlock_t *sl_p;
403 : : /* Pointer to UAR access lock required for 32bit implementations. */
404 : : #endif /* RTE_ARCH_64 */
405 : : };
406 : :
407 : : /* DevX UAR control structure. */
408 : : struct mlx5_uar {
409 : : struct mlx5_uar_data bf_db; /* UAR data for Blueflame register. */
410 : : struct mlx5_uar_data cq_db; /* UAR data for CQ arm db register. */
411 : : void *obj; /* DevX UAR object. */
412 : : bool dbnc; /* Doorbell mapped to non-cached region. */
413 : : #ifndef RTE_ARCH_64
414 : : rte_spinlock_t bf_sl;
415 : : rte_spinlock_t cq_sl;
416 : : /* UAR access locks required for 32bit implementations. */
417 : : #endif /* RTE_ARCH_64 */
418 : : };
419 : :
420 : : /**
421 : : * Ring a doorbell and flush the update if requested.
422 : : *
423 : : * @param uar
424 : : * Pointer to UAR data structure.
425 : : * @param val
426 : : * value to write in big endian format.
427 : : * @param index
428 : : * Index of doorbell record.
429 : : * @param db_rec
430 : : * Address of doorbell record.
431 : : * @param flash
432 : : * Decide whether to flush the DB writing using a memory barrier.
433 : : */
434 : : static __rte_always_inline void
435 : : mlx5_doorbell_ring(struct mlx5_uar_data *uar, uint64_t val, uint32_t index,
436 : : volatile uint32_t *db_rec, bool flash)
437 : : {
438 : 0 : rte_io_wmb();
439 [ # # # # : 0 : *db_rec = rte_cpu_to_be_32(index);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ]
440 : : /* Ensure ordering between DB record actual update and UAR access. */
441 : : rte_wmb();
442 : : #ifdef RTE_ARCH_64
443 : 0 : *uar->db = val;
444 : : #else /* !RTE_ARCH_64 */
445 : : rte_spinlock_lock(uar->sl_p);
446 : : *(volatile uint32_t *)uar->db = val;
447 : : rte_io_wmb();
448 : : *((volatile uint32_t *)uar->db + 1) = val >> 32;
449 : : rte_spinlock_unlock(uar->sl_p);
450 : : #endif
451 [ # # # # : 0 : if (flash)
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ]
452 : : rte_wmb();
453 : : }
454 : :
455 : : /**
456 : : * Get the doorbell register mapping type.
457 : : *
458 : : * @param uar_mmap_offset
459 : : * Mmap offset of Verbs/DevX UAR.
460 : : * @param page_size
461 : : * System page size
462 : : *
463 : : * @return
464 : : * 1 for non-cached, 0 otherwise.
465 : : */
466 : : static inline uint16_t
467 : : mlx5_db_map_type_get(off_t uar_mmap_offset, size_t page_size)
468 : : {
469 : 0 : off_t cmd = uar_mmap_offset / page_size;
470 : :
471 : 0 : cmd >>= MLX5_UAR_MMAP_CMD_SHIFT;
472 : 0 : cmd &= MLX5_UAR_MMAP_CMD_MASK;
473 [ # # ]: 0 : if (cmd == MLX5_MMAP_GET_NC_PAGES_CMD)
474 : 0 : return 1;
475 : : return 0;
476 : : }
477 : :
478 : : __rte_internal
479 : : void mlx5_translate_port_name(const char *port_name_in,
480 : : struct mlx5_switch_info *port_info_out);
481 : : void mlx5_glue_constructor(void);
482 : : extern uint8_t mlx5_haswell_broadwell_cpu;
483 : :
484 : : __rte_internal
485 : : void mlx5_common_init(void);
486 : :
487 : : /*
488 : : * Common Driver Interface
489 : : *
490 : : * ConnectX common driver supports multiple classes: net, vDPA, regex, crypto
491 : : * and compress devices. This layer enables creating such multiple classes
492 : : * on a single device by allowing to bind multiple class-specific device
493 : : * drivers to attach to the common driver.
494 : : *
495 : : * ------------ ------------- -------------- ----------------- ------------
496 : : * | mlx5 net | | mlx5 vdpa | | mlx5 regex | | mlx5 compress | | mlx5 ... |
497 : : * | driver | | driver | | driver | | driver | | drivers |
498 : : * ------------ ------------- -------------- ----------------- ------------
499 : : * ||
500 : : * -----------------
501 : : * | mlx5 |
502 : : * | common driver |
503 : : * -----------------
504 : : * | |
505 : : * ----------- -----------------
506 : : * | mlx5 | | mlx5 |
507 : : * | pci dev | | auxiliary dev |
508 : : * ----------- -----------------
509 : : *
510 : : * - mlx5 PCI bus driver binds to mlx5 PCI devices defined by PCI ID table
511 : : * of all related devices.
512 : : * - mlx5 class driver such as net, vDPA, regex defines its specific
513 : : * PCI ID table and mlx5 bus driver probes matching class drivers.
514 : : * - mlx5 common driver is central place that validates supported
515 : : * class combinations.
516 : : * - mlx5 common driver hides bus difference by resolving device address
517 : : * from devargs, locating target RDMA device and probing with it.
518 : : */
519 : :
520 : : /*
521 : : * Device configuration structure.
522 : : *
523 : : * Merged configuration from:
524 : : *
525 : : * - Device capabilities,
526 : : * - User device parameters disabled features.
527 : : */
528 : : struct mlx5_common_dev_config {
529 : : struct mlx5_hca_attr hca_attr; /* HCA attributes. */
530 : : int dbnc; /* Skip doorbell register write barrier. */
531 : : int device_fd; /* Device file descriptor for importation. */
532 : : int pd_handle; /* Protection Domain handle for importation. */
533 : : unsigned int devx:1; /* Whether devx interface is available or not. */
534 : : unsigned int sys_mem_en:1; /* The default memory allocator. */
535 : : unsigned int probe_opt:1; /* Optimize probing . */
536 : : unsigned int mr_mempool_reg_en:1;
537 : : /* Allow/prevent implicit mempool memory registration. */
538 : : unsigned int mr_ext_memseg_en:1;
539 : : /* Whether memseg should be extended for MR creation. */
540 : : };
541 : :
542 : : struct mlx5_common_device {
543 : : struct rte_device *dev;
544 : : TAILQ_ENTRY(mlx5_common_device) next;
545 : : uint32_t classes_loaded;
546 : : void *ctx; /* Verbs/DV/DevX context. */
547 : : void *pd; /* Protection Domain. */
548 : : struct mlx5_dev_info dev_info; /* Device port info queried via netlink. */
549 : : uint32_t pdn; /* Protection Domain Number. */
550 : : struct mlx5_mr_share_cache mr_scache; /* Global shared MR cache. */
551 : : struct mlx5_common_dev_config config; /* Device configuration. */
552 : : };
553 : :
554 : : /**
555 : : * Indicates whether PD and CTX are imported from another process,
556 : : * or created by this process.
557 : : *
558 : : * @param cdev
559 : : * Pointer to common device.
560 : : *
561 : : * @return
562 : : * True if PD and CTX are imported from another process, False otherwise.
563 : : */
564 : : static inline bool
565 : : mlx5_imported_pd_and_ctx(struct mlx5_common_device *cdev)
566 : : {
567 [ # # # # ]: 0 : return cdev->config.device_fd != MLX5_ARG_UNSET &&
568 [ # # ]: 0 : cdev->config.pd_handle != MLX5_ARG_UNSET;
569 : : }
570 : :
571 : : /**
572 : : * Initialization function for the driver called during device probing.
573 : : */
574 : : typedef int (mlx5_class_driver_probe_t)(struct mlx5_common_device *cdev,
575 : : struct mlx5_kvargs_ctrl *mkvlist);
576 : :
577 : : /**
578 : : * Uninitialization function for the driver called during hot-unplugging.
579 : : */
580 : : typedef int (mlx5_class_driver_remove_t)(struct mlx5_common_device *cdev);
581 : :
582 : : /**
583 : : * A structure describing a mlx5 common class driver.
584 : : */
585 : : struct mlx5_class_driver {
586 : : TAILQ_ENTRY(mlx5_class_driver) next;
587 : : enum mlx5_class drv_class; /**< Class of this driver. */
588 : : const char *name; /**< Driver name. */
589 : : mlx5_class_driver_probe_t *probe; /**< Device probe function. */
590 : : mlx5_class_driver_remove_t *remove; /**< Device remove function. */
591 : : const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
592 : : uint32_t probe_again:1;
593 : : /**< Device already probed can be probed again to check new device. */
594 : : uint32_t intr_lsc:1; /**< Supports link state interrupt. */
595 : : uint32_t intr_rmv:1; /**< Supports device remove interrupt. */
596 : : };
597 : :
598 : : /**
599 : : * Register a mlx5 device driver.
600 : : *
601 : : * @param driver
602 : : * A pointer to a mlx5_driver structure describing the driver
603 : : * to be registered.
604 : : */
605 : : __rte_internal
606 : : void
607 : : mlx5_class_driver_register(struct mlx5_class_driver *driver);
608 : :
609 : : /**
610 : : * Test device is a PCI bus device.
611 : : *
612 : : * @param dev
613 : : * Pointer to device.
614 : : *
615 : : * @return
616 : : * - True on device devargs is a PCI bus device.
617 : : * - False otherwise.
618 : : */
619 : : __rte_internal
620 : : bool
621 : : mlx5_dev_is_pci(const struct rte_device *dev);
622 : :
623 : : /**
624 : : * Test PCI device is a VF device.
625 : : *
626 : : * @param pci_dev
627 : : * Pointer to PCI device.
628 : : *
629 : : * @return
630 : : * - True on PCI device is a VF device.
631 : : * - False otherwise.
632 : : */
633 : : __rte_internal
634 : : bool
635 : : mlx5_dev_is_vf_pci(const struct rte_pci_device *pci_dev);
636 : :
637 : : __rte_internal
638 : : int
639 : : mlx5_dev_mempool_subscribe(struct mlx5_common_device *cdev);
640 : :
641 : : __rte_internal
642 : : void
643 : : mlx5_dev_mempool_unregister(struct mlx5_common_device *cdev,
644 : : struct rte_mempool *mp);
645 : :
646 : : __rte_internal
647 : : int
648 : : mlx5_devx_uar_prepare(struct mlx5_common_device *cdev, struct mlx5_uar *uar);
649 : :
650 : : __rte_internal
651 : : void
652 : : mlx5_devx_uar_release(struct mlx5_uar *uar);
653 : :
654 : : /* mlx5_common_os.c */
655 : :
656 : : __rte_internal
657 : : void *
658 : : mlx5_os_get_physical_device_ctx(struct mlx5_common_device *cdev);
659 : :
660 : : int mlx5_os_open_device(struct mlx5_common_device *cdev, uint32_t classes);
661 : : int mlx5_os_pd_prepare(struct mlx5_common_device *cdev);
662 : : int mlx5_os_pd_release(struct mlx5_common_device *cdev);
663 : : int mlx5_os_remote_pd_and_ctx_validate(struct mlx5_common_dev_config *config);
664 : :
665 : : /* mlx5 PMD wrapped MR struct. */
666 : : struct mlx5_pmd_wrapped_mr {
667 : : uint32_t lkey;
668 : : void *addr;
669 : : size_t len;
670 : : void *obj; /* verbs mr object or devx umem object. */
671 : : void *imkey; /* DevX indirect mkey object. */
672 : : };
673 : :
674 : : __rte_internal
675 : : int
676 : : mlx5_os_wrapped_mkey_create(void *ctx, void *pd, uint32_t pdn, void *addr,
677 : : size_t length, struct mlx5_pmd_wrapped_mr *pmd_mr);
678 : :
679 : : __rte_internal
680 : : void
681 : : mlx5_os_wrapped_mkey_destroy(struct mlx5_pmd_wrapped_mr *pmd_mr);
682 : :
683 : : #endif /* RTE_PMD_MLX5_COMMON_H_ */
|
