usb/storage/debug.c

0001 // SPDX-License-Identifier: GPL-2.0+
0002 /*
0003  * Driver for USB Mass Storage compliant devices
0004  * Debugging Functions Source Code File
0005  *
0006  * Current development and maintenance by:
0007  *   (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
0008  *
0009  * Developed with the assistance of:
0010  *   (c) 2002 Alan Stern <stern@rowland.org>
0011  *
0012  * Initial work by:
0013  *   (c) 1999 Michael Gee (michael@linuxspecific.com)
0014  *
0015  * This driver is based on the 'USB Mass Storage Class' document. This
0016  * describes in detail the protocol used to communicate with such
0017  * devices.  Clearly, the designers had SCSI and ATAPI commands in
0018  * mind when they created this document.  The commands are all very
0019  * similar to commands in the SCSI-II and ATAPI specifications.
0020  *
0021  * It is important to note that in a number of cases this class
0022  * exhibits class-specific exemptions from the USB specification.
0023  * Notably the usage of NAK, STALL and ACK differs from the norm, in
0024  * that they are used to communicate wait, failed and OK on commands.
0025  *
0026  * Also, for certain devices, the interrupt endpoint is used to convey
0027  * status of a command.
0028  */
0029
0030 #include <linux/device.h>
0031 #include <linux/cdrom.h>
0032 #include <linux/export.h>
0033 #include <scsi/scsi.h>
0034 #include <scsi/scsi_cmnd.h>
0035 #include <scsi/scsi_dbg.h>
0036
0037 #include "usb.h"
0038 #include "debug.h"
0039
0040
0041 void usb_stor_show_command(const struct us_data *us, struct scsi_cmnd *srb)
0042 {
0043     char *what = NULL;
0044
0045     switch (srb->cmnd[0]) {
0046     case TEST_UNIT_READY: what = "TEST_UNIT_READY"; break;
0047     case REZERO_UNIT: what = "REZERO_UNIT"; break;
0048     case REQUEST_SENSE: what = "REQUEST_SENSE"; break;
0049     case FORMAT_UNIT: what = "FORMAT_UNIT"; break;
0050     case READ_BLOCK_LIMITS: what = "READ_BLOCK_LIMITS"; break;
0051     case REASSIGN_BLOCKS: what = "REASSIGN_BLOCKS"; break;
0052     case READ_6: what = "READ_6"; break;
0053     case WRITE_6: what = "WRITE_6"; break;
0054     case SEEK_6: what = "SEEK_6"; break;
0055     case READ_REVERSE: what = "READ_REVERSE"; break;
0056     case WRITE_FILEMARKS: what = "WRITE_FILEMARKS"; break;
0057     case SPACE: what = "SPACE"; break;
0058     case INQUIRY: what = "INQUIRY"; break;
0059     case RECOVER_BUFFERED_DATA: what = "RECOVER_BUFFERED_DATA"; break;
0060     case MODE_SELECT: what = "MODE_SELECT"; break;
0061     case RESERVE: what = "RESERVE"; break;
0062     case RELEASE: what = "RELEASE"; break;
0063     case COPY: what = "COPY"; break;
0064     case ERASE: what = "ERASE"; break;
0065     case MODE_SENSE: what = "MODE_SENSE"; break;
0066     case START_STOP: what = "START_STOP"; break;
0067     case RECEIVE_DIAGNOSTIC: what = "RECEIVE_DIAGNOSTIC"; break;
0068     case SEND_DIAGNOSTIC: what = "SEND_DIAGNOSTIC"; break;
0069     case ALLOW_MEDIUM_REMOVAL: what = "ALLOW_MEDIUM_REMOVAL"; break;
0070     case SET_WINDOW: what = "SET_WINDOW"; break;
0071     case READ_CAPACITY: what = "READ_CAPACITY"; break;
0072     case READ_10: what = "READ_10"; break;
0073     case WRITE_10: what = "WRITE_10"; break;
0074     case SEEK_10: what = "SEEK_10"; break;
0075     case WRITE_VERIFY: what = "WRITE_VERIFY"; break;
0076     case VERIFY: what = "VERIFY"; break;
0077     case SEARCH_HIGH: what = "SEARCH_HIGH"; break;
0078     case SEARCH_EQUAL: what = "SEARCH_EQUAL"; break;
0079     case SEARCH_LOW: what = "SEARCH_LOW"; break;
0080     case SET_LIMITS: what = "SET_LIMITS"; break;
0081     case READ_POSITION: what = "READ_POSITION"; break;
0082     case SYNCHRONIZE_CACHE: what = "SYNCHRONIZE_CACHE"; break;
0083     case LOCK_UNLOCK_CACHE: what = "LOCK_UNLOCK_CACHE"; break;
0084     case READ_DEFECT_DATA: what = "READ_DEFECT_DATA"; break;
0085     case MEDIUM_SCAN: what = "MEDIUM_SCAN"; break;
0086     case COMPARE: what = "COMPARE"; break;
0087     case COPY_VERIFY: what = "COPY_VERIFY"; break;
0088     case WRITE_BUFFER: what = "WRITE_BUFFER"; break;
0089     case READ_BUFFER: what = "READ_BUFFER"; break;
0090     case UPDATE_BLOCK: what = "UPDATE_BLOCK"; break;
0091     case READ_LONG: what = "READ_LONG"; break;
0092     case WRITE_LONG: what = "WRITE_LONG"; break;
0093     case CHANGE_DEFINITION: what = "CHANGE_DEFINITION"; break;
0094     case WRITE_SAME: what = "WRITE_SAME"; break;
0095     case GPCMD_READ_SUBCHANNEL: what = "READ SUBCHANNEL"; break;
0096     case READ_TOC: what = "READ_TOC"; break;
0097     case GPCMD_READ_HEADER: what = "READ HEADER"; break;
0098     case GPCMD_PLAY_AUDIO_10: what = "PLAY AUDIO (10)"; break;
0099     case GPCMD_PLAY_AUDIO_MSF: what = "PLAY AUDIO MSF"; break;
0100     case GPCMD_GET_EVENT_STATUS_NOTIFICATION:
0101         what = "GET EVENT/STATUS NOTIFICATION"; break;
0102     case GPCMD_PAUSE_RESUME: what = "PAUSE/RESUME"; break;
0103     case LOG_SELECT: what = "LOG_SELECT"; break;
0104     case LOG_SENSE: what = "LOG_SENSE"; break;
0105     case GPCMD_STOP_PLAY_SCAN: what = "STOP PLAY/SCAN"; break;
0106     case GPCMD_READ_DISC_INFO: what = "READ DISC INFORMATION"; break;
0107     case GPCMD_READ_TRACK_RZONE_INFO:
0108         what = "READ TRACK INFORMATION"; break;
0109     case GPCMD_RESERVE_RZONE_TRACK: what = "RESERVE TRACK"; break;
0110     case GPCMD_SEND_OPC: what = "SEND OPC"; break;
0111     case MODE_SELECT_10: what = "MODE_SELECT_10"; break;
0112     case GPCMD_REPAIR_RZONE_TRACK: what = "REPAIR TRACK"; break;
0113     case 0x59: what = "READ MASTER CUE"; break;
0114     case MODE_SENSE_10: what = "MODE_SENSE_10"; break;
0115     case GPCMD_CLOSE_TRACK: what = "CLOSE TRACK/SESSION"; break;
0116     case 0x5C: what = "READ BUFFER CAPACITY"; break;
0117     case 0x5D: what = "SEND CUE SHEET"; break;
0118     case GPCMD_BLANK: what = "BLANK"; break;
0119     case REPORT_LUNS: what = "REPORT LUNS"; break;
0120     case MOVE_MEDIUM: what = "MOVE_MEDIUM or PLAY AUDIO (12)"; break;
0121     case READ_12: what = "READ_12"; break;
0122     case WRITE_12: what = "WRITE_12"; break;
0123     case WRITE_VERIFY_12: what = "WRITE_VERIFY_12"; break;
0124     case SEARCH_HIGH_12: what = "SEARCH_HIGH_12"; break;
0125     case SEARCH_EQUAL_12: what = "SEARCH_EQUAL_12"; break;
0126     case SEARCH_LOW_12: what = "SEARCH_LOW_12"; break;
0127     case SEND_VOLUME_TAG: what = "SEND_VOLUME_TAG"; break;
0128     case READ_ELEMENT_STATUS: what = "READ_ELEMENT_STATUS"; break;
0129     case GPCMD_READ_CD_MSF: what = "READ CD MSF"; break;
0130     case GPCMD_SCAN: what = "SCAN"; break;
0131     case GPCMD_SET_SPEED: what = "SET CD SPEED"; break;
0132     case GPCMD_MECHANISM_STATUS: what = "MECHANISM STATUS"; break;
0133     case GPCMD_READ_CD: what = "READ CD"; break;
0134     case 0xE1: what = "WRITE CONTINUE"; break;
0135     case WRITE_LONG_2: what = "WRITE_LONG_2"; break;
0136     default: what = "(unknown command)"; break;
0137     }
0138     usb_stor_dbg(us, "Command %s (%d bytes)\n", what, srb->cmd_len);
0139     usb_stor_dbg(us, "bytes: %*ph\n", min_t(int, srb->cmd_len, 16),
0140              (const unsigned char *)srb->cmnd);
0141 }
0142
0143 void usb_stor_show_sense(const struct us_data *us,
0144              unsigned char key,
0145              unsigned char asc,
0146              unsigned char ascq)
0147 {
0148     const char *what, *keystr, *fmt;
0149
0150     keystr = scsi_sense_key_string(key);
0151     what = scsi_extd_sense_format(asc, ascq, &fmt);
0152
0153     if (keystr == NULL)
0154         keystr = "(Unknown Key)";
0155     if (what == NULL)
0156         what = "(unknown ASC/ASCQ)";
0157
0158     if (fmt)
0159         usb_stor_dbg(us, "%s: %s (%s%x)\n", keystr, what, fmt, ascq);
0160     else
0161         usb_stor_dbg(us, "%s: %s\n", keystr, what);
0162 }
0163
0164 void usb_stor_dbg(const struct us_data *us, const char *fmt, ...)
0165 {
0166     va_list args;
0167
0168     va_start(args, fmt);
0169
0170     dev_vprintk_emit(LOGLEVEL_DEBUG, &us->pusb_dev->dev, fmt, args);
0171
0172     va_end(args);
0173 }
0174 EXPORT_SYMBOL_GPL(usb_stor_dbg);