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