Home | History | Annotate | Line # | Download | only in scsipi
scsi_base.c revision 1.50
      1 /*	$NetBSD: scsi_base.c,v 1.50 1997/10/01 01:18:56 enami Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1994, 1995, 1997 Charles M. Hannum.  All rights reserved.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions
      8  * are met:
      9  * 1. Redistributions of source code must retain the above copyright
     10  *    notice, this list of conditions and the following disclaimer.
     11  * 2. Redistributions in binary form must reproduce the above copyright
     12  *    notice, this list of conditions and the following disclaimer in the
     13  *    documentation and/or other materials provided with the distribution.
     14  * 3. All advertising materials mentioning features or use of this software
     15  *    must display the following acknowledgement:
     16  *	This product includes software developed by Charles M. Hannum.
     17  * 4. The name of the author may not be used to endorse or promote products
     18  *    derived from this software without specific prior written permission.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 /*
     33  * Originally written by Julian Elischer (julian (at) dialix.oz.au)
     34  */
     35 
     36 #include "opt_scsiverbose.h"
     37 
     38 #include <sys/types.h>
     39 #include <sys/param.h>
     40 #include <sys/systm.h>
     41 #include <sys/kernel.h>
     42 #include <sys/buf.h>
     43 #include <sys/uio.h>
     44 #include <sys/malloc.h>
     45 #include <sys/errno.h>
     46 #include <sys/device.h>
     47 #include <sys/proc.h>
     48 
     49 #include <dev/scsipi/scsipi_all.h>
     50 #include <dev/scsipi/scsi_all.h>
     51 #include <dev/scsipi/scsi_disk.h>
     52 #include <dev/scsipi/scsiconf.h>
     53 #include <dev/scsipi/scsipi_base.h>
     54 
     55 #ifdef SCSIVERBOSE
     56 static	void asc2ascii __P((unsigned char, unsigned char, char *));
     57 char	*scsi_decode_sense __P((void *, int));
     58 #endif
     59 
     60 /*
     61  * Do a scsi operation, asking a device to run as SCSI-II if it can.
     62  */
     63 int
     64 scsi_change_def(sc_link, flags)
     65 	struct scsipi_link *sc_link;
     66 	int flags;
     67 {
     68 	struct scsi_changedef scsipi_cmd;
     69 
     70 	bzero(&scsipi_cmd, sizeof(scsipi_cmd));
     71 	scsipi_cmd.opcode = SCSI_CHANGE_DEFINITION;
     72 	scsipi_cmd.how = SC_SCSI_2;
     73 
     74 	return ((*sc_link->scsipi_cmd)(sc_link,
     75 	    (struct scsipi_generic *) &scsipi_cmd, sizeof(scsipi_cmd),
     76 	    0, 0, 2, 100000, NULL, flags));
     77 }
     78 
     79 /*
     80  * ask the scsi driver to perform a command for us.
     81  * tell it where to read/write the data, and how
     82  * long the data is supposed to be. If we have  a buf
     83  * to associate with the transfer, we need that too.
     84  */
     85 int
     86 scsi_scsipi_cmd(sc_link, scsipi_cmd, cmdlen, data_addr, datalen,
     87 	retries, timeout, bp, flags)
     88 	struct scsipi_link *sc_link;
     89 	struct scsipi_generic *scsipi_cmd;
     90 	int cmdlen;
     91 	u_char *data_addr;
     92 	int datalen;
     93 	int retries;
     94 	int timeout;
     95 	struct buf *bp;
     96 	int flags;
     97 {
     98 	struct scsipi_xfer *xs;
     99 	int error;
    100 
    101 	SC_DEBUG(sc_link, SDEV_DB2, ("scsi_scsipi_cmd\n"));
    102 
    103 #ifdef DIAGNOSTIC
    104 	if (bp != 0 && (flags & SCSI_NOSLEEP) == 0)
    105 		panic("scsi_scsipi_cmd: buffer without nosleep");
    106 #endif
    107 
    108 	if ((xs = scsipi_make_xs(sc_link, scsipi_cmd, cmdlen, data_addr,
    109 	    datalen, retries, timeout, bp, flags)) == NULL)
    110 		return (ENOMEM);
    111 
    112 	if ((error = scsipi_execute_xs(xs)) == EJUSTRETURN)
    113 		return (0);
    114 
    115 	/*
    116 	 * we have finished with the xfer stuct, free it and
    117 	 * check if anyone else needs to be started up.
    118 	 */
    119 	scsipi_free_xs(xs, flags);
    120 	return (error);
    121 }
    122 
    123 /*
    124  * Look at the returned sense and act on the error, determining
    125  * the unix error number to pass back.  (0 = report no error)
    126  *
    127  * THIS IS THE DEFAULT ERROR HANDLER FOR SCSI DEVICES
    128  */
    129 int
    130 scsi_interpret_sense(xs)
    131 	struct scsipi_xfer *xs;
    132 {
    133 	struct scsipi_sense_data *sense;
    134 	struct scsipi_link *sc_link = xs->sc_link;
    135 	u_int8_t key;
    136 	u_int32_t info;
    137 	int error;
    138 #ifndef	SCSIVERBOSE
    139 	static char *error_mes[] = {
    140 		"soft error (corrected)",
    141 		"not ready", "medium error",
    142 		"non-media hardware failure", "illegal request",
    143 		"unit attention", "readonly device",
    144 		"no data found", "vendor unique",
    145 		"copy aborted", "command aborted",
    146 		"search returned equal", "volume overflow",
    147 		"verify miscompare", "unknown error key"
    148 	};
    149 #endif
    150 
    151 	sense = &xs->sense.scsi_sense;
    152 #ifdef	SCSIDEBUG
    153 	if ((sc_link->flags & SDEV_DB1) != 0) {
    154 		int count;
    155 		printf("code 0x%x valid 0x%x ",
    156 			sense->error_code & SSD_ERRCODE,
    157 			sense->error_code & SSD_ERRCODE_VALID ? 1 : 0);
    158 		printf("seg 0x%x key 0x%x ili 0x%x eom 0x%x fmark 0x%x\n",
    159 			sense->segment,
    160 			sense->flags & SSD_KEY,
    161 			sense->flags & SSD_ILI ? 1 : 0,
    162 			sense->flags & SSD_EOM ? 1 : 0,
    163 			sense->flags & SSD_FILEMARK ? 1 : 0);
    164 		printf("info: 0x%x 0x%x 0x%x 0x%x followed by %d extra bytes\n",
    165 			sense->info[0],
    166 			sense->info[1],
    167 			sense->info[2],
    168 			sense->info[3],
    169 			sense->extra_len);
    170 		printf("extra: ");
    171 		for (count = 0; count < sense->extra_len; count++)
    172 			printf("0x%x ", sense->extra_bytes[count]);
    173 		printf("\n");
    174 	}
    175 #endif	/* SCSIDEBUG */
    176 	/*
    177 	 * If the device has it's own error handler, call it first.
    178 	 * If it returns a legit error value, return that, otherwise
    179 	 * it wants us to continue with normal error processing.
    180 	 */
    181 	if (sc_link->device->err_handler) {
    182 		SC_DEBUG(sc_link, SDEV_DB2,
    183 		    ("calling private err_handler()\n"));
    184 		error = (*sc_link->device->err_handler)(xs);
    185 		if (error != -1)
    186 			return (error);		/* error >= 0  better ? */
    187 	}
    188 	/* otherwise use the default */
    189 	switch (sense->error_code & SSD_ERRCODE) {
    190 		/*
    191 		 * If it's code 70, use the extended stuff and
    192 		 * interpret the key
    193 		 */
    194 	case 0x71:		/* delayed error */
    195 		sc_link->sc_print_addr(sc_link);
    196 		key = sense->flags & SSD_KEY;
    197 		printf(" DEFERRED ERROR, key = 0x%x\n", key);
    198 		/* FALLTHROUGH */
    199 	case 0x70:
    200 		if ((sense->error_code & SSD_ERRCODE_VALID) != 0)
    201 			info = _4btol(sense->info);
    202 		else
    203 			info = 0;
    204 		key = sense->flags & SSD_KEY;
    205 
    206 		switch (key) {
    207 		case 0x0:	/* NO SENSE */
    208 		case 0x1:	/* RECOVERED ERROR */
    209 			if (xs->resid == xs->datalen)
    210 				xs->resid = 0;	/* not short read */
    211 		case 0xc:	/* EQUAL */
    212 			error = 0;
    213 			break;
    214 		case 0x2:	/* NOT READY */
    215 			if ((sc_link->flags & SDEV_REMOVABLE) != 0)
    216 				sc_link->flags &= ~SDEV_MEDIA_LOADED;
    217 			if ((xs->flags & SCSI_IGNORE_NOT_READY) != 0)
    218 				return (0);
    219 			if ((xs->flags & SCSI_SILENT) != 0)
    220 				return (EIO);
    221 			error = EIO;
    222 			break;
    223 		case 0x5:	/* ILLEGAL REQUEST */
    224 			if ((xs->flags & SCSI_IGNORE_ILLEGAL_REQUEST) != 0)
    225 				return (0);
    226 			if ((xs->flags & SCSI_SILENT) != 0)
    227 				return (EIO);
    228 			error = EINVAL;
    229 			break;
    230 		case 0x6:	/* UNIT ATTENTION */
    231 			if ((sc_link->flags & SDEV_REMOVABLE) != 0)
    232 				sc_link->flags &= ~SDEV_MEDIA_LOADED;
    233 			if ((xs->flags & SCSI_IGNORE_MEDIA_CHANGE) != 0 ||
    234 				/* XXX Should reupload any transient state. */
    235 				(sc_link->flags & SDEV_REMOVABLE) == 0)
    236 				return (ERESTART);
    237 			if ((xs->flags & SCSI_SILENT) != 0)
    238 				return (EIO);
    239 			error = EIO;
    240 			break;
    241 		case 0x7:	/* DATA PROTECT */
    242 			error = EACCES;
    243 			break;
    244 		case 0x8:	/* BLANK CHECK */
    245 			error = 0;
    246 			break;
    247 		case 0xb:	/* COMMAND ABORTED */
    248 			error = ERESTART;
    249 			break;
    250 		case 0xd:	/* VOLUME OVERFLOW */
    251 			error = ENOSPC;
    252 			break;
    253 		default:
    254 			error = EIO;
    255 			break;
    256 		}
    257 
    258 #ifdef SCSIVERBOSE
    259 		scsi_print_sense(xs, 0);
    260 #else
    261 		if (key) {
    262 			sc_link->sc_print_addr(sc_link);
    263 			printf("%s", error_mes[key - 1]);
    264 			if ((sense->error_code & SSD_ERRCODE_VALID) != 0) {
    265 				switch (key) {
    266 				case 0x2:	/* NOT READY */
    267 				case 0x5:	/* ILLEGAL REQUEST */
    268 				case 0x6:	/* UNIT ATTENTION */
    269 				case 0x7:	/* DATA PROTECT */
    270 					break;
    271 				case 0x8:	/* BLANK CHECK */
    272 					printf(", requested size: %d (decimal)",
    273 					    info);
    274 					break;
    275 				case 0xb:
    276 					if (xs->retries)
    277 						printf(", retrying");
    278 					printf(", cmd 0x%x, info 0x%x",
    279 					    xs->cmd->opcode, info);
    280 					break;
    281 				default:
    282 					printf(", info = %d (decimal)", info);
    283 				}
    284 			}
    285 			if (sense->extra_len != 0) {
    286 				int n;
    287 				printf(", data =");
    288 				for (n = 0; n < sense->extra_len; n++)
    289 					printf(" %02x",
    290 					    sense->cmd_spec_info[n]);
    291 			}
    292 			printf("\n");
    293 		}
    294 #endif
    295 		return (error);
    296 
    297 	/*
    298 	 * Not code 70, just report it
    299 	 */
    300 	default:
    301 		sc_link->sc_print_addr(sc_link);
    302 		printf("error code %d", sense->error_code & SSD_ERRCODE);
    303 		if ((sense->error_code & SSD_ERRCODE_VALID) != 0) {
    304 			struct scsipi_sense_data_unextended *usense =
    305 			    (struct scsipi_sense_data_unextended *)sense;
    306 			printf(" at block no. %d (decimal)",
    307 			    _3btol(usense->block));
    308 		}
    309 		printf("\n");
    310 		return (EIO);
    311 	}
    312 }
    313 
    314 /*
    315  * Utility routines often used in SCSI stuff
    316  */
    317 
    318 
    319 /*
    320  * Print out the scsi_link structure's address info.
    321  */
    322 void
    323 scsi_print_addr(sc_link)
    324 	struct scsipi_link *sc_link;
    325 {
    326 
    327 	printf("%s(%s:%d:%d): ",
    328 	    sc_link->device_softc ?
    329 	    ((struct device *)sc_link->device_softc)->dv_xname : "probe",
    330 	    ((struct device *)sc_link->adapter_softc)->dv_xname,
    331 	    sc_link->scsipi_scsi.target, sc_link->scsipi_scsi.lun);
    332 }
    333 
    334 #ifdef SCSIVERBOSE
    335 static const char *sense_keys[16] = {
    336 	"No Additional Sense",
    337 	"Soft Error",
    338 	"Not Ready",
    339 	"Media Error",
    340 	"Hardware Error",
    341 	"Illegal Request",
    342 	"Unit Attention",
    343 	"Write Protected",
    344 	"Blank Check",
    345 	"Vendor Unique",
    346 	"Copy Aborted",
    347 	"Aborted Command",
    348 	"Equal Error",
    349 	"Volume Overflow",
    350 	"Miscompare Error",
    351 	"Reserved"
    352 };
    353 static const struct {
    354 	unsigned char asc;
    355 	unsigned char ascq;
    356 	char *description;
    357 } adesc[] = {
    358 { 0x00, 0x00, "No Additional Sense Information" },
    359 { 0x00, 0x01, "Filemark Detected" },
    360 { 0x00, 0x02, "End-Of-Partition/Medium Detected" },
    361 { 0x00, 0x03, "Setmark Detected" },
    362 { 0x00, 0x04, "Beginning-Of-Partition/Medium Detected" },
    363 { 0x00, 0x05, "End-Of-Data Detected" },
    364 { 0x00, 0x06, "I/O Process Terminated" },
    365 { 0x00, 0x11, "Audio Play Operation In Progress" },
    366 { 0x00, 0x12, "Audio Play Operation Paused" },
    367 { 0x00, 0x13, "Audio Play Operation Successfully Completed" },
    368 { 0x00, 0x14, "Audio Play Operation Stopped Due to Error" },
    369 { 0x00, 0x15, "No Current Audio Status To Return" },
    370 { 0x01, 0x00, "No Index/Sector Signal" },
    371 { 0x02, 0x00, "No Seek Complete" },
    372 { 0x03, 0x00, "Peripheral Device Write Fault" },
    373 { 0x03, 0x01, "No Write Current" },
    374 { 0x03, 0x02, "Excessive Write Errors" },
    375 { 0x04, 0x00, "Logical Unit Not Ready, Cause Not Reportable" },
    376 { 0x04, 0x01, "Logical Unit Is in Process Of Becoming Ready" },
    377 { 0x04, 0x02, "Logical Unit Not Ready, Initialization Command Required" },
    378 { 0x04, 0x03, "Logical Unit Not Ready, Manual Intervention Required" },
    379 { 0x04, 0x04, "Logical Unit Not Ready, Format In Progress" },
    380 { 0x05, 0x00, "Logical Unit Does Not Respond To Selection" },
    381 { 0x06, 0x00, "No Reference Position Found" },
    382 { 0x07, 0x00, "Multiple Peripheral Devices Selected" },
    383 { 0x08, 0x00, "Logical Unit Communication Failure" },
    384 { 0x08, 0x01, "Logical Unit Communication Timeout" },
    385 { 0x08, 0x02, "Logical Unit Communication Parity Error" },
    386 { 0x09, 0x00, "Track Following Error" },
    387 { 0x09, 0x01, "Tracking Servo Failure" },
    388 { 0x09, 0x02, "Focus Servo Failure" },
    389 { 0x09, 0x03, "Spindle Servo Failure" },
    390 { 0x0A, 0x00, "Error Log Overflow" },
    391 { 0x0C, 0x00, "Write Error" },
    392 { 0x0C, 0x01, "Write Error Recovered with Auto Reallocation" },
    393 { 0x0C, 0x02, "Write Error - Auto Reallocate Failed" },
    394 { 0x10, 0x00, "ID CRC Or ECC Error" },
    395 { 0x11, 0x00, "Unrecovered Read Error" },
    396 { 0x11, 0x01, "Read Retried Exhausted" },
    397 { 0x11, 0x02, "Error Too Long To Correct" },
    398 { 0x11, 0x03, "Multiple Read Errors" },
    399 { 0x11, 0x04, "Unrecovered Read Error - Auto Reallocate Failed" },
    400 { 0x11, 0x05, "L-EC Uncorrectable Error" },
    401 { 0x11, 0x06, "CIRC Unrecovered Error" },
    402 { 0x11, 0x07, "Data Resynchronization Error" },
    403 { 0x11, 0x08, "Incomplete Block Found" },
    404 { 0x11, 0x09, "No Gap Found" },
    405 { 0x11, 0x0A, "Miscorrected Error" },
    406 { 0x11, 0x0B, "Uncorrected Read Error - Recommend Reassignment" },
    407 { 0x11, 0x0C, "Uncorrected Read Error - Recommend Rewrite the Data" },
    408 { 0x12, 0x00, "Address Mark Not Found for ID Field" },
    409 { 0x13, 0x00, "Address Mark Not Found for Data Field" },
    410 { 0x14, 0x00, "Recorded Entity Not Found" },
    411 { 0x14, 0x01, "Record Not Found" },
    412 { 0x14, 0x02, "Filemark or Setmark Not Found" },
    413 { 0x14, 0x03, "End-Of-Data Not Found" },
    414 { 0x14, 0x04, "Block Sequence Error" },
    415 { 0x15, 0x00, "Random Positioning Error" },
    416 { 0x15, 0x01, "Mechanical Positioning Error" },
    417 { 0x15, 0x02, "Positioning Error Detected By Read of Medium" },
    418 { 0x16, 0x00, "Data Synchronization Mark Error" },
    419 { 0x17, 0x00, "Recovered Data With No Error Correction Applied" },
    420 { 0x17, 0x01, "Recovered Data With Retries" },
    421 { 0x17, 0x02, "Recovered Data With Positive Head Offset" },
    422 { 0x17, 0x03, "Recovered Data With Negative Head Offset" },
    423 { 0x17, 0x04, "Recovered Data With Retries and/or CIRC Applied" },
    424 { 0x17, 0x05, "Recovered Data Using Previous Sector ID" },
    425 { 0x17, 0x06, "Recovered Data Without ECC - Data Auto-Reallocated" },
    426 { 0x17, 0x07, "Recovered Data Without ECC - Recommend Reassignment" },
    427 { 0x17, 0x08, "Recovered Data Without ECC - Recommend Rewrite" },
    428 { 0x18, 0x00, "Recovered Data With Error Correction Applied" },
    429 { 0x18, 0x01, "Recovered Data With Error Correction & Retries Applied" },
    430 { 0x18, 0x02, "Recovered Data - Data Auto-Reallocated" },
    431 { 0x18, 0x03, "Recovered Data With CIRC" },
    432 { 0x18, 0x04, "Recovered Data With LEC" },
    433 { 0x18, 0x05, "Recovered Data - Recommend Reassignment" },
    434 { 0x18, 0x06, "Recovered Data - Recommend Rewrite" },
    435 { 0x19, 0x00, "Defect List Error" },
    436 { 0x19, 0x01, "Defect List Not Available" },
    437 { 0x19, 0x02, "Defect List Error in Primary List" },
    438 { 0x19, 0x03, "Defect List Error in Grown List" },
    439 { 0x1A, 0x00, "Parameter List Length Error" },
    440 { 0x1B, 0x00, "Synchronous Data Transfer Error" },
    441 { 0x1C, 0x00, "Defect List Not Found" },
    442 { 0x1C, 0x01, "Primary Defect List Not Found" },
    443 { 0x1C, 0x02, "Grown Defect List Not Found" },
    444 { 0x1D, 0x00, "Miscompare During Verify Operation" },
    445 { 0x1E, 0x00, "Recovered ID with ECC" },
    446 { 0x20, 0x00, "Invalid Command Operation Code" },
    447 { 0x21, 0x00, "Logical Block Address Out of Range" },
    448 { 0x21, 0x01, "Invalid Element Address" },
    449 { 0x22, 0x00, "Illegal Function (Should 20 00, 24 00, or 26 00)" },
    450 { 0x24, 0x00, "Illegal Field in CDB" },
    451 { 0x25, 0x00, "Logical Unit Not Supported" },
    452 { 0x26, 0x00, "Invalid Field In Parameter List" },
    453 { 0x26, 0x01, "Parameter Not Supported" },
    454 { 0x26, 0x02, "Parameter Value Invalid" },
    455 { 0x26, 0x03, "Threshold Parameters Not Supported" },
    456 { 0x27, 0x00, "Write Protected" },
    457 { 0x28, 0x00, "Not Ready To Ready Transition (Medium May Have Changed)" },
    458 { 0x28, 0x01, "Import Or Export Element Accessed" },
    459 { 0x29, 0x00, "Power On, Reset, or Bus Device Reset Occurred" },
    460 { 0x2A, 0x00, "Parameters Changed" },
    461 { 0x2A, 0x01, "Mode Parameters Changed" },
    462 { 0x2A, 0x02, "Log Parameters Changed" },
    463 { 0x2B, 0x00, "Copy Cannot Execute Since Host Cannot Disconnect" },
    464 { 0x2C, 0x00, "Command Sequence Error" },
    465 { 0x2C, 0x01, "Too Many Windows Specified" },
    466 { 0x2C, 0x02, "Invalid Combination of Windows Specified" },
    467 { 0x2D, 0x00, "Overwrite Error On Update In Place" },
    468 { 0x2F, 0x00, "Commands Cleared By Another Initiator" },
    469 { 0x30, 0x00, "Incompatible Medium Installed" },
    470 { 0x30, 0x01, "Cannot Read Medium - Unknown Format" },
    471 { 0x30, 0x02, "Cannot Read Medium - Incompatible Format" },
    472 { 0x30, 0x03, "Cleaning Cartridge Installed" },
    473 { 0x31, 0x00, "Medium Format Corrupted" },
    474 { 0x31, 0x01, "Format Command Failed" },
    475 { 0x32, 0x00, "No Defect Spare Location Available" },
    476 { 0x32, 0x01, "Defect List Update Failure" },
    477 { 0x33, 0x00, "Tape Length Error" },
    478 { 0x36, 0x00, "Ribbon, Ink, or Toner Failure" },
    479 { 0x37, 0x00, "Rounded Parameter" },
    480 { 0x39, 0x00, "Saving Parameters Not Supported" },
    481 { 0x3A, 0x00, "Medium Not Present" },
    482 { 0x3B, 0x00, "Positioning Error" },
    483 { 0x3B, 0x01, "Tape Position Error At Beginning-of-Medium" },
    484 { 0x3B, 0x02, "Tape Position Error At End-of-Medium" },
    485 { 0x3B, 0x03, "Tape or Electronic Vertical Forms Unit Not Ready" },
    486 { 0x3B, 0x04, "Slew Failure" },
    487 { 0x3B, 0x05, "Paper Jam" },
    488 { 0x3B, 0x06, "Failed To Sense Top-Of-Form" },
    489 { 0x3B, 0x07, "Failed To Sense Bottom-Of-Form" },
    490 { 0x3B, 0x08, "Reposition Error" },
    491 { 0x3B, 0x09, "Read Past End Of Medium" },
    492 { 0x3B, 0x0A, "Read Past Begining Of Medium" },
    493 { 0x3B, 0x0B, "Position Past End Of Medium" },
    494 { 0x3B, 0x0C, "Position Past Beginning Of Medium" },
    495 { 0x3B, 0x0D, "Medium Destination Element Full" },
    496 { 0x3B, 0x0E, "Medium Source Element Empty" },
    497 { 0x3D, 0x00, "Invalid Bits In IDENTFY Message" },
    498 { 0x3E, 0x00, "Logical Unit Has Not Self-Configured Yet" },
    499 { 0x3F, 0x00, "Target Operating Conditions Have Changed" },
    500 { 0x3F, 0x01, "Microcode Has Changed" },
    501 { 0x3F, 0x02, "Changed Operating Definition" },
    502 { 0x3F, 0x03, "INQUIRY Data Has Changed" },
    503 { 0x40, 0x00, "RAM FAILURE (Should Use 40 NN)" },
    504 { 0x41, 0x00, "Data Path FAILURE (Should Use 40 NN)" },
    505 { 0x42, 0x00, "Power-On or Self-Test FAILURE (Should Use 40 NN)" },
    506 { 0x43, 0x00, "Message Error" },
    507 { 0x44, 0x00, "Internal Target Failure" },
    508 { 0x45, 0x00, "Select Or Reselect Failure" },
    509 { 0x46, 0x00, "Unsuccessful Soft Reset" },
    510 { 0x47, 0x00, "SCSI Parity Error" },
    511 { 0x48, 0x00, "INITIATOR DETECTED ERROR Message Received" },
    512 { 0x49, 0x00, "Invalid Message Error" },
    513 { 0x4A, 0x00, "Command Phase Error" },
    514 { 0x4B, 0x00, "Data Phase Error" },
    515 { 0x4C, 0x00, "Logical Unit Failed Self-Configuration" },
    516 { 0x4E, 0x00, "Overlapped Commands Attempted" },
    517 { 0x50, 0x00, "Write Append Error" },
    518 { 0x50, 0x01, "Write Append Position Error" },
    519 { 0x50, 0x01, "Write Append Position Error" },
    520 { 0x50, 0x02, "Position Error Related To Timing" },
    521 { 0x51, 0x00, "Erase Failure" },
    522 { 0x52, 0x00, "Cartridge Fault" },
    523 { 0x53, 0x00, "Media Load or Eject Failed" },
    524 { 0x53, 0x01, "Unload Tape Failure" },
    525 { 0x53, 0x02, "Medium Removal Prevented" },
    526 { 0x54, 0x00, "SCSI To Host System Interface Failure" },
    527 { 0x55, 0x00, "System Resource Failure" },
    528 { 0x57, 0x00, "Unable To Recover Table-Of-Contents" },
    529 { 0x58, 0x00, "Generation Does Not Exist" },
    530 { 0x59, 0x00, "Updated Block Read" },
    531 { 0x5A, 0x00, "Operator Request or State Change Input (Unspecified)" },
    532 { 0x5A, 0x01, "Operator Medium Removal Requested" },
    533 { 0x5A, 0x02, "Operator Selected Write Protect" },
    534 { 0x5A, 0x03, "Operator Selected Write Permit" },
    535 { 0x5B, 0x00, "Log Exception" },
    536 { 0x5B, 0x01, "Threshold Condition Met" },
    537 { 0x5B, 0x02, "Log Counter At Maximum" },
    538 { 0x5B, 0x03, "Log List Codes Exhausted" },
    539 { 0x5C, 0x00, "RPL Status Change" },
    540 { 0x5C, 0x01, "Spindles Synchronized" },
    541 { 0x5C, 0x02, "Spindles Not Synchronized" },
    542 { 0x60, 0x00, "Lamp Failure" },
    543 { 0x61, 0x00, "Video Acquisition Error" },
    544 { 0x61, 0x01, "Unable To Acquire Video" },
    545 { 0x61, 0x02, "Out Of Focus" },
    546 { 0x62, 0x00, "Scan Head Positioning Error" },
    547 { 0x63, 0x00, "End Of User Area Encountered On This Track" },
    548 { 0x64, 0x00, "Illegal Mode For This Track" },
    549 { 0x00, 0x00, NULL }
    550 };
    551 
    552 static inline void
    553 asc2ascii(asc, ascq, result)
    554 	unsigned char asc, ascq;
    555 	char *result;
    556 {
    557 	register int i = 0;
    558 
    559 	while (adesc[i].description != NULL) {
    560 		if (adesc[i].asc == asc && adesc[i].ascq == ascq)
    561 			break;
    562 		i++;
    563 	}
    564 	if (adesc[i].description == NULL) {
    565 		if (asc == 0x40 && ascq != 0)
    566 			(void)sprintf(result,
    567 			    "Diagnostic Failure on Component 0x%02x",
    568 			    ascq & 0xff);
    569 		else
    570 			(void)sprintf(result, "ASC 0x%02x ASCQ 0x%02x",
    571 			    asc & 0xff, ascq & 0xff);
    572 	} else
    573 		(void)strcpy(result, adesc[i].description);
    574 }
    575 
    576 void
    577 scsi_print_sense(xs, verbosity)
    578 	struct scsipi_xfer *xs;
    579 	int verbosity;
    580 {
    581 	int32_t info;
    582 	register int i, j, k;
    583 	char *sbs, *s;
    584 
    585 	xs->sc_link->sc_print_addr(xs->sc_link);
    586 	s = (char *) &xs->sense.scsi_sense;
    587 	printf(" Check Condition on opcode %x\n", xs->cmd->opcode);
    588 
    589 	/*
    590 	 * Basics- print out SENSE KEY
    591 	 */
    592 	printf("    SENSE KEY:  %s", scsi_decode_sense(s, 0));
    593 
    594 	/*
    595 	 * Print out, unqualified but aligned, FMK, EOM and ILI status.
    596 	 */
    597 	if (s[2] & 0xe0) {
    598 		char pad;
    599 		printf("\n              ");
    600 		pad = ' ';
    601 		if (s[2] & SSD_FILEMARK) {
    602 			printf("%c Filemark Detected", pad);
    603 			pad = ',';
    604 		}
    605 		if (s[2] & SSD_EOM) {
    606 			printf("%c EOM Detected", pad);
    607 			pad = ',';
    608 		}
    609 		if (s[2] & SSD_ILI)
    610 			printf("%c Incorrect Length Indicator Set", pad);
    611 	}
    612 
    613 	/*
    614 	 * Now we should figure out, based upon device type, how
    615 	 * to format the information field. Unfortunately, that's
    616 	 * not convenient here, so we'll print it as a signed
    617 	 * 32 bit integer.
    618 	 */
    619 	info = _4btol(&s[3]);
    620 	if (info)
    621 		printf("\n   INFO FIELD:  %d", info);
    622 
    623 	/*
    624 	 * Now we check additional length to see whether there is
    625 	 * more information to extract.
    626 	 */
    627 
    628 	/* enough for command specific information? */
    629 	if (s[7] < 4) {
    630 		printf("\n");
    631 		return;
    632 	}
    633 	info = _4btol(&s[8]);
    634 	if (info)
    635 		printf("\n COMMAND INFO:  %d (0x%x)", info, info);
    636 
    637 	/*
    638 	 * Decode ASC && ASCQ info, plus FRU, plus the rest...
    639 	 */
    640 
    641 	sbs = scsi_decode_sense(s, 1);
    642 	if (sbs)
    643 		printf("\n     ASC/ASCQ:  %s", sbs);
    644 	if (s[14] != 0)
    645 		printf("\n     FRU CODE:  0x%x\n", s[14] & 0xff);
    646 	sbs = scsi_decode_sense(s, 3);
    647 	if (sbs)
    648 		printf("\n         SKSV:  %s", sbs);
    649 	printf("\n");
    650 	if (verbosity == 0) {
    651 		printf("\n");
    652 		return;
    653 	}
    654 
    655 	/*
    656 	 * Now figure whether we should print any additional informtion.
    657 	 *
    658 	 * Where should we start from? If we had SKSV data,
    659 	 * start from offset 18, else from offset 15.
    660 	 *
    661 	 * From that point until the end of the buffer, check for any
    662 	 * nonzero data. If we have some, go back and print the lot,
    663 	 * otherwise we're done.
    664 	 */
    665 	if (sbs)
    666 		i = 18;
    667 	else
    668 		i = 15;
    669 	for (j = i; j < sizeof (xs->sense); j++)
    670 		if (s[j])
    671 			break;
    672 	if (j == sizeof (xs->sense))
    673 		return;
    674 
    675 	printf("\n Additional Sense Information (byte %d out...):\n", i);
    676 	if (i == 15) {
    677 		printf("\n\t%2d:", i);
    678 		k = 7;
    679 	} else {
    680 		printf("\n\t%2d:", i);
    681 		k = 2;
    682 		j -= 2;
    683 	}
    684 	while (j > 0) {
    685 		if (i >= sizeof (xs->sense))
    686 			break;
    687 		if (k == 8) {
    688 			k = 0;
    689 			printf("\n\t%2d:", i);
    690 		}
    691 		printf(" 0x%02x", s[i] & 0xff);
    692 		k++;
    693 		j--;
    694 		i++;
    695 	}
    696 	printf("\n\n");
    697 }
    698 
    699 char *
    700 scsi_decode_sense(sinfo, flag)
    701 	void *sinfo;
    702 	int flag;
    703 {
    704 	unsigned char *snsbuf;
    705 	unsigned char skey;
    706 	static char rqsbuf[132];
    707 
    708 	skey = 0;
    709 
    710 	snsbuf = (unsigned char *) sinfo;
    711 	if (flag == 0 || flag == 2 || flag == 3)
    712 		skey = snsbuf[2] & 0xf;
    713 	if (flag == 0) {			/* Sense Key Only */
    714 		(void) strcpy(rqsbuf, sense_keys[skey]);
    715 		return (rqsbuf);
    716 	} else if (flag == 1) {			/* ASC/ASCQ Only */
    717 		asc2ascii(snsbuf[12], snsbuf[13], rqsbuf);
    718 		return (rqsbuf);
    719 	} else  if (flag == 2) {		/* Sense Key && ASC/ASCQ */
    720 		auto char localbuf[64];
    721 		asc2ascii(snsbuf[12], snsbuf[13], localbuf);
    722 		(void) sprintf(rqsbuf, "%s, %s", sense_keys[skey], localbuf);
    723 		return (rqsbuf);
    724 	} else if (flag == 3 && snsbuf[7] >= 9 && (snsbuf[15] & 0x80)) {
    725 		/*
    726 		 * SKSV Data
    727 		 */
    728 		switch (skey) {
    729 		case 0x5:			/* Illegal Request */
    730 			if (snsbuf[15] & 0x8)
    731 				(void)sprintf(rqsbuf,
    732 				    "Error in %s, Offset %d, bit %d",
    733 				    (snsbuf[15] & 0x40)? "CDB" : "Parameters",
    734 				    (snsbuf[16] & 0xff) << 8 |
    735 				    (snsbuf[17] & 0xff), snsbuf[15] & 0xf);
    736 			else
    737 				(void)sprintf(rqsbuf,
    738 				    "Error in %s, Offset %d",
    739 				    (snsbuf[15] & 0x40)? "CDB" : "Parameters",
    740 				    (snsbuf[16] & 0xff) << 8 |
    741 				    (snsbuf[17] & 0xff));
    742 			return (rqsbuf);
    743 		case 0x1:
    744 		case 0x3:
    745 		case 0x4:
    746 			(void)sprintf(rqsbuf, "Actual Retry Count: %d",
    747 			    (snsbuf[16] & 0xff) << 8 | (snsbuf[17] & 0xff));
    748 			return (rqsbuf);
    749 		case 0x2:
    750 			(void)sprintf(rqsbuf, "Progress Indicator: %d",
    751 			    (snsbuf[16] & 0xff) << 8 | (snsbuf[17] & 0xff));
    752 			return (rqsbuf);
    753 		default:
    754 			break;
    755 		}
    756 	}
    757 	return (NULL);
    758 }
    759 #endif
    760