drivers/usb/storage/debug.h

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Driver for USB Mass Storage compliant devices
   4  * Debugging Functions Header File
   5  *
   6  * Current development and maintenance by:
   7  *   (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
   8  *
   9  * Initial work by:
  10  *   (c) 1999 Michael Gee (michael@linuxspecific.com)
  11  *
  12  * This driver is based on the 'USB Mass Storage Class' document. This
  13  * describes in detail the protocol used to communicate with such
  14  * devices.  Clearly, the designers had SCSI and ATAPI commands in
  15  * mind when they created this document.  The commands are all very
  16  * similar to commands in the SCSI-II and ATAPI specifications.
  17  *
  18  * It is important to note that in a number of cases this class
  19  * exhibits class-specific exemptions from the USB specification.
  20  * Notably the usage of NAK, STALL and ACK differs from the norm, in
  21  * that they are used to communicate wait, failed and OK on commands.
  22  *
  23  * Also, for certain devices, the interrupt endpoint is used to convey
  24  * status of a command.
  25  *
  26  * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
  27  * information about this driver.
  28  *
  29  * This program is free software; you can redistribute it and/or modify it
  30  * under the terms of the GNU General Public License as published by the
  31  * Free Software Foundation; either version 2, or (at your option) any
  32  * later version.
  33  *
  34  * This program is distributed in the hope that it will be useful, but
  35  * WITHOUT ANY WARRANTY; without even the implied warranty of
  36  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  37  * General Public License for more details.
  38  *
  39  * You should have received a copy of the GNU General Public License along
  40  * with this program; if not, write to the Free Software Foundation, Inc.,
  41  * 675 Mass Ave, Cambridge, MA 02139, USA.
  42  */
  43
  44 #ifndef _DEBUG_H_
  45 #define _DEBUG_H_
  46
  47 #include <linux/kernel.h>
  48
  49 #define USB_STORAGE "usb-storage: "
  50
  51 #ifdef CONFIG_USB_STORAGE_DEBUG
  52 void usb_stor_show_command(const struct us_data *us, struct scsi_cmnd *srb);
  53 void usb_stor_show_sense(const struct us_data *us, unsigned char key,
  54                          unsigned char asc, unsigned char ascq);
  55 __printf(2, 3) void usb_stor_dbg(const struct us_data *us,
  56                                  const char *fmt, ...);
  57
  58 #define US_DEBUG(x)             x
  59 #else
  60 __printf(2, 3)
  61 static inline void _usb_stor_dbg(const struct us_data *us,
  62                                  const char *fmt, ...)
  63 {
  64 }
  65 #define usb_stor_dbg(us, fmt, ...)                              \
  66         do { if (0) _usb_stor_dbg(us, fmt, ##__VA_ARGS__); } while (0)
  67 #define US_DEBUG(x)
  68 #endif
  69
  70 #endif