[mirror_ubuntu-artful-kernel.git] / include / scsi / libiscsi.h

/*
 * iSCSI lib definitions
 *
 * Copyright (C) 2006 Red Hat, Inc.  All rights reserved.
 * Copyright (C) 2004 - 2006 Mike Christie
 * Copyright (C) 2004 - 2005 Dmitry Yusupov
 * Copyright (C) 2004 - 2005 Alex Aizman
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
#ifndef LIBISCSI_H
#define LIBISCSI_H

#include <linux/types.h>
#include <linux/mutex.h>
#include <linux/timer.h>
#include <linux/workqueue.h>
#include <scsi/iscsi_proto.h>
#include <scsi/iscsi_if.h>

struct scsi_transport_template;
struct scsi_device;
struct Scsi_Host;
struct scsi_cmnd;
struct socket;
struct iscsi_transport;
struct iscsi_cls_session;
struct iscsi_cls_conn;
struct iscsi_session;
struct iscsi_nopin;

/* #define DEBUG_SCSI */
#ifdef DEBUG_SCSI
#define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
#else
#define debug_scsi(fmt...)
#endif

#define ISCSI_DEF_XMIT_CMDS_MAX	128	/* must be power of 2 */
#define ISCSI_MGMT_CMDS_MAX	16	/* must be power of 2 */

#define ISCSI_MGMT_ITT_OFFSET	0xa00

#define ISCSI_DEF_CMD_PER_LUN		32
#define ISCSI_MAX_CMD_PER_LUN		128

/* Task Mgmt states */
enum {
	TMF_INITIAL,
	TMF_QUEUED,
	TMF_SUCCESS,
	TMF_FAILED,
	TMF_TIMEDOUT,
	TMF_NOT_FOUND,
};

/* Connection suspend "bit" */
#define ISCSI_SUSPEND_BIT		1

#define ISCSI_ITT_MASK			(0xfff)
#define ISCSI_CID_SHIFT			12
#define ISCSI_CID_MASK			(0xffff << ISCSI_CID_SHIFT)
#define ISCSI_AGE_SHIFT			28
#define ISCSI_AGE_MASK			(0xf << ISCSI_AGE_SHIFT)

#define ISCSI_ADDRESS_BUF_LEN		64

enum {
	/* this is the maximum possible storage for AHSs */
	ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
				sizeof(struct iscsi_rlength_ahdr),
	ISCSI_DIGEST_SIZE = sizeof(__u32),
};

struct iscsi_mgmt_task {
	/*
	 * Becuae LLDs allocate their hdr differently, this is a pointer to
	 * that storage. It must be setup at session creation time.
	 */
	struct iscsi_hdr	*hdr;
	char			*data;		/* mgmt payload */
	unsigned		data_count;	/* counts data to be sent */
	uint32_t		itt;		/* this ITT */
	void			*dd_data;	/* driver/transport data */
	struct list_head	running;
};

enum {
	ISCSI_TASK_COMPLETED,
	ISCSI_TASK_PENDING,
	ISCSI_TASK_RUNNING,
};

struct iscsi_cmd_task {
	/*
	 * Because LLDs allocate their hdr differently, this is a pointer
	 * and length to that storage. It must be setup at session
	 * creation time.
	 */
	struct iscsi_cmd	*hdr;
	unsigned short		hdr_max;
	unsigned short		hdr_len;	/* accumulated size of hdr used */
	int			itt;		/* this ITT */

	uint32_t		unsol_datasn;
	unsigned		imm_count;	/* imm-data (bytes)   */
	unsigned		unsol_count;	/* unsolicited (bytes)*/
	/* offset in unsolicited stream (bytes); */
	unsigned		unsol_offset;
	unsigned		data_count;	/* remaining Data-Out */
	struct scsi_cmnd	*sc;		/* associated SCSI cmd*/
	struct iscsi_conn	*conn;		/* used connection    */

	/* state set/tested under session->lock */
	int			state;
	atomic_t		refcount;
	struct list_head	running;	/* running cmd list */
	void			*dd_data;	/* driver/transport data */
};

static inline void* iscsi_next_hdr(struct iscsi_cmd_task *ctask)
{
	return (void*)ctask->hdr + ctask->hdr_len;
}

struct iscsi_conn {
	struct iscsi_cls_conn	*cls_conn;	/* ptr to class connection */
	void			*dd_data;	/* iscsi_transport data */
	struct iscsi_session	*session;	/* parent session */
	/*
	 * LLDs should set this lock. It protects the transport recv
	 * code
	 */
	rwlock_t		*recv_lock;
	/*
	 * conn_stop() flag: stop to recover, stop to terminate
	 */
        int			stop_stage;

	/* iSCSI connection-wide sequencing */
	uint32_t		exp_statsn;

	/* control data */
	int			id;		/* CID */
	int			c_stage;	/* connection state */
	/*
	 * Preallocated buffer for pdus that have data but do not
	 * originate from scsi-ml. We never have two pdus using the
	 * buffer at the same time. It is only allocated to
	 * the default max recv size because the pdus we support
	 * should always fit in this buffer
	 */
	char			*data;
	struct iscsi_mgmt_task	*login_mtask;	/* mtask used for login/text */
	struct iscsi_mgmt_task	*mtask;		/* xmit mtask in progress */
	struct iscsi_cmd_task	*ctask;		/* xmit ctask in progress */

	/* xmit */
	struct list_head	mgmtqueue;	/* mgmt (control) xmit queue */
	struct list_head	mgmt_run_list;	/* list of control tasks */
	struct list_head	xmitqueue;	/* data-path cmd queue */
	struct list_head	run_list;	/* list of cmds in progress */
	struct list_head	requeue;	/* tasks needing another run */
	struct work_struct	xmitwork;	/* per-conn. xmit workqueue */
	unsigned long		suspend_tx;	/* suspend Tx */
	unsigned long		suspend_rx;	/* suspend Rx */

	/* abort */
	wait_queue_head_t	ehwait;		/* used in eh_abort() */
	struct iscsi_tm		tmhdr;
	struct timer_list	tmf_timer;
	int			tmf_state;	/* see TMF_INITIAL, etc.*/

	/* negotiated params */
	unsigned		max_recv_dlength; /* initiator_max_recv_dsl*/
	unsigned		max_xmit_dlength; /* target_max_recv_dsl */
	int			hdrdgst_en;
	int			datadgst_en;
	int			ifmarker_en;
	int			ofmarker_en;
	/* values userspace uses to id a conn */
	int			persistent_port;
	char			*persistent_address;
	/* remote portal currently connected to */
	int			portal_port;
	char			portal_address[ISCSI_ADDRESS_BUF_LEN];
	/* local address */
	int			local_port;
	char			local_address[ISCSI_ADDRESS_BUF_LEN];

	/* MIB-statistics */
	uint64_t		txdata_octets;
	uint64_t		rxdata_octets;
	uint32_t		scsicmd_pdus_cnt;
	uint32_t		dataout_pdus_cnt;
	uint32_t		scsirsp_pdus_cnt;
	uint32_t		datain_pdus_cnt;
	uint32_t		r2t_pdus_cnt;
	uint32_t		tmfcmd_pdus_cnt;
	int32_t			tmfrsp_pdus_cnt;

	/* custom statistics */
	uint32_t		eh_abort_cnt;
};

struct iscsi_queue {
	struct kfifo		*queue;		/* FIFO Queue */
	void			**pool;		/* Pool of elements */
	int			max;		/* Max number of elements */
};

struct iscsi_session {
	/*
	 * Syncs up the scsi eh thread with the iscsi eh thread when sending
	 * task management functions. This must be taken before the session
	 * and recv lock.
	 */
	struct mutex		eh_mutex;

	/* iSCSI session-wide sequencing */
	uint32_t		cmdsn;
	uint32_t		exp_cmdsn;
	uint32_t		max_cmdsn;

	/* This tracks the reqs queued into the initiator */
	uint32_t		queued_cmdsn;

	/* configuration */
	int			initial_r2t_en;
	unsigned		max_r2t;
	int			imm_data_en;
	unsigned		first_burst;
	unsigned		max_burst;
	int			time2wait;
	int			time2retain;
	int			pdu_inorder_en;
	int			dataseq_inorder_en;
	int			erl;
	int			fast_abort;
	int			tpgt;
	char			*username;
	char			*username_in;
	char			*password;
	char			*password_in;
	char			*targetname;
	char			*initiatorname;
	/* hw address or netdev iscsi connection is bound to */
	char			*hwaddress;
	char			*netdev;
	/* control data */
	struct iscsi_transport	*tt;
	struct Scsi_Host	*host;
	struct iscsi_conn	*leadconn;	/* leading connection */
	spinlock_t		lock;		/* protects session state, *
						 * sequence numbers,       *
						 * session resources:      *
						 * - cmdpool,		   *
						 * - mgmtpool,		   *
						 * - r2tpool		   */
	int			state;		/* session state           */
	int			age;		/* counts session re-opens */

	int			cmds_max;	/* size of cmds array */
	struct iscsi_cmd_task	**cmds;		/* Original Cmds arr */
	struct iscsi_queue	cmdpool;	/* PDU's pool */
	int			mgmtpool_max;	/* size of mgmt array */
	struct iscsi_mgmt_task	**mgmt_cmds;	/* Original mgmt arr */
	struct iscsi_queue	mgmtpool;	/* Mgmt PDU's pool */
};

/*
 * scsi host template
 */
extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
extern int iscsi_eh_abort(struct scsi_cmnd *sc);
extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
extern int iscsi_queuecommand(struct scsi_cmnd *sc,
			      void (*done)(struct scsi_cmnd *));


/*
 * iSCSI host helpers.
 */
extern int iscsi_host_set_param(struct Scsi_Host *shost,
				enum iscsi_host_param param, char *buf,
				int buflen);
extern int iscsi_host_get_param(struct Scsi_Host *shost,
				enum iscsi_host_param param, char *buf);

/*
 * session management
 */
extern struct iscsi_cls_session *
iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *,
		    uint16_t, uint16_t, int, int, uint32_t, uint32_t *);
extern void iscsi_session_teardown(struct iscsi_cls_session *);
extern struct iscsi_session *class_to_transport_session(struct iscsi_cls_session *);
extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
			   enum iscsi_param param, char *buf, int buflen);
extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
				   enum iscsi_param param, char *buf);

#define session_to_cls(_sess) \
	hostdata_session(_sess->host->hostdata)

/*
 * connection management
 */
extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
					       uint32_t);
extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
extern int iscsi_conn_start(struct iscsi_cls_conn *);
extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
			   int);
extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
				enum iscsi_param param, char *buf);

/*
 * pdu and task processing
 */
extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
					struct iscsi_data *hdr);
extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
				char *, uint32_t);
extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
			      char *, int);
extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
				char *, int);
extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
			    uint32_t *);
extern void iscsi_requeue_ctask(struct iscsi_cmd_task *ctask);

/*
 * generic helpers
 */
extern void iscsi_pool_free(struct iscsi_queue *, void **);
extern int iscsi_pool_init(struct iscsi_queue *, int, void ***, int);

/*
 * inline functions to deal with padding.
 */
static inline unsigned int
iscsi_padded(unsigned int len)
{
	return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
}

static inline unsigned int
iscsi_padding(unsigned int len)
{
	len &= (ISCSI_PAD_LEN - 1);
	if (len)
		len = ISCSI_PAD_LEN - len;
	return len;
}

#endif
Commit	Line	Data
7996a778 MC	1	/*
	2	* iSCSI lib definitions
	3	*
	4	* Copyright (C) 2006 Red Hat, Inc. All rights reserved.
	5	* Copyright (C) 2004 - 2006 Mike Christie
	6	* Copyright (C) 2004 - 2005 Dmitry Yusupov
	7	* Copyright (C) 2004 - 2005 Alex Aizman
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	22	*/
	23	#ifndef LIBISCSI_H
	24	#define LIBISCSI_H
	25
	26	#include <linux/types.h>
	27	#include <linux/mutex.h>
f6a57033 AV	28	#include <linux/timer.h>
f6a57033 AV	29	#include <linux/workqueue.h>
7996a778 MC	30	#include <scsi/iscsi_proto.h>
	31	#include <scsi/iscsi_if.h>
	32
	33	struct scsi_transport_template;
	34	struct scsi_device;
	35	struct Scsi_Host;
	36	struct scsi_cmnd;
	37	struct socket;
	38	struct iscsi_transport;
	39	struct iscsi_cls_session;
	40	struct iscsi_cls_conn;
	41	struct iscsi_session;
	42	struct iscsi_nopin;
	43
	44	/* #define DEBUG_SCSI */
	45	#ifdef DEBUG_SCSI
be2df72e	46	#define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
7996a778 MC	47	#else
	48	#define debug_scsi(fmt...)
	49	#endif
	50
1548271e MC	51	#define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */
1548271e MC	52	#define ISCSI_MGMT_CMDS_MAX 16 /* must be power of 2 */
7996a778 MC	53
	54	#define ISCSI_MGMT_ITT_OFFSET 0xa00
	55
	56	#define ISCSI_DEF_CMD_PER_LUN 32
	57	#define ISCSI_MAX_CMD_PER_LUN 128
	58
	59	/* Task Mgmt states */
843c0a8a MC	60	enum {
	61	TMF_INITIAL,
	62	TMF_QUEUED,
	63	TMF_SUCCESS,
	64	TMF_FAILED,
	65	TMF_TIMEDOUT,
	66	TMF_NOT_FOUND,
	67	};
7996a778 MC	68
	69	/* Connection suspend "bit" */
	70	#define ISCSI_SUSPEND_BIT 1
	71
	72	#define ISCSI_ITT_MASK (0xfff)
	73	#define ISCSI_CID_SHIFT 12
	74	#define ISCSI_CID_MASK (0xffff << ISCSI_CID_SHIFT)
	75	#define ISCSI_AGE_SHIFT 28
	76	#define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT)
	77
22236961 MC	78	#define ISCSI_ADDRESS_BUF_LEN 64
22236961 MC	79
da32dd68	80	enum {
004d6530 BH	81	/* this is the maximum possible storage for AHSs */
	82	ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
	83	sizeof(struct iscsi_rlength_ahdr),
da32dd68 OK	84	ISCSI_DIGEST_SIZE = sizeof(__u32),
	85	};
	86
7996a778 MC	87	struct iscsi_mgmt_task {
	88	/*
	89	* Becuae LLDs allocate their hdr differently, this is a pointer to
	90	* that storage. It must be setup at session creation time.
	91	*/
	92	struct iscsi_hdr *hdr;
	93	char data; / mgmt payload */
857ae0bd	94	unsigned data_count; /* counts data to be sent */
7996a778 MC	95	uint32_t itt; /* this ITT */
	96	void dd_data; / driver/transport data */
	97	struct list_head running;
	98	};
	99
b6c395ed MC	100	enum {
	101	ISCSI_TASK_COMPLETED,
	102	ISCSI_TASK_PENDING,
	103	ISCSI_TASK_RUNNING,
	104	};
	105
7996a778 MC	106	struct iscsi_cmd_task {
7996a778 MC	107	/*
004d6530 BH	108	* Because LLDs allocate their hdr differently, this is a pointer
	109	* and length to that storage. It must be setup at session
	110	* creation time.
7996a778 MC	111	*/
7996a778 MC	112	struct iscsi_cmd *hdr;
004d6530 BH	113	unsigned short hdr_max;
004d6530 BH	114	unsigned short hdr_len; /* accumulated size of hdr used */
7996a778	115	int itt; /* this ITT */
7996a778 MC	116
7996a778 MC	117	uint32_t unsol_datasn;
857ae0bd MC	118	unsigned imm_count; /* imm-data (bytes) */
857ae0bd MC	119	unsigned unsol_count; /* unsolicited (bytes)*/
ffd0436e	120	/* offset in unsolicited stream (bytes); */
857ae0bd MC	121	unsigned unsol_offset;
857ae0bd MC	122	unsigned data_count; /* remaining Data-Out */
7996a778	123	struct scsi_cmnd sc; / associated SCSI cmd*/
7996a778	124	struct iscsi_conn conn; / used connection */
7996a778	125
b6c395ed MC	126	/* state set/tested under session->lock */
b6c395ed MC	127	int state;
60ecebf5	128	atomic_t refcount;
7996a778 MC	129	struct list_head running; /* running cmd list */
	130	void dd_data; / driver/transport data */
	131	};
	132
004d6530 BH	133	static inline void* iscsi_next_hdr(struct iscsi_cmd_task *ctask)
	134	{
	135	return (void*)ctask->hdr + ctask->hdr_len;
	136	}
	137
7996a778 MC	138	struct iscsi_conn {
	139	struct iscsi_cls_conn cls_conn; / ptr to class connection */
	140	void dd_data; / iscsi_transport data */
	141	struct iscsi_session session; / parent session */
	142	/*
	143	* LLDs should set this lock. It protects the transport recv
	144	* code
	145	*/
	146	rwlock_t *recv_lock;
	147	/*
	148	* conn_stop() flag: stop to recover, stop to terminate
	149	*/
	150	int stop_stage;
	151
	152	/* iSCSI connection-wide sequencing */
	153	uint32_t exp_statsn;
	154
	155	/* control data */
	156	int id; /* CID */
7996a778	157	int c_stage; /* connection state */
c8dc1e52 MC	158	/*
	159	* Preallocated buffer for pdus that have data but do not
	160	* originate from scsi-ml. We never have two pdus using the
	161	* buffer at the same time. It is only allocated to
	162	* the default max recv size because the pdus we support
	163	* should always fit in this buffer
	164	*/
	165	char *data;
7996a778 MC	166	struct iscsi_mgmt_task login_mtask; / mtask used for login/text */
	167	struct iscsi_mgmt_task mtask; / xmit mtask in progress */
	168	struct iscsi_cmd_task ctask; / xmit ctask in progress */
	169
	170	/* xmit */
843c0a8a	171	struct list_head mgmtqueue; /* mgmt (control) xmit queue */
7996a778	172	struct list_head mgmt_run_list; /* list of control tasks */
b6c395ed	173	struct list_head xmitqueue; /* data-path cmd queue */
7996a778	174	struct list_head run_list; /* list of cmds in progress */
843c0a8a	175	struct list_head requeue; /* tasks needing another run */
7996a778	176	struct work_struct xmitwork; /* per-conn. xmit workqueue */
7996a778 MC	177	unsigned long suspend_tx; /* suspend Tx */
	178	unsigned long suspend_rx; /* suspend Rx */
	179
	180	/* abort */
	181	wait_queue_head_t ehwait; /* used in eh_abort() */
	182	struct iscsi_tm tmhdr;
843c0a8a MC	183	struct timer_list tmf_timer;
843c0a8a MC	184	int tmf_state; /* see TMF_INITIAL, etc.*/
7996a778 MC	185
7996a778 MC	186	/* negotiated params */
857ae0bd MC	187	unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
857ae0bd MC	188	unsigned max_xmit_dlength; /* target_max_recv_dsl */
7996a778 MC	189	int hdrdgst_en;
7996a778 MC	190	int datadgst_en;
a54a52ca MC	191	int ifmarker_en;
	192	int ofmarker_en;
	193	/* values userspace uses to id a conn */
	194	int persistent_port;
	195	char *persistent_address;
22236961 MC	196	/* remote portal currently connected to */
	197	int portal_port;
	198	char portal_address[ISCSI_ADDRESS_BUF_LEN];
	199	/* local address */
	200	int local_port;
	201	char local_address[ISCSI_ADDRESS_BUF_LEN];
7996a778 MC	202
	203	/* MIB-statistics */
	204	uint64_t txdata_octets;
	205	uint64_t rxdata_octets;
	206	uint32_t scsicmd_pdus_cnt;
	207	uint32_t dataout_pdus_cnt;
	208	uint32_t scsirsp_pdus_cnt;
	209	uint32_t datain_pdus_cnt;
	210	uint32_t r2t_pdus_cnt;
	211	uint32_t tmfcmd_pdus_cnt;
	212	int32_t tmfrsp_pdus_cnt;
	213
	214	/* custom statistics */
	215	uint32_t eh_abort_cnt;
	216	};
	217
	218	struct iscsi_queue {
	219	struct kfifo queue; / FIFO Queue */
	220	void *pool; / Pool of elements */
	221	int max; /* Max number of elements */
	222	};
	223
	224	struct iscsi_session {
6724add1 MC	225	/*
	226	* Syncs up the scsi eh thread with the iscsi eh thread when sending
	227	* task management functions. This must be taken before the session
	228	* and recv lock.
	229	*/
	230	struct mutex eh_mutex;
	231
7996a778 MC	232	/* iSCSI session-wide sequencing */
	233	uint32_t cmdsn;
	234	uint32_t exp_cmdsn;
	235	uint32_t max_cmdsn;
	236
e0726407 MC	237	/* This tracks the reqs queued into the initiator */
	238	uint32_t queued_cmdsn;
	239
7996a778 MC	240	/* configuration */
7996a778 MC	241	int initial_r2t_en;
857ae0bd	242	unsigned max_r2t;
7996a778	243	int imm_data_en;
857ae0bd MC	244	unsigned first_burst;
857ae0bd MC	245	unsigned max_burst;
7996a778 MC	246	int time2wait;
	247	int time2retain;
	248	int pdu_inorder_en;
	249	int dataseq_inorder_en;
	250	int erl;
843c0a8a	251	int fast_abort;
a54a52ca	252	int tpgt;
b2c64167 MC	253	char *username;
	254	char *username_in;
	255	char *password;
	256	char *password_in;
a54a52ca	257	char *targetname;
8ad5781a	258	char *initiatorname;
d8196ed2	259	/* hw address or netdev iscsi connection is bound to */
0801c242	260	char *hwaddress;
d8196ed2	261	char *netdev;
7996a778 MC	262	/* control data */
	263	struct iscsi_transport *tt;
	264	struct Scsi_Host *host;
	265	struct iscsi_conn leadconn; / leading connection */
	266	spinlock_t lock; /* protects session state, *
	267	* sequence numbers, *
	268	* session resources: *
	269	* - cmdpool, *
	270	* - mgmtpool, *
	271	* - r2tpool */
	272	int state; /* session state */
7996a778 MC	273	int age; /* counts session re-opens */
7996a778 MC	274
7996a778 MC	275	int cmds_max; /* size of cmds array */
	276	struct iscsi_cmd_task *cmds; / Original Cmds arr */
	277	struct iscsi_queue cmdpool; /* PDU's pool */
	278	int mgmtpool_max; /* size of mgmt array */
	279	struct iscsi_mgmt_task *mgmt_cmds; / Original mgmt arr */
	280	struct iscsi_queue mgmtpool; /* Mgmt PDU's pool */
	281	};
	282
	283	/*
	284	* scsi host template
	285	*/
	286	extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
	287	extern int iscsi_eh_abort(struct scsi_cmnd *sc);
	288	extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
843c0a8a	289	extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
7996a778 MC	290	extern int iscsi_queuecommand(struct scsi_cmnd *sc,
7996a778 MC	291	void (done)(struct scsi_cmnd ));
0801c242 MC	292
	293
	294	/*
	295	* iSCSI host helpers.
	296	*/
	297	extern int iscsi_host_set_param(struct Scsi_Host *shost,
	298	enum iscsi_host_param param, char *buf,
	299	int buflen);
	300	extern int iscsi_host_get_param(struct Scsi_Host *shost,
	301	enum iscsi_host_param param, char *buf);
7996a778 MC	302
	303	/*
	304	* session management
	305	*/
	306	extern struct iscsi_cls_session *
	307	iscsi_session_setup(struct iscsi_transport , struct scsi_transport_template ,
1548271e	308	uint16_t, uint16_t, int, int, uint32_t, uint32_t *);
7996a778 MC	309	extern void iscsi_session_teardown(struct iscsi_cls_session *);
7996a778 MC	310	extern struct iscsi_session class_to_transport_session(struct iscsi_cls_session );
7996a778	311	extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
a54a52ca MC	312	extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
	313	enum iscsi_param param, char *buf, int buflen);
	314	extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
	315	enum iscsi_param param, char *buf);
7996a778 MC	316
	317	#define session_to_cls(_sess) \
	318	hostdata_session(_sess->host->hostdata)
	319
	320	/*
	321	* connection management
	322	*/
	323	extern struct iscsi_cls_conn iscsi_conn_setup(struct iscsi_cls_session ,
	324	uint32_t);
	325	extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
	326	extern int iscsi_conn_start(struct iscsi_cls_conn *);
	327	extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
	328	extern int iscsi_conn_bind(struct iscsi_cls_session , struct iscsi_cls_conn ,
	329	int);
	330	extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
a54a52ca MC	331	extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
a54a52ca MC	332	enum iscsi_param param, char *buf);
7996a778 MC	333
	334	/*
	335	* pdu and task processing
	336	*/
77a23c21	337	extern void iscsi_update_cmdsn(struct iscsi_session , struct iscsi_nopin );
7996a778	338	extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
ffd0436e	339	struct iscsi_data *hdr);
7996a778 MC	340	extern int iscsi_conn_send_pdu(struct iscsi_cls_conn , struct iscsi_hdr ,
	341	char *, uint32_t);
	342	extern int iscsi_complete_pdu(struct iscsi_conn , struct iscsi_hdr ,
	343	char *, int);
	344	extern int __iscsi_complete_pdu(struct iscsi_conn , struct iscsi_hdr ,
	345	char *, int);
	346	extern int iscsi_verify_itt(struct iscsi_conn , struct iscsi_hdr ,
	347	uint32_t *);
843c0a8a	348	extern void iscsi_requeue_ctask(struct iscsi_cmd_task *ctask);
7996a778 MC	349
	350	/*
	351	* generic helpers
	352	*/
	353	extern void iscsi_pool_free(struct iscsi_queue , void *);
	354	extern int iscsi_pool_init(struct iscsi_queue , int, void **, int);
	355
004d6530 BH	356	/*
	357	* inline functions to deal with padding.
	358	*/
	359	static inline unsigned int
	360	iscsi_padded(unsigned int len)
	361	{
	362	return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
	363	}
	364
	365	static inline unsigned int
	366	iscsi_padding(unsigned int len)
	367	{
	368	len &= (ISCSI_PAD_LEN - 1);
	369	if (len)
	370	len = ISCSI_PAD_LEN - len;
	371	return len;
	372	}
	373
7996a778	374	#endif