[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_bus_flash_session;
struct iscsi_bus_flash_conn;

/**
 * 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);
	int (*get_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
				    int param, char *buf);
	int (*set_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
				    struct iscsi_bus_flash_conn *fnode_conn,
				    void *data, int len);
	int (*new_flashnode) (struct Scsi_Host *shost, const char *buf,
			      int len);
	int (*del_flashnode) (struct iscsi_bus_flash_session *fnode_sess);
	int (*login_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
				struct iscsi_bus_flash_conn *fnode_conn);
	int (*logout_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
				 struct iscsi_bus_flash_conn *fnode_conn);
	int (*logout_flashnode_sid) (struct iscsi_cls_session *cls_sess);
};

/*
 * 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)


struct iscsi_bus_flash_conn {
	struct list_head conn_list;	/* item in connlist */
	void *dd_data;			/* LLD private data */
	struct iscsi_transport *transport;
	struct device dev;		/* sysfs transport/container device */
	/* iscsi connection parameters */
	uint32_t		exp_statsn;
	uint32_t		statsn;
	unsigned		max_recv_dlength; /* initiator_max_recv_dsl*/
	unsigned		max_xmit_dlength; /* target_max_recv_dsl */
	unsigned		max_segment_size;
	unsigned		tcp_xmit_wsf;
	unsigned		tcp_recv_wsf;
	int			hdrdgst_en;
	int			datadgst_en;
	int			port;
	char			*ipaddress;
	char			*link_local_ipv6_addr;
	char			*redirect_ipaddr;
	uint16_t		keepalive_timeout;
	uint16_t		local_port;
	uint8_t			snack_req_en;
	/* tcp timestamp negotiation status */
	uint8_t			tcp_timestamp_stat;
	uint8_t			tcp_nagle_disable;
	/* tcp window scale factor */
	uint8_t			tcp_wsf_disable;
	uint8_t			tcp_timer_scale;
	uint8_t			tcp_timestamp_en;
	uint8_t			ipv4_tos;
	uint8_t			ipv6_traffic_class;
	uint8_t			ipv6_flow_label;
	uint8_t			fragment_disable;
	/* Link local IPv6 address is assigned by firmware or driver */
	uint8_t			is_fw_assigned_ipv6;
};

#define iscsi_dev_to_flash_conn(_dev) \
	container_of(_dev, struct iscsi_bus_flash_conn, dev)

#define iscsi_flash_conn_to_flash_session(_conn) \
	iscsi_dev_to_flash_session(_conn->dev.parent)

#define ISID_SIZE 6

struct iscsi_bus_flash_session {
	struct list_head sess_list;		/* item in session_list */
	struct iscsi_transport *transport;
	unsigned int target_id;
	int flash_state;	/* persistent or non-persistent */
	void *dd_data;				/* LLD private data */
	struct device dev;	/* sysfs transport/container device */
	/* iscsi session parameters */
	unsigned		first_burst;
	unsigned		max_burst;
	unsigned short		max_r2t;
	int			default_taskmgmt_timeout;
	int			initial_r2t_en;
	int			imm_data_en;
	int			time2wait;
	int			time2retain;
	int			pdu_inorder_en;
	int			dataseq_inorder_en;
	int			erl;
	int			tpgt;
	char			*username;
	char			*username_in;
	char			*password;
	char			*password_in;
	char			*targetname;
	char			*targetalias;
	char			*portal_type;
	uint16_t		tsid;
	uint16_t		chap_in_idx;
	uint16_t		chap_out_idx;
	/* index of iSCSI discovery session if the entry is
	 * discovered by iSCSI discovery session
	 */
	uint16_t		discovery_parent_idx;
	/* indicates if discovery was done through iSNS discovery service
	 * or through sendTarget */
	uint16_t		discovery_parent_type;
	/* Firmware auto sendtarget discovery disable */
	uint8_t			auto_snd_tgt_disable;
	uint8_t			discovery_sess;
	/* indicates if this flashnode entry is enabled or disabled */
	uint8_t			entry_state;
	uint8_t			chap_auth_en;
	/* enables firmware to auto logout the discovery session on discovery
	 * completion
	 */
	uint8_t			discovery_logout_en;
	uint8_t			bidi_chap_en;
	/* makes authentication for discovery session optional */
	uint8_t			discovery_auth_optional;
	uint8_t			isid[ISID_SIZE];
	uint8_t			is_boot_target;
};

#define iscsi_dev_to_flash_session(_dev) \
	container_of(_dev, struct iscsi_bus_flash_session, dev)

#define iscsi_flash_session_to_shost(_session) \
	dev_to_shost(_session->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);

extern char *iscsi_get_discovery_parent_name(int parent_type);
extern struct device *
iscsi_find_flashnode(struct Scsi_Host *shost, void *data,
		     int (*fn)(struct device *dev, void *data));

extern struct iscsi_bus_flash_session *
iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index,
			    struct iscsi_transport *transport, int dd_size);

extern struct iscsi_bus_flash_conn *
iscsi_create_flashnode_conn(struct Scsi_Host *shost,
			    struct iscsi_bus_flash_session *fnode_sess,
			    struct iscsi_transport *transport, int dd_size);

extern void
iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess);

extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost);
extern int iscsi_flashnode_bus_match(struct device *dev,
				     struct device_driver *drv);
extern struct device *
iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data,
			  int (*fn)(struct device *dev, void *data));
extern struct device *
iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess);

#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;
c6a4bb2e AC	42	struct iscsi_bus_flash_session;
c6a4bb2e AC	43	struct iscsi_bus_flash_conn;
7b8631b5	44
39e84790 AA	45	/**
	46	* struct iscsi_transport - iSCSI Transport template
	47	*
	48	* @name: transport name
	49	* @caps: iSCSI Data-Path capabilities
	50	* @create_session: create new iSCSI session object
	51	* @destroy_session: destroy existing iSCSI session object
	52	* @create_conn: create new iSCSI connection
	53	* @bind_conn: associate this connection with existing iSCSI session
	54	* and specified transport descriptor
	55	* @destroy_conn: destroy inactive iSCSI connection
a54a52ca MC	56	* @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
	57	* when param is not supported, and a -Exx value on other
	58	* error.
	59	* @get_param get iSCSI parameter. Must return number of bytes
	60	* copied to buffer on success, -ENODATA when param
	61	* is not supported, and a -Exx value on other error
39e84790 AA	62	* @start_conn: set connection to be operational
	63	* @stop_conn: suspend/recover/terminate connection
	64	* @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
7996a778	65	* @session_recovery_timedout: notify LLD a block during recovery timed out
3e5c28ad MC	66	* @init_task: Initialize a iscsi_task and any internal structs.
	67	* When offloading the data path, this is called from
	68	* queuecommand with the session lock, or from the
	69	* iscsi_conn_send_pdu context with the session lock.
	70	* When not offloading the data path, this is called
	71	* from the scsi work queue without the session lock.
	72	* @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
3219e529	73	* the number of bytes transferred on success, and -Exyz
3e5c28ad MC	74	* value on error. When offloading the data path, this
	75	* is called from queuecommand with the session lock, or
	76	* from the iscsi_conn_send_pdu context with the session
	77	* lock. When not offloading the data path, this is called
	78	* from the scsi work queue without the session lock.
	79	* @cleanup_task: requests LLD to fail task. Called with session lock
	80	* and after the connection has been suspended and
	81	* terminated during recovery. If called
7996a778 MC	82	* from abort task then connection is not suspended
7996a778 MC	83	* or terminated but sk_callback_lock is held
39e84790 AA	84	*
	85	* Template API provided by iSCSI Transport
	86	*/
	87	struct iscsi_transport {
	88	struct module *owner;
	89	char *name;
	90	unsigned int caps;
8d07913d	91
d82ff9be	92	struct iscsi_cls_session (create_session) (struct iscsi_endpoint *ep,
75613521	93	uint16_t cmds_max, uint16_t qdepth,
5e7facb7	94	uint32_t sn);
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);
289324b0 MC	106	int (get_ep_param) (struct iscsi_endpoint ep, enum iscsi_param param,
289324b0 MC	107	char *buf);
7b7232f3	108	int (get_conn_param) (struct iscsi_cls_conn conn,
a54a52ca	109	enum iscsi_param param, char *buf);
7b7232f3	110	int (get_session_param) (struct iscsi_cls_session session,
a54a52ca	111	enum iscsi_param param, char *buf);
1819dc81 MC	112	int (get_host_param) (struct Scsi_Host shost,
1819dc81 MC	113	enum iscsi_host_param param, char *buf);
1d9bf13a MC	114	int (set_host_param) (struct Scsi_Host shost,
	115	enum iscsi_host_param param, char *buf,
	116	int buflen);
7b7232f3	117	int (send_pdu) (struct iscsi_cls_conn conn, struct iscsi_hdr *hdr,
39e84790	118	char *data, uint32_t data_size);
7b7232f3 MC	119	void (get_stats) (struct iscsi_cls_conn conn,
7b7232f3 MC	120	struct iscsi_stats *stats);
577577da	121
9c19a7d0 MC	122	int (init_task) (struct iscsi_task task);
9c19a7d0 MC	123	int (xmit_task) (struct iscsi_task task);
577577da MC	124	void (cleanup_task) (struct iscsi_task task);
577577da MC	125
2ff79d52	126	int (alloc_pdu) (struct iscsi_task task, uint8_t opcode);
577577da MC	127	int (xmit_pdu) (struct iscsi_task task);
	128	int (init_pdu) (struct iscsi_task task, unsigned int offset,
	129	unsigned int count);
262ef636 MC	130	void (parse_pdu_itt) (struct iscsi_conn conn, itt_t itt,
	131	int index, int age);
	132
30a6c652	133	void (session_recovery_timedout) (struct iscsi_cls_session session);
10eb0f01 MC	134	struct iscsi_endpoint (ep_connect) (struct Scsi_Host *shost,
10eb0f01 MC	135	struct sockaddr *dst_addr,
d82ff9be MC	136	int non_blocking);
	137	int (ep_poll) (struct iscsi_endpoint ep, int timeout_ms);
	138	void (ep_disconnect) (struct iscsi_endpoint ep);
2174a04e	139	int (tgt_dscvr) (struct Scsi_Host shost, enum iscsi_tgt_dscvr type,
01cb225d	140	uint32_t enable, struct sockaddr *dst_addr);
43514774	141	int (set_path) (struct Scsi_Host shost, struct iscsi_path *params);
00c31889 MC	142	int (set_iface_param) (struct Scsi_Host shost, void *data,
00c31889 MC	143	uint32_t len);
8d07913d MC	144	int (get_iface_param) (struct iscsi_iface iface,
	145	enum iscsi_param_type param_type,
	146	int param, char *buf);
587a1f16	147	umode_t (*attr_is_visible)(int param_type, int param);
90eeb01a	148	int (bsg_request)(struct bsg_job job);
ac20c7bf VC	149	int (send_ping) (struct Scsi_Host shost, uint32_t iface_num,
	150	uint32_t iface_type, uint32_t payload_size,
	151	uint32_t pid, struct sockaddr *dst_addr);
6260a5d2 NJ	152	int (get_chap) (struct Scsi_Host shost, uint16_t chap_tbl_idx,
	153	uint32_t num_entries, char buf);
	154	int (delete_chap) (struct Scsi_Host shost, uint16_t chap_tbl_idx);
c6a4bb2e AC	155	int (get_flashnode_param) (struct iscsi_bus_flash_session fnode_sess,
	156	int param, char *buf);
	157	int (set_flashnode_param) (struct iscsi_bus_flash_session fnode_sess,
	158	struct iscsi_bus_flash_conn *fnode_conn,
	159	void *data, int len);
	160	int (new_flashnode) (struct Scsi_Host shost, const char *buf,
	161	int len);
	162	int (del_flashnode) (struct iscsi_bus_flash_session fnode_sess);
	163	int (login_flashnode) (struct iscsi_bus_flash_session fnode_sess,
	164	struct iscsi_bus_flash_conn *fnode_conn);
	165	int (logout_flashnode) (struct iscsi_bus_flash_session fnode_sess,
	166	struct iscsi_bus_flash_conn *fnode_conn);
	167	int (logout_flashnode_sid) (struct iscsi_cls_session cls_sess);
1da177e4 LT	168	};
	169
	170	/*
39e84790	171	* transport registration upcalls
1da177e4	172	*/
7b8631b5	173	extern struct scsi_transport_template iscsi_register_transport(struct iscsi_transport tt);
39e84790	174	extern int iscsi_unregister_transport(struct iscsi_transport *tt);
1da177e4 LT	175
1da177e4 LT	176	/*
39e84790	177	* control plane upcalls
1da177e4	178	*/
e5bd7b54 MC	179	extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
e5bd7b54 MC	180	enum iscsi_err error);
17fa575e MR	181	extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
17fa575e MR	182	enum iscsi_conn_state state);
7b7232f3	183	extern int iscsi_recv_pdu(struct iscsi_cls_conn conn, struct iscsi_hdr hdr,
39e84790	184	char *data, uint32_t data_size);
1da177e4	185
43514774 MC	186	extern int iscsi_offload_mesg(struct Scsi_Host *shost,
	187	struct iscsi_transport *transport, uint32_t type,
	188	char *data, uint16_t data_size);
	189
a11e2545 VC	190	extern void iscsi_post_host_event(uint32_t host_no,
	191	struct iscsi_transport *transport,
	192	enum iscsi_host_event_code code,
	193	uint32_t data_size,
	194	uint8_t *data);
	195
ac20c7bf VC	196	extern void iscsi_ping_comp_event(uint32_t host_no,
	197	struct iscsi_transport *transport,
	198	uint32_t status, uint32_t pid,
	199	uint32_t data_size, uint8_t *data);
	200
7b8631b5 MC	201	struct iscsi_cls_conn {
	202	struct list_head conn_list; /* item in connlist */
	203	void dd_data; / LLD private data */
	204	struct iscsi_transport *transport;
b5c7a12d	205	uint32_t cid; /* connection id */
22a39fbb MC	206	struct mutex ep_mutex;
22a39fbb MC	207	struct iscsi_endpoint *ep;
fd7255f5	208
7b8631b5	209	struct device dev; /* sysfs transport/container device */
7b8631b5 MC	210	};
	211
	212	#define iscsi_dev_to_conn(_dev) \
	213	container_of(_dev, struct iscsi_cls_conn, dev)
	214
3128c6c7 MC	215	#define transport_class_to_conn(_cdev) \
	216	iscsi_dev_to_conn(_cdev->parent)
	217
6eabafbe MC	218	#define iscsi_conn_to_session(_conn) \
	219	iscsi_dev_to_session(_conn->dev.parent)
	220
	221	/* iscsi class session state */
	222	enum {
	223	ISCSI_SESSION_LOGGED_IN,
	224	ISCSI_SESSION_FAILED,
	225	ISCSI_SESSION_FREE,
	226	};
7996a778	227
7970634b MC	228	#define ISCSI_MAX_TARGET -1
7970634b MC	229
7b8631b5	230	struct iscsi_cls_session {
7b7232f3	231	struct list_head sess_list; /* item in session_list */
7b8631b5	232	struct iscsi_transport *transport;
6eabafbe	233	spinlock_t lock;
45ab33b6 MC	234	struct work_struct block_work;
45ab33b6 MC	235	struct work_struct unblock_work;
bd976f62 MC	236	struct work_struct scan_work;
bd976f62 MC	237	struct work_struct unbind_work;
fd7255f5	238
30a6c652 MC	239	/* recovery fields */
30a6c652 MC	240	int recovery_tmo;
c4028958	241	struct delayed_work recovery_work;
30a6c652	242
7970634b	243	unsigned int target_id;
8d4a690c	244	bool ida_used;
30a6c652	245
0c70d84b MC	246	/*
	247	* pid of userspace process that created session or -1 if
	248	* created by the kernel.
	249	*/
	250	pid_t creator;
6eabafbe	251	int state;
b5c7a12d MC	252	int sid; /* session id */
b5c7a12d MC	253	void dd_data; / LLD private data */
7b8631b5 MC	254	struct device dev; /* sysfs transport/container device */
	255	};
	256
	257	#define iscsi_dev_to_session(_dev) \
	258	container_of(_dev, struct iscsi_cls_session, dev)
	259
1d063c17 MC	260	#define transport_class_to_session(_cdev) \
	261	iscsi_dev_to_session(_cdev->parent)
	262
7b8631b5 MC	263	#define iscsi_session_to_shost(_session) \
	264	dev_to_shost(_session->dev.parent)
	265
8434aa8b MC	266	#define starget_to_session(_stgt) \
	267	iscsi_dev_to_session(_stgt->dev.parent)
	268
32c6e1b9	269	struct iscsi_cls_host {
8aae18ad	270	atomic_t nr_scans;
30a6c652	271	struct mutex mutex;
90eeb01a	272	struct request_queue *bsg_q;
aeddde29 VC	273	uint32_t port_speed;
aeddde29 VC	274	uint32_t port_state;
30a6c652 MC	275	};
30a6c652 MC	276
90eeb01a MC	277	#define iscsi_job_to_shost(_job) \
	278	dev_to_shost(_job->dev)
	279
a4804cd6 MC	280	extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
	281	void (fn)(struct iscsi_cls_session ));
	282
d82ff9be MC	283	struct iscsi_endpoint {
	284	void dd_data; / LLD private data */
	285	struct device dev;
21536062	286	uint64_t id;
22a39fbb	287	struct iscsi_cls_conn *conn;
d82ff9be	288	};
a4804cd6	289
8d07913d MC	290	struct iscsi_iface {
	291	struct device dev;
	292	struct iscsi_transport *transport;
	293	uint32_t iface_type; /* IPv4 or IPv6 */
	294	uint32_t iface_num; /* iface number, 0 - n */
	295	void dd_data; / LLD private data */
	296	};
	297
	298	#define iscsi_dev_to_iface(_dev) \
	299	container_of(_dev, struct iscsi_iface, dev)
	300
	301	#define iscsi_iface_to_shost(_iface) \
	302	dev_to_shost(_iface->dev.parent)
	303
c6a4bb2e AC	304
	305	struct iscsi_bus_flash_conn {
	306	struct list_head conn_list; /* item in connlist */
	307	void dd_data; / LLD private data */
	308	struct iscsi_transport *transport;
	309	struct device dev; /* sysfs transport/container device */
	310	/* iscsi connection parameters */
	311	uint32_t exp_statsn;
	312	uint32_t statsn;
	313	unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
	314	unsigned max_xmit_dlength; /* target_max_recv_dsl */
	315	unsigned max_segment_size;
	316	unsigned tcp_xmit_wsf;
	317	unsigned tcp_recv_wsf;
	318	int hdrdgst_en;
	319	int datadgst_en;
	320	int port;
	321	char *ipaddress;
	322	char *link_local_ipv6_addr;
	323	char *redirect_ipaddr;
	324	uint16_t keepalive_timeout;
	325	uint16_t local_port;
	326	uint8_t snack_req_en;
	327	/* tcp timestamp negotiation status */
	328	uint8_t tcp_timestamp_stat;
	329	uint8_t tcp_nagle_disable;
	330	/* tcp window scale factor */
	331	uint8_t tcp_wsf_disable;
	332	uint8_t tcp_timer_scale;
	333	uint8_t tcp_timestamp_en;
	334	uint8_t ipv4_tos;
	335	uint8_t ipv6_traffic_class;
	336	uint8_t ipv6_flow_label;
	337	uint8_t fragment_disable;
	338	/* Link local IPv6 address is assigned by firmware or driver */
	339	uint8_t is_fw_assigned_ipv6;
	340	};
	341
	342	#define iscsi_dev_to_flash_conn(_dev) \
	343	container_of(_dev, struct iscsi_bus_flash_conn, dev)
	344
	345	#define iscsi_flash_conn_to_flash_session(_conn) \
	346	iscsi_dev_to_flash_session(_conn->dev.parent)
	347
	348	#define ISID_SIZE 6
	349
	350	struct iscsi_bus_flash_session {
	351	struct list_head sess_list; /* item in session_list */
	352	struct iscsi_transport *transport;
	353	unsigned int target_id;
	354	int flash_state; /* persistent or non-persistent */
	355	void dd_data; / LLD private data */
	356	struct device dev; /* sysfs transport/container device */
	357	/* iscsi session parameters */
	358	unsigned first_burst;
	359	unsigned max_burst;
	360	unsigned short max_r2t;
	361	int default_taskmgmt_timeout;
	362	int initial_r2t_en;
	363	int imm_data_en;
	364	int time2wait;
	365	int time2retain;
	366	int pdu_inorder_en;
	367	int dataseq_inorder_en;
368	int erl;
369	int tpgt;
370	char *username;
371	char *username_in;
372	char *password;
373	char *password_in;
374	char *targetname;
375	char *targetalias;
376	char *portal_type;
377	uint16_t tsid;
378	uint16_t chap_in_idx;
379	uint16_t chap_out_idx;
380	/* index of iSCSI discovery session if the entry is
381	* discovered by iSCSI discovery session
382	*/
383	uint16_t discovery_parent_idx;
384	/* indicates if discovery was done through iSNS discovery service
385	* or through sendTarget */
386	uint16_t discovery_parent_type;
387	/* Firmware auto sendtarget discovery disable */
388	uint8_t auto_snd_tgt_disable;
389	uint8_t discovery_sess;
390	/* indicates if this flashnode entry is enabled or disabled */
391	uint8_t entry_state;
392	uint8_t chap_auth_en;
393	/* enables firmware to auto logout the discovery session on discovery
394	* completion
395	*/
396	uint8_t discovery_logout_en;
397	uint8_t bidi_chap_en;
398	/* makes authentication for discovery session optional */
399	uint8_t discovery_auth_optional;
400	uint8_t isid[ISID_SIZE];
401	uint8_t is_boot_target;
402	};
403
404	#define iscsi_dev_to_flash_session(_dev) \
405	container_of(_dev, struct iscsi_bus_flash_session, dev)
406
407	#define iscsi_flash_session_to_shost(_session) \
408	dev_to_shost(_session->dev.parent)
409
7b8631b5 MC	410	/*
	411	* session and connection functions that can be used by HW iSCSI LLDs
	412	*/
322d739d MC	413	#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
	414	dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
	415
	416	#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
	417	dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
	418
6eabafbe	419	extern int iscsi_session_chkready(struct iscsi_cls_session *session);
17fa575e	420	extern int iscsi_is_session_online(struct iscsi_cls_session *session);
8434aa8b	421	extern struct iscsi_cls_session iscsi_alloc_session(struct Scsi_Host shost,
5d91e209	422	struct iscsi_transport *transport, int dd_size);
6a8a0d36 MC	423	extern int iscsi_add_session(struct iscsi_cls_session *session,
6a8a0d36 MC	424	unsigned int target_id);
26974789 MC	425	extern int iscsi_session_event(struct iscsi_cls_session *session,
26974789 MC	426	enum iscsi_uevent_e event);
7b8631b5	427	extern struct iscsi_cls_session iscsi_create_session(struct Scsi_Host shost,
6a8a0d36	428	struct iscsi_transport *t,
5d91e209	429	int dd_size,
6a8a0d36	430	unsigned int target_id);
8434aa8b MC	431	extern void iscsi_remove_session(struct iscsi_cls_session *session);
8434aa8b MC	432	extern void iscsi_free_session(struct iscsi_cls_session *session);
7b8631b5 MC	433	extern int iscsi_destroy_session(struct iscsi_cls_session *session);
7b8631b5 MC	434	extern struct iscsi_cls_conn iscsi_create_conn(struct iscsi_cls_session sess,
5d91e209	435	int dd_size, uint32_t cid);
7b8631b5	436	extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
30a6c652 MC	437	extern void iscsi_unblock_session(struct iscsi_cls_session *session);
30a6c652 MC	438	extern void iscsi_block_session(struct iscsi_cls_session *session);
8aae18ad	439	extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
d82ff9be MC	440	extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
	441	extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
	442	extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
c01be6dc	443	extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
8d07913d MC	444	extern struct iscsi_iface iscsi_create_iface(struct Scsi_Host shost,
	445	struct iscsi_transport *t,
	446	uint32_t iface_type,
	447	uint32_t iface_num, int dd_size);
	448	extern void iscsi_destroy_iface(struct iscsi_iface *iface);
	449	extern struct iscsi_iface *iscsi_lookup_iface(int handle);
aeddde29 VC	450	extern char iscsi_get_port_speed_name(struct Scsi_Host shost);
aeddde29 VC	451	extern char iscsi_get_port_state_name(struct Scsi_Host shost);
6260a5d2	452	extern int iscsi_is_session_dev(const struct device *dev);
53cb8a1f	453
c6a4bb2e AC	454	extern char *iscsi_get_discovery_parent_name(int parent_type);
	455	extern struct device *
	456	iscsi_find_flashnode(struct Scsi_Host shost, void data,
	457	int (fn)(struct device dev, void *data));
	458
	459	extern struct iscsi_bus_flash_session *
	460	iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index,
	461	struct iscsi_transport *transport, int dd_size);
	462
	463	extern struct iscsi_bus_flash_conn *
	464	iscsi_create_flashnode_conn(struct Scsi_Host *shost,
	465	struct iscsi_bus_flash_session *fnode_sess,
	466	struct iscsi_transport *transport, int dd_size);
	467
	468	extern void
	469	iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess);
	470
	471	extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost);
	472	extern int iscsi_flashnode_bus_match(struct device *dev,
	473	struct device_driver *drv);
c6a4bb2e AC	474	extern struct device *
	475	iscsi_find_flashnode_sess(struct Scsi_Host shost, void data,
	476	int (fn)(struct device dev, void *data));
c6a4bb2e	477	extern struct device *
8526cb11 MC	478	iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess);
8526cb11 MC	479
1da177e4	480	#endif