xref: /openbmc/linux/drivers/s390/scsi/zfcp_def.h (revision f15cbe6f1a4b4d9df59142fc8e4abb973302cf44)
1 /*
2  * zfcp device driver
3  *
4  * Global definitions for the zfcp device driver.
5  *
6  * Copyright IBM Corporation 2002, 2008
7  */
8 
9 #ifndef ZFCP_DEF_H
10 #define ZFCP_DEF_H
11 
12 /*************************** INCLUDES *****************************************/
13 
14 #include <linux/init.h>
15 #include <linux/moduleparam.h>
16 #include <linux/major.h>
17 #include <linux/blkdev.h>
18 #include <linux/delay.h>
19 #include <linux/timer.h>
20 #include <linux/slab.h>
21 #include <linux/mempool.h>
22 #include <linux/syscalls.h>
23 #include <linux/scatterlist.h>
24 #include <linux/ioctl.h>
25 #include <scsi/scsi.h>
26 #include <scsi/scsi_tcq.h>
27 #include <scsi/scsi_cmnd.h>
28 #include <scsi/scsi_device.h>
29 #include <scsi/scsi_host.h>
30 #include <scsi/scsi_transport.h>
31 #include <scsi/scsi_transport_fc.h>
32 #include <asm/ccwdev.h>
33 #include <asm/qdio.h>
34 #include <asm/debug.h>
35 #include <asm/ebcdic.h>
36 #include "zfcp_dbf.h"
37 #include "zfcp_fsf.h"
38 
39 
40 /********************* GENERAL DEFINES *********************************/
41 
42 /**
43  * zfcp_sg_to_address - determine kernel address from struct scatterlist
44  * @list: struct scatterlist
45  * Return: kernel address
46  */
47 static inline void *
48 zfcp_sg_to_address(struct scatterlist *list)
49 {
50 	return sg_virt(list);
51 }
52 
53 /**
54  * zfcp_address_to_sg - set up struct scatterlist from kernel address
55  * @address: kernel address
56  * @list: struct scatterlist
57  * @size: buffer size
58  */
59 static inline void
60 zfcp_address_to_sg(void *address, struct scatterlist *list, unsigned int size)
61 {
62 	sg_set_buf(list, address, size);
63 }
64 
65 #define REQUEST_LIST_SIZE 128
66 
67 /********************* SCSI SPECIFIC DEFINES *********************************/
68 #define ZFCP_SCSI_ER_TIMEOUT                    (10*HZ)
69 
70 /********************* CIO/QDIO SPECIFIC DEFINES *****************************/
71 
72 /* Adapter Identification Parameters */
73 #define ZFCP_CONTROL_UNIT_TYPE  0x1731
74 #define ZFCP_CONTROL_UNIT_MODEL 0x03
75 #define ZFCP_DEVICE_TYPE        0x1732
76 #define ZFCP_DEVICE_MODEL       0x03
77 #define ZFCP_DEVICE_MODEL_PRIV	0x04
78 
79 /* DMQ bug workaround: don't use last SBALE */
80 #define ZFCP_MAX_SBALES_PER_SBAL	(QDIO_MAX_ELEMENTS_PER_BUFFER - 1)
81 
82 /* index of last SBALE (with respect to DMQ bug workaround) */
83 #define ZFCP_LAST_SBALE_PER_SBAL	(ZFCP_MAX_SBALES_PER_SBAL - 1)
84 
85 /* max. number of (data buffer) SBALEs in largest SBAL chain */
86 #define ZFCP_MAX_SBALES_PER_REQ		\
87 	(FSF_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2)
88         /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */
89 
90 #define ZFCP_MAX_SECTORS (ZFCP_MAX_SBALES_PER_REQ * 8)
91         /* max. number of (data buffer) SBALEs in largest SBAL chain
92            multiplied with number of sectors per 4k block */
93 
94 /********************* FSF SPECIFIC DEFINES *********************************/
95 
96 /* ATTENTION: value must not be used by hardware */
97 #define FSF_QTCB_UNSOLICITED_STATUS		0x6305
98 
99 /* timeout value for "default timer" for fsf requests */
100 #define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
101 
102 /*************** FIBRE CHANNEL PROTOCOL SPECIFIC DEFINES ********************/
103 
104 typedef unsigned long long wwn_t;
105 typedef unsigned long long fcp_lun_t;
106 /* data length field may be at variable position in FCP-2 FCP_CMND IU */
107 typedef unsigned int       fcp_dl_t;
108 
109 /* timeout for name-server lookup (in seconds) */
110 #define ZFCP_NS_GID_PN_TIMEOUT		10
111 
112 /* task attribute values in FCP-2 FCP_CMND IU */
113 #define SIMPLE_Q	0
114 #define HEAD_OF_Q	1
115 #define ORDERED_Q	2
116 #define ACA_Q		4
117 #define UNTAGGED	5
118 
119 /* task management flags in FCP-2 FCP_CMND IU */
120 #define FCP_CLEAR_ACA		0x40
121 #define FCP_TARGET_RESET	0x20
122 #define FCP_LOGICAL_UNIT_RESET	0x10
123 #define FCP_CLEAR_TASK_SET	0x04
124 #define FCP_ABORT_TASK_SET	0x02
125 
126 #define FCP_CDB_LENGTH		16
127 
128 #define ZFCP_DID_MASK           0x00FFFFFF
129 
130 /* FCP(-2) FCP_CMND IU */
131 struct fcp_cmnd_iu {
132 	fcp_lun_t fcp_lun;	   /* FCP logical unit number */
133 	u8  crn;	           /* command reference number */
134 	u8  reserved0:5;	   /* reserved */
135 	u8  task_attribute:3;	   /* task attribute */
136 	u8  task_management_flags; /* task management flags */
137 	u8  add_fcp_cdb_length:6;  /* additional FCP_CDB length */
138 	u8  rddata:1;              /* read data */
139 	u8  wddata:1;              /* write data */
140 	u8  fcp_cdb[FCP_CDB_LENGTH];
141 } __attribute__((packed));
142 
143 /* FCP(-2) FCP_RSP IU */
144 struct fcp_rsp_iu {
145 	u8  reserved0[10];
146 	union {
147 		struct {
148 			u8 reserved1:3;
149 			u8 fcp_conf_req:1;
150 			u8 fcp_resid_under:1;
151 			u8 fcp_resid_over:1;
152 			u8 fcp_sns_len_valid:1;
153 			u8 fcp_rsp_len_valid:1;
154 		} bits;
155 		u8 value;
156 	} validity;
157 	u8  scsi_status;
158 	u32 fcp_resid;
159 	u32 fcp_sns_len;
160 	u32 fcp_rsp_len;
161 } __attribute__((packed));
162 
163 
164 #define RSP_CODE_GOOD		 0
165 #define RSP_CODE_LENGTH_MISMATCH 1
166 #define RSP_CODE_FIELD_INVALID	 2
167 #define RSP_CODE_RO_MISMATCH	 3
168 #define RSP_CODE_TASKMAN_UNSUPP	 4
169 #define RSP_CODE_TASKMAN_FAILED	 5
170 
171 /* see fc-fs */
172 #define LS_RSCN  0x61
173 #define LS_LOGO  0x05
174 #define LS_PLOGI 0x03
175 
176 struct fcp_rscn_head {
177         u8  command;
178         u8  page_length; /* always 0x04 */
179         u16 payload_len;
180 } __attribute__((packed));
181 
182 struct fcp_rscn_element {
183         u8  reserved:2;
184         u8  event_qual:4;
185         u8  addr_format:2;
186         u32 nport_did:24;
187 } __attribute__((packed));
188 
189 #define ZFCP_PORT_ADDRESS   0x0
190 #define ZFCP_AREA_ADDRESS   0x1
191 #define ZFCP_DOMAIN_ADDRESS 0x2
192 #define ZFCP_FABRIC_ADDRESS 0x3
193 
194 #define ZFCP_PORTS_RANGE_PORT   0xFFFFFF
195 #define ZFCP_PORTS_RANGE_AREA   0xFFFF00
196 #define ZFCP_PORTS_RANGE_DOMAIN 0xFF0000
197 #define ZFCP_PORTS_RANGE_FABRIC 0x000000
198 
199 #define ZFCP_NO_PORTS_PER_AREA    0x100
200 #define ZFCP_NO_PORTS_PER_DOMAIN  0x10000
201 #define ZFCP_NO_PORTS_PER_FABRIC  0x1000000
202 
203 /* see fc-ph */
204 struct fcp_logo {
205         u32 command;
206         u32 nport_did;
207         wwn_t nport_wwpn;
208 } __attribute__((packed));
209 
210 /*
211  * FC-FS stuff
212  */
213 #define R_A_TOV				10 /* seconds */
214 
215 #define ZFCP_LS_RLS			0x0f
216 #define ZFCP_LS_ADISC			0x52
217 #define ZFCP_LS_RPS			0x56
218 #define ZFCP_LS_RSCN			0x61
219 #define ZFCP_LS_RNID			0x78
220 
221 struct zfcp_ls_rjt_par {
222 	u8 action;
223  	u8 reason_code;
224  	u8 reason_expl;
225  	u8 vendor_unique;
226 } __attribute__ ((packed));
227 
228 struct zfcp_ls_adisc {
229 	u8		code;
230 	u8		field[3];
231 	u32		hard_nport_id;
232 	u64		wwpn;
233 	u64		wwnn;
234 	u32		nport_id;
235 } __attribute__ ((packed));
236 
237 struct zfcp_ls_adisc_acc {
238 	u8		code;
239 	u8		field[3];
240 	u32		hard_nport_id;
241 	u64		wwpn;
242 	u64		wwnn;
243 	u32		nport_id;
244 } __attribute__ ((packed));
245 
246 struct zfcp_rc_entry {
247 	u8 code;
248 	const char *description;
249 };
250 
251 /*
252  * FC-GS-2 stuff
253  */
254 #define ZFCP_CT_REVISION		0x01
255 #define ZFCP_CT_DIRECTORY_SERVICE	0xFC
256 #define ZFCP_CT_NAME_SERVER		0x02
257 #define ZFCP_CT_SYNCHRONOUS		0x00
258 #define ZFCP_CT_SCSI_FCP		0x08
259 #define ZFCP_CT_UNABLE_TO_PERFORM_CMD	0x09
260 #define ZFCP_CT_GID_PN			0x0121
261 #define ZFCP_CT_GPN_FT			0x0172
262 #define ZFCP_CT_MAX_SIZE		0x1020
263 #define ZFCP_CT_ACCEPT			0x8002
264 #define ZFCP_CT_REJECT			0x8001
265 
266 /*
267  * FC-GS-4 stuff
268  */
269 #define ZFCP_CT_TIMEOUT			(3 * R_A_TOV)
270 
271 /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
272 
273 /*
274  * Note, the leftmost status byte is common among adapter, port
275  * and unit
276  */
277 #define ZFCP_COMMON_FLAGS			0xfff00000
278 
279 /* common status bits */
280 #define ZFCP_STATUS_COMMON_REMOVE		0x80000000
281 #define ZFCP_STATUS_COMMON_RUNNING		0x40000000
282 #define ZFCP_STATUS_COMMON_ERP_FAILED		0x20000000
283 #define ZFCP_STATUS_COMMON_UNBLOCKED		0x10000000
284 #define ZFCP_STATUS_COMMON_OPENING              0x08000000
285 #define ZFCP_STATUS_COMMON_OPEN                 0x04000000
286 #define ZFCP_STATUS_COMMON_CLOSING              0x02000000
287 #define ZFCP_STATUS_COMMON_ERP_INUSE		0x01000000
288 #define ZFCP_STATUS_COMMON_ACCESS_DENIED	0x00800000
289 #define ZFCP_STATUS_COMMON_ACCESS_BOXED		0x00400000
290 #define ZFCP_STATUS_COMMON_NOESC		0x00200000
291 
292 /* adapter status */
293 #define ZFCP_STATUS_ADAPTER_QDIOUP		0x00000002
294 #define ZFCP_STATUS_ADAPTER_REGISTERED		0x00000004
295 #define ZFCP_STATUS_ADAPTER_XCONFIG_OK		0x00000008
296 #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT	0x00000010
297 #define ZFCP_STATUS_ADAPTER_ERP_THREAD_UP	0x00000020
298 #define ZFCP_STATUS_ADAPTER_ERP_THREAD_KILL	0x00000080
299 #define ZFCP_STATUS_ADAPTER_ERP_PENDING		0x00000100
300 #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED	0x00000200
301 #define ZFCP_STATUS_ADAPTER_XPORT_OK		0x00000800
302 
303 /* FC-PH/FC-GS well-known address identifiers for generic services */
304 #define ZFCP_DID_MANAGEMENT_SERVICE		0xFFFFFA
305 #define ZFCP_DID_TIME_SERVICE			0xFFFFFB
306 #define ZFCP_DID_DIRECTORY_SERVICE		0xFFFFFC
307 #define ZFCP_DID_ALIAS_SERVICE			0xFFFFF8
308 #define ZFCP_DID_KEY_DISTRIBUTION_SERVICE	0xFFFFF7
309 
310 /* remote port status */
311 #define ZFCP_STATUS_PORT_PHYS_OPEN		0x00000001
312 #define ZFCP_STATUS_PORT_DID_DID		0x00000002
313 #define ZFCP_STATUS_PORT_PHYS_CLOSING		0x00000004
314 #define ZFCP_STATUS_PORT_NO_WWPN		0x00000008
315 #define ZFCP_STATUS_PORT_NO_SCSI_ID		0x00000010
316 #define ZFCP_STATUS_PORT_INVALID_WWPN		0x00000020
317 
318 /* for ports with well known addresses */
319 #define ZFCP_STATUS_PORT_WKA \
320 		(ZFCP_STATUS_PORT_NO_WWPN | \
321 		 ZFCP_STATUS_PORT_NO_SCSI_ID)
322 
323 /* logical unit status */
324 #define ZFCP_STATUS_UNIT_TEMPORARY		0x00000002
325 #define ZFCP_STATUS_UNIT_SHARED			0x00000004
326 #define ZFCP_STATUS_UNIT_READONLY		0x00000008
327 #define ZFCP_STATUS_UNIT_REGISTERED		0x00000010
328 #define ZFCP_STATUS_UNIT_SCSI_WORK_PENDING	0x00000020
329 
330 /* FSF request status (this does not have a common part) */
331 #define ZFCP_STATUS_FSFREQ_NOT_INIT		0x00000000
332 #define ZFCP_STATUS_FSFREQ_POOL  		0x00000001
333 #define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT	0x00000002
334 #define ZFCP_STATUS_FSFREQ_COMPLETED		0x00000004
335 #define ZFCP_STATUS_FSFREQ_ERROR		0x00000008
336 #define ZFCP_STATUS_FSFREQ_CLEANUP		0x00000010
337 #define ZFCP_STATUS_FSFREQ_ABORTING		0x00000020
338 #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED	0x00000040
339 #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED       0x00000080
340 #define ZFCP_STATUS_FSFREQ_ABORTED              0x00000100
341 #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED         0x00000200
342 #define ZFCP_STATUS_FSFREQ_TMFUNCNOTSUPP        0x00000400
343 #define ZFCP_STATUS_FSFREQ_RETRY                0x00000800
344 #define ZFCP_STATUS_FSFREQ_DISMISSED            0x00001000
345 
346 /************************* STRUCTURE DEFINITIONS *****************************/
347 
348 struct zfcp_fsf_req;
349 
350 /* holds various memory pools of an adapter */
351 struct zfcp_adapter_mempool {
352 	mempool_t *fsf_req_erp;
353 	mempool_t *fsf_req_scsi;
354 	mempool_t *fsf_req_abort;
355 	mempool_t *fsf_req_status_read;
356 	mempool_t *data_status_read;
357 	mempool_t *data_gid_pn;
358 };
359 
360 /*
361  * header for CT_IU
362  */
363 struct ct_hdr {
364 	u8 revision;		// 0x01
365 	u8 in_id[3];		// 0x00
366 	u8 gs_type;		// 0xFC	Directory Service
367 	u8 gs_subtype;		// 0x02	Name Server
368 	u8 options;		// 0x00 single bidirectional exchange
369 	u8 reserved0;
370 	u16 cmd_rsp_code;	// 0x0121 GID_PN, or 0x0100 GA_NXT
371 	u16 max_res_size;	// <= (4096 - 16) / 4
372 	u8 reserved1;
373 	u8 reason_code;
374 	u8 reason_code_expl;
375 	u8 vendor_unique;
376 } __attribute__ ((packed));
377 
378 /* nameserver request CT_IU -- for requests where
379  * a port name is required */
380 struct ct_iu_gid_pn_req {
381 	struct ct_hdr header;
382 	wwn_t wwpn;
383 } __attribute__ ((packed));
384 
385 /* FS_ACC IU and data unit for GID_PN nameserver request */
386 struct ct_iu_gid_pn_resp {
387 	struct ct_hdr header;
388 	u32 d_id;
389 } __attribute__ ((packed));
390 
391 typedef void (*zfcp_send_ct_handler_t)(unsigned long);
392 
393 /**
394  * struct zfcp_send_ct - used to pass parameters to function zfcp_fsf_send_ct
395  * @port: port where the request is sent to
396  * @req: scatter-gather list for request
397  * @resp: scatter-gather list for response
398  * @req_count: number of elements in request scatter-gather list
399  * @resp_count: number of elements in response scatter-gather list
400  * @handler: handler function (called for response to the request)
401  * @handler_data: data passed to handler function
402  * @timeout: FSF timeout for this request
403  * @completion: completion for synchronization purposes
404  * @status: used to pass error status to calling function
405  */
406 struct zfcp_send_ct {
407 	struct zfcp_port *port;
408 	struct scatterlist *req;
409 	struct scatterlist *resp;
410 	unsigned int req_count;
411 	unsigned int resp_count;
412 	zfcp_send_ct_handler_t handler;
413 	unsigned long handler_data;
414 	int timeout;
415 	struct completion *completion;
416 	int status;
417 };
418 
419 /* used for name server requests in error recovery */
420 struct zfcp_gid_pn_data {
421 	struct zfcp_send_ct ct;
422 	struct scatterlist req;
423 	struct scatterlist resp;
424 	struct ct_iu_gid_pn_req ct_iu_req;
425 	struct ct_iu_gid_pn_resp ct_iu_resp;
426         struct zfcp_port *port;
427 };
428 
429 typedef void (*zfcp_send_els_handler_t)(unsigned long);
430 
431 /**
432  * struct zfcp_send_els - used to pass parameters to function zfcp_fsf_send_els
433  * @adapter: adapter where request is sent from
434  * @port: port where ELS is destinated (port reference count has to be increased)
435  * @d_id: destiniation id of port where request is sent to
436  * @req: scatter-gather list for request
437  * @resp: scatter-gather list for response
438  * @req_count: number of elements in request scatter-gather list
439  * @resp_count: number of elements in response scatter-gather list
440  * @handler: handler function (called for response to the request)
441  * @handler_data: data passed to handler function
442  * @completion: completion for synchronization purposes
443  * @ls_code: hex code of ELS command
444  * @status: used to pass error status to calling function
445  */
446 struct zfcp_send_els {
447 	struct zfcp_adapter *adapter;
448 	struct zfcp_port *port;
449 	u32 d_id;
450 	struct scatterlist *req;
451 	struct scatterlist *resp;
452 	unsigned int req_count;
453 	unsigned int resp_count;
454 	zfcp_send_els_handler_t handler;
455 	unsigned long handler_data;
456 	struct completion *completion;
457 	int ls_code;
458 	int status;
459 };
460 
461 struct zfcp_qdio_queue {
462 	struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q]; /* SBALs */
463 	u8		   first;	      /* index of next free bfr
464 						 in queue (free_count>0) */
465 	atomic_t           count;	      /* number of free buffers
466 						 in queue */
467 	spinlock_t	   lock;	      /* lock for operations on queue */
468 	int                pci_batch;	      /* SBALs since PCI indication
469 						 was last set */
470 };
471 
472 struct zfcp_erp_action {
473 	struct list_head list;
474 	int action;	              /* requested action code */
475 	struct zfcp_adapter *adapter; /* device which should be recovered */
476 	struct zfcp_port *port;
477 	struct zfcp_unit *unit;
478 	volatile u32 status;	      /* recovery status */
479 	u32 step;	              /* active step of this erp action */
480 	struct zfcp_fsf_req *fsf_req; /* fsf request currently pending
481 					 for this action */
482 	struct timer_list timer;
483 };
484 
485 struct fsf_latency_record {
486 	u32 min;
487 	u32 max;
488 	u64 sum;
489 };
490 
491 struct latency_cont {
492 	struct fsf_latency_record channel;
493 	struct fsf_latency_record fabric;
494 	u64 counter;
495 };
496 
497 struct zfcp_latencies {
498 	struct latency_cont read;
499 	struct latency_cont write;
500 	struct latency_cont cmd;
501 	spinlock_t lock;
502 };
503 
504 struct zfcp_adapter {
505 	struct list_head	list;              /* list of adapters */
506 	atomic_t                refcount;          /* reference count */
507 	wait_queue_head_t	remove_wq;         /* can be used to wait for
508 						      refcount drop to zero */
509 	wwn_t			peer_wwnn;	   /* P2P peer WWNN */
510 	wwn_t			peer_wwpn;	   /* P2P peer WWPN */
511 	u32			peer_d_id;	   /* P2P peer D_ID */
512 	struct ccw_device       *ccw_device;	   /* S/390 ccw device */
513 	u32			hydra_version;	   /* Hydra version */
514 	u32			fsf_lic_version;
515 	u32			adapter_features;  /* FCP channel features */
516 	u32			connection_features; /* host connection features */
517         u32			hardware_version;  /* of FCP channel */
518 	u16			timer_ticks;       /* time int for a tick */
519 	struct Scsi_Host	*scsi_host;	   /* Pointer to mid-layer */
520 	struct list_head	port_list_head;	   /* remote port list */
521 	struct list_head        port_remove_lh;    /* head of ports to be
522 						      removed */
523 	u32			ports;	           /* number of remote ports */
524 	unsigned long		req_no;		   /* unique FSF req number */
525 	struct list_head	*req_list;	   /* list of pending reqs */
526 	spinlock_t		req_list_lock;	   /* request list lock */
527 	struct zfcp_qdio_queue	req_q;		   /* request queue */
528 	u32			fsf_req_seq_no;	   /* FSF cmnd seq number */
529 	wait_queue_head_t	request_wq;	   /* can be used to wait for
530 						      more avaliable SBALs */
531 	struct zfcp_qdio_queue	resp_q;	   /* response queue */
532 	rwlock_t		abort_lock;        /* Protects against SCSI
533 						      stack abort/command
534 						      completion races */
535 	atomic_t		stat_miss;	   /* # missing status reads*/
536 	struct work_struct	stat_work;
537 	atomic_t		status;	           /* status of this adapter */
538 	struct list_head	erp_ready_head;	   /* error recovery for this
539 						      adapter/devices */
540 	struct list_head	erp_running_head;
541 	rwlock_t		erp_lock;
542 	struct semaphore	erp_ready_sem;
543 	wait_queue_head_t	erp_thread_wqh;
544 	wait_queue_head_t	erp_done_wqh;
545 	struct zfcp_erp_action	erp_action;	   /* pending error recovery */
546         atomic_t                erp_counter;
547 	u32			erp_total_count;   /* total nr of enqueued erp
548 						      actions */
549 	u32			erp_low_mem_count; /* nr of erp actions waiting
550 						      for memory */
551 	struct zfcp_port	*nameserver_port;  /* adapter's nameserver */
552 	debug_info_t		*rec_dbf;
553 	debug_info_t		*hba_dbf;
554 	debug_info_t		*san_dbf;          /* debug feature areas */
555 	debug_info_t		*scsi_dbf;
556 	spinlock_t		rec_dbf_lock;
557 	spinlock_t		hba_dbf_lock;
558 	spinlock_t		san_dbf_lock;
559 	spinlock_t		scsi_dbf_lock;
560 	struct zfcp_rec_dbf_record	rec_dbf_buf;
561 	struct zfcp_hba_dbf_record	hba_dbf_buf;
562 	struct zfcp_san_dbf_record	san_dbf_buf;
563 	struct zfcp_scsi_dbf_record	scsi_dbf_buf;
564 	struct zfcp_adapter_mempool	pool;      /* Adapter memory pools */
565 	struct qdio_initialize  qdio_init_data;    /* for qdio_establish */
566 	struct device           generic_services;  /* directory for WKA ports */
567 	struct fc_host_statistics *fc_stats;
568 	struct fsf_qtcb_bottom_port *stats_reset_data;
569 	unsigned long		stats_reset;
570 	struct work_struct	scan_work;
571 };
572 
573 struct zfcp_port {
574 	struct device          sysfs_device;   /* sysfs device */
575 	struct fc_rport        *rport;         /* rport of fc transport class */
576 	struct list_head       list;	       /* list of remote ports */
577 	atomic_t               refcount;       /* reference count */
578 	wait_queue_head_t      remove_wq;      /* can be used to wait for
579 						  refcount drop to zero */
580 	struct zfcp_adapter    *adapter;       /* adapter used to access port */
581 	struct list_head       unit_list_head; /* head of logical unit list */
582 	struct list_head       unit_remove_lh; /* head of luns to be removed
583 						  list */
584 	u32		       units;	       /* # of logical units in list */
585 	atomic_t	       status;	       /* status of this remote port */
586 	wwn_t		       wwnn;	       /* WWNN if known */
587 	wwn_t		       wwpn;	       /* WWPN */
588 	u32		       d_id;	       /* D_ID */
589 	u32		       handle;	       /* handle assigned by FSF */
590 	struct zfcp_erp_action erp_action;     /* pending error recovery */
591         atomic_t               erp_counter;
592 	u32                    maxframe_size;
593 	u32                    supported_classes;
594 };
595 
596 struct zfcp_unit {
597 	struct device          sysfs_device;   /* sysfs device */
598 	struct list_head       list;	       /* list of logical units */
599 	atomic_t               refcount;       /* reference count */
600 	wait_queue_head_t      remove_wq;      /* can be used to wait for
601 						  refcount drop to zero */
602 	struct zfcp_port       *port;	       /* remote port of unit */
603 	atomic_t	       status;	       /* status of this logical unit */
604 	unsigned int	       scsi_lun;       /* own SCSI LUN */
605 	fcp_lun_t	       fcp_lun;	       /* own FCP_LUN */
606 	u32		       handle;	       /* handle assigned by FSF */
607         struct scsi_device     *device;        /* scsi device struct pointer */
608 	struct zfcp_erp_action erp_action;     /* pending error recovery */
609         atomic_t               erp_counter;
610 	struct zfcp_latencies	latencies;
611 };
612 
613 /* FSF request */
614 struct zfcp_fsf_req {
615 	struct list_head       list;	       /* list of FSF requests */
616 	unsigned long	       req_id;	       /* unique request ID */
617 	struct zfcp_adapter    *adapter;       /* adapter request belongs to */
618 	u8		       sbal_number;    /* nr of SBALs free for use */
619 	u8		       sbal_first;     /* first SBAL for this request */
620 	u8		       sbal_last;      /* last SBAL for this request */
621 	u8		       sbal_limit;      /* last possible SBAL for
622 						  this reuest */
623 	u8		       sbale_curr;     /* current SBALE during creation
624 						  of request */
625 	u8			sbal_response;	/* SBAL used in interrupt */
626 	wait_queue_head_t      completion_wq;  /* can be used by a routine
627 						  to wait for completion */
628 	volatile u32	       status;	       /* status of this request */
629 	u32		       fsf_command;    /* FSF Command copy */
630 	struct fsf_qtcb	       *qtcb;	       /* address of associated QTCB */
631 	u32		       seq_no;         /* Sequence number of request */
632 	void			*data;           /* private data of request */
633 	struct timer_list     timer;	       /* used for erp or scsi er */
634 	struct zfcp_erp_action *erp_action;    /* used if this request is
635 						  issued on behalf of erp */
636 	mempool_t	       *pool;	       /* used if request was alloacted
637 						  from emergency pool */
638 	unsigned long long     issued;         /* request sent time (STCK) */
639 	struct zfcp_unit       *unit;
640 	void			(*handler)(struct zfcp_fsf_req *);
641 };
642 
643 /* driver data */
644 struct zfcp_data {
645 	struct scsi_host_template scsi_host_template;
646 	struct scsi_transport_template *scsi_transport_template;
647         atomic_t                status;             /* Module status flags */
648 	struct list_head	adapter_list_head;  /* head of adapter list */
649 	struct list_head	adapter_remove_lh;  /* head of adapters to be
650 						       removed */
651 	u32			adapters;	    /* # of adapters in list */
652 	rwlock_t                config_lock;        /* serialises changes
653 						       to adapter/port/unit
654 						       lists */
655 	struct semaphore        config_sema;        /* serialises configuration
656 						       changes */
657 	atomic_t		loglevel;            /* current loglevel */
658 	char                    init_busid[BUS_ID_SIZE];
659 	wwn_t                   init_wwpn;
660 	fcp_lun_t               init_fcp_lun;
661 	struct kmem_cache		*fsf_req_qtcb_cache;
662 	struct kmem_cache		*sr_buffer_cache;
663 	struct kmem_cache		*gid_pn_cache;
664 };
665 
666 /* struct used by memory pools for fsf_requests */
667 struct zfcp_fsf_req_qtcb {
668 	struct zfcp_fsf_req fsf_req;
669 	struct fsf_qtcb qtcb;
670 };
671 
672 /********************** ZFCP SPECIFIC DEFINES ********************************/
673 
674 #define ZFCP_REQ_AUTO_CLEANUP	0x00000002
675 #define ZFCP_REQ_NO_QTCB	0x00000008
676 
677 #define ZFCP_SET                0x00000100
678 #define ZFCP_CLEAR              0x00000200
679 
680 #ifndef atomic_test_mask
681 #define atomic_test_mask(mask, target) \
682            ((atomic_read(target) & mask) == mask)
683 #endif
684 
685 #define zfcp_get_busid_by_adapter(adapter) (adapter->ccw_device->dev.bus_id)
686 #define zfcp_get_busid_by_port(port) (zfcp_get_busid_by_adapter(port->adapter))
687 #define zfcp_get_busid_by_unit(unit) (zfcp_get_busid_by_port(unit->port))
688 
689 /*
690  * Helper functions for request ID management.
691  */
692 static inline int zfcp_reqlist_hash(unsigned long req_id)
693 {
694 	return req_id % REQUEST_LIST_SIZE;
695 }
696 
697 static inline void zfcp_reqlist_remove(struct zfcp_adapter *adapter,
698 				       struct zfcp_fsf_req *fsf_req)
699 {
700 	list_del(&fsf_req->list);
701 }
702 
703 static inline struct zfcp_fsf_req *
704 zfcp_reqlist_find(struct zfcp_adapter *adapter, unsigned long req_id)
705 {
706 	struct zfcp_fsf_req *request;
707 	unsigned int idx;
708 
709 	idx = zfcp_reqlist_hash(req_id);
710 	list_for_each_entry(request, &adapter->req_list[idx], list)
711 		if (request->req_id == req_id)
712 			return request;
713 	return NULL;
714 }
715 
716 static inline struct zfcp_fsf_req *
717 zfcp_reqlist_find_safe(struct zfcp_adapter *adapter, struct zfcp_fsf_req *req)
718 {
719 	struct zfcp_fsf_req *request;
720 	unsigned int idx;
721 
722 	for (idx = 0; idx < REQUEST_LIST_SIZE; idx++) {
723 		list_for_each_entry(request, &adapter->req_list[idx], list)
724 			if (request == req)
725 				return request;
726 	}
727 	return NULL;
728 }
729 
730 /*
731  *  functions needed for reference/usage counting
732  */
733 
734 static inline void
735 zfcp_unit_get(struct zfcp_unit *unit)
736 {
737 	atomic_inc(&unit->refcount);
738 }
739 
740 static inline void
741 zfcp_unit_put(struct zfcp_unit *unit)
742 {
743 	if (atomic_dec_return(&unit->refcount) == 0)
744 		wake_up(&unit->remove_wq);
745 }
746 
747 static inline void
748 zfcp_unit_wait(struct zfcp_unit *unit)
749 {
750 	wait_event(unit->remove_wq, atomic_read(&unit->refcount) == 0);
751 }
752 
753 static inline void
754 zfcp_port_get(struct zfcp_port *port)
755 {
756 	atomic_inc(&port->refcount);
757 }
758 
759 static inline void
760 zfcp_port_put(struct zfcp_port *port)
761 {
762 	if (atomic_dec_return(&port->refcount) == 0)
763 		wake_up(&port->remove_wq);
764 }
765 
766 static inline void
767 zfcp_port_wait(struct zfcp_port *port)
768 {
769 	wait_event(port->remove_wq, atomic_read(&port->refcount) == 0);
770 }
771 
772 static inline void
773 zfcp_adapter_get(struct zfcp_adapter *adapter)
774 {
775 	atomic_inc(&adapter->refcount);
776 }
777 
778 static inline void
779 zfcp_adapter_put(struct zfcp_adapter *adapter)
780 {
781 	if (atomic_dec_return(&adapter->refcount) == 0)
782 		wake_up(&adapter->remove_wq);
783 }
784 
785 static inline void
786 zfcp_adapter_wait(struct zfcp_adapter *adapter)
787 {
788 	wait_event(adapter->remove_wq, atomic_read(&adapter->refcount) == 0);
789 }
790 
791 #endif /* ZFCP_DEF_H */
792