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