.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "mlx5dv_devx_obj_create / destroy / modify /query / general" "3" "" "" ""
.hy
.SH NAME
.PP
mlx5dv_devx_obj_create \- Creates a devx object
.PP
mlx5dv_devx_obj_destroy \- Destroys a devx object
.PP
mlx5dv_devx_obj_modify \- Modifies a devx object
.PP
mlx5dv_devx_obj_query \- Queries a devx object
.PP
mlx5dv_devx_general_cmd \- Issues a general command over the devx
interface
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <infiniband/mlx5dv.h>

struct\ mlx5dv_devx_obj\ *
mlx5dv_devx_obj_create(struct\ ibv_context\ *context,\ const\ void\ *in,\ size_t\ inlen,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ void\ *out,\ size_t\ outlen);
int\ mlx5dv_devx_obj_query(struct\ mlx5dv_devx_obj\ *obj,\ const\ void\ *in,\ size_t\ inlen,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ void\ *out,\ size_t\ outlen);
int\ mlx5dv_devx_obj_modify(struct\ mlx5dv_devx_obj\ *obj,\ const\ void\ *in,\ size_t\ inlen,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ void\ *out,\ size_t\ outlen);
int\ mlx5dv_devx_obj_destroy(struct\ mlx5dv_devx_obj\ *obj);
int\ mlx5dv_devx_general_cmd(struct\ ibv_context\ *context,\ const\ void\ *in,\ size_t\ inlen,
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ void\ *out,\ size_t\ outlen);
\f[]
.fi
.SH DESCRIPTION
.PP
Create / destroy / modify / query a devx object, issue a general command
over the devx interface.
.SH ARGUMENTS
.TP
.B \f[I]context\f[]
RDMA device context to create the action on.
.RS
.RE
.TP
.B \f[I]in\f[]
A buffer which contains the command\[aq]s input data provided in a
device specification format.
.RS
.RE
.TP
.B \f[I]inlen\f[]
The size of \f[I]in\f[] buffer in bytes.
.RS
.RE
.TP
.B \f[I]out\f[]
A buffer which contains the command\[aq]s output data according to the
device specification format.
.RS
.RE
.TP
.B \f[I]outlen\f[]
The size of \f[I]out\f[] buffer in bytes.
.RS
.RE
.TP
.B \f[I]obj\f[]
For query, modify, destroy: the devx object to work on.
.RS
.RE
.SH RETURN VALUE
.PP
Upon success \f[I]mlx5dv_devx_create_obj\f[] will return a new
\f[I]struct mlx5dv_devx_obj\f[] on error NULL will be returned and errno
will be set.
.PP
Upon success query, modify, destroy, general commands, 0 is returned or
the value of errno on a failure.
.SH SEE ALSO
.PP
\f[B]mlx5dv_open_device\f[]
.PP
AUTHOR
.PP
Yishai Hadas <yishaih@mellanox.com>
