s390: use free_netdev(netdev) instead of kfree()
[linux-2.6.git] / drivers / s390 / scsi / zfcp_dbf.h
1 /*
2  * This file is part of the zfcp device driver for
3  * FCP adapters for IBM System z9 and zSeries.
4  *
5  * Copyright IBM Corp. 2008, 2009
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21
22 #ifndef ZFCP_DBF_H
23 #define ZFCP_DBF_H
24
25 #include <scsi/fc/fc_fcp.h>
26 #include "zfcp_ext.h"
27 #include "zfcp_fsf.h"
28 #include "zfcp_def.h"
29
30 #define ZFCP_DBF_TAG_SIZE      4
31 #define ZFCP_DBF_ID_SIZE       7
32
33 #define ZFCP_DBF_INVALID_LUN    0xFFFFFFFFFFFFFFFFull
34
35 struct zfcp_dbf_dump {
36         u8 tag[ZFCP_DBF_TAG_SIZE];
37         u32 total_size;         /* size of total dump data */
38         u32 offset;             /* how much data has being already dumped */
39         u32 size;               /* how much data comes with this record */
40         u8 data[];              /* dump data */
41 } __attribute__ ((packed));
42
43 struct zfcp_dbf_rec_record_thread {
44         u32 total;
45         u32 ready;
46         u32 running;
47 };
48
49 struct zfcp_dbf_rec_record_target {
50         u64 ref;
51         u32 status;
52         u32 d_id;
53         u64 wwpn;
54         u64 fcp_lun;
55         u32 erp_count;
56 };
57
58 struct zfcp_dbf_rec_record_trigger {
59         u8 want;
60         u8 need;
61         u32 as;
62         u32 ps;
63         u32 us;
64         u64 ref;
65         u64 action;
66         u64 wwpn;
67         u64 fcp_lun;
68 };
69
70 struct zfcp_dbf_rec_record_action {
71         u32 status;
72         u32 step;
73         u64 action;
74         u64 fsf_req;
75 };
76
77 struct zfcp_dbf_rec_record {
78         u8 id;
79         char id2[7];
80         union {
81                 struct zfcp_dbf_rec_record_action action;
82                 struct zfcp_dbf_rec_record_thread thread;
83                 struct zfcp_dbf_rec_record_target target;
84                 struct zfcp_dbf_rec_record_trigger trigger;
85         } u;
86 };
87
88 enum {
89         ZFCP_REC_DBF_ID_ACTION,
90         ZFCP_REC_DBF_ID_THREAD,
91         ZFCP_REC_DBF_ID_TARGET,
92         ZFCP_REC_DBF_ID_TRIGGER,
93 };
94
95 struct zfcp_dbf_hba_record_response {
96         u32 fsf_command;
97         u64 fsf_reqid;
98         u32 fsf_seqno;
99         u64 fsf_issued;
100         u32 fsf_prot_status;
101         u32 fsf_status;
102         u8 fsf_prot_status_qual[FSF_PROT_STATUS_QUAL_SIZE];
103         u8 fsf_status_qual[FSF_STATUS_QUALIFIER_SIZE];
104         u32 fsf_req_status;
105         u8 sbal_first;
106         u8 sbal_last;
107         u8 sbal_response;
108         u8 pool;
109         u64 erp_action;
110         union {
111                 struct {
112                         u64 cmnd;
113                         u64 serial;
114                         u32 data_dir;
115                 } fcp;
116                 struct {
117                         u64 wwpn;
118                         u32 d_id;
119                         u32 port_handle;
120                 } port;
121                 struct {
122                         u64 wwpn;
123                         u64 fcp_lun;
124                         u32 port_handle;
125                         u32 lun_handle;
126                 } unit;
127                 struct {
128                         u32 d_id;
129                 } els;
130         } u;
131 } __attribute__ ((packed));
132
133 struct zfcp_dbf_hba_record_status {
134         u8 failed;
135         u32 status_type;
136         u32 status_subtype;
137         struct fsf_queue_designator
138          queue_designator;
139         u32 payload_size;
140 #define ZFCP_DBF_UNSOL_PAYLOAD                          80
141 #define ZFCP_DBF_UNSOL_PAYLOAD_SENSE_DATA_AVAIL         32
142 #define ZFCP_DBF_UNSOL_PAYLOAD_BIT_ERROR_THRESHOLD      56
143 #define ZFCP_DBF_UNSOL_PAYLOAD_FEATURE_UPDATE_ALERT     2 * sizeof(u32)
144         u8 payload[ZFCP_DBF_UNSOL_PAYLOAD];
145 } __attribute__ ((packed));
146
147 struct zfcp_dbf_hba_record_qdio {
148         u32 qdio_error;
149         u8 sbal_index;
150         u8 sbal_count;
151 } __attribute__ ((packed));
152
153 struct zfcp_dbf_hba_record {
154         u8 tag[ZFCP_DBF_TAG_SIZE];
155         u8 tag2[ZFCP_DBF_TAG_SIZE];
156         union {
157                 struct zfcp_dbf_hba_record_response response;
158                 struct zfcp_dbf_hba_record_status status;
159                 struct zfcp_dbf_hba_record_qdio qdio;
160                 struct fsf_bit_error_payload berr;
161         } u;
162 } __attribute__ ((packed));
163
164 struct zfcp_dbf_san_record_ct_request {
165         u16 cmd_req_code;
166         u8 revision;
167         u8 gs_type;
168         u8 gs_subtype;
169         u8 options;
170         u16 max_res_size;
171         u32 len;
172         u32 d_id;
173 } __attribute__ ((packed));
174
175 struct zfcp_dbf_san_record_ct_response {
176         u16 cmd_rsp_code;
177         u8 revision;
178         u8 reason_code;
179         u8 expl;
180         u8 vendor_unique;
181         u16 max_res_size;
182         u32 len;
183 } __attribute__ ((packed));
184
185 struct zfcp_dbf_san_record_els {
186         u32 d_id;
187 } __attribute__ ((packed));
188
189 struct zfcp_dbf_san_record {
190         u8 tag[ZFCP_DBF_TAG_SIZE];
191         u64 fsf_reqid;
192         u32 fsf_seqno;
193         union {
194                 struct zfcp_dbf_san_record_ct_request ct_req;
195                 struct zfcp_dbf_san_record_ct_response ct_resp;
196                 struct zfcp_dbf_san_record_els els;
197         } u;
198 } __attribute__ ((packed));
199
200 #define ZFCP_DBF_SAN_MAX_PAYLOAD 1024
201
202 struct zfcp_dbf_scsi_record {
203         u8 tag[ZFCP_DBF_TAG_SIZE];
204         u8 tag2[ZFCP_DBF_TAG_SIZE];
205         u32 scsi_id;
206         u32 scsi_lun;
207         u32 scsi_result;
208         u64 scsi_cmnd;
209         u64 scsi_serial;
210 #define ZFCP_DBF_SCSI_OPCODE    16
211         u8 scsi_opcode[ZFCP_DBF_SCSI_OPCODE];
212         u8 scsi_retries;
213         u8 scsi_allowed;
214         u64 fsf_reqid;
215         u32 fsf_seqno;
216         u64 fsf_issued;
217         u64 old_fsf_reqid;
218         u8 rsp_validity;
219         u8 rsp_scsi_status;
220         u32 rsp_resid;
221         u8 rsp_code;
222 #define ZFCP_DBF_SCSI_FCP_SNS_INFO      16
223 #define ZFCP_DBF_SCSI_MAX_FCP_SNS_INFO  256
224         u32 sns_info_len;
225         u8 sns_info[ZFCP_DBF_SCSI_FCP_SNS_INFO];
226 } __attribute__ ((packed));
227
228 struct zfcp_dbf {
229         debug_info_t                    *rec;
230         debug_info_t                    *hba;
231         debug_info_t                    *san;
232         debug_info_t                    *scsi;
233         spinlock_t                      rec_lock;
234         spinlock_t                      hba_lock;
235         spinlock_t                      san_lock;
236         spinlock_t                      scsi_lock;
237         struct zfcp_dbf_rec_record      rec_buf;
238         struct zfcp_dbf_hba_record      hba_buf;
239         struct zfcp_dbf_san_record      san_buf;
240         struct zfcp_dbf_scsi_record     scsi_buf;
241         struct zfcp_adapter             *adapter;
242 };
243
244 static inline
245 void zfcp_dbf_hba_fsf_resp(const char *tag2, int level,
246                            struct zfcp_fsf_req *req, struct zfcp_dbf *dbf)
247 {
248         if (level <= dbf->hba->level)
249                 _zfcp_dbf_hba_fsf_response(tag2, level, req, dbf);
250 }
251
252 /**
253  * zfcp_dbf_hba_fsf_response - trace event for request completion
254  * @fsf_req: request that has been completed
255  */
256 static inline void zfcp_dbf_hba_fsf_response(struct zfcp_fsf_req *req)
257 {
258         struct zfcp_dbf *dbf = req->adapter->dbf;
259         struct fsf_qtcb *qtcb = req->qtcb;
260
261         if ((qtcb->prefix.prot_status != FSF_PROT_GOOD) &&
262             (qtcb->prefix.prot_status != FSF_PROT_FSF_STATUS_PRESENTED)) {
263                 zfcp_dbf_hba_fsf_resp("perr", 1, req, dbf);
264
265         } else if (qtcb->header.fsf_status != FSF_GOOD) {
266                 zfcp_dbf_hba_fsf_resp("ferr", 1, req, dbf);
267
268         } else if ((req->fsf_command == FSF_QTCB_OPEN_PORT_WITH_DID) ||
269                    (req->fsf_command == FSF_QTCB_OPEN_LUN)) {
270                 zfcp_dbf_hba_fsf_resp("open", 4, req, dbf);
271
272         } else if (qtcb->header.log_length) {
273                 zfcp_dbf_hba_fsf_resp("qtcb", 5, req, dbf);
274
275         } else {
276                 zfcp_dbf_hba_fsf_resp("norm", 6, req, dbf);
277         }
278  }
279
280 /**
281  * zfcp_dbf_hba_fsf_unsol - trace event for an unsolicited status buffer
282  * @tag: tag indicating which kind of unsolicited status has been received
283  * @dbf: reference to dbf structure
284  * @status_buffer: buffer containing payload of unsolicited status
285  */
286 static inline
287 void zfcp_dbf_hba_fsf_unsol(const char *tag, struct zfcp_dbf *dbf,
288                             struct fsf_status_read_buffer *buf)
289 {
290         int level = 2;
291
292         if (level <= dbf->hba->level)
293                 _zfcp_dbf_hba_fsf_unsol(tag, level, dbf, buf);
294 }
295
296 static inline
297 void zfcp_dbf_scsi(const char *tag, const char *tag2, int level,
298                    struct zfcp_dbf *dbf, struct scsi_cmnd *scmd,
299                    struct zfcp_fsf_req *req, unsigned long old_id)
300 {
301         if (level <= dbf->scsi->level)
302                 _zfcp_dbf_scsi(tag, tag2, level, dbf, scmd, req, old_id);
303 }
304
305 /**
306  * zfcp_dbf_scsi_result - trace event for SCSI command completion
307  * @dbf: adapter dbf trace
308  * @scmd: SCSI command pointer
309  * @req: FSF request used to issue SCSI command
310  */
311 static inline
312 void zfcp_dbf_scsi_result(struct zfcp_dbf *dbf, struct scsi_cmnd *scmd,
313                           struct zfcp_fsf_req *req)
314 {
315         if (scmd->result != 0)
316                 zfcp_dbf_scsi("rslt", "erro", 3, dbf, scmd, req, 0);
317         else if (scmd->retries > 0)
318                 zfcp_dbf_scsi("rslt", "retr", 4, dbf, scmd, req, 0);
319         else
320                 zfcp_dbf_scsi("rslt", "norm", 6, dbf, scmd, req, 0);
321 }
322
323 /**
324  * zfcp_dbf_scsi_fail_send - trace event for failure to send SCSI command
325  * @dbf: adapter dbf trace
326  * @scmd: SCSI command pointer
327  */
328 static inline
329 void zfcp_dbf_scsi_fail_send(struct zfcp_dbf *dbf, struct scsi_cmnd *scmd)
330 {
331         zfcp_dbf_scsi("rslt", "fail", 4, dbf, scmd, NULL, 0);
332 }
333
334 /**
335  * zfcp_dbf_scsi_abort - trace event for SCSI command abort
336  * @tag: tag indicating success or failure of abort operation
337  * @adapter: adapter thas has been used to issue SCSI command to be aborted
338  * @scmd: SCSI command to be aborted
339  * @new_req: request containing abort (might be NULL)
340  * @old_id: identifier of request containg SCSI command to be aborted
341  */
342 static inline
343 void zfcp_dbf_scsi_abort(const char *tag, struct zfcp_dbf *dbf,
344                          struct scsi_cmnd *scmd, struct zfcp_fsf_req *new_req,
345                          unsigned long old_id)
346 {
347         zfcp_dbf_scsi("abrt", tag, 1, dbf, scmd, new_req, old_id);
348 }
349
350 /**
351  * zfcp_dbf_scsi_devreset - trace event for Logical Unit or Target Reset
352  * @tag: tag indicating success or failure of reset operation
353  * @flag: indicates type of reset (Target Reset, Logical Unit Reset)
354  * @unit: unit that needs reset
355  * @scsi_cmnd: SCSI command which caused this error recovery
356  */
357 static inline
358 void zfcp_dbf_scsi_devreset(const char *tag, u8 flag, struct zfcp_unit *unit,
359                             struct scsi_cmnd *scsi_cmnd)
360 {
361         zfcp_dbf_scsi(flag == FCP_TMF_TGT_RESET ? "trst" : "lrst", tag, 1,
362                             unit->port->adapter->dbf, scsi_cmnd, NULL, 0);
363 }
364
365 #endif /* ZFCP_DBF_H */