1mlx5dv_alloc_var / mlx5dv_free_var(3)    mlx5dv_alloc_var / mlx5dv_free_var(3)
2
3
4

NAME

6       mlx5dv_alloc_var - Allocates a VAR
7
8       mlx5dv_free_var - Frees a VAR
9

SYNOPSIS

11              #include <infiniband/mlx5dv.h>
12
13              struct mlx5dv_var *
14              mlx5dv_alloc_var(struct ibv_context *context, uint32_t flags);
15
16              void mlx5dv_free_var(struct mlx5dv_var *dv_var);
17

DESCRIPTION

19       Create / free a VAR which can be used for some device commands over the
20       DEVX interface.
21
22       The DEVX API enables direct access from the user space area to the mlx5
23       device  driver,  the VAR information is needed for few commands related
24       to Virtio.
25

ARGUMENTS

27       context
28              RDMA device context to work on.
29
30       flags  Allocation flags for the UAR.
31
32   dv_var
33              struct mlx5dv_var {
34                  uint32_t page_id;
35                  uint32_t length;
36                  off_t mmap_off;
37                  uint64_t comp_mask;
38              };
39
40       page_id
41              The device page id to be used.
42
43       length The mmap length parameter to be used for mapping a VA to the al‐
44              located VAR entry.
45
46       mmap_off
47              The mmap offset parameter to be used for mapping a VA to the al‐
48              located VAR entry.
49

RETURN VALUE

51       Upon success mlx5dv_alloc_var returns a pointer to the created VAR  ,on
52       error NULL will be returned and errno will be set.
53

SEE ALSO

55       mlx5dv_open_device, mlx5dv_devx_obj_create
56

AUTHOR

58       Yishai Hadas <yishaih@mellanox.com>
59
60
61
62                                         mlx5dv_alloc_var / mlx5dv_free_var(3)