11a59d1b8SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */ 21da177e4SLinus Torvalds /* 31da177e4SLinus Torvalds * iSCSI transport class definitions 41da177e4SLinus Torvalds * 51da177e4SLinus Torvalds * Copyright (C) IBM Corporation, 2004 67996a778SMike Christie * Copyright (C) Mike Christie, 2004 - 2006 739e84790SAlex Aizman * Copyright (C) Dmitry Yusupov, 2004 - 2005 839e84790SAlex Aizman * Copyright (C) Alex Aizman, 2004 - 2005 91da177e4SLinus Torvalds */ 101da177e4SLinus Torvalds #ifndef SCSI_TRANSPORT_ISCSI_H 111da177e4SLinus Torvalds #define SCSI_TRANSPORT_ISCSI_H 121da177e4SLinus Torvalds 137b8631b5SMike Christie #include <linux/device.h> 14d773c082SMichael S. Tsirkin #include <linux/list.h> 15d773c082SMichael S. Tsirkin #include <linux/mutex.h> 1639e84790SAlex Aizman #include <scsi/iscsi_if.h> 171da177e4SLinus Torvalds 187b8631b5SMike Christie struct scsi_transport_template; 197996a778SMike Christie struct iscsi_transport; 20d82ff9beSMike Christie struct iscsi_endpoint; 217b8631b5SMike Christie struct Scsi_Host; 22c01be6dcSMike Christie struct scsi_cmnd; 237b8631b5SMike Christie struct iscsi_cls_conn; 247996a778SMike Christie struct iscsi_conn; 259c19a7d0SMike Christie struct iscsi_task; 26a54a52caSMike Christie struct sockaddr; 278d07913dSMike Christie struct iscsi_iface; 2890eeb01aSMike Christie struct bsg_job; 29c6a4bb2eSAdheer Chandravanshi struct iscsi_bus_flash_session; 30c6a4bb2eSAdheer Chandravanshi struct iscsi_bus_flash_conn; 317b8631b5SMike Christie 3239e84790SAlex Aizman /** 3339e84790SAlex Aizman * struct iscsi_transport - iSCSI Transport template 3439e84790SAlex Aizman * 3539e84790SAlex Aizman * @name: transport name 3639e84790SAlex Aizman * @caps: iSCSI Data-Path capabilities 3739e84790SAlex Aizman * @create_session: create new iSCSI session object 3839e84790SAlex Aizman * @destroy_session: destroy existing iSCSI session object 3939e84790SAlex Aizman * @create_conn: create new iSCSI connection 4039e84790SAlex Aizman * @bind_conn: associate this connection with existing iSCSI session 4139e84790SAlex Aizman * and specified transport descriptor 4239e84790SAlex Aizman * @destroy_conn: destroy inactive iSCSI connection 43a54a52caSMike Christie * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA 44a54a52caSMike Christie * when param is not supported, and a -Exx value on other 45a54a52caSMike Christie * error. 46a54a52caSMike Christie * @get_param get iSCSI parameter. Must return number of bytes 47a54a52caSMike Christie * copied to buffer on success, -ENODATA when param 48a54a52caSMike Christie * is not supported, and a -Exx value on other error 4939e84790SAlex Aizman * @start_conn: set connection to be operational 5039e84790SAlex Aizman * @stop_conn: suspend/recover/terminate connection 5139e84790SAlex Aizman * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text. 527996a778SMike Christie * @session_recovery_timedout: notify LLD a block during recovery timed out 533e5c28adSMike Christie * @init_task: Initialize a iscsi_task and any internal structs. 543e5c28adSMike Christie * When offloading the data path, this is called from 553e5c28adSMike Christie * queuecommand with the session lock, or from the 563e5c28adSMike Christie * iscsi_conn_send_pdu context with the session lock. 573e5c28adSMike Christie * When not offloading the data path, this is called 583e5c28adSMike Christie * from the scsi work queue without the session lock. 593e5c28adSMike Christie * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the 603219e529SMike Christie * the number of bytes transferred on success, and -Exyz 613e5c28adSMike Christie * value on error. When offloading the data path, this 623e5c28adSMike Christie * is called from queuecommand with the session lock, or 633e5c28adSMike Christie * from the iscsi_conn_send_pdu context with the session 643e5c28adSMike Christie * lock. When not offloading the data path, this is called 653e5c28adSMike Christie * from the scsi work queue without the session lock. 663e5c28adSMike Christie * @cleanup_task: requests LLD to fail task. Called with session lock 673e5c28adSMike Christie * and after the connection has been suspended and 683e5c28adSMike Christie * terminated during recovery. If called 697996a778SMike Christie * from abort task then connection is not suspended 707996a778SMike Christie * or terminated but sk_callback_lock is held 7139e84790SAlex Aizman * 7239e84790SAlex Aizman * Template API provided by iSCSI Transport 7339e84790SAlex Aizman */ 7439e84790SAlex Aizman struct iscsi_transport { 7539e84790SAlex Aizman struct module *owner; 7639e84790SAlex Aizman char *name; 7739e84790SAlex Aizman unsigned int caps; 788d07913dSMike Christie 79d82ff9beSMike Christie struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep, 8075613521SMike Christie uint16_t cmds_max, uint16_t qdepth, 815e7facb7SMike Christie uint32_t sn); 827b7232f3SMike Christie void (*destroy_session) (struct iscsi_cls_session *session); 837b7232f3SMike Christie struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess, 847b8631b5SMike Christie uint32_t cid); 857b7232f3SMike Christie int (*bind_conn) (struct iscsi_cls_session *session, 867b7232f3SMike Christie struct iscsi_cls_conn *cls_conn, 87264faaaaSOr Gerlitz uint64_t transport_eph, int is_leading); 887b7232f3SMike Christie int (*start_conn) (struct iscsi_cls_conn *conn); 897b7232f3SMike Christie void (*stop_conn) (struct iscsi_cls_conn *conn, int flag); 907b8631b5SMike Christie void (*destroy_conn) (struct iscsi_cls_conn *conn); 917b7232f3SMike Christie int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param, 92a54a52caSMike Christie char *buf, int buflen); 93289324b0SMike Christie int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param, 94289324b0SMike Christie char *buf); 957b7232f3SMike Christie int (*get_conn_param) (struct iscsi_cls_conn *conn, 96fd7255f5SMike Christie enum iscsi_param param, char *buf); 97a54a52caSMike Christie int (*get_session_param) (struct iscsi_cls_session *session, 98fd7255f5SMike Christie enum iscsi_param param, char *buf); 991819dc81SMike Christie int (*get_host_param) (struct Scsi_Host *shost, 1001819dc81SMike Christie enum iscsi_host_param param, char *buf); 1011d9bf13aSMike Christie int (*set_host_param) (struct Scsi_Host *shost, 1021d9bf13aSMike Christie enum iscsi_host_param param, char *buf, 1031d9bf13aSMike Christie int buflen); 1047b7232f3SMike Christie int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, 10539e84790SAlex Aizman char *data, uint32_t data_size); 1067b7232f3SMike Christie void (*get_stats) (struct iscsi_cls_conn *conn, 1077b7232f3SMike Christie struct iscsi_stats *stats); 108577577daSMike Christie 1099c19a7d0SMike Christie int (*init_task) (struct iscsi_task *task); 1109c19a7d0SMike Christie int (*xmit_task) (struct iscsi_task *task); 111577577daSMike Christie void (*cleanup_task) (struct iscsi_task *task); 112577577daSMike Christie 1132ff79d52SMike Christie int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode); 114577577daSMike Christie int (*xmit_pdu) (struct iscsi_task *task); 115577577daSMike Christie int (*init_pdu) (struct iscsi_task *task, unsigned int offset, 116577577daSMike Christie unsigned int count); 117262ef636SMike Christie void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt, 118262ef636SMike Christie int *index, int *age); 119262ef636SMike Christie 12030a6c652SMike Christie void (*session_recovery_timedout) (struct iscsi_cls_session *session); 12110eb0f01SMike Christie struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost, 12210eb0f01SMike Christie struct sockaddr *dst_addr, 123d82ff9beSMike Christie int non_blocking); 124d82ff9beSMike Christie int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms); 125d82ff9beSMike Christie void (*ep_disconnect) (struct iscsi_endpoint *ep); 1262174a04eSMike Christie int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type, 12701cb225dSMike Christie uint32_t enable, struct sockaddr *dst_addr); 12843514774SMichael Chan int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params); 12900c31889SMike Christie int (*set_iface_param) (struct Scsi_Host *shost, void *data, 13000c31889SMike Christie uint32_t len); 1318d07913dSMike Christie int (*get_iface_param) (struct iscsi_iface *iface, 1328d07913dSMike Christie enum iscsi_param_type param_type, 1338d07913dSMike Christie int param, char *buf); 134587a1f16SAl Viro umode_t (*attr_is_visible)(int param_type, int param); 13590eeb01aSMike Christie int (*bsg_request)(struct bsg_job *job); 136ac20c7bfSVikas Chaudhary int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num, 137ac20c7bfSVikas Chaudhary uint32_t iface_type, uint32_t payload_size, 138ac20c7bfSVikas Chaudhary uint32_t pid, struct sockaddr *dst_addr); 1396260a5d2SNilesh Javali int (*get_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx, 1406260a5d2SNilesh Javali uint32_t *num_entries, char *buf); 1416260a5d2SNilesh Javali int (*delete_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx); 1423af142feSAdheer Chandravanshi int (*set_chap) (struct Scsi_Host *shost, void *data, int len); 143c6a4bb2eSAdheer Chandravanshi int (*get_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess, 144c6a4bb2eSAdheer Chandravanshi int param, char *buf); 145c6a4bb2eSAdheer Chandravanshi int (*set_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess, 146c6a4bb2eSAdheer Chandravanshi struct iscsi_bus_flash_conn *fnode_conn, 147c6a4bb2eSAdheer Chandravanshi void *data, int len); 148c6a4bb2eSAdheer Chandravanshi int (*new_flashnode) (struct Scsi_Host *shost, const char *buf, 149c6a4bb2eSAdheer Chandravanshi int len); 150c6a4bb2eSAdheer Chandravanshi int (*del_flashnode) (struct iscsi_bus_flash_session *fnode_sess); 151c6a4bb2eSAdheer Chandravanshi int (*login_flashnode) (struct iscsi_bus_flash_session *fnode_sess, 152c6a4bb2eSAdheer Chandravanshi struct iscsi_bus_flash_conn *fnode_conn); 153c6a4bb2eSAdheer Chandravanshi int (*logout_flashnode) (struct iscsi_bus_flash_session *fnode_sess, 154c6a4bb2eSAdheer Chandravanshi struct iscsi_bus_flash_conn *fnode_conn); 155c6a4bb2eSAdheer Chandravanshi int (*logout_flashnode_sid) (struct iscsi_cls_session *cls_sess); 1566fa7c554SLalit Chandivade int (*get_host_stats) (struct Scsi_Host *shost, char *buf, int len); 15755e51edaSSagi Grimberg u8 (*check_protection)(struct iscsi_task *task, sector_t *sector); 1581da177e4SLinus Torvalds }; 1591da177e4SLinus Torvalds 1601da177e4SLinus Torvalds /* 16139e84790SAlex Aizman * transport registration upcalls 1621da177e4SLinus Torvalds */ 1637b8631b5SMike Christie extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt); 16439e84790SAlex Aizman extern int iscsi_unregister_transport(struct iscsi_transport *tt); 1651da177e4SLinus Torvalds 1661da177e4SLinus Torvalds /* 16739e84790SAlex Aizman * control plane upcalls 1681da177e4SLinus Torvalds */ 169e5bd7b54SMike Christie extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn, 170e5bd7b54SMike Christie enum iscsi_err error); 17117fa575eSManish Rangankar extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn, 17217fa575eSManish Rangankar enum iscsi_conn_state state); 1737b7232f3SMike Christie extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, 17439e84790SAlex Aizman char *data, uint32_t data_size); 1751da177e4SLinus Torvalds 17643514774SMichael Chan extern int iscsi_offload_mesg(struct Scsi_Host *shost, 17743514774SMichael Chan struct iscsi_transport *transport, uint32_t type, 17843514774SMichael Chan char *data, uint16_t data_size); 17943514774SMichael Chan 180a11e2545SVikas Chaudhary extern void iscsi_post_host_event(uint32_t host_no, 181a11e2545SVikas Chaudhary struct iscsi_transport *transport, 182a11e2545SVikas Chaudhary enum iscsi_host_event_code code, 183a11e2545SVikas Chaudhary uint32_t data_size, 184a11e2545SVikas Chaudhary uint8_t *data); 185a11e2545SVikas Chaudhary 186ac20c7bfSVikas Chaudhary extern void iscsi_ping_comp_event(uint32_t host_no, 187ac20c7bfSVikas Chaudhary struct iscsi_transport *transport, 188ac20c7bfSVikas Chaudhary uint32_t status, uint32_t pid, 189ac20c7bfSVikas Chaudhary uint32_t data_size, uint8_t *data); 190ac20c7bfSVikas Chaudhary 1917b8631b5SMike Christie struct iscsi_cls_conn { 1927b8631b5SMike Christie struct list_head conn_list; /* item in connlist */ 1930ab71045SBharath Ravi struct list_head conn_list_err; /* item in connlist_err */ 1947b8631b5SMike Christie void *dd_data; /* LLD private data */ 1957b8631b5SMike Christie struct iscsi_transport *transport; 196b5c7a12dSMike Christie uint32_t cid; /* connection id */ 19722a39fbbSMike Christie struct mutex ep_mutex; 19822a39fbbSMike Christie struct iscsi_endpoint *ep; 199fd7255f5SMike Christie 2007b8631b5SMike Christie struct device dev; /* sysfs transport/container device */ 2017b8631b5SMike Christie }; 2027b8631b5SMike Christie 2037b8631b5SMike Christie #define iscsi_dev_to_conn(_dev) \ 2047b8631b5SMike Christie container_of(_dev, struct iscsi_cls_conn, dev) 2057b8631b5SMike Christie 2063128c6c7SMike Christie #define transport_class_to_conn(_cdev) \ 2073128c6c7SMike Christie iscsi_dev_to_conn(_cdev->parent) 2083128c6c7SMike Christie 2096eabafbeSMike Christie #define iscsi_conn_to_session(_conn) \ 2106eabafbeSMike Christie iscsi_dev_to_session(_conn->dev.parent) 2116eabafbeSMike Christie 2126eabafbeSMike Christie /* iscsi class session state */ 2136eabafbeSMike Christie enum { 2146eabafbeSMike Christie ISCSI_SESSION_LOGGED_IN, 2156eabafbeSMike Christie ISCSI_SESSION_FAILED, 2166eabafbeSMike Christie ISCSI_SESSION_FREE, 2176eabafbeSMike Christie }; 2187996a778SMike Christie 2197970634bSMike Christie #define ISCSI_MAX_TARGET -1 2207970634bSMike Christie 2217b8631b5SMike Christie struct iscsi_cls_session { 2227b7232f3SMike Christie struct list_head sess_list; /* item in session_list */ 2237b8631b5SMike Christie struct iscsi_transport *transport; 2246eabafbeSMike Christie spinlock_t lock; 22545ab33b6SMike Christie struct work_struct block_work; 22645ab33b6SMike Christie struct work_struct unblock_work; 227bd976f62SMike Christie struct work_struct scan_work; 228bd976f62SMike Christie struct work_struct unbind_work; 229cc6b32eeSFrank Mayhar struct work_struct destroy_work; 230fd7255f5SMike Christie 23130a6c652SMike Christie /* recovery fields */ 23230a6c652SMike Christie int recovery_tmo; 2339c8108a4SChris Leech bool recovery_tmo_sysfs_override; 234c4028958SDavid Howells struct delayed_work recovery_work; 23530a6c652SMike Christie 2367970634bSMike Christie unsigned int target_id; 2378d4a690cSMike Christie bool ida_used; 23830a6c652SMike Christie 2390c70d84bSMike Christie /* 2400c70d84bSMike Christie * pid of userspace process that created session or -1 if 2410c70d84bSMike Christie * created by the kernel. 2420c70d84bSMike Christie */ 2430c70d84bSMike Christie pid_t creator; 2446eabafbeSMike Christie int state; 245b5c7a12dSMike Christie int sid; /* session id */ 246b5c7a12dSMike Christie void *dd_data; /* LLD private data */ 2477b8631b5SMike Christie struct device dev; /* sysfs transport/container device */ 2487b8631b5SMike Christie }; 2497b8631b5SMike Christie 2507b8631b5SMike Christie #define iscsi_dev_to_session(_dev) \ 2517b8631b5SMike Christie container_of(_dev, struct iscsi_cls_session, dev) 2527b8631b5SMike Christie 2531d063c17SMike Christie #define transport_class_to_session(_cdev) \ 2541d063c17SMike Christie iscsi_dev_to_session(_cdev->parent) 2551d063c17SMike Christie 2567b8631b5SMike Christie #define iscsi_session_to_shost(_session) \ 2577b8631b5SMike Christie dev_to_shost(_session->dev.parent) 2587b8631b5SMike Christie 2598434aa8bSMike Christie #define starget_to_session(_stgt) \ 2608434aa8bSMike Christie iscsi_dev_to_session(_stgt->dev.parent) 2618434aa8bSMike Christie 26232c6e1b9SMike Christie struct iscsi_cls_host { 2638aae18adSMike Christie atomic_t nr_scans; 26430a6c652SMike Christie struct mutex mutex; 26590eeb01aSMike Christie struct request_queue *bsg_q; 266aeddde29SVikas Chaudhary uint32_t port_speed; 267aeddde29SVikas Chaudhary uint32_t port_state; 26830a6c652SMike Christie }; 26930a6c652SMike Christie 27090eeb01aSMike Christie #define iscsi_job_to_shost(_job) \ 27190eeb01aSMike Christie dev_to_shost(_job->dev) 27290eeb01aSMike Christie 273a4804cd6SMike Christie extern void iscsi_host_for_each_session(struct Scsi_Host *shost, 274a4804cd6SMike Christie void (*fn)(struct iscsi_cls_session *)); 275a4804cd6SMike Christie 276d82ff9beSMike Christie struct iscsi_endpoint { 277d82ff9beSMike Christie void *dd_data; /* LLD private data */ 278d82ff9beSMike Christie struct device dev; 27921536062SMike Christie uint64_t id; 28022a39fbbSMike Christie struct iscsi_cls_conn *conn; 281d82ff9beSMike Christie }; 282a4804cd6SMike Christie 2838d07913dSMike Christie struct iscsi_iface { 2848d07913dSMike Christie struct device dev; 2858d07913dSMike Christie struct iscsi_transport *transport; 2868d07913dSMike Christie uint32_t iface_type; /* IPv4 or IPv6 */ 2878d07913dSMike Christie uint32_t iface_num; /* iface number, 0 - n */ 2888d07913dSMike Christie void *dd_data; /* LLD private data */ 2898d07913dSMike Christie }; 2908d07913dSMike Christie 2918d07913dSMike Christie #define iscsi_dev_to_iface(_dev) \ 2928d07913dSMike Christie container_of(_dev, struct iscsi_iface, dev) 2938d07913dSMike Christie 2948d07913dSMike Christie #define iscsi_iface_to_shost(_iface) \ 2958d07913dSMike Christie dev_to_shost(_iface->dev.parent) 2968d07913dSMike Christie 297c6a4bb2eSAdheer Chandravanshi 298c6a4bb2eSAdheer Chandravanshi struct iscsi_bus_flash_conn { 299c6a4bb2eSAdheer Chandravanshi struct list_head conn_list; /* item in connlist */ 300c6a4bb2eSAdheer Chandravanshi void *dd_data; /* LLD private data */ 301c6a4bb2eSAdheer Chandravanshi struct iscsi_transport *transport; 302c6a4bb2eSAdheer Chandravanshi struct device dev; /* sysfs transport/container device */ 303c6a4bb2eSAdheer Chandravanshi /* iscsi connection parameters */ 304c6a4bb2eSAdheer Chandravanshi uint32_t exp_statsn; 305c6a4bb2eSAdheer Chandravanshi uint32_t statsn; 306c6a4bb2eSAdheer Chandravanshi unsigned max_recv_dlength; /* initiator_max_recv_dsl*/ 307c6a4bb2eSAdheer Chandravanshi unsigned max_xmit_dlength; /* target_max_recv_dsl */ 308c6a4bb2eSAdheer Chandravanshi unsigned max_segment_size; 309c6a4bb2eSAdheer Chandravanshi unsigned tcp_xmit_wsf; 310c6a4bb2eSAdheer Chandravanshi unsigned tcp_recv_wsf; 311c6a4bb2eSAdheer Chandravanshi int hdrdgst_en; 312c6a4bb2eSAdheer Chandravanshi int datadgst_en; 313c6a4bb2eSAdheer Chandravanshi int port; 314c6a4bb2eSAdheer Chandravanshi char *ipaddress; 315c6a4bb2eSAdheer Chandravanshi char *link_local_ipv6_addr; 316c6a4bb2eSAdheer Chandravanshi char *redirect_ipaddr; 317c6a4bb2eSAdheer Chandravanshi uint16_t keepalive_timeout; 318c6a4bb2eSAdheer Chandravanshi uint16_t local_port; 319c6a4bb2eSAdheer Chandravanshi uint8_t snack_req_en; 320c6a4bb2eSAdheer Chandravanshi /* tcp timestamp negotiation status */ 321c6a4bb2eSAdheer Chandravanshi uint8_t tcp_timestamp_stat; 322c6a4bb2eSAdheer Chandravanshi uint8_t tcp_nagle_disable; 323c6a4bb2eSAdheer Chandravanshi /* tcp window scale factor */ 324c6a4bb2eSAdheer Chandravanshi uint8_t tcp_wsf_disable; 325c6a4bb2eSAdheer Chandravanshi uint8_t tcp_timer_scale; 326c6a4bb2eSAdheer Chandravanshi uint8_t tcp_timestamp_en; 327c6a4bb2eSAdheer Chandravanshi uint8_t ipv4_tos; 328c6a4bb2eSAdheer Chandravanshi uint8_t ipv6_traffic_class; 329c6a4bb2eSAdheer Chandravanshi uint8_t ipv6_flow_label; 330c6a4bb2eSAdheer Chandravanshi uint8_t fragment_disable; 331c6a4bb2eSAdheer Chandravanshi /* Link local IPv6 address is assigned by firmware or driver */ 332c6a4bb2eSAdheer Chandravanshi uint8_t is_fw_assigned_ipv6; 333c6a4bb2eSAdheer Chandravanshi }; 334c6a4bb2eSAdheer Chandravanshi 335c6a4bb2eSAdheer Chandravanshi #define iscsi_dev_to_flash_conn(_dev) \ 336c6a4bb2eSAdheer Chandravanshi container_of(_dev, struct iscsi_bus_flash_conn, dev) 337c6a4bb2eSAdheer Chandravanshi 338c6a4bb2eSAdheer Chandravanshi #define iscsi_flash_conn_to_flash_session(_conn) \ 339c6a4bb2eSAdheer Chandravanshi iscsi_dev_to_flash_session(_conn->dev.parent) 340c6a4bb2eSAdheer Chandravanshi 341c6a4bb2eSAdheer Chandravanshi #define ISID_SIZE 6 342c6a4bb2eSAdheer Chandravanshi 343c6a4bb2eSAdheer Chandravanshi struct iscsi_bus_flash_session { 344c6a4bb2eSAdheer Chandravanshi struct list_head sess_list; /* item in session_list */ 345c6a4bb2eSAdheer Chandravanshi struct iscsi_transport *transport; 346c6a4bb2eSAdheer Chandravanshi unsigned int target_id; 347c6a4bb2eSAdheer Chandravanshi int flash_state; /* persistent or non-persistent */ 348c6a4bb2eSAdheer Chandravanshi void *dd_data; /* LLD private data */ 349c6a4bb2eSAdheer Chandravanshi struct device dev; /* sysfs transport/container device */ 350c6a4bb2eSAdheer Chandravanshi /* iscsi session parameters */ 351c6a4bb2eSAdheer Chandravanshi unsigned first_burst; 352c6a4bb2eSAdheer Chandravanshi unsigned max_burst; 353c6a4bb2eSAdheer Chandravanshi unsigned short max_r2t; 354c6a4bb2eSAdheer Chandravanshi int default_taskmgmt_timeout; 355c6a4bb2eSAdheer Chandravanshi int initial_r2t_en; 356c6a4bb2eSAdheer Chandravanshi int imm_data_en; 357c6a4bb2eSAdheer Chandravanshi int time2wait; 358c6a4bb2eSAdheer Chandravanshi int time2retain; 359c6a4bb2eSAdheer Chandravanshi int pdu_inorder_en; 360c6a4bb2eSAdheer Chandravanshi int dataseq_inorder_en; 361c6a4bb2eSAdheer Chandravanshi int erl; 362c6a4bb2eSAdheer Chandravanshi int tpgt; 363c6a4bb2eSAdheer Chandravanshi char *username; 364c6a4bb2eSAdheer Chandravanshi char *username_in; 365c6a4bb2eSAdheer Chandravanshi char *password; 366c6a4bb2eSAdheer Chandravanshi char *password_in; 367c6a4bb2eSAdheer Chandravanshi char *targetname; 368c6a4bb2eSAdheer Chandravanshi char *targetalias; 369c6a4bb2eSAdheer Chandravanshi char *portal_type; 370c6a4bb2eSAdheer Chandravanshi uint16_t tsid; 371c6a4bb2eSAdheer Chandravanshi uint16_t chap_in_idx; 372c6a4bb2eSAdheer Chandravanshi uint16_t chap_out_idx; 373c6a4bb2eSAdheer Chandravanshi /* index of iSCSI discovery session if the entry is 374c6a4bb2eSAdheer Chandravanshi * discovered by iSCSI discovery session 375c6a4bb2eSAdheer Chandravanshi */ 376c6a4bb2eSAdheer Chandravanshi uint16_t discovery_parent_idx; 377c6a4bb2eSAdheer Chandravanshi /* indicates if discovery was done through iSNS discovery service 378c6a4bb2eSAdheer Chandravanshi * or through sendTarget */ 379c6a4bb2eSAdheer Chandravanshi uint16_t discovery_parent_type; 380c6a4bb2eSAdheer Chandravanshi /* Firmware auto sendtarget discovery disable */ 381c6a4bb2eSAdheer Chandravanshi uint8_t auto_snd_tgt_disable; 382c6a4bb2eSAdheer Chandravanshi uint8_t discovery_sess; 383c6a4bb2eSAdheer Chandravanshi /* indicates if this flashnode entry is enabled or disabled */ 384c6a4bb2eSAdheer Chandravanshi uint8_t entry_state; 385c6a4bb2eSAdheer Chandravanshi uint8_t chap_auth_en; 386c6a4bb2eSAdheer Chandravanshi /* enables firmware to auto logout the discovery session on discovery 387c6a4bb2eSAdheer Chandravanshi * completion 388c6a4bb2eSAdheer Chandravanshi */ 389c6a4bb2eSAdheer Chandravanshi uint8_t discovery_logout_en; 390c6a4bb2eSAdheer Chandravanshi uint8_t bidi_chap_en; 391c6a4bb2eSAdheer Chandravanshi /* makes authentication for discovery session optional */ 392c6a4bb2eSAdheer Chandravanshi uint8_t discovery_auth_optional; 393c6a4bb2eSAdheer Chandravanshi uint8_t isid[ISID_SIZE]; 394c6a4bb2eSAdheer Chandravanshi uint8_t is_boot_target; 395c6a4bb2eSAdheer Chandravanshi }; 396c6a4bb2eSAdheer Chandravanshi 397c6a4bb2eSAdheer Chandravanshi #define iscsi_dev_to_flash_session(_dev) \ 398c6a4bb2eSAdheer Chandravanshi container_of(_dev, struct iscsi_bus_flash_session, dev) 399c6a4bb2eSAdheer Chandravanshi 400c6a4bb2eSAdheer Chandravanshi #define iscsi_flash_session_to_shost(_session) \ 401c6a4bb2eSAdheer Chandravanshi dev_to_shost(_session->dev.parent) 402c6a4bb2eSAdheer Chandravanshi 4037b8631b5SMike Christie /* 4047b8631b5SMike Christie * session and connection functions that can be used by HW iSCSI LLDs 4057b8631b5SMike Christie */ 406322d739dSMike Christie #define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \ 407322d739dSMike Christie dev_printk(prefix, &(_cls_session)->dev, fmt, ##a) 408322d739dSMike Christie 409322d739dSMike Christie #define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \ 410322d739dSMike Christie dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a) 411322d739dSMike Christie 4126eabafbeSMike Christie extern int iscsi_session_chkready(struct iscsi_cls_session *session); 41317fa575eSManish Rangankar extern int iscsi_is_session_online(struct iscsi_cls_session *session); 4148434aa8bSMike Christie extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost, 4155d91e209SMike Christie struct iscsi_transport *transport, int dd_size); 4166a8a0d36SMike Christie extern int iscsi_add_session(struct iscsi_cls_session *session, 4176a8a0d36SMike Christie unsigned int target_id); 41826974789SMike Christie extern int iscsi_session_event(struct iscsi_cls_session *session, 41926974789SMike Christie enum iscsi_uevent_e event); 4207b8631b5SMike Christie extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost, 4216a8a0d36SMike Christie struct iscsi_transport *t, 4225d91e209SMike Christie int dd_size, 4236a8a0d36SMike Christie unsigned int target_id); 4248434aa8bSMike Christie extern void iscsi_remove_session(struct iscsi_cls_session *session); 4258434aa8bSMike Christie extern void iscsi_free_session(struct iscsi_cls_session *session); 4267b8631b5SMike Christie extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess, 4275d91e209SMike Christie int dd_size, uint32_t cid); 4287b8631b5SMike Christie extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn); 42930a6c652SMike Christie extern void iscsi_unblock_session(struct iscsi_cls_session *session); 43030a6c652SMike Christie extern void iscsi_block_session(struct iscsi_cls_session *session); 4318aae18adSMike Christie extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time); 432d82ff9beSMike Christie extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size); 433d82ff9beSMike Christie extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep); 434d82ff9beSMike Christie extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle); 435c01be6dcSMike Christie extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd); 4368d07913dSMike Christie extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost, 4378d07913dSMike Christie struct iscsi_transport *t, 4388d07913dSMike Christie uint32_t iface_type, 4398d07913dSMike Christie uint32_t iface_num, int dd_size); 4408d07913dSMike Christie extern void iscsi_destroy_iface(struct iscsi_iface *iface); 4418d07913dSMike Christie extern struct iscsi_iface *iscsi_lookup_iface(int handle); 442aeddde29SVikas Chaudhary extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost); 443aeddde29SVikas Chaudhary extern char *iscsi_get_port_state_name(struct Scsi_Host *shost); 4446260a5d2SNilesh Javali extern int iscsi_is_session_dev(const struct device *dev); 44553cb8a1fSMike Christie 446c6a4bb2eSAdheer Chandravanshi extern char *iscsi_get_discovery_parent_name(int parent_type); 447c6a4bb2eSAdheer Chandravanshi extern struct device * 448c6a4bb2eSAdheer Chandravanshi iscsi_find_flashnode(struct Scsi_Host *shost, void *data, 449c6a4bb2eSAdheer Chandravanshi int (*fn)(struct device *dev, void *data)); 450c6a4bb2eSAdheer Chandravanshi 451c6a4bb2eSAdheer Chandravanshi extern struct iscsi_bus_flash_session * 452c6a4bb2eSAdheer Chandravanshi iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index, 453c6a4bb2eSAdheer Chandravanshi struct iscsi_transport *transport, int dd_size); 454c6a4bb2eSAdheer Chandravanshi 455c6a4bb2eSAdheer Chandravanshi extern struct iscsi_bus_flash_conn * 456c6a4bb2eSAdheer Chandravanshi iscsi_create_flashnode_conn(struct Scsi_Host *shost, 457c6a4bb2eSAdheer Chandravanshi struct iscsi_bus_flash_session *fnode_sess, 458c6a4bb2eSAdheer Chandravanshi struct iscsi_transport *transport, int dd_size); 459c6a4bb2eSAdheer Chandravanshi 460c6a4bb2eSAdheer Chandravanshi extern void 461c6a4bb2eSAdheer Chandravanshi iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess); 462c6a4bb2eSAdheer Chandravanshi 463c6a4bb2eSAdheer Chandravanshi extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost); 464c6a4bb2eSAdheer Chandravanshi extern int iscsi_flashnode_bus_match(struct device *dev, 465c6a4bb2eSAdheer Chandravanshi struct device_driver *drv); 466c6a4bb2eSAdheer Chandravanshi extern struct device * 467c6a4bb2eSAdheer Chandravanshi iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data, 468c6a4bb2eSAdheer Chandravanshi int (*fn)(struct device *dev, void *data)); 469c6a4bb2eSAdheer Chandravanshi extern struct device * 4708526cb11SMike Christie iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess); 4718526cb11SMike Christie 4723e0f65b3SHarish Zunjarrao extern char * 4733e0f65b3SHarish Zunjarrao iscsi_get_ipaddress_state_name(enum iscsi_ipaddress_state port_state); 4743e0f65b3SHarish Zunjarrao extern char *iscsi_get_router_state_name(enum iscsi_router_state router_state); 4751da177e4SLinus Torvalds #endif 476