mlx5dv_devx_create_eq(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | ARGUMENTS | NOTES | RETURN VALUE | SEE ALSO | AUTHOR | COLOPHON

mlx5dv_devx_create_eq(3) mlx5 Programmer’s Manualmlx5dv_devx_create_eq(3)

NAME         top

       mlx5dv_devx_create_eq - Create an EQ object

       mlx5dv_devx_destroy_eq - Destroy an EQ object

SYNOPSIS         top

              #include <infiniband/mlx5dv.h>

              struct mlx5dv_devx_eq *
              mlx5dv_devx_create_eq(struct ibv_context *ibctx, const void *in, size_t inlen,
                            void *out, size_t outlen);

              int mlx5dv_devx_destroy_eq(struct mlx5dv_devx_eq *eq);

DESCRIPTION         top

       Create / Destroy an EQ object.  Upon creation, the caller prepares
       the in/out mail boxes based on the device specification format;
       For the input mailbox, caller needs to prepare all fields except
       “eqc.log_page_size” and the pas list, which will be set by the
       driver.  The “eqc.intr” field should be used from the output of
       mlx5dv_devx_alloc_msi_vector().

ARGUMENTS         top

       ibctx  RDMA device context to create the action on.

       in     A buffer which contains the command’s input data provided
              in a device specification format.

       inlen  The size of in buffer in bytes.

       out    A buffer which contains the command’s output data according
              to the device specification format.

       outlen The size of out buffer in bytes.

       eq     The EQ object to work on.

              struct mlx5dv_devx_eq {
                  void *vaddr;
              };

       vaddr  EQ VA that was allocated in the driver for.

NOTES         top

       mlx5dv_devx_query_eqn() will not support vectors which are used by
       mlx5dv_devx_create_eq().

RETURN VALUE         top

       Upon success mlx5dv_devx_create_eq will return a new struct
       mlx5dv_devx_eq; On error NULL will be returned and errno will be
       set.

       Upon success mlx5dv_devx_destroy_eq will return 0, on error errno
       will be returned.

       If the error value is EREMOTEIO, outbox.status and outbox.syndrome
       will contain the command failure details.

SEE ALSO         top

       mlx5dv_devx_alloc_msi_vector(3), mlx5dv_devx_query_eqn(3)

AUTHOR         top

       Mark Zhang ⟨markzhang@nvidia.com⟩

COLOPHON         top

       This page is part of the rdma-core (RDMA Core Userspace Libraries
       and Daemons) project.  Information about the project can be found
       at ⟨https://github.com/linux-rdma/rdma-core⟩.  If you have a bug
       report for this manual page, send it to
       linux-rdma@vger.kernel.org.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/linux-rdma/rdma-core.git⟩ on 2025-08-11.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2025-08-04.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there is
       a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

mlx5                            2022-01-12       mlx5dv_devx_create_eq(3)