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