freebsd-skq/contrib/ofed/libmlx5/mlx5dv_query_device.3
Hans Petter Selasky d6b92ffa99 OFED user-space import and update for use with Linux-4.9 compatible RDMA
kernel APIs.

List of sources used:

1) rdma-core was cloned from "https://github.com/linux-rdma/rdma-core.git"
Top commit d65138ef93af30b3ea249f3a84aa6a24ba7f8a75

2) OpenSM was cloned from git://git.openfabrics.org/~halr/opensm.git
Top commit 85f841cf209f791c89a075048a907020e924528d

3) libibmad was cloned from "git://git.openfabrics.org/~iraweiny/libibmad.git"
Tag 1.3.13 with some additional patches from Mellanox.

4) infiniband-diags was cloned from "git://git.openfabrics.org/~iraweiny/infiniband-diags.git"
Tag 1.6.7 with some additional patches from Mellanox.

Added the required Makefiles for building and installing.

Sponsored by:	Mellanox Technologies
2017-08-02 16:00:30 +00:00

52 lines
1.4 KiB
Groff

.\" -*- nroff -*-
.\" Licensed under the OpenIB.org (MIT) - See COPYING.md
.\"
.TH MLX5DV_QUERY_DEVICE 3 2017-02-02 1.0.0
.SH "NAME"
mlx5dv_query_device \- Query device capabilities specific to mlx5
.SH "SYNOPSIS"
.nf
.B #include <infiniband/mlx5dv.h>
.sp
.BI "int mlx5dv_query_device(struct ibv_context *ctx_in,
.BI " struct mlx5dv_context *attrs_out);
.fi
.SH "DESCRIPTION"
.B mlx5dv_query_device()
Query HW device-specific information which is important for data-path, but isn't provided by
\fBibv_query_device\fR(3).
.PP
This function returns version, flags and compatibility mask. The version represents the format
of the internal hardware structures that mlx5dv.h represents. Additions of new fields to the existed
structures are handled by comp_mask field.
.PP
.nf
struct mlx5dv_context {
.in +8
uint8_t version;
uint64_t flags;
uint64_t comp_mask;
.in -8
};
enum mlx5dv_context_flags {
.in +8
/*
* This flag indicates if CQE version 0 or 1 is needed.
*/
MLX5DV_CONTEXT_FLAGS_CQE_V1 = (1 << 0),
MLX5DV_CONTEXT_FLAGS_MPW = (1 << 1), /* Multi packet WQE is supported or not */
.in -8
};
.fi
.SH "RETURN VALUE"
0 on success or the value of errno on failure (which indicates the failure reason).
.SH "NOTES"
* Compatibility mask (comp_mask) is in/out field.
.SH "SEE ALSO"
.BR mlx5dv (7),
.BR ibv_query_device (3)
.SH "AUTHORS"
.TP
Leon Romanovsky <leonro@mellanox.com>