^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * QLogic iSCSI Offload Driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Copyright (c) 2016 Cavium Inc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) #ifndef _QEDI_DBG_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #define _QEDI_DBG_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include <linux/types.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/compiler.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/string.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/version.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/pci.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/delay.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <scsi/scsi_transport.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <scsi/scsi_transport_iscsi.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #include <linux/fs.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define __PREVENT_QED_HSI__
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #include <linux/qed/common_hsi.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #include <linux/qed/qed_if.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) extern uint qedi_dbg_log;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) /* Debug print level definitions */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) #define QEDI_LOG_DEFAULT 0x1 /* Set default logging mask */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) #define QEDI_LOG_INFO 0x2 /* Informational logs,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) * MAC address, WWPN, WWNN
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) #define QEDI_LOG_DISC 0x4 /* Init, discovery, rport */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) #define QEDI_LOG_LL2 0x8 /* LL2, VLAN logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) #define QEDI_LOG_CONN 0x10 /* Connection setup, cleanup */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) #define QEDI_LOG_EVT 0x20 /* Events, link, mtu */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) #define QEDI_LOG_TIMER 0x40 /* Timer events */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) #define QEDI_LOG_MP_REQ 0x80 /* Middle Path (MP) logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) #define QEDI_LOG_SCSI_TM 0x100 /* SCSI Aborts, Task Mgmt */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) #define QEDI_LOG_UNSOL 0x200 /* unsolicited event logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) #define QEDI_LOG_IO 0x400 /* scsi cmd, completion */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) #define QEDI_LOG_MQ 0x800 /* Multi Queue logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) #define QEDI_LOG_BSG 0x1000 /* BSG logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) #define QEDI_LOG_DEBUGFS 0x2000 /* debugFS logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) #define QEDI_LOG_LPORT 0x4000 /* lport logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) #define QEDI_LOG_ELS 0x8000 /* ELS logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) #define QEDI_LOG_NPIV 0x10000 /* NPIV logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #define QEDI_LOG_SESS 0x20000 /* Connection setup, cleanup */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) #define QEDI_LOG_UIO 0x40000 /* iSCSI UIO logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) #define QEDI_LOG_TID 0x80000 /* FW TID context acquire,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) * free
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) #define QEDI_TRACK_TID 0x100000 /* Track TID state. To be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) * enabled only at module load
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) * and not run-time.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) #define QEDI_TRACK_CMD_LIST 0x300000 /* Track active cmd list nodes,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) * done with reference to TID,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) * hence TRACK_TID also enabled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) #define QEDI_LOG_NOTICE 0x40000000 /* Notice logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) #define QEDI_LOG_WARN 0x80000000 /* Warning logs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) /* Debug context structure */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) struct qedi_dbg_ctx {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) unsigned int host_no;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) struct pci_dev *pdev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) #ifdef CONFIG_DEBUG_FS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) struct dentry *bdf_dentry;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) #define QEDI_ERR(pdev, fmt, ...) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) qedi_dbg_err(pdev, __func__, __LINE__, fmt, ## __VA_ARGS__)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) #define QEDI_WARN(pdev, fmt, ...) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) qedi_dbg_warn(pdev, __func__, __LINE__, fmt, ## __VA_ARGS__)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) #define QEDI_NOTICE(pdev, fmt, ...) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) qedi_dbg_notice(pdev, __func__, __LINE__, fmt, ## __VA_ARGS__)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) #define QEDI_INFO(pdev, level, fmt, ...) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) qedi_dbg_info(pdev, __func__, __LINE__, level, fmt, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) ## __VA_ARGS__)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) void qedi_dbg_err(struct qedi_dbg_ctx *qedi, const char *func, u32 line,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) const char *fmt, ...);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) void qedi_dbg_warn(struct qedi_dbg_ctx *qedi, const char *func, u32 line,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) const char *fmt, ...);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) void qedi_dbg_notice(struct qedi_dbg_ctx *qedi, const char *func, u32 line,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) const char *fmt, ...);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) void qedi_dbg_info(struct qedi_dbg_ctx *qedi, const char *func, u32 line,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) u32 info, const char *fmt, ...);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) struct Scsi_Host;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) struct sysfs_bin_attrs {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) char *name;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) struct bin_attribute *attr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) int qedi_create_sysfs_attr(struct Scsi_Host *shost,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) struct sysfs_bin_attrs *iter);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) void qedi_remove_sysfs_attr(struct Scsi_Host *shost,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) struct sysfs_bin_attrs *iter);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) /* DebugFS related code */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) struct qedi_list_of_funcs {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) char *oper_str;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) ssize_t (*oper_func)(struct qedi_dbg_ctx *qedi);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) struct qedi_debugfs_ops {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) char *name;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) struct qedi_list_of_funcs *qedi_funcs;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) #define qedi_dbg_fileops(drv, ops) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) .owner = THIS_MODULE, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) .open = simple_open, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) .read = drv##_dbg_##ops##_cmd_read, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) .write = drv##_dbg_##ops##_cmd_write \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) /* Used for debugfs sequential files */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define qedi_dbg_fileops_seq(drv, ops) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) .owner = THIS_MODULE, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) .open = drv##_dbg_##ops##_open, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) .read = seq_read, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) .llseek = seq_lseek, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) .release = single_release, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) void qedi_dbg_host_init(struct qedi_dbg_ctx *qedi,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) const struct qedi_debugfs_ops *dops,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) const struct file_operations *fops);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) void qedi_dbg_host_exit(struct qedi_dbg_ctx *qedi);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) void qedi_dbg_init(char *drv_name);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) void qedi_dbg_exit(void);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) #endif /* _QEDI_DBG_H_ */