drivers/scsi/mpt3sas/mpt3sas_debug.h

   1 /*
   2  * Logging Support for MPT (Message Passing Technology) based controllers
   3  *
   4  * This code is based on drivers/scsi/mpt3sas/mpt3sas_debug.c
   5  * Copyright (C) 2012-2014  LSI Corporation
   6  * Copyright (C) 2013-2014 Avago Technologies
   7  *  (mailto: MPT-FusionLinux.pdl@avagotech.com)
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * NO WARRANTY
  20  * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
  21  * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
  22  * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
  23  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
  24  * solely responsible for determining the appropriateness of using and
  25  * distributing the Program and assumes all risks associated with its
  26  * exercise of rights under this Agreement, including but not limited to
  27  * the risks and costs of program errors, damage to or loss of data,
  28  * programs or equipment, and unavailability or interruption of operations.
  29
  30  * DISCLAIMER OF LIABILITY
  31  * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
  32  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
  34  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  35  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  36  * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
  37  * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
  38
  39  * You should have received a copy of the GNU General Public License
  40  * along with this program; if not, write to the Free Software
  41  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  42  * USA.
  43  */
  44
  45 #ifndef MPT3SAS_DEBUG_H_INCLUDED
  46 #define MPT3SAS_DEBUG_H_INCLUDED
  47
  48 #define MPT_DEBUG                       0x00000001
  49 #define MPT_DEBUG_MSG_FRAME             0x00000002
  50 #define MPT_DEBUG_SG                    0x00000004
  51 #define MPT_DEBUG_EVENTS                0x00000008
  52 #define MPT_DEBUG_EVENT_WORK_TASK       0x00000010
  53 #define MPT_DEBUG_INIT                  0x00000020
  54 #define MPT_DEBUG_EXIT                  0x00000040
  55 #define MPT_DEBUG_FAIL                  0x00000080
  56 #define MPT_DEBUG_TM                    0x00000100
  57 #define MPT_DEBUG_REPLY         0x00000200
  58 #define MPT_DEBUG_HANDSHAKE             0x00000400
  59 #define MPT_DEBUG_CONFIG                0x00000800
  60 #define MPT_DEBUG_DL                    0x00001000
  61 #define MPT_DEBUG_RESET         0x00002000
  62 #define MPT_DEBUG_SCSI                  0x00004000
  63 #define MPT_DEBUG_IOCTL         0x00008000
  64 #define MPT_DEBUG_SAS                   0x00020000
  65 #define MPT_DEBUG_TRANSPORT             0x00040000
  66 #define MPT_DEBUG_TASK_SET_FULL 0x00080000
  67
  68 #define MPT_DEBUG_TRIGGER_DIAG          0x00200000
  69
  70
  71 /*
  72  * CONFIG_SCSI_MPT3SAS_LOGGING - enabled in Kconfig
  73  */
  74
  75 #ifdef CONFIG_SCSI_MPT3SAS_LOGGING
  76 #define MPT_CHECK_LOGGING(IOC, CMD, BITS)                       \
  77 {                                                               \
  78         if (IOC->logging_level & BITS)                          \
  79                 CMD;                                            \
  80 }
  81 #else
  82 #define MPT_CHECK_LOGGING(IOC, CMD, BITS)
  83 #endif /* CONFIG_SCSI_MPT3SAS_LOGGING */
  84
  85
  86 /*
  87  * debug macros
  88  */
  89
  90 #define dprintk(IOC, CMD)                       \
  91         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG)
  92
  93 #define dsgprintk(IOC, CMD)                     \
  94         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_SG)
  95
  96 #define devtprintk(IOC, CMD)                    \
  97         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_EVENTS)
  98
  99 #define dewtprintk(IOC, CMD)            \
 100         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_EVENT_WORK_TASK)
 101
 102 #define dinitprintk(IOC, CMD)                   \
 103         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_INIT)
 104
 105 #define dexitprintk(IOC, CMD)                   \
 106         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_EXIT)
 107
 108 #define dfailprintk(IOC, CMD)                   \
 109         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_FAIL)
 110
 111 #define dtmprintk(IOC, CMD)                     \
 112         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_TM)
 113
 114 #define dreplyprintk(IOC, CMD)                  \
 115         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_REPLY)
 116
 117 #define dhsprintk(IOC, CMD)                     \
 118         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_HANDSHAKE)
 119
 120 #define dcprintk(IOC, CMD)                      \
 121         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_CONFIG)
 122
 123 #define ddlprintk(IOC, CMD)                     \
 124         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_DL)
 125
 126 #define drsprintk(IOC, CMD)                     \
 127         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_RESET)
 128
 129 #define dsprintk(IOC, CMD)                      \
 130         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_SCSI)
 131
 132 #define dctlprintk(IOC, CMD)                    \
 133         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_IOCTL)
 134
 135 #define dsasprintk(IOC, CMD)                    \
 136         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_SAS)
 137
 138 #define dsastransport(IOC, CMD)         \
 139         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_SAS_WIDE)
 140
 141 #define dmfprintk(IOC, CMD)                     \
 142         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_MSG_FRAME)
 143
 144 #define dtsfprintk(IOC, CMD)                    \
 145         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_TASK_SET_FULL)
 146
 147 #define dtransportprintk(IOC, CMD)                      \
 148         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_TRANSPORT)
 149
 150 #define dTriggerDiagPrintk(IOC, CMD)                    \
 151         MPT_CHECK_LOGGING(IOC, CMD, MPT_DEBUG_TRIGGER_DIAG)
 152
 153
 154
 155 /* inline functions for dumping debug data*/
 156 #ifdef CONFIG_SCSI_MPT3SAS_LOGGING
 157 /**
 158  * _debug_dump_mf - print message frame contents
 159  * @mpi_request: pointer to message frame
 160  * @sz: number of dwords
 161  */
 162 static inline void
 163 _debug_dump_mf(void *mpi_request, int sz)
 164 {
 165         int i;
 166         __le32 *mfp = (__le32 *)mpi_request;
 167
 168         pr_info("mf:\n\t");
 169         for (i = 0; i < sz; i++) {
 170                 if (i && ((i % 8) == 0))
 171                         pr_info("\n\t");
 172                 pr_info("%08x ", le32_to_cpu(mfp[i]));
 173         }
 174         pr_info("\n");
 175 }
 176 /**
 177  * _debug_dump_reply - print message frame contents
 178  * @mpi_request: pointer to message frame
 179  * @sz: number of dwords
 180  */
 181 static inline void
 182 _debug_dump_reply(void *mpi_request, int sz)
 183 {
 184         int i;
 185         __le32 *mfp = (__le32 *)mpi_request;
 186
 187         pr_info("reply:\n\t");
 188         for (i = 0; i < sz; i++) {
 189                 if (i && ((i % 8) == 0))
 190                         pr_info("\n\t");
 191                 pr_info("%08x ", le32_to_cpu(mfp[i]));
 192         }
 193         pr_info("\n");
 194 }
 195 /**
 196  * _debug_dump_config - print config page contents
 197  * @mpi_request: pointer to message frame
 198  * @sz: number of dwords
 199  */
 200 static inline void
 201 _debug_dump_config(void *mpi_request, int sz)
 202 {
 203         int i;
 204         __le32 *mfp = (__le32 *)mpi_request;
 205
 206         pr_info("config:\n\t");
 207         for (i = 0; i < sz; i++) {
 208                 if (i && ((i % 8) == 0))
 209                         pr_info("\n\t");
 210                 pr_info("%08x ", le32_to_cpu(mfp[i]));
 211         }
 212         pr_info("\n");
 213 }
 214 #else
 215 #define _debug_dump_mf(mpi_request, sz)
 216 #define _debug_dump_reply(mpi_request, sz)
 217 #define _debug_dump_config(mpi_request, sz)
 218 #endif /* CONFIG_SCSI_MPT3SAS_LOGGING */
 219
 220 #endif /* MPT3SAS_DEBUG_H_INCLUDED */