11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * iSCSI transport class definitions 31da177e4SLinus Torvalds * 41da177e4SLinus Torvalds * Copyright (C) IBM Corporation, 2004 539e84790SAlex Aizman * Copyright (C) Mike Christie, 2004 - 2005 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; 307b8631b5SMike Christie struct Scsi_Host; 317b8631b5SMike Christie struct mempool_zone; 327b8631b5SMike Christie struct iscsi_cls_conn; 337b8631b5SMike Christie 3439e84790SAlex Aizman /** 3539e84790SAlex Aizman * struct iscsi_transport - iSCSI Transport template 3639e84790SAlex Aizman * 3739e84790SAlex Aizman * @name: transport name 3839e84790SAlex Aizman * @caps: iSCSI Data-Path capabilities 3939e84790SAlex Aizman * @create_session: create new iSCSI session object 4039e84790SAlex Aizman * @destroy_session: destroy existing iSCSI session object 4139e84790SAlex Aizman * @create_conn: create new iSCSI connection 4239e84790SAlex Aizman * @bind_conn: associate this connection with existing iSCSI session 4339e84790SAlex Aizman * and specified transport descriptor 4439e84790SAlex Aizman * @destroy_conn: destroy inactive iSCSI connection 4539e84790SAlex Aizman * @set_param: set iSCSI Data-Path operational parameter 4639e84790SAlex Aizman * @start_conn: set connection to be operational 4739e84790SAlex Aizman * @stop_conn: suspend/recover/terminate connection 4839e84790SAlex Aizman * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text. 4939e84790SAlex Aizman * 5039e84790SAlex Aizman * Template API provided by iSCSI Transport 5139e84790SAlex Aizman */ 5239e84790SAlex Aizman struct iscsi_transport { 5339e84790SAlex Aizman struct module *owner; 5439e84790SAlex Aizman char *name; 5539e84790SAlex Aizman unsigned int caps; 56fd7255f5SMike Christie /* LLD sets this to indicate what values it can export to sysfs */ 57fd7255f5SMike Christie unsigned int param_mask; 5839e84790SAlex Aizman struct scsi_host_template *host_template; 597b8631b5SMike Christie /* LLD session/scsi_host data size */ 6039e84790SAlex Aizman int hostdata_size; 617b8631b5SMike Christie /* LLD connection data size */ 627b8631b5SMike Christie int conndata_size; 63b5c7a12dSMike Christie /* LLD session data size */ 64b5c7a12dSMike Christie int sessiondata_size; 6539e84790SAlex Aizman int max_lun; 6639e84790SAlex Aizman unsigned int max_conn; 6739e84790SAlex Aizman unsigned int max_cmd_len; 687b7232f3SMike Christie struct iscsi_cls_session *(*create_session) 69b5c7a12dSMike Christie (struct scsi_transport_template *t, uint32_t sn, uint32_t *hn); 707b7232f3SMike Christie void (*destroy_session) (struct iscsi_cls_session *session); 717b7232f3SMike Christie struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess, 727b8631b5SMike Christie uint32_t cid); 737b7232f3SMike Christie int (*bind_conn) (struct iscsi_cls_session *session, 747b7232f3SMike Christie struct iscsi_cls_conn *cls_conn, 7539e84790SAlex Aizman uint32_t transport_fd, int is_leading); 767b7232f3SMike Christie int (*start_conn) (struct iscsi_cls_conn *conn); 777b7232f3SMike Christie void (*stop_conn) (struct iscsi_cls_conn *conn, int flag); 787b8631b5SMike Christie void (*destroy_conn) (struct iscsi_cls_conn *conn); 797b7232f3SMike Christie int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param, 8039e84790SAlex Aizman uint32_t value); 817b7232f3SMike Christie int (*get_conn_param) (struct iscsi_cls_conn *conn, 82fd7255f5SMike Christie enum iscsi_param param, uint32_t *value); 837b7232f3SMike Christie int (*get_session_param) (struct iscsi_cls_session *session, 847b8631b5SMike Christie enum iscsi_param param, uint32_t *value); 85fd7255f5SMike Christie int (*get_conn_str_param) (struct iscsi_cls_conn *conn, 86fd7255f5SMike Christie enum iscsi_param param, char *buf); 87fd7255f5SMike Christie int (*get_session_str_param) (struct iscsi_cls_session *session, 88fd7255f5SMike Christie enum iscsi_param param, char *buf); 897b7232f3SMike Christie int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, 9039e84790SAlex Aizman char *data, uint32_t data_size); 917b7232f3SMike Christie void (*get_stats) (struct iscsi_cls_conn *conn, 927b7232f3SMike Christie struct iscsi_stats *stats); 9330a6c652SMike Christie void (*session_recovery_timedout) (struct iscsi_cls_session *session); 941da177e4SLinus Torvalds }; 951da177e4SLinus Torvalds 961da177e4SLinus Torvalds /* 9739e84790SAlex Aizman * transport registration upcalls 981da177e4SLinus Torvalds */ 997b8631b5SMike Christie extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt); 10039e84790SAlex Aizman extern int iscsi_unregister_transport(struct iscsi_transport *tt); 1011da177e4SLinus Torvalds 1021da177e4SLinus Torvalds /* 10339e84790SAlex Aizman * control plane upcalls 1041da177e4SLinus Torvalds */ 1057b7232f3SMike Christie extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error); 1067b7232f3SMike Christie extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, 10739e84790SAlex Aizman char *data, uint32_t data_size); 1081da177e4SLinus Torvalds 1097b8631b5SMike Christie struct iscsi_cls_conn { 1107b8631b5SMike Christie struct list_head conn_list; /* item in connlist */ 1117b8631b5SMike Christie void *dd_data; /* LLD private data */ 1127b8631b5SMike Christie struct iscsi_transport *transport; 113b5c7a12dSMike Christie uint32_t cid; /* connection id */ 114fd7255f5SMike Christie 115fd7255f5SMike Christie /* portal/group values we got during discovery */ 116fd7255f5SMike Christie char *persistent_address; 117fd7255f5SMike Christie int persistent_port; 118fd7255f5SMike Christie /* portal/group values we are currently using */ 119fd7255f5SMike Christie char *address; 120fd7255f5SMike Christie int port; 121fd7255f5SMike Christie 1227b8631b5SMike Christie int active; /* must be accessed with the connlock */ 1237b8631b5SMike Christie struct device dev; /* sysfs transport/container device */ 1247b8631b5SMike Christie struct mempool_zone *z_error; 1257b8631b5SMike Christie struct mempool_zone *z_pdu; 1267b8631b5SMike Christie struct list_head freequeue; 1277b8631b5SMike Christie }; 1287b8631b5SMike Christie 1297b8631b5SMike Christie #define iscsi_dev_to_conn(_dev) \ 1307b8631b5SMike Christie container_of(_dev, struct iscsi_cls_conn, dev) 1317b8631b5SMike Christie 1327b8631b5SMike Christie struct iscsi_cls_session { 1337b7232f3SMike Christie struct list_head sess_list; /* item in session_list */ 13430a6c652SMike Christie struct list_head host_list; 1357b8631b5SMike Christie struct iscsi_transport *transport; 136fd7255f5SMike Christie 137fd7255f5SMike Christie /* iSCSI values used as unique id by userspace. */ 138fd7255f5SMike Christie char *targetname; 139fd7255f5SMike Christie int tpgt; 140fd7255f5SMike Christie 14130a6c652SMike Christie /* recovery fields */ 14230a6c652SMike Christie int recovery_tmo; 14330a6c652SMike Christie struct work_struct recovery_work; 14430a6c652SMike Christie 14530a6c652SMike Christie int target_id; 14630a6c652SMike Christie int channel; 14730a6c652SMike Christie 148b5c7a12dSMike Christie int sid; /* session id */ 149b5c7a12dSMike Christie void *dd_data; /* LLD private data */ 1507b8631b5SMike Christie struct device dev; /* sysfs transport/container device */ 1517b8631b5SMike Christie }; 1527b8631b5SMike Christie 1537b8631b5SMike Christie #define iscsi_dev_to_session(_dev) \ 1547b8631b5SMike Christie container_of(_dev, struct iscsi_cls_session, dev) 1557b8631b5SMike Christie 1567b8631b5SMike Christie #define iscsi_session_to_shost(_session) \ 1577b8631b5SMike Christie dev_to_shost(_session->dev.parent) 1587b8631b5SMike Christie 15930a6c652SMike Christie struct iscsi_host { 16030a6c652SMike Christie int next_target_id; 16130a6c652SMike Christie struct list_head sessions; 16230a6c652SMike Christie struct mutex mutex; 16330a6c652SMike Christie }; 16430a6c652SMike Christie 1657b8631b5SMike Christie /* 1667b8631b5SMike Christie * session and connection functions that can be used by HW iSCSI LLDs 1677b8631b5SMike Christie */ 1687b8631b5SMike Christie extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost, 16930a6c652SMike Christie struct iscsi_transport *t, int channel); 1707b8631b5SMike Christie extern int iscsi_destroy_session(struct iscsi_cls_session *session); 1717b8631b5SMike Christie extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess, 1727b8631b5SMike Christie uint32_t cid); 1737b8631b5SMike Christie extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn); 17430a6c652SMike Christie extern void iscsi_unblock_session(struct iscsi_cls_session *session); 17530a6c652SMike Christie extern void iscsi_block_session(struct iscsi_cls_session *session); 1767b8631b5SMike Christie 1777b8631b5SMike Christie /* 1787b8631b5SMike Christie * session functions used by software iscsi 1797b8631b5SMike Christie */ 1807b8631b5SMike Christie extern struct Scsi_Host * 1817b8631b5SMike Christie iscsi_transport_create_session(struct scsi_transport_template *scsit, 1827b8631b5SMike Christie struct iscsi_transport *transport); 1837b8631b5SMike Christie extern int iscsi_transport_destroy_session(struct Scsi_Host *shost); 1847b8631b5SMike Christie 1851da177e4SLinus Torvalds #endif 186