[mirror_ubuntu-eoan-kernel.git] / drivers / infiniband / ulp / iser / iscsi_iser.h

/*
 * iSER transport for the Open iSCSI Initiator & iSER transport internals
 *
 * Copyright (C) 2004 Dmitry Yusupov
 * Copyright (C) 2004 Alex Aizman
 * Copyright (C) 2005 Mike Christie
 * based on code maintained by open-iscsi@googlegroups.com
 *
 * Copyright (c) 2004, 2005, 2006 Voltaire, Inc. All rights reserved.
 * Copyright (c) 2005, 2006 Cisco Systems.  All rights reserved.
 * Copyright (c) 2013 Mellanox Technologies. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *	- Redistributions of source code must retain the above
 *	  copyright notice, this list of conditions and the following
 *	  disclaimer.
 *
 *	- Redistributions in binary form must reproduce the above
 *	  copyright notice, this list of conditions and the following
 *	  disclaimer in the documentation and/or other materials
 *	  provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef __ISCSI_ISER_H__
#define __ISCSI_ISER_H__

#include <linux/types.h>
#include <linux/net.h>
#include <linux/printk.h>
#include <scsi/libiscsi.h>
#include <scsi/scsi_transport_iscsi.h>
#include <scsi/scsi_cmnd.h>
#include <scsi/scsi_device.h>

#include <linux/interrupt.h>
#include <linux/wait.h>
#include <linux/sched.h>
#include <linux/list.h>
#include <linux/slab.h>
#include <linux/dma-mapping.h>
#include <linux/mutex.h>
#include <linux/mempool.h>
#include <linux/uio.h>

#include <linux/socket.h>
#include <linux/in.h>
#include <linux/in6.h>

#include <rdma/ib_verbs.h>
#include <rdma/ib_fmr_pool.h>
#include <rdma/rdma_cm.h>

#define DRV_NAME	"iser"
#define PFX		DRV_NAME ": "
#define DRV_VER		"1.1"

#define iser_dbg(fmt, arg...)				\
	do {						\
		if (iser_debug_level > 2)		\
			printk(KERN_DEBUG PFX "%s:" fmt,\
				__func__ , ## arg);	\
	} while (0)

#define iser_warn(fmt, arg...)				\
	do {						\
		if (iser_debug_level > 0)		\
			pr_warn(PFX "%s:" fmt,          \
				__func__ , ## arg);	\
	} while (0)

#define iser_info(fmt, arg...)				\
	do {						\
		if (iser_debug_level > 1)		\
			pr_info(PFX "%s:" fmt,          \
				__func__ , ## arg);	\
	} while (0)

#define iser_err(fmt, arg...)				\
	do {						\
		printk(KERN_ERR PFX "%s:" fmt,          \
		       __func__ , ## arg);		\
	} while (0)

#define SHIFT_4K	12
#define SIZE_4K	(1ULL << SHIFT_4K)
#define MASK_4K	(~(SIZE_4K-1))

					/* support up to 512KB in one RDMA */
#define ISCSI_ISER_SG_TABLESIZE         (0x80000 >> SHIFT_4K)
#define ISER_DEF_XMIT_CMDS_DEFAULT		512
#if ISCSI_DEF_XMIT_CMDS_MAX > ISER_DEF_XMIT_CMDS_DEFAULT
	#define ISER_DEF_XMIT_CMDS_MAX		ISCSI_DEF_XMIT_CMDS_MAX
#else
	#define ISER_DEF_XMIT_CMDS_MAX		ISER_DEF_XMIT_CMDS_DEFAULT
#endif
#define ISER_DEF_CMD_PER_LUN		ISER_DEF_XMIT_CMDS_MAX

/* QP settings */
/* Maximal bounds on received asynchronous PDUs */
#define ISER_MAX_RX_MISC_PDUS		4 /* NOOP_IN(2) , ASYNC_EVENT(2)   */

#define ISER_MAX_TX_MISC_PDUS		6 /* NOOP_OUT(2), TEXT(1),         *
					   * SCSI_TMFUNC(2), LOGOUT(1) */

#define ISER_QP_MAX_RECV_DTOS		(ISER_DEF_XMIT_CMDS_MAX)

#define ISER_MIN_POSTED_RX		(ISER_DEF_XMIT_CMDS_MAX >> 2)

/* the max TX (send) WR supported by the iSER QP is defined by                 *
 * max_send_wr = T * (1 + D) + C ; D is how many inflight dataouts we expect   *
 * to have at max for SCSI command. The tx posting & completion handling code  *
 * supports -EAGAIN scheme where tx is suspended till the QP has room for more *
 * send WR. D=8 comes from 64K/8K                                              */

#define ISER_INFLIGHT_DATAOUTS		8

#define ISER_QP_MAX_REQ_DTOS		(ISER_DEF_XMIT_CMDS_MAX *    \
					(1 + ISER_INFLIGHT_DATAOUTS) + \
					ISER_MAX_TX_MISC_PDUS        + \
					ISER_MAX_RX_MISC_PDUS)

/* Max registration work requests per command */
#define ISER_MAX_REG_WR_PER_CMD		5

/* For Signature we don't support DATAOUTs so no need to make room for them */
#define ISER_QP_SIG_MAX_REQ_DTOS	(ISER_DEF_XMIT_CMDS_MAX	*       \
					(1 + ISER_MAX_REG_WR_PER_CMD) + \
					ISER_MAX_TX_MISC_PDUS         + \
					ISER_MAX_RX_MISC_PDUS)

#define ISER_VER			0x10
#define ISER_WSV			0x08
#define ISER_RSV			0x04

#define ISER_FASTREG_LI_WRID		0xffffffffffffffffULL

struct iser_hdr {
	u8      flags;
	u8      rsvd[3];
	__be32  write_stag; /* write rkey */
	__be64  write_va;
	__be32  read_stag;  /* read rkey */
	__be64  read_va;
} __attribute__((packed));


#define ISER_ZBVA_NOT_SUPPORTED		0x80
#define ISER_SEND_W_INV_NOT_SUPPORTED	0x40

struct iser_cm_hdr {
	u8      flags;
	u8      rsvd[3];
} __packed;

/* Constant PDU lengths calculations */
#define ISER_HEADERS_LEN  (sizeof(struct iser_hdr) + sizeof(struct iscsi_hdr))

#define ISER_RECV_DATA_SEG_LEN	128
#define ISER_RX_PAYLOAD_SIZE	(ISER_HEADERS_LEN + ISER_RECV_DATA_SEG_LEN)
#define ISER_RX_LOGIN_SIZE	(ISER_HEADERS_LEN + ISCSI_DEF_MAX_RECV_SEG_LEN)

/* Length of an object name string */
#define ISER_OBJECT_NAME_SIZE		    64

enum iser_ib_conn_state {
	ISER_CONN_INIT,		   /* descriptor allocd, no conn          */
	ISER_CONN_PENDING,	   /* in the process of being established */
	ISER_CONN_UP,		   /* up and running                      */
	ISER_CONN_TERMINATING,	   /* in the process of being terminated  */
	ISER_CONN_DOWN,		   /* shut down                           */
	ISER_CONN_STATES_NUM
};

enum iser_task_status {
	ISER_TASK_STATUS_INIT = 0,
	ISER_TASK_STATUS_STARTED,
	ISER_TASK_STATUS_COMPLETED
};

enum iser_data_dir {
	ISER_DIR_IN = 0,	   /* to initiator */
	ISER_DIR_OUT,		   /* from initiator */
	ISER_DIRS_NUM
};

struct iser_data_buf {
	void               *buf;      /* pointer to the sg list               */
	unsigned int       size;      /* num entries of this sg               */
	unsigned long      data_len;  /* total data len                       */
	unsigned int       dma_nents; /* returned by dma_map_sg               */
	char       	   *copy_buf; /* allocated copy buf for SGs unaligned *
	                               * for rdma which are copied            */
	struct scatterlist sg_single; /* SG-ified clone of a non SG SC or     *
				       * unaligned SG                         */
  };

/* fwd declarations */
struct iser_device;
struct iser_cq_desc;
struct iscsi_iser_conn;
struct iscsi_iser_task;
struct iscsi_endpoint;

struct iser_mem_reg {
	u32  lkey;
	u32  rkey;
	u64  va;
	u64  len;
	void *mem_h;
	int  is_mr;
};

struct iser_regd_buf {
	struct iser_mem_reg     reg;        /* memory registration info        */
	void                    *virt_addr;
	struct iser_device      *device;    /* device->device for dma_unmap    */
	enum dma_data_direction direction;  /* direction for dma_unmap	       */
	unsigned int            data_size;
};

enum iser_desc_type {
	ISCSI_TX_CONTROL ,
	ISCSI_TX_SCSI_COMMAND,
	ISCSI_TX_DATAOUT
};

struct iser_tx_desc {
	struct iser_hdr              iser_header;
	struct iscsi_hdr             iscsi_header;
	enum   iser_desc_type        type;
	u64		             dma_addr;
	/* sg[0] points to iser/iscsi headers, sg[1] optionally points to either
	of immediate data, unsolicited data-out or control (login,text) */
	struct ib_sge		     tx_sg[2];
	int                          num_sge;
};

#define ISER_RX_PAD_SIZE	(256 - (ISER_RX_PAYLOAD_SIZE + \
					sizeof(u64) + sizeof(struct ib_sge)))
struct iser_rx_desc {
	struct iser_hdr              iser_header;
	struct iscsi_hdr             iscsi_header;
	char		             data[ISER_RECV_DATA_SEG_LEN];
	u64		             dma_addr;
	struct ib_sge		     rx_sg;
	char		             pad[ISER_RX_PAD_SIZE];
} __attribute__((packed));

#define ISER_MAX_CQ 4

struct iser_conn;
struct iscsi_iser_task;

struct iser_device {
	struct ib_device             *ib_device;
	struct ib_pd	             *pd;
	struct ib_device_attr	     dev_attr;
	struct ib_cq	             *rx_cq[ISER_MAX_CQ];
	struct ib_cq	             *tx_cq[ISER_MAX_CQ];
	struct ib_mr	             *mr;
	struct tasklet_struct	     cq_tasklet[ISER_MAX_CQ];
	struct ib_event_handler      event_handler;
	struct list_head             ig_list; /* entry in ig devices list */
	int                          refcount;
	int                          cq_active_qps[ISER_MAX_CQ];
	int			     cqs_used;
	struct iser_cq_desc	     *cq_desc;
	int                          (*iser_alloc_rdma_reg_res)(struct iser_conn *ib_conn,
								unsigned cmds_max);
	void                         (*iser_free_rdma_reg_res)(struct iser_conn *ib_conn);
	int                          (*iser_reg_rdma_mem)(struct iscsi_iser_task *iser_task,
							  enum iser_data_dir cmd_dir);
	void                         (*iser_unreg_rdma_mem)(struct iscsi_iser_task *iser_task,
							    enum iser_data_dir cmd_dir);
};

#define ISER_CHECK_GUARD	0xc0
#define ISER_CHECK_REFTAG	0x0f
#define ISER_CHECK_APPTAG	0x30

enum iser_reg_indicator {
	ISER_DATA_KEY_VALID	= 1 << 0,
	ISER_PROT_KEY_VALID	= 1 << 1,
	ISER_SIG_KEY_VALID	= 1 << 2,
	ISER_FASTREG_PROTECTED	= 1 << 3,
};

struct iser_pi_context {
	struct ib_mr                   *prot_mr;
	struct ib_fast_reg_page_list   *prot_frpl;
	struct ib_mr                   *sig_mr;
};

struct fast_reg_descriptor {
	struct list_head		  list;
	/* For fast registration - FRWR */
	struct ib_mr			 *data_mr;
	struct ib_fast_reg_page_list     *data_frpl;
	struct iser_pi_context		 *pi_ctx;
	/* registration indicators container */
	u8				  reg_indicators;
};

struct iser_conn {
	struct iscsi_iser_conn       *iser_conn; /* iser conn for upcalls  */
	struct iscsi_endpoint	     *ep;
	enum iser_ib_conn_state	     state;	    /* rdma connection state   */
	atomic_t		     refcount;
	spinlock_t		     lock;	    /* used for state changes  */
	struct iser_device           *device;       /* device context          */
	struct rdma_cm_id            *cma_id;       /* CMA ID		       */
	struct ib_qp	             *qp;           /* QP 		       */
	wait_queue_head_t	     wait;          /* waitq for conn/disconn  */
	unsigned		     qp_max_recv_dtos; /* num of rx buffers */
	unsigned		     qp_max_recv_dtos_mask; /* above minus 1 */
	unsigned		     min_posted_rx; /* qp_max_recv_dtos >> 2 */
	int                          post_recv_buf_count; /* posted rx count  */
	atomic_t                     post_send_buf_count; /* posted tx count   */
	char 			     name[ISER_OBJECT_NAME_SIZE];
	struct list_head	     conn_list;       /* entry in ig conn list */

	char  			     *login_buf;
	char			     *login_req_buf, *login_resp_buf;
	u64			     login_req_dma, login_resp_dma;
	unsigned int 		     rx_desc_head;
	struct iser_rx_desc	     *rx_descs;
	struct ib_recv_wr	     rx_wr[ISER_MIN_POSTED_RX];
	bool			     pi_support;

	/* Connection memory registration pool */
	union {
		struct {
			struct ib_fmr_pool      *pool;	   /* pool of IB FMRs         */
			struct iser_page_vec	*page_vec; /* represents SG to fmr maps*
							    * maps serialized as tx is*/
		} fmr;
		struct {
			struct list_head	pool;
			int			pool_size;
		} fastreg;
	};
};

struct iscsi_iser_conn {
	struct iscsi_conn            *iscsi_conn;/* ptr to iscsi conn */
	struct iser_conn             *ib_conn;   /* iSER IB conn      */
};

struct iscsi_iser_task {
	struct iser_tx_desc          desc;
	struct iscsi_iser_conn	     *iser_conn;
	enum iser_task_status 	     status;
	struct scsi_cmnd	     *sc;
	int                          command_sent;  /* set if command  sent  */
	int                          dir[ISER_DIRS_NUM];      /* set if dir use*/
	struct iser_regd_buf         rdma_regd[ISER_DIRS_NUM];/* regd rdma buf */
	struct iser_data_buf         data[ISER_DIRS_NUM];     /* orig. data des*/
	struct iser_data_buf         data_copy[ISER_DIRS_NUM];/* contig. copy  */
	struct iser_data_buf         prot[ISER_DIRS_NUM];     /* prot desc     */
	struct iser_data_buf         prot_copy[ISER_DIRS_NUM];/* prot copy     */
};

struct iser_page_vec {
	u64 *pages;
	int length;
	int offset;
	int data_size;
};

struct iser_cq_desc {
	struct iser_device           *device;
	int                          cq_index;
};

struct iser_global {
	struct mutex      device_list_mutex;/*                   */
	struct list_head  device_list;	     /* all iSER devices */
	struct mutex      connlist_mutex;
	struct list_head  connlist;		/* all iSER IB connections */

	struct kmem_cache *desc_cache;
};

extern struct iser_global ig;
extern int iser_debug_level;
extern bool iser_pi_enable;
extern int iser_pi_guard;

/* allocate connection resources needed for rdma functionality */
int iser_conn_set_full_featured_mode(struct iscsi_conn *conn);

int iser_send_control(struct iscsi_conn *conn,
		      struct iscsi_task *task);

int iser_send_command(struct iscsi_conn *conn,
		      struct iscsi_task *task);

int iser_send_data_out(struct iscsi_conn *conn,
		       struct iscsi_task *task,
		       struct iscsi_data *hdr);

void iscsi_iser_recv(struct iscsi_conn *conn,
		     struct iscsi_hdr       *hdr,
		     char                   *rx_data,
		     int                    rx_data_len);

void iser_conn_init(struct iser_conn *ib_conn);

void iser_conn_get(struct iser_conn *ib_conn);

int iser_conn_put(struct iser_conn *ib_conn, int destroy_cma_id_allowed);

void iser_conn_terminate(struct iser_conn *ib_conn);

void iser_rcv_completion(struct iser_rx_desc *desc,
			 unsigned long    dto_xfer_len,
			struct iser_conn *ib_conn);

void iser_snd_completion(struct iser_tx_desc *desc, struct iser_conn *ib_conn);

void iser_task_rdma_init(struct iscsi_iser_task *task);

void iser_task_rdma_finalize(struct iscsi_iser_task *task);

void iser_free_rx_descriptors(struct iser_conn *ib_conn);

void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_task *iser_task,
				     struct iser_data_buf *mem,
				     struct iser_data_buf *mem_copy,
				     enum iser_data_dir cmd_dir);

int  iser_reg_rdma_mem_fmr(struct iscsi_iser_task *task,
			   enum iser_data_dir cmd_dir);
int  iser_reg_rdma_mem_fastreg(struct iscsi_iser_task *task,
			       enum iser_data_dir cmd_dir);

int  iser_connect(struct iser_conn   *ib_conn,
		  struct sockaddr_in *src_addr,
		  struct sockaddr_in *dst_addr,
		  int                non_blocking);

int  iser_reg_page_vec(struct iser_conn     *ib_conn,
		       struct iser_page_vec *page_vec,
		       struct iser_mem_reg  *mem_reg);

void iser_unreg_mem_fmr(struct iscsi_iser_task *iser_task,
			enum iser_data_dir cmd_dir);
void iser_unreg_mem_fastreg(struct iscsi_iser_task *iser_task,
			    enum iser_data_dir cmd_dir);

int  iser_post_recvl(struct iser_conn *ib_conn);
int  iser_post_recvm(struct iser_conn *ib_conn, int count);
int  iser_post_send(struct iser_conn *ib_conn, struct iser_tx_desc *tx_desc);

int iser_dma_map_task_data(struct iscsi_iser_task *iser_task,
			    struct iser_data_buf       *data,
			    enum   iser_data_dir       iser_dir,
			    enum   dma_data_direction  dma_dir);

void iser_dma_unmap_task_data(struct iscsi_iser_task *iser_task,
			      struct iser_data_buf *data);
int  iser_initialize_task_headers(struct iscsi_task *task,
			struct iser_tx_desc *tx_desc);
int iser_alloc_rx_descriptors(struct iser_conn *ib_conn, struct iscsi_session *session);
int iser_create_fmr_pool(struct iser_conn *ib_conn, unsigned cmds_max);
void iser_free_fmr_pool(struct iser_conn *ib_conn);
int iser_create_fastreg_pool(struct iser_conn *ib_conn, unsigned cmds_max);
void iser_free_fastreg_pool(struct iser_conn *ib_conn);
u8 iser_check_task_pi_status(struct iscsi_iser_task *iser_task,
			     enum iser_data_dir cmd_dir, sector_t *sector);
#endif
Commit	Line	Data
49cd5382 OG	1	/*
	2	* iSER transport for the Open iSCSI Initiator & iSER transport internals
	3	*
	4	* Copyright (C) 2004 Dmitry Yusupov
	5	* Copyright (C) 2004 Alex Aizman
	6	* Copyright (C) 2005 Mike Christie
	7	* based on code maintained by open-iscsi@googlegroups.com
	8	*
	9	* Copyright (c) 2004, 2005, 2006 Voltaire, Inc. All rights reserved.
	10	* Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
28f292e8	11	* Copyright (c) 2013 Mellanox Technologies. All rights reserved.
49cd5382 OG	12	*
	13	* This software is available to you under a choice of one of two
	14	* licenses. You may choose to be licensed under the terms of the GNU
	15	* General Public License (GPL) Version 2, available from the file
	16	* COPYING in the main directory of this source tree, or the
	17	* OpenIB.org BSD license below:
	18	*
	19	* Redistribution and use in source and binary forms, with or
	20	* without modification, are permitted provided that the following
	21	* conditions are met:
	22	*
	23	* - Redistributions of source code must retain the above
	24	* copyright notice, this list of conditions and the following
	25	* disclaimer.
	26	*
	27	* - Redistributions in binary form must reproduce the above
	28	* copyright notice, this list of conditions and the following
	29	* disclaimer in the documentation and/or other materials
	30	* provided with the distribution.
	31	*
	32	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	33	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	34	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	35	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	36	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	37	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	38	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	39	* SOFTWARE.
49cd5382 OG	40	*/
	41	#ifndef __ISCSI_ISER_H__
	42	#define __ISCSI_ISER_H__
	43
	44	#include <linux/types.h>
	45	#include <linux/net.h>
4f363882	46	#include <linux/printk.h>
49cd5382 OG	47	#include <scsi/libiscsi.h>
49cd5382 OG	48	#include <scsi/scsi_transport_iscsi.h>
177e31bd SG	49	#include <scsi/scsi_cmnd.h>
177e31bd SG	50	#include <scsi/scsi_device.h>
49cd5382	51
a6b7a407	52	#include <linux/interrupt.h>
49cd5382 OG	53	#include <linux/wait.h>
	54	#include <linux/sched.h>
	55	#include <linux/list.h>
	56	#include <linux/slab.h>
	57	#include <linux/dma-mapping.h>
	58	#include <linux/mutex.h>
	59	#include <linux/mempool.h>
	60	#include <linux/uio.h>
	61
	62	#include <linux/socket.h>
	63	#include <linux/in.h>
	64	#include <linux/in6.h>
	65
	66	#include <rdma/ib_verbs.h>
	67	#include <rdma/ib_fmr_pool.h>
	68	#include <rdma/rdma_cm.h>
	69
	70	#define DRV_NAME "iser"
	71	#define PFX DRV_NAME ": "
c1d786e6	72	#define DRV_VER "1.1"
49cd5382 OG	73
49cd5382 OG	74	#define iser_dbg(fmt, arg...) \
6f735e36	75	do { \
4f363882	76	if (iser_debug_level > 2) \
6f735e36 ED	77	printk(KERN_DEBUG PFX "%s:" fmt,\
	78	__func__ , ## arg); \
	79	} while (0)
	80
	81	#define iser_warn(fmt, arg...) \
4f363882	82	do { \
f91424cf	83	if (iser_debug_level > 0) \
4f363882 RD	84	pr_warn(PFX "%s:" fmt, \
	85	__func__ , ## arg); \
	86	} while (0)
	87
	88	#define iser_info(fmt, arg...) \
49cd5382	89	do { \
f91424cf	90	if (iser_debug_level > 1) \
4f363882	91	pr_info(PFX "%s:" fmt, \
49cd5382 OG	92	__func__ , ## arg); \
	93	} while (0)
	94
	95	#define iser_err(fmt, arg...) \
	96	do { \
	97	printk(KERN_ERR PFX "%s:" fmt, \
	98	__func__ , ## arg); \
	99	} while (0)
	100
8dfa0876	101	#define SHIFT_4K 12
0ace64b8	102	#define SIZE_4K (1ULL << SHIFT_4K)
8dfa0876 EZ	103	#define MASK_4K (~(SIZE_4K-1))
8dfa0876 EZ	104
25985edc	105	/* support up to 512KB in one RDMA */
8dfa0876	106	#define ISCSI_ISER_SG_TABLESIZE (0x80000 >> SHIFT_4K)
b7f04513 SP	107	#define ISER_DEF_XMIT_CMDS_DEFAULT 512
	108	#if ISCSI_DEF_XMIT_CMDS_MAX > ISER_DEF_XMIT_CMDS_DEFAULT
	109	#define ISER_DEF_XMIT_CMDS_MAX ISCSI_DEF_XMIT_CMDS_MAX
	110	#else
	111	#define ISER_DEF_XMIT_CMDS_MAX ISER_DEF_XMIT_CMDS_DEFAULT
	112	#endif
	113	#define ISER_DEF_CMD_PER_LUN ISER_DEF_XMIT_CMDS_MAX
49cd5382 OG	114
	115	/* QP settings */
	116	/* Maximal bounds on received asynchronous PDUs */
	117	#define ISER_MAX_RX_MISC_PDUS 4 /* NOOP_IN(2) , ASYNC_EVENT(2) */
	118
	119	#define ISER_MAX_TX_MISC_PDUS 6 /* NOOP_OUT(2), TEXT(1), *
	120	* SCSI_TMFUNC(2), LOGOUT(1) */
	121
b7f04513	122	#define ISER_QP_MAX_RECV_DTOS (ISER_DEF_XMIT_CMDS_MAX)
bcc60c38	123
b7f04513	124	#define ISER_MIN_POSTED_RX (ISER_DEF_XMIT_CMDS_MAX >> 2)
49cd5382 OG	125
	126	/* the max TX (send) WR supported by the iSER QP is defined by *
	127	* max_send_wr = T * (1 + D) + C ; D is how many inflight dataouts we expect *
	128	* to have at max for SCSI command. The tx posting & completion handling code *
	129	* supports -EAGAIN scheme where tx is suspended till the QP has room for more *
	130	* send WR. D=8 comes from 64K/8K */
	131
	132	#define ISER_INFLIGHT_DATAOUTS 8
	133
b7f04513	134	#define ISER_QP_MAX_REQ_DTOS (ISER_DEF_XMIT_CMDS_MAX * \
49cd5382 OG	135	(1 + ISER_INFLIGHT_DATAOUTS) + \
	136	ISER_MAX_TX_MISC_PDUS + \
	137	ISER_MAX_RX_MISC_PDUS)
	138
6b5a8fb0 AT	139	/* Max registration work requests per command */
	140	#define ISER_MAX_REG_WR_PER_CMD 5
	141
	142	/* For Signature we don't support DATAOUTs so no need to make room for them */
	143	#define ISER_QP_SIG_MAX_REQ_DTOS (ISER_DEF_XMIT_CMDS_MAX * \
	144	(1 + ISER_MAX_REG_WR_PER_CMD) + \
	145	ISER_MAX_TX_MISC_PDUS + \
	146	ISER_MAX_RX_MISC_PDUS)
	147
49cd5382 OG	148	#define ISER_VER 0x10
	149	#define ISER_WSV 0x08
	150	#define ISER_RSV 0x04
	151
7306b8fa	152	#define ISER_FASTREG_LI_WRID 0xffffffffffffffffULL
db523b8d	153
49cd5382 OG	154	struct iser_hdr {
	155	u8 flags;
	156	u8 rsvd[3];
	157	__be32 write_stag; /* write rkey */
	158	__be64 write_va;
	159	__be32 read_stag; /* read rkey */
	160	__be64 read_va;
	161	} __attribute__((packed));
	162
8d8399de OG	163
	164	#define ISER_ZBVA_NOT_SUPPORTED 0x80
	165	#define ISER_SEND_W_INV_NOT_SUPPORTED 0x40
	166
	167	struct iser_cm_hdr {
	168	u8 flags;
	169	u8 rsvd[3];
	170	} __packed;
	171
bcc60c38 OG	172	/* Constant PDU lengths calculations */
	173	#define ISER_HEADERS_LEN (sizeof(struct iser_hdr) + sizeof(struct iscsi_hdr))
	174
	175	#define ISER_RECV_DATA_SEG_LEN 128
	176	#define ISER_RX_PAYLOAD_SIZE (ISER_HEADERS_LEN + ISER_RECV_DATA_SEG_LEN)
	177	#define ISER_RX_LOGIN_SIZE (ISER_HEADERS_LEN + ISCSI_DEF_MAX_RECV_SEG_LEN)
49cd5382 OG	178
	179	/* Length of an object name string */
	180	#define ISER_OBJECT_NAME_SIZE 64
	181
	182	enum iser_ib_conn_state {
	183	ISER_CONN_INIT, /* descriptor allocd, no conn */
	184	ISER_CONN_PENDING, /* in the process of being established */
	185	ISER_CONN_UP, /* up and running */
	186	ISER_CONN_TERMINATING, /* in the process of being terminated */
	187	ISER_CONN_DOWN, /* shut down */
	188	ISER_CONN_STATES_NUM
	189	};
	190
	191	enum iser_task_status {
	192	ISER_TASK_STATUS_INIT = 0,
	193	ISER_TASK_STATUS_STARTED,
	194	ISER_TASK_STATUS_COMPLETED
	195	};
	196
	197	enum iser_data_dir {
	198	ISER_DIR_IN = 0, /* to initiator */
	199	ISER_DIR_OUT, /* from initiator */
	200	ISER_DIRS_NUM
	201	};
	202
	203	struct iser_data_buf {
	204	void buf; / pointer to the sg list */
	205	unsigned int size; /* num entries of this sg */
	206	unsigned long data_len; /* total data len */
	207	unsigned int dma_nents; /* returned by dma_map_sg */
	208	char copy_buf; / allocated copy buf for SGs unaligned *
	209	* for rdma which are copied */
	210	struct scatterlist sg_single; /* SG-ified clone of a non SG SC or *
	211	* unaligned SG */
	212	};
	213
	214	/* fwd declarations */
	215	struct iser_device;
5a33a669	216	struct iser_cq_desc;
49cd5382	217	struct iscsi_iser_conn;
2261ec3d	218	struct iscsi_iser_task;
412eeafa	219	struct iscsi_endpoint;
49cd5382 OG	220
	221	struct iser_mem_reg {
	222	u32 lkey;
	223	u32 rkey;
	224	u64 va;
	225	u64 len;
	226	void *mem_h;
5587856c	227	int is_mr;
49cd5382 OG	228	};
	229
	230	struct iser_regd_buf {
	231	struct iser_mem_reg reg; /* memory registration info */
	232	void *virt_addr;
	233	struct iser_device device; / device->device for dma_unmap */
49cd5382 OG	234	enum dma_data_direction direction; /* direction for dma_unmap */
49cd5382 OG	235	unsigned int data_size;
49cd5382 OG	236	};
	237
	238	enum iser_desc_type {
49cd5382 OG	239	ISCSI_TX_CONTROL ,
	240	ISCSI_TX_SCSI_COMMAND,
	241	ISCSI_TX_DATAOUT
	242	};
	243
f19624aa	244	struct iser_tx_desc {
49cd5382 OG	245	struct iser_hdr iser_header;
49cd5382 OG	246	struct iscsi_hdr iscsi_header;
49cd5382	247	enum iser_desc_type type;
f19624aa OG	248	u64 dma_addr;
	249	/* sg[0] points to iser/iscsi headers, sg[1] optionally points to either
	250	of immediate data, unsolicited data-out or control (login,text) */
	251	struct ib_sge tx_sg[2];
	252	int num_sge;
49cd5382 OG	253	};
49cd5382 OG	254
bcc60c38 OG	255	#define ISER_RX_PAD_SIZE (256 - (ISER_RX_PAYLOAD_SIZE + \
	256	sizeof(u64) + sizeof(struct ib_sge)))
	257	struct iser_rx_desc {
	258	struct iser_hdr iser_header;
	259	struct iscsi_hdr iscsi_header;
	260	char data[ISER_RECV_DATA_SEG_LEN];
	261	u64 dma_addr;
	262	struct ib_sge rx_sg;
	263	char pad[ISER_RX_PAD_SIZE];
	264	} __attribute__((packed));
	265
5a33a669 AT	266	#define ISER_MAX_CQ 4
5a33a669 AT	267
b4e155ff SG	268	struct iser_conn;
	269	struct iscsi_iser_task;
	270
49cd5382 OG	271	struct iser_device {
	272	struct ib_device *ib_device;
	273	struct ib_pd *pd;
65198d6b	274	struct ib_device_attr dev_attr;
5a33a669 AT	275	struct ib_cq *rx_cq[ISER_MAX_CQ];
5a33a669 AT	276	struct ib_cq *tx_cq[ISER_MAX_CQ];
49cd5382	277	struct ib_mr *mr;
5a33a669	278	struct tasklet_struct cq_tasklet[ISER_MAX_CQ];
2110f9bf	279	struct ib_event_handler event_handler;
49cd5382 OG	280	struct list_head ig_list; /* entry in ig devices list */
49cd5382 OG	281	int refcount;
5a33a669 AT	282	int cq_active_qps[ISER_MAX_CQ];
	283	int cqs_used;
	284	struct iser_cq_desc *cq_desc;
b4e155ff SG	285	int (iser_alloc_rdma_reg_res)(struct iser_conn ib_conn,
	286	unsigned cmds_max);
	287	void (iser_free_rdma_reg_res)(struct iser_conn ib_conn);
	288	int (iser_reg_rdma_mem)(struct iscsi_iser_task iser_task,
	289	enum iser_data_dir cmd_dir);
	290	void (iser_unreg_rdma_mem)(struct iscsi_iser_task iser_task,
	291	enum iser_data_dir cmd_dir);
49cd5382 OG	292	};
49cd5382 OG	293
177e31bd SG	294	#define ISER_CHECK_GUARD 0xc0
	295	#define ISER_CHECK_REFTAG 0x0f
	296	#define ISER_CHECK_APPTAG 0x30
	297
73bc06b7	298	enum iser_reg_indicator {
6b5a8fb0 AT	299	ISER_DATA_KEY_VALID = 1 << 0,
	300	ISER_PROT_KEY_VALID = 1 << 1,
	301	ISER_SIG_KEY_VALID = 1 << 2,
	302	ISER_FASTREG_PROTECTED = 1 << 3,
	303	};
	304
	305	struct iser_pi_context {
	306	struct ib_mr *prot_mr;
	307	struct ib_fast_reg_page_list *prot_frpl;
	308	struct ib_mr *sig_mr;
73bc06b7 SG	309	};
73bc06b7 SG	310
5587856c SG	311	struct fast_reg_descriptor {
	312	struct list_head list;
	313	/* For fast registration - FRWR */
	314	struct ib_mr *data_mr;
	315	struct ib_fast_reg_page_list *data_frpl;
6b5a8fb0	316	struct iser_pi_context *pi_ctx;
73bc06b7 SG	317	/* registration indicators container */
73bc06b7 SG	318	u8 reg_indicators;
5587856c SG	319	};
5587856c SG	320
49cd5382 OG	321	struct iser_conn {
49cd5382 OG	322	struct iscsi_iser_conn iser_conn; / iser conn for upcalls */
412eeafa	323	struct iscsi_endpoint *ep;
49cd5382	324	enum iser_ib_conn_state state; /* rdma connection state */
b40977d9	325	atomic_t refcount;
49cd5382 OG	326	spinlock_t lock; /* used for state changes */
	327	struct iser_device device; / device context */
	328	struct rdma_cm_id cma_id; / CMA ID */
	329	struct ib_qp qp; / QP */
49cd5382	330	wait_queue_head_t wait; /* waitq for conn/disconn */
b7f04513 SP	331	unsigned qp_max_recv_dtos; /* num of rx buffers */
	332	unsigned qp_max_recv_dtos_mask; /* above minus 1 */
	333	unsigned min_posted_rx; /* qp_max_recv_dtos >> 2 */
704315f0	334	int post_recv_buf_count; /* posted rx count */
49cd5382	335	atomic_t post_send_buf_count; /* posted tx count */
49cd5382	336	char name[ISER_OBJECT_NAME_SIZE];
49cd5382	337	struct list_head conn_list; /* entry in ig conn list */
bcc60c38 OG	338
bcc60c38 OG	339	char *login_buf;
2c4ce609 OG	340	char login_req_buf, login_resp_buf;
2c4ce609 OG	341	u64 login_req_dma, login_resp_dma;
bcc60c38 OG	342	unsigned int rx_desc_head;
	343	struct iser_rx_desc *rx_descs;
	344	struct ib_recv_wr rx_wr[ISER_MIN_POSTED_RX];
7f733847	345	bool pi_support;
7306b8fa SG	346
7306b8fa SG	347	/* Connection memory registration pool */
e657571b SG	348	union {
	349	struct {
	350	struct ib_fmr_pool pool; / pool of IB FMRs */
	351	struct iser_page_vec page_vec; / represents SG to fmr maps*
	352	* maps serialized as tx is*/
	353	} fmr;
5587856c SG	354	struct {
	355	struct list_head pool;
	356	int pool_size;
7306b8fa SG	357	} fastreg;
7306b8fa SG	358	};
49cd5382 OG	359	};
	360
	361	struct iscsi_iser_conn {
	362	struct iscsi_conn iscsi_conn;/ ptr to iscsi conn */
	363	struct iser_conn ib_conn; / iSER IB conn */
49cd5382 OG	364	};
49cd5382 OG	365
2261ec3d	366	struct iscsi_iser_task {
f19624aa	367	struct iser_tx_desc desc;
49cd5382	368	struct iscsi_iser_conn *iser_conn;
49cd5382	369	enum iser_task_status status;
177e31bd	370	struct scsi_cmnd *sc;
49cd5382 OG	371	int command_sent; /* set if command sent */
	372	int dir[ISER_DIRS_NUM]; /* set if dir use*/
	373	struct iser_regd_buf rdma_regd[ISER_DIRS_NUM];/* regd rdma buf */
	374	struct iser_data_buf data[ISER_DIRS_NUM]; /* orig. data des*/
	375	struct iser_data_buf data_copy[ISER_DIRS_NUM];/* contig. copy */
177e31bd SG	376	struct iser_data_buf prot[ISER_DIRS_NUM]; /* prot desc */
177e31bd SG	377	struct iser_data_buf prot_copy[ISER_DIRS_NUM];/* prot copy */
49cd5382 OG	378	};
	379
	380	struct iser_page_vec {
	381	u64 *pages;
	382	int length;
	383	int offset;
	384	int data_size;
	385	};
	386
5a33a669 AT	387	struct iser_cq_desc {
	388	struct iser_device *device;
	389	int cq_index;
	390	};
	391
49cd5382 OG	392	struct iser_global {
	393	struct mutex device_list_mutex;/* */
	394	struct list_head device_list; /* all iSER devices */
	395	struct mutex connlist_mutex;
	396	struct list_head connlist; /* all iSER IB connections */
	397
e54f8188	398	struct kmem_cache *desc_cache;
49cd5382 OG	399	};
	400
	401	extern struct iser_global ig;
	402	extern int iser_debug_level;
7f733847 AT	403	extern bool iser_pi_enable;
7f733847 AT	404	extern int iser_pi_guard;
49cd5382 OG	405
	406	/* allocate connection resources needed for rdma functionality */
	407	int iser_conn_set_full_featured_mode(struct iscsi_conn *conn);
	408
2747fdb2	409	int iser_send_control(struct iscsi_conn *conn,
2261ec3d	410	struct iscsi_task *task);
49cd5382	411
2747fdb2	412	int iser_send_command(struct iscsi_conn *conn,
2261ec3d	413	struct iscsi_task *task);
49cd5382	414
2747fdb2	415	int iser_send_data_out(struct iscsi_conn *conn,
2261ec3d	416	struct iscsi_task *task,
2747fdb2	417	struct iscsi_data *hdr);
49cd5382 OG	418
	419	void iscsi_iser_recv(struct iscsi_conn *conn,
	420	struct iscsi_hdr *hdr,
	421	char *rx_data,
	422	int rx_data_len);
	423
412eeafa	424	void iser_conn_init(struct iser_conn *ib_conn);
49cd5382	425
b40977d9 MC	426	void iser_conn_get(struct iser_conn *ib_conn);
b40977d9 MC	427
39ff05db	428	int iser_conn_put(struct iser_conn *ib_conn, int destroy_cma_id_allowed);
49cd5382 OG	429
	430	void iser_conn_terminate(struct iser_conn *ib_conn);
	431
bcc60c38 OG	432	void iser_rcv_completion(struct iser_rx_desc *desc,
	433	unsigned long dto_xfer_len,
	434	struct iser_conn *ib_conn);
49cd5382	435
f19624aa	436	void iser_snd_completion(struct iser_tx_desc desc, struct iser_conn ib_conn);
49cd5382	437
2261ec3d	438	void iser_task_rdma_init(struct iscsi_iser_task *task);
49cd5382	439
2261ec3d	440	void iser_task_rdma_finalize(struct iscsi_iser_task *task);
49cd5382	441
bcc60c38 OG	442	void iser_free_rx_descriptors(struct iser_conn *ib_conn);
bcc60c38 OG	443
9a8b08fa SG	444	void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_task *iser_task,
	445	struct iser_data_buf *mem,
	446	struct iser_data_buf *mem_copy,
	447	enum iser_data_dir cmd_dir);
49cd5382	448
e657571b SG	449	int iser_reg_rdma_mem_fmr(struct iscsi_iser_task *task,
e657571b SG	450	enum iser_data_dir cmd_dir);
7306b8fa SG	451	int iser_reg_rdma_mem_fastreg(struct iscsi_iser_task *task,
7306b8fa SG	452	enum iser_data_dir cmd_dir);
49cd5382 OG	453
	454	int iser_connect(struct iser_conn *ib_conn,
	455	struct sockaddr_in *src_addr,
	456	struct sockaddr_in *dst_addr,
	457	int non_blocking);
	458
	459	int iser_reg_page_vec(struct iser_conn *ib_conn,
	460	struct iser_page_vec *page_vec,
	461	struct iser_mem_reg *mem_reg);
	462
e657571b SG	463	void iser_unreg_mem_fmr(struct iscsi_iser_task *iser_task,
e657571b SG	464	enum iser_data_dir cmd_dir);
7306b8fa SG	465	void iser_unreg_mem_fastreg(struct iscsi_iser_task *iser_task,
7306b8fa SG	466	enum iser_data_dir cmd_dir);
49cd5382	467
bcc60c38 OG	468	int iser_post_recvl(struct iser_conn *ib_conn);
bcc60c38 OG	469	int iser_post_recvm(struct iser_conn *ib_conn, int count);
f19624aa	470	int iser_post_send(struct iser_conn ib_conn, struct iser_tx_desc tx_desc);
49cd5382	471
2261ec3d	472	int iser_dma_map_task_data(struct iscsi_iser_task *iser_task,
74a20780 EZ	473	struct iser_data_buf *data,
	474	enum iser_data_dir iser_dir,
	475	enum dma_data_direction dma_dir);
	476
9a8b08fa SG	477	void iser_dma_unmap_task_data(struct iscsi_iser_task *iser_task,
9a8b08fa SG	478	struct iser_data_buf *data);
f19624aa OG	479	int iser_initialize_task_headers(struct iscsi_task *task,
f19624aa OG	480	struct iser_tx_desc *tx_desc);
b7f04513 SP	481	int iser_alloc_rx_descriptors(struct iser_conn ib_conn, struct iscsi_session session);
b7f04513 SP	482	int iser_create_fmr_pool(struct iser_conn *ib_conn, unsigned cmds_max);
986db0d6	483	void iser_free_fmr_pool(struct iser_conn *ib_conn);
7306b8fa SG	484	int iser_create_fastreg_pool(struct iser_conn *ib_conn, unsigned cmds_max);
7306b8fa SG	485	void iser_free_fastreg_pool(struct iser_conn *ib_conn);
0a7a08ad SG	486	u8 iser_check_task_pi_status(struct iscsi_iser_task *iser_task,
0a7a08ad SG	487	enum iser_data_dir cmd_dir, sector_t *sector);
49cd5382	488	#endif