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> 2739e84790SAlex Aizman #include <scsi/iscsi_if.h> 281da177e4SLinus Torvalds 297b8631b5SMike Christie struct scsi_transport_template; 307996a778SMike Christie struct iscsi_transport; 317b8631b5SMike Christie struct Scsi_Host; 327b8631b5SMike Christie struct iscsi_cls_conn; 337996a778SMike Christie struct iscsi_conn; 347996a778SMike Christie struct iscsi_cmd_task; 357996a778SMike Christie struct iscsi_mgmt_task; 36a54a52caSMike Christie struct sockaddr; 377b8631b5SMike Christie 3839e84790SAlex Aizman /** 3939e84790SAlex Aizman * struct iscsi_transport - iSCSI Transport template 4039e84790SAlex Aizman * 4139e84790SAlex Aizman * @name: transport name 4239e84790SAlex Aizman * @caps: iSCSI Data-Path capabilities 4339e84790SAlex Aizman * @create_session: create new iSCSI session object 4439e84790SAlex Aizman * @destroy_session: destroy existing iSCSI session object 4539e84790SAlex Aizman * @create_conn: create new iSCSI connection 4639e84790SAlex Aizman * @bind_conn: associate this connection with existing iSCSI session 4739e84790SAlex Aizman * and specified transport descriptor 4839e84790SAlex Aizman * @destroy_conn: destroy inactive iSCSI connection 49a54a52caSMike Christie * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA 50a54a52caSMike Christie * when param is not supported, and a -Exx value on other 51a54a52caSMike Christie * error. 52a54a52caSMike Christie * @get_param get iSCSI parameter. Must return number of bytes 53a54a52caSMike Christie * copied to buffer on success, -ENODATA when param 54a54a52caSMike Christie * is not supported, and a -Exx value on other error 5539e84790SAlex Aizman * @start_conn: set connection to be operational 5639e84790SAlex Aizman * @stop_conn: suspend/recover/terminate connection 5739e84790SAlex Aizman * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text. 587996a778SMike Christie * @session_recovery_timedout: notify LLD a block during recovery timed out 597996a778SMike Christie * @init_cmd_task: Initialize a iscsi_cmd_task and any internal structs. 607996a778SMike Christie * Called from queuecommand with session lock held. 617996a778SMike Christie * @init_mgmt_task: Initialize a iscsi_mgmt_task and any internal structs. 627996a778SMike Christie * Called from iscsi_conn_send_generic with xmitmutex. 633219e529SMike Christie * @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the 643219e529SMike Christie * the number of bytes transferred on success, and -Exyz 653219e529SMike Christie * value on error. 663219e529SMike Christie * @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the 673219e529SMike Christie * the number of bytes transferred on success, and -Exyz 683219e529SMike Christie * value on error. 697996a778SMike Christie * @cleanup_cmd_task: requests LLD to fail cmd task. Called with xmitmutex 707996a778SMike Christie * and session->lock after the connection has been 717996a778SMike Christie * suspended and terminated during recovery. If called 727996a778SMike Christie * from abort task then connection is not suspended 737996a778SMike Christie * or terminated but sk_callback_lock is held 7439e84790SAlex Aizman * 7539e84790SAlex Aizman * Template API provided by iSCSI Transport 7639e84790SAlex Aizman */ 7739e84790SAlex Aizman struct iscsi_transport { 7839e84790SAlex Aizman struct module *owner; 7939e84790SAlex Aizman char *name; 8039e84790SAlex Aizman unsigned int caps; 81fd7255f5SMike Christie /* LLD sets this to indicate what values it can export to sysfs */ 821819dc81SMike Christie uint64_t param_mask; 831819dc81SMike Christie uint64_t host_param_mask; 8439e84790SAlex Aizman struct scsi_host_template *host_template; 857b8631b5SMike Christie /* LLD connection data size */ 867b8631b5SMike Christie int conndata_size; 87b5c7a12dSMike Christie /* LLD session data size */ 88b5c7a12dSMike Christie int sessiondata_size; 8939e84790SAlex Aizman int max_lun; 9039e84790SAlex Aizman unsigned int max_conn; 9139e84790SAlex Aizman unsigned int max_cmd_len; 927996a778SMike Christie struct iscsi_cls_session *(*create_session) (struct iscsi_transport *it, 937996a778SMike Christie struct scsi_transport_template *t, uint32_t sn, uint32_t *hn); 947b7232f3SMike Christie void (*destroy_session) (struct iscsi_cls_session *session); 957b7232f3SMike Christie struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess, 967b8631b5SMike Christie uint32_t cid); 977b7232f3SMike Christie int (*bind_conn) (struct iscsi_cls_session *session, 987b7232f3SMike Christie struct iscsi_cls_conn *cls_conn, 99264faaaaSOr Gerlitz uint64_t transport_eph, int is_leading); 1007b7232f3SMike Christie int (*start_conn) (struct iscsi_cls_conn *conn); 1017b7232f3SMike Christie void (*stop_conn) (struct iscsi_cls_conn *conn, int flag); 1027b8631b5SMike Christie void (*destroy_conn) (struct iscsi_cls_conn *conn); 1037b7232f3SMike Christie int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param, 104a54a52caSMike Christie char *buf, int buflen); 1057b7232f3SMike Christie int (*get_conn_param) (struct iscsi_cls_conn *conn, 106fd7255f5SMike Christie enum iscsi_param param, char *buf); 107a54a52caSMike Christie int (*get_session_param) (struct iscsi_cls_session *session, 108fd7255f5SMike Christie enum iscsi_param param, char *buf); 1091819dc81SMike Christie int (*get_host_param) (struct Scsi_Host *shost, 1101819dc81SMike Christie enum iscsi_host_param param, char *buf); 1117b7232f3SMike Christie int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, 11239e84790SAlex Aizman char *data, uint32_t data_size); 1137b7232f3SMike Christie void (*get_stats) (struct iscsi_cls_conn *conn, 1147b7232f3SMike Christie struct iscsi_stats *stats); 1157996a778SMike Christie void (*init_cmd_task) (struct iscsi_cmd_task *ctask); 1167996a778SMike Christie void (*init_mgmt_task) (struct iscsi_conn *conn, 1177996a778SMike Christie struct iscsi_mgmt_task *mtask, 1187996a778SMike Christie char *data, uint32_t data_size); 1197996a778SMike Christie int (*xmit_cmd_task) (struct iscsi_conn *conn, 1207996a778SMike Christie struct iscsi_cmd_task *ctask); 1217996a778SMike Christie void (*cleanup_cmd_task) (struct iscsi_conn *conn, 1227996a778SMike Christie struct iscsi_cmd_task *ctask); 1237996a778SMike Christie int (*xmit_mgmt_task) (struct iscsi_conn *conn, 1247996a778SMike Christie struct iscsi_mgmt_task *mtask); 12530a6c652SMike Christie void (*session_recovery_timedout) (struct iscsi_cls_session *session); 126264faaaaSOr Gerlitz int (*ep_connect) (struct sockaddr *dst_addr, int non_blocking, 127264faaaaSOr Gerlitz uint64_t *ep_handle); 128264faaaaSOr Gerlitz int (*ep_poll) (uint64_t ep_handle, int timeout_ms); 129264faaaaSOr Gerlitz void (*ep_disconnect) (uint64_t ep_handle); 13001cb225dSMike Christie int (*tgt_dscvr) (enum iscsi_tgt_dscvr type, uint32_t host_no, 13101cb225dSMike Christie uint32_t enable, struct sockaddr *dst_addr); 1321da177e4SLinus Torvalds }; 1331da177e4SLinus Torvalds 1341da177e4SLinus Torvalds /* 13539e84790SAlex Aizman * transport registration upcalls 1361da177e4SLinus Torvalds */ 1377b8631b5SMike Christie extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt); 13839e84790SAlex Aizman extern int iscsi_unregister_transport(struct iscsi_transport *tt); 1391da177e4SLinus Torvalds 1401da177e4SLinus Torvalds /* 14139e84790SAlex Aizman * control plane upcalls 1421da177e4SLinus Torvalds */ 1437b7232f3SMike Christie extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error); 1447b7232f3SMike Christie extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, 14539e84790SAlex Aizman char *data, uint32_t data_size); 1461da177e4SLinus Torvalds 1477996a778SMike Christie 1487996a778SMike Christie /* Connection's states */ 1497996a778SMike Christie #define ISCSI_CONN_INITIAL_STAGE 0 1507996a778SMike Christie #define ISCSI_CONN_STARTED 1 1517996a778SMike Christie #define ISCSI_CONN_STOPPED 2 1527996a778SMike Christie #define ISCSI_CONN_CLEANUP_WAIT 3 1537996a778SMike Christie 1547b8631b5SMike Christie struct iscsi_cls_conn { 1557b8631b5SMike Christie struct list_head conn_list; /* item in connlist */ 1567b8631b5SMike Christie void *dd_data; /* LLD private data */ 1577b8631b5SMike Christie struct iscsi_transport *transport; 158b5c7a12dSMike Christie uint32_t cid; /* connection id */ 159fd7255f5SMike Christie 1607b8631b5SMike Christie int active; /* must be accessed with the connlock */ 1617b8631b5SMike Christie struct device dev; /* sysfs transport/container device */ 1627b8631b5SMike Christie }; 1637b8631b5SMike Christie 1647b8631b5SMike Christie #define iscsi_dev_to_conn(_dev) \ 1657b8631b5SMike Christie container_of(_dev, struct iscsi_cls_conn, dev) 1667b8631b5SMike Christie 1677996a778SMike Christie /* Session's states */ 1687996a778SMike Christie #define ISCSI_STATE_FREE 1 1697996a778SMike Christie #define ISCSI_STATE_LOGGED_IN 2 1707996a778SMike Christie #define ISCSI_STATE_FAILED 3 1717996a778SMike Christie #define ISCSI_STATE_TERMINATE 4 172656cffc9SMike Christie #define ISCSI_STATE_IN_RECOVERY 5 173656cffc9SMike Christie #define ISCSI_STATE_RECOVERY_FAILED 6 1747996a778SMike Christie 1757b8631b5SMike Christie struct iscsi_cls_session { 1767b7232f3SMike Christie struct list_head sess_list; /* item in session_list */ 17730a6c652SMike Christie struct list_head host_list; 1787b8631b5SMike Christie struct iscsi_transport *transport; 179fd7255f5SMike Christie 18030a6c652SMike Christie /* recovery fields */ 18130a6c652SMike Christie int recovery_tmo; 182c4028958SDavid Howells struct delayed_work recovery_work; 18330a6c652SMike Christie 18430a6c652SMike Christie int target_id; 18530a6c652SMike Christie 186b5c7a12dSMike Christie int sid; /* session id */ 187b5c7a12dSMike Christie void *dd_data; /* LLD private data */ 1887b8631b5SMike Christie struct device dev; /* sysfs transport/container device */ 1897b8631b5SMike Christie }; 1907b8631b5SMike Christie 1917b8631b5SMike Christie #define iscsi_dev_to_session(_dev) \ 1927b8631b5SMike Christie container_of(_dev, struct iscsi_cls_session, dev) 1937b8631b5SMike Christie 1947b8631b5SMike Christie #define iscsi_session_to_shost(_session) \ 1957b8631b5SMike Christie dev_to_shost(_session->dev.parent) 1967b8631b5SMike Christie 1978434aa8bSMike Christie #define starget_to_session(_stgt) \ 1988434aa8bSMike Christie iscsi_dev_to_session(_stgt->dev.parent) 1998434aa8bSMike Christie 20030a6c652SMike Christie struct iscsi_host { 20130a6c652SMike Christie struct list_head sessions; 20230a6c652SMike Christie struct mutex mutex; 20330a6c652SMike Christie }; 20430a6c652SMike Christie 2057b8631b5SMike Christie /* 2067b8631b5SMike Christie * session and connection functions that can be used by HW iSCSI LLDs 2077b8631b5SMike Christie */ 2088434aa8bSMike Christie extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost, 2098434aa8bSMike Christie struct iscsi_transport *transport); 2106a8a0d36SMike Christie extern int iscsi_add_session(struct iscsi_cls_session *session, 2116a8a0d36SMike Christie unsigned int target_id); 21253cb8a1fSMike Christie extern int iscsi_if_create_session_done(struct iscsi_cls_conn *conn); 21353cb8a1fSMike Christie extern int iscsi_if_destroy_session_done(struct iscsi_cls_conn *conn); 2147b8631b5SMike Christie extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost, 2156a8a0d36SMike Christie struct iscsi_transport *t, 2166a8a0d36SMike Christie unsigned int target_id); 2178434aa8bSMike Christie extern void iscsi_remove_session(struct iscsi_cls_session *session); 2188434aa8bSMike Christie extern void iscsi_free_session(struct iscsi_cls_session *session); 2197b8631b5SMike Christie extern int iscsi_destroy_session(struct iscsi_cls_session *session); 2207b8631b5SMike Christie extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess, 2217b8631b5SMike Christie uint32_t cid); 2227b8631b5SMike Christie extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn); 22330a6c652SMike Christie extern void iscsi_unblock_session(struct iscsi_cls_session *session); 22430a6c652SMike Christie extern void iscsi_block_session(struct iscsi_cls_session *session); 2257b8631b5SMike Christie 22653cb8a1fSMike Christie 2271da177e4SLinus Torvalds #endif 228