11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * iSCSI transport class definitions 31da177e4SLinus Torvalds * 41da177e4SLinus Torvalds * Copyright (C) IBM Corporation, 2004 57996a778SMike Christie * Copyright (C) Mike Christie, 2004 - 2006 639e84790SAlex Aizman * Copyright (C) Dmitry Yusupov, 2004 - 2005 739e84790SAlex Aizman * Copyright (C) Alex Aizman, 2004 - 2005 81da177e4SLinus Torvalds * 91da177e4SLinus Torvalds * This program is free software; you can redistribute it and/or modify 101da177e4SLinus Torvalds * it under the terms of the GNU General Public License as published by 111da177e4SLinus Torvalds * the Free Software Foundation; either version 2 of the License, or 121da177e4SLinus Torvalds * (at your option) any later version. 131da177e4SLinus Torvalds * 141da177e4SLinus Torvalds * This program is distributed in the hope that it will be useful, 151da177e4SLinus Torvalds * but WITHOUT ANY WARRANTY; without even the implied warranty of 161da177e4SLinus Torvalds * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 171da177e4SLinus Torvalds * GNU General Public License for more details. 181da177e4SLinus Torvalds * 191da177e4SLinus Torvalds * You should have received a copy of the GNU General Public License 201da177e4SLinus Torvalds * along with this program; if not, write to the Free Software 211da177e4SLinus Torvalds * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 221da177e4SLinus Torvalds */ 231da177e4SLinus Torvalds #ifndef SCSI_TRANSPORT_ISCSI_H 241da177e4SLinus Torvalds #define SCSI_TRANSPORT_ISCSI_H 251da177e4SLinus Torvalds 267b8631b5SMike Christie #include <linux/device.h> 27d773c082SMichael S. Tsirkin #include <linux/list.h> 28d773c082SMichael S. Tsirkin #include <linux/mutex.h> 2939e84790SAlex Aizman #include <scsi/iscsi_if.h> 301da177e4SLinus Torvalds 317b8631b5SMike Christie struct scsi_transport_template; 327996a778SMike Christie struct iscsi_transport; 33d82ff9beSMike Christie struct iscsi_endpoint; 347b8631b5SMike Christie struct Scsi_Host; 35c01be6dcSMike Christie struct scsi_cmnd; 367b8631b5SMike Christie struct iscsi_cls_conn; 377996a778SMike Christie struct iscsi_conn; 389c19a7d0SMike Christie struct iscsi_task; 39a54a52caSMike Christie struct sockaddr; 408d07913dSMike Christie struct iscsi_iface; 4190eeb01aSMike Christie struct bsg_job; 427b8631b5SMike Christie 4339e84790SAlex Aizman /** 4439e84790SAlex Aizman * struct iscsi_transport - iSCSI Transport template 4539e84790SAlex Aizman * 4639e84790SAlex Aizman * @name: transport name 4739e84790SAlex Aizman * @caps: iSCSI Data-Path capabilities 4839e84790SAlex Aizman * @create_session: create new iSCSI session object 4939e84790SAlex Aizman * @destroy_session: destroy existing iSCSI session object 5039e84790SAlex Aizman * @create_conn: create new iSCSI connection 5139e84790SAlex Aizman * @bind_conn: associate this connection with existing iSCSI session 5239e84790SAlex Aizman * and specified transport descriptor 5339e84790SAlex Aizman * @destroy_conn: destroy inactive iSCSI connection 54a54a52caSMike Christie * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA 55a54a52caSMike Christie * when param is not supported, and a -Exx value on other 56a54a52caSMike Christie * error. 57a54a52caSMike Christie * @get_param get iSCSI parameter. Must return number of bytes 58a54a52caSMike Christie * copied to buffer on success, -ENODATA when param 59a54a52caSMike Christie * is not supported, and a -Exx value on other error 6039e84790SAlex Aizman * @start_conn: set connection to be operational 6139e84790SAlex Aizman * @stop_conn: suspend/recover/terminate connection 6239e84790SAlex Aizman * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text. 637996a778SMike Christie * @session_recovery_timedout: notify LLD a block during recovery timed out 643e5c28adSMike Christie * @init_task: Initialize a iscsi_task and any internal structs. 653e5c28adSMike Christie * When offloading the data path, this is called from 663e5c28adSMike Christie * queuecommand with the session lock, or from the 673e5c28adSMike Christie * iscsi_conn_send_pdu context with the session lock. 683e5c28adSMike Christie * When not offloading the data path, this is called 693e5c28adSMike Christie * from the scsi work queue without the session lock. 703e5c28adSMike Christie * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the 713219e529SMike Christie * the number of bytes transferred on success, and -Exyz 723e5c28adSMike Christie * value on error. When offloading the data path, this 733e5c28adSMike Christie * is called from queuecommand with the session lock, or 743e5c28adSMike Christie * from the iscsi_conn_send_pdu context with the session 753e5c28adSMike Christie * lock. When not offloading the data path, this is called 763e5c28adSMike Christie * from the scsi work queue without the session lock. 773e5c28adSMike Christie * @cleanup_task: requests LLD to fail task. Called with session lock 783e5c28adSMike Christie * and after the connection has been suspended and 793e5c28adSMike Christie * terminated during recovery. If called 807996a778SMike Christie * from abort task then connection is not suspended 817996a778SMike Christie * or terminated but sk_callback_lock is held 8239e84790SAlex Aizman * 8339e84790SAlex Aizman * Template API provided by iSCSI Transport 8439e84790SAlex Aizman */ 8539e84790SAlex Aizman struct iscsi_transport { 8639e84790SAlex Aizman struct module *owner; 8739e84790SAlex Aizman char *name; 8839e84790SAlex Aizman unsigned int caps; 898d07913dSMike Christie 90d82ff9beSMike Christie struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep, 9175613521SMike Christie uint16_t cmds_max, uint16_t qdepth, 925e7facb7SMike Christie uint32_t sn); 937b7232f3SMike Christie void (*destroy_session) (struct iscsi_cls_session *session); 947b7232f3SMike Christie struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess, 957b8631b5SMike Christie uint32_t cid); 967b7232f3SMike Christie int (*bind_conn) (struct iscsi_cls_session *session, 977b7232f3SMike Christie struct iscsi_cls_conn *cls_conn, 98264faaaaSOr Gerlitz uint64_t transport_eph, int is_leading); 997b7232f3SMike Christie int (*start_conn) (struct iscsi_cls_conn *conn); 1007b7232f3SMike Christie void (*stop_conn) (struct iscsi_cls_conn *conn, int flag); 1017b8631b5SMike Christie void (*destroy_conn) (struct iscsi_cls_conn *conn); 1027b7232f3SMike Christie int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param, 103a54a52caSMike Christie char *buf, int buflen); 104289324b0SMike Christie int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param, 105289324b0SMike Christie char *buf); 1067b7232f3SMike Christie int (*get_conn_param) (struct iscsi_cls_conn *conn, 107fd7255f5SMike Christie enum iscsi_param param, char *buf); 108a54a52caSMike Christie int (*get_session_param) (struct iscsi_cls_session *session, 109fd7255f5SMike Christie enum iscsi_param param, char *buf); 1101819dc81SMike Christie int (*get_host_param) (struct Scsi_Host *shost, 1111819dc81SMike Christie enum iscsi_host_param param, char *buf); 1121d9bf13aSMike Christie int (*set_host_param) (struct Scsi_Host *shost, 1131d9bf13aSMike Christie enum iscsi_host_param param, char *buf, 1141d9bf13aSMike Christie int buflen); 1157b7232f3SMike Christie int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, 11639e84790SAlex Aizman char *data, uint32_t data_size); 1177b7232f3SMike Christie void (*get_stats) (struct iscsi_cls_conn *conn, 1187b7232f3SMike Christie struct iscsi_stats *stats); 119577577daSMike Christie 1209c19a7d0SMike Christie int (*init_task) (struct iscsi_task *task); 1219c19a7d0SMike Christie int (*xmit_task) (struct iscsi_task *task); 122577577daSMike Christie void (*cleanup_task) (struct iscsi_task *task); 123577577daSMike Christie 1242ff79d52SMike Christie int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode); 125577577daSMike Christie int (*xmit_pdu) (struct iscsi_task *task); 126577577daSMike Christie int (*init_pdu) (struct iscsi_task *task, unsigned int offset, 127577577daSMike Christie unsigned int count); 128262ef636SMike Christie void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt, 129262ef636SMike Christie int *index, int *age); 130262ef636SMike Christie 13130a6c652SMike Christie void (*session_recovery_timedout) (struct iscsi_cls_session *session); 13210eb0f01SMike Christie struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost, 13310eb0f01SMike Christie struct sockaddr *dst_addr, 134d82ff9beSMike Christie int non_blocking); 135d82ff9beSMike Christie int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms); 136d82ff9beSMike Christie void (*ep_disconnect) (struct iscsi_endpoint *ep); 1372174a04eSMike Christie int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type, 13801cb225dSMike Christie uint32_t enable, struct sockaddr *dst_addr); 13943514774SMichael Chan int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params); 14000c31889SMike Christie int (*set_iface_param) (struct Scsi_Host *shost, void *data, 14100c31889SMike Christie uint32_t len); 1428d07913dSMike Christie int (*get_iface_param) (struct iscsi_iface *iface, 1438d07913dSMike Christie enum iscsi_param_type param_type, 1448d07913dSMike Christie int param, char *buf); 145587a1f16SAl Viro umode_t (*attr_is_visible)(int param_type, int param); 14690eeb01aSMike Christie int (*bsg_request)(struct bsg_job *job); 147ac20c7bfSVikas Chaudhary int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num, 148ac20c7bfSVikas Chaudhary uint32_t iface_type, uint32_t payload_size, 149ac20c7bfSVikas Chaudhary uint32_t pid, struct sockaddr *dst_addr); 1501da177e4SLinus Torvalds }; 1511da177e4SLinus Torvalds 1521da177e4SLinus Torvalds /* 15339e84790SAlex Aizman * transport registration upcalls 1541da177e4SLinus Torvalds */ 1557b8631b5SMike Christie extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt); 15639e84790SAlex Aizman extern int iscsi_unregister_transport(struct iscsi_transport *tt); 1571da177e4SLinus Torvalds 1581da177e4SLinus Torvalds /* 15939e84790SAlex Aizman * control plane upcalls 1601da177e4SLinus Torvalds */ 161e5bd7b54SMike Christie extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn, 162e5bd7b54SMike Christie enum iscsi_err error); 16317fa575eSManish Rangankar extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn, 16417fa575eSManish Rangankar enum iscsi_conn_state state); 1657b7232f3SMike Christie extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, 16639e84790SAlex Aizman char *data, uint32_t data_size); 1671da177e4SLinus Torvalds 16843514774SMichael Chan extern int iscsi_offload_mesg(struct Scsi_Host *shost, 16943514774SMichael Chan struct iscsi_transport *transport, uint32_t type, 17043514774SMichael Chan char *data, uint16_t data_size); 17143514774SMichael Chan 172a11e2545SVikas Chaudhary extern void iscsi_post_host_event(uint32_t host_no, 173a11e2545SVikas Chaudhary struct iscsi_transport *transport, 174a11e2545SVikas Chaudhary enum iscsi_host_event_code code, 175a11e2545SVikas Chaudhary uint32_t data_size, 176a11e2545SVikas Chaudhary uint8_t *data); 177a11e2545SVikas Chaudhary 178ac20c7bfSVikas Chaudhary extern void iscsi_ping_comp_event(uint32_t host_no, 179ac20c7bfSVikas Chaudhary struct iscsi_transport *transport, 180ac20c7bfSVikas Chaudhary uint32_t status, uint32_t pid, 181ac20c7bfSVikas Chaudhary uint32_t data_size, uint8_t *data); 182ac20c7bfSVikas Chaudhary 1837b8631b5SMike Christie struct iscsi_cls_conn { 1847b8631b5SMike Christie struct list_head conn_list; /* item in connlist */ 1857b8631b5SMike Christie void *dd_data; /* LLD private data */ 1867b8631b5SMike Christie struct iscsi_transport *transport; 187b5c7a12dSMike Christie uint32_t cid; /* connection id */ 18822a39fbbSMike Christie struct mutex ep_mutex; 18922a39fbbSMike Christie struct iscsi_endpoint *ep; 190fd7255f5SMike Christie 1917b8631b5SMike Christie struct device dev; /* sysfs transport/container device */ 1927b8631b5SMike Christie }; 1937b8631b5SMike Christie 1947b8631b5SMike Christie #define iscsi_dev_to_conn(_dev) \ 1957b8631b5SMike Christie container_of(_dev, struct iscsi_cls_conn, dev) 1967b8631b5SMike Christie 1973128c6c7SMike Christie #define transport_class_to_conn(_cdev) \ 1983128c6c7SMike Christie iscsi_dev_to_conn(_cdev->parent) 1993128c6c7SMike Christie 2006eabafbeSMike Christie #define iscsi_conn_to_session(_conn) \ 2016eabafbeSMike Christie iscsi_dev_to_session(_conn->dev.parent) 2026eabafbeSMike Christie 2036eabafbeSMike Christie /* iscsi class session state */ 2046eabafbeSMike Christie enum { 2056eabafbeSMike Christie ISCSI_SESSION_LOGGED_IN, 2066eabafbeSMike Christie ISCSI_SESSION_FAILED, 2076eabafbeSMike Christie ISCSI_SESSION_FREE, 2086eabafbeSMike Christie }; 2097996a778SMike Christie 2107970634bSMike Christie #define ISCSI_MAX_TARGET -1 2117970634bSMike Christie 2127b8631b5SMike Christie struct iscsi_cls_session { 2137b7232f3SMike Christie struct list_head sess_list; /* item in session_list */ 2147b8631b5SMike Christie struct iscsi_transport *transport; 2156eabafbeSMike Christie spinlock_t lock; 21645ab33b6SMike Christie struct work_struct block_work; 21745ab33b6SMike Christie struct work_struct unblock_work; 218bd976f62SMike Christie struct work_struct scan_work; 219bd976f62SMike Christie struct work_struct unbind_work; 220fd7255f5SMike Christie 22130a6c652SMike Christie /* recovery fields */ 22230a6c652SMike Christie int recovery_tmo; 223c4028958SDavid Howells struct delayed_work recovery_work; 22430a6c652SMike Christie 2257970634bSMike Christie unsigned int target_id; 2268d4a690cSMike Christie bool ida_used; 22730a6c652SMike Christie 2280c70d84bSMike Christie /* 2290c70d84bSMike Christie * pid of userspace process that created session or -1 if 2300c70d84bSMike Christie * created by the kernel. 2310c70d84bSMike Christie */ 2320c70d84bSMike Christie pid_t creator; 2336eabafbeSMike Christie int state; 234b5c7a12dSMike Christie int sid; /* session id */ 235b5c7a12dSMike Christie void *dd_data; /* LLD private data */ 2367b8631b5SMike Christie struct device dev; /* sysfs transport/container device */ 2377b8631b5SMike Christie }; 2387b8631b5SMike Christie 2397b8631b5SMike Christie #define iscsi_dev_to_session(_dev) \ 2407b8631b5SMike Christie container_of(_dev, struct iscsi_cls_session, dev) 2417b8631b5SMike Christie 2421d063c17SMike Christie #define transport_class_to_session(_cdev) \ 2431d063c17SMike Christie iscsi_dev_to_session(_cdev->parent) 2441d063c17SMike Christie 2457b8631b5SMike Christie #define iscsi_session_to_shost(_session) \ 2467b8631b5SMike Christie dev_to_shost(_session->dev.parent) 2477b8631b5SMike Christie 2488434aa8bSMike Christie #define starget_to_session(_stgt) \ 2498434aa8bSMike Christie iscsi_dev_to_session(_stgt->dev.parent) 2508434aa8bSMike Christie 25132c6e1b9SMike Christie struct iscsi_cls_host { 2528aae18adSMike Christie atomic_t nr_scans; 25330a6c652SMike Christie struct mutex mutex; 25490eeb01aSMike Christie struct request_queue *bsg_q; 255aeddde29SVikas Chaudhary uint32_t port_speed; 256aeddde29SVikas Chaudhary uint32_t port_state; 25730a6c652SMike Christie }; 25830a6c652SMike Christie 25990eeb01aSMike Christie #define iscsi_job_to_shost(_job) \ 26090eeb01aSMike Christie dev_to_shost(_job->dev) 26190eeb01aSMike Christie 262a4804cd6SMike Christie extern void iscsi_host_for_each_session(struct Scsi_Host *shost, 263a4804cd6SMike Christie void (*fn)(struct iscsi_cls_session *)); 264a4804cd6SMike Christie 265d82ff9beSMike Christie struct iscsi_endpoint { 266d82ff9beSMike Christie void *dd_data; /* LLD private data */ 267d82ff9beSMike Christie struct device dev; 26821536062SMike Christie uint64_t id; 26922a39fbbSMike Christie struct iscsi_cls_conn *conn; 270d82ff9beSMike Christie }; 271a4804cd6SMike Christie 2728d07913dSMike Christie struct iscsi_iface { 2738d07913dSMike Christie struct device dev; 2748d07913dSMike Christie struct iscsi_transport *transport; 2758d07913dSMike Christie uint32_t iface_type; /* IPv4 or IPv6 */ 2768d07913dSMike Christie uint32_t iface_num; /* iface number, 0 - n */ 2778d07913dSMike Christie void *dd_data; /* LLD private data */ 2788d07913dSMike Christie }; 2798d07913dSMike Christie 2808d07913dSMike Christie #define iscsi_dev_to_iface(_dev) \ 2818d07913dSMike Christie container_of(_dev, struct iscsi_iface, dev) 2828d07913dSMike Christie 2838d07913dSMike Christie #define iscsi_iface_to_shost(_iface) \ 2848d07913dSMike Christie dev_to_shost(_iface->dev.parent) 2858d07913dSMike Christie 2867b8631b5SMike Christie /* 2877b8631b5SMike Christie * session and connection functions that can be used by HW iSCSI LLDs 2887b8631b5SMike Christie */ 289322d739dSMike Christie #define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \ 290322d739dSMike Christie dev_printk(prefix, &(_cls_session)->dev, fmt, ##a) 291322d739dSMike Christie 292322d739dSMike Christie #define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \ 293322d739dSMike Christie dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a) 294322d739dSMike Christie 2956eabafbeSMike Christie extern int iscsi_session_chkready(struct iscsi_cls_session *session); 29617fa575eSManish Rangankar extern int iscsi_is_session_online(struct iscsi_cls_session *session); 2978434aa8bSMike Christie extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost, 2985d91e209SMike Christie struct iscsi_transport *transport, int dd_size); 2996a8a0d36SMike Christie extern int iscsi_add_session(struct iscsi_cls_session *session, 3006a8a0d36SMike Christie unsigned int target_id); 30126974789SMike Christie extern int iscsi_session_event(struct iscsi_cls_session *session, 30226974789SMike Christie enum iscsi_uevent_e event); 3037b8631b5SMike Christie extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost, 3046a8a0d36SMike Christie struct iscsi_transport *t, 3055d91e209SMike Christie int dd_size, 3066a8a0d36SMike Christie unsigned int target_id); 3078434aa8bSMike Christie extern void iscsi_remove_session(struct iscsi_cls_session *session); 3088434aa8bSMike Christie extern void iscsi_free_session(struct iscsi_cls_session *session); 3097b8631b5SMike Christie extern int iscsi_destroy_session(struct iscsi_cls_session *session); 3107b8631b5SMike Christie extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess, 3115d91e209SMike Christie int dd_size, uint32_t cid); 3127b8631b5SMike Christie extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn); 31330a6c652SMike Christie extern void iscsi_unblock_session(struct iscsi_cls_session *session); 31430a6c652SMike Christie extern void iscsi_block_session(struct iscsi_cls_session *session); 3158aae18adSMike Christie extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time); 316d82ff9beSMike Christie extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size); 317d82ff9beSMike Christie extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep); 318d82ff9beSMike Christie extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle); 319c01be6dcSMike Christie extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd); 3208d07913dSMike Christie extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost, 3218d07913dSMike Christie struct iscsi_transport *t, 3228d07913dSMike Christie uint32_t iface_type, 3238d07913dSMike Christie uint32_t iface_num, int dd_size); 3248d07913dSMike Christie extern void iscsi_destroy_iface(struct iscsi_iface *iface); 3258d07913dSMike Christie extern struct iscsi_iface *iscsi_lookup_iface(int handle); 326aeddde29SVikas Chaudhary extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost); 327aeddde29SVikas Chaudhary extern char *iscsi_get_port_state_name(struct Scsi_Host *shost); 32853cb8a1fSMike Christie 3291da177e4SLinus Torvalds #endif 330