xref: /openbmc/linux/drivers/s390/scsi/zfcp_def.h (revision 64c70b1c)
1 /*
2  * This file is part of the zfcp device driver for
3  * FCP adapters for IBM System z9 and zSeries.
4  *
5  * (C) Copyright IBM Corp. 2002, 2006
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21 
22 #ifndef ZFCP_DEF_H
23 #define ZFCP_DEF_H
24 
25 /*************************** INCLUDES *****************************************/
26 
27 #include <linux/init.h>
28 #include <linux/moduleparam.h>
29 #include <linux/miscdevice.h>
30 #include <linux/major.h>
31 #include <linux/blkdev.h>
32 #include <linux/delay.h>
33 #include <linux/timer.h>
34 #include <linux/slab.h>
35 #include <linux/mempool.h>
36 #include <linux/syscalls.h>
37 #include <linux/ioctl.h>
38 #include <scsi/scsi.h>
39 #include <scsi/scsi_tcq.h>
40 #include <scsi/scsi_cmnd.h>
41 #include <scsi/scsi_device.h>
42 #include <scsi/scsi_host.h>
43 #include <scsi/scsi_transport.h>
44 #include <scsi/scsi_transport_fc.h>
45 #include <asm/ccwdev.h>
46 #include <asm/qdio.h>
47 #include <asm/debug.h>
48 #include <asm/ebcdic.h>
49 #include "zfcp_fsf.h"
50 
51 
52 /********************* GENERAL DEFINES *********************************/
53 
54 /* zfcp version number, it consists of major, minor, and patch-level number */
55 #define ZFCP_VERSION		"4.8.0"
56 
57 /**
58  * zfcp_sg_to_address - determine kernel address from struct scatterlist
59  * @list: struct scatterlist
60  * Return: kernel address
61  */
62 static inline void *
63 zfcp_sg_to_address(struct scatterlist *list)
64 {
65 	return (void *) (page_address(list->page) + list->offset);
66 }
67 
68 /**
69  * zfcp_address_to_sg - set up struct scatterlist from kernel address
70  * @address: kernel address
71  * @list: struct scatterlist
72  */
73 static inline void
74 zfcp_address_to_sg(void *address, struct scatterlist *list)
75 {
76 	list->page = virt_to_page(address);
77 	list->offset = ((unsigned long) address) & (PAGE_SIZE - 1);
78 }
79 
80 #define REQUEST_LIST_SIZE 128
81 
82 /********************* SCSI SPECIFIC DEFINES *********************************/
83 #define ZFCP_SCSI_ER_TIMEOUT                    (10*HZ)
84 
85 /********************* CIO/QDIO SPECIFIC DEFINES *****************************/
86 
87 /* Adapter Identification Parameters */
88 #define ZFCP_CONTROL_UNIT_TYPE  0x1731
89 #define ZFCP_CONTROL_UNIT_MODEL 0x03
90 #define ZFCP_DEVICE_TYPE        0x1732
91 #define ZFCP_DEVICE_MODEL       0x03
92 #define ZFCP_DEVICE_MODEL_PRIV	0x04
93 
94 /* allow as many chained SBALs as are supported by hardware */
95 #define ZFCP_MAX_SBALS_PER_REQ		FSF_MAX_SBALS_PER_REQ
96 #define ZFCP_MAX_SBALS_PER_CT_REQ	FSF_MAX_SBALS_PER_REQ
97 #define ZFCP_MAX_SBALS_PER_ELS_REQ	FSF_MAX_SBALS_PER_ELS_REQ
98 
99 /* DMQ bug workaround: don't use last SBALE */
100 #define ZFCP_MAX_SBALES_PER_SBAL	(QDIO_MAX_ELEMENTS_PER_BUFFER - 1)
101 
102 /* index of last SBALE (with respect to DMQ bug workaround) */
103 #define ZFCP_LAST_SBALE_PER_SBAL	(ZFCP_MAX_SBALES_PER_SBAL - 1)
104 
105 /* max. number of (data buffer) SBALEs in largest SBAL chain */
106 #define ZFCP_MAX_SBALES_PER_REQ		\
107 	(ZFCP_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2)
108         /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */
109 
110 #define ZFCP_MAX_SECTORS (ZFCP_MAX_SBALES_PER_REQ * 8)
111         /* max. number of (data buffer) SBALEs in largest SBAL chain
112            multiplied with number of sectors per 4k block */
113 
114 /* FIXME(tune): free space should be one max. SBAL chain plus what? */
115 #define ZFCP_QDIO_PCI_INTERVAL		(QDIO_MAX_BUFFERS_PER_Q \
116                                          - (ZFCP_MAX_SBALS_PER_REQ + 4))
117 
118 #define ZFCP_SBAL_TIMEOUT               (5*HZ)
119 
120 #define ZFCP_TYPE2_RECOVERY_TIME        (8*HZ)
121 
122 /* queue polling (values in microseconds) */
123 #define ZFCP_MAX_INPUT_THRESHOLD 	5000	/* FIXME: tune */
124 #define ZFCP_MAX_OUTPUT_THRESHOLD 	1000	/* FIXME: tune */
125 #define ZFCP_MIN_INPUT_THRESHOLD 	1	/* ignored by QDIO layer */
126 #define ZFCP_MIN_OUTPUT_THRESHOLD 	1	/* ignored by QDIO layer */
127 
128 #define QDIO_SCSI_QFMT			1	/* 1 for FSF */
129 
130 /********************* FSF SPECIFIC DEFINES *********************************/
131 
132 #define ZFCP_ULP_INFO_VERSION                   26
133 #define ZFCP_QTCB_VERSION	FSF_QTCB_CURRENT_VERSION
134 /* ATTENTION: value must not be used by hardware */
135 #define FSF_QTCB_UNSOLICITED_STATUS		0x6305
136 #define ZFCP_STATUS_READ_FAILED_THRESHOLD	3
137 #define ZFCP_STATUS_READS_RECOM		        FSF_STATUS_READS_RECOM
138 
139 /* Do 1st retry in 1 second, then double the timeout for each following retry */
140 #define ZFCP_EXCHANGE_CONFIG_DATA_FIRST_SLEEP	100
141 #define ZFCP_EXCHANGE_CONFIG_DATA_RETRIES	7
142 
143 /* timeout value for "default timer" for fsf requests */
144 #define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
145 
146 /*************** FIBRE CHANNEL PROTOCOL SPECIFIC DEFINES ********************/
147 
148 typedef unsigned long long wwn_t;
149 typedef unsigned long long fcp_lun_t;
150 /* data length field may be at variable position in FCP-2 FCP_CMND IU */
151 typedef unsigned int       fcp_dl_t;
152 
153 #define ZFCP_FC_SERVICE_CLASS_DEFAULT	FSF_CLASS_3
154 
155 /* timeout for name-server lookup (in seconds) */
156 #define ZFCP_NS_GID_PN_TIMEOUT		10
157 
158 /* largest SCSI command we can process */
159 /* FCP-2 (FCP_CMND IU) allows up to (255-3+16) */
160 #define ZFCP_MAX_SCSI_CMND_LENGTH	255
161 /* maximum number of commands in LUN queue (tagged queueing) */
162 #define ZFCP_CMND_PER_LUN               32
163 
164 /* task attribute values in FCP-2 FCP_CMND IU */
165 #define SIMPLE_Q	0
166 #define HEAD_OF_Q	1
167 #define ORDERED_Q	2
168 #define ACA_Q		4
169 #define UNTAGGED	5
170 
171 /* task management flags in FCP-2 FCP_CMND IU */
172 #define FCP_CLEAR_ACA		0x40
173 #define FCP_TARGET_RESET	0x20
174 #define FCP_LOGICAL_UNIT_RESET	0x10
175 #define FCP_CLEAR_TASK_SET	0x04
176 #define FCP_ABORT_TASK_SET	0x02
177 
178 #define FCP_CDB_LENGTH		16
179 
180 #define ZFCP_DID_MASK           0x00FFFFFF
181 
182 /* FCP(-2) FCP_CMND IU */
183 struct fcp_cmnd_iu {
184 	fcp_lun_t fcp_lun;	   /* FCP logical unit number */
185 	u8  crn;	           /* command reference number */
186 	u8  reserved0:5;	   /* reserved */
187 	u8  task_attribute:3;	   /* task attribute */
188 	u8  task_management_flags; /* task management flags */
189 	u8  add_fcp_cdb_length:6;  /* additional FCP_CDB length */
190 	u8  rddata:1;              /* read data */
191 	u8  wddata:1;              /* write data */
192 	u8  fcp_cdb[FCP_CDB_LENGTH];
193 } __attribute__((packed));
194 
195 /* FCP(-2) FCP_RSP IU */
196 struct fcp_rsp_iu {
197 	u8  reserved0[10];
198 	union {
199 		struct {
200 			u8 reserved1:3;
201 			u8 fcp_conf_req:1;
202 			u8 fcp_resid_under:1;
203 			u8 fcp_resid_over:1;
204 			u8 fcp_sns_len_valid:1;
205 			u8 fcp_rsp_len_valid:1;
206 		} bits;
207 		u8 value;
208 	} validity;
209 	u8  scsi_status;
210 	u32 fcp_resid;
211 	u32 fcp_sns_len;
212 	u32 fcp_rsp_len;
213 } __attribute__((packed));
214 
215 
216 #define RSP_CODE_GOOD		 0
217 #define RSP_CODE_LENGTH_MISMATCH 1
218 #define RSP_CODE_FIELD_INVALID	 2
219 #define RSP_CODE_RO_MISMATCH	 3
220 #define RSP_CODE_TASKMAN_UNSUPP	 4
221 #define RSP_CODE_TASKMAN_FAILED	 5
222 
223 /* see fc-fs */
224 #define LS_RSCN  0x61040000
225 #define LS_LOGO  0x05000000
226 #define LS_PLOGI 0x03000000
227 
228 struct fcp_rscn_head {
229         u8  command;
230         u8  page_length; /* always 0x04 */
231         u16 payload_len;
232 } __attribute__((packed));
233 
234 struct fcp_rscn_element {
235         u8  reserved:2;
236         u8  event_qual:4;
237         u8  addr_format:2;
238         u32 nport_did:24;
239 } __attribute__((packed));
240 
241 #define ZFCP_PORT_ADDRESS   0x0
242 #define ZFCP_AREA_ADDRESS   0x1
243 #define ZFCP_DOMAIN_ADDRESS 0x2
244 #define ZFCP_FABRIC_ADDRESS 0x3
245 
246 #define ZFCP_PORTS_RANGE_PORT   0xFFFFFF
247 #define ZFCP_PORTS_RANGE_AREA   0xFFFF00
248 #define ZFCP_PORTS_RANGE_DOMAIN 0xFF0000
249 #define ZFCP_PORTS_RANGE_FABRIC 0x000000
250 
251 #define ZFCP_NO_PORTS_PER_AREA    0x100
252 #define ZFCP_NO_PORTS_PER_DOMAIN  0x10000
253 #define ZFCP_NO_PORTS_PER_FABRIC  0x1000000
254 
255 /* see fc-ph */
256 struct fcp_logo {
257         u32 command;
258         u32 nport_did;
259         wwn_t nport_wwpn;
260 } __attribute__((packed));
261 
262 /*
263  * DBF stuff
264  */
265 #define ZFCP_DBF_TAG_SIZE      4
266 
267 struct zfcp_dbf_dump {
268 	u8 tag[ZFCP_DBF_TAG_SIZE];
269 	u32 total_size;		/* size of total dump data */
270 	u32 offset;		/* how much data has being already dumped */
271 	u32 size;		/* how much data comes with this record */
272 	u8 data[];		/* dump data */
273 } __attribute__ ((packed));
274 
275 /* FIXME: to be inflated when reworking the erp dbf */
276 struct zfcp_erp_dbf_record {
277 	u8 dummy[16];
278 } __attribute__ ((packed));
279 
280 struct zfcp_hba_dbf_record_response {
281 	u32 fsf_command;
282 	u64 fsf_reqid;
283 	u32 fsf_seqno;
284 	u64 fsf_issued;
285 	u32 fsf_prot_status;
286 	u32 fsf_status;
287 	u8 fsf_prot_status_qual[FSF_PROT_STATUS_QUAL_SIZE];
288 	u8 fsf_status_qual[FSF_STATUS_QUALIFIER_SIZE];
289 	u32 fsf_req_status;
290 	u8 sbal_first;
291 	u8 sbal_curr;
292 	u8 sbal_last;
293 	u8 pool;
294 	u64 erp_action;
295 	union {
296 		struct {
297 			u64 scsi_cmnd;
298 			u64 scsi_serial;
299 		} send_fcp;
300 		struct {
301 			u64 wwpn;
302 			u32 d_id;
303 			u32 port_handle;
304 		} port;
305 		struct {
306 			u64 wwpn;
307 			u64 fcp_lun;
308 			u32 port_handle;
309 			u32 lun_handle;
310 		} unit;
311 		struct {
312 			u32 d_id;
313 			u8 ls_code;
314 		} send_els;
315 	} data;
316 } __attribute__ ((packed));
317 
318 struct zfcp_hba_dbf_record_status {
319 	u8 failed;
320 	u32 status_type;
321 	u32 status_subtype;
322 	struct fsf_queue_designator
323 	 queue_designator;
324 	u32 payload_size;
325 #define ZFCP_DBF_UNSOL_PAYLOAD				80
326 #define ZFCP_DBF_UNSOL_PAYLOAD_SENSE_DATA_AVAIL		32
327 #define ZFCP_DBF_UNSOL_PAYLOAD_BIT_ERROR_THRESHOLD	56
328 #define ZFCP_DBF_UNSOL_PAYLOAD_FEATURE_UPDATE_ALERT	2 * sizeof(u32)
329 	u8 payload[ZFCP_DBF_UNSOL_PAYLOAD];
330 } __attribute__ ((packed));
331 
332 struct zfcp_hba_dbf_record_qdio {
333 	u32 status;
334 	u32 qdio_error;
335 	u32 siga_error;
336 	u8 sbal_index;
337 	u8 sbal_count;
338 } __attribute__ ((packed));
339 
340 struct zfcp_hba_dbf_record {
341 	u8 tag[ZFCP_DBF_TAG_SIZE];
342 	u8 tag2[ZFCP_DBF_TAG_SIZE];
343 	union {
344 		struct zfcp_hba_dbf_record_response response;
345 		struct zfcp_hba_dbf_record_status status;
346 		struct zfcp_hba_dbf_record_qdio qdio;
347 	} type;
348 } __attribute__ ((packed));
349 
350 struct zfcp_san_dbf_record_ct {
351 	union {
352 		struct {
353 			u16 cmd_req_code;
354 			u8 revision;
355 			u8 gs_type;
356 			u8 gs_subtype;
357 			u8 options;
358 			u16 max_res_size;
359 		} request;
360 		struct {
361 			u16 cmd_rsp_code;
362 			u8 revision;
363 			u8 reason_code;
364 			u8 reason_code_expl;
365 			u8 vendor_unique;
366 		} response;
367 	} type;
368 	u32 payload_size;
369 #define ZFCP_DBF_CT_PAYLOAD	24
370 	u8 payload[ZFCP_DBF_CT_PAYLOAD];
371 } __attribute__ ((packed));
372 
373 struct zfcp_san_dbf_record_els {
374 	u8 ls_code;
375 	u32 payload_size;
376 #define ZFCP_DBF_ELS_PAYLOAD	32
377 #define ZFCP_DBF_ELS_MAX_PAYLOAD 1024
378 	u8 payload[ZFCP_DBF_ELS_PAYLOAD];
379 } __attribute__ ((packed));
380 
381 struct zfcp_san_dbf_record {
382 	u8 tag[ZFCP_DBF_TAG_SIZE];
383 	u64 fsf_reqid;
384 	u32 fsf_seqno;
385 	u32 s_id;
386 	u32 d_id;
387 	union {
388 		struct zfcp_san_dbf_record_ct ct;
389 		struct zfcp_san_dbf_record_els els;
390 	} type;
391 } __attribute__ ((packed));
392 
393 struct zfcp_scsi_dbf_record {
394 	u8 tag[ZFCP_DBF_TAG_SIZE];
395 	u8 tag2[ZFCP_DBF_TAG_SIZE];
396 	u32 scsi_id;
397 	u32 scsi_lun;
398 	u32 scsi_result;
399 	u64 scsi_cmnd;
400 	u64 scsi_serial;
401 #define ZFCP_DBF_SCSI_OPCODE	16
402 	u8 scsi_opcode[ZFCP_DBF_SCSI_OPCODE];
403 	u8 scsi_retries;
404 	u8 scsi_allowed;
405 	u64 fsf_reqid;
406 	u32 fsf_seqno;
407 	u64 fsf_issued;
408 	union {
409 		u64 old_fsf_reqid;
410 		struct {
411 			u8 rsp_validity;
412 			u8 rsp_scsi_status;
413 			u32 rsp_resid;
414 			u8 rsp_code;
415 #define ZFCP_DBF_SCSI_FCP_SNS_INFO	16
416 #define ZFCP_DBF_SCSI_MAX_FCP_SNS_INFO	256
417 			u32 sns_info_len;
418 			u8 sns_info[ZFCP_DBF_SCSI_FCP_SNS_INFO];
419 		} fcp;
420 	} type;
421 } __attribute__ ((packed));
422 
423 /*
424  * FC-FS stuff
425  */
426 #define R_A_TOV				10 /* seconds */
427 #define ZFCP_ELS_TIMEOUT		(2 * R_A_TOV)
428 
429 #define ZFCP_LS_RLS			0x0f
430 #define ZFCP_LS_ADISC			0x52
431 #define ZFCP_LS_RPS			0x56
432 #define ZFCP_LS_RSCN			0x61
433 #define ZFCP_LS_RNID			0x78
434 
435 struct zfcp_ls_rjt_par {
436 	u8 action;
437  	u8 reason_code;
438  	u8 reason_expl;
439  	u8 vendor_unique;
440 } __attribute__ ((packed));
441 
442 struct zfcp_ls_adisc {
443 	u8		code;
444 	u8		field[3];
445 	u32		hard_nport_id;
446 	u64		wwpn;
447 	u64		wwnn;
448 	u32		nport_id;
449 } __attribute__ ((packed));
450 
451 struct zfcp_ls_adisc_acc {
452 	u8		code;
453 	u8		field[3];
454 	u32		hard_nport_id;
455 	u64		wwpn;
456 	u64		wwnn;
457 	u32		nport_id;
458 } __attribute__ ((packed));
459 
460 struct zfcp_rc_entry {
461 	u8 code;
462 	const char *description;
463 };
464 
465 /*
466  * FC-GS-2 stuff
467  */
468 #define ZFCP_CT_REVISION		0x01
469 #define ZFCP_CT_DIRECTORY_SERVICE	0xFC
470 #define ZFCP_CT_NAME_SERVER		0x02
471 #define ZFCP_CT_SYNCHRONOUS		0x00
472 #define ZFCP_CT_GID_PN			0x0121
473 #define ZFCP_CT_MAX_SIZE		0x1020
474 #define ZFCP_CT_ACCEPT			0x8002
475 #define ZFCP_CT_REJECT			0x8001
476 
477 /*
478  * FC-GS-4 stuff
479  */
480 #define ZFCP_CT_TIMEOUT			(3 * R_A_TOV)
481 
482 /******************** LOGGING MACROS AND DEFINES *****************************/
483 
484 /*
485  * Logging may be applied on certain kinds of driver operations
486  * independently. Additionally, different log-levels are supported for
487  * each of these areas.
488  */
489 
490 #define ZFCP_NAME               "zfcp"
491 
492 /* independent log areas */
493 #define ZFCP_LOG_AREA_OTHER	0
494 #define ZFCP_LOG_AREA_SCSI	1
495 #define ZFCP_LOG_AREA_FSF	2
496 #define ZFCP_LOG_AREA_CONFIG	3
497 #define ZFCP_LOG_AREA_CIO	4
498 #define ZFCP_LOG_AREA_QDIO	5
499 #define ZFCP_LOG_AREA_ERP	6
500 #define ZFCP_LOG_AREA_FC	7
501 
502 /* log level values*/
503 #define ZFCP_LOG_LEVEL_NORMAL	0
504 #define ZFCP_LOG_LEVEL_INFO	1
505 #define ZFCP_LOG_LEVEL_DEBUG	2
506 #define ZFCP_LOG_LEVEL_TRACE	3
507 
508 /*
509  * this allows removal of logging code by the preprocessor
510  * (the most detailed log level still to be compiled in is specified,
511  * higher log levels are removed)
512  */
513 #define ZFCP_LOG_LEVEL_LIMIT	ZFCP_LOG_LEVEL_TRACE
514 
515 /* get "loglevel" nibble assignment */
516 #define ZFCP_GET_LOG_VALUE(zfcp_lognibble) \
517 	       ((atomic_read(&zfcp_data.loglevel) >> (zfcp_lognibble<<2)) & 0xF)
518 
519 /* set "loglevel" nibble */
520 #define ZFCP_SET_LOG_NIBBLE(value, zfcp_lognibble) \
521 	       (value << (zfcp_lognibble << 2))
522 
523 /* all log-level defaults are combined to generate initial log-level */
524 #define ZFCP_LOG_LEVEL_DEFAULTS \
525 	(ZFCP_SET_LOG_NIBBLE(ZFCP_LOG_LEVEL_NORMAL, ZFCP_LOG_AREA_OTHER) | \
526 	 ZFCP_SET_LOG_NIBBLE(ZFCP_LOG_LEVEL_NORMAL, ZFCP_LOG_AREA_SCSI) | \
527 	 ZFCP_SET_LOG_NIBBLE(ZFCP_LOG_LEVEL_NORMAL, ZFCP_LOG_AREA_FSF) | \
528 	 ZFCP_SET_LOG_NIBBLE(ZFCP_LOG_LEVEL_NORMAL, ZFCP_LOG_AREA_CONFIG) | \
529 	 ZFCP_SET_LOG_NIBBLE(ZFCP_LOG_LEVEL_NORMAL, ZFCP_LOG_AREA_CIO) | \
530 	 ZFCP_SET_LOG_NIBBLE(ZFCP_LOG_LEVEL_NORMAL, ZFCP_LOG_AREA_QDIO) | \
531 	 ZFCP_SET_LOG_NIBBLE(ZFCP_LOG_LEVEL_NORMAL, ZFCP_LOG_AREA_ERP) | \
532 	 ZFCP_SET_LOG_NIBBLE(ZFCP_LOG_LEVEL_NORMAL, ZFCP_LOG_AREA_FC))
533 
534 /* check whether we have the right level for logging */
535 #define ZFCP_LOG_CHECK(level) \
536 	((ZFCP_GET_LOG_VALUE(ZFCP_LOG_AREA)) >= level)
537 
538 /* logging routine for zfcp */
539 #define _ZFCP_LOG(fmt, args...) \
540 	printk(KERN_ERR ZFCP_NAME": %s(%d): " fmt, __FUNCTION__, \
541 	       __LINE__ , ##args)
542 
543 #define ZFCP_LOG(level, fmt, args...) \
544 do { \
545 	if (ZFCP_LOG_CHECK(level)) \
546 		_ZFCP_LOG(fmt, ##args); \
547 } while (0)
548 
549 #if ZFCP_LOG_LEVEL_LIMIT < ZFCP_LOG_LEVEL_NORMAL
550 # define ZFCP_LOG_NORMAL(fmt, args...)	do { } while (0)
551 #else
552 # define ZFCP_LOG_NORMAL(fmt, args...) \
553 do { \
554 	if (ZFCP_LOG_CHECK(ZFCP_LOG_LEVEL_NORMAL)) \
555 		printk(KERN_ERR ZFCP_NAME": " fmt, ##args); \
556 } while (0)
557 #endif
558 
559 #if ZFCP_LOG_LEVEL_LIMIT < ZFCP_LOG_LEVEL_INFO
560 # define ZFCP_LOG_INFO(fmt, args...)	do { } while (0)
561 #else
562 # define ZFCP_LOG_INFO(fmt, args...) \
563 do { \
564 	if (ZFCP_LOG_CHECK(ZFCP_LOG_LEVEL_INFO)) \
565 		printk(KERN_ERR ZFCP_NAME": " fmt, ##args); \
566 } while (0)
567 #endif
568 
569 #if ZFCP_LOG_LEVEL_LIMIT < ZFCP_LOG_LEVEL_DEBUG
570 # define ZFCP_LOG_DEBUG(fmt, args...)	do { } while (0)
571 #else
572 # define ZFCP_LOG_DEBUG(fmt, args...) \
573 	ZFCP_LOG(ZFCP_LOG_LEVEL_DEBUG, fmt , ##args)
574 #endif
575 
576 #if ZFCP_LOG_LEVEL_LIMIT < ZFCP_LOG_LEVEL_TRACE
577 # define ZFCP_LOG_TRACE(fmt, args...)	do { } while (0)
578 #else
579 # define ZFCP_LOG_TRACE(fmt, args...) \
580 	ZFCP_LOG(ZFCP_LOG_LEVEL_TRACE, fmt , ##args)
581 #endif
582 
583 /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
584 
585 /*
586  * Note, the leftmost status byte is common among adapter, port
587  * and unit
588  */
589 #define ZFCP_COMMON_FLAGS			0xfff00000
590 
591 /* common status bits */
592 #define ZFCP_STATUS_COMMON_REMOVE		0x80000000
593 #define ZFCP_STATUS_COMMON_RUNNING		0x40000000
594 #define ZFCP_STATUS_COMMON_ERP_FAILED		0x20000000
595 #define ZFCP_STATUS_COMMON_UNBLOCKED		0x10000000
596 #define ZFCP_STATUS_COMMON_OPENING              0x08000000
597 #define ZFCP_STATUS_COMMON_OPEN                 0x04000000
598 #define ZFCP_STATUS_COMMON_CLOSING              0x02000000
599 #define ZFCP_STATUS_COMMON_ERP_INUSE		0x01000000
600 #define ZFCP_STATUS_COMMON_ACCESS_DENIED	0x00800000
601 #define ZFCP_STATUS_COMMON_ACCESS_BOXED		0x00400000
602 
603 /* adapter status */
604 #define ZFCP_STATUS_ADAPTER_QDIOUP		0x00000002
605 #define ZFCP_STATUS_ADAPTER_REGISTERED		0x00000004
606 #define ZFCP_STATUS_ADAPTER_XCONFIG_OK		0x00000008
607 #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT	0x00000010
608 #define ZFCP_STATUS_ADAPTER_ERP_THREAD_UP	0x00000020
609 #define ZFCP_STATUS_ADAPTER_ERP_THREAD_KILL	0x00000080
610 #define ZFCP_STATUS_ADAPTER_ERP_PENDING		0x00000100
611 #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED	0x00000200
612 #define ZFCP_STATUS_ADAPTER_XPORT_OK		0x00000800
613 
614 /* FC-PH/FC-GS well-known address identifiers for generic services */
615 #define ZFCP_DID_MANAGEMENT_SERVICE		0xFFFFFA
616 #define ZFCP_DID_TIME_SERVICE			0xFFFFFB
617 #define ZFCP_DID_DIRECTORY_SERVICE		0xFFFFFC
618 #define ZFCP_DID_ALIAS_SERVICE			0xFFFFF8
619 #define ZFCP_DID_KEY_DISTRIBUTION_SERVICE	0xFFFFF7
620 
621 /* remote port status */
622 #define ZFCP_STATUS_PORT_PHYS_OPEN		0x00000001
623 #define ZFCP_STATUS_PORT_DID_DID		0x00000002
624 #define ZFCP_STATUS_PORT_PHYS_CLOSING		0x00000004
625 #define ZFCP_STATUS_PORT_NO_WWPN		0x00000008
626 #define ZFCP_STATUS_PORT_NO_SCSI_ID		0x00000010
627 #define ZFCP_STATUS_PORT_INVALID_WWPN		0x00000020
628 
629 /* for ports with well known addresses */
630 #define ZFCP_STATUS_PORT_WKA \
631 		(ZFCP_STATUS_PORT_NO_WWPN | \
632 		 ZFCP_STATUS_PORT_NO_SCSI_ID)
633 
634 /* logical unit status */
635 #define ZFCP_STATUS_UNIT_NOTSUPPUNITRESET	0x00000001
636 #define ZFCP_STATUS_UNIT_TEMPORARY		0x00000002
637 #define ZFCP_STATUS_UNIT_SHARED			0x00000004
638 #define ZFCP_STATUS_UNIT_READONLY		0x00000008
639 #define ZFCP_STATUS_UNIT_REGISTERED		0x00000010
640 #define ZFCP_STATUS_UNIT_SCSI_WORK_PENDING	0x00000020
641 
642 /* FSF request status (this does not have a common part) */
643 #define ZFCP_STATUS_FSFREQ_NOT_INIT		0x00000000
644 #define ZFCP_STATUS_FSFREQ_POOL  		0x00000001
645 #define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT	0x00000002
646 #define ZFCP_STATUS_FSFREQ_COMPLETED		0x00000004
647 #define ZFCP_STATUS_FSFREQ_ERROR		0x00000008
648 #define ZFCP_STATUS_FSFREQ_CLEANUP		0x00000010
649 #define ZFCP_STATUS_FSFREQ_ABORTING		0x00000020
650 #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED	0x00000040
651 #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED       0x00000080
652 #define ZFCP_STATUS_FSFREQ_ABORTED              0x00000100
653 #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED         0x00000200
654 #define ZFCP_STATUS_FSFREQ_TMFUNCNOTSUPP        0x00000400
655 #define ZFCP_STATUS_FSFREQ_RETRY                0x00000800
656 #define ZFCP_STATUS_FSFREQ_DISMISSED            0x00001000
657 
658 /*********************** ERROR RECOVERY PROCEDURE DEFINES ********************/
659 
660 #define ZFCP_MAX_ERPS                   3
661 
662 #define ZFCP_ERP_FSFREQ_TIMEOUT		(30 * HZ)
663 #define ZFCP_ERP_MEMWAIT_TIMEOUT	HZ
664 
665 #define ZFCP_STATUS_ERP_TIMEDOUT	0x10000000
666 #define ZFCP_STATUS_ERP_CLOSE_ONLY	0x01000000
667 #define ZFCP_STATUS_ERP_DISMISSING	0x00100000
668 #define ZFCP_STATUS_ERP_DISMISSED	0x00200000
669 #define ZFCP_STATUS_ERP_LOWMEM		0x00400000
670 
671 #define ZFCP_ERP_STEP_UNINITIALIZED	0x00000000
672 #define ZFCP_ERP_STEP_FSF_XCONFIG	0x00000001
673 #define ZFCP_ERP_STEP_PHYS_PORT_CLOSING	0x00000010
674 #define ZFCP_ERP_STEP_PORT_CLOSING	0x00000100
675 #define ZFCP_ERP_STEP_NAMESERVER_OPEN	0x00000200
676 #define ZFCP_ERP_STEP_NAMESERVER_LOOKUP	0x00000400
677 #define ZFCP_ERP_STEP_PORT_OPENING	0x00000800
678 #define ZFCP_ERP_STEP_UNIT_CLOSING	0x00001000
679 #define ZFCP_ERP_STEP_UNIT_OPENING	0x00002000
680 
681 /* Ordered by escalation level (necessary for proper erp-code operation) */
682 #define ZFCP_ERP_ACTION_REOPEN_ADAPTER		0x4
683 #define ZFCP_ERP_ACTION_REOPEN_PORT_FORCED	0x3
684 #define ZFCP_ERP_ACTION_REOPEN_PORT		0x2
685 #define ZFCP_ERP_ACTION_REOPEN_UNIT		0x1
686 
687 #define ZFCP_ERP_ACTION_RUNNING			0x1
688 #define ZFCP_ERP_ACTION_READY			0x2
689 
690 #define ZFCP_ERP_SUCCEEDED	0x0
691 #define ZFCP_ERP_FAILED		0x1
692 #define ZFCP_ERP_CONTINUES	0x2
693 #define ZFCP_ERP_EXIT		0x3
694 #define ZFCP_ERP_DISMISSED	0x4
695 #define ZFCP_ERP_NOMEM		0x5
696 
697 
698 /******************** CFDC SPECIFIC STUFF *****************************/
699 
700 /* Firewall data channel sense data record */
701 struct zfcp_cfdc_sense_data {
702 	u32 signature;           /* Request signature */
703 	u32 devno;               /* FCP adapter device number */
704 	u32 command;             /* Command code */
705 	u32 fsf_status;          /* FSF request status and status qualifier */
706 	u8  fsf_status_qual[FSF_STATUS_QUALIFIER_SIZE];
707 	u8  payloads[256];       /* Access conflicts list */
708 	u8  control_file[0];     /* Access control table */
709 };
710 
711 #define ZFCP_CFDC_SIGNATURE			0xCFDCACDF
712 
713 #define ZFCP_CFDC_CMND_DOWNLOAD_NORMAL		0x00010001
714 #define ZFCP_CFDC_CMND_DOWNLOAD_FORCE		0x00010101
715 #define ZFCP_CFDC_CMND_FULL_ACCESS		0x00000201
716 #define ZFCP_CFDC_CMND_RESTRICTED_ACCESS	0x00000401
717 #define ZFCP_CFDC_CMND_UPLOAD			0x00010002
718 
719 #define ZFCP_CFDC_DOWNLOAD			0x00000001
720 #define ZFCP_CFDC_UPLOAD			0x00000002
721 #define ZFCP_CFDC_WITH_CONTROL_FILE		0x00010000
722 
723 #define ZFCP_CFDC_DEV_NAME			"zfcp_cfdc"
724 #define ZFCP_CFDC_DEV_MAJOR			MISC_MAJOR
725 #define ZFCP_CFDC_DEV_MINOR			MISC_DYNAMIC_MINOR
726 
727 #define ZFCP_CFDC_MAX_CONTROL_FILE_SIZE		127 * 1024
728 
729 /************************* STRUCTURE DEFINITIONS *****************************/
730 
731 struct zfcp_fsf_req;
732 
733 /* holds various memory pools of an adapter */
734 struct zfcp_adapter_mempool {
735 	mempool_t *fsf_req_erp;
736 	mempool_t *fsf_req_scsi;
737 	mempool_t *fsf_req_abort;
738 	mempool_t *fsf_req_status_read;
739 	mempool_t *data_status_read;
740 	mempool_t *data_gid_pn;
741 };
742 
743 /*
744  * header for CT_IU
745  */
746 struct ct_hdr {
747 	u8 revision;		// 0x01
748 	u8 in_id[3];		// 0x00
749 	u8 gs_type;		// 0xFC	Directory Service
750 	u8 gs_subtype;		// 0x02	Name Server
751 	u8 options;		// 0x00 single bidirectional exchange
752 	u8 reserved0;
753 	u16 cmd_rsp_code;	// 0x0121 GID_PN, or 0x0100 GA_NXT
754 	u16 max_res_size;	// <= (4096 - 16) / 4
755 	u8 reserved1;
756 	u8 reason_code;
757 	u8 reason_code_expl;
758 	u8 vendor_unique;
759 } __attribute__ ((packed));
760 
761 /* nameserver request CT_IU -- for requests where
762  * a port name is required */
763 struct ct_iu_gid_pn_req {
764 	struct ct_hdr header;
765 	wwn_t wwpn;
766 } __attribute__ ((packed));
767 
768 /* FS_ACC IU and data unit for GID_PN nameserver request */
769 struct ct_iu_gid_pn_resp {
770 	struct ct_hdr header;
771 	u32 d_id;
772 } __attribute__ ((packed));
773 
774 typedef void (*zfcp_send_ct_handler_t)(unsigned long);
775 
776 /**
777  * struct zfcp_send_ct - used to pass parameters to function zfcp_fsf_send_ct
778  * @port: port where the request is sent to
779  * @req: scatter-gather list for request
780  * @resp: scatter-gather list for response
781  * @req_count: number of elements in request scatter-gather list
782  * @resp_count: number of elements in response scatter-gather list
783  * @handler: handler function (called for response to the request)
784  * @handler_data: data passed to handler function
785  * @pool: pointer to memory pool for ct request structure
786  * @timeout: FSF timeout for this request
787  * @completion: completion for synchronization purposes
788  * @status: used to pass error status to calling function
789  */
790 struct zfcp_send_ct {
791 	struct zfcp_port *port;
792 	struct scatterlist *req;
793 	struct scatterlist *resp;
794 	unsigned int req_count;
795 	unsigned int resp_count;
796 	zfcp_send_ct_handler_t handler;
797 	unsigned long handler_data;
798 	mempool_t *pool;
799 	int timeout;
800 	struct completion *completion;
801 	int status;
802 };
803 
804 /* used for name server requests in error recovery */
805 struct zfcp_gid_pn_data {
806 	struct zfcp_send_ct ct;
807 	struct scatterlist req;
808 	struct scatterlist resp;
809 	struct ct_iu_gid_pn_req ct_iu_req;
810 	struct ct_iu_gid_pn_resp ct_iu_resp;
811         struct zfcp_port *port;
812 };
813 
814 typedef void (*zfcp_send_els_handler_t)(unsigned long);
815 
816 /**
817  * struct zfcp_send_els - used to pass parameters to function zfcp_fsf_send_els
818  * @adapter: adapter where request is sent from
819  * @port: port where ELS is destinated (port reference count has to be increased)
820  * @d_id: destiniation id of port where request is sent to
821  * @req: scatter-gather list for request
822  * @resp: scatter-gather list for response
823  * @req_count: number of elements in request scatter-gather list
824  * @resp_count: number of elements in response scatter-gather list
825  * @handler: handler function (called for response to the request)
826  * @handler_data: data passed to handler function
827  * @completion: completion for synchronization purposes
828  * @ls_code: hex code of ELS command
829  * @status: used to pass error status to calling function
830  */
831 struct zfcp_send_els {
832 	struct zfcp_adapter *adapter;
833 	struct zfcp_port *port;
834 	u32 d_id;
835 	struct scatterlist *req;
836 	struct scatterlist *resp;
837 	unsigned int req_count;
838 	unsigned int resp_count;
839 	zfcp_send_els_handler_t handler;
840 	unsigned long handler_data;
841 	struct completion *completion;
842 	int ls_code;
843 	int status;
844 };
845 
846 struct zfcp_qdio_queue {
847 	struct qdio_buffer *buffer[QDIO_MAX_BUFFERS_PER_Q]; /* SBALs */
848 	u8		   free_index;	      /* index of next free bfr
849 						 in queue (free_count>0) */
850 	atomic_t           free_count;	      /* number of free buffers
851 						 in queue */
852 	rwlock_t	   queue_lock;	      /* lock for operations on queue */
853         int                distance_from_int; /* SBALs used since PCI indication
854 						 was last set */
855 };
856 
857 struct zfcp_erp_action {
858 	struct list_head list;
859 	int action;	              /* requested action code */
860 	struct zfcp_adapter *adapter; /* device which should be recovered */
861 	struct zfcp_port *port;
862 	struct zfcp_unit *unit;
863 	volatile u32 status;	      /* recovery status */
864 	u32 step;	              /* active step of this erp action */
865 	struct zfcp_fsf_req *fsf_req; /* fsf request currently pending
866 					 for this action */
867 	struct timer_list timer;
868 };
869 
870 
871 struct zfcp_adapter {
872 	struct list_head	list;              /* list of adapters */
873 	atomic_t                refcount;          /* reference count */
874 	wait_queue_head_t	remove_wq;         /* can be used to wait for
875 						      refcount drop to zero */
876 	wwn_t			peer_wwnn;	   /* P2P peer WWNN */
877 	wwn_t			peer_wwpn;	   /* P2P peer WWPN */
878 	u32			peer_d_id;	   /* P2P peer D_ID */
879 	struct ccw_device       *ccw_device;	   /* S/390 ccw device */
880 	u32			hydra_version;	   /* Hydra version */
881 	u32			fsf_lic_version;
882 	u32			adapter_features;  /* FCP channel features */
883 	u32			connection_features; /* host connection features */
884         u32			hardware_version;  /* of FCP channel */
885 	struct Scsi_Host	*scsi_host;	   /* Pointer to mid-layer */
886 	struct list_head	port_list_head;	   /* remote port list */
887 	struct list_head        port_remove_lh;    /* head of ports to be
888 						      removed */
889 	u32			ports;	           /* number of remote ports */
890 	atomic_t		reqs_active;	   /* # active FSF reqs */
891 	unsigned long		req_no;		   /* unique FSF req number */
892 	struct list_head	*req_list;	   /* list of pending reqs */
893 	spinlock_t		req_list_lock;	   /* request list lock */
894 	struct zfcp_qdio_queue	request_queue;	   /* request queue */
895 	u32			fsf_req_seq_no;	   /* FSF cmnd seq number */
896 	wait_queue_head_t	request_wq;	   /* can be used to wait for
897 						      more avaliable SBALs */
898 	struct zfcp_qdio_queue	response_queue;	   /* response queue */
899 	rwlock_t		abort_lock;        /* Protects against SCSI
900 						      stack abort/command
901 						      completion races */
902 	u16			status_read_failed; /* # failed status reads */
903 	atomic_t		status;	           /* status of this adapter */
904 	struct list_head	erp_ready_head;	   /* error recovery for this
905 						      adapter/devices */
906 	struct list_head	erp_running_head;
907 	rwlock_t		erp_lock;
908 	struct semaphore	erp_ready_sem;
909 	wait_queue_head_t	erp_thread_wqh;
910 	wait_queue_head_t	erp_done_wqh;
911 	struct zfcp_erp_action	erp_action;	   /* pending error recovery */
912         atomic_t                erp_counter;
913 	u32			erp_total_count;   /* total nr of enqueued erp
914 						      actions */
915 	u32			erp_low_mem_count; /* nr of erp actions waiting
916 						      for memory */
917 	struct zfcp_port	*nameserver_port;  /* adapter's nameserver */
918 	debug_info_t		*erp_dbf;
919 	debug_info_t		*hba_dbf;
920 	debug_info_t		*san_dbf;          /* debug feature areas */
921 	debug_info_t		*scsi_dbf;
922 	spinlock_t		erp_dbf_lock;
923 	spinlock_t		hba_dbf_lock;
924 	spinlock_t		san_dbf_lock;
925 	spinlock_t		scsi_dbf_lock;
926 	struct zfcp_erp_dbf_record	erp_dbf_buf;
927 	struct zfcp_hba_dbf_record	hba_dbf_buf;
928 	struct zfcp_san_dbf_record	san_dbf_buf;
929 	struct zfcp_scsi_dbf_record	scsi_dbf_buf;
930 	struct zfcp_adapter_mempool	pool;      /* Adapter memory pools */
931 	struct qdio_initialize  qdio_init_data;    /* for qdio_establish */
932 	struct device           generic_services;  /* directory for WKA ports */
933 	struct fc_host_statistics *fc_stats;
934 	struct fsf_qtcb_bottom_port *stats_reset_data;
935 	unsigned long		stats_reset;
936 };
937 
938 /*
939  * the struct device sysfs_device must be at the beginning of this structure.
940  * pointer to struct device is used to free port structure in release function
941  * of the device. don't change!
942  */
943 struct zfcp_port {
944 	struct device          sysfs_device;   /* sysfs device */
945 	struct fc_rport        *rport;         /* rport of fc transport class */
946 	struct list_head       list;	       /* list of remote ports */
947 	atomic_t               refcount;       /* reference count */
948 	wait_queue_head_t      remove_wq;      /* can be used to wait for
949 						  refcount drop to zero */
950 	struct zfcp_adapter    *adapter;       /* adapter used to access port */
951 	struct list_head       unit_list_head; /* head of logical unit list */
952 	struct list_head       unit_remove_lh; /* head of luns to be removed
953 						  list */
954 	u32		       units;	       /* # of logical units in list */
955 	atomic_t	       status;	       /* status of this remote port */
956 	wwn_t		       wwnn;	       /* WWNN if known */
957 	wwn_t		       wwpn;	       /* WWPN */
958 	u32		       d_id;	       /* D_ID */
959 	u32		       handle;	       /* handle assigned by FSF */
960 	struct zfcp_erp_action erp_action;     /* pending error recovery */
961         atomic_t               erp_counter;
962 	u32                    maxframe_size;
963 	u32                    supported_classes;
964 };
965 
966 /* the struct device sysfs_device must be at the beginning of this structure.
967  * pointer to struct device is used to free unit structure in release function
968  * of the device. don't change!
969  */
970 struct zfcp_unit {
971 	struct device          sysfs_device;   /* sysfs device */
972 	struct list_head       list;	       /* list of logical units */
973 	atomic_t               refcount;       /* reference count */
974 	wait_queue_head_t      remove_wq;      /* can be used to wait for
975 						  refcount drop to zero */
976 	struct zfcp_port       *port;	       /* remote port of unit */
977 	atomic_t	       status;	       /* status of this logical unit */
978 	unsigned int	       scsi_lun;       /* own SCSI LUN */
979 	fcp_lun_t	       fcp_lun;	       /* own FCP_LUN */
980 	u32		       handle;	       /* handle assigned by FSF */
981         struct scsi_device     *device;        /* scsi device struct pointer */
982 	struct zfcp_erp_action erp_action;     /* pending error recovery */
983         atomic_t               erp_counter;
984 	wait_queue_head_t      scsi_scan_wq;   /* can be used to wait until
985 						  all scsi_scan_target
986 						  requests have been
987 						  completed. */
988 };
989 
990 /* FSF request */
991 struct zfcp_fsf_req {
992 	struct list_head       list;	       /* list of FSF requests */
993 	unsigned long	       req_id;	       /* unique request ID */
994 	struct zfcp_adapter    *adapter;       /* adapter request belongs to */
995 	u8		       sbal_number;    /* nr of SBALs free for use */
996 	u8		       sbal_first;     /* first SBAL for this request */
997 	u8		       sbal_last;      /* last possible SBAL for
998 						  this reuest */
999 	u8		       sbal_curr;      /* current SBAL during creation
1000 						  of request */
1001 	u8		       sbale_curr;     /* current SBALE during creation
1002 						  of request */
1003 	wait_queue_head_t      completion_wq;  /* can be used by a routine
1004 						  to wait for completion */
1005 	volatile u32	       status;	       /* status of this request */
1006 	u32		       fsf_command;    /* FSF Command copy */
1007 	struct fsf_qtcb	       *qtcb;	       /* address of associated QTCB */
1008 	u32		       seq_no;         /* Sequence number of request */
1009         unsigned long          data;           /* private data of request */
1010 	struct timer_list      timer;	       /* used for erp or scsi er */
1011 	struct zfcp_erp_action *erp_action;    /* used if this request is
1012 						  issued on behalf of erp */
1013 	mempool_t	       *pool;	       /* used if request was alloacted
1014 						  from emergency pool */
1015 	unsigned long long     issued;         /* request sent time (STCK) */
1016 	struct zfcp_unit       *unit;
1017 };
1018 
1019 typedef void zfcp_fsf_req_handler_t(struct zfcp_fsf_req*);
1020 
1021 /* driver data */
1022 struct zfcp_data {
1023 	struct scsi_host_template scsi_host_template;
1024 	struct scsi_transport_template *scsi_transport_template;
1025         atomic_t                status;             /* Module status flags */
1026 	struct list_head	adapter_list_head;  /* head of adapter list */
1027 	struct list_head	adapter_remove_lh;  /* head of adapters to be
1028 						       removed */
1029 	u32			adapters;	    /* # of adapters in list */
1030 	rwlock_t                config_lock;        /* serialises changes
1031 						       to adapter/port/unit
1032 						       lists */
1033 	struct semaphore        config_sema;        /* serialises configuration
1034 						       changes */
1035 	atomic_t		loglevel;            /* current loglevel */
1036 	char                    init_busid[BUS_ID_SIZE];
1037 	wwn_t                   init_wwpn;
1038 	fcp_lun_t               init_fcp_lun;
1039 	char 			*driver_version;
1040 	struct kmem_cache		*fsf_req_qtcb_cache;
1041 	struct kmem_cache		*sr_buffer_cache;
1042 	struct kmem_cache		*gid_pn_cache;
1043 };
1044 
1045 /**
1046  * struct zfcp_sg_list - struct describing a scatter-gather list
1047  * @sg: pointer to array of (struct scatterlist)
1048  * @count: number of elements in scatter-gather list
1049  */
1050 struct zfcp_sg_list {
1051 	struct scatterlist *sg;
1052 	unsigned int count;
1053 };
1054 
1055 /* number of elements for various memory pools */
1056 #define ZFCP_POOL_FSF_REQ_ERP_NR	1
1057 #define ZFCP_POOL_FSF_REQ_SCSI_NR	1
1058 #define ZFCP_POOL_FSF_REQ_ABORT_NR	1
1059 #define ZFCP_POOL_STATUS_READ_NR	ZFCP_STATUS_READS_RECOM
1060 #define ZFCP_POOL_DATA_GID_PN_NR	1
1061 
1062 /* struct used by memory pools for fsf_requests */
1063 struct zfcp_fsf_req_qtcb {
1064 	struct zfcp_fsf_req fsf_req;
1065 	struct fsf_qtcb qtcb;
1066 };
1067 
1068 /********************** ZFCP SPECIFIC DEFINES ********************************/
1069 
1070 #define ZFCP_REQ_AUTO_CLEANUP	0x00000002
1071 #define ZFCP_WAIT_FOR_SBAL	0x00000004
1072 #define ZFCP_REQ_NO_QTCB	0x00000008
1073 
1074 #define ZFCP_SET                0x00000100
1075 #define ZFCP_CLEAR              0x00000200
1076 
1077 #ifndef atomic_test_mask
1078 #define atomic_test_mask(mask, target) \
1079            ((atomic_read(target) & mask) == mask)
1080 #endif
1081 
1082 extern void _zfcp_hex_dump(char *, int);
1083 #define ZFCP_HEX_DUMP(level, addr, count) \
1084 		if (ZFCP_LOG_CHECK(level)) { \
1085 			_zfcp_hex_dump(addr, count); \
1086 		}
1087 
1088 #define zfcp_get_busid_by_adapter(adapter) (adapter->ccw_device->dev.bus_id)
1089 #define zfcp_get_busid_by_port(port) (zfcp_get_busid_by_adapter(port->adapter))
1090 #define zfcp_get_busid_by_unit(unit) (zfcp_get_busid_by_port(unit->port))
1091 
1092 /*
1093  * Helper functions for request ID management.
1094  */
1095 static inline int zfcp_reqlist_hash(unsigned long req_id)
1096 {
1097 	return req_id % REQUEST_LIST_SIZE;
1098 }
1099 
1100 static inline void zfcp_reqlist_add(struct zfcp_adapter *adapter,
1101 				    struct zfcp_fsf_req *fsf_req)
1102 {
1103 	unsigned int idx;
1104 
1105 	idx = zfcp_reqlist_hash(fsf_req->req_id);
1106 	list_add_tail(&fsf_req->list, &adapter->req_list[idx]);
1107 }
1108 
1109 static inline void zfcp_reqlist_remove(struct zfcp_adapter *adapter,
1110 				       struct zfcp_fsf_req *fsf_req)
1111 {
1112 	list_del(&fsf_req->list);
1113 }
1114 
1115 static inline struct zfcp_fsf_req *
1116 zfcp_reqlist_find(struct zfcp_adapter *adapter, unsigned long req_id)
1117 {
1118 	struct zfcp_fsf_req *request;
1119 	unsigned int idx;
1120 
1121 	idx = zfcp_reqlist_hash(req_id);
1122 	list_for_each_entry(request, &adapter->req_list[idx], list)
1123 		if (request->req_id == req_id)
1124 			return request;
1125 	return NULL;
1126 }
1127 
1128 /*
1129  *  functions needed for reference/usage counting
1130  */
1131 
1132 static inline void
1133 zfcp_unit_get(struct zfcp_unit *unit)
1134 {
1135 	atomic_inc(&unit->refcount);
1136 }
1137 
1138 static inline void
1139 zfcp_unit_put(struct zfcp_unit *unit)
1140 {
1141 	if (atomic_dec_return(&unit->refcount) == 0)
1142 		wake_up(&unit->remove_wq);
1143 }
1144 
1145 static inline void
1146 zfcp_unit_wait(struct zfcp_unit *unit)
1147 {
1148 	wait_event(unit->remove_wq, atomic_read(&unit->refcount) == 0);
1149 }
1150 
1151 static inline void
1152 zfcp_port_get(struct zfcp_port *port)
1153 {
1154 	atomic_inc(&port->refcount);
1155 }
1156 
1157 static inline void
1158 zfcp_port_put(struct zfcp_port *port)
1159 {
1160 	if (atomic_dec_return(&port->refcount) == 0)
1161 		wake_up(&port->remove_wq);
1162 }
1163 
1164 static inline void
1165 zfcp_port_wait(struct zfcp_port *port)
1166 {
1167 	wait_event(port->remove_wq, atomic_read(&port->refcount) == 0);
1168 }
1169 
1170 static inline void
1171 zfcp_adapter_get(struct zfcp_adapter *adapter)
1172 {
1173 	atomic_inc(&adapter->refcount);
1174 }
1175 
1176 static inline void
1177 zfcp_adapter_put(struct zfcp_adapter *adapter)
1178 {
1179 	if (atomic_dec_return(&adapter->refcount) == 0)
1180 		wake_up(&adapter->remove_wq);
1181 }
1182 
1183 static inline void
1184 zfcp_adapter_wait(struct zfcp_adapter *adapter)
1185 {
1186 	wait_event(adapter->remove_wq, atomic_read(&adapter->refcount) == 0);
1187 }
1188 
1189 #endif /* ZFCP_DEF_H */
1190