xref: /freebsd/sys/cam/ctl/ctl_error.c (revision f02f7422801bb39f5eaab8fc383fa7b70c467ff9)
1 /*-
2  * Copyright (c) 2003-2009 Silicon Graphics International Corp.
3  * Copyright (c) 2011 Spectra Logic Corporation
4  * 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  *    without modification.
12  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
13  *    substantially similar to the "NO WARRANTY" disclaimer below
14  *    ("Disclaimer") and any redistribution must be conditioned upon
15  *    including a substantially similar Disclaimer requirement for further
16  *    binary redistribution.
17  *
18  * NO WARRANTY
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
28  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGES.
30  *
31  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_error.c#2 $
32  */
33 /*
34  * CAM Target Layer error reporting routines.
35  *
36  * Author: Ken Merry <ken@FreeBSD.org>
37  */
38 
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
41 
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/types.h>
46 #include <sys/malloc.h>
47 #include <sys/lock.h>
48 #include <sys/mutex.h>
49 #include <sys/condvar.h>
50 #include <sys/stddef.h>
51 #include <sys/ctype.h>
52 #include <sys/sysctl.h>
53 #include <machine/stdarg.h>
54 
55 #include <cam/scsi/scsi_all.h>
56 #include <cam/scsi/scsi_da.h>
57 #include <cam/ctl/ctl_io.h>
58 #include <cam/ctl/ctl.h>
59 #include <cam/ctl/ctl_frontend.h>
60 #include <cam/ctl/ctl_frontend_internal.h>
61 #include <cam/ctl/ctl_backend.h>
62 #include <cam/ctl/ctl_ioctl.h>
63 #include <cam/ctl/ctl_error.h>
64 #include <cam/ctl/ctl_ha.h>
65 #include <cam/ctl/ctl_private.h>
66 
67 void
68 ctl_set_sense_data_va(struct scsi_sense_data *sense_data, void *lunptr,
69 		      scsi_sense_data_type sense_format, int current_error,
70 		      int sense_key, int asc, int ascq, va_list ap)
71 {
72 	struct ctl_lun *lun;
73 
74 	lun = (struct ctl_lun *)lunptr;
75 
76 	/*
77 	 * Determine whether to return fixed or descriptor format sense
78 	 * data.
79 	 */
80 	if (sense_format == SSD_TYPE_NONE) {
81 		/*
82 		 * If the format isn't specified, we only return descriptor
83 		 * sense if the LUN exists and descriptor sense is turned
84 		 * on for that LUN.
85 		 */
86 		if ((lun != NULL)
87 		 && (lun->flags & CTL_LUN_SENSE_DESC))
88 			sense_format = SSD_TYPE_DESC;
89 		else
90 			sense_format = SSD_TYPE_FIXED;
91 	}
92 
93 	scsi_set_sense_data_va(sense_data, sense_format, current_error,
94 			       sense_key, asc, ascq, ap);
95 }
96 
97 void
98 ctl_set_sense_data(struct scsi_sense_data *sense_data, void *lunptr,
99 		   scsi_sense_data_type sense_format, int current_error,
100 		   int sense_key, int asc, int ascq, ...)
101 {
102 	va_list ap;
103 
104 	va_start(ap, ascq);
105 	ctl_set_sense_data_va(sense_data, lunptr, sense_format, current_error,
106 			      sense_key, asc, ascq, ap);
107 	va_end(ap);
108 }
109 
110 void
111 ctl_set_sense(struct ctl_scsiio *ctsio, int current_error, int sense_key,
112 	      int asc, int ascq, ...)
113 {
114 	va_list ap;
115 	struct ctl_lun *lun;
116 
117 	/*
118 	 * The LUN can't go away until all of the commands have been
119 	 * completed.  Therefore we can safely access the LUN structure and
120 	 * flags without the lock.
121 	 */
122 	lun = (struct ctl_lun *)ctsio->io_hdr.ctl_private[CTL_PRIV_LUN].ptr;
123 
124 	va_start(ap, ascq);
125 	ctl_set_sense_data_va(&ctsio->sense_data,
126 			      lun,
127 			      SSD_TYPE_NONE,
128 			      current_error,
129 			      sense_key,
130 			      asc,
131 			      ascq,
132 			      ap);
133 	va_end(ap);
134 
135 	ctsio->scsi_status = SCSI_STATUS_CHECK_COND;
136 	ctsio->sense_len = SSD_FULL_SIZE;
137 	ctsio->io_hdr.status = CTL_SCSI_ERROR | CTL_AUTOSENSE;
138 }
139 
140 /*
141  * Transform fixed sense data into descriptor sense data.
142  *
143  * For simplicity's sake, we assume that both sense structures are
144  * SSD_FULL_SIZE.  Otherwise, the logic gets more complicated.
145  */
146 void
147 ctl_sense_to_desc(struct scsi_sense_data_fixed *sense_src,
148 		  struct scsi_sense_data_desc *sense_dest)
149 {
150 	struct scsi_sense_stream stream_sense;
151 	int current_error;
152 	uint8_t stream_bits;
153 
154 	bzero(sense_dest, sizeof(*sense_dest));
155 
156 	if ((sense_src->error_code & SSD_ERRCODE) == SSD_DEFERRED_ERROR)
157 		current_error = 0;
158 	else
159 		current_error = 1;
160 
161 	bzero(&stream_sense, sizeof(stream_sense));
162 
163 	/*
164 	 * Check to see whether any of the tape-specific bits are set.  If
165 	 * so, we'll need a stream sense descriptor.
166 	 */
167 	if (sense_src->flags & (SSD_ILI|SSD_EOM|SSD_FILEMARK))
168 		stream_bits = sense_src->flags & ~SSD_KEY;
169 	else
170 		stream_bits = 0;
171 
172 	/*
173 	 * Utilize our sense setting routine to do the transform.  If a
174 	 * value is set in the fixed sense data, set it in the descriptor
175 	 * data.  Otherwise, skip it.
176 	 */
177 	ctl_set_sense_data((struct scsi_sense_data *)sense_dest,
178 			   /*lun*/ NULL,
179 			   /*sense_format*/ SSD_TYPE_DESC,
180 			   current_error,
181 			   /*sense_key*/ sense_src->flags & SSD_KEY,
182 			   /*asc*/ sense_src->add_sense_code,
183 			   /*ascq*/ sense_src->add_sense_code_qual,
184 
185 			   /* Information Bytes */
186 			   (scsi_4btoul(sense_src->info) != 0) ?
187 			   SSD_ELEM_INFO : SSD_ELEM_SKIP,
188 			   sizeof(sense_src->info),
189 			   sense_src->info,
190 
191 			   /* Command specific bytes */
192 			   (scsi_4btoul(sense_src->cmd_spec_info) != 0) ?
193 			   SSD_ELEM_COMMAND : SSD_ELEM_SKIP,
194 			   sizeof(sense_src->cmd_spec_info),
195 			   sense_src->cmd_spec_info,
196 
197 			   /* FRU */
198 			   (sense_src->fru != 0) ?
199 			   SSD_ELEM_FRU : SSD_ELEM_SKIP,
200 			   sizeof(sense_src->fru),
201 			   &sense_src->fru,
202 
203 			   /* Sense Key Specific */
204 			   (sense_src->sense_key_spec[0] & SSD_SCS_VALID) ?
205 			   SSD_ELEM_SKS : SSD_ELEM_SKIP,
206 			   sizeof(sense_src->sense_key_spec),
207 			   sense_src->sense_key_spec,
208 
209 			   /* Tape bits */
210 			   (stream_bits != 0) ?
211 			   SSD_ELEM_STREAM : SSD_ELEM_SKIP,
212 			   sizeof(stream_bits),
213 			   &stream_bits,
214 
215 			   SSD_ELEM_NONE);
216 }
217 
218 /*
219  * Transform descriptor format sense data into fixed sense data.
220  *
221  * Some data may be lost in translation, because there are descriptors
222  * thant can't be represented as fixed sense data.
223  *
224  * For simplicity's sake, we assume that both sense structures are
225  * SSD_FULL_SIZE.  Otherwise, the logic gets more complicated.
226  */
227 void
228 ctl_sense_to_fixed(struct scsi_sense_data_desc *sense_src,
229 		   struct scsi_sense_data_fixed *sense_dest)
230 {
231 	int current_error;
232 	uint8_t *info_ptr = NULL, *cmd_ptr = NULL, *fru_ptr = NULL;
233 	uint8_t *sks_ptr = NULL, *stream_ptr = NULL;
234 	int info_size = 0, cmd_size = 0, fru_size = 0;
235 	int sks_size = 0, stream_size = 0;
236 	int pos;
237 
238 	if ((sense_src->error_code & SSD_ERRCODE) == SSD_DESC_CURRENT_ERROR)
239 		current_error = 1;
240 	else
241 		current_error = 0;
242 
243 	for (pos = 0; pos < (int)(sense_src->extra_len - 1);) {
244 		struct scsi_sense_desc_header *header;
245 
246 		header = (struct scsi_sense_desc_header *)
247 		    &sense_src->sense_desc[pos];
248 
249 		/*
250 		 * See if this record goes past the end of the sense data.
251 		 * It shouldn't, but check just in case.
252 		 */
253 		if ((pos + header->length + sizeof(*header)) >
254 		     sense_src->extra_len)
255 			break;
256 
257 		switch (sense_src->sense_desc[pos]) {
258 		case SSD_DESC_INFO: {
259 			struct scsi_sense_info *info;
260 
261 			info = (struct scsi_sense_info *)header;
262 
263 			info_ptr = info->info;
264 			info_size = sizeof(info->info);
265 
266 			pos += info->length +
267 			    sizeof(struct scsi_sense_desc_header);
268 			break;
269 		}
270 		case SSD_DESC_COMMAND: {
271 			struct scsi_sense_command *cmd;
272 
273 			cmd = (struct scsi_sense_command *)header;
274 			cmd_ptr = cmd->command_info;
275 			cmd_size = sizeof(cmd->command_info);
276 
277 			pos += cmd->length +
278 			    sizeof(struct scsi_sense_desc_header);
279 			break;
280 		}
281 		case SSD_DESC_FRU: {
282 			struct scsi_sense_fru *fru;
283 
284 			fru = (struct scsi_sense_fru *)header;
285 			fru_ptr = &fru->fru;
286 			fru_size = sizeof(fru->fru);
287 			pos += fru->length +
288 			    sizeof(struct scsi_sense_desc_header);
289 			break;
290 		}
291 		case SSD_DESC_SKS: {
292 			struct scsi_sense_sks *sks;
293 
294 			sks = (struct scsi_sense_sks *)header;
295 			sks_ptr = sks->sense_key_spec;
296 			sks_size = sizeof(sks->sense_key_spec);
297 
298 			pos = sks->length +
299 			    sizeof(struct scsi_sense_desc_header);
300 			break;
301 		}
302 		case SSD_DESC_STREAM: {
303 			struct scsi_sense_stream *stream_sense;
304 
305 			stream_sense = (struct scsi_sense_stream *)header;
306 			stream_ptr = &stream_sense->byte3;
307 			stream_size = sizeof(stream_sense->byte3);
308 			pos = stream_sense->length +
309 			    sizeof(struct scsi_sense_desc_header);
310 			break;
311 		}
312 		default:
313 			/*
314 			 * We don't recognize this particular sense
315 			 * descriptor type, so just skip it.
316 			 */
317 			pos += sizeof(*header) + header->length;
318 			break;
319 		}
320 	}
321 
322 	ctl_set_sense_data((struct scsi_sense_data *)sense_dest,
323 			   /*lun*/ NULL,
324 			   /*sense_format*/ SSD_TYPE_FIXED,
325 			   current_error,
326 			   /*sense_key*/ sense_src->sense_key & SSD_KEY,
327 			   /*asc*/ sense_src->add_sense_code,
328 			   /*ascq*/ sense_src->add_sense_code_qual,
329 
330 			   /* Information Bytes */
331 			   (info_ptr != NULL) ? SSD_ELEM_INFO : SSD_ELEM_SKIP,
332 			   info_size,
333 			   info_ptr,
334 
335 			   /* Command specific bytes */
336 			   (cmd_ptr != NULL) ? SSD_ELEM_COMMAND : SSD_ELEM_SKIP,
337 			   cmd_size,
338 			   cmd_ptr,
339 
340 			   /* FRU */
341 			   (fru_ptr != NULL) ? SSD_ELEM_FRU : SSD_ELEM_SKIP,
342 			   fru_size,
343 			   fru_ptr,
344 
345 			   /* Sense Key Specific */
346 			   (sks_ptr != NULL) ? SSD_ELEM_SKS : SSD_ELEM_SKIP,
347 			   sks_size,
348 			   sks_ptr,
349 
350 			   /* Tape bits */
351 			   (stream_ptr != NULL) ? SSD_ELEM_STREAM : SSD_ELEM_SKIP,
352 			   stream_size,
353 			   stream_ptr,
354 
355 			   SSD_ELEM_NONE);
356 }
357 
358 void
359 ctl_set_ua(struct ctl_scsiio *ctsio, int asc, int ascq)
360 {
361 	ctl_set_sense(ctsio,
362 		      /*current_error*/ 1,
363 		      /*sense_key*/ SSD_KEY_UNIT_ATTENTION,
364 		      asc,
365 		      ascq,
366 		      SSD_ELEM_NONE);
367 }
368 
369 ctl_ua_type
370 ctl_build_ua(ctl_ua_type ua_type, struct scsi_sense_data *sense,
371 	     scsi_sense_data_type sense_format)
372 {
373 	ctl_ua_type ua_to_build;
374 	int i, asc, ascq;
375 
376 	if (ua_type == CTL_UA_NONE)
377 		return (ua_type);
378 
379 	ua_to_build = CTL_UA_NONE;
380 
381 	for (i = 0; i < (sizeof(ua_type) * 8); i++) {
382 		if (ua_type & (1 << i)) {
383 			ua_to_build = 1 << i;
384 			break;
385 		}
386 	}
387 
388 	switch (ua_to_build) {
389 	case CTL_UA_POWERON:
390 		/* 29h/01h  POWER ON OCCURRED */
391 		asc = 0x29;
392 		ascq = 0x01;
393 		break;
394 	case CTL_UA_BUS_RESET:
395 		/* 29h/02h  SCSI BUS RESET OCCURRED */
396 		asc = 0x29;
397 		ascq = 0x02;
398 		break;
399 	case CTL_UA_TARG_RESET:
400 		/* 29h/03h  BUS DEVICE RESET FUNCTION OCCURRED*/
401 		asc = 0x29;
402 		ascq = 0x03;
403 		break;
404 	case CTL_UA_I_T_NEXUS_LOSS:
405 		/* 29h/07h  I_T NEXUS LOSS OCCURRED */
406 		asc = 0x29;
407 		ascq = 0x07;
408 		break;
409 	case CTL_UA_LUN_RESET:
410 		/* 29h/00h  POWER ON, RESET, OR BUS DEVICE RESET OCCURRED */
411 		/*
412 		 * Since we don't have a specific ASC/ASCQ pair for a LUN
413 		 * reset, just return the generic reset code.
414 		 */
415 		asc = 0x29;
416 		ascq = 0x00;
417 		break;
418 	case CTL_UA_LUN_CHANGE:
419 		/* 3Fh/0Eh  REPORTED LUNS DATA HAS CHANGED */
420 		asc = 0x3F;
421 		ascq = 0x0E;
422 		break;
423 	case CTL_UA_MODE_CHANGE:
424 		/* 2Ah/01h  MODE PARAMETERS CHANGED */
425 		asc = 0x2A;
426 		ascq = 0x01;
427 		break;
428 	case CTL_UA_LOG_CHANGE:
429 		/* 2Ah/02h  LOG PARAMETERS CHANGED */
430 		asc = 0x2A;
431 		ascq = 0x02;
432 		break;
433 	case CTL_UA_LVD:
434 		/* 29h/06h  TRANSCEIVER MODE CHANGED TO LVD */
435 		asc = 0x29;
436 		ascq = 0x06;
437 		break;
438 	case CTL_UA_SE:
439 		/* 29h/05h  TRANSCEIVER MODE CHANGED TO SINGLE-ENDED */
440 		asc = 0x29;
441 		ascq = 0x05;
442 		break;
443 	case CTL_UA_RES_PREEMPT:
444 		/* 2Ah/03h  RESERVATIONS PREEMPTED */
445 		asc = 0x2A;
446 		ascq = 0x03;
447 		break;
448 	case CTL_UA_RES_RELEASE:
449 		/* 2Ah/04h  RESERVATIONS RELEASED */
450 		asc = 0x2A;
451 		ascq = 0x04;
452 		break;
453 	case CTL_UA_REG_PREEMPT:
454 		/* 2Ah/05h  REGISTRATIONS PREEMPTED */
455 		asc = 0x2A;
456 		ascq = 0x05;
457 		break;
458 	case CTL_UA_ASYM_ACC_CHANGE:
459 	        /* 2Ah/06n  ASYMMETRIC ACCESS STATE CHANGED */
460 		asc = 0x2A;
461 		ascq = 0x06;
462 		break;
463 	case CTL_UA_CAPACITY_CHANGED:
464 	        /* 2Ah/09n  CAPACITY DATA HAS CHANGED */
465 		asc = 0x2A;
466 		ascq = 0x09;
467 		break;
468 	default:
469 		ua_to_build = CTL_UA_NONE;
470 		return (ua_to_build);
471 		break; /* NOTREACHED */
472 	}
473 
474 	ctl_set_sense_data(sense,
475 			   /*lun*/ NULL,
476 			   sense_format,
477 			   /*current_error*/ 1,
478 			   /*sense_key*/ SSD_KEY_UNIT_ATTENTION,
479 			   asc,
480 			   ascq,
481 			   SSD_ELEM_NONE);
482 
483 	return (ua_to_build);
484 }
485 
486 void
487 ctl_set_overlapped_cmd(struct ctl_scsiio *ctsio)
488 {
489 	/* OVERLAPPED COMMANDS ATTEMPTED */
490 	ctl_set_sense(ctsio,
491 		      /*current_error*/ 1,
492 		      /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
493 		      /*asc*/ 0x4E,
494 		      /*ascq*/ 0x00,
495 		      SSD_ELEM_NONE);
496 }
497 
498 void
499 ctl_set_overlapped_tag(struct ctl_scsiio *ctsio, uint8_t tag)
500 {
501 	/* TAGGED OVERLAPPED COMMANDS (NN = QUEUE TAG) */
502 	ctl_set_sense(ctsio,
503 		      /*current_error*/ 1,
504 		      /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
505 		      /*asc*/ 0x4D,
506 		      /*ascq*/ tag,
507 		      SSD_ELEM_NONE);
508 }
509 
510 /*
511  * Tell the user that there was a problem with the command or data he sent.
512  */
513 void
514 ctl_set_invalid_field(struct ctl_scsiio *ctsio, int sks_valid, int command,
515 		      int field, int bit_valid, int bit)
516 {
517 	uint8_t sks[3];
518 	int asc;
519 
520 	if (command != 0) {
521 		/* "Invalid field in CDB" */
522 		asc = 0x24;
523 	} else {
524 		/* "Invalid field in parameter list" */
525 		asc = 0x26;
526 	}
527 
528 	if (sks_valid) {
529 		sks[0] = SSD_SCS_VALID;
530 		if (command)
531 			sks[0] |= SSD_FIELDPTR_CMD;
532 		scsi_ulto2b(field, &sks[1]);
533 
534 		if (bit_valid)
535 			sks[0] |= SSD_BITPTR_VALID | bit;
536 	}
537 
538 	ctl_set_sense(ctsio,
539 		      /*current_error*/ 1,
540 		      /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
541 		      asc,
542 		      /*ascq*/ 0x00,
543 		      /*type*/ (sks_valid != 0) ? SSD_ELEM_SKS : SSD_ELEM_SKIP,
544 		      /*size*/ sizeof(sks),
545 		      /*data*/ sks,
546 		      SSD_ELEM_NONE);
547 }
548 
549 void
550 ctl_set_invalid_opcode(struct ctl_scsiio *ctsio)
551 {
552 	struct scsi_sense_data *sense;
553 	uint8_t sks[3];
554 
555 	sense = &ctsio->sense_data;
556 
557 	sks[0] = SSD_SCS_VALID | SSD_FIELDPTR_CMD;
558 	scsi_ulto2b(0, &sks[1]);
559 
560 	/* "Invalid command operation code" */
561 	ctl_set_sense(ctsio,
562 		      /*current_error*/ 1,
563 		      /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
564 		      /*asc*/ 0x20,
565 		      /*ascq*/ 0x00,
566 		      /*type*/ SSD_ELEM_SKS,
567 		      /*size*/ sizeof(sks),
568 		      /*data*/ sks,
569 		      SSD_ELEM_NONE);
570 }
571 
572 void
573 ctl_set_param_len_error(struct ctl_scsiio *ctsio)
574 {
575 	/* "Parameter list length error" */
576 	ctl_set_sense(ctsio,
577 		      /*current_error*/ 1,
578 		      /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
579 		      /*asc*/ 0x1a,
580 		      /*ascq*/ 0x00,
581 		      SSD_ELEM_NONE);
582 }
583 
584 void
585 ctl_set_already_locked(struct ctl_scsiio *ctsio)
586 {
587 	/* Vendor unique "Somebody already is locked" */
588 	ctl_set_sense(ctsio,
589 		      /*current_error*/ 1,
590 		      /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
591 		      /*asc*/ 0x81,
592 		      /*ascq*/ 0x00,
593 		      SSD_ELEM_NONE);
594 }
595 
596 void
597 ctl_set_unsupported_lun(struct ctl_scsiio *ctsio)
598 {
599 	/* "Logical unit not supported" */
600 	ctl_set_sense(ctsio,
601 		      /*current_error*/ 1,
602 		      /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
603 		      /*asc*/ 0x25,
604 		      /*ascq*/ 0x00,
605 		      SSD_ELEM_NONE);
606 }
607 
608 void
609 ctl_set_internal_failure(struct ctl_scsiio *ctsio, int sks_valid,
610 			 uint16_t retry_count)
611 {
612 	uint8_t sks[3];
613 
614 	if (sks_valid) {
615 		sks[0] = SSD_SCS_VALID;
616 		sks[1] = (retry_count >> 8) & 0xff;
617 		sks[2] = retry_count & 0xff;
618 	}
619 
620 	/* "Internal target failure" */
621 	ctl_set_sense(ctsio,
622 		      /*current_error*/ 1,
623 		      /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
624 		      /*asc*/ 0x44,
625 		      /*ascq*/ 0x00,
626 		      /*type*/ (sks_valid != 0) ? SSD_ELEM_SKS : SSD_ELEM_SKIP,
627 		      /*size*/ sizeof(sks),
628 		      /*data*/ sks,
629 		      SSD_ELEM_NONE);
630 }
631 
632 void
633 ctl_set_medium_error(struct ctl_scsiio *ctsio)
634 {
635 	if ((ctsio->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) {
636 		/* "Unrecovered read error" */
637 		ctl_set_sense(ctsio,
638 			      /*current_error*/ 1,
639 			      /*sense_key*/ SSD_KEY_MEDIUM_ERROR,
640 			      /*asc*/ 0x11,
641 			      /*ascq*/ 0x00,
642 			      SSD_ELEM_NONE);
643 	} else {
644 		/* "Write error - auto reallocation failed" */
645 		ctl_set_sense(ctsio,
646 			      /*current_error*/ 1,
647 			      /*sense_key*/ SSD_KEY_MEDIUM_ERROR,
648 			      /*asc*/ 0x0C,
649 			      /*ascq*/ 0x02,
650 			      SSD_ELEM_NONE);
651 	}
652 }
653 
654 void
655 ctl_set_aborted(struct ctl_scsiio *ctsio)
656 {
657 	ctl_set_sense(ctsio,
658 		      /*current_error*/ 1,
659 		      /*sense_key*/ SSD_KEY_ABORTED_COMMAND,
660 		      /*asc*/ 0x45,
661 		      /*ascq*/ 0x00,
662 		      SSD_ELEM_NONE);
663 }
664 
665 void
666 ctl_set_lba_out_of_range(struct ctl_scsiio *ctsio)
667 {
668 	/* "Logical block address out of range" */
669 	ctl_set_sense(ctsio,
670 		      /*current_error*/ 1,
671 		      /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
672 		      /*asc*/ 0x21,
673 		      /*ascq*/ 0x00,
674 		      SSD_ELEM_NONE);
675 }
676 
677 void
678 ctl_set_lun_stopped(struct ctl_scsiio *ctsio)
679 {
680 	/* "Logical unit not ready, initializing cmd. required" */
681 	ctl_set_sense(ctsio,
682 		      /*current_error*/ 1,
683 		      /*sense_key*/ SSD_KEY_NOT_READY,
684 		      /*asc*/ 0x04,
685 		      /*ascq*/ 0x02,
686 		      SSD_ELEM_NONE);
687 }
688 
689 void
690 ctl_set_lun_not_ready(struct ctl_scsiio *ctsio)
691 {
692 	/* "Logical unit not ready, manual intervention required" */
693 	ctl_set_sense(ctsio,
694 		      /*current_error*/ 1,
695 		      /*sense_key*/ SSD_KEY_NOT_READY,
696 		      /*asc*/ 0x04,
697 		      /*ascq*/ 0x05,
698 		      SSD_ELEM_NONE);
699 }
700 
701 void
702 ctl_set_illegal_pr_release(struct ctl_scsiio *ctsio)
703 {
704 	/* "Invalid release of persistent reservation" */
705 	ctl_set_sense(ctsio,
706 		      /*current_error*/ 1,
707 		      /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
708 		      /*asc*/ 0x26,
709 		      /*ascq*/ 0x04,
710 		      SSD_ELEM_NONE);
711 }
712 
713 void
714 ctl_set_lun_standby(struct ctl_scsiio *ctsio)
715 {
716 	/* "Logical unit not ready, target port in standby state" */
717 	ctl_set_sense(ctsio,
718 		      /*current_error*/ 1,
719 		      /*sense_key*/ SSD_KEY_NOT_READY,
720 		      /*asc*/ 0x04,
721 		      /*ascq*/ 0x0b,
722 		      SSD_ELEM_NONE);
723 }
724 
725 void
726 ctl_set_medium_format_corrupted(struct ctl_scsiio *ctsio)
727 {
728 	/* "Medium format corrupted" */
729 	ctl_set_sense(ctsio,
730 		      /*current_error*/ 1,
731 		      /*sense_key*/ SSD_KEY_MEDIUM_ERROR,
732 		      /*asc*/ 0x31,
733 		      /*ascq*/ 0x00,
734 		      SSD_ELEM_NONE);
735 }
736 
737 void
738 ctl_set_medium_magazine_inaccessible(struct ctl_scsiio *ctsio)
739 {
740 	/* "Medium magazine not accessible" */
741 	ctl_set_sense(ctsio,
742 		      /*current_error*/ 1,
743 		      /*sense_key*/ SSD_KEY_NOT_READY,
744 		      /*asc*/ 0x3b,
745 		      /*ascq*/ 0x11,
746 		      SSD_ELEM_NONE);
747 }
748 
749 void
750 ctl_set_data_phase_error(struct ctl_scsiio *ctsio)
751 {
752 	/* "Data phase error" */
753 	ctl_set_sense(ctsio,
754 		      /*current_error*/ 1,
755 		      /*sense_key*/ SSD_KEY_NOT_READY,
756 		      /*asc*/ 0x4b,
757 		      /*ascq*/ 0x00,
758 		      SSD_ELEM_NONE);
759 }
760 
761 void
762 ctl_set_reservation_conflict(struct ctl_scsiio *ctsio)
763 {
764 	struct scsi_sense_data *sense;
765 
766 	sense = &ctsio->sense_data;
767 	memset(sense, 0, sizeof(*sense));
768 	ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
769 	ctsio->sense_len = 0;
770 	ctsio->io_hdr.status = CTL_SCSI_ERROR;
771 }
772 
773 void
774 ctl_set_queue_full(struct ctl_scsiio *ctsio)
775 {
776 	struct scsi_sense_data *sense;
777 
778 	sense = &ctsio->sense_data;
779 	memset(sense, 0, sizeof(*sense));
780 	ctsio->scsi_status = SCSI_STATUS_QUEUE_FULL;
781 	ctsio->sense_len = 0;
782 	ctsio->io_hdr.status = CTL_SCSI_ERROR;
783 }
784 
785 void
786 ctl_set_busy(struct ctl_scsiio *ctsio)
787 {
788 	struct scsi_sense_data *sense;
789 
790 	sense = &ctsio->sense_data;
791 	memset(sense, 0, sizeof(*sense));
792 	ctsio->scsi_status = SCSI_STATUS_BUSY;
793 	ctsio->sense_len = 0;
794 	ctsio->io_hdr.status = CTL_SCSI_ERROR;
795 }
796 
797 void
798 ctl_set_task_aborted(struct ctl_scsiio *ctsio)
799 {
800 	struct scsi_sense_data *sense;
801 
802 	sense = &ctsio->sense_data;
803 	memset(sense, 0, sizeof(*sense));
804 	ctsio->scsi_status = SCSI_STATUS_TASK_ABORTED;
805 	ctsio->sense_len = 0;
806 	ctsio->io_hdr.status = CTL_CMD_ABORTED;
807 }
808 
809 void
810 ctl_set_success(struct ctl_scsiio *ctsio)
811 {
812 	struct scsi_sense_data *sense;
813 
814 	sense = &ctsio->sense_data;
815 	memset(sense, 0, sizeof(*sense));
816 	ctsio->scsi_status = SCSI_STATUS_OK;
817 	ctsio->sense_len = 0;
818 	ctsio->io_hdr.status = CTL_SUCCESS;
819 }
820