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 |
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> |
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; |
7b8631b5 | 33 | struct Scsi_Host; |
7b8631b5 | 34 | struct iscsi_cls_conn; |
7996a778 MC |
35 | struct iscsi_conn; |
36 | struct iscsi_cmd_task; | |
37 | struct iscsi_mgmt_task; | |
a54a52ca | 38 | struct sockaddr; |
7b8631b5 | 39 | |
39e84790 AA |
40 | /** |
41 | * struct iscsi_transport - iSCSI Transport template | |
42 | * | |
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 | |
a54a52ca MC |
51 | * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA |
52 | * when param is not supported, and a -Exx value on other | |
53 | * error. | |
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 | |
39e84790 AA |
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. | |
7996a778 | 60 | * @session_recovery_timedout: notify LLD a block during recovery timed out |
7996a778 MC |
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. | |
3219e529 MC |
65 | * @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the |
66 | * the number of bytes transferred on success, and -Exyz | |
67 | * value on error. | |
68 | * @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the | |
69 | * the number of bytes transferred on success, and -Exyz | |
70 | * value on error. | |
7996a778 MC |
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 | |
39e84790 AA |
76 | * |
77 | * Template API provided by iSCSI Transport | |
78 | */ | |
79 | struct iscsi_transport { | |
80 | struct module *owner; | |
81 | char *name; | |
82 | unsigned int caps; | |
fd7255f5 | 83 | /* LLD sets this to indicate what values it can export to sysfs */ |
1819dc81 MC |
84 | uint64_t param_mask; |
85 | uint64_t host_param_mask; | |
39e84790 | 86 | struct scsi_host_template *host_template; |
7b8631b5 MC |
87 | /* LLD connection data size */ |
88 | int conndata_size; | |
b5c7a12d MC |
89 | /* LLD session data size */ |
90 | int sessiondata_size; | |
39e84790 | 91 | int max_lun; |
7996a778 | 92 | struct iscsi_cls_session *(*create_session) (struct iscsi_transport *it, |
40753caa MC |
93 | struct scsi_transport_template *t, struct Scsi_Host *shost, |
94 | uint16_t cmds_max, uint16_t qdepth, uint32_t sn, uint32_t *hn); | |
7b7232f3 MC |
95 | void (*destroy_session) (struct iscsi_cls_session *session); |
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, |
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); |
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); |
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, |
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, |
118 | struct iscsi_stats *stats); | |
a8ac6311 | 119 | int (*init_cmd_task) (struct iscsi_cmd_task *ctask); |
7996a778 | 120 | void (*init_mgmt_task) (struct iscsi_conn *conn, |
77a23c21 | 121 | struct iscsi_mgmt_task *mtask); |
7996a778 MC |
122 | int (*xmit_cmd_task) (struct iscsi_conn *conn, |
123 | struct iscsi_cmd_task *ctask); | |
124 | void (*cleanup_cmd_task) (struct iscsi_conn *conn, | |
125 | struct iscsi_cmd_task *ctask); | |
126 | int (*xmit_mgmt_task) (struct iscsi_conn *conn, | |
127 | struct iscsi_mgmt_task *mtask); | |
30a6c652 | 128 | void (*session_recovery_timedout) (struct iscsi_cls_session *session); |
264faaaa OG |
129 | int (*ep_connect) (struct sockaddr *dst_addr, int non_blocking, |
130 | uint64_t *ep_handle); | |
131 | int (*ep_poll) (uint64_t ep_handle, int timeout_ms); | |
132 | void (*ep_disconnect) (uint64_t ep_handle); | |
2174a04e | 133 | int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type, |
01cb225d | 134 | uint32_t enable, struct sockaddr *dst_addr); |
1da177e4 LT |
135 | }; |
136 | ||
137 | /* | |
39e84790 | 138 | * transport registration upcalls |
1da177e4 | 139 | */ |
7b8631b5 | 140 | extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt); |
39e84790 | 141 | extern int iscsi_unregister_transport(struct iscsi_transport *tt); |
1da177e4 LT |
142 | |
143 | /* | |
39e84790 | 144 | * control plane upcalls |
1da177e4 | 145 | */ |
7b7232f3 MC |
146 | extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error); |
147 | extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, | |
39e84790 | 148 | char *data, uint32_t data_size); |
1da177e4 | 149 | |
7b8631b5 MC |
150 | struct iscsi_cls_conn { |
151 | struct list_head conn_list; /* item in connlist */ | |
152 | void *dd_data; /* LLD private data */ | |
153 | struct iscsi_transport *transport; | |
b5c7a12d | 154 | uint32_t cid; /* connection id */ |
fd7255f5 | 155 | |
7b8631b5 MC |
156 | int active; /* must be accessed with the connlock */ |
157 | struct device dev; /* sysfs transport/container device */ | |
7b8631b5 MC |
158 | }; |
159 | ||
160 | #define iscsi_dev_to_conn(_dev) \ | |
161 | container_of(_dev, struct iscsi_cls_conn, dev) | |
162 | ||
6eabafbe MC |
163 | #define iscsi_conn_to_session(_conn) \ |
164 | iscsi_dev_to_session(_conn->dev.parent) | |
165 | ||
166 | /* iscsi class session state */ | |
167 | enum { | |
168 | ISCSI_SESSION_LOGGED_IN, | |
169 | ISCSI_SESSION_FAILED, | |
170 | ISCSI_SESSION_FREE, | |
171 | }; | |
7996a778 | 172 | |
7b8631b5 | 173 | struct iscsi_cls_session { |
7b7232f3 | 174 | struct list_head sess_list; /* item in session_list */ |
30a6c652 | 175 | struct list_head host_list; |
7b8631b5 | 176 | struct iscsi_transport *transport; |
6eabafbe | 177 | spinlock_t lock; |
45ab33b6 MC |
178 | struct work_struct block_work; |
179 | struct work_struct unblock_work; | |
bd976f62 MC |
180 | struct work_struct scan_work; |
181 | struct work_struct unbind_work; | |
fd7255f5 | 182 | |
30a6c652 MC |
183 | /* recovery fields */ |
184 | int recovery_tmo; | |
c4028958 | 185 | struct delayed_work recovery_work; |
30a6c652 MC |
186 | |
187 | int target_id; | |
30a6c652 | 188 | |
6eabafbe | 189 | int state; |
b5c7a12d MC |
190 | int sid; /* session id */ |
191 | void *dd_data; /* LLD private data */ | |
7b8631b5 MC |
192 | struct device dev; /* sysfs transport/container device */ |
193 | }; | |
194 | ||
195 | #define iscsi_dev_to_session(_dev) \ | |
196 | container_of(_dev, struct iscsi_cls_session, dev) | |
197 | ||
198 | #define iscsi_session_to_shost(_session) \ | |
199 | dev_to_shost(_session->dev.parent) | |
200 | ||
8434aa8b MC |
201 | #define starget_to_session(_stgt) \ |
202 | iscsi_dev_to_session(_stgt->dev.parent) | |
203 | ||
30a6c652 | 204 | struct iscsi_host { |
30a6c652 | 205 | struct list_head sessions; |
8aae18ad | 206 | atomic_t nr_scans; |
30a6c652 | 207 | struct mutex mutex; |
bd976f62 MC |
208 | struct workqueue_struct *scan_workq; |
209 | char scan_workq_name[KOBJ_NAME_LEN]; | |
30a6c652 MC |
210 | }; |
211 | ||
7b8631b5 MC |
212 | /* |
213 | * session and connection functions that can be used by HW iSCSI LLDs | |
214 | */ | |
322d739d MC |
215 | #define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \ |
216 | dev_printk(prefix, &(_cls_session)->dev, fmt, ##a) | |
217 | ||
218 | #define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \ | |
219 | dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a) | |
220 | ||
6eabafbe | 221 | extern int iscsi_session_chkready(struct iscsi_cls_session *session); |
8434aa8b MC |
222 | extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost, |
223 | struct iscsi_transport *transport); | |
6a8a0d36 MC |
224 | extern int iscsi_add_session(struct iscsi_cls_session *session, |
225 | unsigned int target_id); | |
26974789 MC |
226 | extern int iscsi_session_event(struct iscsi_cls_session *session, |
227 | enum iscsi_uevent_e event); | |
7b8631b5 | 228 | extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost, |
6a8a0d36 MC |
229 | struct iscsi_transport *t, |
230 | unsigned int target_id); | |
8434aa8b MC |
231 | extern void iscsi_remove_session(struct iscsi_cls_session *session); |
232 | extern void iscsi_free_session(struct iscsi_cls_session *session); | |
7b8631b5 MC |
233 | extern int iscsi_destroy_session(struct iscsi_cls_session *session); |
234 | extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess, | |
235 | uint32_t cid); | |
236 | extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn); | |
30a6c652 MC |
237 | extern void iscsi_unblock_session(struct iscsi_cls_session *session); |
238 | extern void iscsi_block_session(struct iscsi_cls_session *session); | |
8aae18ad | 239 | extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time); |
53cb8a1f | 240 | |
1da177e4 | 241 | #endif |