blob: 2555ee5343fd0a45dbec75f5d6305963b35eabdb [file] [log] [blame]
Alex Aizman39e84792005-08-04 19:31:00 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * iSCSI transport class definitions
3 *
4 * Copyright (C) IBM Corporation, 2004
Mike Christie7996a772006-04-06 21:13:41 -05005 * Copyright (C) Mike Christie, 2004 - 2006
Alex Aizman39e84792005-08-04 19:31:00 -07006 * Copyright (C) Dmitry Yusupov, 2004 - 2005
7 * Copyright (C) Alex Aizman, 2004 - 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
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
Mike Christie7b8631b2006-01-13 18:05:50 -060026#include <linux/device.h>
Michael S. Tsirkind773c082007-10-02 14:38:05 -070027#include <linux/list.h>
28#include <linux/mutex.h>
Alex Aizman39e84792005-08-04 19:31:00 -070029#include <scsi/iscsi_if.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Mike Christie7b8631b2006-01-13 18:05:50 -060031struct scsi_transport_template;
Mike Christie7996a772006-04-06 21:13:41 -050032struct iscsi_transport;
Mike Christied82ff9be2008-05-21 15:54:13 -050033struct iscsi_endpoint;
Mike Christie7b8631b2006-01-13 18:05:50 -060034struct Scsi_Host;
Mike Christiec01be6d2010-07-22 16:59:49 +053035struct scsi_cmnd;
Mike Christie7b8631b2006-01-13 18:05:50 -060036struct iscsi_cls_conn;
Mike Christie7996a772006-04-06 21:13:41 -050037struct iscsi_conn;
Mike Christie9c19a7d2008-05-21 15:54:09 -050038struct iscsi_task;
Mike Christiea54a52c2006-06-28 12:00:23 -050039struct sockaddr;
Mike Christie8d079132011-07-25 13:48:40 -050040struct iscsi_iface;
Mike Christie90eeb012011-07-25 13:48:50 -050041struct bsg_job;
Adheer Chandravanshic6a4bb22013-03-22 07:41:29 -040042struct iscsi_bus_flash_session;
43struct iscsi_bus_flash_conn;
Mike Christie7b8631b2006-01-13 18:05:50 -060044
Alex Aizman39e84792005-08-04 19:31:00 -070045/**
46 * struct iscsi_transport - iSCSI Transport template
47 *
48 * @name: transport name
49 * @caps: iSCSI Data-Path capabilities
50 * @create_session: create new iSCSI session object
51 * @destroy_session: destroy existing iSCSI session object
52 * @create_conn: create new iSCSI connection
53 * @bind_conn: associate this connection with existing iSCSI session
54 * and specified transport descriptor
55 * @destroy_conn: destroy inactive iSCSI connection
Mike Christiea54a52c2006-06-28 12:00:23 -050056 * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
57 * when param is not supported, and a -Exx value on other
58 * error.
59 * @get_param get iSCSI parameter. Must return number of bytes
60 * copied to buffer on success, -ENODATA when param
61 * is not supported, and a -Exx value on other error
Alex Aizman39e84792005-08-04 19:31:00 -070062 * @start_conn: set connection to be operational
63 * @stop_conn: suspend/recover/terminate connection
64 * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
Mike Christie7996a772006-04-06 21:13:41 -050065 * @session_recovery_timedout: notify LLD a block during recovery timed out
Mike Christie3e5c28a2008-05-21 15:54:06 -050066 * @init_task: Initialize a iscsi_task and any internal structs.
67 * When offloading the data path, this is called from
68 * queuecommand with the session lock, or from the
69 * iscsi_conn_send_pdu context with the session lock.
70 * When not offloading the data path, this is called
71 * from the scsi work queue without the session lock.
72 * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
Mike Christie3219e522006-05-30 00:37:28 -050073 * the number of bytes transferred on success, and -Exyz
Mike Christie3e5c28a2008-05-21 15:54:06 -050074 * value on error. When offloading the data path, this
75 * is called from queuecommand with the session lock, or
76 * from the iscsi_conn_send_pdu context with the session
77 * lock. When not offloading the data path, this is called
78 * from the scsi work queue without the session lock.
79 * @cleanup_task: requests LLD to fail task. Called with session lock
80 * and after the connection has been suspended and
81 * terminated during recovery. If called
Mike Christie7996a772006-04-06 21:13:41 -050082 * from abort task then connection is not suspended
83 * or terminated but sk_callback_lock is held
Alex Aizman39e84792005-08-04 19:31:00 -070084 *
85 * Template API provided by iSCSI Transport
86 */
87struct iscsi_transport {
88 struct module *owner;
89 char *name;
90 unsigned int caps;
Mike Christie8d079132011-07-25 13:48:40 -050091
Mike Christied82ff9be2008-05-21 15:54:13 -050092 struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
Mike Christie75613522008-05-21 15:53:59 -050093 uint16_t cmds_max, uint16_t qdepth,
Mike Christie5e7facb2009-03-05 14:46:06 -060094 uint32_t sn);
Mike Christie7b7232f2006-02-01 21:06:49 -060095 void (*destroy_session) (struct iscsi_cls_session *session);
96 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
Mike Christie7b8631b2006-01-13 18:05:50 -060097 uint32_t cid);
Mike Christie7b7232f2006-02-01 21:06:49 -060098 int (*bind_conn) (struct iscsi_cls_session *session,
99 struct iscsi_cls_conn *cls_conn,
Or Gerlitz264faaa2006-05-02 19:46:36 -0500100 uint64_t transport_eph, int is_leading);
Mike Christie7b7232f2006-02-01 21:06:49 -0600101 int (*start_conn) (struct iscsi_cls_conn *conn);
102 void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
Mike Christie7b8631b2006-01-13 18:05:50 -0600103 void (*destroy_conn) (struct iscsi_cls_conn *conn);
Mike Christie7b7232f2006-02-01 21:06:49 -0600104 int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
Mike Christiea54a52c2006-06-28 12:00:23 -0500105 char *buf, int buflen);
Mike Christie289324b2011-02-16 15:04:37 -0600106 int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
107 char *buf);
Mike Christie7b7232f2006-02-01 21:06:49 -0600108 int (*get_conn_param) (struct iscsi_cls_conn *conn,
Mike Christiea54a52c2006-06-28 12:00:23 -0500109 enum iscsi_param param, char *buf);
Mike Christie7b7232f2006-02-01 21:06:49 -0600110 int (*get_session_param) (struct iscsi_cls_session *session,
Mike Christiea54a52c2006-06-28 12:00:23 -0500111 enum iscsi_param param, char *buf);
Mike Christie1819dc82007-05-30 12:57:08 -0500112 int (*get_host_param) (struct Scsi_Host *shost,
113 enum iscsi_host_param param, char *buf);
Mike Christie1d9bf132007-05-30 12:57:11 -0500114 int (*set_host_param) (struct Scsi_Host *shost,
115 enum iscsi_host_param param, char *buf,
116 int buflen);
Mike Christie7b7232f2006-02-01 21:06:49 -0600117 int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
Alex Aizman39e84792005-08-04 19:31:00 -0700118 char *data, uint32_t data_size);
Mike Christie7b7232f2006-02-01 21:06:49 -0600119 void (*get_stats) (struct iscsi_cls_conn *conn,
120 struct iscsi_stats *stats);
Mike Christie577577d2008-12-02 00:32:05 -0600121
Mike Christie9c19a7d2008-05-21 15:54:09 -0500122 int (*init_task) (struct iscsi_task *task);
123 int (*xmit_task) (struct iscsi_task *task);
Mike Christie577577d2008-12-02 00:32:05 -0600124 void (*cleanup_task) (struct iscsi_task *task);
125
Mike Christie2ff79d52008-12-02 00:32:14 -0600126 int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
Mike Christie577577d2008-12-02 00:32:05 -0600127 int (*xmit_pdu) (struct iscsi_task *task);
128 int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
129 unsigned int count);
Mike Christie262ef632008-12-02 00:32:13 -0600130 void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
131 int *index, int *age);
132
Mike Christie30a6c652006-04-06 21:13:39 -0500133 void (*session_recovery_timedout) (struct iscsi_cls_session *session);
Mike Christie10eb0f02009-05-13 17:57:38 -0500134 struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
135 struct sockaddr *dst_addr,
Mike Christied82ff9be2008-05-21 15:54:13 -0500136 int non_blocking);
137 int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
138 void (*ep_disconnect) (struct iscsi_endpoint *ep);
Mike Christie2174a042007-05-30 12:57:10 -0500139 int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
Mike Christie01cb2252006-06-28 12:00:22 -0500140 uint32_t enable, struct sockaddr *dst_addr);
Michael Chan43514772009-06-08 18:14:41 -0700141 int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
Mike Christie00c31882011-10-06 03:56:59 -0500142 int (*set_iface_param) (struct Scsi_Host *shost, void *data,
143 uint32_t len);
Mike Christie8d079132011-07-25 13:48:40 -0500144 int (*get_iface_param) (struct iscsi_iface *iface,
145 enum iscsi_param_type param_type,
146 int param, char *buf);
Al Viro587a1f12011-07-23 23:11:19 -0400147 umode_t (*attr_is_visible)(int param_type, int param);
Mike Christie90eeb012011-07-25 13:48:50 -0500148 int (*bsg_request)(struct bsg_job *job);
Vikas Chaudharyac20c7b2012-02-13 18:30:48 +0530149 int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num,
150 uint32_t iface_type, uint32_t payload_size,
151 uint32_t pid, struct sockaddr *dst_addr);
Nilesh Javali6260a5d2012-02-27 03:08:51 -0800152 int (*get_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx,
153 uint32_t *num_entries, char *buf);
154 int (*delete_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx);
Adheer Chandravanshi3af142f2013-09-17 07:54:48 -0400155 int (*set_chap) (struct Scsi_Host *shost, void *data, int len);
Adheer Chandravanshic6a4bb22013-03-22 07:41:29 -0400156 int (*get_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
157 int param, char *buf);
158 int (*set_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
159 struct iscsi_bus_flash_conn *fnode_conn,
160 void *data, int len);
161 int (*new_flashnode) (struct Scsi_Host *shost, const char *buf,
162 int len);
163 int (*del_flashnode) (struct iscsi_bus_flash_session *fnode_sess);
164 int (*login_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
165 struct iscsi_bus_flash_conn *fnode_conn);
166 int (*logout_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
167 struct iscsi_bus_flash_conn *fnode_conn);
168 int (*logout_flashnode_sid) (struct iscsi_cls_session *cls_sess);
Lalit Chandivade6fa7c552013-11-22 05:28:18 -0500169 int (*get_host_stats) (struct Scsi_Host *shost, char *buf, int len);
Sagi Grimberg55e51ed2014-03-05 19:43:49 +0200170 u8 (*check_protection)(struct iscsi_task *task, sector_t *sector);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171};
172
173/*
Alex Aizman39e84792005-08-04 19:31:00 -0700174 * transport registration upcalls
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 */
Mike Christie7b8631b2006-01-13 18:05:50 -0600176extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
Alex Aizman39e84792005-08-04 19:31:00 -0700177extern int iscsi_unregister_transport(struct iscsi_transport *tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179/*
Alex Aizman39e84792005-08-04 19:31:00 -0700180 * control plane upcalls
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 */
Mike Christiee5bd7b52008-09-24 11:46:10 -0500182extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
183 enum iscsi_err error);
Manish Rangankar17fa5752011-07-25 13:48:52 -0500184extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
185 enum iscsi_conn_state state);
Mike Christie7b7232f2006-02-01 21:06:49 -0600186extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
Alex Aizman39e84792005-08-04 19:31:00 -0700187 char *data, uint32_t data_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Michael Chan43514772009-06-08 18:14:41 -0700189extern int iscsi_offload_mesg(struct Scsi_Host *shost,
190 struct iscsi_transport *transport, uint32_t type,
191 char *data, uint16_t data_size);
192
Vikas Chaudharya11e2542012-02-13 18:30:46 +0530193extern void iscsi_post_host_event(uint32_t host_no,
194 struct iscsi_transport *transport,
195 enum iscsi_host_event_code code,
196 uint32_t data_size,
197 uint8_t *data);
198
Vikas Chaudharyac20c7b2012-02-13 18:30:48 +0530199extern void iscsi_ping_comp_event(uint32_t host_no,
200 struct iscsi_transport *transport,
201 uint32_t status, uint32_t pid,
202 uint32_t data_size, uint8_t *data);
203
Mike Christie7b8631b2006-01-13 18:05:50 -0600204struct iscsi_cls_conn {
205 struct list_head conn_list; /* item in connlist */
206 void *dd_data; /* LLD private data */
207 struct iscsi_transport *transport;
Mike Christieb5c7a122006-04-06 21:13:33 -0500208 uint32_t cid; /* connection id */
Mike Christie22a39fb2011-02-16 15:04:33 -0600209 struct mutex ep_mutex;
210 struct iscsi_endpoint *ep;
Mike Christiefd7255f2006-04-06 21:13:36 -0500211
Mike Christie7b8631b2006-01-13 18:05:50 -0600212 struct device dev; /* sysfs transport/container device */
Mike Christie7b8631b2006-01-13 18:05:50 -0600213};
214
215#define iscsi_dev_to_conn(_dev) \
216 container_of(_dev, struct iscsi_cls_conn, dev)
217
Mike Christie3128c6c2011-07-25 13:48:42 -0500218#define transport_class_to_conn(_cdev) \
219 iscsi_dev_to_conn(_cdev->parent)
220
Mike Christie6eabafb2008-01-31 13:36:43 -0600221#define iscsi_conn_to_session(_conn) \
222 iscsi_dev_to_session(_conn->dev.parent)
223
224/* iscsi class session state */
225enum {
226 ISCSI_SESSION_LOGGED_IN,
227 ISCSI_SESSION_FAILED,
228 ISCSI_SESSION_FREE,
229};
Mike Christie7996a772006-04-06 21:13:41 -0500230
Mike Christie79706342008-05-21 15:54:12 -0500231#define ISCSI_MAX_TARGET -1
232
Mike Christie7b8631b2006-01-13 18:05:50 -0600233struct iscsi_cls_session {
Mike Christie7b7232f2006-02-01 21:06:49 -0600234 struct list_head sess_list; /* item in session_list */
Mike Christie7b8631b2006-01-13 18:05:50 -0600235 struct iscsi_transport *transport;
Mike Christie6eabafb2008-01-31 13:36:43 -0600236 spinlock_t lock;
Mike Christie45ab33b2008-03-04 13:26:55 -0600237 struct work_struct block_work;
238 struct work_struct unblock_work;
Mike Christiebd976f62008-01-31 13:36:46 -0600239 struct work_struct scan_work;
240 struct work_struct unbind_work;
Mike Christiefd7255f2006-04-06 21:13:36 -0500241
Mike Christie30a6c652006-04-06 21:13:39 -0500242 /* recovery fields */
243 int recovery_tmo;
David Howellsc4028952006-11-22 14:57:56 +0000244 struct delayed_work recovery_work;
Mike Christie30a6c652006-04-06 21:13:39 -0500245
Mike Christie79706342008-05-21 15:54:12 -0500246 unsigned int target_id;
Mike Christie8d4a6902011-10-06 03:56:57 -0500247 bool ida_used;
Mike Christie30a6c652006-04-06 21:13:39 -0500248
Mike Christie0c70d842011-12-05 16:44:01 -0600249 /*
250 * pid of userspace process that created session or -1 if
251 * created by the kernel.
252 */
253 pid_t creator;
Mike Christie6eabafb2008-01-31 13:36:43 -0600254 int state;
Mike Christieb5c7a122006-04-06 21:13:33 -0500255 int sid; /* session id */
256 void *dd_data; /* LLD private data */
Mike Christie7b8631b2006-01-13 18:05:50 -0600257 struct device dev; /* sysfs transport/container device */
258};
259
260#define iscsi_dev_to_session(_dev) \
261 container_of(_dev, struct iscsi_cls_session, dev)
262
Mike Christie1d063c12011-07-25 13:48:43 -0500263#define transport_class_to_session(_cdev) \
264 iscsi_dev_to_session(_cdev->parent)
265
Mike Christie7b8631b2006-01-13 18:05:50 -0600266#define iscsi_session_to_shost(_session) \
267 dev_to_shost(_session->dev.parent)
268
Mike Christie8434aa82006-06-28 12:00:30 -0500269#define starget_to_session(_stgt) \
270 iscsi_dev_to_session(_stgt->dev.parent)
271
Mike Christie32c6e1b2008-05-21 15:53:58 -0500272struct iscsi_cls_host {
Mike Christie8aae18a2008-01-31 13:36:48 -0600273 atomic_t nr_scans;
Mike Christie30a6c652006-04-06 21:13:39 -0500274 struct mutex mutex;
Mike Christie90eeb012011-07-25 13:48:50 -0500275 struct request_queue *bsg_q;
Vikas Chaudharyaeddde22012-01-19 03:06:55 -0800276 uint32_t port_speed;
277 uint32_t port_state;
Mike Christie30a6c652006-04-06 21:13:39 -0500278};
279
Mike Christie90eeb012011-07-25 13:48:50 -0500280#define iscsi_job_to_shost(_job) \
281 dev_to_shost(_job->dev)
282
Mike Christiea4804cd2008-05-21 15:54:00 -0500283extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
284 void (*fn)(struct iscsi_cls_session *));
285
Mike Christied82ff9be2008-05-21 15:54:13 -0500286struct iscsi_endpoint {
287 void *dd_data; /* LLD private data */
288 struct device dev;
Mike Christie21536062008-09-24 11:46:11 -0500289 uint64_t id;
Mike Christie22a39fb2011-02-16 15:04:33 -0600290 struct iscsi_cls_conn *conn;
Mike Christied82ff9be2008-05-21 15:54:13 -0500291};
Mike Christiea4804cd2008-05-21 15:54:00 -0500292
Mike Christie8d079132011-07-25 13:48:40 -0500293struct iscsi_iface {
294 struct device dev;
295 struct iscsi_transport *transport;
296 uint32_t iface_type; /* IPv4 or IPv6 */
297 uint32_t iface_num; /* iface number, 0 - n */
298 void *dd_data; /* LLD private data */
299};
300
301#define iscsi_dev_to_iface(_dev) \
302 container_of(_dev, struct iscsi_iface, dev)
303
304#define iscsi_iface_to_shost(_iface) \
305 dev_to_shost(_iface->dev.parent)
306
Adheer Chandravanshic6a4bb22013-03-22 07:41:29 -0400307
308struct iscsi_bus_flash_conn {
309 struct list_head conn_list; /* item in connlist */
310 void *dd_data; /* LLD private data */
311 struct iscsi_transport *transport;
312 struct device dev; /* sysfs transport/container device */
313 /* iscsi connection parameters */
314 uint32_t exp_statsn;
315 uint32_t statsn;
316 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
317 unsigned max_xmit_dlength; /* target_max_recv_dsl */
318 unsigned max_segment_size;
319 unsigned tcp_xmit_wsf;
320 unsigned tcp_recv_wsf;
321 int hdrdgst_en;
322 int datadgst_en;
323 int port;
324 char *ipaddress;
325 char *link_local_ipv6_addr;
326 char *redirect_ipaddr;
327 uint16_t keepalive_timeout;
328 uint16_t local_port;
329 uint8_t snack_req_en;
330 /* tcp timestamp negotiation status */
331 uint8_t tcp_timestamp_stat;
332 uint8_t tcp_nagle_disable;
333 /* tcp window scale factor */
334 uint8_t tcp_wsf_disable;
335 uint8_t tcp_timer_scale;
336 uint8_t tcp_timestamp_en;
337 uint8_t ipv4_tos;
338 uint8_t ipv6_traffic_class;
339 uint8_t ipv6_flow_label;
340 uint8_t fragment_disable;
341 /* Link local IPv6 address is assigned by firmware or driver */
342 uint8_t is_fw_assigned_ipv6;
343};
344
345#define iscsi_dev_to_flash_conn(_dev) \
346 container_of(_dev, struct iscsi_bus_flash_conn, dev)
347
348#define iscsi_flash_conn_to_flash_session(_conn) \
349 iscsi_dev_to_flash_session(_conn->dev.parent)
350
351#define ISID_SIZE 6
352
353struct iscsi_bus_flash_session {
354 struct list_head sess_list; /* item in session_list */
355 struct iscsi_transport *transport;
356 unsigned int target_id;
357 int flash_state; /* persistent or non-persistent */
358 void *dd_data; /* LLD private data */
359 struct device dev; /* sysfs transport/container device */
360 /* iscsi session parameters */
361 unsigned first_burst;
362 unsigned max_burst;
363 unsigned short max_r2t;
364 int default_taskmgmt_timeout;
365 int initial_r2t_en;
366 int imm_data_en;
367 int time2wait;
368 int time2retain;
369 int pdu_inorder_en;
370 int dataseq_inorder_en;
371 int erl;
372 int tpgt;
373 char *username;
374 char *username_in;
375 char *password;
376 char *password_in;
377 char *targetname;
378 char *targetalias;
379 char *portal_type;
380 uint16_t tsid;
381 uint16_t chap_in_idx;
382 uint16_t chap_out_idx;
383 /* index of iSCSI discovery session if the entry is
384 * discovered by iSCSI discovery session
385 */
386 uint16_t discovery_parent_idx;
387 /* indicates if discovery was done through iSNS discovery service
388 * or through sendTarget */
389 uint16_t discovery_parent_type;
390 /* Firmware auto sendtarget discovery disable */
391 uint8_t auto_snd_tgt_disable;
392 uint8_t discovery_sess;
393 /* indicates if this flashnode entry is enabled or disabled */
394 uint8_t entry_state;
395 uint8_t chap_auth_en;
396 /* enables firmware to auto logout the discovery session on discovery
397 * completion
398 */
399 uint8_t discovery_logout_en;
400 uint8_t bidi_chap_en;
401 /* makes authentication for discovery session optional */
402 uint8_t discovery_auth_optional;
403 uint8_t isid[ISID_SIZE];
404 uint8_t is_boot_target;
405};
406
407#define iscsi_dev_to_flash_session(_dev) \
408 container_of(_dev, struct iscsi_bus_flash_session, dev)
409
410#define iscsi_flash_session_to_shost(_session) \
411 dev_to_shost(_session->dev.parent)
412
Mike Christie7b8631b2006-01-13 18:05:50 -0600413/*
414 * session and connection functions that can be used by HW iSCSI LLDs
415 */
Mike Christie322d7392008-01-31 13:36:52 -0600416#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
417 dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
418
419#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
420 dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
421
Mike Christie6eabafb2008-01-31 13:36:43 -0600422extern int iscsi_session_chkready(struct iscsi_cls_session *session);
Manish Rangankar17fa5752011-07-25 13:48:52 -0500423extern int iscsi_is_session_online(struct iscsi_cls_session *session);
Mike Christie8434aa82006-06-28 12:00:30 -0500424extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
Mike Christie5d91e202008-05-21 15:54:01 -0500425 struct iscsi_transport *transport, int dd_size);
Mike Christie6a8a0d32006-06-28 12:00:31 -0500426extern int iscsi_add_session(struct iscsi_cls_session *session,
427 unsigned int target_id);
Mike Christie26974782007-12-13 12:43:29 -0600428extern int iscsi_session_event(struct iscsi_cls_session *session,
429 enum iscsi_uevent_e event);
Mike Christie7b8631b2006-01-13 18:05:50 -0600430extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
Mike Christie6a8a0d32006-06-28 12:00:31 -0500431 struct iscsi_transport *t,
Mike Christie5d91e202008-05-21 15:54:01 -0500432 int dd_size,
Mike Christie6a8a0d32006-06-28 12:00:31 -0500433 unsigned int target_id);
Mike Christie8434aa82006-06-28 12:00:30 -0500434extern void iscsi_remove_session(struct iscsi_cls_session *session);
435extern void iscsi_free_session(struct iscsi_cls_session *session);
Mike Christie7b8631b2006-01-13 18:05:50 -0600436extern int iscsi_destroy_session(struct iscsi_cls_session *session);
437extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
Mike Christie5d91e202008-05-21 15:54:01 -0500438 int dd_size, uint32_t cid);
Mike Christie7b8631b2006-01-13 18:05:50 -0600439extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
Mike Christie30a6c652006-04-06 21:13:39 -0500440extern void iscsi_unblock_session(struct iscsi_cls_session *session);
441extern void iscsi_block_session(struct iscsi_cls_session *session);
Mike Christie8aae18a2008-01-31 13:36:48 -0600442extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
Mike Christied82ff9be2008-05-21 15:54:13 -0500443extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
444extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
445extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
Mike Christiec01be6d2010-07-22 16:59:49 +0530446extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
Mike Christie8d079132011-07-25 13:48:40 -0500447extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
448 struct iscsi_transport *t,
449 uint32_t iface_type,
450 uint32_t iface_num, int dd_size);
451extern void iscsi_destroy_iface(struct iscsi_iface *iface);
452extern struct iscsi_iface *iscsi_lookup_iface(int handle);
Vikas Chaudharyaeddde22012-01-19 03:06:55 -0800453extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
454extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
Nilesh Javali6260a5d2012-02-27 03:08:51 -0800455extern int iscsi_is_session_dev(const struct device *dev);
Mike Christie53cb8a12006-06-28 12:00:32 -0500456
Adheer Chandravanshic6a4bb22013-03-22 07:41:29 -0400457extern char *iscsi_get_discovery_parent_name(int parent_type);
458extern struct device *
459iscsi_find_flashnode(struct Scsi_Host *shost, void *data,
460 int (*fn)(struct device *dev, void *data));
461
462extern struct iscsi_bus_flash_session *
463iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index,
464 struct iscsi_transport *transport, int dd_size);
465
466extern struct iscsi_bus_flash_conn *
467iscsi_create_flashnode_conn(struct Scsi_Host *shost,
468 struct iscsi_bus_flash_session *fnode_sess,
469 struct iscsi_transport *transport, int dd_size);
470
471extern void
472iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess);
473
474extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost);
475extern int iscsi_flashnode_bus_match(struct device *dev,
476 struct device_driver *drv);
Adheer Chandravanshic6a4bb22013-03-22 07:41:29 -0400477extern struct device *
478iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data,
479 int (*fn)(struct device *dev, void *data));
Adheer Chandravanshic6a4bb22013-03-22 07:41:29 -0400480extern struct device *
Mike Christie8526cb12013-05-06 12:06:56 -0500481iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess);
482
Harish Zunjarrao3e0f65b2013-10-18 09:01:41 -0400483extern char *
484iscsi_get_ipaddress_state_name(enum iscsi_ipaddress_state port_state);
485extern char *iscsi_get_router_state_name(enum iscsi_router_state router_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486#endif