[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 <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)

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

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_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);
};

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;
	/* Valid for fast registration flag */
	bool				  valid;
};

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];
	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;
		} frwr;
	} 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;
	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_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;

/* 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 *task,
				     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_frwr(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_frwr(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);
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_frwr_pool(struct iser_conn *ib_conn, unsigned cmds_max);
void iser_free_frwr_pool(struct iser_conn *ib_conn);
#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>
	48	#include <scsi/scsi_transport_iscsi.h>
	49
a6b7a407	50	#include <linux/interrupt.h>
49cd5382 OG	51	#include <linux/wait.h>
	52	#include <linux/sched.h>
	53	#include <linux/list.h>
	54	#include <linux/slab.h>
	55	#include <linux/dma-mapping.h>
	56	#include <linux/mutex.h>
	57	#include <linux/mempool.h>
	58	#include <linux/uio.h>
	59
	60	#include <linux/socket.h>
	61	#include <linux/in.h>
	62	#include <linux/in6.h>
	63
	64	#include <rdma/ib_verbs.h>
	65	#include <rdma/ib_fmr_pool.h>
	66	#include <rdma/rdma_cm.h>
	67
	68	#define DRV_NAME "iser"
	69	#define PFX DRV_NAME ": "
c1d786e6	70	#define DRV_VER "1.1"
49cd5382 OG	71
49cd5382 OG	72	#define iser_dbg(fmt, arg...) \
6f735e36	73	do { \
4f363882	74	if (iser_debug_level > 2) \
6f735e36 ED	75	printk(KERN_DEBUG PFX "%s:" fmt,\
	76	__func__ , ## arg); \
	77	} while (0)
	78
	79	#define iser_warn(fmt, arg...) \
4f363882	80	do { \
f91424cf	81	if (iser_debug_level > 0) \
4f363882 RD	82	pr_warn(PFX "%s:" fmt, \
	83	__func__ , ## arg); \
	84	} while (0)
	85
	86	#define iser_info(fmt, arg...) \
49cd5382	87	do { \
f91424cf	88	if (iser_debug_level > 1) \
4f363882	89	pr_info(PFX "%s:" fmt, \
49cd5382 OG	90	__func__ , ## arg); \
	91	} while (0)
	92
	93	#define iser_err(fmt, arg...) \
	94	do { \
	95	printk(KERN_ERR PFX "%s:" fmt, \
	96	__func__ , ## arg); \
	97	} while (0)
	98
8dfa0876	99	#define SHIFT_4K 12
0ace64b8	100	#define SIZE_4K (1ULL << SHIFT_4K)
8dfa0876 EZ	101	#define MASK_4K (~(SIZE_4K-1))
8dfa0876 EZ	102
25985edc	103	/* support up to 512KB in one RDMA */
8dfa0876	104	#define ISCSI_ISER_SG_TABLESIZE (0x80000 >> SHIFT_4K)
b7f04513 SP	105	#define ISER_DEF_XMIT_CMDS_DEFAULT 512
	106	#if ISCSI_DEF_XMIT_CMDS_MAX > ISER_DEF_XMIT_CMDS_DEFAULT
	107	#define ISER_DEF_XMIT_CMDS_MAX ISCSI_DEF_XMIT_CMDS_MAX
	108	#else
	109	#define ISER_DEF_XMIT_CMDS_MAX ISER_DEF_XMIT_CMDS_DEFAULT
	110	#endif
	111	#define ISER_DEF_CMD_PER_LUN ISER_DEF_XMIT_CMDS_MAX
49cd5382 OG	112
	113	/* QP settings */
	114	/* Maximal bounds on received asynchronous PDUs */
	115	#define ISER_MAX_RX_MISC_PDUS 4 /* NOOP_IN(2) , ASYNC_EVENT(2) */
	116
	117	#define ISER_MAX_TX_MISC_PDUS 6 /* NOOP_OUT(2), TEXT(1), *
	118	* SCSI_TMFUNC(2), LOGOUT(1) */
	119
b7f04513	120	#define ISER_QP_MAX_RECV_DTOS (ISER_DEF_XMIT_CMDS_MAX)
bcc60c38	121
b7f04513	122	#define ISER_MIN_POSTED_RX (ISER_DEF_XMIT_CMDS_MAX >> 2)
49cd5382 OG	123
	124	/* the max TX (send) WR supported by the iSER QP is defined by *
	125	* max_send_wr = T * (1 + D) + C ; D is how many inflight dataouts we expect *
	126	* to have at max for SCSI command. The tx posting & completion handling code *
	127	* supports -EAGAIN scheme where tx is suspended till the QP has room for more *
	128	* send WR. D=8 comes from 64K/8K */
	129
	130	#define ISER_INFLIGHT_DATAOUTS 8
	131
b7f04513	132	#define ISER_QP_MAX_REQ_DTOS (ISER_DEF_XMIT_CMDS_MAX * \
49cd5382 OG	133	(1 + ISER_INFLIGHT_DATAOUTS) + \
	134	ISER_MAX_TX_MISC_PDUS + \
	135	ISER_MAX_RX_MISC_PDUS)
	136
	137	#define ISER_VER 0x10
	138	#define ISER_WSV 0x08
	139	#define ISER_RSV 0x04
	140
	141	struct iser_hdr {
	142	u8 flags;
	143	u8 rsvd[3];
	144	__be32 write_stag; /* write rkey */
	145	__be64 write_va;
	146	__be32 read_stag; /* read rkey */
	147	__be64 read_va;
	148	} __attribute__((packed));
	149
8d8399de OG	150
	151	#define ISER_ZBVA_NOT_SUPPORTED 0x80
	152	#define ISER_SEND_W_INV_NOT_SUPPORTED 0x40
	153
	154	struct iser_cm_hdr {
	155	u8 flags;
	156	u8 rsvd[3];
	157	} __packed;
	158
bcc60c38 OG	159	/* Constant PDU lengths calculations */
	160	#define ISER_HEADERS_LEN (sizeof(struct iser_hdr) + sizeof(struct iscsi_hdr))
	161
	162	#define ISER_RECV_DATA_SEG_LEN 128
	163	#define ISER_RX_PAYLOAD_SIZE (ISER_HEADERS_LEN + ISER_RECV_DATA_SEG_LEN)
	164	#define ISER_RX_LOGIN_SIZE (ISER_HEADERS_LEN + ISCSI_DEF_MAX_RECV_SEG_LEN)
49cd5382 OG	165
	166	/* Length of an object name string */
	167	#define ISER_OBJECT_NAME_SIZE 64
	168
	169	enum iser_ib_conn_state {
	170	ISER_CONN_INIT, /* descriptor allocd, no conn */
	171	ISER_CONN_PENDING, /* in the process of being established */
	172	ISER_CONN_UP, /* up and running */
	173	ISER_CONN_TERMINATING, /* in the process of being terminated */
	174	ISER_CONN_DOWN, /* shut down */
	175	ISER_CONN_STATES_NUM
	176	};
	177
	178	enum iser_task_status {
	179	ISER_TASK_STATUS_INIT = 0,
	180	ISER_TASK_STATUS_STARTED,
	181	ISER_TASK_STATUS_COMPLETED
	182	};
	183
	184	enum iser_data_dir {
	185	ISER_DIR_IN = 0, /* to initiator */
	186	ISER_DIR_OUT, /* from initiator */
	187	ISER_DIRS_NUM
	188	};
	189
	190	struct iser_data_buf {
	191	void buf; / pointer to the sg list */
	192	unsigned int size; /* num entries of this sg */
	193	unsigned long data_len; /* total data len */
	194	unsigned int dma_nents; /* returned by dma_map_sg */
	195	char copy_buf; / allocated copy buf for SGs unaligned *
	196	* for rdma which are copied */
	197	struct scatterlist sg_single; /* SG-ified clone of a non SG SC or *
	198	* unaligned SG */
	199	};
	200
	201	/* fwd declarations */
	202	struct iser_device;
5a33a669	203	struct iser_cq_desc;
49cd5382	204	struct iscsi_iser_conn;
2261ec3d	205	struct iscsi_iser_task;
412eeafa	206	struct iscsi_endpoint;
49cd5382 OG	207
	208	struct iser_mem_reg {
	209	u32 lkey;
	210	u32 rkey;
	211	u64 va;
	212	u64 len;
	213	void *mem_h;
5587856c	214	int is_mr;
49cd5382 OG	215	};
	216
	217	struct iser_regd_buf {
	218	struct iser_mem_reg reg; /* memory registration info */
	219	void *virt_addr;
	220	struct iser_device device; / device->device for dma_unmap */
49cd5382 OG	221	enum dma_data_direction direction; /* direction for dma_unmap */
49cd5382 OG	222	unsigned int data_size;
49cd5382 OG	223	};
	224
	225	enum iser_desc_type {
49cd5382 OG	226	ISCSI_TX_CONTROL ,
	227	ISCSI_TX_SCSI_COMMAND,
	228	ISCSI_TX_DATAOUT
	229	};
	230
f19624aa	231	struct iser_tx_desc {
49cd5382 OG	232	struct iser_hdr iser_header;
49cd5382 OG	233	struct iscsi_hdr iscsi_header;
49cd5382	234	enum iser_desc_type type;
f19624aa OG	235	u64 dma_addr;
	236	/* sg[0] points to iser/iscsi headers, sg[1] optionally points to either
	237	of immediate data, unsolicited data-out or control (login,text) */
	238	struct ib_sge tx_sg[2];
	239	int num_sge;
49cd5382 OG	240	};
49cd5382 OG	241
bcc60c38 OG	242	#define ISER_RX_PAD_SIZE (256 - (ISER_RX_PAYLOAD_SIZE + \
	243	sizeof(u64) + sizeof(struct ib_sge)))
	244	struct iser_rx_desc {
	245	struct iser_hdr iser_header;
	246	struct iscsi_hdr iscsi_header;
	247	char data[ISER_RECV_DATA_SEG_LEN];
	248	u64 dma_addr;
	249	struct ib_sge rx_sg;
	250	char pad[ISER_RX_PAD_SIZE];
	251	} __attribute__((packed));
	252
5a33a669 AT	253	#define ISER_MAX_CQ 4
5a33a669 AT	254
b4e155ff SG	255	struct iser_conn;
	256	struct iscsi_iser_task;
	257
49cd5382 OG	258	struct iser_device {
	259	struct ib_device *ib_device;
	260	struct ib_pd *pd;
5a33a669 AT	261	struct ib_cq *rx_cq[ISER_MAX_CQ];
5a33a669 AT	262	struct ib_cq *tx_cq[ISER_MAX_CQ];
49cd5382	263	struct ib_mr *mr;
5a33a669	264	struct tasklet_struct cq_tasklet[ISER_MAX_CQ];
2110f9bf	265	struct ib_event_handler event_handler;
49cd5382 OG	266	struct list_head ig_list; /* entry in ig devices list */
49cd5382 OG	267	int refcount;
5a33a669 AT	268	int cq_active_qps[ISER_MAX_CQ];
	269	int cqs_used;
	270	struct iser_cq_desc *cq_desc;
b4e155ff SG	271	int (iser_alloc_rdma_reg_res)(struct iser_conn ib_conn,
	272	unsigned cmds_max);
	273	void (iser_free_rdma_reg_res)(struct iser_conn ib_conn);
	274	int (iser_reg_rdma_mem)(struct iscsi_iser_task iser_task,
	275	enum iser_data_dir cmd_dir);
	276	void (iser_unreg_rdma_mem)(struct iscsi_iser_task iser_task,
	277	enum iser_data_dir cmd_dir);
49cd5382 OG	278	};
49cd5382 OG	279
5587856c SG	280	struct fast_reg_descriptor {
	281	struct list_head list;
	282	/* For fast registration - FRWR */
	283	struct ib_mr *data_mr;
	284	struct ib_fast_reg_page_list *data_frpl;
	285	/* Valid for fast registration flag */
	286	bool valid;
	287	};
	288
49cd5382 OG	289	struct iser_conn {
49cd5382 OG	290	struct iscsi_iser_conn iser_conn; / iser conn for upcalls */
412eeafa	291	struct iscsi_endpoint *ep;
49cd5382	292	enum iser_ib_conn_state state; /* rdma connection state */
b40977d9	293	atomic_t refcount;
49cd5382 OG	294	spinlock_t lock; /* used for state changes */
	295	struct iser_device device; / device context */
	296	struct rdma_cm_id cma_id; / CMA ID */
	297	struct ib_qp qp; / QP */
49cd5382	298	wait_queue_head_t wait; /* waitq for conn/disconn */
b7f04513 SP	299	unsigned qp_max_recv_dtos; /* num of rx buffers */
	300	unsigned qp_max_recv_dtos_mask; /* above minus 1 */
	301	unsigned min_posted_rx; /* qp_max_recv_dtos >> 2 */
704315f0	302	int post_recv_buf_count; /* posted rx count */
49cd5382	303	atomic_t post_send_buf_count; /* posted tx count */
49cd5382	304	char name[ISER_OBJECT_NAME_SIZE];
49cd5382	305	struct list_head conn_list; /* entry in ig conn list */
bcc60c38 OG	306
bcc60c38 OG	307	char *login_buf;
2c4ce609 OG	308	char login_req_buf, login_resp_buf;
2c4ce609 OG	309	u64 login_req_dma, login_resp_dma;
bcc60c38 OG	310	unsigned int rx_desc_head;
	311	struct iser_rx_desc *rx_descs;
	312	struct ib_recv_wr rx_wr[ISER_MIN_POSTED_RX];
e657571b SG	313	union {
	314	struct {
	315	struct ib_fmr_pool pool; / pool of IB FMRs */
	316	struct iser_page_vec page_vec; / represents SG to fmr maps*
	317	* maps serialized as tx is*/
	318	} fmr;
5587856c SG	319	struct {
	320	struct list_head pool;
	321	int pool_size;
	322	} frwr;
e657571b	323	} fastreg;
49cd5382 OG	324	};
	325
	326	struct iscsi_iser_conn {
	327	struct iscsi_conn iscsi_conn;/ ptr to iscsi conn */
	328	struct iser_conn ib_conn; / iSER IB conn */
49cd5382 OG	329	};
49cd5382 OG	330
2261ec3d	331	struct iscsi_iser_task {
f19624aa	332	struct iser_tx_desc desc;
49cd5382	333	struct iscsi_iser_conn *iser_conn;
49cd5382 OG	334	enum iser_task_status status;
	335	int command_sent; /* set if command sent */
	336	int dir[ISER_DIRS_NUM]; /* set if dir use*/
	337	struct iser_regd_buf rdma_regd[ISER_DIRS_NUM];/* regd rdma buf */
	338	struct iser_data_buf data[ISER_DIRS_NUM]; /* orig. data des*/
	339	struct iser_data_buf data_copy[ISER_DIRS_NUM];/* contig. copy */
	340	};
	341
	342	struct iser_page_vec {
	343	u64 *pages;
	344	int length;
	345	int offset;
	346	int data_size;
	347	};
	348
5a33a669 AT	349	struct iser_cq_desc {
	350	struct iser_device *device;
	351	int cq_index;
	352	};
	353
49cd5382 OG	354	struct iser_global {
	355	struct mutex device_list_mutex;/* */
	356	struct list_head device_list; /* all iSER devices */
	357	struct mutex connlist_mutex;
	358	struct list_head connlist; /* all iSER IB connections */
	359
e54f8188	360	struct kmem_cache *desc_cache;
49cd5382 OG	361	};
	362
	363	extern struct iser_global ig;
	364	extern int iser_debug_level;
	365
	366	/* allocate connection resources needed for rdma functionality */
	367	int iser_conn_set_full_featured_mode(struct iscsi_conn *conn);
	368
2747fdb2	369	int iser_send_control(struct iscsi_conn *conn,
2261ec3d	370	struct iscsi_task *task);
49cd5382	371
2747fdb2	372	int iser_send_command(struct iscsi_conn *conn,
2261ec3d	373	struct iscsi_task *task);
49cd5382	374
2747fdb2	375	int iser_send_data_out(struct iscsi_conn *conn,
2261ec3d	376	struct iscsi_task *task,
2747fdb2	377	struct iscsi_data *hdr);
49cd5382 OG	378
	379	void iscsi_iser_recv(struct iscsi_conn *conn,
	380	struct iscsi_hdr *hdr,
	381	char *rx_data,
	382	int rx_data_len);
	383
412eeafa	384	void iser_conn_init(struct iser_conn *ib_conn);
49cd5382	385
b40977d9 MC	386	void iser_conn_get(struct iser_conn *ib_conn);
b40977d9 MC	387
39ff05db	388	int iser_conn_put(struct iser_conn *ib_conn, int destroy_cma_id_allowed);
49cd5382 OG	389
	390	void iser_conn_terminate(struct iser_conn *ib_conn);
	391
bcc60c38 OG	392	void iser_rcv_completion(struct iser_rx_desc *desc,
	393	unsigned long dto_xfer_len,
	394	struct iser_conn *ib_conn);
49cd5382	395
f19624aa	396	void iser_snd_completion(struct iser_tx_desc desc, struct iser_conn ib_conn);
49cd5382	397
2261ec3d	398	void iser_task_rdma_init(struct iscsi_iser_task *task);
49cd5382	399
2261ec3d	400	void iser_task_rdma_finalize(struct iscsi_iser_task *task);
49cd5382	401
bcc60c38 OG	402	void iser_free_rx_descriptors(struct iser_conn *ib_conn);
bcc60c38 OG	403
2261ec3d	404	void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_task *task,
49cd5382 OG	405	enum iser_data_dir cmd_dir);
49cd5382 OG	406
e657571b SG	407	int iser_reg_rdma_mem_fmr(struct iscsi_iser_task *task,
e657571b SG	408	enum iser_data_dir cmd_dir);
5587856c SG	409	int iser_reg_rdma_mem_frwr(struct iscsi_iser_task *task,
5587856c SG	410	enum iser_data_dir cmd_dir);
49cd5382 OG	411
	412	int iser_connect(struct iser_conn *ib_conn,
	413	struct sockaddr_in *src_addr,
	414	struct sockaddr_in *dst_addr,
	415	int non_blocking);
	416
	417	int iser_reg_page_vec(struct iser_conn *ib_conn,
	418	struct iser_page_vec *page_vec,
	419	struct iser_mem_reg *mem_reg);
	420
e657571b SG	421	void iser_unreg_mem_fmr(struct iscsi_iser_task *iser_task,
e657571b SG	422	enum iser_data_dir cmd_dir);
5587856c SG	423	void iser_unreg_mem_frwr(struct iscsi_iser_task *iser_task,
5587856c SG	424	enum iser_data_dir cmd_dir);
49cd5382	425
bcc60c38 OG	426	int iser_post_recvl(struct iser_conn *ib_conn);
bcc60c38 OG	427	int iser_post_recvm(struct iser_conn *ib_conn, int count);
f19624aa	428	int iser_post_send(struct iser_conn ib_conn, struct iser_tx_desc tx_desc);
49cd5382	429
2261ec3d	430	int iser_dma_map_task_data(struct iscsi_iser_task *iser_task,
74a20780 EZ	431	struct iser_data_buf *data,
	432	enum iser_data_dir iser_dir,
	433	enum dma_data_direction dma_dir);
	434
2261ec3d	435	void iser_dma_unmap_task_data(struct iscsi_iser_task *iser_task);
f19624aa OG	436	int iser_initialize_task_headers(struct iscsi_task *task,
f19624aa OG	437	struct iser_tx_desc *tx_desc);
b7f04513 SP	438	int iser_alloc_rx_descriptors(struct iser_conn ib_conn, struct iscsi_session session);
b7f04513 SP	439	int iser_create_fmr_pool(struct iser_conn *ib_conn, unsigned cmds_max);
986db0d6	440	void iser_free_fmr_pool(struct iser_conn *ib_conn);
5587856c SG	441	int iser_create_frwr_pool(struct iser_conn *ib_conn, unsigned cmds_max);
5587856c SG	442	void iser_free_frwr_pool(struct iser_conn *ib_conn);
49cd5382	443	#endif