xref: /freebsd/contrib/ofed/libmlx5/mlx5dv_init_obj.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
-*- nroff -*-
Licensed under the OpenIB.org (MIT) - See COPYING.md

MLX5DV_INIT_OBJ 3 2017-02-02 1.0.0
"NAME"
mlx5dv_init_obj - Initialize mlx5 direct verbs object from ibv_xxx structures
"SYNOPSIS"
 #include <infiniband/mlx5dv.h>  "int mlx5dv_init_obj(struct mlx5dv_obj *obj, uint64_t obj_type); 
"DESCRIPTION"
mlx5dv_init_obj() This function will initialize mlx5dv_xxx structs based on supplied type. The information for initialization is taken from ibv_xx structs supplied as part of input. Request information of CQ marks its owned by direct verbs for all consumer index related actions. The initialization type can be combination of several types together.

struct mlx5dv_qp {
uint32_t *dbrec;
struct {
void *buf;
uint32_t wqe_cnt;
uint32_t stride;
} sq;
struct {
void *buf;
uint32_t wqe_cnt;
uint32_t stride;
} rq;
struct {
void *reg;
uint32_t size;
} bf;
uint64_t comp_mask;
};

struct mlx5dv_cq {
void *buf;
uint32_t *dbrec;
uint32_t cqe_cnt;
uint32_t cqe_size;
void *uar;
uint32_t cqn;
uint64_t comp_mask;
};

struct mlx5dv_srq {
void *buf;
uint32_t *dbrec;
uint32_t stride;
uint32_t head;
uint32_t tail;
uint64_t comp_mask;
};

struct mlx5dv_rwq {
void *buf;
uint32_t *dbrec;
uint32_t wqe_cnt;
uint32_t stride;
uint64_t comp_mask;
};

struct mlx5dv_obj {
struct {
struct ibv_qp *in;
struct mlx5dv_qp *out;
} qp;
struct {
struct ibv_cq *in;
struct mlx5dv_cq *out;
} cq;
struct {
struct ibv_srq *in;
struct mlx5dv_srq *out;
} srq;
struct {
struct ibv_wq *in;
struct mlx5dv_rwq *out;
} rwq;
};

enum mlx5dv_obj_type {
MLX5DV_OBJ_QP = 1 << 0,
MLX5DV_OBJ_CQ = 1 << 1,
MLX5DV_OBJ_SRQ = 1 << 2,
MLX5DV_OBJ_RWQ = 1 << 3,
};
"RETURN VALUE"
0 on success or the value of errno on failure (which indicates the failure reason).
"NOTES"
* The information if doorbell is blueflame is based on mlx5dv_qp->bf->size, in case of 0 it's not a BF. * Compatibility masks (comp_mask) are in/out fields.
"SEE ALSO"
mlx5dv (7)
"AUTHORS"

Leon Romanovsky <leonro@mellanox.com>