+/*
+ * Common Driver Interface
+ *
+ * ConnectX common driver supports multiple classes: net, vDPA, regex, crypto
+ * and compress devices. This layer enables creating such multiple classes
+ * on a single device by allowing to bind multiple class-specific device
+ * drivers to attach to the common driver.
+ *
+ * ------------ ------------- -------------- ----------------- ------------
+ * | mlx5 net | | mlx5 vdpa | | mlx5 regex | | mlx5 compress | | mlx5 ... |
+ * | driver | | driver | | driver | | driver | | drivers |
+ * ------------ ------------- -------------- ----------------- ------------
+ * ||
+ * -----------------
+ * | mlx5 |
+ * | common driver |
+ * -----------------
+ * | |
+ * ----------- -----------------
+ * | mlx5 | | mlx5 |
+ * | pci dev | | auxiliary dev |
+ * ----------- -----------------
+ *
+ * - mlx5 PCI bus driver binds to mlx5 PCI devices defined by PCI ID table
+ * of all related devices.
+ * - mlx5 class driver such as net, vDPA, regex defines its specific
+ * PCI ID table and mlx5 bus driver probes matching class drivers.
+ * - mlx5 common driver is central place that validates supported
+ * class combinations.
+ * - mlx5 common driver hides bus difference by resolving device address
+ * from devargs, locating target RDMA device and probing with it.
+ */
+
+/*
+ * Device configuration structure.
+ *
+ * Merged configuration from:
+ *
+ * - Device capabilities,
+ * - User device parameters disabled features.
+ */
+struct mlx5_common_dev_config {
+ struct mlx5_hca_attr hca_attr; /* HCA attributes. */
+ int dbnc; /* Skip doorbell register write barrier. */
+ unsigned int devx:1; /* Whether devx interface is available or not. */
+ unsigned int sys_mem_en:1; /* The default memory allocator. */
+ unsigned int mr_mempool_reg_en:1;
+ /* Allow/prevent implicit mempool memory registration. */
+ unsigned int mr_ext_memseg_en:1;
+ /* Whether memseg should be extended for MR creation. */
+};
+
+struct mlx5_common_device {
+ struct rte_device *dev;
+ TAILQ_ENTRY(mlx5_common_device) next;
+ uint32_t classes_loaded;
+ void *ctx; /* Verbs/DV/DevX context. */
+ void *pd; /* Protection Domain. */
+ uint32_t pdn; /* Protection Domain Number. */
+ struct mlx5_mr_share_cache mr_scache; /* Global shared MR cache. */
+ struct mlx5_common_dev_config config; /* Device configuration. */
+};
+
+/**
+ * Initialization function for the driver called during device probing.
+ */
+typedef int (mlx5_class_driver_probe_t)(struct mlx5_common_device *dev);
+
+/**
+ * Uninitialization function for the driver called during hot-unplugging.
+ */
+typedef int (mlx5_class_driver_remove_t)(struct mlx5_common_device *dev);
+
+/** Device already probed can be probed again to check for new ports. */
+#define MLX5_DRV_PROBE_AGAIN 0x0004
+
+/**
+ * A structure describing a mlx5 common class driver.
+ */
+struct mlx5_class_driver {
+ TAILQ_ENTRY(mlx5_class_driver) next;
+ enum mlx5_class drv_class; /**< Class of this driver. */
+ const char *name; /**< Driver name. */
+ mlx5_class_driver_probe_t *probe; /**< Device probe function. */
+ mlx5_class_driver_remove_t *remove; /**< Device remove function. */
+ const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
+ uint32_t probe_again:1;
+ /**< Device already probed can be probed again to check new device. */
+ uint32_t intr_lsc:1; /**< Supports link state interrupt. */
+ uint32_t intr_rmv:1; /**< Supports device remove interrupt. */
+};
+
+/**
+ * Register a mlx5 device driver.
+ *
+ * @param driver
+ * A pointer to a mlx5_driver structure describing the driver
+ * to be registered.
+ */
+__rte_internal
+void
+mlx5_class_driver_register(struct mlx5_class_driver *driver);
+
+/**
+ * Test device is a PCI bus device.
+ *
+ * @param dev
+ * Pointer to device.
+ *
+ * @return
+ * - True on device devargs is a PCI bus device.
+ * - False otherwise.
+ */
+__rte_internal
+bool
+mlx5_dev_is_pci(const struct rte_device *dev);
+
+__rte_internal
+int
+mlx5_dev_mempool_subscribe(struct mlx5_common_device *cdev);
+
+__rte_internal
+void
+mlx5_dev_mempool_unregister(struct mlx5_common_device *cdev,
+ struct rte_mempool *mp);
+
+/* mlx5_common_mr.c */
+
+__rte_internal
+uint32_t
+mlx5_mr_mb2mr(struct mlx5_common_device *cdev, struct mlx5_mp_id *mp_id,
+ struct mlx5_mr_ctrl *mr_ctrl, struct rte_mbuf *mbuf);
+
+/* mlx5_common_os.c */
+
+int mlx5_os_open_device(struct mlx5_common_device *cdev, uint32_t classes);
+int mlx5_os_pd_create(struct mlx5_common_device *cdev);
+