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