Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * iSCSI transport class definitions
4 *
5 * Copyright (C) IBM Corporation, 2004
6 * Copyright (C) Mike Christie, 2004 - 2006
7 * Copyright (C) Dmitry Yusupov, 2004 - 2005
8 * Copyright (C) Alex Aizman, 2004 - 2005
9 */
10#ifndef SCSI_TRANSPORT_ISCSI_H
11#define SCSI_TRANSPORT_ISCSI_H
12
13#include <linux/device.h>
14#include <linux/list.h>
15#include <linux/mutex.h>
16#include <scsi/iscsi_if.h>
17
18struct scsi_transport_template;
19struct iscsi_transport;
20struct iscsi_endpoint;
21struct Scsi_Host;
22struct scsi_cmnd;
23struct iscsi_cls_conn;
24struct iscsi_conn;
25struct iscsi_task;
26struct sockaddr;
27struct iscsi_iface;
28struct bsg_job;
29struct iscsi_bus_flash_session;
30struct iscsi_bus_flash_conn;
31
32/**
33 * struct iscsi_transport - iSCSI Transport template
34 *
35 * @name: transport name
36 * @caps: iSCSI Data-Path capabilities
37 * @create_session: create new iSCSI session object
38 * @destroy_session: destroy existing iSCSI session object
39 * @create_conn: create new iSCSI connection
40 * @bind_conn: associate this connection with existing iSCSI session
41 * and specified transport descriptor
42 * @destroy_conn: destroy inactive iSCSI connection
43 * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
44 * when param is not supported, and a -Exx value on other
45 * error.
46 * @get_param get iSCSI parameter. Must return number of bytes
47 * copied to buffer on success, -ENODATA when param
48 * is not supported, and a -Exx value on other error
49 * @start_conn: set connection to be operational
50 * @stop_conn: suspend/recover/terminate connection
51 * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
52 * @session_recovery_timedout: notify LLD a block during recovery timed out
53 * @init_task: Initialize a iscsi_task and any internal structs.
54 * When offloading the data path, this is called from
55 * queuecommand with the session lock, or from the
56 * iscsi_conn_send_pdu context with the session lock.
57 * When not offloading the data path, this is called
58 * from the scsi work queue without the session lock.
59 * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
60 * number of bytes transferred on success, and -Exyz
61 * value on error. When offloading the data path, this
62 * is called from queuecommand with the session lock, or
63 * from the iscsi_conn_send_pdu context with the session
64 * lock. When not offloading the data path, this is called
65 * from the scsi work queue without the session lock.
66 * @cleanup_task: requests LLD to fail task. Called with session lock
67 * and after the connection has been suspended and
68 * terminated during recovery. If called
69 * from abort task then connection is not suspended
70 * or terminated but sk_callback_lock is held
71 *
72 * Template API provided by iSCSI Transport
73 */
74struct iscsi_transport {
75 struct module *owner;
76 char *name;
77 unsigned int caps;
78
79 struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
80 uint16_t cmds_max, uint16_t qdepth,
81 uint32_t sn);
82 void (*destroy_session) (struct iscsi_cls_session *session);
83 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
84 uint32_t cid);
85 void (*unbind_conn) (struct iscsi_cls_conn *conn, bool is_active);
86 int (*bind_conn) (struct iscsi_cls_session *session,
87 struct iscsi_cls_conn *cls_conn,
88 uint64_t transport_eph, int is_leading);
89 int (*start_conn) (struct iscsi_cls_conn *conn);
90 void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
91 void (*destroy_conn) (struct iscsi_cls_conn *conn);
92 int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
93 char *buf, int buflen);
94 int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
95 char *buf);
96 int (*get_conn_param) (struct iscsi_cls_conn *conn,
97 enum iscsi_param param, char *buf);
98 int (*get_session_param) (struct iscsi_cls_session *session,
99 enum iscsi_param param, char *buf);
100 int (*get_host_param) (struct Scsi_Host *shost,
101 enum iscsi_host_param param, char *buf);
102 int (*set_host_param) (struct Scsi_Host *shost,
103 enum iscsi_host_param param, char *buf,
104 int buflen);
105 int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
106 char *data, uint32_t data_size);
107 void (*get_stats) (struct iscsi_cls_conn *conn,
108 struct iscsi_stats *stats);
109
110 int (*init_task) (struct iscsi_task *task);
111 int (*xmit_task) (struct iscsi_task *task);
112 void (*cleanup_task) (struct iscsi_task *task);
113
114 int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
115 int (*xmit_pdu) (struct iscsi_task *task);
116 int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
117 unsigned int count);
118 void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
119 int *index, int *age);
120
121 void (*session_recovery_timedout) (struct iscsi_cls_session *session);
122 struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
123 struct sockaddr *dst_addr,
124 int non_blocking);
125 int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
126 void (*ep_disconnect) (struct iscsi_endpoint *ep);
127 int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
128 uint32_t enable, struct sockaddr *dst_addr);
129 int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
130 int (*set_iface_param) (struct Scsi_Host *shost, void *data,
131 uint32_t len);
132 int (*get_iface_param) (struct iscsi_iface *iface,
133 enum iscsi_param_type param_type,
134 int param, char *buf);
135 umode_t (*attr_is_visible)(int param_type, int param);
136 int (*bsg_request)(struct bsg_job *job);
137 int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num,
138 uint32_t iface_type, uint32_t payload_size,
139 uint32_t pid, struct sockaddr *dst_addr);
140 int (*get_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx,
141 uint32_t *num_entries, char *buf);
142 int (*delete_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx);
143 int (*set_chap) (struct Scsi_Host *shost, void *data, int len);
144 int (*get_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
145 int param, char *buf);
146 int (*set_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
147 struct iscsi_bus_flash_conn *fnode_conn,
148 void *data, int len);
149 int (*new_flashnode) (struct Scsi_Host *shost, const char *buf,
150 int len);
151 int (*del_flashnode) (struct iscsi_bus_flash_session *fnode_sess);
152 int (*login_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
153 struct iscsi_bus_flash_conn *fnode_conn);
154 int (*logout_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
155 struct iscsi_bus_flash_conn *fnode_conn);
156 int (*logout_flashnode_sid) (struct iscsi_cls_session *cls_sess);
157 int (*get_host_stats) (struct Scsi_Host *shost, char *buf, int len);
158 u8 (*check_protection)(struct iscsi_task *task, sector_t *sector);
159};
160
161/*
162 * transport registration upcalls
163 */
164extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
165extern void iscsi_unregister_transport(struct iscsi_transport *tt);
166
167/*
168 * control plane upcalls
169 */
170extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
171 enum iscsi_err error);
172extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
173 enum iscsi_conn_state state);
174extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
175 char *data, uint32_t data_size);
176
177extern int iscsi_offload_mesg(struct Scsi_Host *shost,
178 struct iscsi_transport *transport, uint32_t type,
179 char *data, uint16_t data_size);
180
181extern void iscsi_post_host_event(uint32_t host_no,
182 struct iscsi_transport *transport,
183 enum iscsi_host_event_code code,
184 uint32_t data_size,
185 uint8_t *data);
186
187extern void iscsi_ping_comp_event(uint32_t host_no,
188 struct iscsi_transport *transport,
189 uint32_t status, uint32_t pid,
190 uint32_t data_size, uint8_t *data);
191
192/* iscsi class connection state */
193enum iscsi_connection_state {
194 ISCSI_CONN_UP = 0,
195 ISCSI_CONN_DOWN,
196 ISCSI_CONN_FAILED,
197 ISCSI_CONN_BOUND,
198};
199
200#define ISCSI_CLS_CONN_BIT_CLEANUP 1
201
202struct iscsi_cls_conn {
203 struct list_head conn_list; /* item in connlist */
204 void *dd_data; /* LLD private data */
205 struct iscsi_transport *transport;
206 uint32_t cid; /* connection id */
207 /*
208 * This protects the conn startup and binding/unbinding of the ep to
209 * the conn. Unbinding includes ep_disconnect and stop_conn.
210 */
211 struct mutex ep_mutex;
212 struct iscsi_endpoint *ep;
213
214 /* Used when accessing flags and queueing work. */
215 spinlock_t lock;
216 unsigned long flags;
217 struct work_struct cleanup_work;
218
219 struct device dev; /* sysfs transport/container device */
220 enum iscsi_connection_state state;
221};
222
223#define iscsi_dev_to_conn(_dev) \
224 container_of(_dev, struct iscsi_cls_conn, dev)
225
226#define transport_class_to_conn(_cdev) \
227 iscsi_dev_to_conn(_cdev->parent)
228
229#define iscsi_conn_to_session(_conn) \
230 iscsi_dev_to_session(_conn->dev.parent)
231
232/* iscsi class session state */
233enum {
234 ISCSI_SESSION_LOGGED_IN,
235 ISCSI_SESSION_FAILED,
236 ISCSI_SESSION_FREE,
237};
238
239enum {
240 ISCSI_SESSION_TARGET_UNBOUND,
241 ISCSI_SESSION_TARGET_ALLOCATED,
242 ISCSI_SESSION_TARGET_SCANNED,
243 ISCSI_SESSION_TARGET_UNBINDING,
244 ISCSI_SESSION_TARGET_MAX,
245};
246
247#define ISCSI_MAX_TARGET -1
248
249struct iscsi_cls_session {
250 struct list_head sess_list; /* item in session_list */
251 struct iscsi_transport *transport;
252 spinlock_t lock;
253 struct work_struct block_work;
254 struct work_struct unblock_work;
255 struct work_struct scan_work;
256 struct work_struct unbind_work;
257 struct work_struct destroy_work;
258
259 /* recovery fields */
260 int recovery_tmo;
261 bool recovery_tmo_sysfs_override;
262 struct delayed_work recovery_work;
263
264 struct workqueue_struct *workq;
265
266 unsigned int target_id;
267 bool ida_used;
268
269 /*
270 * pid of userspace process that created session or -1 if
271 * created by the kernel.
272 */
273 pid_t creator;
274 int state;
275 int target_state; /* session target bind state */
276 int sid; /* session id */
277 void *dd_data; /* LLD private data */
278 struct device dev; /* sysfs transport/container device */
279};
280
281#define iscsi_dev_to_session(_dev) \
282 container_of(_dev, struct iscsi_cls_session, dev)
283
284#define transport_class_to_session(_cdev) \
285 iscsi_dev_to_session(_cdev->parent)
286
287#define iscsi_session_to_shost(_session) \
288 dev_to_shost(_session->dev.parent)
289
290#define starget_to_session(_stgt) \
291 iscsi_dev_to_session(_stgt->dev.parent)
292
293struct iscsi_cls_host {
294 struct mutex mutex;
295 struct request_queue *bsg_q;
296 uint32_t port_speed;
297 uint32_t port_state;
298};
299
300#define iscsi_job_to_shost(_job) \
301 dev_to_shost(_job->dev)
302
303extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
304 void (*fn)(struct iscsi_cls_session *));
305
306struct iscsi_endpoint {
307 void *dd_data; /* LLD private data */
308 struct device dev;
309 int id;
310 struct iscsi_cls_conn *conn;
311};
312
313struct iscsi_iface {
314 struct device dev;
315 struct iscsi_transport *transport;
316 uint32_t iface_type; /* IPv4 or IPv6 */
317 uint32_t iface_num; /* iface number, 0 - n */
318 void *dd_data; /* LLD private data */
319};
320
321#define iscsi_dev_to_iface(_dev) \
322 container_of(_dev, struct iscsi_iface, dev)
323
324#define iscsi_iface_to_shost(_iface) \
325 dev_to_shost(_iface->dev.parent)
326
327
328struct iscsi_bus_flash_conn {
329 struct list_head conn_list; /* item in connlist */
330 void *dd_data; /* LLD private data */
331 struct iscsi_transport *transport;
332 struct device dev; /* sysfs transport/container device */
333 /* iscsi connection parameters */
334 uint32_t exp_statsn;
335 uint32_t statsn;
336 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
337 unsigned max_xmit_dlength; /* target_max_recv_dsl */
338 unsigned max_segment_size;
339 unsigned tcp_xmit_wsf;
340 unsigned tcp_recv_wsf;
341 int hdrdgst_en;
342 int datadgst_en;
343 int port;
344 char *ipaddress;
345 char *link_local_ipv6_addr;
346 char *redirect_ipaddr;
347 uint16_t keepalive_timeout;
348 uint16_t local_port;
349 uint8_t snack_req_en;
350 /* tcp timestamp negotiation status */
351 uint8_t tcp_timestamp_stat;
352 uint8_t tcp_nagle_disable;
353 /* tcp window scale factor */
354 uint8_t tcp_wsf_disable;
355 uint8_t tcp_timer_scale;
356 uint8_t tcp_timestamp_en;
357 uint8_t ipv4_tos;
358 uint8_t ipv6_traffic_class;
359 uint8_t ipv6_flow_label;
360 uint8_t fragment_disable;
361 /* Link local IPv6 address is assigned by firmware or driver */
362 uint8_t is_fw_assigned_ipv6;
363};
364
365#define iscsi_dev_to_flash_conn(_dev) \
366 container_of(_dev, struct iscsi_bus_flash_conn, dev)
367
368#define iscsi_flash_conn_to_flash_session(_conn) \
369 iscsi_dev_to_flash_session(_conn->dev.parent)
370
371#define ISID_SIZE 6
372
373struct iscsi_bus_flash_session {
374 struct list_head sess_list; /* item in session_list */
375 struct iscsi_transport *transport;
376 unsigned int target_id;
377 int flash_state; /* persistent or non-persistent */
378 void *dd_data; /* LLD private data */
379 struct device dev; /* sysfs transport/container device */
380 /* iscsi session parameters */
381 unsigned first_burst;
382 unsigned max_burst;
383 unsigned short max_r2t;
384 int default_taskmgmt_timeout;
385 int initial_r2t_en;
386 int imm_data_en;
387 int time2wait;
388 int time2retain;
389 int pdu_inorder_en;
390 int dataseq_inorder_en;
391 int erl;
392 int tpgt;
393 char *username;
394 char *username_in;
395 char *password;
396 char *password_in;
397 char *targetname;
398 char *targetalias;
399 char *portal_type;
400 uint16_t tsid;
401 uint16_t chap_in_idx;
402 uint16_t chap_out_idx;
403 /* index of iSCSI discovery session if the entry is
404 * discovered by iSCSI discovery session
405 */
406 uint16_t discovery_parent_idx;
407 /* indicates if discovery was done through iSNS discovery service
408 * or through sendTarget */
409 uint16_t discovery_parent_type;
410 /* Firmware auto sendtarget discovery disable */
411 uint8_t auto_snd_tgt_disable;
412 uint8_t discovery_sess;
413 /* indicates if this flashnode entry is enabled or disabled */
414 uint8_t entry_state;
415 uint8_t chap_auth_en;
416 /* enables firmware to auto logout the discovery session on discovery
417 * completion
418 */
419 uint8_t discovery_logout_en;
420 uint8_t bidi_chap_en;
421 /* makes authentication for discovery session optional */
422 uint8_t discovery_auth_optional;
423 uint8_t isid[ISID_SIZE];
424 uint8_t is_boot_target;
425};
426
427#define iscsi_dev_to_flash_session(_dev) \
428 container_of(_dev, struct iscsi_bus_flash_session, dev)
429
430#define iscsi_flash_session_to_shost(_session) \
431 dev_to_shost(_session->dev.parent)
432
433/*
434 * session and connection functions that can be used by HW iSCSI LLDs
435 */
436#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
437 dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
438
439#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
440 dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
441
442extern int iscsi_session_chkready(struct iscsi_cls_session *session);
443extern int iscsi_is_session_online(struct iscsi_cls_session *session);
444extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
445 struct iscsi_transport *transport, int dd_size);
446extern int iscsi_add_session(struct iscsi_cls_session *session,
447 unsigned int target_id);
448extern int iscsi_session_event(struct iscsi_cls_session *session,
449 enum iscsi_uevent_e event);
450extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
451 struct iscsi_transport *t,
452 int dd_size,
453 unsigned int target_id);
454extern void iscsi_force_destroy_session(struct iscsi_cls_session *session);
455extern void iscsi_remove_session(struct iscsi_cls_session *session);
456extern void iscsi_free_session(struct iscsi_cls_session *session);
457extern struct iscsi_cls_conn *iscsi_alloc_conn(struct iscsi_cls_session *sess,
458 int dd_size, uint32_t cid);
459extern int iscsi_add_conn(struct iscsi_cls_conn *conn);
460extern void iscsi_remove_conn(struct iscsi_cls_conn *conn);
461extern void iscsi_put_conn(struct iscsi_cls_conn *conn);
462extern void iscsi_get_conn(struct iscsi_cls_conn *conn);
463extern void iscsi_unblock_session(struct iscsi_cls_session *session);
464extern void iscsi_block_session(struct iscsi_cls_session *session);
465extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
466extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
467extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
468extern void iscsi_put_endpoint(struct iscsi_endpoint *ep);
469extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
470extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
471 struct iscsi_transport *t,
472 uint32_t iface_type,
473 uint32_t iface_num, int dd_size);
474extern void iscsi_destroy_iface(struct iscsi_iface *iface);
475extern struct iscsi_iface *iscsi_lookup_iface(int handle);
476extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
477extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
478extern int iscsi_is_session_dev(const struct device *dev);
479
480extern char *iscsi_get_discovery_parent_name(int parent_type);
481extern struct device *
482iscsi_find_flashnode(struct Scsi_Host *shost, void *data,
483 int (*fn)(struct device *dev, void *data));
484
485extern struct iscsi_bus_flash_session *
486iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index,
487 struct iscsi_transport *transport, int dd_size);
488
489extern struct iscsi_bus_flash_conn *
490iscsi_create_flashnode_conn(struct Scsi_Host *shost,
491 struct iscsi_bus_flash_session *fnode_sess,
492 struct iscsi_transport *transport, int dd_size);
493
494extern void
495iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess);
496
497extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost);
498extern int iscsi_flashnode_bus_match(struct device *dev,
499 struct device_driver *drv);
500extern struct device *
501iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data,
502 int (*fn)(struct device *dev, void *data));
503extern struct device *
504iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess);
505
506extern char *
507iscsi_get_ipaddress_state_name(enum iscsi_ipaddress_state port_state);
508extern char *iscsi_get_router_state_name(enum iscsi_router_state router_state);
509#endif
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * iSCSI transport class definitions
4 *
5 * Copyright (C) IBM Corporation, 2004
6 * Copyright (C) Mike Christie, 2004 - 2006
7 * Copyright (C) Dmitry Yusupov, 2004 - 2005
8 * Copyright (C) Alex Aizman, 2004 - 2005
9 */
10#ifndef SCSI_TRANSPORT_ISCSI_H
11#define SCSI_TRANSPORT_ISCSI_H
12
13#include <linux/device.h>
14#include <linux/list.h>
15#include <linux/mutex.h>
16#include <scsi/iscsi_if.h>
17
18struct scsi_transport_template;
19struct iscsi_transport;
20struct iscsi_endpoint;
21struct Scsi_Host;
22struct scsi_cmnd;
23struct iscsi_cls_conn;
24struct iscsi_conn;
25struct iscsi_task;
26struct sockaddr;
27struct iscsi_iface;
28struct bsg_job;
29struct iscsi_bus_flash_session;
30struct iscsi_bus_flash_conn;
31
32/**
33 * struct iscsi_transport - iSCSI Transport template
34 *
35 * @name: transport name
36 * @caps: iSCSI Data-Path capabilities
37 * @create_session: create new iSCSI session object
38 * @destroy_session: destroy existing iSCSI session object
39 * @create_conn: create new iSCSI connection
40 * @bind_conn: associate this connection with existing iSCSI session
41 * and specified transport descriptor
42 * @destroy_conn: destroy inactive iSCSI connection
43 * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
44 * when param is not supported, and a -Exx value on other
45 * error.
46 * @get_param get iSCSI parameter. Must return number of bytes
47 * copied to buffer on success, -ENODATA when param
48 * is not supported, and a -Exx value on other error
49 * @start_conn: set connection to be operational
50 * @stop_conn: suspend/recover/terminate connection
51 * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
52 * @session_recovery_timedout: notify LLD a block during recovery timed out
53 * @init_task: Initialize a iscsi_task and any internal structs.
54 * When offloading the data path, this is called from
55 * queuecommand with the session lock, or from the
56 * iscsi_conn_send_pdu context with the session lock.
57 * When not offloading the data path, this is called
58 * from the scsi work queue without the session lock.
59 * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
60 * the number of bytes transferred on success, and -Exyz
61 * value on error. When offloading the data path, this
62 * is called from queuecommand with the session lock, or
63 * from the iscsi_conn_send_pdu context with the session
64 * lock. When not offloading the data path, this is called
65 * from the scsi work queue without the session lock.
66 * @cleanup_task: requests LLD to fail task. Called with session lock
67 * and after the connection has been suspended and
68 * terminated during recovery. If called
69 * from abort task then connection is not suspended
70 * or terminated but sk_callback_lock is held
71 *
72 * Template API provided by iSCSI Transport
73 */
74struct iscsi_transport {
75 struct module *owner;
76 char *name;
77 unsigned int caps;
78
79 struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
80 uint16_t cmds_max, uint16_t qdepth,
81 uint32_t sn);
82 void (*destroy_session) (struct iscsi_cls_session *session);
83 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
84 uint32_t cid);
85 int (*bind_conn) (struct iscsi_cls_session *session,
86 struct iscsi_cls_conn *cls_conn,
87 uint64_t transport_eph, int is_leading);
88 int (*start_conn) (struct iscsi_cls_conn *conn);
89 void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
90 void (*destroy_conn) (struct iscsi_cls_conn *conn);
91 int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
92 char *buf, int buflen);
93 int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
94 char *buf);
95 int (*get_conn_param) (struct iscsi_cls_conn *conn,
96 enum iscsi_param param, char *buf);
97 int (*get_session_param) (struct iscsi_cls_session *session,
98 enum iscsi_param param, char *buf);
99 int (*get_host_param) (struct Scsi_Host *shost,
100 enum iscsi_host_param param, char *buf);
101 int (*set_host_param) (struct Scsi_Host *shost,
102 enum iscsi_host_param param, char *buf,
103 int buflen);
104 int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
105 char *data, uint32_t data_size);
106 void (*get_stats) (struct iscsi_cls_conn *conn,
107 struct iscsi_stats *stats);
108
109 int (*init_task) (struct iscsi_task *task);
110 int (*xmit_task) (struct iscsi_task *task);
111 void (*cleanup_task) (struct iscsi_task *task);
112
113 int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
114 int (*xmit_pdu) (struct iscsi_task *task);
115 int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
116 unsigned int count);
117 void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
118 int *index, int *age);
119
120 void (*session_recovery_timedout) (struct iscsi_cls_session *session);
121 struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
122 struct sockaddr *dst_addr,
123 int non_blocking);
124 int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
125 void (*ep_disconnect) (struct iscsi_endpoint *ep);
126 int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
127 uint32_t enable, struct sockaddr *dst_addr);
128 int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
129 int (*set_iface_param) (struct Scsi_Host *shost, void *data,
130 uint32_t len);
131 int (*get_iface_param) (struct iscsi_iface *iface,
132 enum iscsi_param_type param_type,
133 int param, char *buf);
134 umode_t (*attr_is_visible)(int param_type, int param);
135 int (*bsg_request)(struct bsg_job *job);
136 int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num,
137 uint32_t iface_type, uint32_t payload_size,
138 uint32_t pid, struct sockaddr *dst_addr);
139 int (*get_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx,
140 uint32_t *num_entries, char *buf);
141 int (*delete_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx);
142 int (*set_chap) (struct Scsi_Host *shost, void *data, int len);
143 int (*get_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
144 int param, char *buf);
145 int (*set_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
146 struct iscsi_bus_flash_conn *fnode_conn,
147 void *data, int len);
148 int (*new_flashnode) (struct Scsi_Host *shost, const char *buf,
149 int len);
150 int (*del_flashnode) (struct iscsi_bus_flash_session *fnode_sess);
151 int (*login_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
152 struct iscsi_bus_flash_conn *fnode_conn);
153 int (*logout_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
154 struct iscsi_bus_flash_conn *fnode_conn);
155 int (*logout_flashnode_sid) (struct iscsi_cls_session *cls_sess);
156 int (*get_host_stats) (struct Scsi_Host *shost, char *buf, int len);
157 u8 (*check_protection)(struct iscsi_task *task, sector_t *sector);
158};
159
160/*
161 * transport registration upcalls
162 */
163extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
164extern int iscsi_unregister_transport(struct iscsi_transport *tt);
165
166/*
167 * control plane upcalls
168 */
169extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
170 enum iscsi_err error);
171extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
172 enum iscsi_conn_state state);
173extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
174 char *data, uint32_t data_size);
175
176extern int iscsi_offload_mesg(struct Scsi_Host *shost,
177 struct iscsi_transport *transport, uint32_t type,
178 char *data, uint16_t data_size);
179
180extern void iscsi_post_host_event(uint32_t host_no,
181 struct iscsi_transport *transport,
182 enum iscsi_host_event_code code,
183 uint32_t data_size,
184 uint8_t *data);
185
186extern void iscsi_ping_comp_event(uint32_t host_no,
187 struct iscsi_transport *transport,
188 uint32_t status, uint32_t pid,
189 uint32_t data_size, uint8_t *data);
190
191struct iscsi_cls_conn {
192 struct list_head conn_list; /* item in connlist */
193 void *dd_data; /* LLD private data */
194 struct iscsi_transport *transport;
195 uint32_t cid; /* connection id */
196 struct mutex ep_mutex;
197 struct iscsi_endpoint *ep;
198
199 struct device dev; /* sysfs transport/container device */
200};
201
202#define iscsi_dev_to_conn(_dev) \
203 container_of(_dev, struct iscsi_cls_conn, dev)
204
205#define transport_class_to_conn(_cdev) \
206 iscsi_dev_to_conn(_cdev->parent)
207
208#define iscsi_conn_to_session(_conn) \
209 iscsi_dev_to_session(_conn->dev.parent)
210
211/* iscsi class session state */
212enum {
213 ISCSI_SESSION_LOGGED_IN,
214 ISCSI_SESSION_FAILED,
215 ISCSI_SESSION_FREE,
216};
217
218#define ISCSI_MAX_TARGET -1
219
220struct iscsi_cls_session {
221 struct list_head sess_list; /* item in session_list */
222 struct iscsi_transport *transport;
223 spinlock_t lock;
224 struct work_struct block_work;
225 struct work_struct unblock_work;
226 struct work_struct scan_work;
227 struct work_struct unbind_work;
228
229 /* recovery fields */
230 int recovery_tmo;
231 bool recovery_tmo_sysfs_override;
232 struct delayed_work recovery_work;
233
234 unsigned int target_id;
235 bool ida_used;
236
237 /*
238 * pid of userspace process that created session or -1 if
239 * created by the kernel.
240 */
241 pid_t creator;
242 int state;
243 int sid; /* session id */
244 void *dd_data; /* LLD private data */
245 struct device dev; /* sysfs transport/container device */
246};
247
248#define iscsi_dev_to_session(_dev) \
249 container_of(_dev, struct iscsi_cls_session, dev)
250
251#define transport_class_to_session(_cdev) \
252 iscsi_dev_to_session(_cdev->parent)
253
254#define iscsi_session_to_shost(_session) \
255 dev_to_shost(_session->dev.parent)
256
257#define starget_to_session(_stgt) \
258 iscsi_dev_to_session(_stgt->dev.parent)
259
260struct iscsi_cls_host {
261 atomic_t nr_scans;
262 struct mutex mutex;
263 struct request_queue *bsg_q;
264 uint32_t port_speed;
265 uint32_t port_state;
266};
267
268#define iscsi_job_to_shost(_job) \
269 dev_to_shost(_job->dev)
270
271extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
272 void (*fn)(struct iscsi_cls_session *));
273
274struct iscsi_endpoint {
275 void *dd_data; /* LLD private data */
276 struct device dev;
277 uint64_t id;
278 struct iscsi_cls_conn *conn;
279};
280
281struct iscsi_iface {
282 struct device dev;
283 struct iscsi_transport *transport;
284 uint32_t iface_type; /* IPv4 or IPv6 */
285 uint32_t iface_num; /* iface number, 0 - n */
286 void *dd_data; /* LLD private data */
287};
288
289#define iscsi_dev_to_iface(_dev) \
290 container_of(_dev, struct iscsi_iface, dev)
291
292#define iscsi_iface_to_shost(_iface) \
293 dev_to_shost(_iface->dev.parent)
294
295
296struct iscsi_bus_flash_conn {
297 struct list_head conn_list; /* item in connlist */
298 void *dd_data; /* LLD private data */
299 struct iscsi_transport *transport;
300 struct device dev; /* sysfs transport/container device */
301 /* iscsi connection parameters */
302 uint32_t exp_statsn;
303 uint32_t statsn;
304 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
305 unsigned max_xmit_dlength; /* target_max_recv_dsl */
306 unsigned max_segment_size;
307 unsigned tcp_xmit_wsf;
308 unsigned tcp_recv_wsf;
309 int hdrdgst_en;
310 int datadgst_en;
311 int port;
312 char *ipaddress;
313 char *link_local_ipv6_addr;
314 char *redirect_ipaddr;
315 uint16_t keepalive_timeout;
316 uint16_t local_port;
317 uint8_t snack_req_en;
318 /* tcp timestamp negotiation status */
319 uint8_t tcp_timestamp_stat;
320 uint8_t tcp_nagle_disable;
321 /* tcp window scale factor */
322 uint8_t tcp_wsf_disable;
323 uint8_t tcp_timer_scale;
324 uint8_t tcp_timestamp_en;
325 uint8_t ipv4_tos;
326 uint8_t ipv6_traffic_class;
327 uint8_t ipv6_flow_label;
328 uint8_t fragment_disable;
329 /* Link local IPv6 address is assigned by firmware or driver */
330 uint8_t is_fw_assigned_ipv6;
331};
332
333#define iscsi_dev_to_flash_conn(_dev) \
334 container_of(_dev, struct iscsi_bus_flash_conn, dev)
335
336#define iscsi_flash_conn_to_flash_session(_conn) \
337 iscsi_dev_to_flash_session(_conn->dev.parent)
338
339#define ISID_SIZE 6
340
341struct iscsi_bus_flash_session {
342 struct list_head sess_list; /* item in session_list */
343 struct iscsi_transport *transport;
344 unsigned int target_id;
345 int flash_state; /* persistent or non-persistent */
346 void *dd_data; /* LLD private data */
347 struct device dev; /* sysfs transport/container device */
348 /* iscsi session parameters */
349 unsigned first_burst;
350 unsigned max_burst;
351 unsigned short max_r2t;
352 int default_taskmgmt_timeout;
353 int initial_r2t_en;
354 int imm_data_en;
355 int time2wait;
356 int time2retain;
357 int pdu_inorder_en;
358 int dataseq_inorder_en;
359 int erl;
360 int tpgt;
361 char *username;
362 char *username_in;
363 char *password;
364 char *password_in;
365 char *targetname;
366 char *targetalias;
367 char *portal_type;
368 uint16_t tsid;
369 uint16_t chap_in_idx;
370 uint16_t chap_out_idx;
371 /* index of iSCSI discovery session if the entry is
372 * discovered by iSCSI discovery session
373 */
374 uint16_t discovery_parent_idx;
375 /* indicates if discovery was done through iSNS discovery service
376 * or through sendTarget */
377 uint16_t discovery_parent_type;
378 /* Firmware auto sendtarget discovery disable */
379 uint8_t auto_snd_tgt_disable;
380 uint8_t discovery_sess;
381 /* indicates if this flashnode entry is enabled or disabled */
382 uint8_t entry_state;
383 uint8_t chap_auth_en;
384 /* enables firmware to auto logout the discovery session on discovery
385 * completion
386 */
387 uint8_t discovery_logout_en;
388 uint8_t bidi_chap_en;
389 /* makes authentication for discovery session optional */
390 uint8_t discovery_auth_optional;
391 uint8_t isid[ISID_SIZE];
392 uint8_t is_boot_target;
393};
394
395#define iscsi_dev_to_flash_session(_dev) \
396 container_of(_dev, struct iscsi_bus_flash_session, dev)
397
398#define iscsi_flash_session_to_shost(_session) \
399 dev_to_shost(_session->dev.parent)
400
401/*
402 * session and connection functions that can be used by HW iSCSI LLDs
403 */
404#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
405 dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
406
407#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
408 dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
409
410extern int iscsi_session_chkready(struct iscsi_cls_session *session);
411extern int iscsi_is_session_online(struct iscsi_cls_session *session);
412extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
413 struct iscsi_transport *transport, int dd_size);
414extern int iscsi_add_session(struct iscsi_cls_session *session,
415 unsigned int target_id);
416extern int iscsi_session_event(struct iscsi_cls_session *session,
417 enum iscsi_uevent_e event);
418extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
419 struct iscsi_transport *t,
420 int dd_size,
421 unsigned int target_id);
422extern void iscsi_remove_session(struct iscsi_cls_session *session);
423extern void iscsi_free_session(struct iscsi_cls_session *session);
424extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
425 int dd_size, uint32_t cid);
426extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
427extern void iscsi_unblock_session(struct iscsi_cls_session *session);
428extern void iscsi_block_session(struct iscsi_cls_session *session);
429extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
430extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
431extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
432extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
433extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
434extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
435 struct iscsi_transport *t,
436 uint32_t iface_type,
437 uint32_t iface_num, int dd_size);
438extern void iscsi_destroy_iface(struct iscsi_iface *iface);
439extern struct iscsi_iface *iscsi_lookup_iface(int handle);
440extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
441extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
442extern int iscsi_is_session_dev(const struct device *dev);
443
444extern char *iscsi_get_discovery_parent_name(int parent_type);
445extern struct device *
446iscsi_find_flashnode(struct Scsi_Host *shost, void *data,
447 int (*fn)(struct device *dev, void *data));
448
449extern struct iscsi_bus_flash_session *
450iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index,
451 struct iscsi_transport *transport, int dd_size);
452
453extern struct iscsi_bus_flash_conn *
454iscsi_create_flashnode_conn(struct Scsi_Host *shost,
455 struct iscsi_bus_flash_session *fnode_sess,
456 struct iscsi_transport *transport, int dd_size);
457
458extern void
459iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess);
460
461extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost);
462extern int iscsi_flashnode_bus_match(struct device *dev,
463 struct device_driver *drv);
464extern struct device *
465iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data,
466 int (*fn)(struct device *dev, void *data));
467extern struct device *
468iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess);
469
470extern char *
471iscsi_get_ipaddress_state_name(enum iscsi_ipaddress_state port_state);
472extern char *iscsi_get_router_state_name(enum iscsi_router_state router_state);
473#endif