^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) #ifndef _SCSI_LOGGING_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) #define _SCSI_LOGGING_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4)
^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) * This defines the scsi logging feature. It is a means by which the user can
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * select how much information they get about various goings on, and it can be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * really useful for fault tracing. The logging word is divided into 10 3-bit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * bitfields, each of which describes a loglevel. The division of things is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) * somewhat arbitrary, and the division of the word could be changed if it
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) * were really needed for any reason. The numbers below are the only place
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) * where these are specified. For a first go-around, 3 bits is more than
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) * enough, since this gives 8 levels of logging (really 7, since 0 is always
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) * off). Cutting to 2 bits might be wise at some point.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #define SCSI_LOG_ERROR_SHIFT 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #define SCSI_LOG_TIMEOUT_SHIFT 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #define SCSI_LOG_SCAN_SHIFT 6
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define SCSI_LOG_MLQUEUE_SHIFT 9
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define SCSI_LOG_MLCOMPLETE_SHIFT 12
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define SCSI_LOG_LLQUEUE_SHIFT 15
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) #define SCSI_LOG_LLCOMPLETE_SHIFT 18
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) #define SCSI_LOG_HLQUEUE_SHIFT 21
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define SCSI_LOG_HLCOMPLETE_SHIFT 24
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define SCSI_LOG_IOCTL_SHIFT 27
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) #define SCSI_LOG_ERROR_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) #define SCSI_LOG_TIMEOUT_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) #define SCSI_LOG_SCAN_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) #define SCSI_LOG_MLQUEUE_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) #define SCSI_LOG_MLCOMPLETE_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) #define SCSI_LOG_LLQUEUE_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) #define SCSI_LOG_LLCOMPLETE_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) #define SCSI_LOG_HLQUEUE_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) #define SCSI_LOG_HLCOMPLETE_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) #define SCSI_LOG_IOCTL_BITS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) extern unsigned int scsi_logging_level;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) #ifdef CONFIG_SCSI_LOGGING
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) #define SCSI_LOG_LEVEL(SHIFT, BITS) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) ((scsi_logging_level >> (SHIFT)) & ((1 << (BITS)) - 1))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #define SCSI_CHECK_LOGGING(SHIFT, BITS, LEVEL, CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) do { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) if (unlikely((SCSI_LOG_LEVEL(SHIFT, BITS)) > (LEVEL))) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) do { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) CMD; \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) } while (0); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) } while (0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) #define SCSI_LOG_LEVEL(SHIFT, BITS) 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) #define SCSI_CHECK_LOGGING(SHIFT, BITS, LEVEL, CMD) do { } while (0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) #endif /* CONFIG_SCSI_LOGGING */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) * These are the macros that are actually used throughout the code to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) * log events. If logging isn't enabled, they are no-ops and will be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) * completely absent from the user's code.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) #define SCSI_LOG_ERROR_RECOVERY(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) SCSI_CHECK_LOGGING(SCSI_LOG_ERROR_SHIFT, SCSI_LOG_ERROR_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) #define SCSI_LOG_TIMEOUT(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) SCSI_CHECK_LOGGING(SCSI_LOG_TIMEOUT_SHIFT, SCSI_LOG_TIMEOUT_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) #define SCSI_LOG_SCAN_BUS(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) SCSI_CHECK_LOGGING(SCSI_LOG_SCAN_SHIFT, SCSI_LOG_SCAN_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) #define SCSI_LOG_MLQUEUE(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) SCSI_CHECK_LOGGING(SCSI_LOG_MLQUEUE_SHIFT, SCSI_LOG_MLQUEUE_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) #define SCSI_LOG_MLCOMPLETE(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) SCSI_CHECK_LOGGING(SCSI_LOG_MLCOMPLETE_SHIFT, SCSI_LOG_MLCOMPLETE_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) #define SCSI_LOG_LLQUEUE(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) SCSI_CHECK_LOGGING(SCSI_LOG_LLQUEUE_SHIFT, SCSI_LOG_LLQUEUE_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) #define SCSI_LOG_LLCOMPLETE(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) SCSI_CHECK_LOGGING(SCSI_LOG_LLCOMPLETE_SHIFT, SCSI_LOG_LLCOMPLETE_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) #define SCSI_LOG_HLQUEUE(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) SCSI_CHECK_LOGGING(SCSI_LOG_HLQUEUE_SHIFT, SCSI_LOG_HLQUEUE_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) #define SCSI_LOG_HLCOMPLETE(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) SCSI_CHECK_LOGGING(SCSI_LOG_HLCOMPLETE_SHIFT, SCSI_LOG_HLCOMPLETE_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) #define SCSI_LOG_IOCTL(LEVEL,CMD) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) SCSI_CHECK_LOGGING(SCSI_LOG_IOCTL_SHIFT, SCSI_LOG_IOCTL_BITS, LEVEL,CMD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) #endif /* _SCSI_LOGGING_H */