2 * iSCSI transport class definitions
4 * Copyright (C) IBM Corporation, 2004
5 * Copyright (C) Mike Christie, 2004 - 2006
6 * Copyright (C) Dmitry Yusupov, 2004 - 2005
7 * Copyright (C) Alex Aizman, 2004 - 2005
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.
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.
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.
23 #ifndef SCSI_TRANSPORT_ISCSI_H
24 #define SCSI_TRANSPORT_ISCSI_H
26 #include <linux/device.h>
27 #include <linux/list.h>
28 #include <linux/mutex.h>
29 #include <scsi/iscsi_if.h>
31 struct scsi_transport_template;
32 struct iscsi_transport;
34 struct iscsi_cls_conn;
36 struct iscsi_cmd_task;
37 struct iscsi_mgmt_task;
41 * struct iscsi_transport - iSCSI Transport template
43 * @name: transport name
44 * @caps: iSCSI Data-Path capabilities
45 * @create_session: create new iSCSI session object
46 * @destroy_session: destroy existing iSCSI session object
47 * @create_conn: create new iSCSI connection
48 * @bind_conn: associate this connection with existing iSCSI session
49 * and specified transport descriptor
50 * @destroy_conn: destroy inactive iSCSI connection
51 * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
52 * when param is not supported, and a -Exx value on other
54 * @get_param get iSCSI parameter. Must return number of bytes
55 * copied to buffer on success, -ENODATA when param
56 * is not supported, and a -Exx value on other error
57 * @start_conn: set connection to be operational
58 * @stop_conn: suspend/recover/terminate connection
59 * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
60 * @session_recovery_timedout: notify LLD a block during recovery timed out
61 * @init_cmd_task: Initialize a iscsi_cmd_task and any internal structs.
62 * Called from queuecommand with session lock held.
63 * @init_mgmt_task: Initialize a iscsi_mgmt_task and any internal structs.
64 * Called from iscsi_conn_send_generic with xmitmutex.
65 * @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the
66 * the number of bytes transferred on success, and -Exyz
68 * @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the
69 * the number of bytes transferred on success, and -Exyz
71 * @cleanup_cmd_task: requests LLD to fail cmd task. Called with xmitmutex
72 * and session->lock after the connection has been
73 * suspended and terminated during recovery. If called
74 * from abort task then connection is not suspended
75 * or terminated but sk_callback_lock is held
77 * Template API provided by iSCSI Transport
79 struct iscsi_transport {
83 /* LLD sets this to indicate what values it can export to sysfs */
85 uint64_t host_param_mask;
86 struct iscsi_cls_session *(*create_session) (struct Scsi_Host *shost,
87 uint16_t cmds_max, uint16_t qdepth,
88 uint32_t sn, uint32_t *hn);
89 void (*destroy_session) (struct iscsi_cls_session *session);
90 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
92 int (*bind_conn) (struct iscsi_cls_session *session,
93 struct iscsi_cls_conn *cls_conn,
94 uint64_t transport_eph, int is_leading);
95 int (*start_conn) (struct iscsi_cls_conn *conn);
96 void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
97 void (*destroy_conn) (struct iscsi_cls_conn *conn);
98 int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
99 char *buf, int buflen);
100 int (*get_conn_param) (struct iscsi_cls_conn *conn,
101 enum iscsi_param param, char *buf);
102 int (*get_session_param) (struct iscsi_cls_session *session,
103 enum iscsi_param param, char *buf);
104 int (*get_host_param) (struct Scsi_Host *shost,
105 enum iscsi_host_param param, char *buf);
106 int (*set_host_param) (struct Scsi_Host *shost,
107 enum iscsi_host_param param, char *buf,
109 int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
110 char *data, uint32_t data_size);
111 void (*get_stats) (struct iscsi_cls_conn *conn,
112 struct iscsi_stats *stats);
113 int (*init_cmd_task) (struct iscsi_cmd_task *ctask);
114 void (*init_mgmt_task) (struct iscsi_conn *conn,
115 struct iscsi_mgmt_task *mtask);
116 int (*xmit_cmd_task) (struct iscsi_conn *conn,
117 struct iscsi_cmd_task *ctask);
118 void (*cleanup_cmd_task) (struct iscsi_conn *conn,
119 struct iscsi_cmd_task *ctask);
120 int (*xmit_mgmt_task) (struct iscsi_conn *conn,
121 struct iscsi_mgmt_task *mtask);
122 void (*session_recovery_timedout) (struct iscsi_cls_session *session);
123 int (*ep_connect) (struct sockaddr *dst_addr, int non_blocking,
124 uint64_t *ep_handle);
125 int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
126 void (*ep_disconnect) (uint64_t ep_handle);
127 int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
128 uint32_t enable, struct sockaddr *dst_addr);
132 * transport registration upcalls
134 extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
135 extern int iscsi_unregister_transport(struct iscsi_transport *tt);
138 * control plane upcalls
140 extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
141 extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
142 char *data, uint32_t data_size);
144 struct iscsi_cls_conn {
145 struct list_head conn_list; /* item in connlist */
146 void *dd_data; /* LLD private data */
147 struct iscsi_transport *transport;
148 uint32_t cid; /* connection id */
150 int active; /* must be accessed with the connlock */
151 struct device dev; /* sysfs transport/container device */
154 #define iscsi_dev_to_conn(_dev) \
155 container_of(_dev, struct iscsi_cls_conn, dev)
157 #define iscsi_conn_to_session(_conn) \
158 iscsi_dev_to_session(_conn->dev.parent)
160 /* iscsi class session state */
162 ISCSI_SESSION_LOGGED_IN,
163 ISCSI_SESSION_FAILED,
167 struct iscsi_cls_session {
168 struct list_head sess_list; /* item in session_list */
169 struct list_head host_list;
170 struct iscsi_transport *transport;
172 struct work_struct block_work;
173 struct work_struct unblock_work;
174 struct work_struct scan_work;
175 struct work_struct unbind_work;
177 /* recovery fields */
179 struct delayed_work recovery_work;
184 int sid; /* session id */
185 void *dd_data; /* LLD private data */
186 struct device dev; /* sysfs transport/container device */
189 #define iscsi_dev_to_session(_dev) \
190 container_of(_dev, struct iscsi_cls_session, dev)
192 #define iscsi_session_to_shost(_session) \
193 dev_to_shost(_session->dev.parent)
195 #define starget_to_session(_stgt) \
196 iscsi_dev_to_session(_stgt->dev.parent)
198 struct iscsi_cls_host {
199 struct list_head sessions;
202 struct workqueue_struct *scan_workq;
203 char scan_workq_name[KOBJ_NAME_LEN];
206 extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
207 void (*fn)(struct iscsi_cls_session *));
211 * session and connection functions that can be used by HW iSCSI LLDs
213 #define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
214 dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
216 #define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
217 dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
219 extern int iscsi_session_chkready(struct iscsi_cls_session *session);
220 extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
221 struct iscsi_transport *transport, int dd_size);
222 extern int iscsi_add_session(struct iscsi_cls_session *session,
223 unsigned int target_id);
224 extern int iscsi_session_event(struct iscsi_cls_session *session,
225 enum iscsi_uevent_e event);
226 extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
227 struct iscsi_transport *t,
229 unsigned int target_id);
230 extern void iscsi_remove_session(struct iscsi_cls_session *session);
231 extern void iscsi_free_session(struct iscsi_cls_session *session);
232 extern int iscsi_destroy_session(struct iscsi_cls_session *session);
233 extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
234 int dd_size, uint32_t cid);
235 extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
236 extern void iscsi_unblock_session(struct iscsi_cls_session *session);
237 extern void iscsi_block_session(struct iscsi_cls_session *session);
238 extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);