1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * QLogic FCoE Offload Driver 4 * Copyright (c) 2016-2018 Cavium Inc. 5 */ 6 #ifndef _QEDF_DBG_H_ 7 #define _QEDF_DBG_H_ 8 9 #include <linux/types.h> 10 #include <linux/kernel.h> 11 #include <linux/compiler.h> 12 #include <linux/string.h> 13 #include <linux/pci.h> 14 #include <linux/delay.h> 15 #include <scsi/scsi_transport.h> 16 #include <linux/fs.h> 17 18 #include <linux/qed/common_hsi.h> 19 #include <linux/qed/qed_if.h> 20 21 extern uint qedf_debug; 22 23 /* Debug print level definitions */ 24 #define QEDF_LOG_DEFAULT 0x1 /* Set default logging mask */ 25 #define QEDF_LOG_INFO 0x2 /* 26 * Informational logs, 27 * MAC address, WWPN, WWNN 28 */ 29 #define QEDF_LOG_DISC 0x4 /* Init, discovery, rport */ 30 #define QEDF_LOG_LL2 0x8 /* LL2, VLAN logs */ 31 #define QEDF_LOG_CONN 0x10 /* Connection setup, cleanup */ 32 #define QEDF_LOG_EVT 0x20 /* Events, link, mtu */ 33 #define QEDF_LOG_TIMER 0x40 /* Timer events */ 34 #define QEDF_LOG_MP_REQ 0x80 /* Middle Path (MP) logs */ 35 #define QEDF_LOG_SCSI_TM 0x100 /* SCSI Aborts, Task Mgmt */ 36 #define QEDF_LOG_UNSOL 0x200 /* unsolicited event logs */ 37 #define QEDF_LOG_IO 0x400 /* scsi cmd, completion */ 38 #define QEDF_LOG_MQ 0x800 /* Multi Queue logs */ 39 #define QEDF_LOG_BSG 0x1000 /* BSG logs */ 40 #define QEDF_LOG_DEBUGFS 0x2000 /* debugFS logs */ 41 #define QEDF_LOG_LPORT 0x4000 /* lport logs */ 42 #define QEDF_LOG_ELS 0x8000 /* ELS logs */ 43 #define QEDF_LOG_NPIV 0x10000 /* NPIV logs */ 44 #define QEDF_LOG_SESS 0x20000 /* Connection setup, cleanup */ 45 #define QEDF_LOG_TID 0x80000 /* 46 * FW TID context acquire 47 * free 48 */ 49 #define QEDF_TRACK_TID 0x100000 /* 50 * Track TID state. To be 51 * enabled only at module load 52 * and not run-time. 53 */ 54 #define QEDF_TRACK_CMD_LIST 0x300000 /* 55 * Track active cmd list nodes, 56 * done with reference to TID, 57 * hence TRACK_TID also enabled. 58 */ 59 #define QEDF_LOG_NOTICE 0x40000000 /* Notice logs */ 60 #define QEDF_LOG_WARN 0x80000000 /* Warning logs */ 61 62 /* Debug context structure */ 63 struct qedf_dbg_ctx { 64 unsigned int host_no; 65 struct pci_dev *pdev; 66 #ifdef CONFIG_DEBUG_FS 67 struct dentry *bdf_dentry; 68 #endif 69 }; 70 71 #define QEDF_ERR(pdev, fmt, ...) \ 72 qedf_dbg_err(pdev, __func__, __LINE__, fmt, ## __VA_ARGS__) 73 #define QEDF_WARN(pdev, fmt, ...) \ 74 qedf_dbg_warn(pdev, __func__, __LINE__, fmt, ## __VA_ARGS__) 75 #define QEDF_NOTICE(pdev, fmt, ...) \ 76 qedf_dbg_notice(pdev, __func__, __LINE__, fmt, ## __VA_ARGS__) 77 #define QEDF_INFO(pdev, level, fmt, ...) \ 78 qedf_dbg_info(pdev, __func__, __LINE__, level, fmt, \ 79 ## __VA_ARGS__) 80 __printf(4, 5) 81 void qedf_dbg_err(struct qedf_dbg_ctx *qedf, const char *func, u32 line, 82 const char *fmt, ...); 83 __printf(4, 5) 84 void qedf_dbg_warn(struct qedf_dbg_ctx *qedf, const char *func, u32 line, 85 const char *, ...); 86 __printf(4, 5) 87 void qedf_dbg_notice(struct qedf_dbg_ctx *qedf, const char *func, 88 u32 line, const char *, ...); 89 __printf(5, 6) 90 void qedf_dbg_info(struct qedf_dbg_ctx *qedf, const char *func, u32 line, 91 u32 info, const char *fmt, ...); 92 93 /* GRC Dump related defines */ 94 95 struct Scsi_Host; 96 97 #define QEDF_UEVENT_CODE_GRCDUMP 0 98 99 struct sysfs_bin_attrs { 100 char *name; 101 struct bin_attribute *attr; 102 }; 103 104 extern int qedf_alloc_grc_dump_buf(uint8_t **buf, uint32_t len); 105 extern void qedf_free_grc_dump_buf(uint8_t **buf); 106 extern int qedf_get_grc_dump(struct qed_dev *cdev, 107 const struct qed_common_ops *common, uint8_t **buf, 108 uint32_t *grcsize); 109 extern void qedf_uevent_emit(struct Scsi_Host *shost, u32 code, char *msg); 110 extern int qedf_create_sysfs_attr(struct Scsi_Host *shost, 111 struct sysfs_bin_attrs *iter); 112 extern void qedf_remove_sysfs_attr(struct Scsi_Host *shost, 113 struct sysfs_bin_attrs *iter); 114 115 struct qedf_debugfs_ops { 116 char *name; 117 struct qedf_list_of_funcs *qedf_funcs; 118 }; 119 120 extern const struct qedf_debugfs_ops qedf_debugfs_ops[]; 121 extern const struct file_operations qedf_dbg_fops[]; 122 123 #ifdef CONFIG_DEBUG_FS 124 /* DebugFS related code */ 125 struct qedf_list_of_funcs { 126 char *oper_str; 127 ssize_t (*oper_func)(struct qedf_dbg_ctx *qedf); 128 }; 129 130 #define qedf_dbg_fileops(drv, ops) \ 131 { \ 132 .owner = THIS_MODULE, \ 133 .open = simple_open, \ 134 .read = drv##_dbg_##ops##_cmd_read, \ 135 .write = drv##_dbg_##ops##_cmd_write \ 136 } 137 138 /* Used for debugfs sequential files */ 139 #define qedf_dbg_fileops_seq(drv, ops) \ 140 { \ 141 .owner = THIS_MODULE, \ 142 .open = drv##_dbg_##ops##_open, \ 143 .read = seq_read, \ 144 .llseek = seq_lseek, \ 145 .release = single_release, \ 146 } 147 148 extern void qedf_dbg_host_init(struct qedf_dbg_ctx *qedf, 149 const struct qedf_debugfs_ops *dops, 150 const struct file_operations *fops); 151 extern void qedf_dbg_host_exit(struct qedf_dbg_ctx *qedf); 152 extern void qedf_dbg_init(char *drv_name); 153 extern void qedf_dbg_exit(void); 154 #endif /* CONFIG_DEBUG_FS */ 155 156 #endif /* _QEDF_DBG_H_ */ 157