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