1 /*
2 * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
3 * Copyright (c) 2014- QLogic Corporation.
4 * All rights reserved
5 * www.qlogic.com
6 *
7 * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
8 *
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License (GPL) Version 2 as
11 * published by the Free Software Foundation
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 */
18
19 #include <linux/debugfs.h>
20 #include <linux/export.h>
21
22 #include "bfad_drv.h"
23 #include "bfad_im.h"
24
25 /*
26 * BFA debufs interface
27 *
28 * To access the interface, debugfs file system should be mounted
29 * if not already mounted using:
30 * mount -t debugfs none /sys/kernel/debug
31 *
32 * BFA Hierarchy:
33 * - bfa/pci_dev:<pci_name>
34 * where the pci_name corresponds to the one under /sys/bus/pci/drivers/bfa
35 *
36 * Debugging service available per pci_dev:
37 * fwtrc: To collect current firmware trace.
38 * drvtrc: To collect current driver trace
39 * fwsave: To collect last saved fw trace as a result of firmware crash.
40 * regwr: To write one word to chip register
41 * regrd: To read one or more words from chip register.
42 */
43
44 struct bfad_debug_info {
45 char *debug_buffer;
46 void *i_private;
47 int buffer_len;
48 };
49
50 static int
bfad_debugfs_open_drvtrc(struct inode * inode,struct file * file)51 bfad_debugfs_open_drvtrc(struct inode *inode, struct file *file)
52 {
53 struct bfad_port_s *port = inode->i_private;
54 struct bfad_s *bfad = port->bfad;
55 struct bfad_debug_info *debug;
56
57 debug = kzalloc(sizeof(struct bfad_debug_info), GFP_KERNEL);
58 if (!debug)
59 return -ENOMEM;
60
61 debug->debug_buffer = (void *) bfad->trcmod;
62 debug->buffer_len = sizeof(struct bfa_trc_mod_s);
63
64 file->private_data = debug;
65
66 return 0;
67 }
68
69 static int
bfad_debugfs_open_fwtrc(struct inode * inode,struct file * file)70 bfad_debugfs_open_fwtrc(struct inode *inode, struct file *file)
71 {
72 struct bfad_port_s *port = inode->i_private;
73 struct bfad_s *bfad = port->bfad;
74 struct bfad_debug_info *fw_debug;
75 unsigned long flags;
76 int rc;
77
78 fw_debug = kzalloc(sizeof(struct bfad_debug_info), GFP_KERNEL);
79 if (!fw_debug)
80 return -ENOMEM;
81
82 fw_debug->buffer_len = sizeof(struct bfa_trc_mod_s);
83
84 fw_debug->debug_buffer = vmalloc(fw_debug->buffer_len);
85 if (!fw_debug->debug_buffer) {
86 kfree(fw_debug);
87 printk(KERN_INFO "bfad[%d]: Failed to allocate fwtrc buffer\n",
88 bfad->inst_no);
89 return -ENOMEM;
90 }
91
92 memset(fw_debug->debug_buffer, 0, fw_debug->buffer_len);
93
94 spin_lock_irqsave(&bfad->bfad_lock, flags);
95 rc = bfa_ioc_debug_fwtrc(&bfad->bfa.ioc,
96 fw_debug->debug_buffer,
97 &fw_debug->buffer_len);
98 spin_unlock_irqrestore(&bfad->bfad_lock, flags);
99 if (rc != BFA_STATUS_OK) {
100 vfree(fw_debug->debug_buffer);
101 fw_debug->debug_buffer = NULL;
102 kfree(fw_debug);
103 printk(KERN_INFO "bfad[%d]: Failed to collect fwtrc\n",
104 bfad->inst_no);
105 return -ENOMEM;
106 }
107
108 file->private_data = fw_debug;
109
110 return 0;
111 }
112
113 static int
bfad_debugfs_open_fwsave(struct inode * inode,struct file * file)114 bfad_debugfs_open_fwsave(struct inode *inode, struct file *file)
115 {
116 struct bfad_port_s *port = inode->i_private;
117 struct bfad_s *bfad = port->bfad;
118 struct bfad_debug_info *fw_debug;
119 unsigned long flags;
120 int rc;
121
122 fw_debug = kzalloc(sizeof(struct bfad_debug_info), GFP_KERNEL);
123 if (!fw_debug)
124 return -ENOMEM;
125
126 fw_debug->buffer_len = sizeof(struct bfa_trc_mod_s);
127
128 fw_debug->debug_buffer = vmalloc(fw_debug->buffer_len);
129 if (!fw_debug->debug_buffer) {
130 kfree(fw_debug);
131 printk(KERN_INFO "bfad[%d]: Failed to allocate fwsave buffer\n",
132 bfad->inst_no);
133 return -ENOMEM;
134 }
135
136 memset(fw_debug->debug_buffer, 0, fw_debug->buffer_len);
137
138 spin_lock_irqsave(&bfad->bfad_lock, flags);
139 rc = bfa_ioc_debug_fwsave(&bfad->bfa.ioc,
140 fw_debug->debug_buffer,
141 &fw_debug->buffer_len);
142 spin_unlock_irqrestore(&bfad->bfad_lock, flags);
143 if (rc != BFA_STATUS_OK) {
144 vfree(fw_debug->debug_buffer);
145 fw_debug->debug_buffer = NULL;
146 kfree(fw_debug);
147 printk(KERN_INFO "bfad[%d]: Failed to collect fwsave\n",
148 bfad->inst_no);
149 return -ENOMEM;
150 }
151
152 file->private_data = fw_debug;
153
154 return 0;
155 }
156
157 static int
bfad_debugfs_open_reg(struct inode * inode,struct file * file)158 bfad_debugfs_open_reg(struct inode *inode, struct file *file)
159 {
160 struct bfad_debug_info *reg_debug;
161
162 reg_debug = kzalloc(sizeof(struct bfad_debug_info), GFP_KERNEL);
163 if (!reg_debug)
164 return -ENOMEM;
165
166 reg_debug->i_private = inode->i_private;
167
168 file->private_data = reg_debug;
169
170 return 0;
171 }
172
173 /* Changes the current file position */
174 static loff_t
bfad_debugfs_lseek(struct file * file,loff_t offset,int orig)175 bfad_debugfs_lseek(struct file *file, loff_t offset, int orig)
176 {
177 struct bfad_debug_info *debug = file->private_data;
178 return fixed_size_llseek(file, offset, orig,
179 debug->buffer_len);
180 }
181
182 static ssize_t
bfad_debugfs_read(struct file * file,char __user * buf,size_t nbytes,loff_t * pos)183 bfad_debugfs_read(struct file *file, char __user *buf,
184 size_t nbytes, loff_t *pos)
185 {
186 struct bfad_debug_info *debug = file->private_data;
187
188 if (!debug || !debug->debug_buffer)
189 return 0;
190
191 return simple_read_from_buffer(buf, nbytes, pos,
192 debug->debug_buffer, debug->buffer_len);
193 }
194
195 #define BFA_REG_CT_ADDRSZ (0x40000)
196 #define BFA_REG_CB_ADDRSZ (0x20000)
197 #define BFA_REG_ADDRSZ(__ioc) \
198 ((u32)(bfa_asic_id_ctc(bfa_ioc_devid(__ioc)) ? \
199 BFA_REG_CT_ADDRSZ : BFA_REG_CB_ADDRSZ))
200 #define BFA_REG_ADDRMSK(__ioc) (BFA_REG_ADDRSZ(__ioc) - 1)
201
202 static bfa_status_t
bfad_reg_offset_check(struct bfa_s * bfa,u32 offset,u32 len)203 bfad_reg_offset_check(struct bfa_s *bfa, u32 offset, u32 len)
204 {
205 u8 area;
206
207 /* check [16:15] */
208 area = (offset >> 15) & 0x7;
209 if (area == 0) {
210 /* PCIe core register */
211 if ((offset + (len<<2)) > 0x8000) /* 8k dwords or 32KB */
212 return BFA_STATUS_EINVAL;
213 } else if (area == 0x1) {
214 /* CB 32 KB memory page */
215 if ((offset + (len<<2)) > 0x10000) /* 8k dwords or 32KB */
216 return BFA_STATUS_EINVAL;
217 } else {
218 /* CB register space 64KB */
219 if ((offset + (len<<2)) > BFA_REG_ADDRMSK(&bfa->ioc))
220 return BFA_STATUS_EINVAL;
221 }
222 return BFA_STATUS_OK;
223 }
224
225 static ssize_t
bfad_debugfs_read_regrd(struct file * file,char __user * buf,size_t nbytes,loff_t * pos)226 bfad_debugfs_read_regrd(struct file *file, char __user *buf,
227 size_t nbytes, loff_t *pos)
228 {
229 struct bfad_debug_info *regrd_debug = file->private_data;
230 struct bfad_port_s *port = (struct bfad_port_s *)regrd_debug->i_private;
231 struct bfad_s *bfad = port->bfad;
232 ssize_t rc;
233
234 if (!bfad->regdata)
235 return 0;
236
237 rc = simple_read_from_buffer(buf, nbytes, pos,
238 bfad->regdata, bfad->reglen);
239
240 if ((*pos + nbytes) >= bfad->reglen) {
241 kfree(bfad->regdata);
242 bfad->regdata = NULL;
243 bfad->reglen = 0;
244 }
245
246 return rc;
247 }
248
249 static ssize_t
bfad_debugfs_write_regrd(struct file * file,const char __user * buf,size_t nbytes,loff_t * ppos)250 bfad_debugfs_write_regrd(struct file *file, const char __user *buf,
251 size_t nbytes, loff_t *ppos)
252 {
253 struct bfad_debug_info *regrd_debug = file->private_data;
254 struct bfad_port_s *port = (struct bfad_port_s *)regrd_debug->i_private;
255 struct bfad_s *bfad = port->bfad;
256 struct bfa_s *bfa = &bfad->bfa;
257 struct bfa_ioc_s *ioc = &bfa->ioc;
258 int addr, rc, i;
259 u32 len;
260 u32 *regbuf;
261 void __iomem *rb, *reg_addr;
262 unsigned long flags;
263 void *kern_buf;
264
265 kern_buf = memdup_user(buf, nbytes);
266 if (IS_ERR(kern_buf))
267 return PTR_ERR(kern_buf);
268
269 rc = sscanf(kern_buf, "%x:%x", &addr, &len);
270 if (rc < 2 || len > (UINT_MAX >> 2)) {
271 printk(KERN_INFO
272 "bfad[%d]: %s failed to read user buf\n",
273 bfad->inst_no, __func__);
274 kfree(kern_buf);
275 return -EINVAL;
276 }
277
278 kfree(kern_buf);
279 kfree(bfad->regdata);
280 bfad->regdata = NULL;
281 bfad->reglen = 0;
282
283 bfad->regdata = kzalloc(len << 2, GFP_KERNEL);
284 if (!bfad->regdata) {
285 printk(KERN_INFO "bfad[%d]: Failed to allocate regrd buffer\n",
286 bfad->inst_no);
287 return -ENOMEM;
288 }
289
290 bfad->reglen = len << 2;
291 rb = bfa_ioc_bar0(ioc);
292 addr &= BFA_REG_ADDRMSK(ioc);
293
294 /* offset and len sanity check */
295 rc = bfad_reg_offset_check(bfa, addr, len);
296 if (rc) {
297 printk(KERN_INFO "bfad[%d]: Failed reg offset check\n",
298 bfad->inst_no);
299 kfree(bfad->regdata);
300 bfad->regdata = NULL;
301 bfad->reglen = 0;
302 return -EINVAL;
303 }
304
305 reg_addr = rb + addr;
306 regbuf = (u32 *)bfad->regdata;
307 spin_lock_irqsave(&bfad->bfad_lock, flags);
308 for (i = 0; i < len; i++) {
309 *regbuf = readl(reg_addr);
310 regbuf++;
311 reg_addr += sizeof(u32);
312 }
313 spin_unlock_irqrestore(&bfad->bfad_lock, flags);
314
315 return nbytes;
316 }
317
318 static ssize_t
bfad_debugfs_write_regwr(struct file * file,const char __user * buf,size_t nbytes,loff_t * ppos)319 bfad_debugfs_write_regwr(struct file *file, const char __user *buf,
320 size_t nbytes, loff_t *ppos)
321 {
322 struct bfad_debug_info *debug = file->private_data;
323 struct bfad_port_s *port = (struct bfad_port_s *)debug->i_private;
324 struct bfad_s *bfad = port->bfad;
325 struct bfa_s *bfa = &bfad->bfa;
326 struct bfa_ioc_s *ioc = &bfa->ioc;
327 int addr, val, rc;
328 void __iomem *reg_addr;
329 unsigned long flags;
330 void *kern_buf;
331
332 kern_buf = memdup_user(buf, nbytes);
333 if (IS_ERR(kern_buf))
334 return PTR_ERR(kern_buf);
335
336 rc = sscanf(kern_buf, "%x:%x", &addr, &val);
337 if (rc < 2) {
338 printk(KERN_INFO
339 "bfad[%d]: %s failed to read user buf\n",
340 bfad->inst_no, __func__);
341 kfree(kern_buf);
342 return -EINVAL;
343 }
344 kfree(kern_buf);
345
346 addr &= BFA_REG_ADDRMSK(ioc); /* offset only 17 bit and word align */
347
348 /* offset and len sanity check */
349 rc = bfad_reg_offset_check(bfa, addr, 1);
350 if (rc) {
351 printk(KERN_INFO
352 "bfad[%d]: Failed reg offset check\n",
353 bfad->inst_no);
354 return -EINVAL;
355 }
356
357 reg_addr = (bfa_ioc_bar0(ioc)) + addr;
358 spin_lock_irqsave(&bfad->bfad_lock, flags);
359 writel(val, reg_addr);
360 spin_unlock_irqrestore(&bfad->bfad_lock, flags);
361
362 return nbytes;
363 }
364
365 static int
bfad_debugfs_release(struct inode * inode,struct file * file)366 bfad_debugfs_release(struct inode *inode, struct file *file)
367 {
368 struct bfad_debug_info *debug = file->private_data;
369
370 if (!debug)
371 return 0;
372
373 file->private_data = NULL;
374 kfree(debug);
375 return 0;
376 }
377
378 static int
bfad_debugfs_release_fwtrc(struct inode * inode,struct file * file)379 bfad_debugfs_release_fwtrc(struct inode *inode, struct file *file)
380 {
381 struct bfad_debug_info *fw_debug = file->private_data;
382
383 if (!fw_debug)
384 return 0;
385
386 if (fw_debug->debug_buffer)
387 vfree(fw_debug->debug_buffer);
388
389 file->private_data = NULL;
390 kfree(fw_debug);
391 return 0;
392 }
393
394 static const struct file_operations bfad_debugfs_op_drvtrc = {
395 .owner = THIS_MODULE,
396 .open = bfad_debugfs_open_drvtrc,
397 .llseek = bfad_debugfs_lseek,
398 .read = bfad_debugfs_read,
399 .release = bfad_debugfs_release,
400 };
401
402 static const struct file_operations bfad_debugfs_op_fwtrc = {
403 .owner = THIS_MODULE,
404 .open = bfad_debugfs_open_fwtrc,
405 .llseek = bfad_debugfs_lseek,
406 .read = bfad_debugfs_read,
407 .release = bfad_debugfs_release_fwtrc,
408 };
409
410 static const struct file_operations bfad_debugfs_op_fwsave = {
411 .owner = THIS_MODULE,
412 .open = bfad_debugfs_open_fwsave,
413 .llseek = bfad_debugfs_lseek,
414 .read = bfad_debugfs_read,
415 .release = bfad_debugfs_release_fwtrc,
416 };
417
418 static const struct file_operations bfad_debugfs_op_regrd = {
419 .owner = THIS_MODULE,
420 .open = bfad_debugfs_open_reg,
421 .llseek = bfad_debugfs_lseek,
422 .read = bfad_debugfs_read_regrd,
423 .write = bfad_debugfs_write_regrd,
424 .release = bfad_debugfs_release,
425 };
426
427 static const struct file_operations bfad_debugfs_op_regwr = {
428 .owner = THIS_MODULE,
429 .open = bfad_debugfs_open_reg,
430 .llseek = bfad_debugfs_lseek,
431 .write = bfad_debugfs_write_regwr,
432 .release = bfad_debugfs_release,
433 };
434
435 struct bfad_debugfs_entry {
436 const char *name;
437 umode_t mode;
438 const struct file_operations *fops;
439 };
440
441 static const struct bfad_debugfs_entry bfad_debugfs_files[] = {
442 { "drvtrc", S_IFREG|S_IRUGO, &bfad_debugfs_op_drvtrc, },
443 { "fwtrc", S_IFREG|S_IRUGO, &bfad_debugfs_op_fwtrc, },
444 { "fwsave", S_IFREG|S_IRUGO, &bfad_debugfs_op_fwsave, },
445 { "regrd", S_IFREG|S_IRUGO|S_IWUSR, &bfad_debugfs_op_regrd, },
446 { "regwr", S_IFREG|S_IWUSR, &bfad_debugfs_op_regwr, },
447 };
448
449 static struct dentry *bfa_debugfs_root;
450 static atomic_t bfa_debugfs_port_count;
451
452 inline void
bfad_debugfs_init(struct bfad_port_s * port)453 bfad_debugfs_init(struct bfad_port_s *port)
454 {
455 struct bfad_s *bfad = port->bfad;
456 const struct bfad_debugfs_entry *file;
457 char name[64];
458 int i;
459
460 if (!bfa_debugfs_enable)
461 return;
462
463 /* Setup the BFA debugfs root directory*/
464 if (!bfa_debugfs_root) {
465 bfa_debugfs_root = debugfs_create_dir("bfa", NULL);
466 atomic_set(&bfa_debugfs_port_count, 0);
467 if (!bfa_debugfs_root) {
468 printk(KERN_WARNING
469 "BFA debugfs root dir creation failed\n");
470 goto err;
471 }
472 }
473
474 /* Setup the pci_dev debugfs directory for the port */
475 snprintf(name, sizeof(name), "pci_dev:%s", bfad->pci_name);
476 if (!port->port_debugfs_root) {
477 port->port_debugfs_root =
478 debugfs_create_dir(name, bfa_debugfs_root);
479 if (!port->port_debugfs_root) {
480 printk(KERN_WARNING
481 "bfa %s: debugfs root creation failed\n",
482 bfad->pci_name);
483 goto err;
484 }
485
486 atomic_inc(&bfa_debugfs_port_count);
487
488 for (i = 0; i < ARRAY_SIZE(bfad_debugfs_files); i++) {
489 file = &bfad_debugfs_files[i];
490 bfad->bfad_dentry_files[i] =
491 debugfs_create_file(file->name,
492 file->mode,
493 port->port_debugfs_root,
494 port,
495 file->fops);
496 if (!bfad->bfad_dentry_files[i]) {
497 printk(KERN_WARNING
498 "bfa %s: debugfs %s creation failed\n",
499 bfad->pci_name, file->name);
500 goto err;
501 }
502 }
503 }
504
505 err:
506 return;
507 }
508
509 inline void
bfad_debugfs_exit(struct bfad_port_s * port)510 bfad_debugfs_exit(struct bfad_port_s *port)
511 {
512 struct bfad_s *bfad = port->bfad;
513 int i;
514
515 for (i = 0; i < ARRAY_SIZE(bfad_debugfs_files); i++) {
516 if (bfad->bfad_dentry_files[i]) {
517 debugfs_remove(bfad->bfad_dentry_files[i]);
518 bfad->bfad_dentry_files[i] = NULL;
519 }
520 }
521
522 /* Remove the pci_dev debugfs directory for the port */
523 if (port->port_debugfs_root) {
524 debugfs_remove(port->port_debugfs_root);
525 port->port_debugfs_root = NULL;
526 atomic_dec(&bfa_debugfs_port_count);
527 }
528
529 /* Remove the BFA debugfs root directory */
530 if (atomic_read(&bfa_debugfs_port_count) == 0) {
531 debugfs_remove(bfa_debugfs_root);
532 bfa_debugfs_root = NULL;
533 }
534 }
535