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 <scsi/iscsi_if.h>
29 struct scsi_transport_template
;
30 struct iscsi_transport
;
32 struct iscsi_cls_conn
;
34 struct iscsi_cmd_task
;
35 struct iscsi_mgmt_task
;
39 * struct iscsi_transport - iSCSI Transport template
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
49 * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
50 * when param is not supported, and a -Exx value on other
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
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.
58 * @session_recovery_timedout: notify LLD a block during recovery timed out
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.
63 * @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the
64 * the number of bytes transferred on success, and -Exyz
66 * @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the
67 * the number of bytes transferred on success, and -Exyz
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
75 * Template API provided by iSCSI Transport
77 struct iscsi_transport
{
81 /* LLD sets this to indicate what values it can export to sysfs */
83 uint64_t host_param_mask
;
84 struct scsi_host_template
*host_template
;
85 /* LLD connection data size */
87 /* LLD session data size */
90 unsigned int max_conn
;
91 unsigned int max_cmd_len
;
92 struct iscsi_cls_session
*(*create_session
) (struct iscsi_transport
*it
,
93 struct scsi_transport_template
*t
, uint32_t sn
, uint32_t *hn
);
94 void (*destroy_session
) (struct iscsi_cls_session
*session
);
95 struct iscsi_cls_conn
*(*create_conn
) (struct iscsi_cls_session
*sess
,
97 int (*bind_conn
) (struct iscsi_cls_session
*session
,
98 struct iscsi_cls_conn
*cls_conn
,
99 uint64_t transport_eph
, int is_leading
);
100 int (*start_conn
) (struct iscsi_cls_conn
*conn
);
101 void (*stop_conn
) (struct iscsi_cls_conn
*conn
, int flag
);
102 void (*destroy_conn
) (struct iscsi_cls_conn
*conn
);
103 int (*set_param
) (struct iscsi_cls_conn
*conn
, enum iscsi_param param
,
104 char *buf
, int buflen
);
105 int (*get_conn_param
) (struct iscsi_cls_conn
*conn
,
106 enum iscsi_param param
, char *buf
);
107 int (*get_session_param
) (struct iscsi_cls_session
*session
,
108 enum iscsi_param param
, char *buf
);
109 int (*get_host_param
) (struct Scsi_Host
*shost
,
110 enum iscsi_host_param param
, char *buf
);
111 int (*send_pdu
) (struct iscsi_cls_conn
*conn
, struct iscsi_hdr
*hdr
,
112 char *data
, uint32_t data_size
);
113 void (*get_stats
) (struct iscsi_cls_conn
*conn
,
114 struct iscsi_stats
*stats
);
115 void (*init_cmd_task
) (struct iscsi_cmd_task
*ctask
);
116 void (*init_mgmt_task
) (struct iscsi_conn
*conn
,
117 struct iscsi_mgmt_task
*mtask
,
118 char *data
, uint32_t data_size
);
119 int (*xmit_cmd_task
) (struct iscsi_conn
*conn
,
120 struct iscsi_cmd_task
*ctask
);
121 void (*cleanup_cmd_task
) (struct iscsi_conn
*conn
,
122 struct iscsi_cmd_task
*ctask
);
123 int (*xmit_mgmt_task
) (struct iscsi_conn
*conn
,
124 struct iscsi_mgmt_task
*mtask
);
125 void (*session_recovery_timedout
) (struct iscsi_cls_session
*session
);
126 int (*ep_connect
) (struct sockaddr
*dst_addr
, int non_blocking
,
127 uint64_t *ep_handle
);
128 int (*ep_poll
) (uint64_t ep_handle
, int timeout_ms
);
129 void (*ep_disconnect
) (uint64_t ep_handle
);
130 int (*tgt_dscvr
) (struct Scsi_Host
*shost
, enum iscsi_tgt_dscvr type
,
131 uint32_t enable
, struct sockaddr
*dst_addr
);
135 * transport registration upcalls
137 extern struct scsi_transport_template
*iscsi_register_transport(struct iscsi_transport
*tt
);
138 extern int iscsi_unregister_transport(struct iscsi_transport
*tt
);
141 * control plane upcalls
143 extern void iscsi_conn_error(struct iscsi_cls_conn
*conn
, enum iscsi_err error
);
144 extern int iscsi_recv_pdu(struct iscsi_cls_conn
*conn
, struct iscsi_hdr
*hdr
,
145 char *data
, uint32_t data_size
);
148 /* Connection's states */
149 #define ISCSI_CONN_INITIAL_STAGE 0
150 #define ISCSI_CONN_STARTED 1
151 #define ISCSI_CONN_STOPPED 2
152 #define ISCSI_CONN_CLEANUP_WAIT 3
154 struct iscsi_cls_conn
{
155 struct list_head conn_list
; /* item in connlist */
156 void *dd_data
; /* LLD private data */
157 struct iscsi_transport
*transport
;
158 uint32_t cid
; /* connection id */
160 int active
; /* must be accessed with the connlock */
161 struct device dev
; /* sysfs transport/container device */
164 #define iscsi_dev_to_conn(_dev) \
165 container_of(_dev, struct iscsi_cls_conn, dev)
167 /* Session's states */
168 #define ISCSI_STATE_FREE 1
169 #define ISCSI_STATE_LOGGED_IN 2
170 #define ISCSI_STATE_FAILED 3
171 #define ISCSI_STATE_TERMINATE 4
172 #define ISCSI_STATE_IN_RECOVERY 5
173 #define ISCSI_STATE_RECOVERY_FAILED 6
175 struct iscsi_cls_session
{
176 struct list_head sess_list
; /* item in session_list */
177 struct list_head host_list
;
178 struct iscsi_transport
*transport
;
180 /* recovery fields */
182 struct delayed_work recovery_work
;
186 int sid
; /* session id */
187 void *dd_data
; /* LLD private data */
188 struct device dev
; /* sysfs transport/container device */
191 #define iscsi_dev_to_session(_dev) \
192 container_of(_dev, struct iscsi_cls_session, dev)
194 #define iscsi_session_to_shost(_session) \
195 dev_to_shost(_session->dev.parent)
197 #define starget_to_session(_stgt) \
198 iscsi_dev_to_session(_stgt->dev.parent)
201 struct list_head sessions
;
206 * session and connection functions that can be used by HW iSCSI LLDs
208 extern struct iscsi_cls_session
*iscsi_alloc_session(struct Scsi_Host
*shost
,
209 struct iscsi_transport
*transport
);
210 extern int iscsi_add_session(struct iscsi_cls_session
*session
,
211 unsigned int target_id
);
212 extern int iscsi_if_create_session_done(struct iscsi_cls_conn
*conn
);
213 extern int iscsi_if_destroy_session_done(struct iscsi_cls_conn
*conn
);
214 extern struct iscsi_cls_session
*iscsi_create_session(struct Scsi_Host
*shost
,
215 struct iscsi_transport
*t
,
216 unsigned int target_id
);
217 extern void iscsi_remove_session(struct iscsi_cls_session
*session
);
218 extern void iscsi_free_session(struct iscsi_cls_session
*session
);
219 extern int iscsi_destroy_session(struct iscsi_cls_session
*session
);
220 extern struct iscsi_cls_conn
*iscsi_create_conn(struct iscsi_cls_session
*sess
,
222 extern int iscsi_destroy_conn(struct iscsi_cls_conn
*conn
);
223 extern void iscsi_unblock_session(struct iscsi_cls_session
*session
);
224 extern void iscsi_block_session(struct iscsi_cls_session
*session
);