2 * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
6 * Linux driver for Brocade Fibre Channel Host Bus Adapter.
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
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.
18 #include <linux/debugfs.h>
19 #include <linux/export.h>
25 * BFA debufs interface
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
32 * - bfa/pci_dev:<pci_name>
33 * where the pci_name corresponds to the one under /sys/bus/pci/drivers/bfa
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.
43 struct bfad_debug_info {
50 bfad_debugfs_open_drvtrc(struct inode *inode, struct file *file)
52 struct bfad_port_s *port = inode->i_private;
53 struct bfad_s *bfad = port->bfad;
54 struct bfad_debug_info *debug;
56 debug = kzalloc(sizeof(struct bfad_debug_info), GFP_KERNEL);
60 debug->debug_buffer = (void *) bfad->trcmod;
61 debug->buffer_len = sizeof(struct bfa_trc_mod_s);
63 file->private_data = debug;
69 bfad_debugfs_open_fwtrc(struct inode *inode, struct file *file)
71 struct bfad_port_s *port = inode->i_private;
72 struct bfad_s *bfad = port->bfad;
73 struct bfad_debug_info *fw_debug;
77 fw_debug = kzalloc(sizeof(struct bfad_debug_info), GFP_KERNEL);
81 fw_debug->buffer_len = sizeof(struct bfa_trc_mod_s);
83 fw_debug->debug_buffer = vmalloc(fw_debug->buffer_len);
84 if (!fw_debug->debug_buffer) {
86 printk(KERN_INFO "bfad[%d]: Failed to allocate fwtrc buffer\n",
91 memset(fw_debug->debug_buffer, 0, fw_debug->buffer_len);
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;
102 printk(KERN_INFO "bfad[%d]: Failed to collect fwtrc\n",
107 file->private_data = fw_debug;
113 bfad_debugfs_open_fwsave(struct inode *inode, struct file *file)
115 struct bfad_port_s *port = inode->i_private;
116 struct bfad_s *bfad = port->bfad;
117 struct bfad_debug_info *fw_debug;
121 fw_debug = kzalloc(sizeof(struct bfad_debug_info), GFP_KERNEL);
125 fw_debug->buffer_len = sizeof(struct bfa_trc_mod_s);
127 fw_debug->debug_buffer = vmalloc(fw_debug->buffer_len);
128 if (!fw_debug->debug_buffer) {
130 printk(KERN_INFO "bfad[%d]: Failed to allocate fwsave buffer\n",
135 memset(fw_debug->debug_buffer, 0, fw_debug->buffer_len);
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;
146 printk(KERN_INFO "bfad[%d]: Failed to collect fwsave\n",
151 file->private_data = fw_debug;
157 bfad_debugfs_open_reg(struct inode *inode, struct file *file)
159 struct bfad_debug_info *reg_debug;
161 reg_debug = kzalloc(sizeof(struct bfad_debug_info), GFP_KERNEL);
165 reg_debug->i_private = inode->i_private;
167 file->private_data = reg_debug;
172 /* Changes the current file position */
174 bfad_debugfs_lseek(struct file *file, loff_t offset, int orig)
176 struct bfad_debug_info *debug = file->private_data;
177 return fixed_size_llseek(file, offset, orig,
182 bfad_debugfs_read(struct file *file, char __user *buf,
183 size_t nbytes, loff_t *pos)
185 struct bfad_debug_info *debug = file->private_data;
187 if (!debug || !debug->debug_buffer)
190 return simple_read_from_buffer(buf, nbytes, pos,
191 debug->debug_buffer, debug->buffer_len);
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)
202 bfad_reg_offset_check(struct bfa_s *bfa, u32 offset, u32 len)
207 area = (offset >> 15) & 0x7;
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;
217 /* CB register space 64KB */
218 if ((offset + (len<<2)) > BFA_REG_ADDRMSK(&bfa->ioc))
219 return BFA_STATUS_EINVAL;
221 return BFA_STATUS_OK;
225 bfad_debugfs_read_regrd(struct file *file, char __user *buf,
226 size_t nbytes, loff_t *pos)
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;
236 rc = simple_read_from_buffer(buf, nbytes, pos,
237 bfad->regdata, bfad->reglen);
239 if ((*pos + nbytes) >= bfad->reglen) {
240 kfree(bfad->regdata);
241 bfad->regdata = NULL;
249 bfad_debugfs_write_regrd(struct file *file, const char __user *buf,
250 size_t nbytes, loff_t *ppos)
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, len, rc, i;
259 void __iomem *rb, *reg_addr;
263 kern_buf = kzalloc(nbytes, GFP_KERNEL);
266 printk(KERN_INFO "bfad[%d]: Failed to allocate buffer\n",
271 if (copy_from_user(kern_buf, (void __user *)buf, nbytes)) {
276 rc = sscanf(kern_buf, "%x:%x", &addr, &len);
279 "bfad[%d]: %s failed to read user buf\n",
280 bfad->inst_no, __func__);
286 kfree(bfad->regdata);
287 bfad->regdata = NULL;
290 bfad->regdata = kzalloc(len << 2, GFP_KERNEL);
291 if (!bfad->regdata) {
292 printk(KERN_INFO "bfad[%d]: Failed to allocate regrd buffer\n",
297 bfad->reglen = len << 2;
298 rb = bfa_ioc_bar0(ioc);
299 addr &= BFA_REG_ADDRMSK(ioc);
301 /* offset and len sanity check */
302 rc = bfad_reg_offset_check(bfa, addr, len);
304 printk(KERN_INFO "bfad[%d]: Failed reg offset check\n",
306 kfree(bfad->regdata);
307 bfad->regdata = NULL;
312 reg_addr = rb + addr;
313 regbuf = (u32 *)bfad->regdata;
314 spin_lock_irqsave(&bfad->bfad_lock, flags);
315 for (i = 0; i < len; i++) {
316 *regbuf = readl(reg_addr);
318 reg_addr += sizeof(u32);
320 spin_unlock_irqrestore(&bfad->bfad_lock, flags);
326 bfad_debugfs_write_regwr(struct file *file, const char __user *buf,
327 size_t nbytes, loff_t *ppos)
329 struct bfad_debug_info *debug = file->private_data;
330 struct bfad_port_s *port = (struct bfad_port_s *)debug->i_private;
331 struct bfad_s *bfad = port->bfad;
332 struct bfa_s *bfa = &bfad->bfa;
333 struct bfa_ioc_s *ioc = &bfa->ioc;
335 void __iomem *reg_addr;
339 kern_buf = kzalloc(nbytes, GFP_KERNEL);
342 printk(KERN_INFO "bfad[%d]: Failed to allocate buffer\n",
347 if (copy_from_user(kern_buf, (void __user *)buf, nbytes)) {
352 rc = sscanf(kern_buf, "%x:%x", &addr, &val);
355 "bfad[%d]: %s failed to read user buf\n",
356 bfad->inst_no, __func__);
362 addr &= BFA_REG_ADDRMSK(ioc); /* offset only 17 bit and word align */
364 /* offset and len sanity check */
365 rc = bfad_reg_offset_check(bfa, addr, 1);
368 "bfad[%d]: Failed reg offset check\n",
373 reg_addr = (bfa_ioc_bar0(ioc)) + addr;
374 spin_lock_irqsave(&bfad->bfad_lock, flags);
375 writel(val, reg_addr);
376 spin_unlock_irqrestore(&bfad->bfad_lock, flags);
382 bfad_debugfs_release(struct inode *inode, struct file *file)
384 struct bfad_debug_info *debug = file->private_data;
389 file->private_data = NULL;
395 bfad_debugfs_release_fwtrc(struct inode *inode, struct file *file)
397 struct bfad_debug_info *fw_debug = file->private_data;
402 if (fw_debug->debug_buffer)
403 vfree(fw_debug->debug_buffer);
405 file->private_data = NULL;
410 static const struct file_operations bfad_debugfs_op_drvtrc = {
411 .owner = THIS_MODULE,
412 .open = bfad_debugfs_open_drvtrc,
413 .llseek = bfad_debugfs_lseek,
414 .read = bfad_debugfs_read,
415 .release = bfad_debugfs_release,
418 static const struct file_operations bfad_debugfs_op_fwtrc = {
419 .owner = THIS_MODULE,
420 .open = bfad_debugfs_open_fwtrc,
421 .llseek = bfad_debugfs_lseek,
422 .read = bfad_debugfs_read,
423 .release = bfad_debugfs_release_fwtrc,
426 static const struct file_operations bfad_debugfs_op_fwsave = {
427 .owner = THIS_MODULE,
428 .open = bfad_debugfs_open_fwsave,
429 .llseek = bfad_debugfs_lseek,
430 .read = bfad_debugfs_read,
431 .release = bfad_debugfs_release_fwtrc,
434 static const struct file_operations bfad_debugfs_op_regrd = {
435 .owner = THIS_MODULE,
436 .open = bfad_debugfs_open_reg,
437 .llseek = bfad_debugfs_lseek,
438 .read = bfad_debugfs_read_regrd,
439 .write = bfad_debugfs_write_regrd,
440 .release = bfad_debugfs_release,
443 static const struct file_operations bfad_debugfs_op_regwr = {
444 .owner = THIS_MODULE,
445 .open = bfad_debugfs_open_reg,
446 .llseek = bfad_debugfs_lseek,
447 .write = bfad_debugfs_write_regwr,
448 .release = bfad_debugfs_release,
451 struct bfad_debugfs_entry {
454 const struct file_operations *fops;
457 static const struct bfad_debugfs_entry bfad_debugfs_files[] = {
458 { "drvtrc", S_IFREG|S_IRUGO, &bfad_debugfs_op_drvtrc, },
459 { "fwtrc", S_IFREG|S_IRUGO, &bfad_debugfs_op_fwtrc, },
460 { "fwsave", S_IFREG|S_IRUGO, &bfad_debugfs_op_fwsave, },
461 { "regrd", S_IFREG|S_IRUGO|S_IWUSR, &bfad_debugfs_op_regrd, },
462 { "regwr", S_IFREG|S_IWUSR, &bfad_debugfs_op_regwr, },
465 static struct dentry *bfa_debugfs_root;
466 static atomic_t bfa_debugfs_port_count;
469 bfad_debugfs_init(struct bfad_port_s *port)
471 struct bfad_s *bfad = port->bfad;
472 const struct bfad_debugfs_entry *file;
476 if (!bfa_debugfs_enable)
479 /* Setup the BFA debugfs root directory*/
480 if (!bfa_debugfs_root) {
481 bfa_debugfs_root = debugfs_create_dir("bfa", NULL);
482 atomic_set(&bfa_debugfs_port_count, 0);
483 if (!bfa_debugfs_root) {
485 "BFA debugfs root dir creation failed\n");
490 /* Setup the pci_dev debugfs directory for the port */
491 snprintf(name, sizeof(name), "pci_dev:%s", bfad->pci_name);
492 if (!port->port_debugfs_root) {
493 port->port_debugfs_root =
494 debugfs_create_dir(name, bfa_debugfs_root);
495 if (!port->port_debugfs_root) {
497 "bfa %s: debugfs root creation failed\n",
502 atomic_inc(&bfa_debugfs_port_count);
504 for (i = 0; i < ARRAY_SIZE(bfad_debugfs_files); i++) {
505 file = &bfad_debugfs_files[i];
506 bfad->bfad_dentry_files[i] =
507 debugfs_create_file(file->name,
509 port->port_debugfs_root,
512 if (!bfad->bfad_dentry_files[i]) {
514 "bfa %s: debugfs %s creation failed\n",
515 bfad->pci_name, file->name);
526 bfad_debugfs_exit(struct bfad_port_s *port)
528 struct bfad_s *bfad = port->bfad;
531 for (i = 0; i < ARRAY_SIZE(bfad_debugfs_files); i++) {
532 if (bfad->bfad_dentry_files[i]) {
533 debugfs_remove(bfad->bfad_dentry_files[i]);
534 bfad->bfad_dentry_files[i] = NULL;
538 /* Remove the pci_dev debugfs directory for the port */
539 if (port->port_debugfs_root) {
540 debugfs_remove(port->port_debugfs_root);
541 port->port_debugfs_root = NULL;
542 atomic_dec(&bfa_debugfs_port_count);
545 /* Remove the BFA debugfs root directory */
546 if (atomic_read(&bfa_debugfs_port_count) == 0) {
547 debugfs_remove(bfa_debugfs_root);
548 bfa_debugfs_root = NULL;