[mirror_ubuntu-bionic-kernel.git] / include / rdma / rw.h

/*
 * Copyright (c) 2016 HGST, a Western Digital Company.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 */
#ifndef _RDMA_RW_H
#define _RDMA_RW_H

#include <linux/dma-mapping.h>
#include <linux/scatterlist.h>
#include <rdma/ib_verbs.h>
#include <rdma/rdma_cm.h>
#include <rdma/mr_pool.h>

struct rdma_rw_ctx {
	/* number of RDMA READ/WRITE WRs (not counting MR WRs) */
	u32			nr_ops;

	/* tag for the union below: */
	u8			type;

	union {
		/* for mapping a single SGE: */
		struct {
			struct ib_sge		sge;
			struct ib_rdma_wr	wr;
		} single;

		/* for mapping of multiple SGEs: */
		struct {
			struct ib_sge		*sges;
			struct ib_rdma_wr	*wrs;
		} map;

		/* for registering multiple WRs: */
		struct rdma_rw_reg_ctx {
			struct ib_sge		sge;
			struct ib_rdma_wr	wr;
			struct ib_reg_wr	reg_wr;
			struct ib_send_wr	inv_wr;
			struct ib_mr		*mr;
		} *reg;

		struct {
			struct rdma_rw_reg_ctx	data;
			struct rdma_rw_reg_ctx	prot;
			struct ib_send_wr	sig_inv_wr;
			struct ib_mr		*sig_mr;
			struct ib_sge		sig_sge;
			struct ib_sig_handover_wr sig_wr;
		} *sig;
	};
};

int rdma_rw_ctx_init(struct rdma_rw_ctx *ctx, struct ib_qp *qp, u8 port_num,
		struct scatterlist *sg, u32 sg_cnt, u32 sg_offset,
		u64 remote_addr, u32 rkey, enum dma_data_direction dir);
void rdma_rw_ctx_destroy(struct rdma_rw_ctx *ctx, struct ib_qp *qp, u8 port_num,
		struct scatterlist *sg, u32 sg_cnt,
		enum dma_data_direction dir);

int rdma_rw_ctx_signature_init(struct rdma_rw_ctx *ctx, struct ib_qp *qp,
		u8 port_num, struct scatterlist *sg, u32 sg_cnt,
		struct scatterlist *prot_sg, u32 prot_sg_cnt,
		struct ib_sig_attrs *sig_attrs, u64 remote_addr, u32 rkey,
		enum dma_data_direction dir);
void rdma_rw_ctx_destroy_signature(struct rdma_rw_ctx *ctx, struct ib_qp *qp,
		u8 port_num, struct scatterlist *sg, u32 sg_cnt,
		struct scatterlist *prot_sg, u32 prot_sg_cnt,
		enum dma_data_direction dir);

struct ib_send_wr *rdma_rw_ctx_wrs(struct rdma_rw_ctx *ctx, struct ib_qp *qp,
		u8 port_num, struct ib_cqe *cqe, struct ib_send_wr *chain_wr);
int rdma_rw_ctx_post(struct rdma_rw_ctx *ctx, struct ib_qp *qp, u8 port_num,
		struct ib_cqe *cqe, struct ib_send_wr *chain_wr);

unsigned int rdma_rw_mr_factor(struct ib_device *device, u8 port_num,
		unsigned int maxpages);
void rdma_rw_init_qp(struct ib_device *dev, struct ib_qp_init_attr *attr);
int rdma_rw_init_mrs(struct ib_qp *qp, struct ib_qp_init_attr *attr);
void rdma_rw_cleanup_mrs(struct ib_qp *qp);

#endif /* _RDMA_RW_H */
Commit	Line	Data
a060b562 CH	1	/*
	2	* Copyright (c) 2016 HGST, a Western Digital Company.
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms and conditions of the GNU General Public License,
	6	* version 2, as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*/
	13	#ifndef _RDMA_RW_H
	14	#define _RDMA_RW_H
	15
	16	#include <linux/dma-mapping.h>
	17	#include <linux/scatterlist.h>
	18	#include <rdma/ib_verbs.h>
	19	#include <rdma/rdma_cm.h>
	20	#include <rdma/mr_pool.h>
	21
	22	struct rdma_rw_ctx {
	23	/* number of RDMA READ/WRITE WRs (not counting MR WRs) */
	24	u32 nr_ops;
	25
	26	/* tag for the union below: */
	27	u8 type;
	28
	29	union {
	30	/* for mapping a single SGE: */
	31	struct {
	32	struct ib_sge sge;
	33	struct ib_rdma_wr wr;
	34	} single;
	35
	36	/* for mapping of multiple SGEs: */
	37	struct {
	38	struct ib_sge *sges;
	39	struct ib_rdma_wr *wrs;
	40	} map;
	41
	42	/* for registering multiple WRs: */
	43	struct rdma_rw_reg_ctx {
	44	struct ib_sge sge;
	45	struct ib_rdma_wr wr;
	46	struct ib_reg_wr reg_wr;
	47	struct ib_send_wr inv_wr;
	48	struct ib_mr *mr;
	49	} *reg;
0e353e34 CH	50
	51	struct {
	52	struct rdma_rw_reg_ctx data;
	53	struct rdma_rw_reg_ctx prot;
	54	struct ib_send_wr sig_inv_wr;
	55	struct ib_mr *sig_mr;
	56	struct ib_sge sig_sge;
	57	struct ib_sig_handover_wr sig_wr;
	58	} *sig;
a060b562 CH	59	};
	60	};
	61
	62	int rdma_rw_ctx_init(struct rdma_rw_ctx ctx, struct ib_qp qp, u8 port_num,
	63	struct scatterlist *sg, u32 sg_cnt, u32 sg_offset,
	64	u64 remote_addr, u32 rkey, enum dma_data_direction dir);
	65	void rdma_rw_ctx_destroy(struct rdma_rw_ctx ctx, struct ib_qp qp, u8 port_num,
	66	struct scatterlist *sg, u32 sg_cnt,
	67	enum dma_data_direction dir);
	68
0e353e34 CH	69	int rdma_rw_ctx_signature_init(struct rdma_rw_ctx ctx, struct ib_qp qp,
	70	u8 port_num, struct scatterlist *sg, u32 sg_cnt,
	71	struct scatterlist *prot_sg, u32 prot_sg_cnt,
	72	struct ib_sig_attrs *sig_attrs, u64 remote_addr, u32 rkey,
	73	enum dma_data_direction dir);
	74	void rdma_rw_ctx_destroy_signature(struct rdma_rw_ctx ctx, struct ib_qp qp,
	75	u8 port_num, struct scatterlist *sg, u32 sg_cnt,
	76	struct scatterlist *prot_sg, u32 prot_sg_cnt,
	77	enum dma_data_direction dir);
	78
a060b562 CH	79	struct ib_send_wr rdma_rw_ctx_wrs(struct rdma_rw_ctx ctx, struct ib_qp *qp,
	80	u8 port_num, struct ib_cqe cqe, struct ib_send_wr chain_wr);
	81	int rdma_rw_ctx_post(struct rdma_rw_ctx ctx, struct ib_qp qp, u8 port_num,
	82	struct ib_cqe cqe, struct ib_send_wr chain_wr);
	83
00628182 CL	84	unsigned int rdma_rw_mr_factor(struct ib_device *device, u8 port_num,
00628182 CL	85	unsigned int maxpages);
a060b562 CH	86	void rdma_rw_init_qp(struct ib_device dev, struct ib_qp_init_attr attr);
	87	int rdma_rw_init_mrs(struct ib_qp qp, struct ib_qp_init_attr attr);
	88	void rdma_rw_cleanup_mrs(struct ib_qp *qp);
	89
	90	#endif /* _RDMA_RW_H */