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