[deliverable/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 <linux/list.h>
#include <linux/mutex.h>
#include <scsi/iscsi_if.h>

struct scsi_transport_template;
struct iscsi_transport;
struct iscsi_endpoint;
struct Scsi_Host;
struct scsi_cmnd;
struct iscsi_cls_conn;
struct iscsi_conn;
struct iscsi_task;
struct sockaddr;
struct iscsi_iface;
struct bsg_job;

/**
 * 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_task:		Initialize a iscsi_task and any internal structs.
 *			When offloading the data path, this is called from
 *			queuecommand with the session lock, or from the
 *			iscsi_conn_send_pdu context with the session lock.
 *			When not offloading the data path, this is called
 *			from the scsi work queue without the session lock.
 * @xmit_task		Requests LLD to transfer cmd task. Returns 0 or the
 *			the number of bytes transferred on success, and -Exyz
 *			value on error. When offloading the data path, this
 *			is called from queuecommand with the session lock, or
 *			from the iscsi_conn_send_pdu context with the session
 *			lock. When not offloading the data path, this is called
 *			from the scsi work queue without the session lock.
 * @cleanup_task:	requests LLD to fail task. Called with session lock
 *			and 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;

	struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
					uint16_t cmds_max, uint16_t qdepth,
					uint32_t sn);
	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_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
			     char *buf);
	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);

	int (*init_task) (struct iscsi_task *task);
	int (*xmit_task) (struct iscsi_task *task);
	void (*cleanup_task) (struct iscsi_task *task);

	int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
	int (*xmit_pdu) (struct iscsi_task *task);
	int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
			 unsigned int count);
	void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
			       int *index, int *age);

	void (*session_recovery_timedout) (struct iscsi_cls_session *session);
	struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
					      struct sockaddr *dst_addr,
					      int non_blocking);
	int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
	void (*ep_disconnect) (struct iscsi_endpoint *ep);
	int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
			  uint32_t enable, struct sockaddr *dst_addr);
	int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
	int (*set_iface_param) (struct Scsi_Host *shost, void *data,
				uint32_t len);
	int (*get_iface_param) (struct iscsi_iface *iface,
				enum iscsi_param_type param_type,
				int param, char *buf);
	umode_t (*attr_is_visible)(int param_type, int param);
	int (*bsg_request)(struct bsg_job *job);
	int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num,
			  uint32_t iface_type, uint32_t payload_size,
			  uint32_t pid, struct sockaddr *dst_addr);
	int (*get_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx,
			 uint32_t *num_entries, char *buf);
	int (*delete_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx);
};

/*
 * 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_event(struct iscsi_cls_conn *conn,
				   enum iscsi_err error);
extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
				   enum iscsi_conn_state state);
extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
			  char *data, uint32_t data_size);

extern int iscsi_offload_mesg(struct Scsi_Host *shost,
			      struct iscsi_transport *transport, uint32_t type,
			      char *data, uint16_t data_size);

extern void iscsi_post_host_event(uint32_t host_no,
				  struct iscsi_transport *transport,
				  enum iscsi_host_event_code code,
				  uint32_t data_size,
				  uint8_t *data);

extern void iscsi_ping_comp_event(uint32_t host_no,
				  struct iscsi_transport *transport,
				  uint32_t status, uint32_t pid,
				  uint32_t data_size, uint8_t *data);

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 */
	struct mutex ep_mutex;
	struct iscsi_endpoint *ep;

	struct device dev;		/* sysfs transport/container device */
};

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

#define transport_class_to_conn(_cdev) \
	iscsi_dev_to_conn(_cdev->parent)

#define iscsi_conn_to_session(_conn) \
	iscsi_dev_to_session(_conn->dev.parent)

/* iscsi class session state */
enum {
	ISCSI_SESSION_LOGGED_IN,
	ISCSI_SESSION_FAILED,
	ISCSI_SESSION_FREE,
};

#define ISCSI_MAX_TARGET -1

struct iscsi_cls_session {
	struct list_head sess_list;		/* item in session_list */
	struct iscsi_transport *transport;
	spinlock_t lock;
	struct work_struct block_work;
	struct work_struct unblock_work;
	struct work_struct scan_work;
	struct work_struct unbind_work;

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

	unsigned int target_id;
	bool ida_used;

	/*
	 * pid of userspace process that created session or -1 if
	 * created by the kernel.
	 */
	pid_t creator;
	int state;
	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 transport_class_to_session(_cdev) \
	iscsi_dev_to_session(_cdev->parent)

#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_cls_host {
	atomic_t nr_scans;
	struct mutex mutex;
	struct request_queue *bsg_q;
	uint32_t port_speed;
	uint32_t port_state;
};

#define iscsi_job_to_shost(_job) \
        dev_to_shost(_job->dev)

extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
				void (*fn)(struct iscsi_cls_session *));

struct iscsi_endpoint {
	void *dd_data;			/* LLD private data */
	struct device dev;
	uint64_t id;
	struct iscsi_cls_conn *conn;
};

struct iscsi_iface {
	struct device dev;
	struct iscsi_transport *transport;
	uint32_t iface_type;	/* IPv4 or IPv6 */
	uint32_t iface_num;	/* iface number, 0 - n */
	void *dd_data;		/* LLD private data */
};

#define iscsi_dev_to_iface(_dev) \
	container_of(_dev, struct iscsi_iface, dev)

#define iscsi_iface_to_shost(_iface) \
	dev_to_shost(_iface->dev.parent)

/*
 * session and connection functions that can be used by HW iSCSI LLDs
 */
#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
	dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)

#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
	dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)

extern int iscsi_session_chkready(struct iscsi_cls_session *session);
extern int iscsi_is_session_online(struct iscsi_cls_session *session);
extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
				struct iscsi_transport *transport, int dd_size);
extern int iscsi_add_session(struct iscsi_cls_session *session,
			     unsigned int target_id);
extern int iscsi_session_event(struct iscsi_cls_session *session,
			       enum iscsi_uevent_e event);
extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
						struct iscsi_transport *t,
						int dd_size,
						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,
						int dd_size, 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);
extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
					      struct iscsi_transport *t,
					      uint32_t iface_type,
					      uint32_t iface_num, int dd_size);
extern void iscsi_destroy_iface(struct iscsi_iface *iface);
extern struct iscsi_iface *iscsi_lookup_iface(int handle);
extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
extern int iscsi_is_session_dev(const struct device *dev);

#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>
d773c082 MT	27	#include <linux/list.h>
d773c082 MT	28	#include <linux/mutex.h>
39e84790	29	#include <scsi/iscsi_if.h>
1da177e4	30
7b8631b5	31	struct scsi_transport_template;
7996a778	32	struct iscsi_transport;
d82ff9be	33	struct iscsi_endpoint;
7b8631b5	34	struct Scsi_Host;
c01be6dc	35	struct scsi_cmnd;
7b8631b5	36	struct iscsi_cls_conn;
7996a778	37	struct iscsi_conn;
9c19a7d0	38	struct iscsi_task;
a54a52ca	39	struct sockaddr;
8d07913d	40	struct iscsi_iface;
90eeb01a	41	struct bsg_job;
7b8631b5	42
39e84790 AA	43	/**
	44	* struct iscsi_transport - iSCSI Transport template
	45	*
	46	* @name: transport name
	47	* @caps: iSCSI Data-Path capabilities
	48	* @create_session: create new iSCSI session object
	49	* @destroy_session: destroy existing iSCSI session object
	50	* @create_conn: create new iSCSI connection
	51	* @bind_conn: associate this connection with existing iSCSI session
	52	* and specified transport descriptor
	53	* @destroy_conn: destroy inactive iSCSI connection
a54a52ca MC	54	* @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
	55	* when param is not supported, and a -Exx value on other
	56	* error.
	57	* @get_param get iSCSI parameter. Must return number of bytes
	58	* copied to buffer on success, -ENODATA when param
	59	* is not supported, and a -Exx value on other error
39e84790 AA	60	* @start_conn: set connection to be operational
	61	* @stop_conn: suspend/recover/terminate connection
	62	* @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
7996a778	63	* @session_recovery_timedout: notify LLD a block during recovery timed out
3e5c28ad MC	64	* @init_task: Initialize a iscsi_task and any internal structs.
	65	* When offloading the data path, this is called from
	66	* queuecommand with the session lock, or from the
	67	* iscsi_conn_send_pdu context with the session lock.
	68	* When not offloading the data path, this is called
	69	* from the scsi work queue without the session lock.
	70	* @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
3219e529	71	* the number of bytes transferred on success, and -Exyz
3e5c28ad MC	72	* value on error. When offloading the data path, this
	73	* is called from queuecommand with the session lock, or
	74	* from the iscsi_conn_send_pdu context with the session
	75	* lock. When not offloading the data path, this is called
	76	* from the scsi work queue without the session lock.
	77	* @cleanup_task: requests LLD to fail task. Called with session lock
	78	* and after the connection has been suspended and
	79	* terminated during recovery. If called
7996a778 MC	80	* from abort task then connection is not suspended
7996a778 MC	81	* or terminated but sk_callback_lock is held
39e84790 AA	82	*
	83	* Template API provided by iSCSI Transport
	84	*/
	85	struct iscsi_transport {
	86	struct module *owner;
	87	char *name;
	88	unsigned int caps;
8d07913d	89
d82ff9be	90	struct iscsi_cls_session (create_session) (struct iscsi_endpoint *ep,
75613521	91	uint16_t cmds_max, uint16_t qdepth,
5e7facb7	92	uint32_t sn);
7b7232f3 MC	93	void (destroy_session) (struct iscsi_cls_session session);
7b7232f3 MC	94	struct iscsi_cls_conn (create_conn) (struct iscsi_cls_session *sess,
7b8631b5	95	uint32_t cid);
7b7232f3 MC	96	int (bind_conn) (struct iscsi_cls_session session,
7b7232f3 MC	97	struct iscsi_cls_conn *cls_conn,
264faaaa	98	uint64_t transport_eph, int is_leading);
7b7232f3 MC	99	int (start_conn) (struct iscsi_cls_conn conn);
7b7232f3 MC	100	void (stop_conn) (struct iscsi_cls_conn conn, int flag);
7b8631b5	101	void (destroy_conn) (struct iscsi_cls_conn conn);
7b7232f3	102	int (set_param) (struct iscsi_cls_conn conn, enum iscsi_param param,
a54a52ca	103	char *buf, int buflen);
289324b0 MC	104	int (get_ep_param) (struct iscsi_endpoint ep, enum iscsi_param param,
289324b0 MC	105	char *buf);
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);
577577da	119
9c19a7d0 MC	120	int (init_task) (struct iscsi_task task);
9c19a7d0 MC	121	int (xmit_task) (struct iscsi_task task);
577577da MC	122	void (cleanup_task) (struct iscsi_task task);
577577da MC	123
2ff79d52	124	int (alloc_pdu) (struct iscsi_task task, uint8_t opcode);
577577da MC	125	int (xmit_pdu) (struct iscsi_task task);
	126	int (init_pdu) (struct iscsi_task task, unsigned int offset,
	127	unsigned int count);
262ef636 MC	128	void (parse_pdu_itt) (struct iscsi_conn conn, itt_t itt,
	129	int index, int age);
	130
30a6c652	131	void (session_recovery_timedout) (struct iscsi_cls_session session);
10eb0f01 MC	132	struct iscsi_endpoint (ep_connect) (struct Scsi_Host *shost,
10eb0f01 MC	133	struct sockaddr *dst_addr,
d82ff9be MC	134	int non_blocking);
	135	int (ep_poll) (struct iscsi_endpoint ep, int timeout_ms);
	136	void (ep_disconnect) (struct iscsi_endpoint ep);
2174a04e	137	int (tgt_dscvr) (struct Scsi_Host shost, enum iscsi_tgt_dscvr type,
01cb225d	138	uint32_t enable, struct sockaddr *dst_addr);
43514774	139	int (set_path) (struct Scsi_Host shost, struct iscsi_path *params);
00c31889 MC	140	int (set_iface_param) (struct Scsi_Host shost, void *data,
00c31889 MC	141	uint32_t len);
8d07913d MC	142	int (get_iface_param) (struct iscsi_iface iface,
	143	enum iscsi_param_type param_type,
	144	int param, char *buf);
587a1f16	145	umode_t (*attr_is_visible)(int param_type, int param);
90eeb01a	146	int (bsg_request)(struct bsg_job job);
ac20c7bf VC	147	int (send_ping) (struct Scsi_Host shost, uint32_t iface_num,
	148	uint32_t iface_type, uint32_t payload_size,
	149	uint32_t pid, struct sockaddr *dst_addr);
6260a5d2 NJ	150	int (get_chap) (struct Scsi_Host shost, uint16_t chap_tbl_idx,
	151	uint32_t num_entries, char buf);
	152	int (delete_chap) (struct Scsi_Host shost, uint16_t chap_tbl_idx);
1da177e4 LT	153	};
	154
	155	/*
39e84790	156	* transport registration upcalls
1da177e4	157	*/
7b8631b5	158	extern struct scsi_transport_template iscsi_register_transport(struct iscsi_transport tt);
39e84790	159	extern int iscsi_unregister_transport(struct iscsi_transport *tt);
1da177e4 LT	160
1da177e4 LT	161	/*
39e84790	162	* control plane upcalls
1da177e4	163	*/
e5bd7b54 MC	164	extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
e5bd7b54 MC	165	enum iscsi_err error);
17fa575e MR	166	extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
17fa575e MR	167	enum iscsi_conn_state state);
7b7232f3	168	extern int iscsi_recv_pdu(struct iscsi_cls_conn conn, struct iscsi_hdr hdr,
39e84790	169	char *data, uint32_t data_size);
1da177e4	170
43514774 MC	171	extern int iscsi_offload_mesg(struct Scsi_Host *shost,
	172	struct iscsi_transport *transport, uint32_t type,
	173	char *data, uint16_t data_size);
	174
a11e2545 VC	175	extern void iscsi_post_host_event(uint32_t host_no,
	176	struct iscsi_transport *transport,
	177	enum iscsi_host_event_code code,
	178	uint32_t data_size,
	179	uint8_t *data);
	180
ac20c7bf VC	181	extern void iscsi_ping_comp_event(uint32_t host_no,
	182	struct iscsi_transport *transport,
	183	uint32_t status, uint32_t pid,
	184	uint32_t data_size, uint8_t *data);
	185
7b8631b5 MC	186	struct iscsi_cls_conn {
	187	struct list_head conn_list; /* item in connlist */
	188	void dd_data; / LLD private data */
	189	struct iscsi_transport *transport;
b5c7a12d	190	uint32_t cid; /* connection id */
22a39fbb MC	191	struct mutex ep_mutex;
22a39fbb MC	192	struct iscsi_endpoint *ep;
fd7255f5	193
7b8631b5	194	struct device dev; /* sysfs transport/container device */
7b8631b5 MC	195	};
	196
	197	#define iscsi_dev_to_conn(_dev) \
	198	container_of(_dev, struct iscsi_cls_conn, dev)
	199
3128c6c7 MC	200	#define transport_class_to_conn(_cdev) \
	201	iscsi_dev_to_conn(_cdev->parent)
	202
6eabafbe MC	203	#define iscsi_conn_to_session(_conn) \
	204	iscsi_dev_to_session(_conn->dev.parent)
	205
	206	/* iscsi class session state */
	207	enum {
	208	ISCSI_SESSION_LOGGED_IN,
	209	ISCSI_SESSION_FAILED,
	210	ISCSI_SESSION_FREE,
	211	};
7996a778	212
7970634b MC	213	#define ISCSI_MAX_TARGET -1
7970634b MC	214
7b8631b5	215	struct iscsi_cls_session {
7b7232f3	216	struct list_head sess_list; /* item in session_list */
7b8631b5	217	struct iscsi_transport *transport;
6eabafbe	218	spinlock_t lock;
45ab33b6 MC	219	struct work_struct block_work;
45ab33b6 MC	220	struct work_struct unblock_work;
bd976f62 MC	221	struct work_struct scan_work;
bd976f62 MC	222	struct work_struct unbind_work;
fd7255f5	223
30a6c652 MC	224	/* recovery fields */
30a6c652 MC	225	int recovery_tmo;
c4028958	226	struct delayed_work recovery_work;
30a6c652	227
7970634b	228	unsigned int target_id;
8d4a690c	229	bool ida_used;
30a6c652	230
0c70d84b MC	231	/*
	232	* pid of userspace process that created session or -1 if
	233	* created by the kernel.
	234	*/
	235	pid_t creator;
6eabafbe	236	int state;
b5c7a12d MC	237	int sid; /* session id */
b5c7a12d MC	238	void dd_data; / LLD private data */
7b8631b5 MC	239	struct device dev; /* sysfs transport/container device */
	240	};
	241
	242	#define iscsi_dev_to_session(_dev) \
	243	container_of(_dev, struct iscsi_cls_session, dev)
	244
1d063c17 MC	245	#define transport_class_to_session(_cdev) \
	246	iscsi_dev_to_session(_cdev->parent)
	247
7b8631b5 MC	248	#define iscsi_session_to_shost(_session) \
	249	dev_to_shost(_session->dev.parent)
	250
8434aa8b MC	251	#define starget_to_session(_stgt) \
	252	iscsi_dev_to_session(_stgt->dev.parent)
	253
32c6e1b9	254	struct iscsi_cls_host {
8aae18ad	255	atomic_t nr_scans;
30a6c652	256	struct mutex mutex;
90eeb01a	257	struct request_queue *bsg_q;
aeddde29 VC	258	uint32_t port_speed;
aeddde29 VC	259	uint32_t port_state;
30a6c652 MC	260	};
30a6c652 MC	261
90eeb01a MC	262	#define iscsi_job_to_shost(_job) \
	263	dev_to_shost(_job->dev)
	264
a4804cd6 MC	265	extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
	266	void (fn)(struct iscsi_cls_session ));
	267
d82ff9be MC	268	struct iscsi_endpoint {
	269	void dd_data; / LLD private data */
	270	struct device dev;
21536062	271	uint64_t id;
22a39fbb	272	struct iscsi_cls_conn *conn;
d82ff9be	273	};
a4804cd6	274
8d07913d MC	275	struct iscsi_iface {
	276	struct device dev;
	277	struct iscsi_transport *transport;
	278	uint32_t iface_type; /* IPv4 or IPv6 */
	279	uint32_t iface_num; /* iface number, 0 - n */
	280	void dd_data; / LLD private data */
	281	};
	282
	283	#define iscsi_dev_to_iface(_dev) \
	284	container_of(_dev, struct iscsi_iface, dev)
	285
	286	#define iscsi_iface_to_shost(_iface) \
	287	dev_to_shost(_iface->dev.parent)
	288
7b8631b5 MC	289	/*
	290	* session and connection functions that can be used by HW iSCSI LLDs
	291	*/
322d739d MC	292	#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
	293	dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
	294
	295	#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
	296	dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
	297
6eabafbe	298	extern int iscsi_session_chkready(struct iscsi_cls_session *session);
17fa575e	299	extern int iscsi_is_session_online(struct iscsi_cls_session *session);
8434aa8b	300	extern struct iscsi_cls_session iscsi_alloc_session(struct Scsi_Host shost,
5d91e209	301	struct iscsi_transport *transport, int dd_size);
6a8a0d36 MC	302	extern int iscsi_add_session(struct iscsi_cls_session *session,
6a8a0d36 MC	303	unsigned int target_id);
26974789 MC	304	extern int iscsi_session_event(struct iscsi_cls_session *session,
26974789 MC	305	enum iscsi_uevent_e event);
7b8631b5	306	extern struct iscsi_cls_session iscsi_create_session(struct Scsi_Host shost,
6a8a0d36	307	struct iscsi_transport *t,
5d91e209	308	int dd_size,
6a8a0d36	309	unsigned int target_id);
8434aa8b MC	310	extern void iscsi_remove_session(struct iscsi_cls_session *session);
8434aa8b MC	311	extern void iscsi_free_session(struct iscsi_cls_session *session);
7b8631b5 MC	312	extern int iscsi_destroy_session(struct iscsi_cls_session *session);
7b8631b5 MC	313	extern struct iscsi_cls_conn iscsi_create_conn(struct iscsi_cls_session sess,
5d91e209	314	int dd_size, uint32_t cid);
7b8631b5	315	extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
30a6c652 MC	316	extern void iscsi_unblock_session(struct iscsi_cls_session *session);
30a6c652 MC	317	extern void iscsi_block_session(struct iscsi_cls_session *session);
8aae18ad	318	extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
d82ff9be MC	319	extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
	320	extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
	321	extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
c01be6dc	322	extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
8d07913d MC	323	extern struct iscsi_iface iscsi_create_iface(struct Scsi_Host shost,
	324	struct iscsi_transport *t,
	325	uint32_t iface_type,
	326	uint32_t iface_num, int dd_size);
	327	extern void iscsi_destroy_iface(struct iscsi_iface *iface);
	328	extern struct iscsi_iface *iscsi_lookup_iface(int handle);
aeddde29 VC	329	extern char iscsi_get_port_speed_name(struct Scsi_Host shost);
aeddde29 VC	330	extern char iscsi_get_port_state_name(struct Scsi_Host shost);
6260a5d2	331	extern int iscsi_is_session_dev(const struct device *dev);
53cb8a1f	332
1da177e4	333	#endif