common/mlx5: add mempool registration facilities
[dpdk.git] / drivers / common / mlx5 / mlx5_common_mp.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2018 6WIND S.A.
3  * Copyright 2018 Mellanox Technologies, Ltd
4  */
5
6 #ifndef RTE_PMD_MLX5_COMMON_MP_H_
7 #define RTE_PMD_MLX5_COMMON_MP_H_
8
9 #include <mlx5_glue.h>
10 #include <rte_eal.h>
11 #include <rte_string_fns.h>
12
13 /* Request types for IPC. */
14 enum mlx5_mp_req_type {
15         MLX5_MP_REQ_VERBS_CMD_FD = 1,
16         MLX5_MP_REQ_CREATE_MR,
17         MLX5_MP_REQ_MEMPOOL_REGISTER,
18         MLX5_MP_REQ_MEMPOOL_UNREGISTER,
19         MLX5_MP_REQ_START_RXTX,
20         MLX5_MP_REQ_STOP_RXTX,
21         MLX5_MP_REQ_QUEUE_STATE_MODIFY,
22         MLX5_MP_REQ_QUEUE_RX_STOP,
23         MLX5_MP_REQ_QUEUE_RX_START,
24         MLX5_MP_REQ_QUEUE_TX_STOP,
25         MLX5_MP_REQ_QUEUE_TX_START,
26 };
27
28 struct mlx5_mp_arg_queue_state_modify {
29         uint8_t is_wq; /* Set if WQ. */
30         uint16_t queue_id; /* DPDK queue ID. */
31         enum ibv_wq_state state; /* WQ requested state. */
32 };
33
34 struct mlx5_mp_arg_queue_id {
35         uint16_t queue_id; /* DPDK queue ID. */
36 };
37
38 struct mlx5_mp_arg_mempool_reg {
39         struct mlx5_mr_share_cache *share_cache;
40         void *pd; /* NULL for MLX5_MP_REQ_MEMPOOL_UNREGISTER */
41         struct rte_mempool *mempool;
42 };
43
44 /* Pameters for IPC. */
45 struct mlx5_mp_param {
46         enum mlx5_mp_req_type type;
47         int port_id;
48         int result;
49         RTE_STD_C11
50         union {
51                 uintptr_t addr; /* MLX5_MP_REQ_CREATE_MR */
52                 struct mlx5_mp_arg_mempool_reg mempool_reg;
53                 /* MLX5_MP_REQ_MEMPOOL_(UN)REGISTER */
54                 struct mlx5_mp_arg_queue_state_modify state_modify;
55                 /* MLX5_MP_REQ_QUEUE_STATE_MODIFY */
56                 struct mlx5_mp_arg_queue_id queue_id;
57                 /* MLX5_MP_REQ_QUEUE_RX/TX_START/STOP */
58         } args;
59 };
60
61 /*  Identifier of a MP process */
62 struct mlx5_mp_id {
63         char name[RTE_MP_MAX_NAME_LEN];
64         uint16_t port_id;
65 };
66
67 /** Request timeout for IPC. */
68 #define MLX5_MP_REQ_TIMEOUT_SEC 5
69
70 /**
71  * Initialize IPC message.
72  *
73  * @param[in] port_id
74  *   Port ID of the device.
75  * @param[out] msg
76  *   Pointer to message to fill in.
77  * @param[in] type
78  *   Message type.
79  */
80 static inline void
81 mp_init_msg(struct mlx5_mp_id *mp_id, struct rte_mp_msg *msg,
82             enum mlx5_mp_req_type type)
83 {
84         struct mlx5_mp_param *param = (struct mlx5_mp_param *)msg->param;
85
86         memset(msg, 0, sizeof(*msg));
87         strlcpy(msg->name, mp_id->name, sizeof(msg->name));
88         msg->len_param = sizeof(*param);
89         param->type = type;
90         param->port_id = mp_id->port_id;
91 }
92
93 __rte_internal
94 int mlx5_mp_init_primary(const char *name, const rte_mp_t primary_action);
95 __rte_internal
96 void mlx5_mp_uninit_primary(const char *name);
97 __rte_internal
98 int mlx5_mp_init_secondary(const char *name, const rte_mp_t secondary_action);
99 __rte_internal
100 void mlx5_mp_uninit_secondary(const char *name);
101 __rte_internal
102 int mlx5_mp_req_mr_create(struct mlx5_mp_id *mp_id, uintptr_t addr);
103 __rte_internal
104 int mlx5_mp_req_mempool_reg(struct mlx5_mp_id *mp_id,
105                         struct mlx5_mr_share_cache *share_cache, void *pd,
106                         struct rte_mempool *mempool, bool reg);
107 __rte_internal
108 int mlx5_mp_req_queue_state_modify(struct mlx5_mp_id *mp_id,
109                                    struct mlx5_mp_arg_queue_state_modify *sm);
110 __rte_internal
111 int mlx5_mp_req_verbs_cmd_fd(struct mlx5_mp_id *mp_id);
112
113 #endif /* RTE_PMD_MLX5_COMMON_MP_H_ */