Orange Pi5 kernel

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