blob: 9a8ff055342105f8a4823e9998e28fa10ea32a4b [file] [log] [blame]
Swen Schillig41fa2ad2007-09-07 09:15:31 +02001/*
Christof Schmitt553448f2008-06-10 18:20:58 +02002 * zfcp device driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Christof Schmitt553448f2008-06-10 18:20:58 +02004 * Global definitions for the zfcp device driver.
Swen Schillig41fa2ad2007-09-07 09:15:31 +02005 *
Christof Schmitta2fa0ae2009-03-02 13:09:08 +01006 * Copyright IBM Corporation 2002, 2009
Swen Schillig41fa2ad2007-09-07 09:15:31 +02007 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#ifndef ZFCP_DEF_H
10#define ZFCP_DEF_H
11
Linus Torvalds1da177e2005-04-16 15:20:36 -070012/*************************** INCLUDES *****************************************/
13
14#include <linux/init.h>
15#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/major.h>
17#include <linux/blkdev.h>
18#include <linux/delay.h>
19#include <linux/timer.h>
Heiko Carstensdd52e0e2006-09-18 22:28:49 +020020#include <linux/slab.h>
21#include <linux/mempool.h>
22#include <linux/syscalls.h>
FUJITA Tomonorif1346372007-07-30 23:01:32 +090023#include <linux/scatterlist.h>
Heiko Carstensdd52e0e2006-09-18 22:28:49 +020024#include <linux/ioctl.h>
Sven Schuetz9d544f22009-04-06 18:31:47 +020025#include <scsi/fc/fc_fs.h>
26#include <scsi/fc/fc_gs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <scsi/scsi.h>
28#include <scsi/scsi_tcq.h>
29#include <scsi/scsi_cmnd.h>
30#include <scsi/scsi_device.h>
31#include <scsi/scsi_host.h>
32#include <scsi/scsi_transport.h>
33#include <scsi/scsi_transport_fc.h>
Sven Schuetz9d544f22009-04-06 18:31:47 +020034#include <scsi/scsi_bsg_fc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <asm/ccwdev.h>
36#include <asm/qdio.h>
37#include <asm/debug.h>
38#include <asm/ebcdic.h>
Christof Schmittbd43a422008-12-25 13:38:50 +010039#include <asm/sysinfo.h>
Heiko Carstensdd52e0e2006-09-18 22:28:49 +020040#include "zfcp_fsf.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/********************* GENERAL DEFINES *********************************/
43
Andreas Herrmann06506d02006-05-22 18:18:19 +020044#define REQUEST_LIST_SIZE 128
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046/********************* SCSI SPECIFIC DEFINES *********************************/
Andreas Herrmannf6c0e7a2006-08-02 11:05:52 +020047#define ZFCP_SCSI_ER_TIMEOUT (10*HZ)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49/********************* CIO/QDIO SPECIFIC DEFINES *****************************/
50
Linus Torvalds1da177e2005-04-16 15:20:36 -070051/* DMQ bug workaround: don't use last SBALE */
52#define ZFCP_MAX_SBALES_PER_SBAL (QDIO_MAX_ELEMENTS_PER_BUFFER - 1)
53
54/* index of last SBALE (with respect to DMQ bug workaround) */
55#define ZFCP_LAST_SBALE_PER_SBAL (ZFCP_MAX_SBALES_PER_SBAL - 1)
56
57/* max. number of (data buffer) SBALEs in largest SBAL chain */
58#define ZFCP_MAX_SBALES_PER_REQ \
Swen Schilligc41f8cb2008-07-02 10:56:39 +020059 (FSF_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */
61
Swen Schillig8d1a0062006-10-12 11:43:44 +020062#define ZFCP_MAX_SECTORS (ZFCP_MAX_SBALES_PER_REQ * 8)
63 /* max. number of (data buffer) SBALEs in largest SBAL chain
64 multiplied with number of sectors per 4k block */
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066/********************* FSF SPECIFIC DEFINES *********************************/
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068/* ATTENTION: value must not be used by hardware */
69#define FSF_QTCB_UNSOLICITED_STATUS 0x6305
Andreas Herrmann22753fa2005-06-13 13:15:15 +020070
Linus Torvalds1da177e2005-04-16 15:20:36 -070071/* timeout value for "default timer" for fsf requests */
Andreas Herrmann2abbe862006-09-18 22:29:56 +020072#define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74/*************** FIBRE CHANNEL PROTOCOL SPECIFIC DEFINES ********************/
75
Linus Torvalds1da177e2005-04-16 15:20:36 -070076/* timeout for name-server lookup (in seconds) */
77#define ZFCP_NS_GID_PN_TIMEOUT 10
78
Linus Torvalds1da177e2005-04-16 15:20:36 -070079/* task attribute values in FCP-2 FCP_CMND IU */
80#define SIMPLE_Q 0
81#define HEAD_OF_Q 1
82#define ORDERED_Q 2
83#define ACA_Q 4
84#define UNTAGGED 5
85
86/* task management flags in FCP-2 FCP_CMND IU */
87#define FCP_CLEAR_ACA 0x40
88#define FCP_TARGET_RESET 0x20
89#define FCP_LOGICAL_UNIT_RESET 0x10
90#define FCP_CLEAR_TASK_SET 0x04
91#define FCP_ABORT_TASK_SET 0x02
92
93#define FCP_CDB_LENGTH 16
94
95#define ZFCP_DID_MASK 0x00FFFFFF
96
97/* FCP(-2) FCP_CMND IU */
98struct fcp_cmnd_iu {
Swen Schillig7ba58c92008-10-01 12:42:18 +020099 u64 fcp_lun; /* FCP logical unit number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 u8 crn; /* command reference number */
101 u8 reserved0:5; /* reserved */
102 u8 task_attribute:3; /* task attribute */
103 u8 task_management_flags; /* task management flags */
104 u8 add_fcp_cdb_length:6; /* additional FCP_CDB length */
105 u8 rddata:1; /* read data */
106 u8 wddata:1; /* write data */
107 u8 fcp_cdb[FCP_CDB_LENGTH];
108} __attribute__((packed));
109
110/* FCP(-2) FCP_RSP IU */
111struct fcp_rsp_iu {
112 u8 reserved0[10];
113 union {
114 struct {
115 u8 reserved1:3;
116 u8 fcp_conf_req:1;
117 u8 fcp_resid_under:1;
118 u8 fcp_resid_over:1;
119 u8 fcp_sns_len_valid:1;
120 u8 fcp_rsp_len_valid:1;
121 } bits;
122 u8 value;
123 } validity;
124 u8 scsi_status;
125 u32 fcp_resid;
126 u32 fcp_sns_len;
127 u32 fcp_rsp_len;
128} __attribute__((packed));
129
130
131#define RSP_CODE_GOOD 0
132#define RSP_CODE_LENGTH_MISMATCH 1
133#define RSP_CODE_FIELD_INVALID 2
134#define RSP_CODE_RO_MISMATCH 3
135#define RSP_CODE_TASKMAN_UNSUPP 4
136#define RSP_CODE_TASKMAN_FAILED 5
137
138/* see fc-fs */
Christof Schmitt24073b42008-06-10 18:20:54 +0200139#define LS_RSCN 0x61
140#define LS_LOGO 0x05
141#define LS_PLOGI 0x03
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143struct fcp_rscn_head {
144 u8 command;
145 u8 page_length; /* always 0x04 */
146 u16 payload_len;
147} __attribute__((packed));
148
149struct fcp_rscn_element {
150 u8 reserved:2;
151 u8 event_qual:4;
152 u8 addr_format:2;
153 u32 nport_did:24;
154} __attribute__((packed));
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156/* see fc-ph */
157struct fcp_logo {
158 u32 command;
159 u32 nport_did;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200160 u64 nport_wwpn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161} __attribute__((packed));
162
163/*
164 * FC-FS stuff
165 */
166#define R_A_TOV 10 /* seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168#define ZFCP_LS_RLS 0x0f
169#define ZFCP_LS_ADISC 0x52
170#define ZFCP_LS_RPS 0x56
171#define ZFCP_LS_RSCN 0x61
172#define ZFCP_LS_RNID 0x78
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174struct zfcp_ls_adisc {
175 u8 code;
176 u8 field[3];
177 u32 hard_nport_id;
178 u64 wwpn;
179 u64 wwnn;
180 u32 nport_id;
181} __attribute__ ((packed));
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183/*
184 * FC-GS-2 stuff
185 */
186#define ZFCP_CT_REVISION 0x01
187#define ZFCP_CT_DIRECTORY_SERVICE 0xFC
188#define ZFCP_CT_NAME_SERVER 0x02
189#define ZFCP_CT_SYNCHRONOUS 0x00
Swen Schilligcc8c2822008-06-10 18:21:00 +0200190#define ZFCP_CT_SCSI_FCP 0x08
191#define ZFCP_CT_UNABLE_TO_PERFORM_CMD 0x09
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192#define ZFCP_CT_GID_PN 0x0121
Swen Schilligcc8c2822008-06-10 18:21:00 +0200193#define ZFCP_CT_GPN_FT 0x0172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194#define ZFCP_CT_ACCEPT 0x8002
195#define ZFCP_CT_REJECT 0x8001
196
197/*
198 * FC-GS-4 stuff
199 */
200#define ZFCP_CT_TIMEOUT (3 * R_A_TOV)
201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202/*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
203
Swen Schillig41fa2ad2007-09-07 09:15:31 +0200204/*
205 * Note, the leftmost status byte is common among adapter, port
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 * and unit
207 */
208#define ZFCP_COMMON_FLAGS 0xfff00000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210/* common status bits */
211#define ZFCP_STATUS_COMMON_REMOVE 0x80000000
212#define ZFCP_STATUS_COMMON_RUNNING 0x40000000
213#define ZFCP_STATUS_COMMON_ERP_FAILED 0x20000000
214#define ZFCP_STATUS_COMMON_UNBLOCKED 0x10000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215#define ZFCP_STATUS_COMMON_OPEN 0x04000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216#define ZFCP_STATUS_COMMON_ERP_INUSE 0x01000000
217#define ZFCP_STATUS_COMMON_ACCESS_DENIED 0x00800000
Andreas Herrmannd736a272005-06-13 13:23:57 +0200218#define ZFCP_STATUS_COMMON_ACCESS_BOXED 0x00400000
Swen Schilligcc8c2822008-06-10 18:21:00 +0200219#define ZFCP_STATUS_COMMON_NOESC 0x00200000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221/* adapter status */
222#define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223#define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008
224#define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010
225#define ZFCP_STATUS_ADAPTER_ERP_THREAD_UP 0x00000020
226#define ZFCP_STATUS_ADAPTER_ERP_THREAD_KILL 0x00000080
227#define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100
228#define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200
229
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230/* FC-PH/FC-GS well-known address identifiers for generic services */
Swen Schillig5ab944f2008-10-01 12:42:17 +0200231#define ZFCP_DID_WKA 0xFFFFF0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233/* remote port status */
234#define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001
Christof Schmitt14e242e2009-08-18 15:43:11 +0200235#define ZFCP_STATUS_PORT_LINK_TEST 0x00000002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Swen Schillig5ab944f2008-10-01 12:42:17 +0200237/* well known address (WKA) port status*/
238enum zfcp_wka_status {
239 ZFCP_WKA_PORT_OFFLINE,
240 ZFCP_WKA_PORT_CLOSING,
241 ZFCP_WKA_PORT_OPENING,
242 ZFCP_WKA_PORT_ONLINE,
243};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245/* logical unit status */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246#define ZFCP_STATUS_UNIT_SHARED 0x00000004
247#define ZFCP_STATUS_UNIT_READONLY 0x00000008
248
249/* FSF request status (this does not have a common part) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250#define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT 0x00000002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251#define ZFCP_STATUS_FSFREQ_ERROR 0x00000008
252#define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253#define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040
254#define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080
255#define ZFCP_STATUS_FSFREQ_ABORTED 0x00000100
256#define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200
257#define ZFCP_STATUS_FSFREQ_TMFUNCNOTSUPP 0x00000400
258#define ZFCP_STATUS_FSFREQ_RETRY 0x00000800
259#define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000
260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261/************************* STRUCTURE DEFINITIONS *****************************/
262
263struct zfcp_fsf_req;
264
265/* holds various memory pools of an adapter */
266struct zfcp_adapter_mempool {
Swen Schilliga4623c42009-08-18 15:43:15 +0200267 mempool_t *erp_req;
Christof Schmitt799b76d2009-08-18 15:43:20 +0200268 mempool_t *gid_pn_req;
Swen Schilliga4623c42009-08-18 15:43:15 +0200269 mempool_t *scsi_req;
270 mempool_t *scsi_abort;
271 mempool_t *status_read_req;
272 mempool_t *status_read_data;
273 mempool_t *gid_pn_data;
274 mempool_t *qtcb_pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275};
276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277/*
278 * header for CT_IU
279 */
280struct ct_hdr {
281 u8 revision; // 0x01
282 u8 in_id[3]; // 0x00
283 u8 gs_type; // 0xFC Directory Service
284 u8 gs_subtype; // 0x02 Name Server
285 u8 options; // 0x00 single bidirectional exchange
286 u8 reserved0;
287 u16 cmd_rsp_code; // 0x0121 GID_PN, or 0x0100 GA_NXT
288 u16 max_res_size; // <= (4096 - 16) / 4
289 u8 reserved1;
290 u8 reason_code;
291 u8 reason_code_expl;
292 u8 vendor_unique;
293} __attribute__ ((packed));
294
295/* nameserver request CT_IU -- for requests where
296 * a port name is required */
297struct ct_iu_gid_pn_req {
298 struct ct_hdr header;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200299 u64 wwpn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300} __attribute__ ((packed));
301
302/* FS_ACC IU and data unit for GID_PN nameserver request */
303struct ct_iu_gid_pn_resp {
304 struct ct_hdr header;
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200305 u32 d_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306} __attribute__ ((packed));
307
Swen Schilliga4623c42009-08-18 15:43:15 +0200308struct ct_iu_gpn_ft_req {
309 struct ct_hdr header;
310 u8 flags;
311 u8 domain_id_scope;
312 u8 area_id_scope;
313 u8 fc4_type;
314} __attribute__ ((packed));
315
316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317/**
318 * struct zfcp_send_ct - used to pass parameters to function zfcp_fsf_send_ct
Swen Schillig5ab944f2008-10-01 12:42:17 +0200319 * @wka_port: port where the request is sent to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 * @req: scatter-gather list for request
321 * @resp: scatter-gather list for response
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 * @handler: handler function (called for response to the request)
323 * @handler_data: data passed to handler function
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 * @timeout: FSF timeout for this request
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 * @completion: completion for synchronization purposes
326 * @status: used to pass error status to calling function
327 */
328struct zfcp_send_ct {
Swen Schillig5ab944f2008-10-01 12:42:17 +0200329 struct zfcp_wka_port *wka_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 struct scatterlist *req;
331 struct scatterlist *resp;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200332 void (*handler)(unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 unsigned long handler_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 int timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 struct completion *completion;
336 int status;
337};
338
339/* used for name server requests in error recovery */
340struct zfcp_gid_pn_data {
341 struct zfcp_send_ct ct;
342 struct scatterlist req;
343 struct scatterlist resp;
344 struct ct_iu_gid_pn_req ct_iu_req;
345 struct ct_iu_gid_pn_resp ct_iu_resp;
346 struct zfcp_port *port;
347};
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349/**
350 * struct zfcp_send_els - used to pass parameters to function zfcp_fsf_send_els
351 * @adapter: adapter where request is sent from
Andreas Herrmann64b29a132005-06-13 13:18:56 +0200352 * @port: port where ELS is destinated (port reference count has to be increased)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 * @d_id: destiniation id of port where request is sent to
354 * @req: scatter-gather list for request
355 * @resp: scatter-gather list for response
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 * @handler: handler function (called for response to the request)
357 * @handler_data: data passed to handler function
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 * @completion: completion for synchronization purposes
359 * @ls_code: hex code of ELS command
360 * @status: used to pass error status to calling function
361 */
362struct zfcp_send_els {
363 struct zfcp_adapter *adapter;
Andreas Herrmann64b29a132005-06-13 13:18:56 +0200364 struct zfcp_port *port;
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200365 u32 d_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 struct scatterlist *req;
367 struct scatterlist *resp;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200368 void (*handler)(unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 unsigned long handler_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 struct completion *completion;
371 int ls_code;
372 int status;
373};
374
Swen Schillig5ab944f2008-10-01 12:42:17 +0200375struct zfcp_wka_port {
376 struct zfcp_adapter *adapter;
377 wait_queue_head_t completion_wq;
378 enum zfcp_wka_status status;
379 atomic_t refcount;
380 u32 d_id;
381 u32 handle;
382 struct mutex mutex;
383 struct delayed_work work;
384};
385
Sven Schuetz9d544f22009-04-06 18:31:47 +0200386struct zfcp_wka_ports {
387 struct zfcp_wka_port ms; /* management service */
388 struct zfcp_wka_port ts; /* time service */
389 struct zfcp_wka_port ds; /* directory service */
390 struct zfcp_wka_port as; /* alias service */
391 struct zfcp_wka_port ks; /* key distribution service */
392};
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394struct zfcp_qdio_queue {
Christof Schmitt04062892008-10-01 12:42:20 +0200395 struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q];
396 u8 first; /* index of next free bfr in queue */
397 atomic_t count; /* number of free buffers in queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398};
399
400struct zfcp_erp_action {
401 struct list_head list;
402 int action; /* requested action code */
403 struct zfcp_adapter *adapter; /* device which should be recovered */
404 struct zfcp_port *port;
405 struct zfcp_unit *unit;
Swen Schillig44cc76f2008-10-01 12:42:16 +0200406 u32 status; /* recovery status */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 u32 step; /* active step of this erp action */
408 struct zfcp_fsf_req *fsf_req; /* fsf request currently pending
409 for this action */
410 struct timer_list timer;
411};
412
Christof Schmittc9615852008-05-06 11:00:05 +0200413struct fsf_latency_record {
414 u32 min;
415 u32 max;
416 u64 sum;
417};
418
419struct latency_cont {
420 struct fsf_latency_record channel;
421 struct fsf_latency_record fabric;
422 u64 counter;
423};
424
425struct zfcp_latencies {
426 struct latency_cont read;
427 struct latency_cont write;
428 struct latency_cont cmd;
429 spinlock_t lock;
430};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
Swen Schillig564e1c82009-08-18 15:43:19 +0200432/** struct zfcp_qdio - basic QDIO data structure
433 * @resp_q: response queue
434 * @req_q: request queue
435 * @stat_lock: lock to protect req_q_util and req_q_time
436 * @req_q_lock; lock to serialize access to request queue
437 * @req_q_time: time of last fill level change
438 * @req_q_util: used for accounting
439 * @req_q_full: queue full incidents
440 * @req_q_wq: used to wait for SBAL availability
441 * @adapter: adapter used in conjunction with this QDIO structure
442 */
443struct zfcp_qdio {
444 struct zfcp_qdio_queue resp_q;
445 struct zfcp_qdio_queue req_q;
446 spinlock_t stat_lock;
447 spinlock_t req_q_lock;
448 ktime_t req_q_time;
449 u64 req_q_util;
450 atomic_t req_q_full;
451 wait_queue_head_t req_q_wq;
452 struct zfcp_adapter *adapter;
453};
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455struct zfcp_adapter {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 atomic_t refcount; /* reference count */
457 wait_queue_head_t remove_wq; /* can be used to wait for
458 refcount drop to zero */
Swen Schillig7ba58c92008-10-01 12:42:18 +0200459 u64 peer_wwnn; /* P2P peer WWNN */
460 u64 peer_wwpn; /* P2P peer WWPN */
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200461 u32 peer_d_id; /* P2P peer D_ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 struct ccw_device *ccw_device; /* S/390 ccw device */
Swen Schillig564e1c82009-08-18 15:43:19 +0200463 struct zfcp_qdio *qdio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 u32 hydra_version; /* Hydra version */
465 u32 fsf_lic_version;
Maxim Shchetyninaef4a982005-09-13 21:51:16 +0200466 u32 adapter_features; /* FCP channel features */
467 u32 connection_features; /* host connection features */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 u32 hardware_version; /* of FCP channel */
Christof Schmittc9615852008-05-06 11:00:05 +0200469 u16 timer_ticks; /* time int for a tick */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 struct Scsi_Host *scsi_host; /* Pointer to mid-layer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 struct list_head port_list_head; /* remote port list */
Volker Sameskefea9d6c2006-08-02 11:05:16 +0200472 unsigned long req_no; /* unique FSF req number */
473 struct list_head *req_list; /* list of pending reqs */
474 spinlock_t req_list_lock; /* request list lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 u32 fsf_req_seq_no; /* FSF cmnd seq number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 rwlock_t abort_lock; /* Protects against SCSI
477 stack abort/command
478 completion races */
Swen Schilligd26ab062008-05-19 12:17:37 +0200479 atomic_t stat_miss; /* # missing status reads*/
480 struct work_struct stat_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 atomic_t status; /* status of this adapter */
482 struct list_head erp_ready_head; /* error recovery for this
483 adapter/devices */
484 struct list_head erp_running_head;
485 rwlock_t erp_lock;
486 struct semaphore erp_ready_sem;
487 wait_queue_head_t erp_thread_wqh;
488 wait_queue_head_t erp_done_wqh;
489 struct zfcp_erp_action erp_action; /* pending error recovery */
490 atomic_t erp_counter;
491 u32 erp_total_count; /* total nr of enqueued erp
492 actions */
493 u32 erp_low_mem_count; /* nr of erp actions waiting
494 for memory */
Sven Schuetz9d544f22009-04-06 18:31:47 +0200495 struct zfcp_wka_ports *gs; /* generic services */
Christof Schmittd46f3842009-08-18 15:43:07 +0200496 struct zfcp_dbf *dbf; /* debug traces */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 struct zfcp_adapter_mempool pool; /* Adapter memory pools */
Andreas Herrmannf6cd94b2006-01-05 09:59:34 +0100498 struct fc_host_statistics *fc_stats;
499 struct fsf_qtcb_bottom_port *stats_reset_data;
500 unsigned long stats_reset;
Swen Schilligcc8c2822008-06-10 18:21:00 +0200501 struct work_struct scan_work;
Christof Schmittbd43a422008-12-25 13:38:50 +0100502 struct service_level service_level;
Swen Schillig45446832009-08-18 15:43:17 +0200503 struct workqueue_struct *work_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504};
505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506struct zfcp_port {
507 struct device sysfs_device; /* sysfs device */
Andreas Herrmann3859f6a2005-08-27 11:07:54 -0700508 struct fc_rport *rport; /* rport of fc transport class */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 struct list_head list; /* list of remote ports */
510 atomic_t refcount; /* reference count */
511 wait_queue_head_t remove_wq; /* can be used to wait for
512 refcount drop to zero */
513 struct zfcp_adapter *adapter; /* adapter used to access port */
514 struct list_head unit_list_head; /* head of logical unit list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 atomic_t status; /* status of this remote port */
Swen Schillig7ba58c92008-10-01 12:42:18 +0200516 u64 wwnn; /* WWNN if known */
517 u64 wwpn; /* WWPN */
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200518 u32 d_id; /* D_ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 u32 handle; /* handle assigned by FSF */
520 struct zfcp_erp_action erp_action; /* pending error recovery */
521 atomic_t erp_counter;
Ralph Wuerthner75bfc282006-05-22 18:24:33 +0200522 u32 maxframe_size;
523 u32 supported_classes;
Swen Schillig5ab944f2008-10-01 12:42:17 +0200524 struct work_struct gid_pn_work;
Christof Schmitt8fdf30d2009-03-02 13:09:01 +0100525 struct work_struct test_link_work;
Christof Schmitta2fa0ae2009-03-02 13:09:08 +0100526 struct work_struct rport_work;
527 enum { RPORT_NONE, RPORT_ADD, RPORT_DEL } rport_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528};
529
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530struct zfcp_unit {
531 struct device sysfs_device; /* sysfs device */
532 struct list_head list; /* list of logical units */
533 atomic_t refcount; /* reference count */
534 wait_queue_head_t remove_wq; /* can be used to wait for
535 refcount drop to zero */
536 struct zfcp_port *port; /* remote port of unit */
537 atomic_t status; /* status of this logical unit */
Swen Schillig7ba58c92008-10-01 12:42:18 +0200538 u64 fcp_lun; /* own FCP_LUN */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 u32 handle; /* handle assigned by FSF */
540 struct scsi_device *device; /* scsi device struct pointer */
541 struct zfcp_erp_action erp_action; /* pending error recovery */
542 atomic_t erp_counter;
Christof Schmittc9615852008-05-06 11:00:05 +0200543 struct zfcp_latencies latencies;
Swen Schillig92d51932009-04-17 15:08:04 +0200544 struct work_struct scsi_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545};
546
Swen Schillig42428f72009-08-18 15:43:18 +0200547/**
548 * struct zfcp_queue_req - queue related values for a request
549 * @sbal_number: number of free SBALs
550 * @sbal_first: first SBAL for this request
551 * @sbal_last: last SBAL for this request
552 * @sbal_limit: last possible SBAL for this request
553 * @sbale_curr: current SBALE at creation of this request
554 * @sbal_response: SBAL used in interrupt
555 * @qdio_outb_usage: usage of outbound queue
556 * @qdio_inb_usage: usage of inbound queue
557 */
558struct zfcp_queue_req {
559 u8 sbal_number;
560 u8 sbal_first;
561 u8 sbal_last;
562 u8 sbal_limit;
563 u8 sbale_curr;
564 u8 sbal_response;
565 u16 qdio_outb_usage;
566 u16 qdio_inb_usage;
567};
568
569/**
570 * struct zfcp_fsf_req - basic FSF request structure
571 * @list: list of FSF requests
572 * @req_id: unique request ID
573 * @adapter: adapter this request belongs to
574 * @queue_req: queue related values
575 * @completion: used to signal the completion of the request
576 * @status: status of the request
577 * @fsf_command: FSF command issued
578 * @qtcb: associated QTCB
579 * @seq_no: sequence number of this request
580 * @data: private data
581 * @timer: timer data of this request
582 * @erp_action: reference to erp action if request issued on behalf of ERP
583 * @pool: reference to memory pool if used for this request
584 * @issued: time when request was send (STCK)
585 * @unit: reference to unit if this request is a SCSI request
586 * @handler: handler which should be called to process response
587 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588struct zfcp_fsf_req {
Swen Schillig42428f72009-08-18 15:43:18 +0200589 struct list_head list;
590 unsigned long req_id;
591 struct zfcp_adapter *adapter;
592 struct zfcp_queue_req queue_req;
593 struct completion completion;
594 u32 status;
595 u32 fsf_command;
596 struct fsf_qtcb *qtcb;
597 u32 seq_no;
598 void *data;
599 struct timer_list timer;
600 struct zfcp_erp_action *erp_action;
601 mempool_t *pool;
602 unsigned long long issued;
603 struct zfcp_unit *unit;
Swen Schilligc41f8cb2008-07-02 10:56:39 +0200604 void (*handler)(struct zfcp_fsf_req *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605};
606
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607/* driver data */
608struct zfcp_data {
609 struct scsi_host_template scsi_host_template;
Heiko Carstensdd52e0e2006-09-18 22:28:49 +0200610 struct scsi_transport_template *scsi_transport_template;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 rwlock_t config_lock; /* serialises changes
612 to adapter/port/unit
613 lists */
614 struct semaphore config_sema; /* serialises configuration
615 changes */
Swen Schilliga4623c42009-08-18 15:43:15 +0200616 struct kmem_cache *gpn_ft_cache;
617 struct kmem_cache *qtcb_cache;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200618 struct kmem_cache *sr_buffer_cache;
619 struct kmem_cache *gid_pn_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620};
621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622/********************** ZFCP SPECIFIC DEFINES ********************************/
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624#define ZFCP_SET 0x00000100
625#define ZFCP_CLEAR 0x00000200
626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627/*
Heiko Carstensca2d02c2007-05-08 11:17:54 +0200628 * Helper functions for request ID management.
629 */
630static inline int zfcp_reqlist_hash(unsigned long req_id)
631{
632 return req_id % REQUEST_LIST_SIZE;
633}
634
Heiko Carstensca2d02c2007-05-08 11:17:54 +0200635static inline void zfcp_reqlist_remove(struct zfcp_adapter *adapter,
636 struct zfcp_fsf_req *fsf_req)
637{
638 list_del(&fsf_req->list);
639}
640
641static inline struct zfcp_fsf_req *
642zfcp_reqlist_find(struct zfcp_adapter *adapter, unsigned long req_id)
643{
644 struct zfcp_fsf_req *request;
645 unsigned int idx;
646
647 idx = zfcp_reqlist_hash(req_id);
648 list_for_each_entry(request, &adapter->req_list[idx], list)
649 if (request->req_id == req_id)
650 return request;
651 return NULL;
652}
653
Heiko Carstensd1ad09d2007-12-20 12:30:22 +0100654static inline struct zfcp_fsf_req *
655zfcp_reqlist_find_safe(struct zfcp_adapter *adapter, struct zfcp_fsf_req *req)
656{
657 struct zfcp_fsf_req *request;
658 unsigned int idx;
659
660 for (idx = 0; idx < REQUEST_LIST_SIZE; idx++) {
661 list_for_each_entry(request, &adapter->req_list[idx], list)
662 if (request == req)
663 return request;
664 }
665 return NULL;
666}
667
Heiko Carstensca2d02c2007-05-08 11:17:54 +0200668/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 * functions needed for reference/usage counting
670 */
671
672static inline void
673zfcp_unit_get(struct zfcp_unit *unit)
674{
675 atomic_inc(&unit->refcount);
676}
677
678static inline void
679zfcp_unit_put(struct zfcp_unit *unit)
680{
681 if (atomic_dec_return(&unit->refcount) == 0)
682 wake_up(&unit->remove_wq);
683}
684
685static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686zfcp_port_get(struct zfcp_port *port)
687{
688 atomic_inc(&port->refcount);
689}
690
691static inline void
692zfcp_port_put(struct zfcp_port *port)
693{
694 if (atomic_dec_return(&port->refcount) == 0)
695 wake_up(&port->remove_wq);
696}
697
698static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699zfcp_adapter_get(struct zfcp_adapter *adapter)
700{
701 atomic_inc(&adapter->refcount);
702}
703
704static inline void
705zfcp_adapter_put(struct zfcp_adapter *adapter)
706{
707 if (atomic_dec_return(&adapter->refcount) == 0)
708 wake_up(&adapter->remove_wq);
709}
710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711#endif /* ZFCP_DEF_H */