1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * iSCSI transport class definitions
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
10 #ifndef SCSI_TRANSPORT_ISCSI_H
11 #define SCSI_TRANSPORT_ISCSI_H
13 #include <linux/device.h>
14 #include <linux/list.h>
15 #include <linux/mutex.h>
16 #include <scsi/iscsi_if.h>
18 struct scsi_transport_template;
19 struct iscsi_transport;
20 struct iscsi_endpoint;
23 struct iscsi_cls_conn;
29 struct iscsi_bus_flash_session;
30 struct iscsi_bus_flash_conn;
33 * struct iscsi_transport - iSCSI Transport template
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
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
72 * Template API provided by iSCSI Transport
74 struct iscsi_transport {
79 struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
80 uint16_t cmds_max, uint16_t qdepth,
82 void (*destroy_session) (struct iscsi_cls_session *session);
83 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
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,
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,
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);
110 int (*init_task) (struct iscsi_task *task);
111 int (*xmit_task) (struct iscsi_task *task);
112 void (*cleanup_task) (struct iscsi_task *task);
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,
118 void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
119 int *index, int *age);
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,
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,
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,
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);
162 * transport registration upcalls
164 extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
165 extern int iscsi_unregister_transport(struct iscsi_transport *tt);
168 * control plane upcalls
170 extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
171 enum iscsi_err error);
172 extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
173 enum iscsi_conn_state state);
174 extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
175 char *data, uint32_t data_size);
177 extern int iscsi_offload_mesg(struct Scsi_Host *shost,
178 struct iscsi_transport *transport, uint32_t type,
179 char *data, uint16_t data_size);
181 extern void iscsi_post_host_event(uint32_t host_no,
182 struct iscsi_transport *transport,
183 enum iscsi_host_event_code code,
187 extern 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);
192 /* iscsi class connection state */
193 enum iscsi_connection_state {
200 #define ISCSI_CLS_CONN_BIT_CLEANUP 1
202 struct 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 */
208 * This protects the conn startup and binding/unbinding of the ep to
209 * the conn. Unbinding includes ep_disconnect and stop_conn.
211 struct mutex ep_mutex;
212 struct iscsi_endpoint *ep;
215 struct work_struct cleanup_work;
217 struct device dev; /* sysfs transport/container device */
218 enum iscsi_connection_state state;
221 #define iscsi_dev_to_conn(_dev) \
222 container_of(_dev, struct iscsi_cls_conn, dev)
224 #define transport_class_to_conn(_cdev) \
225 iscsi_dev_to_conn(_cdev->parent)
227 #define iscsi_conn_to_session(_conn) \
228 iscsi_dev_to_session(_conn->dev.parent)
230 /* iscsi class session state */
232 ISCSI_SESSION_LOGGED_IN,
233 ISCSI_SESSION_FAILED,
237 #define ISCSI_MAX_TARGET -1
239 struct iscsi_cls_session {
240 struct list_head sess_list; /* item in session_list */
241 struct iscsi_transport *transport;
243 struct work_struct block_work;
244 struct work_struct unblock_work;
245 struct work_struct scan_work;
246 struct work_struct unbind_work;
247 struct work_struct destroy_work;
249 /* recovery fields */
251 bool recovery_tmo_sysfs_override;
252 struct delayed_work recovery_work;
254 struct workqueue_struct *workq;
256 unsigned int target_id;
260 * pid of userspace process that created session or -1 if
261 * created by the kernel.
265 int sid; /* session id */
266 void *dd_data; /* LLD private data */
267 struct device dev; /* sysfs transport/container device */
270 #define iscsi_dev_to_session(_dev) \
271 container_of(_dev, struct iscsi_cls_session, dev)
273 #define transport_class_to_session(_cdev) \
274 iscsi_dev_to_session(_cdev->parent)
276 #define iscsi_session_to_shost(_session) \
277 dev_to_shost(_session->dev.parent)
279 #define starget_to_session(_stgt) \
280 iscsi_dev_to_session(_stgt->dev.parent)
282 struct iscsi_cls_host {
284 struct request_queue *bsg_q;
289 #define iscsi_job_to_shost(_job) \
290 dev_to_shost(_job->dev)
292 extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
293 void (*fn)(struct iscsi_cls_session *));
295 struct iscsi_endpoint {
296 void *dd_data; /* LLD private data */
299 struct iscsi_cls_conn *conn;
304 struct iscsi_transport *transport;
305 uint32_t iface_type; /* IPv4 or IPv6 */
306 uint32_t iface_num; /* iface number, 0 - n */
307 void *dd_data; /* LLD private data */
310 #define iscsi_dev_to_iface(_dev) \
311 container_of(_dev, struct iscsi_iface, dev)
313 #define iscsi_iface_to_shost(_iface) \
314 dev_to_shost(_iface->dev.parent)
317 struct iscsi_bus_flash_conn {
318 struct list_head conn_list; /* item in connlist */
319 void *dd_data; /* LLD private data */
320 struct iscsi_transport *transport;
321 struct device dev; /* sysfs transport/container device */
322 /* iscsi connection parameters */
325 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
326 unsigned max_xmit_dlength; /* target_max_recv_dsl */
327 unsigned max_segment_size;
328 unsigned tcp_xmit_wsf;
329 unsigned tcp_recv_wsf;
334 char *link_local_ipv6_addr;
335 char *redirect_ipaddr;
336 uint16_t keepalive_timeout;
338 uint8_t snack_req_en;
339 /* tcp timestamp negotiation status */
340 uint8_t tcp_timestamp_stat;
341 uint8_t tcp_nagle_disable;
342 /* tcp window scale factor */
343 uint8_t tcp_wsf_disable;
344 uint8_t tcp_timer_scale;
345 uint8_t tcp_timestamp_en;
347 uint8_t ipv6_traffic_class;
348 uint8_t ipv6_flow_label;
349 uint8_t fragment_disable;
350 /* Link local IPv6 address is assigned by firmware or driver */
351 uint8_t is_fw_assigned_ipv6;
354 #define iscsi_dev_to_flash_conn(_dev) \
355 container_of(_dev, struct iscsi_bus_flash_conn, dev)
357 #define iscsi_flash_conn_to_flash_session(_conn) \
358 iscsi_dev_to_flash_session(_conn->dev.parent)
362 struct iscsi_bus_flash_session {
363 struct list_head sess_list; /* item in session_list */
364 struct iscsi_transport *transport;
365 unsigned int target_id;
366 int flash_state; /* persistent or non-persistent */
367 void *dd_data; /* LLD private data */
368 struct device dev; /* sysfs transport/container device */
369 /* iscsi session parameters */
370 unsigned first_burst;
372 unsigned short max_r2t;
373 int default_taskmgmt_timeout;
379 int dataseq_inorder_en;
390 uint16_t chap_in_idx;
391 uint16_t chap_out_idx;
392 /* index of iSCSI discovery session if the entry is
393 * discovered by iSCSI discovery session
395 uint16_t discovery_parent_idx;
396 /* indicates if discovery was done through iSNS discovery service
397 * or through sendTarget */
398 uint16_t discovery_parent_type;
399 /* Firmware auto sendtarget discovery disable */
400 uint8_t auto_snd_tgt_disable;
401 uint8_t discovery_sess;
402 /* indicates if this flashnode entry is enabled or disabled */
404 uint8_t chap_auth_en;
405 /* enables firmware to auto logout the discovery session on discovery
408 uint8_t discovery_logout_en;
409 uint8_t bidi_chap_en;
410 /* makes authentication for discovery session optional */
411 uint8_t discovery_auth_optional;
412 uint8_t isid[ISID_SIZE];
413 uint8_t is_boot_target;
416 #define iscsi_dev_to_flash_session(_dev) \
417 container_of(_dev, struct iscsi_bus_flash_session, dev)
419 #define iscsi_flash_session_to_shost(_session) \
420 dev_to_shost(_session->dev.parent)
423 * session and connection functions that can be used by HW iSCSI LLDs
425 #define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
426 dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
428 #define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
429 dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
431 extern int iscsi_session_chkready(struct iscsi_cls_session *session);
432 extern int iscsi_is_session_online(struct iscsi_cls_session *session);
433 extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
434 struct iscsi_transport *transport, int dd_size);
435 extern int iscsi_add_session(struct iscsi_cls_session *session,
436 unsigned int target_id);
437 extern int iscsi_session_event(struct iscsi_cls_session *session,
438 enum iscsi_uevent_e event);
439 extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
440 struct iscsi_transport *t,
442 unsigned int target_id);
443 extern void iscsi_remove_session(struct iscsi_cls_session *session);
444 extern void iscsi_free_session(struct iscsi_cls_session *session);
445 extern struct iscsi_cls_conn *iscsi_alloc_conn(struct iscsi_cls_session *sess,
446 int dd_size, uint32_t cid);
447 extern int iscsi_add_conn(struct iscsi_cls_conn *conn);
448 extern void iscsi_remove_conn(struct iscsi_cls_conn *conn);
449 extern void iscsi_put_conn(struct iscsi_cls_conn *conn);
450 extern void iscsi_get_conn(struct iscsi_cls_conn *conn);
451 extern void iscsi_unblock_session(struct iscsi_cls_session *session);
452 extern void iscsi_block_session(struct iscsi_cls_session *session);
453 extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
454 extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
455 extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
456 extern void iscsi_put_endpoint(struct iscsi_endpoint *ep);
457 extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
458 extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
459 struct iscsi_transport *t,
461 uint32_t iface_num, int dd_size);
462 extern void iscsi_destroy_iface(struct iscsi_iface *iface);
463 extern struct iscsi_iface *iscsi_lookup_iface(int handle);
464 extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
465 extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
466 extern int iscsi_is_session_dev(const struct device *dev);
468 extern char *iscsi_get_discovery_parent_name(int parent_type);
469 extern struct device *
470 iscsi_find_flashnode(struct Scsi_Host *shost, void *data,
471 int (*fn)(struct device *dev, void *data));
473 extern struct iscsi_bus_flash_session *
474 iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index,
475 struct iscsi_transport *transport, int dd_size);
477 extern struct iscsi_bus_flash_conn *
478 iscsi_create_flashnode_conn(struct Scsi_Host *shost,
479 struct iscsi_bus_flash_session *fnode_sess,
480 struct iscsi_transport *transport, int dd_size);
483 iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess);
485 extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost);
486 extern int iscsi_flashnode_bus_match(struct device *dev,
487 struct device_driver *drv);
488 extern struct device *
489 iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data,
490 int (*fn)(struct device *dev, void *data));
491 extern struct device *
492 iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess);
495 iscsi_get_ipaddress_state_name(enum iscsi_ipaddress_state port_state);
496 extern char *iscsi_get_router_state_name(enum iscsi_router_state router_state);