Merge branch 'docs-next' of git://git.lwn.net/linux-2.6
[linux-2.6] / drivers / usb / storage / debug.c
1 /* Driver for USB Mass Storage compliant devices
2  * Debugging Functions Source Code File
3  *
4  * Current development and maintenance by:
5  *   (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
6  *
7  * Developed with the assistance of:
8  *   (c) 2002 Alan Stern <stern@rowland.org>
9  *
10  * Initial work by:
11  *   (c) 1999 Michael Gee (michael@linuxspecific.com)
12  *
13  * This driver is based on the 'USB Mass Storage Class' document. This
14  * describes in detail the protocol used to communicate with such
15  * devices.  Clearly, the designers had SCSI and ATAPI commands in
16  * mind when they created this document.  The commands are all very
17  * similar to commands in the SCSI-II and ATAPI specifications.
18  *
19  * It is important to note that in a number of cases this class
20  * exhibits class-specific exemptions from the USB specification.
21  * Notably the usage of NAK, STALL and ACK differs from the norm, in
22  * that they are used to communicate wait, failed and OK on commands.
23  *
24  * Also, for certain devices, the interrupt endpoint is used to convey
25  * status of a command.
26  *
27  * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
28  * information about this driver.
29  *
30  * This program is free software; you can redistribute it and/or modify it
31  * under the terms of the GNU General Public License as published by the
32  * Free Software Foundation; either version 2, or (at your option) any
33  * later version.
34  *
35  * This program is distributed in the hope that it will be useful, but
36  * WITHOUT ANY WARRANTY; without even the implied warranty of
37  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
38  * General Public License for more details.
39  *
40  * You should have received a copy of the GNU General Public License along
41  * with this program; if not, write to the Free Software Foundation, Inc.,
42  * 675 Mass Ave, Cambridge, MA 02139, USA.
43  */
44
45 #include <linux/cdrom.h>
46 #include <scsi/scsi.h>
47 #include <scsi/scsi_cmnd.h>
48 #include <scsi/scsi_dbg.h>
49
50 #include "debug.h"
51 #include "scsi.h"
52
53
54 void usb_stor_show_command(struct scsi_cmnd *srb)
55 {
56         char *what = NULL;
57         int i;
58
59         switch (srb->cmnd[0]) {
60         case TEST_UNIT_READY: what = "TEST_UNIT_READY"; break;
61         case REZERO_UNIT: what = "REZERO_UNIT"; break;
62         case REQUEST_SENSE: what = "REQUEST_SENSE"; break;
63         case FORMAT_UNIT: what = "FORMAT_UNIT"; break;
64         case READ_BLOCK_LIMITS: what = "READ_BLOCK_LIMITS"; break;
65         case REASSIGN_BLOCKS: what = "REASSIGN_BLOCKS"; break;
66         case READ_6: what = "READ_6"; break;
67         case WRITE_6: what = "WRITE_6"; break;
68         case SEEK_6: what = "SEEK_6"; break;
69         case READ_REVERSE: what = "READ_REVERSE"; break;
70         case WRITE_FILEMARKS: what = "WRITE_FILEMARKS"; break;
71         case SPACE: what = "SPACE"; break;
72         case INQUIRY: what = "INQUIRY"; break;
73         case RECOVER_BUFFERED_DATA: what = "RECOVER_BUFFERED_DATA"; break;
74         case MODE_SELECT: what = "MODE_SELECT"; break;
75         case RESERVE: what = "RESERVE"; break;
76         case RELEASE: what = "RELEASE"; break;
77         case COPY: what = "COPY"; break;
78         case ERASE: what = "ERASE"; break;
79         case MODE_SENSE: what = "MODE_SENSE"; break;
80         case START_STOP: what = "START_STOP"; break;
81         case RECEIVE_DIAGNOSTIC: what = "RECEIVE_DIAGNOSTIC"; break;
82         case SEND_DIAGNOSTIC: what = "SEND_DIAGNOSTIC"; break;
83         case ALLOW_MEDIUM_REMOVAL: what = "ALLOW_MEDIUM_REMOVAL"; break;
84         case SET_WINDOW: what = "SET_WINDOW"; break;
85         case READ_CAPACITY: what = "READ_CAPACITY"; break;
86         case READ_10: what = "READ_10"; break;
87         case WRITE_10: what = "WRITE_10"; break;
88         case SEEK_10: what = "SEEK_10"; break;
89         case WRITE_VERIFY: what = "WRITE_VERIFY"; break;
90         case VERIFY: what = "VERIFY"; break;
91         case SEARCH_HIGH: what = "SEARCH_HIGH"; break;
92         case SEARCH_EQUAL: what = "SEARCH_EQUAL"; break;
93         case SEARCH_LOW: what = "SEARCH_LOW"; break;
94         case SET_LIMITS: what = "SET_LIMITS"; break;
95         case READ_POSITION: what = "READ_POSITION"; break;
96         case SYNCHRONIZE_CACHE: what = "SYNCHRONIZE_CACHE"; break;
97         case LOCK_UNLOCK_CACHE: what = "LOCK_UNLOCK_CACHE"; break;
98         case READ_DEFECT_DATA: what = "READ_DEFECT_DATA"; break;
99         case MEDIUM_SCAN: what = "MEDIUM_SCAN"; break;
100         case COMPARE: what = "COMPARE"; break;
101         case COPY_VERIFY: what = "COPY_VERIFY"; break;
102         case WRITE_BUFFER: what = "WRITE_BUFFER"; break;
103         case READ_BUFFER: what = "READ_BUFFER"; break;
104         case UPDATE_BLOCK: what = "UPDATE_BLOCK"; break;
105         case READ_LONG: what = "READ_LONG"; break;
106         case WRITE_LONG: what = "WRITE_LONG"; break;
107         case CHANGE_DEFINITION: what = "CHANGE_DEFINITION"; break;
108         case WRITE_SAME: what = "WRITE_SAME"; break;
109         case GPCMD_READ_SUBCHANNEL: what = "READ SUBCHANNEL"; break;
110         case READ_TOC: what = "READ_TOC"; break;
111         case GPCMD_READ_HEADER: what = "READ HEADER"; break;
112         case GPCMD_PLAY_AUDIO_10: what = "PLAY AUDIO (10)"; break;
113         case GPCMD_PLAY_AUDIO_MSF: what = "PLAY AUDIO MSF"; break;
114         case GPCMD_GET_EVENT_STATUS_NOTIFICATION:
115                 what = "GET EVENT/STATUS NOTIFICATION"; break;
116         case GPCMD_PAUSE_RESUME: what = "PAUSE/RESUME"; break;
117         case LOG_SELECT: what = "LOG_SELECT"; break;
118         case LOG_SENSE: what = "LOG_SENSE"; break;
119         case GPCMD_STOP_PLAY_SCAN: what = "STOP PLAY/SCAN"; break;
120         case GPCMD_READ_DISC_INFO: what = "READ DISC INFORMATION"; break;
121         case GPCMD_READ_TRACK_RZONE_INFO:
122                 what = "READ TRACK INFORMATION"; break;
123         case GPCMD_RESERVE_RZONE_TRACK: what = "RESERVE TRACK"; break;
124         case GPCMD_SEND_OPC: what = "SEND OPC"; break;
125         case MODE_SELECT_10: what = "MODE_SELECT_10"; break;
126         case GPCMD_REPAIR_RZONE_TRACK: what = "REPAIR TRACK"; break;
127         case 0x59: what = "READ MASTER CUE"; break;
128         case MODE_SENSE_10: what = "MODE_SENSE_10"; break;
129         case GPCMD_CLOSE_TRACK: what = "CLOSE TRACK/SESSION"; break;
130         case 0x5C: what = "READ BUFFER CAPACITY"; break;
131         case 0x5D: what = "SEND CUE SHEET"; break;
132         case GPCMD_BLANK: what = "BLANK"; break;
133         case REPORT_LUNS: what = "REPORT LUNS"; break;
134         case MOVE_MEDIUM: what = "MOVE_MEDIUM or PLAY AUDIO (12)"; break;
135         case READ_12: what = "READ_12"; break;
136         case WRITE_12: what = "WRITE_12"; break;
137         case WRITE_VERIFY_12: what = "WRITE_VERIFY_12"; break;
138         case SEARCH_HIGH_12: what = "SEARCH_HIGH_12"; break;
139         case SEARCH_EQUAL_12: what = "SEARCH_EQUAL_12"; break;
140         case SEARCH_LOW_12: what = "SEARCH_LOW_12"; break;
141         case SEND_VOLUME_TAG: what = "SEND_VOLUME_TAG"; break;
142         case READ_ELEMENT_STATUS: what = "READ_ELEMENT_STATUS"; break;
143         case GPCMD_READ_CD_MSF: what = "READ CD MSF"; break;
144         case GPCMD_SCAN: what = "SCAN"; break;
145         case GPCMD_SET_SPEED: what = "SET CD SPEED"; break;
146         case GPCMD_MECHANISM_STATUS: what = "MECHANISM STATUS"; break;
147         case GPCMD_READ_CD: what = "READ CD"; break;
148         case 0xE1: what = "WRITE CONTINUE"; break;
149         case WRITE_LONG_2: what = "WRITE_LONG_2"; break;
150         default: what = "(unknown command)"; break;
151         }
152         US_DEBUGP("Command %s (%d bytes)\n", what, srb->cmd_len);
153         US_DEBUGP("");
154         for (i = 0; i < srb->cmd_len && i < 16; i++)
155                 US_DEBUGPX(" %02x", srb->cmnd[i]);
156         US_DEBUGPX("\n");
157 }
158
159 void usb_stor_show_sense(
160                 unsigned char key,
161                 unsigned char asc,
162                 unsigned char ascq) {
163
164         const char *what, *keystr;
165
166         keystr = scsi_sense_key_string(key);
167         what = scsi_extd_sense_format(asc, ascq);
168
169         if (keystr == NULL)
170                 keystr = "(Unknown Key)";
171         if (what == NULL)
172                 what = "(unknown ASC/ASCQ)";
173
174         US_DEBUGP("%s: ", keystr);
175         US_DEBUGPX(what, ascq);
176         US_DEBUGPX("\n");
177 }