blob: 73eb41580f25c40fe3dc41861703de5c9f9f2bb8 [file] [log] [blame]
Swen Schillig41fa2ad2007-09-07 09:15:31 +02001/*
Christof Schmitt553448f2008-06-10 18:20:58 +02002 * zfcp device driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Christof Schmitt553448f2008-06-10 18:20:58 +02004 * Global definitions for the zfcp device driver.
Swen Schillig41fa2ad2007-09-07 09:15:31 +02005 *
Christof Schmitt553448f2008-06-10 18:20:58 +02006 * Copyright IBM Corporation 2002, 2008
Swen Schillig41fa2ad2007-09-07 09:15:31 +02007 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#ifndef ZFCP_DEF_H
10#define ZFCP_DEF_H
11
Linus Torvalds1da177e2005-04-16 15:20:36 -070012/*************************** INCLUDES *****************************************/
13
14#include <linux/init.h>
15#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/major.h>
17#include <linux/blkdev.h>
18#include <linux/delay.h>
19#include <linux/timer.h>
Heiko Carstensdd52e0e2006-09-18 22:28:49 +020020#include <linux/slab.h>
21#include <linux/mempool.h>
22#include <linux/syscalls.h>
FUJITA Tomonorif1346372007-07-30 23:01:32 +090023#include <linux/scatterlist.h>
Heiko Carstensdd52e0e2006-09-18 22:28:49 +020024#include <linux/ioctl.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <asm/ccwdev.h>
33#include <asm/qdio.h>
34#include <asm/debug.h>
35#include <asm/ebcdic.h>
Christof Schmitt2b604c92008-03-31 11:15:28 +020036#include "zfcp_dbf.h"
Heiko Carstensdd52e0e2006-09-18 22:28:49 +020037#include "zfcp_fsf.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40/********************* GENERAL DEFINES *********************************/
41
Andreas Herrmann06506d02006-05-22 18:18:19 +020042#define REQUEST_LIST_SIZE 128
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044/********************* SCSI SPECIFIC DEFINES *********************************/
Andreas Herrmannf6c0e7a2006-08-02 11:05:52 +020045#define ZFCP_SCSI_ER_TIMEOUT (10*HZ)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
47/********************* CIO/QDIO SPECIFIC DEFINES *****************************/
48
49/* Adapter Identification Parameters */
50#define ZFCP_CONTROL_UNIT_TYPE 0x1731
51#define ZFCP_CONTROL_UNIT_MODEL 0x03
52#define ZFCP_DEVICE_TYPE 0x1732
53#define ZFCP_DEVICE_MODEL 0x03
54#define ZFCP_DEVICE_MODEL_PRIV 0x04
Swen Schillig41fa2ad2007-09-07 09:15:31 +020055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056/* DMQ bug workaround: don't use last SBALE */
57#define ZFCP_MAX_SBALES_PER_SBAL (QDIO_MAX_ELEMENTS_PER_BUFFER - 1)
58
59/* index of last SBALE (with respect to DMQ bug workaround) */
60#define ZFCP_LAST_SBALE_PER_SBAL (ZFCP_MAX_SBALES_PER_SBAL - 1)
61
62/* max. number of (data buffer) SBALEs in largest SBAL chain */
63#define ZFCP_MAX_SBALES_PER_REQ \
Swen Schilligc41f8cb2008-07-02 10:56:39 +020064 (FSF_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */
66
Swen Schillig8d1a0062006-10-12 11:43:44 +020067#define ZFCP_MAX_SECTORS (ZFCP_MAX_SBALES_PER_REQ * 8)
68 /* max. number of (data buffer) SBALEs in largest SBAL chain
69 multiplied with number of sectors per 4k block */
70
Linus Torvalds1da177e2005-04-16 15:20:36 -070071/********************* FSF SPECIFIC DEFINES *********************************/
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073/* ATTENTION: value must not be used by hardware */
74#define FSF_QTCB_UNSOLICITED_STATUS 0x6305
Andreas Herrmann22753fa2005-06-13 13:15:15 +020075
Linus Torvalds1da177e2005-04-16 15:20:36 -070076/* timeout value for "default timer" for fsf requests */
Andreas Herrmann2abbe862006-09-18 22:29:56 +020077#define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
79/*************** FIBRE CHANNEL PROTOCOL SPECIFIC DEFINES ********************/
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081/* timeout for name-server lookup (in seconds) */
82#define ZFCP_NS_GID_PN_TIMEOUT 10
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084/* task attribute values in FCP-2 FCP_CMND IU */
85#define SIMPLE_Q 0
86#define HEAD_OF_Q 1
87#define ORDERED_Q 2
88#define ACA_Q 4
89#define UNTAGGED 5
90
91/* task management flags in FCP-2 FCP_CMND IU */
92#define FCP_CLEAR_ACA 0x40
93#define FCP_TARGET_RESET 0x20
94#define FCP_LOGICAL_UNIT_RESET 0x10
95#define FCP_CLEAR_TASK_SET 0x04
96#define FCP_ABORT_TASK_SET 0x02
97
98#define FCP_CDB_LENGTH 16
99
100#define ZFCP_DID_MASK 0x00FFFFFF
101
102/* FCP(-2) FCP_CMND IU */
103struct fcp_cmnd_iu {
Swen Schillig7ba58c92008-10-01 12:42:18 +0200104 u64 fcp_lun; /* FCP logical unit number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 u8 crn; /* command reference number */
106 u8 reserved0:5; /* reserved */
107 u8 task_attribute:3; /* task attribute */
108 u8 task_management_flags; /* task management flags */
109 u8 add_fcp_cdb_length:6; /* additional FCP_CDB length */
110 u8 rddata:1; /* read data */
111 u8 wddata:1; /* write data */
112 u8 fcp_cdb[FCP_CDB_LENGTH];
113} __attribute__((packed));
114
115/* FCP(-2) FCP_RSP IU */
116struct fcp_rsp_iu {
117 u8 reserved0[10];
118 union {
119 struct {
120 u8 reserved1:3;
121 u8 fcp_conf_req:1;
122 u8 fcp_resid_under:1;
123 u8 fcp_resid_over:1;
124 u8 fcp_sns_len_valid:1;
125 u8 fcp_rsp_len_valid:1;
126 } bits;
127 u8 value;
128 } validity;
129 u8 scsi_status;
130 u32 fcp_resid;
131 u32 fcp_sns_len;
132 u32 fcp_rsp_len;
133} __attribute__((packed));
134
135
136#define RSP_CODE_GOOD 0
137#define RSP_CODE_LENGTH_MISMATCH 1
138#define RSP_CODE_FIELD_INVALID 2
139#define RSP_CODE_RO_MISMATCH 3
140#define RSP_CODE_TASKMAN_UNSUPP 4
141#define RSP_CODE_TASKMAN_FAILED 5
142
143/* see fc-fs */
Christof Schmitt24073b42008-06-10 18:20:54 +0200144#define LS_RSCN 0x61
145#define LS_LOGO 0x05
146#define LS_PLOGI 0x03
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148struct fcp_rscn_head {
149 u8 command;
150 u8 page_length; /* always 0x04 */
151 u16 payload_len;
152} __attribute__((packed));
153
154struct fcp_rscn_element {
155 u8 reserved:2;
156 u8 event_qual:4;
157 u8 addr_format:2;
158 u32 nport_did:24;
159} __attribute__((packed));
160
161#define ZFCP_PORT_ADDRESS 0x0
162#define ZFCP_AREA_ADDRESS 0x1
163#define ZFCP_DOMAIN_ADDRESS 0x2
164#define ZFCP_FABRIC_ADDRESS 0x3
165
166#define ZFCP_PORTS_RANGE_PORT 0xFFFFFF
167#define ZFCP_PORTS_RANGE_AREA 0xFFFF00
168#define ZFCP_PORTS_RANGE_DOMAIN 0xFF0000
169#define ZFCP_PORTS_RANGE_FABRIC 0x000000
170
171#define ZFCP_NO_PORTS_PER_AREA 0x100
172#define ZFCP_NO_PORTS_PER_DOMAIN 0x10000
173#define ZFCP_NO_PORTS_PER_FABRIC 0x1000000
174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175/* see fc-ph */
176struct fcp_logo {
177 u32 command;
178 u32 nport_did;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200179 u64 nport_wwpn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180} __attribute__((packed));
181
182/*
183 * FC-FS stuff
184 */
185#define R_A_TOV 10 /* seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187#define ZFCP_LS_RLS 0x0f
188#define ZFCP_LS_ADISC 0x52
189#define ZFCP_LS_RPS 0x56
190#define ZFCP_LS_RSCN 0x61
191#define ZFCP_LS_RNID 0x78
192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193struct zfcp_ls_adisc {
194 u8 code;
195 u8 field[3];
196 u32 hard_nport_id;
197 u64 wwpn;
198 u64 wwnn;
199 u32 nport_id;
200} __attribute__ ((packed));
201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202/*
203 * FC-GS-2 stuff
204 */
205#define ZFCP_CT_REVISION 0x01
206#define ZFCP_CT_DIRECTORY_SERVICE 0xFC
207#define ZFCP_CT_NAME_SERVER 0x02
208#define ZFCP_CT_SYNCHRONOUS 0x00
Swen Schilligcc8c2822008-06-10 18:21:00 +0200209#define ZFCP_CT_SCSI_FCP 0x08
210#define ZFCP_CT_UNABLE_TO_PERFORM_CMD 0x09
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211#define ZFCP_CT_GID_PN 0x0121
Swen Schilligcc8c2822008-06-10 18:21:00 +0200212#define ZFCP_CT_GPN_FT 0x0172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213#define ZFCP_CT_MAX_SIZE 0x1020
214#define ZFCP_CT_ACCEPT 0x8002
215#define ZFCP_CT_REJECT 0x8001
216
217/*
218 * FC-GS-4 stuff
219 */
220#define ZFCP_CT_TIMEOUT (3 * R_A_TOV)
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
223
Swen Schillig41fa2ad2007-09-07 09:15:31 +0200224/*
225 * Note, the leftmost status byte is common among adapter, port
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 * and unit
227 */
228#define ZFCP_COMMON_FLAGS 0xfff00000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
230/* common status bits */
231#define ZFCP_STATUS_COMMON_REMOVE 0x80000000
232#define ZFCP_STATUS_COMMON_RUNNING 0x40000000
233#define ZFCP_STATUS_COMMON_ERP_FAILED 0x20000000
234#define ZFCP_STATUS_COMMON_UNBLOCKED 0x10000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235#define ZFCP_STATUS_COMMON_OPEN 0x04000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236#define ZFCP_STATUS_COMMON_ERP_INUSE 0x01000000
237#define ZFCP_STATUS_COMMON_ACCESS_DENIED 0x00800000
Andreas Herrmannd736a27b2005-06-13 13:23:57 +0200238#define ZFCP_STATUS_COMMON_ACCESS_BOXED 0x00400000
Swen Schilligcc8c2822008-06-10 18:21:00 +0200239#define ZFCP_STATUS_COMMON_NOESC 0x00200000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241/* adapter status */
242#define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243#define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008
244#define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010
245#define ZFCP_STATUS_ADAPTER_ERP_THREAD_UP 0x00000020
246#define ZFCP_STATUS_ADAPTER_ERP_THREAD_KILL 0x00000080
247#define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100
248#define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200
249
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250/* FC-PH/FC-GS well-known address identifiers for generic services */
Swen Schillig5ab944f2008-10-01 12:42:17 +0200251#define ZFCP_DID_WKA 0xFFFFF0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252#define ZFCP_DID_MANAGEMENT_SERVICE 0xFFFFFA
253#define ZFCP_DID_TIME_SERVICE 0xFFFFFB
254#define ZFCP_DID_DIRECTORY_SERVICE 0xFFFFFC
255#define ZFCP_DID_ALIAS_SERVICE 0xFFFFF8
256#define ZFCP_DID_KEY_DISTRIBUTION_SERVICE 0xFFFFF7
257
258/* remote port status */
259#define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001
260#define ZFCP_STATUS_PORT_DID_DID 0x00000002
261#define ZFCP_STATUS_PORT_PHYS_CLOSING 0x00000004
262#define ZFCP_STATUS_PORT_NO_WWPN 0x00000008
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263#define ZFCP_STATUS_PORT_INVALID_WWPN 0x00000020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Swen Schillig5ab944f2008-10-01 12:42:17 +0200265/* well known address (WKA) port status*/
266enum zfcp_wka_status {
267 ZFCP_WKA_PORT_OFFLINE,
268 ZFCP_WKA_PORT_CLOSING,
269 ZFCP_WKA_PORT_OPENING,
270 ZFCP_WKA_PORT_ONLINE,
271};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
273/* logical unit status */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#define ZFCP_STATUS_UNIT_SHARED 0x00000004
275#define ZFCP_STATUS_UNIT_READONLY 0x00000008
Andreas Herrmannad58f7d2006-03-10 00:56:16 +0100276#define ZFCP_STATUS_UNIT_REGISTERED 0x00000010
Christof Schmitt5f852be2007-05-08 11:16:52 +0200277#define ZFCP_STATUS_UNIT_SCSI_WORK_PENDING 0x00000020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279/* FSF request status (this does not have a common part) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280#define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT 0x00000002
281#define ZFCP_STATUS_FSFREQ_COMPLETED 0x00000004
282#define ZFCP_STATUS_FSFREQ_ERROR 0x00000008
283#define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284#define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040
285#define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080
286#define ZFCP_STATUS_FSFREQ_ABORTED 0x00000100
287#define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200
288#define ZFCP_STATUS_FSFREQ_TMFUNCNOTSUPP 0x00000400
289#define ZFCP_STATUS_FSFREQ_RETRY 0x00000800
290#define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292/************************* STRUCTURE DEFINITIONS *****************************/
293
294struct zfcp_fsf_req;
295
296/* holds various memory pools of an adapter */
297struct zfcp_adapter_mempool {
298 mempool_t *fsf_req_erp;
299 mempool_t *fsf_req_scsi;
300 mempool_t *fsf_req_abort;
301 mempool_t *fsf_req_status_read;
302 mempool_t *data_status_read;
303 mempool_t *data_gid_pn;
304};
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306/*
307 * header for CT_IU
308 */
309struct ct_hdr {
310 u8 revision; // 0x01
311 u8 in_id[3]; // 0x00
312 u8 gs_type; // 0xFC Directory Service
313 u8 gs_subtype; // 0x02 Name Server
314 u8 options; // 0x00 single bidirectional exchange
315 u8 reserved0;
316 u16 cmd_rsp_code; // 0x0121 GID_PN, or 0x0100 GA_NXT
317 u16 max_res_size; // <= (4096 - 16) / 4
318 u8 reserved1;
319 u8 reason_code;
320 u8 reason_code_expl;
321 u8 vendor_unique;
322} __attribute__ ((packed));
323
324/* nameserver request CT_IU -- for requests where
325 * a port name is required */
326struct ct_iu_gid_pn_req {
327 struct ct_hdr header;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200328 u64 wwpn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329} __attribute__ ((packed));
330
331/* FS_ACC IU and data unit for GID_PN nameserver request */
332struct ct_iu_gid_pn_resp {
333 struct ct_hdr header;
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200334 u32 d_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335} __attribute__ ((packed));
336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337/**
338 * struct zfcp_send_ct - used to pass parameters to function zfcp_fsf_send_ct
Swen Schillig5ab944f2008-10-01 12:42:17 +0200339 * @wka_port: port where the request is sent to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 * @req: scatter-gather list for request
341 * @resp: scatter-gather list for response
342 * @req_count: number of elements in request scatter-gather list
343 * @resp_count: number of elements in response scatter-gather list
344 * @handler: handler function (called for response to the request)
345 * @handler_data: data passed to handler function
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 * @timeout: FSF timeout for this request
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 * @completion: completion for synchronization purposes
348 * @status: used to pass error status to calling function
349 */
350struct zfcp_send_ct {
Swen Schillig5ab944f2008-10-01 12:42:17 +0200351 struct zfcp_wka_port *wka_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 struct scatterlist *req;
353 struct scatterlist *resp;
354 unsigned int req_count;
355 unsigned int resp_count;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200356 void (*handler)(unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 unsigned long handler_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 int timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 struct completion *completion;
360 int status;
361};
362
363/* used for name server requests in error recovery */
364struct zfcp_gid_pn_data {
365 struct zfcp_send_ct ct;
366 struct scatterlist req;
367 struct scatterlist resp;
368 struct ct_iu_gid_pn_req ct_iu_req;
369 struct ct_iu_gid_pn_resp ct_iu_resp;
370 struct zfcp_port *port;
371};
372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373/**
374 * struct zfcp_send_els - used to pass parameters to function zfcp_fsf_send_els
375 * @adapter: adapter where request is sent from
Andreas Herrmann64b29a132005-06-13 13:18:56 +0200376 * @port: port where ELS is destinated (port reference count has to be increased)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 * @d_id: destiniation id of port where request is sent to
378 * @req: scatter-gather list for request
379 * @resp: scatter-gather list for response
380 * @req_count: number of elements in request scatter-gather list
381 * @resp_count: number of elements in response scatter-gather list
382 * @handler: handler function (called for response to the request)
383 * @handler_data: data passed to handler function
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 * @completion: completion for synchronization purposes
385 * @ls_code: hex code of ELS command
386 * @status: used to pass error status to calling function
387 */
388struct zfcp_send_els {
389 struct zfcp_adapter *adapter;
Andreas Herrmann64b29a132005-06-13 13:18:56 +0200390 struct zfcp_port *port;
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200391 u32 d_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 struct scatterlist *req;
393 struct scatterlist *resp;
394 unsigned int req_count;
395 unsigned int resp_count;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200396 void (*handler)(unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 unsigned long handler_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 struct completion *completion;
399 int ls_code;
400 int status;
401};
402
Swen Schillig5ab944f2008-10-01 12:42:17 +0200403struct zfcp_wka_port {
404 struct zfcp_adapter *adapter;
405 wait_queue_head_t completion_wq;
406 enum zfcp_wka_status status;
407 atomic_t refcount;
408 u32 d_id;
409 u32 handle;
410 struct mutex mutex;
411 struct delayed_work work;
412};
413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414struct zfcp_qdio_queue {
Christof Schmitt04062892008-10-01 12:42:20 +0200415 struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q];
416 u8 first; /* index of next free bfr in queue */
417 atomic_t count; /* number of free buffers in queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418};
419
420struct zfcp_erp_action {
421 struct list_head list;
422 int action; /* requested action code */
423 struct zfcp_adapter *adapter; /* device which should be recovered */
424 struct zfcp_port *port;
425 struct zfcp_unit *unit;
Swen Schillig44cc76f2008-10-01 12:42:16 +0200426 u32 status; /* recovery status */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 u32 step; /* active step of this erp action */
428 struct zfcp_fsf_req *fsf_req; /* fsf request currently pending
429 for this action */
430 struct timer_list timer;
431};
432
Christof Schmittc9615852008-05-06 11:00:05 +0200433struct fsf_latency_record {
434 u32 min;
435 u32 max;
436 u64 sum;
437};
438
439struct latency_cont {
440 struct fsf_latency_record channel;
441 struct fsf_latency_record fabric;
442 u64 counter;
443};
444
445struct zfcp_latencies {
446 struct latency_cont read;
447 struct latency_cont write;
448 struct latency_cont cmd;
449 spinlock_t lock;
450};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452struct zfcp_adapter {
453 struct list_head list; /* list of adapters */
454 atomic_t refcount; /* reference count */
455 wait_queue_head_t remove_wq; /* can be used to wait for
456 refcount drop to zero */
Swen Schillig7ba58c92008-10-01 12:42:18 +0200457 u64 peer_wwnn; /* P2P peer WWNN */
458 u64 peer_wwpn; /* P2P peer WWPN */
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200459 u32 peer_d_id; /* P2P peer D_ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 struct ccw_device *ccw_device; /* S/390 ccw device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 u32 hydra_version; /* Hydra version */
462 u32 fsf_lic_version;
Maxim Shchetyninaef4a982005-09-13 21:51:16 +0200463 u32 adapter_features; /* FCP channel features */
464 u32 connection_features; /* host connection features */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 u32 hardware_version; /* of FCP channel */
Christof Schmittc9615852008-05-06 11:00:05 +0200466 u16 timer_ticks; /* time int for a tick */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 struct Scsi_Host *scsi_host; /* Pointer to mid-layer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 struct list_head port_list_head; /* remote port list */
Volker Sameskefea9d6c2006-08-02 11:05:16 +0200469 unsigned long req_no; /* unique FSF req number */
470 struct list_head *req_list; /* list of pending reqs */
471 spinlock_t req_list_lock; /* request list lock */
Swen Schillig00bab912008-06-10 18:20:57 +0200472 struct zfcp_qdio_queue req_q; /* request queue */
Christof Schmitt04062892008-10-01 12:42:20 +0200473 spinlock_t req_q_lock; /* for operations on queue */
474 int req_q_pci_batch; /* SBALs since PCI indication
475 was last set */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 u32 fsf_req_seq_no; /* FSF cmnd seq number */
477 wait_queue_head_t request_wq; /* can be used to wait for
478 more avaliable SBALs */
Swen Schillig00bab912008-06-10 18:20:57 +0200479 struct zfcp_qdio_queue resp_q; /* response queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 rwlock_t abort_lock; /* Protects against SCSI
481 stack abort/command
482 completion races */
Swen Schilligd26ab062008-05-19 12:17:37 +0200483 atomic_t stat_miss; /* # missing status reads*/
484 struct work_struct stat_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 atomic_t status; /* status of this adapter */
486 struct list_head erp_ready_head; /* error recovery for this
487 adapter/devices */
488 struct list_head erp_running_head;
489 rwlock_t erp_lock;
490 struct semaphore erp_ready_sem;
491 wait_queue_head_t erp_thread_wqh;
492 wait_queue_head_t erp_done_wqh;
493 struct zfcp_erp_action erp_action; /* pending error recovery */
494 atomic_t erp_counter;
495 u32 erp_total_count; /* total nr of enqueued erp
496 actions */
497 u32 erp_low_mem_count; /* nr of erp actions waiting
498 for memory */
Swen Schillig5ab944f2008-10-01 12:42:17 +0200499 struct zfcp_wka_port nsp; /* adapter's nameserver */
Martin Peschked79a83d2008-03-27 14:22:00 +0100500 debug_info_t *rec_dbf;
Maxim Shchetynin8a36e452005-09-13 21:50:38 +0200501 debug_info_t *hba_dbf;
502 debug_info_t *san_dbf; /* debug feature areas */
503 debug_info_t *scsi_dbf;
Martin Peschked79a83d2008-03-27 14:22:00 +0100504 spinlock_t rec_dbf_lock;
Maxim Shchetynin8a36e452005-09-13 21:50:38 +0200505 spinlock_t hba_dbf_lock;
506 spinlock_t san_dbf_lock;
507 spinlock_t scsi_dbf_lock;
Martin Peschked79a83d2008-03-27 14:22:00 +0100508 struct zfcp_rec_dbf_record rec_dbf_buf;
Maxim Shchetynin8a36e452005-09-13 21:50:38 +0200509 struct zfcp_hba_dbf_record hba_dbf_buf;
510 struct zfcp_san_dbf_record san_dbf_buf;
511 struct zfcp_scsi_dbf_record scsi_dbf_buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 struct zfcp_adapter_mempool pool; /* Adapter memory pools */
513 struct qdio_initialize qdio_init_data; /* for qdio_establish */
Andreas Herrmannf6cd94b2006-01-05 09:59:34 +0100514 struct fc_host_statistics *fc_stats;
515 struct fsf_qtcb_bottom_port *stats_reset_data;
516 unsigned long stats_reset;
Swen Schilligcc8c2822008-06-10 18:21:00 +0200517 struct work_struct scan_work;
Stefan Raspl2450d3e2008-10-01 12:42:14 +0200518 atomic_t qdio_outb_full; /* queue full incidents */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519};
520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521struct zfcp_port {
522 struct device sysfs_device; /* sysfs device */
Andreas Herrmann3859f6a2005-08-27 11:07:54 -0700523 struct fc_rport *rport; /* rport of fc transport class */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 struct list_head list; /* list of remote ports */
525 atomic_t refcount; /* reference count */
526 wait_queue_head_t remove_wq; /* can be used to wait for
527 refcount drop to zero */
528 struct zfcp_adapter *adapter; /* adapter used to access port */
529 struct list_head unit_list_head; /* head of logical unit list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 atomic_t status; /* status of this remote port */
Swen Schillig7ba58c92008-10-01 12:42:18 +0200531 u64 wwnn; /* WWNN if known */
532 u64 wwpn; /* WWPN */
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200533 u32 d_id; /* D_ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 u32 handle; /* handle assigned by FSF */
535 struct zfcp_erp_action erp_action; /* pending error recovery */
536 atomic_t erp_counter;
Ralph Wuerthner75bfc282006-05-22 18:24:33 +0200537 u32 maxframe_size;
538 u32 supported_classes;
Swen Schillig5ab944f2008-10-01 12:42:17 +0200539 struct work_struct gid_pn_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540};
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542struct zfcp_unit {
543 struct device sysfs_device; /* sysfs device */
544 struct list_head list; /* list of logical units */
545 atomic_t refcount; /* reference count */
546 wait_queue_head_t remove_wq; /* can be used to wait for
547 refcount drop to zero */
548 struct zfcp_port *port; /* remote port of unit */
549 atomic_t status; /* status of this logical unit */
Swen Schillig7ba58c92008-10-01 12:42:18 +0200550 u64 fcp_lun; /* own FCP_LUN */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 u32 handle; /* handle assigned by FSF */
552 struct scsi_device *device; /* scsi device struct pointer */
553 struct zfcp_erp_action erp_action; /* pending error recovery */
554 atomic_t erp_counter;
Christof Schmittc9615852008-05-06 11:00:05 +0200555 struct zfcp_latencies latencies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556};
557
558/* FSF request */
559struct zfcp_fsf_req {
560 struct list_head list; /* list of FSF requests */
Volker Sameskefea9d6c2006-08-02 11:05:16 +0200561 unsigned long req_id; /* unique request ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 struct zfcp_adapter *adapter; /* adapter request belongs to */
563 u8 sbal_number; /* nr of SBALs free for use */
564 u8 sbal_first; /* first SBAL for this request */
Martin Peschkee891bff2008-05-19 12:17:43 +0200565 u8 sbal_last; /* last SBAL for this request */
Martin Peschked01d51b2008-05-19 12:17:42 +0200566 u8 sbal_limit; /* last possible SBAL for
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 this reuest */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 u8 sbale_curr; /* current SBALE during creation
569 of request */
Martin Peschkec3baa9a22008-05-19 12:17:44 +0200570 u8 sbal_response; /* SBAL used in interrupt */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 wait_queue_head_t completion_wq; /* can be used by a routine
572 to wait for completion */
Swen Schillig44cc76f2008-10-01 12:42:16 +0200573 u32 status; /* status of this request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 u32 fsf_command; /* FSF Command copy */
575 struct fsf_qtcb *qtcb; /* address of associated QTCB */
576 u32 seq_no; /* Sequence number of request */
Swen Schilligc41f8cb2008-07-02 10:56:39 +0200577 void *data; /* private data of request */
Swen Schillig41fa2ad2007-09-07 09:15:31 +0200578 struct timer_list timer; /* used for erp or scsi er */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 struct zfcp_erp_action *erp_action; /* used if this request is
580 issued on behalf of erp */
581 mempool_t *pool; /* used if request was alloacted
582 from emergency pool */
Maxim Shchetynin8a36e452005-09-13 21:50:38 +0200583 unsigned long long issued; /* request sent time (STCK) */
Andreas Herrmann059c97d2005-09-13 21:47:52 +0200584 struct zfcp_unit *unit;
Swen Schilligc41f8cb2008-07-02 10:56:39 +0200585 void (*handler)(struct zfcp_fsf_req *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586};
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588/* driver data */
589struct zfcp_data {
590 struct scsi_host_template scsi_host_template;
Heiko Carstensdd52e0e2006-09-18 22:28:49 +0200591 struct scsi_transport_template *scsi_transport_template;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 struct list_head adapter_list_head; /* head of adapter list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 rwlock_t config_lock; /* serialises changes
594 to adapter/port/unit
595 lists */
596 struct semaphore config_sema; /* serialises configuration
597 changes */
598 atomic_t loglevel; /* current loglevel */
599 char init_busid[BUS_ID_SIZE];
Swen Schillig7ba58c92008-10-01 12:42:18 +0200600 u64 init_wwpn;
601 u64 init_fcp_lun;
602 struct kmem_cache *fsf_req_qtcb_cache;
603 struct kmem_cache *sr_buffer_cache;
604 struct kmem_cache *gid_pn_cache;
Swen Schilligb7f15f32008-10-01 12:42:22 +0200605 struct workqueue_struct *work_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606};
607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608/* struct used by memory pools for fsf_requests */
Heiko Carstensdd52e0e2006-09-18 22:28:49 +0200609struct zfcp_fsf_req_qtcb {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 struct zfcp_fsf_req fsf_req;
611 struct fsf_qtcb qtcb;
612};
613
614/********************** ZFCP SPECIFIC DEFINES ********************************/
615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616#define ZFCP_REQ_AUTO_CLEANUP 0x00000002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617#define ZFCP_REQ_NO_QTCB 0x00000008
618
619#define ZFCP_SET 0x00000100
620#define ZFCP_CLEAR 0x00000200
621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622#define zfcp_get_busid_by_adapter(adapter) (adapter->ccw_device->dev.bus_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
624/*
Heiko Carstensca2d02c2007-05-08 11:17:54 +0200625 * Helper functions for request ID management.
626 */
627static inline int zfcp_reqlist_hash(unsigned long req_id)
628{
629 return req_id % REQUEST_LIST_SIZE;
630}
631
Heiko Carstensca2d02c2007-05-08 11:17:54 +0200632static inline void zfcp_reqlist_remove(struct zfcp_adapter *adapter,
633 struct zfcp_fsf_req *fsf_req)
634{
635 list_del(&fsf_req->list);
636}
637
638static inline struct zfcp_fsf_req *
639zfcp_reqlist_find(struct zfcp_adapter *adapter, unsigned long req_id)
640{
641 struct zfcp_fsf_req *request;
642 unsigned int idx;
643
644 idx = zfcp_reqlist_hash(req_id);
645 list_for_each_entry(request, &adapter->req_list[idx], list)
646 if (request->req_id == req_id)
647 return request;
648 return NULL;
649}
650
Heiko Carstensd1ad09d2007-12-20 12:30:22 +0100651static inline struct zfcp_fsf_req *
652zfcp_reqlist_find_safe(struct zfcp_adapter *adapter, struct zfcp_fsf_req *req)
653{
654 struct zfcp_fsf_req *request;
655 unsigned int idx;
656
657 for (idx = 0; idx < REQUEST_LIST_SIZE; idx++) {
658 list_for_each_entry(request, &adapter->req_list[idx], list)
659 if (request == req)
660 return request;
661 }
662 return NULL;
663}
664
Heiko Carstensca2d02c2007-05-08 11:17:54 +0200665/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 * functions needed for reference/usage counting
667 */
668
669static inline void
670zfcp_unit_get(struct zfcp_unit *unit)
671{
672 atomic_inc(&unit->refcount);
673}
674
675static inline void
676zfcp_unit_put(struct zfcp_unit *unit)
677{
678 if (atomic_dec_return(&unit->refcount) == 0)
679 wake_up(&unit->remove_wq);
680}
681
682static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683zfcp_port_get(struct zfcp_port *port)
684{
685 atomic_inc(&port->refcount);
686}
687
688static inline void
689zfcp_port_put(struct zfcp_port *port)
690{
691 if (atomic_dec_return(&port->refcount) == 0)
692 wake_up(&port->remove_wq);
693}
694
695static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696zfcp_adapter_get(struct zfcp_adapter *adapter)
697{
698 atomic_inc(&adapter->refcount);
699}
700
701static inline void
702zfcp_adapter_put(struct zfcp_adapter *adapter)
703{
704 if (atomic_dec_return(&adapter->refcount) == 0)
705 wake_up(&adapter->remove_wq);
706}
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708#endif /* ZFCP_DEF_H */