[SCSI] zfcp: Add docbook comments to debug trace.
[pandora-kernel.git] / drivers / s390 / scsi / zfcp_dbf.c
1 /*
2  * This file is part of the zfcp device driver for
3  * FCP adapters for IBM System z9 and zSeries.
4  *
5  * (C) Copyright IBM Corp. 2002, 2006
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21
22 #include <linux/ctype.h>
23 #include <asm/debug.h>
24 #include "zfcp_ext.h"
25
26 static u32 dbfsize = 4;
27
28 module_param(dbfsize, uint, 0400);
29 MODULE_PARM_DESC(dbfsize,
30                  "number of pages for each debug feature area (default 4)");
31
32 #define ZFCP_LOG_AREA                   ZFCP_LOG_AREA_OTHER
33
34 static void zfcp_dbf_hexdump(debug_info_t *dbf, void *to, int to_len,
35                              int level, char *from, int from_len)
36 {
37         int offset;
38         struct zfcp_dbf_dump *dump = to;
39         int room = to_len - sizeof(*dump);
40
41         for (offset = 0; offset < from_len; offset += dump->size) {
42                 memset(to, 0, to_len);
43                 strncpy(dump->tag, "dump", ZFCP_DBF_TAG_SIZE);
44                 dump->total_size = from_len;
45                 dump->offset = offset;
46                 dump->size = min(from_len - offset, room);
47                 memcpy(dump->data, from + offset, dump->size);
48                 debug_event(dbf, level, dump, dump->size);
49         }
50 }
51
52 /* FIXME: this duplicate this code in s390 debug feature */
53 static void zfcp_dbf_timestamp(unsigned long long stck, struct timespec *time)
54 {
55         unsigned long long sec;
56
57         stck -= 0x8126d60e46000000LL - (0x3c26700LL * 1000000 * 4096);
58         sec = stck >> 12;
59         do_div(sec, 1000000);
60         time->tv_sec = sec;
61         stck -= (sec * 1000000) << 12;
62         time->tv_nsec = ((stck * 1000) >> 12);
63 }
64
65 static void zfcp_dbf_tag(char **p, const char *label, const char *tag)
66 {
67         int i;
68
69         *p += sprintf(*p, "%-24s", label);
70         for (i = 0; i < ZFCP_DBF_TAG_SIZE; i++)
71                 *p += sprintf(*p, "%c", tag[i]);
72         *p += sprintf(*p, "\n");
73 }
74
75 static void zfcp_dbf_outs(char **buf, const char *s1, const char *s2)
76 {
77         *buf += sprintf(*buf, "%-24s%s\n", s1, s2);
78 }
79
80 static void zfcp_dbf_out(char **buf, const char *s, const char *format, ...)
81 {
82         va_list arg;
83
84         *buf += sprintf(*buf, "%-24s", s);
85         va_start(arg, format);
86         *buf += vsprintf(*buf, format, arg);
87         va_end(arg);
88         *buf += sprintf(*buf, "\n");
89 }
90
91 static void zfcp_dbf_outd(char **p, const char *label, char *buffer,
92                           int buflen, int offset, int total_size)
93 {
94         if (!offset)
95                 *p += sprintf(*p, "%-24s  ", label);
96         while (buflen--) {
97                 if (offset > 0) {
98                         if ((offset % 32) == 0)
99                                 *p += sprintf(*p, "\n%-24c  ", ' ');
100                         else if ((offset % 4) == 0)
101                                 *p += sprintf(*p, " ");
102                 }
103                 *p += sprintf(*p, "%02x", *buffer++);
104                 if (++offset == total_size) {
105                         *p += sprintf(*p, "\n");
106                         break;
107                 }
108         }
109         if (!total_size)
110                 *p += sprintf(*p, "\n");
111 }
112
113 static int zfcp_dbf_view_header(debug_info_t *id, struct debug_view *view,
114                                 int area, debug_entry_t *entry, char *out_buf)
115 {
116         struct zfcp_dbf_dump *dump = (struct zfcp_dbf_dump *)DEBUG_DATA(entry);
117         struct timespec t;
118         char *p = out_buf;
119
120         if (strncmp(dump->tag, "dump", ZFCP_DBF_TAG_SIZE) != 0) {
121                 zfcp_dbf_timestamp(entry->id.stck, &t);
122                 zfcp_dbf_out(&p, "timestamp", "%011lu:%06lu",
123                              t.tv_sec, t.tv_nsec);
124                 zfcp_dbf_out(&p, "cpu", "%02i", entry->id.fields.cpuid);
125         } else  {
126                 zfcp_dbf_outd(&p, NULL, dump->data, dump->size, dump->offset,
127                               dump->total_size);
128                 if ((dump->offset + dump->size) == dump->total_size)
129                         p += sprintf(p, "\n");
130         }
131         return p - out_buf;
132 }
133
134 /**
135  * zfcp_hba_dbf_event_fsf_response - trace event for request completion
136  * @fsf_req: request that has been completed
137  */
138 void zfcp_hba_dbf_event_fsf_response(struct zfcp_fsf_req *fsf_req)
139 {
140         struct zfcp_adapter *adapter = fsf_req->adapter;
141         struct fsf_qtcb *qtcb = fsf_req->qtcb;
142         union fsf_prot_status_qual *prot_status_qual =
143                                         &qtcb->prefix.prot_status_qual;
144         union fsf_status_qual *fsf_status_qual = &qtcb->header.fsf_status_qual;
145         struct scsi_cmnd *scsi_cmnd;
146         struct zfcp_port *port;
147         struct zfcp_unit *unit;
148         struct zfcp_send_els *send_els;
149         struct zfcp_hba_dbf_record *rec = &adapter->hba_dbf_buf;
150         struct zfcp_hba_dbf_record_response *response = &rec->u.response;
151         int level;
152         unsigned long flags;
153
154         spin_lock_irqsave(&adapter->hba_dbf_lock, flags);
155         memset(rec, 0, sizeof(*rec));
156         strncpy(rec->tag, "resp", ZFCP_DBF_TAG_SIZE);
157
158         if ((qtcb->prefix.prot_status != FSF_PROT_GOOD) &&
159             (qtcb->prefix.prot_status != FSF_PROT_FSF_STATUS_PRESENTED)) {
160                 strncpy(rec->tag2, "perr", ZFCP_DBF_TAG_SIZE);
161                 level = 1;
162         } else if (qtcb->header.fsf_status != FSF_GOOD) {
163                 strncpy(rec->tag2, "ferr", ZFCP_DBF_TAG_SIZE);
164                 level = 1;
165         } else if ((fsf_req->fsf_command == FSF_QTCB_OPEN_PORT_WITH_DID) ||
166                    (fsf_req->fsf_command == FSF_QTCB_OPEN_LUN)) {
167                 strncpy(rec->tag2, "open", ZFCP_DBF_TAG_SIZE);
168                 level = 4;
169         } else if (qtcb->header.log_length) {
170                 strncpy(rec->tag2, "qtcb", ZFCP_DBF_TAG_SIZE);
171                 level = 5;
172         } else {
173                 strncpy(rec->tag2, "norm", ZFCP_DBF_TAG_SIZE);
174                 level = 6;
175         }
176
177         response->fsf_command = fsf_req->fsf_command;
178         response->fsf_reqid = (unsigned long)fsf_req;
179         response->fsf_seqno = fsf_req->seq_no;
180         response->fsf_issued = fsf_req->issued;
181         response->fsf_prot_status = qtcb->prefix.prot_status;
182         response->fsf_status = qtcb->header.fsf_status;
183         memcpy(response->fsf_prot_status_qual,
184                prot_status_qual, FSF_PROT_STATUS_QUAL_SIZE);
185         memcpy(response->fsf_status_qual,
186                fsf_status_qual, FSF_STATUS_QUALIFIER_SIZE);
187         response->fsf_req_status = fsf_req->status;
188         response->sbal_first = fsf_req->sbal_first;
189         response->sbal_curr = fsf_req->sbal_curr;
190         response->sbal_last = fsf_req->sbal_last;
191         response->pool = fsf_req->pool != NULL;
192         response->erp_action = (unsigned long)fsf_req->erp_action;
193
194         switch (fsf_req->fsf_command) {
195         case FSF_QTCB_FCP_CMND:
196                 if (fsf_req->status & ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT)
197                         break;
198                 scsi_cmnd = (struct scsi_cmnd *)fsf_req->data;
199                 if (scsi_cmnd) {
200                         response->u.fcp.cmnd = (unsigned long)scsi_cmnd;
201                         response->u.fcp.serial = scsi_cmnd->serial_number;
202                 }
203                 break;
204
205         case FSF_QTCB_OPEN_PORT_WITH_DID:
206         case FSF_QTCB_CLOSE_PORT:
207         case FSF_QTCB_CLOSE_PHYSICAL_PORT:
208                 port = (struct zfcp_port *)fsf_req->data;
209                 response->u.port.wwpn = port->wwpn;
210                 response->u.port.d_id = port->d_id;
211                 response->u.port.port_handle = qtcb->header.port_handle;
212                 break;
213
214         case FSF_QTCB_OPEN_LUN:
215         case FSF_QTCB_CLOSE_LUN:
216                 unit = (struct zfcp_unit *)fsf_req->data;
217                 port = unit->port;
218                 response->u.unit.wwpn = port->wwpn;
219                 response->u.unit.fcp_lun = unit->fcp_lun;
220                 response->u.unit.port_handle = qtcb->header.port_handle;
221                 response->u.unit.lun_handle = qtcb->header.lun_handle;
222                 break;
223
224         case FSF_QTCB_SEND_ELS:
225                 send_els = (struct zfcp_send_els *)fsf_req->data;
226                 response->u.els.d_id = qtcb->bottom.support.d_id;
227                 response->u.els.ls_code = send_els->ls_code >> 24;
228                 break;
229
230         case FSF_QTCB_ABORT_FCP_CMND:
231         case FSF_QTCB_SEND_GENERIC:
232         case FSF_QTCB_EXCHANGE_CONFIG_DATA:
233         case FSF_QTCB_EXCHANGE_PORT_DATA:
234         case FSF_QTCB_DOWNLOAD_CONTROL_FILE:
235         case FSF_QTCB_UPLOAD_CONTROL_FILE:
236                 break;
237         }
238
239         debug_event(adapter->hba_dbf, level, rec, sizeof(*rec));
240
241         /* have fcp channel microcode fixed to use as little as possible */
242         if (fsf_req->fsf_command != FSF_QTCB_FCP_CMND) {
243                 /* adjust length skipping trailing zeros */
244                 char *buf = (char *)qtcb + qtcb->header.log_start;
245                 int len = qtcb->header.log_length;
246                 for (; len && !buf[len - 1]; len--);
247                 zfcp_dbf_hexdump(adapter->hba_dbf, rec, sizeof(*rec), level,
248                                  buf, len);
249         }
250
251         spin_unlock_irqrestore(&adapter->hba_dbf_lock, flags);
252 }
253
254 /**
255  * zfcp_hba_dbf_event_fsf_unsol - trace event for an unsolicited status buffer
256  * @tag: tag indicating which kind of unsolicited status has been received
257  * @adapter: adapter that has issued the unsolicited status buffer
258  * @status_buffer: buffer containing payload of unsolicited status
259  */
260 void zfcp_hba_dbf_event_fsf_unsol(const char *tag, struct zfcp_adapter *adapter,
261                                   struct fsf_status_read_buffer *status_buffer)
262 {
263         struct zfcp_hba_dbf_record *rec = &adapter->hba_dbf_buf;
264         unsigned long flags;
265
266         spin_lock_irqsave(&adapter->hba_dbf_lock, flags);
267         memset(rec, 0, sizeof(*rec));
268         strncpy(rec->tag, "stat", ZFCP_DBF_TAG_SIZE);
269         strncpy(rec->tag2, tag, ZFCP_DBF_TAG_SIZE);
270
271         rec->u.status.failed = adapter->status_read_failed;
272         if (status_buffer != NULL) {
273                 rec->u.status.status_type = status_buffer->status_type;
274                 rec->u.status.status_subtype = status_buffer->status_subtype;
275                 memcpy(&rec->u.status.queue_designator,
276                        &status_buffer->queue_designator,
277                        sizeof(struct fsf_queue_designator));
278
279                 switch (status_buffer->status_type) {
280                 case FSF_STATUS_READ_SENSE_DATA_AVAIL:
281                         rec->u.status.payload_size =
282                             ZFCP_DBF_UNSOL_PAYLOAD_SENSE_DATA_AVAIL;
283                         break;
284
285                 case FSF_STATUS_READ_BIT_ERROR_THRESHOLD:
286                         rec->u.status.payload_size =
287                             ZFCP_DBF_UNSOL_PAYLOAD_BIT_ERROR_THRESHOLD;
288                         break;
289
290                 case FSF_STATUS_READ_LINK_DOWN:
291                         switch (status_buffer->status_subtype) {
292                         case FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK:
293                         case FSF_STATUS_READ_SUB_FDISC_FAILED:
294                                 rec->u.status.payload_size =
295                                         sizeof(struct fsf_link_down_info);
296                         }
297                         break;
298
299                 case FSF_STATUS_READ_FEATURE_UPDATE_ALERT:
300                         rec->u.status.payload_size =
301                             ZFCP_DBF_UNSOL_PAYLOAD_FEATURE_UPDATE_ALERT;
302                         break;
303                 }
304                 memcpy(&rec->u.status.payload,
305                        &status_buffer->payload, rec->u.status.payload_size);
306         }
307
308         debug_event(adapter->hba_dbf, 2, rec, sizeof(*rec));
309         spin_unlock_irqrestore(&adapter->hba_dbf_lock, flags);
310 }
311
312 /**
313  * zfcp_hba_dbf_event_qdio - trace event for QDIO related failure
314  * @adapter: adapter affected by this QDIO related event
315  * @status: as passed by qdio module
316  * @qdio_error: as passed by qdio module
317  * @siga_error: as passed by qdio module
318  * @sbal_index: first buffer with error condition, as passed by qdio module
319  * @sbal_count: number of buffers affected, as passed by qdio module
320  */
321 void zfcp_hba_dbf_event_qdio(struct zfcp_adapter *adapter, unsigned int status,
322                              unsigned int qdio_error, unsigned int siga_error,
323                              int sbal_index, int sbal_count)
324 {
325         struct zfcp_hba_dbf_record *r = &adapter->hba_dbf_buf;
326         unsigned long flags;
327
328         spin_lock_irqsave(&adapter->hba_dbf_lock, flags);
329         memset(r, 0, sizeof(*r));
330         strncpy(r->tag, "qdio", ZFCP_DBF_TAG_SIZE);
331         r->u.qdio.status = status;
332         r->u.qdio.qdio_error = qdio_error;
333         r->u.qdio.siga_error = siga_error;
334         r->u.qdio.sbal_index = sbal_index;
335         r->u.qdio.sbal_count = sbal_count;
336         debug_event(adapter->hba_dbf, 0, r, sizeof(*r));
337         spin_unlock_irqrestore(&adapter->hba_dbf_lock, flags);
338 }
339
340 static void zfcp_hba_dbf_view_response(char **p,
341                                        struct zfcp_hba_dbf_record_response *r)
342 {
343         struct timespec t;
344
345         zfcp_dbf_out(p, "fsf_command", "0x%08x", r->fsf_command);
346         zfcp_dbf_out(p, "fsf_reqid", "0x%0Lx", r->fsf_reqid);
347         zfcp_dbf_out(p, "fsf_seqno", "0x%08x", r->fsf_seqno);
348         zfcp_dbf_timestamp(r->fsf_issued, &t);
349         zfcp_dbf_out(p, "fsf_issued", "%011lu:%06lu", t.tv_sec, t.tv_nsec);
350         zfcp_dbf_out(p, "fsf_prot_status", "0x%08x", r->fsf_prot_status);
351         zfcp_dbf_out(p, "fsf_status", "0x%08x", r->fsf_status);
352         zfcp_dbf_outd(p, "fsf_prot_status_qual", r->fsf_prot_status_qual,
353                       FSF_PROT_STATUS_QUAL_SIZE, 0, FSF_PROT_STATUS_QUAL_SIZE);
354         zfcp_dbf_outd(p, "fsf_status_qual", r->fsf_status_qual,
355                       FSF_STATUS_QUALIFIER_SIZE, 0, FSF_STATUS_QUALIFIER_SIZE);
356         zfcp_dbf_out(p, "fsf_req_status", "0x%08x", r->fsf_req_status);
357         zfcp_dbf_out(p, "sbal_first", "0x%02x", r->sbal_first);
358         zfcp_dbf_out(p, "sbal_curr", "0x%02x", r->sbal_curr);
359         zfcp_dbf_out(p, "sbal_last", "0x%02x", r->sbal_last);
360         zfcp_dbf_out(p, "pool", "0x%02x", r->pool);
361
362         switch (r->fsf_command) {
363         case FSF_QTCB_FCP_CMND:
364                 if (r->fsf_req_status & ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT)
365                         break;
366                 zfcp_dbf_out(p, "scsi_cmnd", "0x%0Lx", r->u.fcp.cmnd);
367                 zfcp_dbf_out(p, "scsi_serial", "0x%016Lx", r->u.fcp.serial);
368                 break;
369
370         case FSF_QTCB_OPEN_PORT_WITH_DID:
371         case FSF_QTCB_CLOSE_PORT:
372         case FSF_QTCB_CLOSE_PHYSICAL_PORT:
373                 zfcp_dbf_out(p, "wwpn", "0x%016Lx", r->u.port.wwpn);
374                 zfcp_dbf_out(p, "d_id", "0x%06x", r->u.port.d_id);
375                 zfcp_dbf_out(p, "port_handle", "0x%08x", r->u.port.port_handle);
376                 break;
377
378         case FSF_QTCB_OPEN_LUN:
379         case FSF_QTCB_CLOSE_LUN:
380                 zfcp_dbf_out(p, "wwpn", "0x%016Lx", r->u.unit.wwpn);
381                 zfcp_dbf_out(p, "fcp_lun", "0x%016Lx", r->u.unit.fcp_lun);
382                 zfcp_dbf_out(p, "port_handle", "0x%08x", r->u.unit.port_handle);
383                 zfcp_dbf_out(p, "lun_handle", "0x%08x", r->u.unit.lun_handle);
384                 break;
385
386         case FSF_QTCB_SEND_ELS:
387                 zfcp_dbf_out(p, "d_id", "0x%06x", r->u.els.d_id);
388                 zfcp_dbf_out(p, "ls_code", "0x%02x", r->u.els.ls_code);
389                 break;
390
391         case FSF_QTCB_ABORT_FCP_CMND:
392         case FSF_QTCB_SEND_GENERIC:
393         case FSF_QTCB_EXCHANGE_CONFIG_DATA:
394         case FSF_QTCB_EXCHANGE_PORT_DATA:
395         case FSF_QTCB_DOWNLOAD_CONTROL_FILE:
396         case FSF_QTCB_UPLOAD_CONTROL_FILE:
397                 break;
398         }
399 }
400
401 static void zfcp_hba_dbf_view_status(char **p,
402                                      struct zfcp_hba_dbf_record_status *r)
403 {
404         zfcp_dbf_out(p, "failed", "0x%02x", r->failed);
405         zfcp_dbf_out(p, "status_type", "0x%08x", r->status_type);
406         zfcp_dbf_out(p, "status_subtype", "0x%08x", r->status_subtype);
407         zfcp_dbf_outd(p, "queue_designator", (char *)&r->queue_designator,
408                       sizeof(struct fsf_queue_designator), 0,
409                       sizeof(struct fsf_queue_designator));
410         zfcp_dbf_outd(p, "payload", (char *)&r->payload, r->payload_size, 0,
411                       r->payload_size);
412 }
413
414 static void zfcp_hba_dbf_view_qdio(char **p, struct zfcp_hba_dbf_record_qdio *r)
415 {
416         zfcp_dbf_out(p, "status", "0x%08x", r->status);
417         zfcp_dbf_out(p, "qdio_error", "0x%08x", r->qdio_error);
418         zfcp_dbf_out(p, "siga_error", "0x%08x", r->siga_error);
419         zfcp_dbf_out(p, "sbal_index", "0x%02x", r->sbal_index);
420         zfcp_dbf_out(p, "sbal_count", "0x%02x", r->sbal_count);
421 }
422
423 static int zfcp_hba_dbf_view_format(debug_info_t *id, struct debug_view *view,
424                                     char *out_buf, const char *in_buf)
425 {
426         struct zfcp_hba_dbf_record *r = (struct zfcp_hba_dbf_record *)in_buf;
427         char *p = out_buf;
428
429         if (strncmp(r->tag, "dump", ZFCP_DBF_TAG_SIZE) == 0)
430                 return 0;
431
432         zfcp_dbf_tag(&p, "tag", r->tag);
433         if (isalpha(r->tag2[0]))
434                 zfcp_dbf_tag(&p, "tag2", r->tag2);
435
436         if (strncmp(r->tag, "resp", ZFCP_DBF_TAG_SIZE) == 0)
437                 zfcp_hba_dbf_view_response(&p, &r->u.response);
438         else if (strncmp(r->tag, "stat", ZFCP_DBF_TAG_SIZE) == 0)
439                 zfcp_hba_dbf_view_status(&p, &r->u.status);
440         else if (strncmp(r->tag, "qdio", ZFCP_DBF_TAG_SIZE) == 0)
441                 zfcp_hba_dbf_view_qdio(&p, &r->u.qdio);
442
443         p += sprintf(p, "\n");
444         return p - out_buf;
445 }
446
447 static struct debug_view zfcp_hba_dbf_view = {
448         "structured",
449         NULL,
450         &zfcp_dbf_view_header,
451         &zfcp_hba_dbf_view_format,
452         NULL,
453         NULL
454 };
455
456 static const char *zfcp_rec_dbf_tags[] = {
457         [ZFCP_REC_DBF_ID_THREAD] = "thread",
458         [ZFCP_REC_DBF_ID_TARGET] = "target",
459         [ZFCP_REC_DBF_ID_TRIGGER] = "trigger",
460         [ZFCP_REC_DBF_ID_ACTION] = "action",
461 };
462
463 static const char *zfcp_rec_dbf_ids[] = {
464         [1]     = "new",
465         [2]     = "ready",
466         [3]     = "kill",
467         [4]     = "down sleep",
468         [5]     = "down wakeup",
469         [6]     = "down sleep ecd",
470         [7]     = "down wakeup ecd",
471         [8]     = "down sleep epd",
472         [9]     = "down wakeup epd",
473         [10]    = "online",
474         [11]    = "operational",
475         [12]    = "scsi slave destroy",
476         [13]    = "propagate failed adapter",
477         [14]    = "propagate failed port",
478         [15]    = "block adapter",
479         [16]    = "unblock adapter",
480         [17]    = "block port",
481         [18]    = "unblock port",
482         [19]    = "block unit",
483         [20]    = "unblock unit",
484         [21]    = "unit recovery failed",
485         [22]    = "port recovery failed",
486         [23]    = "adapter recovery failed",
487         [24]    = "qdio queues down",
488         [25]    = "p2p failed",
489         [26]    = "nameserver lookup failed",
490         [27]    = "nameserver port failed",
491         [28]    = "link up",
492         [29]    = "link down",
493         [30]    = "link up status read",
494         [31]    = "open port failed",
495         [32]    = "open port failed",
496         [33]    = "close port",
497         [34]    = "open unit failed",
498         [35]    = "exclusive open unit failed",
499         [36]    = "shared open unit failed",
500         [37]    = "link down",
501         [38]    = "link down status read no link",
502         [39]    = "link down status read fdisc login",
503         [40]    = "link down status read firmware update",
504         [41]    = "link down status read unknown reason",
505         [42]    = "link down ecd incomplete",
506         [43]    = "link down epd incomplete",
507         [44]    = "sysfs adapter recovery",
508         [45]    = "sysfs port recovery",
509         [46]    = "sysfs unit recovery",
510         [47]    = "port boxed abort",
511         [48]    = "unit boxed abort",
512         [49]    = "port boxed ct",
513         [50]    = "port boxed close physical",
514         [51]    = "port boxed open unit",
515         [52]    = "port boxed close unit",
516         [53]    = "port boxed fcp",
517         [54]    = "unit boxed fcp",
518         [55]    = "port access denied ct",
519         [56]    = "port access denied els",
520         [57]    = "port access denied open port",
521         [58]    = "port access denied close physical",
522         [59]    = "unit access denied open unit",
523         [60]    = "shared unit access denied open unit",
524         [61]    = "unit access denied fcp",
525         [62]    = "request timeout",
526         [63]    = "adisc link test reject or timeout",
527         [64]    = "adisc link test d_id changed",
528         [65]    = "adisc link test failed",
529         [66]    = "recovery out of memory",
530         [67]    = "adapter recovery repeated after state change",
531         [68]    = "port recovery repeated after state change",
532         [69]    = "unit recovery repeated after state change",
533         [70]    = "port recovery follow-up after successful adapter recovery",
534         [71]    = "adapter recovery escalation after failed adapter recovery",
535         [72]    = "port recovery follow-up after successful physical port "
536                   "recovery",
537         [73]    = "adapter recovery escalation after failed physical port "
538                   "recovery",
539         [74]    = "unit recovery follow-up after successful port recovery",
540         [75]    = "physical port recovery escalation after failed port "
541                   "recovery",
542         [76]    = "port recovery escalation after failed unit recovery",
543         [77]    = "recovery opening nameserver port",
544         [78]    = "duplicate request id",
545         [79]    = "link down",
546         [80]    = "exclusive read-only unit access unsupported",
547         [81]    = "shared read-write unit access unsupported",
548         [82]    = "incoming rscn",
549         [83]    = "incoming plogi",
550         [84]    = "incoming logo",
551         [85]    = "online",
552         [86]    = "offline",
553         [87]    = "ccw device gone",
554         [88]    = "ccw device no path",
555         [89]    = "ccw device operational",
556         [90]    = "ccw device shutdown",
557         [91]    = "sysfs port addition",
558         [92]    = "sysfs port removal",
559         [93]    = "sysfs adapter recovery",
560         [94]    = "sysfs unit addition",
561         [95]    = "sysfs unit removal",
562         [96]    = "sysfs port recovery",
563         [97]    = "sysfs unit recovery",
564         [98]    = "sequence number mismatch",
565         [99]    = "link up",
566         [100]   = "error state",
567         [101]   = "status read physical port closed",
568         [102]   = "link up status read",
569         [103]   = "too many failed status read buffers",
570         [104]   = "port handle not valid abort",
571         [105]   = "lun handle not valid abort",
572         [106]   = "port handle not valid ct",
573         [107]   = "port handle not valid close port",
574         [108]   = "port handle not valid close physical port",
575         [109]   = "port handle not valid open unit",
576         [110]   = "port handle not valid close unit",
577         [111]   = "lun handle not valid close unit",
578         [112]   = "port handle not valid fcp",
579         [113]   = "lun handle not valid fcp",
580         [114]   = "handle mismatch fcp",
581         [115]   = "lun not valid fcp",
582         [116]   = "qdio send failed",
583         [117]   = "version mismatch",
584         [118]   = "incompatible qtcb type",
585         [119]   = "unknown protocol status",
586         [120]   = "unknown fsf command",
587         [121]   = "no recommendation for status qualifier",
588         [122]   = "status read physical port closed in error",
589         [123]   = "fc service class not supported ct",
590         [124]   = "fc service class not supported els",
591         [125]   = "need newer zfcp",
592         [126]   = "need newer microcode",
593         [127]   = "arbitrated loop not supported",
594         [128]   = "unknown topology",
595         [129]   = "qtcb size mismatch",
596         [130]   = "unknown fsf status ecd",
597         [131]   = "fcp request too big",
598         [132]   = "fc service class not supported fcp",
599         [133]   = "data direction not valid fcp",
600         [134]   = "command length not valid fcp",
601         [135]   = "status read act update",
602         [136]   = "status read cfdc update",
603         [137]   = "hbaapi port open",
604         [138]   = "hbaapi unit open",
605         [139]   = "hbaapi unit shutdown",
606         [140]   = "qdio error",
607         [141]   = "scsi host reset",
608         [142]   = "dismissing fsf request for recovery action",
609         [143]   = "recovery action timed out",
610         [144]   = "recovery action gone",
611         [145]   = "recovery action being processed",
612         [146]   = "recovery action ready for next step",
613 };
614
615 static int zfcp_rec_dbf_view_format(debug_info_t *id, struct debug_view *view,
616                                     char *buf, const char *_rec)
617 {
618         struct zfcp_rec_dbf_record *r = (struct zfcp_rec_dbf_record *)_rec;
619         char *p = buf;
620
621         zfcp_dbf_outs(&p, "tag", zfcp_rec_dbf_tags[r->id]);
622         zfcp_dbf_outs(&p, "hint", zfcp_rec_dbf_ids[r->id2]);
623         zfcp_dbf_out(&p, "id", "%d", r->id2);
624         switch (r->id) {
625         case ZFCP_REC_DBF_ID_THREAD:
626                 zfcp_dbf_out(&p, "sema", "%d", r->u.thread.sema);
627                 zfcp_dbf_out(&p, "total", "%d", r->u.thread.total);
628                 zfcp_dbf_out(&p, "ready", "%d", r->u.thread.ready);
629                 zfcp_dbf_out(&p, "running", "%d", r->u.thread.running);
630                 break;
631         case ZFCP_REC_DBF_ID_TARGET:
632                 zfcp_dbf_out(&p, "reference", "0x%016Lx", r->u.target.ref);
633                 zfcp_dbf_out(&p, "status", "0x%08x", r->u.target.status);
634                 zfcp_dbf_out(&p, "erp_count", "%d", r->u.target.erp_count);
635                 zfcp_dbf_out(&p, "d_id", "0x%06x", r->u.target.d_id);
636                 zfcp_dbf_out(&p, "wwpn", "0x%016Lx", r->u.target.wwpn);
637                 zfcp_dbf_out(&p, "fcp_lun", "0x%016Lx", r->u.target.fcp_lun);
638                 break;
639         case ZFCP_REC_DBF_ID_TRIGGER:
640                 zfcp_dbf_out(&p, "reference", "0x%016Lx", r->u.trigger.ref);
641                 zfcp_dbf_out(&p, "erp_action", "0x%016Lx", r->u.trigger.action);
642                 zfcp_dbf_out(&p, "requested", "%d", r->u.trigger.want);
643                 zfcp_dbf_out(&p, "executed", "%d", r->u.trigger.need);
644                 zfcp_dbf_out(&p, "wwpn", "0x%016Lx", r->u.trigger.wwpn);
645                 zfcp_dbf_out(&p, "fcp_lun", "0x%016Lx", r->u.trigger.fcp_lun);
646                 zfcp_dbf_out(&p, "adapter_status", "0x%08x", r->u.trigger.as);
647                 zfcp_dbf_out(&p, "port_status", "0x%08x", r->u.trigger.ps);
648                 zfcp_dbf_out(&p, "unit_status", "0x%08x", r->u.trigger.us);
649                 break;
650         case ZFCP_REC_DBF_ID_ACTION:
651                 zfcp_dbf_out(&p, "erp_action", "0x%016Lx", r->u.action.action);
652                 zfcp_dbf_out(&p, "fsf_req", "0x%016Lx", r->u.action.fsf_req);
653                 zfcp_dbf_out(&p, "status", "0x%08Lx", r->u.action.status);
654                 zfcp_dbf_out(&p, "step", "0x%08Lx", r->u.action.step);
655                 break;
656         }
657         p += sprintf(p, "\n");
658         return p - buf;
659 }
660
661 static struct debug_view zfcp_rec_dbf_view = {
662         "structured",
663         NULL,
664         &zfcp_dbf_view_header,
665         &zfcp_rec_dbf_view_format,
666         NULL,
667         NULL
668 };
669
670 /**
671  * zfcp_rec_dbf_event_thread - trace event related to recovery thread operation
672  * @id2: identifier for event
673  * @adapter: adapter
674  * @lock: non-zero value indicates that erp_lock has not yet been acquired
675  */
676 void zfcp_rec_dbf_event_thread(u8 id2, struct zfcp_adapter *adapter, int lock)
677 {
678         struct zfcp_rec_dbf_record *r = &adapter->rec_dbf_buf;
679         unsigned long flags = 0;
680         struct list_head *entry;
681         unsigned ready = 0, running = 0, total;
682
683         if (lock)
684                 read_lock_irqsave(&adapter->erp_lock, flags);
685         list_for_each(entry, &adapter->erp_ready_head)
686                 ready++;
687         list_for_each(entry, &adapter->erp_running_head)
688                 running++;
689         total = adapter->erp_total_count;
690         if (lock)
691                 read_unlock_irqrestore(&adapter->erp_lock, flags);
692
693         spin_lock_irqsave(&adapter->rec_dbf_lock, flags);
694         memset(r, 0, sizeof(*r));
695         r->id = ZFCP_REC_DBF_ID_THREAD;
696         r->id2 = id2;
697         r->u.thread.sema = atomic_read(&adapter->erp_ready_sem.count);
698         r->u.thread.total = total;
699         r->u.thread.ready = ready;
700         r->u.thread.running = running;
701         debug_event(adapter->rec_dbf, 5, r, sizeof(*r));
702         spin_unlock_irqrestore(&adapter->rec_dbf_lock, flags);
703 }
704
705 static void zfcp_rec_dbf_event_target(u8 id2, u64 ref,
706                                       struct zfcp_adapter *adapter,
707                                       atomic_t *status, atomic_t *erp_count,
708                                       u64 wwpn, u32 d_id, u64 fcp_lun)
709 {
710         struct zfcp_rec_dbf_record *r = &adapter->rec_dbf_buf;
711         unsigned long flags;
712
713         spin_lock_irqsave(&adapter->rec_dbf_lock, flags);
714         memset(r, 0, sizeof(*r));
715         r->id = ZFCP_REC_DBF_ID_TARGET;
716         r->id2 = id2;
717         r->u.target.ref = ref;
718         r->u.target.status = atomic_read(status);
719         r->u.target.wwpn = wwpn;
720         r->u.target.d_id = d_id;
721         r->u.target.fcp_lun = fcp_lun;
722         r->u.target.erp_count = atomic_read(erp_count);
723         debug_event(adapter->rec_dbf, 3, r, sizeof(*r));
724         spin_unlock_irqrestore(&adapter->rec_dbf_lock, flags);
725 }
726
727 /**
728  * zfcp_rec_dbf_event_adapter - trace event for adapter state change
729  * @id: identifier for trigger of state change
730  * @ref: additional reference (e.g. request)
731  * @adapter: adapter
732  */
733 void zfcp_rec_dbf_event_adapter(u8 id, u64 ref, struct zfcp_adapter *adapter)
734 {
735         zfcp_rec_dbf_event_target(id, ref, adapter, &adapter->status,
736                                   &adapter->erp_counter, 0, 0, 0);
737 }
738
739 /**
740  * zfcp_rec_dbf_event_port - trace event for port state change
741  * @id: identifier for trigger of state change
742  * @ref: additional reference (e.g. request)
743  * @port: port
744  */
745 void zfcp_rec_dbf_event_port(u8 id, u64 ref, struct zfcp_port *port)
746 {
747         struct zfcp_adapter *adapter = port->adapter;
748
749         zfcp_rec_dbf_event_target(id, ref, adapter, &port->status,
750                                   &port->erp_counter, port->wwpn, port->d_id,
751                                   0);
752 }
753
754 /**
755  * zfcp_rec_dbf_event_unit - trace event for unit state change
756  * @id: identifier for trigger of state change
757  * @ref: additional reference (e.g. request)
758  * @unit: unit
759  */
760 void zfcp_rec_dbf_event_unit(u8 id, u64 ref, struct zfcp_unit *unit)
761 {
762         struct zfcp_port *port = unit->port;
763         struct zfcp_adapter *adapter = port->adapter;
764
765         zfcp_rec_dbf_event_target(id, ref, adapter, &unit->status,
766                                   &unit->erp_counter, port->wwpn, port->d_id,
767                                   unit->fcp_lun);
768 }
769
770 /**
771  * zfcp_rec_dbf_event_trigger - trace event for triggered error recovery
772  * @id2: identifier for error recovery trigger
773  * @ref: additional reference (e.g. request)
774  * @want: originally requested error recovery action
775  * @need: error recovery action actually initiated
776  * @action: address of error recovery action struct
777  * @adapter: adapter
778  * @port: port
779  * @unit: unit
780  */
781 void zfcp_rec_dbf_event_trigger(u8 id2, u64 ref, u8 want, u8 need, u64 action,
782                                 struct zfcp_adapter *adapter,
783                                 struct zfcp_port *port, struct zfcp_unit *unit)
784 {
785         struct zfcp_rec_dbf_record *r = &adapter->rec_dbf_buf;
786         unsigned long flags;
787
788         spin_lock_irqsave(&adapter->rec_dbf_lock, flags);
789         memset(r, 0, sizeof(*r));
790         r->id = ZFCP_REC_DBF_ID_TRIGGER;
791         r->id2 = id2;
792         r->u.trigger.ref = ref;
793         r->u.trigger.want = want;
794         r->u.trigger.need = need;
795         r->u.trigger.action = action;
796         r->u.trigger.as = atomic_read(&adapter->status);
797         if (port) {
798                 r->u.trigger.ps = atomic_read(&port->status);
799                 r->u.trigger.wwpn = port->wwpn;
800         }
801         if (unit) {
802                 r->u.trigger.us = atomic_read(&unit->status);
803                 r->u.trigger.fcp_lun = unit->fcp_lun;
804         }
805         debug_event(adapter->rec_dbf, action ? 1 : 4, r, sizeof(*r));
806         spin_unlock_irqrestore(&adapter->rec_dbf_lock, flags);
807 }
808
809 /**
810  * zfcp_rec_dbf_event_action - trace event showing progress of recovery action
811  * @id2: identifier
812  * @erp_action: error recovery action struct pointer
813  */
814 void zfcp_rec_dbf_event_action(u8 id2, struct zfcp_erp_action *erp_action)
815 {
816         struct zfcp_adapter *adapter = erp_action->adapter;
817         struct zfcp_rec_dbf_record *r = &adapter->rec_dbf_buf;
818         unsigned long flags;
819
820         spin_lock_irqsave(&adapter->rec_dbf_lock, flags);
821         memset(r, 0, sizeof(*r));
822         r->id = ZFCP_REC_DBF_ID_ACTION;
823         r->id2 = id2;
824         r->u.action.action = (u64)erp_action;
825         r->u.action.status = erp_action->status;
826         r->u.action.step = erp_action->step;
827         r->u.action.fsf_req = (u64)erp_action->fsf_req;
828         debug_event(adapter->rec_dbf, 4, r, sizeof(*r));
829         spin_unlock_irqrestore(&adapter->rec_dbf_lock, flags);
830 }
831
832 /**
833  * zfcp_san_dbf_event_ct_request - trace event for issued CT request
834  * @fsf_req: request containing issued CT data
835  */
836 void zfcp_san_dbf_event_ct_request(struct zfcp_fsf_req *fsf_req)
837 {
838         struct zfcp_send_ct *ct = (struct zfcp_send_ct *)fsf_req->data;
839         struct zfcp_port *port = ct->port;
840         struct zfcp_adapter *adapter = port->adapter;
841         struct ct_hdr *hdr = zfcp_sg_to_address(ct->req);
842         struct zfcp_san_dbf_record *r = &adapter->san_dbf_buf;
843         struct zfcp_san_dbf_record_ct_request *oct = &r->u.ct_req;
844         unsigned long flags;
845
846         spin_lock_irqsave(&adapter->san_dbf_lock, flags);
847         memset(r, 0, sizeof(*r));
848         strncpy(r->tag, "octc", ZFCP_DBF_TAG_SIZE);
849         r->fsf_reqid = (unsigned long)fsf_req;
850         r->fsf_seqno = fsf_req->seq_no;
851         r->s_id = fc_host_port_id(adapter->scsi_host);
852         r->d_id = port->d_id;
853         oct->cmd_req_code = hdr->cmd_rsp_code;
854         oct->revision = hdr->revision;
855         oct->gs_type = hdr->gs_type;
856         oct->gs_subtype = hdr->gs_subtype;
857         oct->options = hdr->options;
858         oct->max_res_size = hdr->max_res_size;
859         oct->len = min((int)ct->req->length - (int)sizeof(struct ct_hdr),
860                        ZFCP_DBF_CT_PAYLOAD);
861         memcpy(oct->payload, (void *)hdr + sizeof(struct ct_hdr), oct->len);
862         debug_event(adapter->san_dbf, 3, r, sizeof(*r));
863         spin_unlock_irqrestore(&adapter->san_dbf_lock, flags);
864 }
865
866 /**
867  * zfcp_san_dbf_event_ct_response - trace event for completion of CT request
868  * @fsf_req: request containing CT response
869  */
870 void zfcp_san_dbf_event_ct_response(struct zfcp_fsf_req *fsf_req)
871 {
872         struct zfcp_send_ct *ct = (struct zfcp_send_ct *)fsf_req->data;
873         struct zfcp_port *port = ct->port;
874         struct zfcp_adapter *adapter = port->adapter;
875         struct ct_hdr *hdr = zfcp_sg_to_address(ct->resp);
876         struct zfcp_san_dbf_record *r = &adapter->san_dbf_buf;
877         struct zfcp_san_dbf_record_ct_response *rct = &r->u.ct_resp;
878         unsigned long flags;
879
880         spin_lock_irqsave(&adapter->san_dbf_lock, flags);
881         memset(r, 0, sizeof(*r));
882         strncpy(r->tag, "rctc", ZFCP_DBF_TAG_SIZE);
883         r->fsf_reqid = (unsigned long)fsf_req;
884         r->fsf_seqno = fsf_req->seq_no;
885         r->s_id = port->d_id;
886         r->d_id = fc_host_port_id(adapter->scsi_host);
887         rct->cmd_rsp_code = hdr->cmd_rsp_code;
888         rct->revision = hdr->revision;
889         rct->reason_code = hdr->reason_code;
890         rct->expl = hdr->reason_code_expl;
891         rct->vendor_unique = hdr->vendor_unique;
892         rct->len = min((int)ct->resp->length - (int)sizeof(struct ct_hdr),
893                        ZFCP_DBF_CT_PAYLOAD);
894         memcpy(rct->payload, (void *)hdr + sizeof(struct ct_hdr), rct->len);
895         debug_event(adapter->san_dbf, 3, r, sizeof(*r));
896         spin_unlock_irqrestore(&adapter->san_dbf_lock, flags);
897 }
898
899 static void zfcp_san_dbf_event_els(const char *tag, int level,
900                                    struct zfcp_fsf_req *fsf_req, u32 s_id,
901                                    u32 d_id, u8 ls_code, void *buffer,
902                                    int buflen)
903 {
904         struct zfcp_adapter *adapter = fsf_req->adapter;
905         struct zfcp_san_dbf_record *rec = &adapter->san_dbf_buf;
906         unsigned long flags;
907
908         spin_lock_irqsave(&adapter->san_dbf_lock, flags);
909         memset(rec, 0, sizeof(*rec));
910         strncpy(rec->tag, tag, ZFCP_DBF_TAG_SIZE);
911         rec->fsf_reqid = (unsigned long)fsf_req;
912         rec->fsf_seqno = fsf_req->seq_no;
913         rec->s_id = s_id;
914         rec->d_id = d_id;
915         rec->u.els.ls_code = ls_code;
916         debug_event(adapter->san_dbf, level, rec, sizeof(*rec));
917         zfcp_dbf_hexdump(adapter->san_dbf, rec, sizeof(*rec), level,
918                          buffer, min(buflen, ZFCP_DBF_ELS_MAX_PAYLOAD));
919         spin_unlock_irqrestore(&adapter->san_dbf_lock, flags);
920 }
921
922 /**
923  * zfcp_san_dbf_event_els_request - trace event for issued ELS
924  * @fsf_req: request containing issued ELS
925  */
926 void zfcp_san_dbf_event_els_request(struct zfcp_fsf_req *fsf_req)
927 {
928         struct zfcp_send_els *els = (struct zfcp_send_els *)fsf_req->data;
929
930         zfcp_san_dbf_event_els("oels", 2, fsf_req,
931                                fc_host_port_id(els->adapter->scsi_host),
932                                els->d_id, *(u8 *) zfcp_sg_to_address(els->req),
933                                zfcp_sg_to_address(els->req), els->req->length);
934 }
935
936 /**
937  * zfcp_san_dbf_event_els_response - trace event for completed ELS
938  * @fsf_req: request containing ELS response
939  */
940 void zfcp_san_dbf_event_els_response(struct zfcp_fsf_req *fsf_req)
941 {
942         struct zfcp_send_els *els = (struct zfcp_send_els *)fsf_req->data;
943
944         zfcp_san_dbf_event_els("rels", 2, fsf_req, els->d_id,
945                                fc_host_port_id(els->adapter->scsi_host),
946                                *(u8 *)zfcp_sg_to_address(els->req),
947                                zfcp_sg_to_address(els->resp),
948                                els->resp->length);
949 }
950
951 /**
952  * zfcp_san_dbf_event_incoming_els - trace event for incomig ELS
953  * @fsf_req: request containing unsolicited status buffer with incoming ELS
954  */
955 void zfcp_san_dbf_event_incoming_els(struct zfcp_fsf_req *fsf_req)
956 {
957         struct zfcp_adapter *adapter = fsf_req->adapter;
958         struct fsf_status_read_buffer *buf =
959                         (struct fsf_status_read_buffer *)fsf_req->data;
960         int length = (int)buf->length -
961                      (int)((void *)&buf->payload - (void *)buf);
962
963         zfcp_san_dbf_event_els("iels", 1, fsf_req, buf->d_id,
964                                fc_host_port_id(adapter->scsi_host),
965                                *(u8 *)buf->payload, (void *)buf->payload,
966                                length);
967 }
968
969 static int zfcp_san_dbf_view_format(debug_info_t *id, struct debug_view *view,
970                                     char *out_buf, const char *in_buf)
971 {
972         struct zfcp_san_dbf_record *r = (struct zfcp_san_dbf_record *)in_buf;
973         char *buffer = NULL;
974         int buflen = 0, total = 0;
975         char *p = out_buf;
976
977         if (strncmp(r->tag, "dump", ZFCP_DBF_TAG_SIZE) == 0)
978                 return 0;
979
980         zfcp_dbf_tag(&p, "tag", r->tag);
981         zfcp_dbf_out(&p, "fsf_reqid", "0x%0Lx", r->fsf_reqid);
982         zfcp_dbf_out(&p, "fsf_seqno", "0x%08x", r->fsf_seqno);
983         zfcp_dbf_out(&p, "s_id", "0x%06x", r->s_id);
984         zfcp_dbf_out(&p, "d_id", "0x%06x", r->d_id);
985
986         if (strncmp(r->tag, "octc", ZFCP_DBF_TAG_SIZE) == 0) {
987                 struct zfcp_san_dbf_record_ct_request *ct = &r->u.ct_req;
988                 zfcp_dbf_out(&p, "cmd_req_code", "0x%04x", ct->cmd_req_code);
989                 zfcp_dbf_out(&p, "revision", "0x%02x", ct->revision);
990                 zfcp_dbf_out(&p, "gs_type", "0x%02x", ct->gs_type);
991                 zfcp_dbf_out(&p, "gs_subtype", "0x%02x", ct->gs_subtype);
992                 zfcp_dbf_out(&p, "options", "0x%02x", ct->options);
993                 zfcp_dbf_out(&p, "max_res_size", "0x%04x", ct->max_res_size);
994                 total = ct->len;
995                 buffer = ct->payload;
996                 buflen = min(total, ZFCP_DBF_CT_PAYLOAD);
997         } else if (strncmp(r->tag, "rctc", ZFCP_DBF_TAG_SIZE) == 0) {
998                 struct zfcp_san_dbf_record_ct_response *ct = &r->u.ct_resp;
999                 zfcp_dbf_out(&p, "cmd_rsp_code", "0x%04x", ct->cmd_rsp_code);
1000                 zfcp_dbf_out(&p, "revision", "0x%02x", ct->revision);
1001                 zfcp_dbf_out(&p, "reason_code", "0x%02x", ct->reason_code);
1002                 zfcp_dbf_out(&p, "reason_code_expl", "0x%02x", ct->expl);
1003                 zfcp_dbf_out(&p, "vendor_unique", "0x%02x", ct->vendor_unique);
1004                 total = ct->len;
1005                 buffer = ct->payload;
1006                 buflen = min(total, ZFCP_DBF_CT_PAYLOAD);
1007         } else if (strncmp(r->tag, "oels", ZFCP_DBF_TAG_SIZE) == 0 ||
1008                    strncmp(r->tag, "rels", ZFCP_DBF_TAG_SIZE) == 0 ||
1009                    strncmp(r->tag, "iels", ZFCP_DBF_TAG_SIZE) == 0) {
1010                 struct zfcp_san_dbf_record_els *els = &r->u.els;
1011                 zfcp_dbf_out(&p, "ls_code", "0x%02x", els->ls_code);
1012                 total = els->len;
1013                 buffer = els->payload;
1014                 buflen = min(total, ZFCP_DBF_ELS_PAYLOAD);
1015         }
1016
1017         zfcp_dbf_outd(&p, "payload", buffer, buflen, 0, total);
1018         if (buflen == total)
1019                 p += sprintf(p, "\n");
1020
1021         return p - out_buf;
1022 }
1023
1024 static struct debug_view zfcp_san_dbf_view = {
1025         "structured",
1026         NULL,
1027         &zfcp_dbf_view_header,
1028         &zfcp_san_dbf_view_format,
1029         NULL,
1030         NULL
1031 };
1032
1033 static void zfcp_scsi_dbf_event(const char *tag, const char *tag2, int level,
1034                                 struct zfcp_adapter *adapter,
1035                                 struct scsi_cmnd *scsi_cmnd,
1036                                 struct zfcp_fsf_req *fsf_req,
1037                                 unsigned long old_req_id)
1038 {
1039         struct zfcp_scsi_dbf_record *rec = &adapter->scsi_dbf_buf;
1040         struct zfcp_dbf_dump *dump = (struct zfcp_dbf_dump *)rec;
1041         unsigned long flags;
1042         struct fcp_rsp_iu *fcp_rsp;
1043         char *fcp_rsp_info = NULL, *fcp_sns_info = NULL;
1044         int offset = 0, buflen = 0;
1045
1046         spin_lock_irqsave(&adapter->scsi_dbf_lock, flags);
1047         do {
1048                 memset(rec, 0, sizeof(*rec));
1049                 if (offset == 0) {
1050                         strncpy(rec->tag, tag, ZFCP_DBF_TAG_SIZE);
1051                         strncpy(rec->tag2, tag2, ZFCP_DBF_TAG_SIZE);
1052                         if (scsi_cmnd != NULL) {
1053                                 if (scsi_cmnd->device) {
1054                                         rec->scsi_id = scsi_cmnd->device->id;
1055                                         rec->scsi_lun = scsi_cmnd->device->lun;
1056                                 }
1057                                 rec->scsi_result = scsi_cmnd->result;
1058                                 rec->scsi_cmnd = (unsigned long)scsi_cmnd;
1059                                 rec->scsi_serial = scsi_cmnd->serial_number;
1060                                 memcpy(rec->scsi_opcode, &scsi_cmnd->cmnd,
1061                                         min((int)scsi_cmnd->cmd_len,
1062                                                 ZFCP_DBF_SCSI_OPCODE));
1063                                 rec->scsi_retries = scsi_cmnd->retries;
1064                                 rec->scsi_allowed = scsi_cmnd->allowed;
1065                         }
1066                         if (fsf_req != NULL) {
1067                                 fcp_rsp = (struct fcp_rsp_iu *)
1068                                     &(fsf_req->qtcb->bottom.io.fcp_rsp);
1069                                 fcp_rsp_info =
1070                                     zfcp_get_fcp_rsp_info_ptr(fcp_rsp);
1071                                 fcp_sns_info =
1072                                     zfcp_get_fcp_sns_info_ptr(fcp_rsp);
1073
1074                                 rec->rsp_validity = fcp_rsp->validity.value;
1075                                 rec->rsp_scsi_status = fcp_rsp->scsi_status;
1076                                 rec->rsp_resid = fcp_rsp->fcp_resid;
1077                                 if (fcp_rsp->validity.bits.fcp_rsp_len_valid)
1078                                         rec->rsp_code = *(fcp_rsp_info + 3);
1079                                 if (fcp_rsp->validity.bits.fcp_sns_len_valid) {
1080                                         buflen = min((int)fcp_rsp->fcp_sns_len,
1081                                                      ZFCP_DBF_SCSI_MAX_FCP_SNS_INFO);
1082                                         rec->sns_info_len = buflen;
1083                                         memcpy(rec->sns_info, fcp_sns_info,
1084                                                min(buflen,
1085                                                    ZFCP_DBF_SCSI_FCP_SNS_INFO));
1086                                         offset += min(buflen,
1087                                                       ZFCP_DBF_SCSI_FCP_SNS_INFO);
1088                                 }
1089
1090                                 rec->fsf_reqid = (unsigned long)fsf_req;
1091                                 rec->fsf_seqno = fsf_req->seq_no;
1092                                 rec->fsf_issued = fsf_req->issued;
1093                         }
1094                         rec->old_fsf_reqid = old_req_id;
1095                 } else {
1096                         strncpy(dump->tag, "dump", ZFCP_DBF_TAG_SIZE);
1097                         dump->total_size = buflen;
1098                         dump->offset = offset;
1099                         dump->size = min(buflen - offset,
1100                                          (int)sizeof(struct
1101                                                      zfcp_scsi_dbf_record) -
1102                                          (int)sizeof(struct zfcp_dbf_dump));
1103                         memcpy(dump->data, fcp_sns_info + offset, dump->size);
1104                         offset += dump->size;
1105                 }
1106                 debug_event(adapter->scsi_dbf, level, rec, sizeof(*rec));
1107         } while (offset < buflen);
1108         spin_unlock_irqrestore(&adapter->scsi_dbf_lock, flags);
1109 }
1110
1111 /**
1112  * zfcp_scsi_dbf_event_result - trace event for SCSI command completion
1113  * @tag: tag indicating success or failure of SCSI command
1114  * @level: trace level applicable for this event
1115  * @adapter: adapter that has been used to issue the SCSI command
1116  * @scsi_cmnd: SCSI command pointer
1117  * @fsf_req: request used to issue SCSI command (might be NULL)
1118  */
1119 void zfcp_scsi_dbf_event_result(const char *tag, int level,
1120                                 struct zfcp_adapter *adapter,
1121                                 struct scsi_cmnd *scsi_cmnd,
1122                                 struct zfcp_fsf_req *fsf_req)
1123 {
1124         zfcp_scsi_dbf_event("rslt", tag, level, adapter, scsi_cmnd, fsf_req, 0);
1125 }
1126
1127 /**
1128  * zfcp_scsi_dbf_event_abort - trace event for SCSI command abort
1129  * @tag: tag indicating success or failure of abort operation
1130  * @adapter: adapter thas has been used to issue SCSI command to be aborted
1131  * @scsi_cmnd: SCSI command to be aborted
1132  * @new_fsf_req: request containing abort (might be NULL)
1133  * @old_req_id: identifier of request containg SCSI command to be aborted
1134  */
1135 void zfcp_scsi_dbf_event_abort(const char *tag, struct zfcp_adapter *adapter,
1136                                struct scsi_cmnd *scsi_cmnd,
1137                                struct zfcp_fsf_req *new_fsf_req,
1138                                unsigned long old_req_id)
1139 {
1140         zfcp_scsi_dbf_event("abrt", tag, 1, adapter, scsi_cmnd, new_fsf_req,
1141                             old_req_id);
1142 }
1143
1144 /**
1145  * zfcp_scsi_dbf_event_devreset - trace event for Logical Unit or Target Reset
1146  * @tag: tag indicating success or failure of reset operation
1147  * @flag: indicates type of reset (Target Reset, Logical Unit Reset)
1148  * @unit: unit that needs reset
1149  * @scsi_cmnd: SCSI command which caused this error recovery
1150  */
1151 void zfcp_scsi_dbf_event_devreset(const char *tag, u8 flag,
1152                                   struct zfcp_unit *unit,
1153                                   struct scsi_cmnd *scsi_cmnd)
1154 {
1155         zfcp_scsi_dbf_event(flag == FCP_TARGET_RESET ? "trst" : "lrst", tag, 1,
1156                             unit->port->adapter, scsi_cmnd, NULL, 0);
1157 }
1158
1159 static int zfcp_scsi_dbf_view_format(debug_info_t *id, struct debug_view *view,
1160                                      char *out_buf, const char *in_buf)
1161 {
1162         struct zfcp_scsi_dbf_record *r = (struct zfcp_scsi_dbf_record *)in_buf;
1163         struct timespec t;
1164         char *p = out_buf;
1165
1166         if (strncmp(r->tag, "dump", ZFCP_DBF_TAG_SIZE) == 0)
1167                 return 0;
1168
1169         zfcp_dbf_tag(&p, "tag", r->tag);
1170         zfcp_dbf_tag(&p, "tag2", r->tag2);
1171         zfcp_dbf_out(&p, "scsi_id", "0x%08x", r->scsi_id);
1172         zfcp_dbf_out(&p, "scsi_lun", "0x%08x", r->scsi_lun);
1173         zfcp_dbf_out(&p, "scsi_result", "0x%08x", r->scsi_result);
1174         zfcp_dbf_out(&p, "scsi_cmnd", "0x%0Lx", r->scsi_cmnd);
1175         zfcp_dbf_out(&p, "scsi_serial", "0x%016Lx", r->scsi_serial);
1176         zfcp_dbf_outd(&p, "scsi_opcode", r->scsi_opcode, ZFCP_DBF_SCSI_OPCODE,
1177                       0, ZFCP_DBF_SCSI_OPCODE);
1178         zfcp_dbf_out(&p, "scsi_retries", "0x%02x", r->scsi_retries);
1179         zfcp_dbf_out(&p, "scsi_allowed", "0x%02x", r->scsi_allowed);
1180         if (strncmp(r->tag, "abrt", ZFCP_DBF_TAG_SIZE) == 0)
1181                 zfcp_dbf_out(&p, "old_fsf_reqid", "0x%0Lx", r->old_fsf_reqid);
1182         zfcp_dbf_out(&p, "fsf_reqid", "0x%0Lx", r->fsf_reqid);
1183         zfcp_dbf_out(&p, "fsf_seqno", "0x%08x", r->fsf_seqno);
1184         zfcp_dbf_timestamp(r->fsf_issued, &t);
1185         zfcp_dbf_out(&p, "fsf_issued", "%011lu:%06lu", t.tv_sec, t.tv_nsec);
1186
1187         if (strncmp(r->tag, "rslt", ZFCP_DBF_TAG_SIZE) == 0) {
1188                 zfcp_dbf_out(&p, "fcp_rsp_validity", "0x%02x", r->rsp_validity);
1189                 zfcp_dbf_out(&p, "fcp_rsp_scsi_status", "0x%02x",
1190                              r->rsp_scsi_status);
1191                 zfcp_dbf_out(&p, "fcp_rsp_resid", "0x%08x", r->rsp_resid);
1192                 zfcp_dbf_out(&p, "fcp_rsp_code", "0x%08x", r->rsp_code);
1193                 zfcp_dbf_out(&p, "fcp_sns_info_len", "0x%08x", r->sns_info_len);
1194                 zfcp_dbf_outd(&p, "fcp_sns_info", r->sns_info,
1195                               min((int)r->sns_info_len,
1196                               ZFCP_DBF_SCSI_FCP_SNS_INFO), 0,
1197                               r->sns_info_len);
1198         }
1199         p += sprintf(p, "\n");
1200         return p - out_buf;
1201 }
1202
1203 static struct debug_view zfcp_scsi_dbf_view = {
1204         "structured",
1205         NULL,
1206         &zfcp_dbf_view_header,
1207         &zfcp_scsi_dbf_view_format,
1208         NULL,
1209         NULL
1210 };
1211
1212 /**
1213  * zfcp_adapter_debug_register - registers debug feature for an adapter
1214  * @adapter: pointer to adapter for which debug features should be registered
1215  * return: -ENOMEM on error, 0 otherwise
1216  */
1217 int zfcp_adapter_debug_register(struct zfcp_adapter *adapter)
1218 {
1219         char dbf_name[DEBUG_MAX_NAME_LEN];
1220
1221         /* debug feature area which records recovery activity */
1222         sprintf(dbf_name, "zfcp_%s_rec", zfcp_get_busid_by_adapter(adapter));
1223         adapter->rec_dbf = debug_register(dbf_name, dbfsize, 1,
1224                                           sizeof(struct zfcp_rec_dbf_record));
1225         if (!adapter->rec_dbf)
1226                 goto failed;
1227         debug_register_view(adapter->rec_dbf, &debug_hex_ascii_view);
1228         debug_register_view(adapter->rec_dbf, &zfcp_rec_dbf_view);
1229         debug_set_level(adapter->rec_dbf, 3);
1230
1231         /* debug feature area which records HBA (FSF and QDIO) conditions */
1232         sprintf(dbf_name, "zfcp_%s_hba", zfcp_get_busid_by_adapter(adapter));
1233         adapter->hba_dbf = debug_register(dbf_name, dbfsize, 1,
1234                                           sizeof(struct zfcp_hba_dbf_record));
1235         if (!adapter->hba_dbf)
1236                 goto failed;
1237         debug_register_view(adapter->hba_dbf, &debug_hex_ascii_view);
1238         debug_register_view(adapter->hba_dbf, &zfcp_hba_dbf_view);
1239         debug_set_level(adapter->hba_dbf, 3);
1240
1241         /* debug feature area which records SAN command failures and recovery */
1242         sprintf(dbf_name, "zfcp_%s_san", zfcp_get_busid_by_adapter(adapter));
1243         adapter->san_dbf = debug_register(dbf_name, dbfsize, 1,
1244                                           sizeof(struct zfcp_san_dbf_record));
1245         if (!adapter->san_dbf)
1246                 goto failed;
1247         debug_register_view(adapter->san_dbf, &debug_hex_ascii_view);
1248         debug_register_view(adapter->san_dbf, &zfcp_san_dbf_view);
1249         debug_set_level(adapter->san_dbf, 6);
1250
1251         /* debug feature area which records SCSI command failures and recovery */
1252         sprintf(dbf_name, "zfcp_%s_scsi", zfcp_get_busid_by_adapter(adapter));
1253         adapter->scsi_dbf = debug_register(dbf_name, dbfsize, 1,
1254                                            sizeof(struct zfcp_scsi_dbf_record));
1255         if (!adapter->scsi_dbf)
1256                 goto failed;
1257         debug_register_view(adapter->scsi_dbf, &debug_hex_ascii_view);
1258         debug_register_view(adapter->scsi_dbf, &zfcp_scsi_dbf_view);
1259         debug_set_level(adapter->scsi_dbf, 3);
1260
1261         return 0;
1262
1263  failed:
1264         zfcp_adapter_debug_unregister(adapter);
1265
1266         return -ENOMEM;
1267 }
1268
1269 /**
1270  * zfcp_adapter_debug_unregister - unregisters debug feature for an adapter
1271  * @adapter: pointer to adapter for which debug features should be unregistered
1272  */
1273 void zfcp_adapter_debug_unregister(struct zfcp_adapter *adapter)
1274 {
1275         debug_unregister(adapter->scsi_dbf);
1276         debug_unregister(adapter->san_dbf);
1277         debug_unregister(adapter->hba_dbf);
1278         debug_unregister(adapter->rec_dbf);
1279         adapter->scsi_dbf = NULL;
1280         adapter->san_dbf = NULL;
1281         adapter->hba_dbf = NULL;
1282         adapter->rec_dbf = NULL;
1283 }
1284
1285 #undef ZFCP_LOG_AREA