[mirror_ubuntu-zesty-kernel.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 mempool_zone;
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
 * @suspend_conn_recv:	susepend the recv side of the connection
 * @termincate_conn:	destroy socket connection. Called with mutex lock.
 * @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 */
	unsigned int 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, 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 (*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 (*suspend_conn_recv) (struct iscsi_conn *conn);
	void (*terminate_conn) (struct iscsi_conn *conn);
	void (*init_cmd_task) (struct iscsi_cmd_task *ctask);
	void (*init_mgmt_task) (struct iscsi_conn *conn,
				struct iscsi_mgmt_task *mtask,
				char *data, uint32_t data_size);
	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) (enum iscsi_tgt_dscvr type, uint32_t host_no,
			  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 */
	struct mempool_zone *z_error;
	struct mempool_zone *z_pdu;
	struct list_head freequeue;
};

#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 work_struct 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)

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