[linux.git] / include / scsi / scsi_transport_iscsi.h

/*
 * iSCSI transport class definitions
 *
 * Copyright (C) IBM Corporation, 2004
 * Copyright (C) Mike Christie, 2004 - 2006
 * Copyright (C) Dmitry Yusupov, 2004 - 2005
 * Copyright (C) Alex Aizman, 2004 - 2005
 *
 * 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 SCSI_TRANSPORT_ISCSI_H
#define SCSI_TRANSPORT_ISCSI_H

#include <linux/device.h>
#include <scsi/iscsi_if.h>

struct scsi_transport_template;
struct iscsi_transport;
struct Scsi_Host;
struct iscsi_cls_conn;
struct iscsi_conn;
struct iscsi_cmd_task;
struct iscsi_mgmt_task;
struct sockaddr;

/**
 * struct iscsi_transport - iSCSI Transport template
 *
 * @name:		transport name
 * @caps:		iSCSI Data-Path capabilities
 * @create_session:	create new iSCSI session object
 * @destroy_session:	destroy existing iSCSI session object
 * @create_conn:	create new iSCSI connection
 * @bind_conn:		associate this connection with existing iSCSI session
 *			and specified transport descriptor
 * @destroy_conn:	destroy inactive iSCSI connection
 * @set_param:		set iSCSI parameter. Return 0 on success, -ENODATA
 *			when param is not supported, and a -Exx value on other
 *			error.
 * @get_param		get iSCSI parameter. Must return number of bytes
 *			copied to buffer on success, -ENODATA when param
 *			is not supported, and a -Exx value on other error
 * @start_conn:		set connection to be operational
 * @stop_conn:		suspend/recover/terminate connection
 * @send_pdu:		send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
 * @session_recovery_timedout: notify LLD a block during recovery timed out
 * @init_cmd_task:	Initialize a iscsi_cmd_task and any internal structs.
 *			Called from queuecommand with session lock held.
 * @init_mgmt_task:	Initialize a iscsi_mgmt_task and any internal structs.
 *			Called from iscsi_conn_send_generic with xmitmutex.
 * @xmit_cmd_task:	Requests LLD to transfer cmd task. Returns 0 or the
 *			the number of bytes transferred on success, and -Exyz
 *			value on error.
 * @xmit_mgmt_task:	Requests LLD to transfer mgmt task. Returns 0 or the
 *			the number of bytes transferred on success, and -Exyz
 *			value on error.
 * @cleanup_cmd_task:	requests LLD to fail cmd task. Called with xmitmutex
 *			and session->lock after the connection has been
 *			suspended and terminated during recovery. If called
 *			from abort task then connection is not suspended
 *			or terminated but sk_callback_lock is held
 *
 * Template API provided by iSCSI Transport
 */
struct iscsi_transport {
	struct module *owner;
	char *name;
	unsigned int caps;
	/* LLD sets this to indicate what values it can export to sysfs */
	uint64_t param_mask;
	uint64_t host_param_mask;
	struct scsi_host_template *host_template;
	/* LLD connection data size */
	int conndata_size;
	/* LLD session data size */
	int sessiondata_size;
	int max_lun;
	unsigned int max_conn;
	unsigned int max_cmd_len;
	struct iscsi_cls_session *(*create_session) (struct iscsi_transport *it,
		struct scsi_transport_template *t, uint16_t, uint16_t,
		uint32_t sn, uint32_t *hn);
	void (*destroy_session) (struct iscsi_cls_session *session);
	struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
				uint32_t cid);
	int (*bind_conn) (struct iscsi_cls_session *session,
			  struct iscsi_cls_conn *cls_conn,
			  uint64_t transport_eph, int is_leading);
	int (*start_conn) (struct iscsi_cls_conn *conn);
	void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
	void (*destroy_conn) (struct iscsi_cls_conn *conn);
	int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
			  char *buf, int buflen);
	int (*get_conn_param) (struct iscsi_cls_conn *conn,
			       enum iscsi_param param, char *buf);
	int (*get_session_param) (struct iscsi_cls_session *session,
				  enum iscsi_param param, char *buf);
	int (*get_host_param) (struct Scsi_Host *shost,
				enum iscsi_host_param param, char *buf);
	int (*set_host_param) (struct Scsi_Host *shost,
			       enum iscsi_host_param param, char *buf,
			       int buflen);
	int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
			 char *data, uint32_t data_size);
	void (*get_stats) (struct iscsi_cls_conn *conn,
			   struct iscsi_stats *stats);
	void (*init_cmd_task) (struct iscsi_cmd_task *ctask);
	void (*init_mgmt_task) (struct iscsi_conn *conn,
				struct iscsi_mgmt_task *mtask);
	int (*xmit_cmd_task) (struct iscsi_conn *conn,
			      struct iscsi_cmd_task *ctask);
	void (*cleanup_cmd_task) (struct iscsi_conn *conn,
				  struct iscsi_cmd_task *ctask);
	int (*xmit_mgmt_task) (struct iscsi_conn *conn,
			       struct iscsi_mgmt_task *mtask);
	void (*session_recovery_timedout) (struct iscsi_cls_session *session);
	int (*ep_connect) (struct sockaddr *dst_addr, int non_blocking,
			   uint64_t *ep_handle);
	int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
	void (*ep_disconnect) (uint64_t ep_handle);
	int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
			  uint32_t enable, struct sockaddr *dst_addr);
};

/*
 * transport registration upcalls
 */
extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
extern int iscsi_unregister_transport(struct iscsi_transport *tt);

/*
 * control plane upcalls
 */
extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
			  char *data, uint32_t data_size);


/* Connection's states */
#define ISCSI_CONN_INITIAL_STAGE	0
#define ISCSI_CONN_STARTED		1
#define ISCSI_CONN_STOPPED		2
#define ISCSI_CONN_CLEANUP_WAIT		3

struct iscsi_cls_conn {
	struct list_head conn_list;	/* item in connlist */
	void *dd_data;			/* LLD private data */
	struct iscsi_transport *transport;
	uint32_t cid;			/* connection id */

	int active;			/* must be accessed with the connlock */
	struct device dev;		/* sysfs transport/container device */
};

#define iscsi_dev_to_conn(_dev) \
	container_of(_dev, struct iscsi_cls_conn, dev)

/* Session's states */
#define ISCSI_STATE_FREE		1
#define ISCSI_STATE_LOGGED_IN		2
#define ISCSI_STATE_FAILED		3
#define ISCSI_STATE_TERMINATE		4
#define ISCSI_STATE_IN_RECOVERY		5
#define ISCSI_STATE_RECOVERY_FAILED	6

struct iscsi_cls_session {
	struct list_head sess_list;		/* item in session_list */
	struct list_head host_list;
	struct iscsi_transport *transport;

	/* recovery fields */
	int recovery_tmo;
	struct delayed_work recovery_work;

	int target_id;

	int sid;				/* session id */
	void *dd_data;				/* LLD private data */
	struct device dev;	/* sysfs transport/container device */
};

#define iscsi_dev_to_session(_dev) \
	container_of(_dev, struct iscsi_cls_session, dev)

#define iscsi_session_to_shost(_session) \
	dev_to_shost(_session->dev.parent)

#define starget_to_session(_stgt) \
	iscsi_dev_to_session(_stgt->dev.parent)

struct iscsi_host {
	struct list_head sessions;
	struct mutex mutex;
};

/*
 * session and connection functions that can be used by HW iSCSI LLDs
 */
extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
					struct iscsi_transport *transport);
extern int iscsi_add_session(struct iscsi_cls_session *session,
			     unsigned int target_id);
extern int iscsi_if_create_session_done(struct iscsi_cls_conn *conn);
extern int iscsi_if_destroy_session_done(struct iscsi_cls_conn *conn);
extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
						struct iscsi_transport *t,
						unsigned int target_id);
extern void iscsi_remove_session(struct iscsi_cls_session *session);
extern void iscsi_free_session(struct iscsi_cls_session *session);
extern int iscsi_destroy_session(struct iscsi_cls_session *session);
extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
					    uint32_t cid);
extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
extern void iscsi_unblock_session(struct iscsi_cls_session *session);
extern void iscsi_block_session(struct iscsi_cls_session *session);


#endif
Commit	Line	Data
39e84790	1	/*
1da177e4 LT	2	* iSCSI transport class definitions
	3	*
	4	* Copyright (C) IBM Corporation, 2004
7996a778	5	* Copyright (C) Mike Christie, 2004 - 2006
39e84790 AA	6	* Copyright (C) Dmitry Yusupov, 2004 - 2005
39e84790 AA	7	* Copyright (C) Alex Aizman, 2004 - 2005
1da177e4 LT	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 SCSI_TRANSPORT_ISCSI_H
	24	#define SCSI_TRANSPORT_ISCSI_H
	25
7b8631b5	26	#include <linux/device.h>
39e84790	27	#include <scsi/iscsi_if.h>
1da177e4	28
7b8631b5	29	struct scsi_transport_template;
7996a778	30	struct iscsi_transport;
7b8631b5	31	struct Scsi_Host;
7b8631b5	32	struct iscsi_cls_conn;
7996a778 MC	33	struct iscsi_conn;
	34	struct iscsi_cmd_task;
	35	struct iscsi_mgmt_task;
a54a52ca	36	struct sockaddr;
7b8631b5	37
39e84790 AA	38	/**
	39	* struct iscsi_transport - iSCSI Transport template
	40	*
	41	* @name: transport name
	42	* @caps: iSCSI Data-Path capabilities
	43	* @create_session: create new iSCSI session object
	44	* @destroy_session: destroy existing iSCSI session object
	45	* @create_conn: create new iSCSI connection
	46	* @bind_conn: associate this connection with existing iSCSI session
	47	* and specified transport descriptor
	48	* @destroy_conn: destroy inactive iSCSI connection
a54a52ca MC	49	* @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
	50	* when param is not supported, and a -Exx value on other
	51	* error.
	52	* @get_param get iSCSI parameter. Must return number of bytes
	53	* copied to buffer on success, -ENODATA when param
	54	* is not supported, and a -Exx value on other error
39e84790 AA	55	* @start_conn: set connection to be operational
	56	* @stop_conn: suspend/recover/terminate connection
	57	* @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
7996a778	58	* @session_recovery_timedout: notify LLD a block during recovery timed out
7996a778 MC	59	* @init_cmd_task: Initialize a iscsi_cmd_task and any internal structs.
	60	* Called from queuecommand with session lock held.
	61	* @init_mgmt_task: Initialize a iscsi_mgmt_task and any internal structs.
	62	* Called from iscsi_conn_send_generic with xmitmutex.
3219e529 MC	63	* @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the
	64	* the number of bytes transferred on success, and -Exyz
	65	* value on error.
	66	* @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the
	67	* the number of bytes transferred on success, and -Exyz
	68	* value on error.
7996a778 MC	69	* @cleanup_cmd_task: requests LLD to fail cmd task. Called with xmitmutex
	70	* and session->lock after the connection has been
	71	* suspended and terminated during recovery. If called
	72	* from abort task then connection is not suspended
	73	* or terminated but sk_callback_lock is held
39e84790 AA	74	*
	75	* Template API provided by iSCSI Transport
	76	*/
	77	struct iscsi_transport {
	78	struct module *owner;
	79	char *name;
	80	unsigned int caps;
fd7255f5	81	/* LLD sets this to indicate what values it can export to sysfs */
1819dc81 MC	82	uint64_t param_mask;
1819dc81 MC	83	uint64_t host_param_mask;
39e84790	84	struct scsi_host_template *host_template;
7b8631b5 MC	85	/* LLD connection data size */
7b8631b5 MC	86	int conndata_size;
b5c7a12d MC	87	/* LLD session data size */
b5c7a12d MC	88	int sessiondata_size;
39e84790 AA	89	int max_lun;
	90	unsigned int max_conn;
	91	unsigned int max_cmd_len;
7996a778	92	struct iscsi_cls_session (create_session) (struct iscsi_transport *it,
1548271e MC	93	struct scsi_transport_template *t, uint16_t, uint16_t,
1548271e MC	94	uint32_t sn, uint32_t *hn);
7b7232f3 MC	95	void (destroy_session) (struct iscsi_cls_session session);
7b7232f3 MC	96	struct iscsi_cls_conn (create_conn) (struct iscsi_cls_session *sess,
7b8631b5	97	uint32_t cid);
7b7232f3 MC	98	int (bind_conn) (struct iscsi_cls_session session,
7b7232f3 MC	99	struct iscsi_cls_conn *cls_conn,
264faaaa	100	uint64_t transport_eph, int is_leading);
7b7232f3 MC	101	int (start_conn) (struct iscsi_cls_conn conn);
7b7232f3 MC	102	void (stop_conn) (struct iscsi_cls_conn conn, int flag);
7b8631b5	103	void (destroy_conn) (struct iscsi_cls_conn conn);
7b7232f3	104	int (set_param) (struct iscsi_cls_conn conn, enum iscsi_param param,
a54a52ca	105	char *buf, int buflen);
7b7232f3	106	int (get_conn_param) (struct iscsi_cls_conn conn,
a54a52ca	107	enum iscsi_param param, char *buf);
7b7232f3	108	int (get_session_param) (struct iscsi_cls_session session,
a54a52ca	109	enum iscsi_param param, char *buf);
1819dc81 MC	110	int (get_host_param) (struct Scsi_Host shost,
1819dc81 MC	111	enum iscsi_host_param param, char *buf);
1d9bf13a MC	112	int (set_host_param) (struct Scsi_Host shost,
	113	enum iscsi_host_param param, char *buf,
	114	int buflen);
7b7232f3	115	int (send_pdu) (struct iscsi_cls_conn conn, struct iscsi_hdr *hdr,
39e84790	116	char *data, uint32_t data_size);
7b7232f3 MC	117	void (get_stats) (struct iscsi_cls_conn conn,
7b7232f3 MC	118	struct iscsi_stats *stats);
7996a778 MC	119	void (init_cmd_task) (struct iscsi_cmd_task ctask);
7996a778 MC	120	void (init_mgmt_task) (struct iscsi_conn conn,
77a23c21	121	struct iscsi_mgmt_task *mtask);
7996a778 MC	122	int (xmit_cmd_task) (struct iscsi_conn conn,
	123	struct iscsi_cmd_task *ctask);
	124	void (cleanup_cmd_task) (struct iscsi_conn conn,
	125	struct iscsi_cmd_task *ctask);
	126	int (xmit_mgmt_task) (struct iscsi_conn conn,
	127	struct iscsi_mgmt_task *mtask);
30a6c652	128	void (session_recovery_timedout) (struct iscsi_cls_session session);
264faaaa OG	129	int (ep_connect) (struct sockaddr dst_addr, int non_blocking,
	130	uint64_t *ep_handle);
	131	int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
	132	void (*ep_disconnect) (uint64_t ep_handle);
2174a04e	133	int (tgt_dscvr) (struct Scsi_Host shost, enum iscsi_tgt_dscvr type,
01cb225d	134	uint32_t enable, struct sockaddr *dst_addr);
1da177e4 LT	135	};
	136
	137	/*
39e84790	138	* transport registration upcalls
1da177e4	139	*/
7b8631b5	140	extern struct scsi_transport_template iscsi_register_transport(struct iscsi_transport tt);
39e84790	141	extern int iscsi_unregister_transport(struct iscsi_transport *tt);
1da177e4 LT	142
1da177e4 LT	143	/*
39e84790	144	* control plane upcalls
1da177e4	145	*/
7b7232f3 MC	146	extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
7b7232f3 MC	147	extern int iscsi_recv_pdu(struct iscsi_cls_conn conn, struct iscsi_hdr hdr,
39e84790	148	char *data, uint32_t data_size);
1da177e4	149
7996a778 MC	150
	151	/* Connection's states */
	152	#define ISCSI_CONN_INITIAL_STAGE 0
	153	#define ISCSI_CONN_STARTED 1
	154	#define ISCSI_CONN_STOPPED 2
	155	#define ISCSI_CONN_CLEANUP_WAIT 3
	156
7b8631b5 MC	157	struct iscsi_cls_conn {
	158	struct list_head conn_list; /* item in connlist */
	159	void dd_data; / LLD private data */
	160	struct iscsi_transport *transport;
b5c7a12d	161	uint32_t cid; /* connection id */
fd7255f5	162
7b8631b5 MC	163	int active; /* must be accessed with the connlock */
7b8631b5 MC	164	struct device dev; /* sysfs transport/container device */
7b8631b5 MC	165	};
	166
	167	#define iscsi_dev_to_conn(_dev) \
	168	container_of(_dev, struct iscsi_cls_conn, dev)
	169
7996a778 MC	170	/* Session's states */
	171	#define ISCSI_STATE_FREE 1
	172	#define ISCSI_STATE_LOGGED_IN 2
	173	#define ISCSI_STATE_FAILED 3
	174	#define ISCSI_STATE_TERMINATE 4
656cffc9 MC	175	#define ISCSI_STATE_IN_RECOVERY 5
656cffc9 MC	176	#define ISCSI_STATE_RECOVERY_FAILED 6
7996a778	177
7b8631b5	178	struct iscsi_cls_session {
7b7232f3	179	struct list_head sess_list; /* item in session_list */
30a6c652	180	struct list_head host_list;
7b8631b5	181	struct iscsi_transport *transport;
fd7255f5	182
30a6c652 MC	183	/* recovery fields */
30a6c652 MC	184	int recovery_tmo;
c4028958	185	struct delayed_work recovery_work;
30a6c652 MC	186
30a6c652 MC	187	int target_id;
30a6c652	188
b5c7a12d MC	189	int sid; /* session id */
b5c7a12d MC	190	void dd_data; / LLD private data */
7b8631b5 MC	191	struct device dev; /* sysfs transport/container device */
	192	};
	193
	194	#define iscsi_dev_to_session(_dev) \
	195	container_of(_dev, struct iscsi_cls_session, dev)
	196
	197	#define iscsi_session_to_shost(_session) \
	198	dev_to_shost(_session->dev.parent)
	199
8434aa8b MC	200	#define starget_to_session(_stgt) \
	201	iscsi_dev_to_session(_stgt->dev.parent)
	202
30a6c652	203	struct iscsi_host {
30a6c652 MC	204	struct list_head sessions;
	205	struct mutex mutex;
	206	};
	207
7b8631b5 MC	208	/*
	209	* session and connection functions that can be used by HW iSCSI LLDs
	210	*/
8434aa8b MC	211	extern struct iscsi_cls_session iscsi_alloc_session(struct Scsi_Host shost,
8434aa8b MC	212	struct iscsi_transport *transport);
6a8a0d36 MC	213	extern int iscsi_add_session(struct iscsi_cls_session *session,
6a8a0d36 MC	214	unsigned int target_id);
53cb8a1f MC	215	extern int iscsi_if_create_session_done(struct iscsi_cls_conn *conn);
53cb8a1f MC	216	extern int iscsi_if_destroy_session_done(struct iscsi_cls_conn *conn);
7b8631b5	217	extern struct iscsi_cls_session iscsi_create_session(struct Scsi_Host shost,
6a8a0d36 MC	218	struct iscsi_transport *t,
6a8a0d36 MC	219	unsigned int target_id);
8434aa8b MC	220	extern void iscsi_remove_session(struct iscsi_cls_session *session);
8434aa8b MC	221	extern void iscsi_free_session(struct iscsi_cls_session *session);
7b8631b5 MC	222	extern int iscsi_destroy_session(struct iscsi_cls_session *session);
	223	extern struct iscsi_cls_conn iscsi_create_conn(struct iscsi_cls_session sess,
	224	uint32_t cid);
	225	extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
30a6c652 MC	226	extern void iscsi_unblock_session(struct iscsi_cls_session *session);
30a6c652 MC	227	extern void iscsi_block_session(struct iscsi_cls_session *session);
7b8631b5	228
53cb8a1f	229
1da177e4	230	#endif