1mlx5dv_devx_alloc_uar / mlx5dv_dmelvxx5_dfvr_edee_vuxa_ra(l3l)oc_uar / mlx5dv_devx_free_uar(3)
2
3
4

NAME

6       mlx5dv_devx_alloc_uar - Allocates a DEVX UAR
7
8       mlx5dv_devx_free_uar - Frees a DEVX UAR
9

SYNOPSIS

11              #include <infiniband/mlx5dv.h>
12
13              struct mlx5dv_devx_uar *mlx5dv_devx_alloc_uar(struct ibv_context *context,
14                                                            uint32_t flags);
15
16              void mlx5dv_devx_free_uar(struct mlx5dv_devx_uar *devx_uar);
17

DESCRIPTION

19       Create / free a DEVX UAR which is needed for other device commands over
20       the DEVX interface.
21
22       The DEVX API enables direct access from the user space area to the mlx5
23       device  driver, the UAR information is needed for few commands as of QP
24       creation.
25

ARGUMENTS

27       context
28              RDMA device context to work on.
29
30       flags  Allocation flags for the UAR.
31
32   devx_uar
33              struct mlx5dv_devx_uar {
34                  void *reg_addr;
35                  void *base_addr;
36                  uint32_t page_id;
37                  off_t mmap_off;
38                  uint64_t comp_mask;
39              };
40
41       reg_addr
42              The write address of DB/BF.
43
44       base_addr
45              The base address of the UAR.
46
47       page_id
48              The device page id to be used.
49
50       mmap_off
51              The mmap offset parameter to be used for re-mapping, to be  used
52              by a secondary process.
53

RETURN VALUE

55       Upon  success mlx5dv_devx_alloc_uar will return a new struct mlx5dv_de‐
56       vx_uar, on error NULL will be returned and errno will be set.
57

SEE ALSO

59       mlx5dv_open_device, mlx5dv_devx_obj_create
60

AUTHOR

62       Yishai Hadas <yishaih@mellanox.com>
63
64
65
66                               mlx5dv_devx_alloc_uar / mlx5dv_devx_free_uar(3)