xref: /linux/include/rdma/rw.h (revision 2dbc0838bcf24ca59cabc3130cf3b1d6809cdcd4)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (c) 2016 HGST, a Western Digital Company.
4  */
5 #ifndef _RDMA_RW_H
6 #define _RDMA_RW_H
7 
8 #include <linux/dma-mapping.h>
9 #include <linux/scatterlist.h>
10 #include <rdma/ib_verbs.h>
11 #include <rdma/rdma_cm.h>
12 #include <rdma/mr_pool.h>
13 
14 struct rdma_rw_ctx {
15 	/* number of RDMA READ/WRITE WRs (not counting MR WRs) */
16 	u32			nr_ops;
17 
18 	/* tag for the union below: */
19 	u8			type;
20 
21 	union {
22 		/* for mapping a single SGE: */
23 		struct {
24 			struct ib_sge		sge;
25 			struct ib_rdma_wr	wr;
26 		} single;
27 
28 		/* for mapping of multiple SGEs: */
29 		struct {
30 			struct ib_sge		*sges;
31 			struct ib_rdma_wr	*wrs;
32 		} map;
33 
34 		/* for registering multiple WRs: */
35 		struct rdma_rw_reg_ctx {
36 			struct ib_sge		sge;
37 			struct ib_rdma_wr	wr;
38 			struct ib_reg_wr	reg_wr;
39 			struct ib_send_wr	inv_wr;
40 			struct ib_mr		*mr;
41 		} *reg;
42 
43 		struct {
44 			struct rdma_rw_reg_ctx	data;
45 			struct rdma_rw_reg_ctx	prot;
46 			struct ib_send_wr	sig_inv_wr;
47 			struct ib_mr		*sig_mr;
48 			struct ib_sge		sig_sge;
49 			struct ib_sig_handover_wr sig_wr;
50 		} *sig;
51 	};
52 };
53 
54 int rdma_rw_ctx_init(struct rdma_rw_ctx *ctx, struct ib_qp *qp, u8 port_num,
55 		struct scatterlist *sg, u32 sg_cnt, u32 sg_offset,
56 		u64 remote_addr, u32 rkey, enum dma_data_direction dir);
57 void rdma_rw_ctx_destroy(struct rdma_rw_ctx *ctx, struct ib_qp *qp, u8 port_num,
58 		struct scatterlist *sg, u32 sg_cnt,
59 		enum dma_data_direction dir);
60 
61 int rdma_rw_ctx_signature_init(struct rdma_rw_ctx *ctx, struct ib_qp *qp,
62 		u8 port_num, struct scatterlist *sg, u32 sg_cnt,
63 		struct scatterlist *prot_sg, u32 prot_sg_cnt,
64 		struct ib_sig_attrs *sig_attrs, u64 remote_addr, u32 rkey,
65 		enum dma_data_direction dir);
66 void rdma_rw_ctx_destroy_signature(struct rdma_rw_ctx *ctx, struct ib_qp *qp,
67 		u8 port_num, struct scatterlist *sg, u32 sg_cnt,
68 		struct scatterlist *prot_sg, u32 prot_sg_cnt,
69 		enum dma_data_direction dir);
70 
71 struct ib_send_wr *rdma_rw_ctx_wrs(struct rdma_rw_ctx *ctx, struct ib_qp *qp,
72 		u8 port_num, struct ib_cqe *cqe, struct ib_send_wr *chain_wr);
73 int rdma_rw_ctx_post(struct rdma_rw_ctx *ctx, struct ib_qp *qp, u8 port_num,
74 		struct ib_cqe *cqe, struct ib_send_wr *chain_wr);
75 
76 unsigned int rdma_rw_mr_factor(struct ib_device *device, u8 port_num,
77 		unsigned int maxpages);
78 void rdma_rw_init_qp(struct ib_device *dev, struct ib_qp_init_attr *attr);
79 int rdma_rw_init_mrs(struct ib_qp *qp, struct ib_qp_init_attr *attr);
80 void rdma_rw_cleanup_mrs(struct ib_qp *qp);
81 
82 #endif /* _RDMA_RW_H */
83