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