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