Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 1 | /* |
| 2 | * iSCSI lib definitions |
| 3 | * |
| 4 | * Copyright (C) 2006 Red Hat, Inc. All rights reserved. |
| 5 | * Copyright (C) 2004 - 2006 Mike Christie |
| 6 | * Copyright (C) 2004 - 2005 Dmitry Yusupov |
| 7 | * Copyright (C) 2004 - 2005 Alex Aizman |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU General Public License as published by |
| 11 | * the Free Software Foundation; either version 2 of the License, or |
| 12 | * (at your option) any later version. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU General Public License |
| 20 | * along with this program; if not, write to the Free Software |
| 21 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 22 | */ |
| 23 | #ifndef LIBISCSI_H |
| 24 | #define LIBISCSI_H |
| 25 | |
| 26 | #include <linux/types.h> |
Mike Christie | 40753ca | 2008-05-21 15:53:56 -0500 | [diff] [blame] | 27 | #include <linux/wait.h> |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 28 | #include <linux/mutex.h> |
Al Viro | f6a5703 | 2006-10-18 01:47:25 -0400 | [diff] [blame] | 29 | #include <linux/timer.h> |
| 30 | #include <linux/workqueue.h> |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 31 | #include <scsi/iscsi_proto.h> |
| 32 | #include <scsi/iscsi_if.h> |
| 33 | |
| 34 | struct scsi_transport_template; |
Mike Christie | a4804cd | 2008-05-21 15:54:00 -0500 | [diff] [blame] | 35 | struct scsi_host_template; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 36 | struct scsi_device; |
| 37 | struct Scsi_Host; |
| 38 | struct scsi_cmnd; |
| 39 | struct socket; |
| 40 | struct iscsi_transport; |
| 41 | struct iscsi_cls_session; |
| 42 | struct iscsi_cls_conn; |
| 43 | struct iscsi_session; |
| 44 | struct iscsi_nopin; |
Mike Christie | a4804cd | 2008-05-21 15:54:00 -0500 | [diff] [blame] | 45 | struct device; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 46 | |
| 47 | /* #define DEBUG_SCSI */ |
| 48 | #ifdef DEBUG_SCSI |
Or Gerlitz | be2df72 | 2006-05-02 19:46:43 -0500 | [diff] [blame] | 49 | #define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt) |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 50 | #else |
| 51 | #define debug_scsi(fmt...) |
| 52 | #endif |
| 53 | |
Mike Christie | 1548271 | 2007-05-30 12:57:19 -0500 | [diff] [blame] | 54 | #define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */ |
Mike Christie | 3cf7b23 | 2008-05-21 15:54:17 -0500 | [diff] [blame^] | 55 | #define ISCSI_MGMT_CMDS_MAX 15 |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 56 | |
| 57 | #define ISCSI_DEF_CMD_PER_LUN 32 |
| 58 | #define ISCSI_MAX_CMD_PER_LUN 128 |
| 59 | |
| 60 | /* Task Mgmt states */ |
Mike Christie | 843c0a8 | 2007-12-13 12:43:20 -0600 | [diff] [blame] | 61 | enum { |
| 62 | TMF_INITIAL, |
| 63 | TMF_QUEUED, |
| 64 | TMF_SUCCESS, |
| 65 | TMF_FAILED, |
| 66 | TMF_TIMEDOUT, |
| 67 | TMF_NOT_FOUND, |
| 68 | }; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 69 | |
| 70 | /* Connection suspend "bit" */ |
| 71 | #define ISCSI_SUSPEND_BIT 1 |
| 72 | |
Mike Christie | 3cf7b23 | 2008-05-21 15:54:17 -0500 | [diff] [blame^] | 73 | #define ISCSI_ITT_MASK (0x1fff) |
| 74 | #define ISCSI_TOTAL_CMDS_MAX 4096 |
| 75 | /* this must be a power of two greater than ISCSI_MGMT_CMDS_MAX */ |
| 76 | #define ISCSI_TOTAL_CMDS_MIN 16 |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 77 | #define ISCSI_AGE_SHIFT 28 |
| 78 | #define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT) |
| 79 | |
Mike Christie | 2223696 | 2007-05-30 12:57:24 -0500 | [diff] [blame] | 80 | #define ISCSI_ADDRESS_BUF_LEN 64 |
| 81 | |
Olaf Kirch | da32dd6 | 2007-12-13 12:43:21 -0600 | [diff] [blame] | 82 | enum { |
Boaz Harrosh | 004d653 | 2007-12-13 12:43:23 -0600 | [diff] [blame] | 83 | /* this is the maximum possible storage for AHSs */ |
| 84 | ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) + |
| 85 | sizeof(struct iscsi_rlength_ahdr), |
Olaf Kirch | da32dd6 | 2007-12-13 12:43:21 -0600 | [diff] [blame] | 86 | ISCSI_DIGEST_SIZE = sizeof(__u32), |
| 87 | }; |
| 88 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 89 | |
Mike Christie | b6c395e | 2006-07-24 15:47:15 -0500 | [diff] [blame] | 90 | enum { |
| 91 | ISCSI_TASK_COMPLETED, |
| 92 | ISCSI_TASK_PENDING, |
| 93 | ISCSI_TASK_RUNNING, |
| 94 | }; |
| 95 | |
Mike Christie | 9c19a7d | 2008-05-21 15:54:09 -0500 | [diff] [blame] | 96 | struct iscsi_task { |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 97 | /* |
Boaz Harrosh | 004d653 | 2007-12-13 12:43:23 -0600 | [diff] [blame] | 98 | * Because LLDs allocate their hdr differently, this is a pointer |
| 99 | * and length to that storage. It must be setup at session |
| 100 | * creation time. |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 101 | */ |
| 102 | struct iscsi_cmd *hdr; |
Boaz Harrosh | 004d653 | 2007-12-13 12:43:23 -0600 | [diff] [blame] | 103 | unsigned short hdr_max; |
| 104 | unsigned short hdr_len; /* accumulated size of hdr used */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 105 | int itt; /* this ITT */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 106 | |
| 107 | uint32_t unsol_datasn; |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 108 | unsigned imm_count; /* imm-data (bytes) */ |
| 109 | unsigned unsol_count; /* unsolicited (bytes)*/ |
Mike Christie | ffd0436 | 2006-08-31 18:09:24 -0400 | [diff] [blame] | 110 | /* offset in unsolicited stream (bytes); */ |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 111 | unsigned unsol_offset; |
| 112 | unsigned data_count; /* remaining Data-Out */ |
Mike Christie | 3e5c28a | 2008-05-21 15:54:06 -0500 | [diff] [blame] | 113 | char *data; /* mgmt payload */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 114 | struct scsi_cmnd *sc; /* associated SCSI cmd*/ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 115 | struct iscsi_conn *conn; /* used connection */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 116 | |
Mike Christie | b6c395e | 2006-07-24 15:47:15 -0500 | [diff] [blame] | 117 | /* state set/tested under session->lock */ |
| 118 | int state; |
Mike Christie | 60ecebf | 2006-08-31 18:09:25 -0400 | [diff] [blame] | 119 | atomic_t refcount; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 120 | struct list_head running; /* running cmd list */ |
| 121 | void *dd_data; /* driver/transport data */ |
| 122 | }; |
| 123 | |
Mike Christie | 9c19a7d | 2008-05-21 15:54:09 -0500 | [diff] [blame] | 124 | static inline void* iscsi_next_hdr(struct iscsi_task *task) |
Boaz Harrosh | 004d653 | 2007-12-13 12:43:23 -0600 | [diff] [blame] | 125 | { |
Mike Christie | 9c19a7d | 2008-05-21 15:54:09 -0500 | [diff] [blame] | 126 | return (void*)task->hdr + task->hdr_len; |
Boaz Harrosh | 004d653 | 2007-12-13 12:43:23 -0600 | [diff] [blame] | 127 | } |
| 128 | |
Mike Christie | 6eabafb | 2008-01-31 13:36:43 -0600 | [diff] [blame] | 129 | /* Connection's states */ |
| 130 | enum { |
| 131 | ISCSI_CONN_INITIAL_STAGE, |
| 132 | ISCSI_CONN_STARTED, |
| 133 | ISCSI_CONN_STOPPED, |
| 134 | ISCSI_CONN_CLEANUP_WAIT, |
| 135 | }; |
| 136 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 137 | struct iscsi_conn { |
| 138 | struct iscsi_cls_conn *cls_conn; /* ptr to class connection */ |
| 139 | void *dd_data; /* iscsi_transport data */ |
| 140 | struct iscsi_session *session; /* parent session */ |
| 141 | /* |
| 142 | * LLDs should set this lock. It protects the transport recv |
| 143 | * code |
| 144 | */ |
| 145 | rwlock_t *recv_lock; |
| 146 | /* |
| 147 | * conn_stop() flag: stop to recover, stop to terminate |
| 148 | */ |
| 149 | int stop_stage; |
Mike Christie | f6d5180 | 2007-12-13 12:43:30 -0600 | [diff] [blame] | 150 | struct timer_list transport_timer; |
| 151 | unsigned long last_recv; |
| 152 | unsigned long last_ping; |
| 153 | int ping_timeout; |
| 154 | int recv_timeout; |
Mike Christie | 9c19a7d | 2008-05-21 15:54:09 -0500 | [diff] [blame] | 155 | struct iscsi_task *ping_task; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 156 | |
| 157 | /* iSCSI connection-wide sequencing */ |
| 158 | uint32_t exp_statsn; |
| 159 | |
| 160 | /* control data */ |
| 161 | int id; /* CID */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 162 | int c_stage; /* connection state */ |
Mike Christie | c8dc1e5 | 2006-07-24 15:47:39 -0500 | [diff] [blame] | 163 | /* |
| 164 | * Preallocated buffer for pdus that have data but do not |
| 165 | * originate from scsi-ml. We never have two pdus using the |
| 166 | * buffer at the same time. It is only allocated to |
| 167 | * the default max recv size because the pdus we support |
| 168 | * should always fit in this buffer |
| 169 | */ |
| 170 | char *data; |
Mike Christie | 9c19a7d | 2008-05-21 15:54:09 -0500 | [diff] [blame] | 171 | struct iscsi_task *login_task; /* mtask used for login/text */ |
| 172 | struct iscsi_task *task; /* xmit task in progress */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 173 | |
| 174 | /* xmit */ |
Mike Christie | 843c0a8 | 2007-12-13 12:43:20 -0600 | [diff] [blame] | 175 | struct list_head mgmtqueue; /* mgmt (control) xmit queue */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 176 | struct list_head mgmt_run_list; /* list of control tasks */ |
Mike Christie | b6c395e | 2006-07-24 15:47:15 -0500 | [diff] [blame] | 177 | struct list_head xmitqueue; /* data-path cmd queue */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 178 | struct list_head run_list; /* list of cmds in progress */ |
Mike Christie | 843c0a8 | 2007-12-13 12:43:20 -0600 | [diff] [blame] | 179 | struct list_head requeue; /* tasks needing another run */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 180 | struct work_struct xmitwork; /* per-conn. xmit workqueue */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 181 | unsigned long suspend_tx; /* suspend Tx */ |
| 182 | unsigned long suspend_rx; /* suspend Rx */ |
| 183 | |
| 184 | /* abort */ |
| 185 | wait_queue_head_t ehwait; /* used in eh_abort() */ |
| 186 | struct iscsi_tm tmhdr; |
Mike Christie | 843c0a8 | 2007-12-13 12:43:20 -0600 | [diff] [blame] | 187 | struct timer_list tmf_timer; |
| 188 | int tmf_state; /* see TMF_INITIAL, etc.*/ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 189 | |
| 190 | /* negotiated params */ |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 191 | unsigned max_recv_dlength; /* initiator_max_recv_dsl*/ |
| 192 | unsigned max_xmit_dlength; /* target_max_recv_dsl */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 193 | int hdrdgst_en; |
| 194 | int datadgst_en; |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 195 | int ifmarker_en; |
| 196 | int ofmarker_en; |
| 197 | /* values userspace uses to id a conn */ |
| 198 | int persistent_port; |
| 199 | char *persistent_address; |
Mike Christie | 2223696 | 2007-05-30 12:57:24 -0500 | [diff] [blame] | 200 | /* remote portal currently connected to */ |
| 201 | int portal_port; |
| 202 | char portal_address[ISCSI_ADDRESS_BUF_LEN]; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 203 | |
| 204 | /* MIB-statistics */ |
| 205 | uint64_t txdata_octets; |
| 206 | uint64_t rxdata_octets; |
| 207 | uint32_t scsicmd_pdus_cnt; |
| 208 | uint32_t dataout_pdus_cnt; |
| 209 | uint32_t scsirsp_pdus_cnt; |
| 210 | uint32_t datain_pdus_cnt; |
| 211 | uint32_t r2t_pdus_cnt; |
| 212 | uint32_t tmfcmd_pdus_cnt; |
| 213 | int32_t tmfrsp_pdus_cnt; |
| 214 | |
| 215 | /* custom statistics */ |
| 216 | uint32_t eh_abort_cnt; |
Eli Dorfman | 8752822 | 2008-04-29 13:46:52 -0700 | [diff] [blame] | 217 | uint32_t fmr_unalign_cnt; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 218 | }; |
| 219 | |
Olaf Kirch | 6320377 | 2007-12-13 12:43:25 -0600 | [diff] [blame] | 220 | struct iscsi_pool { |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 221 | struct kfifo *queue; /* FIFO Queue */ |
| 222 | void **pool; /* Pool of elements */ |
| 223 | int max; /* Max number of elements */ |
| 224 | }; |
| 225 | |
Mike Christie | 6eabafb | 2008-01-31 13:36:43 -0600 | [diff] [blame] | 226 | /* Session's states */ |
| 227 | enum { |
| 228 | ISCSI_STATE_FREE = 1, |
| 229 | ISCSI_STATE_LOGGED_IN, |
| 230 | ISCSI_STATE_FAILED, |
| 231 | ISCSI_STATE_TERMINATE, |
| 232 | ISCSI_STATE_IN_RECOVERY, |
| 233 | ISCSI_STATE_RECOVERY_FAILED, |
| 234 | ISCSI_STATE_LOGGING_OUT, |
| 235 | }; |
| 236 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 237 | struct iscsi_session { |
Mike Christie | 7561352 | 2008-05-21 15:53:59 -0500 | [diff] [blame] | 238 | struct iscsi_cls_session *cls_session; |
Mike Christie | 6724add | 2007-08-15 01:38:30 -0500 | [diff] [blame] | 239 | /* |
| 240 | * Syncs up the scsi eh thread with the iscsi eh thread when sending |
| 241 | * task management functions. This must be taken before the session |
| 242 | * and recv lock. |
| 243 | */ |
| 244 | struct mutex eh_mutex; |
| 245 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 246 | /* iSCSI session-wide sequencing */ |
| 247 | uint32_t cmdsn; |
| 248 | uint32_t exp_cmdsn; |
| 249 | uint32_t max_cmdsn; |
| 250 | |
Mike Christie | e072640 | 2007-07-26 12:46:48 -0500 | [diff] [blame] | 251 | /* This tracks the reqs queued into the initiator */ |
| 252 | uint32_t queued_cmdsn; |
| 253 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 254 | /* configuration */ |
Mike Christie | f6d5180 | 2007-12-13 12:43:30 -0600 | [diff] [blame] | 255 | int abort_timeout; |
| 256 | int lu_reset_timeout; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 257 | int initial_r2t_en; |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 258 | unsigned max_r2t; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 259 | int imm_data_en; |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 260 | unsigned first_burst; |
| 261 | unsigned max_burst; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 262 | int time2wait; |
| 263 | int time2retain; |
| 264 | int pdu_inorder_en; |
| 265 | int dataseq_inorder_en; |
| 266 | int erl; |
Mike Christie | 843c0a8 | 2007-12-13 12:43:20 -0600 | [diff] [blame] | 267 | int fast_abort; |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 268 | int tpgt; |
Mike Christie | b2c6416 | 2007-05-30 12:57:16 -0500 | [diff] [blame] | 269 | char *username; |
| 270 | char *username_in; |
| 271 | char *password; |
| 272 | char *password_in; |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 273 | char *targetname; |
Mike Christie | 88dfd34 | 2008-05-21 15:54:16 -0500 | [diff] [blame] | 274 | char *ifacename; |
| 275 | char *initiatorname; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 276 | /* control data */ |
| 277 | struct iscsi_transport *tt; |
| 278 | struct Scsi_Host *host; |
| 279 | struct iscsi_conn *leadconn; /* leading connection */ |
| 280 | spinlock_t lock; /* protects session state, * |
| 281 | * sequence numbers, * |
| 282 | * session resources: * |
| 283 | * - cmdpool, * |
| 284 | * - mgmtpool, * |
| 285 | * - r2tpool */ |
| 286 | int state; /* session state */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 287 | int age; /* counts session re-opens */ |
| 288 | |
Mike Christie | 3e5c28a | 2008-05-21 15:54:06 -0500 | [diff] [blame] | 289 | int scsi_cmds_max; /* max scsi commands */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 290 | int cmds_max; /* size of cmds array */ |
Mike Christie | 9c19a7d | 2008-05-21 15:54:09 -0500 | [diff] [blame] | 291 | struct iscsi_task **cmds; /* Original Cmds arr */ |
Olaf Kirch | 6320377 | 2007-12-13 12:43:25 -0600 | [diff] [blame] | 292 | struct iscsi_pool cmdpool; /* PDU's pool */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 293 | }; |
| 294 | |
Mike Christie | 7561352 | 2008-05-21 15:53:59 -0500 | [diff] [blame] | 295 | struct iscsi_host { |
| 296 | char *initiatorname; |
| 297 | /* hw address or netdev iscsi connection is bound to */ |
| 298 | char *hwaddress; |
| 299 | char *netdev; |
| 300 | /* local address */ |
| 301 | int local_port; |
| 302 | char local_address[ISCSI_ADDRESS_BUF_LEN]; |
| 303 | }; |
| 304 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 305 | /* |
| 306 | * scsi host template |
| 307 | */ |
| 308 | extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth); |
| 309 | extern int iscsi_eh_abort(struct scsi_cmnd *sc); |
| 310 | extern int iscsi_eh_host_reset(struct scsi_cmnd *sc); |
Mike Christie | 843c0a8 | 2007-12-13 12:43:20 -0600 | [diff] [blame] | 311 | extern int iscsi_eh_device_reset(struct scsi_cmnd *sc); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 312 | extern int iscsi_queuecommand(struct scsi_cmnd *sc, |
| 313 | void (*done)(struct scsi_cmnd *)); |
| 314 | |
Mike Christie | 0801c24 | 2007-05-30 12:57:12 -0500 | [diff] [blame] | 315 | /* |
| 316 | * iSCSI host helpers. |
| 317 | */ |
Mike Christie | 5d91e20 | 2008-05-21 15:54:01 -0500 | [diff] [blame] | 318 | #define iscsi_host_priv(_shost) \ |
| 319 | (shost_priv(_shost) + sizeof(struct iscsi_host)) |
| 320 | |
Mike Christie | 0801c24 | 2007-05-30 12:57:12 -0500 | [diff] [blame] | 321 | extern int iscsi_host_set_param(struct Scsi_Host *shost, |
| 322 | enum iscsi_host_param param, char *buf, |
| 323 | int buflen); |
| 324 | extern int iscsi_host_get_param(struct Scsi_Host *shost, |
| 325 | enum iscsi_host_param param, char *buf); |
Mike Christie | a4804cd | 2008-05-21 15:54:00 -0500 | [diff] [blame] | 326 | extern int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev); |
| 327 | extern struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht, |
| 328 | int dd_data_size, uint16_t qdepth); |
| 329 | extern void iscsi_host_remove(struct Scsi_Host *shost); |
| 330 | extern void iscsi_host_free(struct Scsi_Host *shost); |
Mike Christie | 0801c24 | 2007-05-30 12:57:12 -0500 | [diff] [blame] | 331 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 332 | /* |
| 333 | * session management |
| 334 | */ |
| 335 | extern struct iscsi_cls_session * |
Mike Christie | 7561352 | 2008-05-21 15:53:59 -0500 | [diff] [blame] | 336 | iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost, |
Mike Christie | 7970634 | 2008-05-21 15:54:12 -0500 | [diff] [blame] | 337 | uint16_t, int, uint32_t, unsigned int); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 338 | extern void iscsi_session_teardown(struct iscsi_cls_session *); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 339 | extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *); |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 340 | extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn, |
| 341 | enum iscsi_param param, char *buf, int buflen); |
| 342 | extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session, |
| 343 | enum iscsi_param param, char *buf); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 344 | |
Mike Christie | 322d739 | 2008-01-31 13:36:52 -0600 | [diff] [blame] | 345 | #define iscsi_session_printk(prefix, _sess, fmt, a...) \ |
Mike Christie | 7561352 | 2008-05-21 15:53:59 -0500 | [diff] [blame] | 346 | iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a) |
Mike Christie | 322d739 | 2008-01-31 13:36:52 -0600 | [diff] [blame] | 347 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 348 | /* |
| 349 | * connection management |
| 350 | */ |
| 351 | extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *, |
Mike Christie | 5d91e20 | 2008-05-21 15:54:01 -0500 | [diff] [blame] | 352 | int, uint32_t); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 353 | extern void iscsi_conn_teardown(struct iscsi_cls_conn *); |
| 354 | extern int iscsi_conn_start(struct iscsi_cls_conn *); |
| 355 | extern void iscsi_conn_stop(struct iscsi_cls_conn *, int); |
| 356 | extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *, |
| 357 | int); |
| 358 | extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err); |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 359 | extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn, |
| 360 | enum iscsi_param param, char *buf); |
Mike Christie | 5af3e91 | 2008-05-21 15:54:02 -0500 | [diff] [blame] | 361 | extern void iscsi_suspend_tx(struct iscsi_conn *conn); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 362 | |
Mike Christie | 322d739 | 2008-01-31 13:36:52 -0600 | [diff] [blame] | 363 | #define iscsi_conn_printk(prefix, _c, fmt, a...) \ |
Mike Christie | 5af3e91 | 2008-05-21 15:54:02 -0500 | [diff] [blame] | 364 | iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \ |
| 365 | fmt, ##a) |
Mike Christie | 322d739 | 2008-01-31 13:36:52 -0600 | [diff] [blame] | 366 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 367 | /* |
| 368 | * pdu and task processing |
| 369 | */ |
Mike Christie | 77a23c2 | 2007-05-30 12:57:18 -0500 | [diff] [blame] | 370 | extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *); |
Mike Christie | 9c19a7d | 2008-05-21 15:54:09 -0500 | [diff] [blame] | 371 | extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_task *, |
Mike Christie | ffd0436 | 2006-08-31 18:09:24 -0400 | [diff] [blame] | 372 | struct iscsi_data *hdr); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 373 | extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *, |
| 374 | char *, uint32_t); |
| 375 | extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *, |
| 376 | char *, int); |
Mike Christie | 0af967f | 2008-05-21 15:54:04 -0500 | [diff] [blame] | 377 | extern int iscsi_verify_itt(struct iscsi_conn *, itt_t); |
Mike Christie | 9c19a7d | 2008-05-21 15:54:09 -0500 | [diff] [blame] | 378 | extern struct iscsi_task *iscsi_itt_to_ctask(struct iscsi_conn *, itt_t); |
| 379 | extern void iscsi_requeue_task(struct iscsi_task *task); |
| 380 | extern void iscsi_put_task(struct iscsi_task *task); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 381 | |
| 382 | /* |
| 383 | * generic helpers |
| 384 | */ |
Olaf Kirch | 6320377 | 2007-12-13 12:43:25 -0600 | [diff] [blame] | 385 | extern void iscsi_pool_free(struct iscsi_pool *); |
| 386 | extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 387 | |
Boaz Harrosh | 004d653 | 2007-12-13 12:43:23 -0600 | [diff] [blame] | 388 | /* |
| 389 | * inline functions to deal with padding. |
| 390 | */ |
| 391 | static inline unsigned int |
| 392 | iscsi_padded(unsigned int len) |
| 393 | { |
| 394 | return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1); |
| 395 | } |
| 396 | |
| 397 | static inline unsigned int |
| 398 | iscsi_padding(unsigned int len) |
| 399 | { |
| 400 | len &= (ISCSI_PAD_LEN - 1); |
| 401 | if (len) |
| 402 | len = ISCSI_PAD_LEN - len; |
| 403 | return len; |
| 404 | } |
| 405 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 406 | #endif |