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
ctl_set_sense_data_va(struct scsi_sense_data * sense_data,void * lunptr,scsi_sense_data_type sense_format,int current_error,int sense_key,int asc,int ascq,va_list ap)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
ctl_set_sense_data(struct scsi_sense_data * sense_data,void * lunptr,scsi_sense_data_type sense_format,int current_error,int sense_key,int asc,int ascq,...)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
ctl_set_sense(struct ctl_scsiio * ctsio,int current_error,int sense_key,int asc,int ascq,...)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
ctl_sense_to_desc(struct scsi_sense_data_fixed * sense_src,struct scsi_sense_data_desc * sense_dest)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
ctl_sense_to_fixed(struct scsi_sense_data_desc * sense_src,struct scsi_sense_data_fixed * sense_dest)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
ctl_set_ua(struct ctl_scsiio * ctsio,int asc,int ascq)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
ctl_build_ua(struct ctl_lun * lun,uint32_t initidx,struct scsi_sense_data * sense,scsi_sense_data_type sense_format)370 ctl_build_ua(struct ctl_lun *lun, uint32_t initidx,
371 struct scsi_sense_data *sense, scsi_sense_data_type sense_format)
372 {
373 ctl_ua_type *ua;
374 ctl_ua_type ua_to_build, ua_to_clear;
375 int asc, ascq;
376 uint32_t p, i;
377
378 mtx_assert(&lun->lun_lock, MA_OWNED);
379 p = initidx / CTL_MAX_INIT_PER_PORT;
380 if ((ua = lun->pending_ua[p]) == NULL) {
381 mtx_unlock(&lun->lun_lock);
382 ua = malloc(sizeof(ctl_ua_type) * CTL_MAX_INIT_PER_PORT,
383 M_CTL, M_WAITOK);
384 mtx_lock(&lun->lun_lock);
385 if (lun->pending_ua[p] == NULL) {
386 lun->pending_ua[p] = ua;
387 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++)
388 ua[i] = CTL_UA_POWERON;
389 } else {
390 free(ua, M_CTL);
391 ua = lun->pending_ua[p];
392 }
393 }
394 i = initidx % CTL_MAX_INIT_PER_PORT;
395 if (ua[i] == CTL_UA_NONE)
396 return (CTL_UA_NONE);
397
398 ua_to_build = (1 << (ffs(ua[i]) - 1));
399 ua_to_clear = ua_to_build;
400
401 switch (ua_to_build) {
402 case CTL_UA_POWERON:
403 /* 29h/01h POWER ON OCCURRED */
404 asc = 0x29;
405 ascq = 0x01;
406 ua_to_clear = ~0;
407 break;
408 case CTL_UA_BUS_RESET:
409 /* 29h/02h SCSI BUS RESET OCCURRED */
410 asc = 0x29;
411 ascq = 0x02;
412 ua_to_clear = ~0;
413 break;
414 case CTL_UA_TARG_RESET:
415 /* 29h/03h BUS DEVICE RESET FUNCTION OCCURRED*/
416 asc = 0x29;
417 ascq = 0x03;
418 ua_to_clear = ~0;
419 break;
420 case CTL_UA_I_T_NEXUS_LOSS:
421 /* 29h/07h I_T NEXUS LOSS OCCURRED */
422 asc = 0x29;
423 ascq = 0x07;
424 ua_to_clear = ~0;
425 break;
426 case CTL_UA_LUN_RESET:
427 /* 29h/00h POWER ON, RESET, OR BUS DEVICE RESET OCCURRED */
428 /*
429 * Since we don't have a specific ASC/ASCQ pair for a LUN
430 * reset, just return the generic reset code.
431 */
432 asc = 0x29;
433 ascq = 0x00;
434 break;
435 case CTL_UA_LUN_CHANGE:
436 /* 3Fh/0Eh REPORTED LUNS DATA HAS CHANGED */
437 asc = 0x3F;
438 ascq = 0x0E;
439 break;
440 case CTL_UA_MODE_CHANGE:
441 /* 2Ah/01h MODE PARAMETERS CHANGED */
442 asc = 0x2A;
443 ascq = 0x01;
444 break;
445 case CTL_UA_LOG_CHANGE:
446 /* 2Ah/02h LOG PARAMETERS CHANGED */
447 asc = 0x2A;
448 ascq = 0x02;
449 break;
450 case CTL_UA_LVD:
451 /* 29h/06h TRANSCEIVER MODE CHANGED TO LVD */
452 asc = 0x29;
453 ascq = 0x06;
454 break;
455 case CTL_UA_SE:
456 /* 29h/05h TRANSCEIVER MODE CHANGED TO SINGLE-ENDED */
457 asc = 0x29;
458 ascq = 0x05;
459 break;
460 case CTL_UA_RES_PREEMPT:
461 /* 2Ah/03h RESERVATIONS PREEMPTED */
462 asc = 0x2A;
463 ascq = 0x03;
464 break;
465 case CTL_UA_RES_RELEASE:
466 /* 2Ah/04h RESERVATIONS RELEASED */
467 asc = 0x2A;
468 ascq = 0x04;
469 break;
470 case CTL_UA_REG_PREEMPT:
471 /* 2Ah/05h REGISTRATIONS PREEMPTED */
472 asc = 0x2A;
473 ascq = 0x05;
474 break;
475 case CTL_UA_ASYM_ACC_CHANGE:
476 /* 2Ah/06n ASYMMETRIC ACCESS STATE CHANGED */
477 asc = 0x2A;
478 ascq = 0x06;
479 break;
480 case CTL_UA_CAPACITY_CHANGED:
481 /* 2Ah/09n CAPACITY DATA HAS CHANGED */
482 asc = 0x2A;
483 ascq = 0x09;
484 break;
485 case CTL_UA_THIN_PROV_THRES:
486 /* 38h/07n THIN PROVISIONING SOFT THRESHOLD REACHED */
487 asc = 0x38;
488 ascq = 0x07;
489 break;
490 default:
491 panic("ctl_build_ua: Unknown UA %x", ua_to_build);
492 }
493
494 ctl_set_sense_data(sense,
495 /*lun*/ NULL,
496 sense_format,
497 /*current_error*/ 1,
498 /*sense_key*/ SSD_KEY_UNIT_ATTENTION,
499 asc,
500 ascq,
501 SSD_ELEM_NONE);
502
503 /* We're reporting this UA, so clear it */
504 ua[i] &= ~ua_to_clear;
505
506 return (ua_to_build);
507 }
508
509 void
ctl_set_overlapped_cmd(struct ctl_scsiio * ctsio)510 ctl_set_overlapped_cmd(struct ctl_scsiio *ctsio)
511 {
512 /* OVERLAPPED COMMANDS ATTEMPTED */
513 ctl_set_sense(ctsio,
514 /*current_error*/ 1,
515 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
516 /*asc*/ 0x4E,
517 /*ascq*/ 0x00,
518 SSD_ELEM_NONE);
519 }
520
521 void
ctl_set_overlapped_tag(struct ctl_scsiio * ctsio,uint8_t tag)522 ctl_set_overlapped_tag(struct ctl_scsiio *ctsio, uint8_t tag)
523 {
524 /* TAGGED OVERLAPPED COMMANDS (NN = QUEUE TAG) */
525 ctl_set_sense(ctsio,
526 /*current_error*/ 1,
527 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
528 /*asc*/ 0x4D,
529 /*ascq*/ tag,
530 SSD_ELEM_NONE);
531 }
532
533 /*
534 * Tell the user that there was a problem with the command or data he sent.
535 */
536 void
ctl_set_invalid_field(struct ctl_scsiio * ctsio,int sks_valid,int command,int field,int bit_valid,int bit)537 ctl_set_invalid_field(struct ctl_scsiio *ctsio, int sks_valid, int command,
538 int field, int bit_valid, int bit)
539 {
540 uint8_t sks[3];
541 int asc;
542
543 if (command != 0) {
544 /* "Invalid field in CDB" */
545 asc = 0x24;
546 } else {
547 /* "Invalid field in parameter list" */
548 asc = 0x26;
549 }
550
551 if (sks_valid) {
552 sks[0] = SSD_SCS_VALID;
553 if (command)
554 sks[0] |= SSD_FIELDPTR_CMD;
555 scsi_ulto2b(field, &sks[1]);
556
557 if (bit_valid)
558 sks[0] |= SSD_BITPTR_VALID | bit;
559 }
560
561 ctl_set_sense(ctsio,
562 /*current_error*/ 1,
563 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
564 asc,
565 /*ascq*/ 0x00,
566 /*type*/ (sks_valid != 0) ? SSD_ELEM_SKS : SSD_ELEM_SKIP,
567 /*size*/ sizeof(sks),
568 /*data*/ sks,
569 SSD_ELEM_NONE);
570 }
571
572 void
ctl_set_invalid_opcode(struct ctl_scsiio * ctsio)573 ctl_set_invalid_opcode(struct ctl_scsiio *ctsio)
574 {
575 struct scsi_sense_data *sense;
576 uint8_t sks[3];
577
578 sense = &ctsio->sense_data;
579
580 sks[0] = SSD_SCS_VALID | SSD_FIELDPTR_CMD;
581 scsi_ulto2b(0, &sks[1]);
582
583 /* "Invalid command operation code" */
584 ctl_set_sense(ctsio,
585 /*current_error*/ 1,
586 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
587 /*asc*/ 0x20,
588 /*ascq*/ 0x00,
589 /*type*/ SSD_ELEM_SKS,
590 /*size*/ sizeof(sks),
591 /*data*/ sks,
592 SSD_ELEM_NONE);
593 }
594
595 void
ctl_set_param_len_error(struct ctl_scsiio * ctsio)596 ctl_set_param_len_error(struct ctl_scsiio *ctsio)
597 {
598 /* "Parameter list length error" */
599 ctl_set_sense(ctsio,
600 /*current_error*/ 1,
601 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
602 /*asc*/ 0x1a,
603 /*ascq*/ 0x00,
604 SSD_ELEM_NONE);
605 }
606
607 void
ctl_set_already_locked(struct ctl_scsiio * ctsio)608 ctl_set_already_locked(struct ctl_scsiio *ctsio)
609 {
610 /* Vendor unique "Somebody already is locked" */
611 ctl_set_sense(ctsio,
612 /*current_error*/ 1,
613 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
614 /*asc*/ 0x81,
615 /*ascq*/ 0x00,
616 SSD_ELEM_NONE);
617 }
618
619 void
ctl_set_unsupported_lun(struct ctl_scsiio * ctsio)620 ctl_set_unsupported_lun(struct ctl_scsiio *ctsio)
621 {
622 /* "Logical unit not supported" */
623 ctl_set_sense(ctsio,
624 /*current_error*/ 1,
625 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
626 /*asc*/ 0x25,
627 /*ascq*/ 0x00,
628 SSD_ELEM_NONE);
629 }
630
631 void
ctl_set_internal_failure(struct ctl_scsiio * ctsio,int sks_valid,uint16_t retry_count)632 ctl_set_internal_failure(struct ctl_scsiio *ctsio, int sks_valid,
633 uint16_t retry_count)
634 {
635 uint8_t sks[3];
636
637 if (sks_valid) {
638 sks[0] = SSD_SCS_VALID;
639 sks[1] = (retry_count >> 8) & 0xff;
640 sks[2] = retry_count & 0xff;
641 }
642
643 /* "Internal target failure" */
644 ctl_set_sense(ctsio,
645 /*current_error*/ 1,
646 /*sense_key*/ SSD_KEY_HARDWARE_ERROR,
647 /*asc*/ 0x44,
648 /*ascq*/ 0x00,
649 /*type*/ (sks_valid != 0) ? SSD_ELEM_SKS : SSD_ELEM_SKIP,
650 /*size*/ sizeof(sks),
651 /*data*/ sks,
652 SSD_ELEM_NONE);
653 }
654
655 void
ctl_set_medium_error(struct ctl_scsiio * ctsio)656 ctl_set_medium_error(struct ctl_scsiio *ctsio)
657 {
658 if ((ctsio->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) {
659 /* "Unrecovered read error" */
660 ctl_set_sense(ctsio,
661 /*current_error*/ 1,
662 /*sense_key*/ SSD_KEY_MEDIUM_ERROR,
663 /*asc*/ 0x11,
664 /*ascq*/ 0x00,
665 SSD_ELEM_NONE);
666 } else {
667 /* "Write error - auto reallocation failed" */
668 ctl_set_sense(ctsio,
669 /*current_error*/ 1,
670 /*sense_key*/ SSD_KEY_MEDIUM_ERROR,
671 /*asc*/ 0x0C,
672 /*ascq*/ 0x02,
673 SSD_ELEM_NONE);
674 }
675 }
676
677 void
ctl_set_aborted(struct ctl_scsiio * ctsio)678 ctl_set_aborted(struct ctl_scsiio *ctsio)
679 {
680 ctl_set_sense(ctsio,
681 /*current_error*/ 1,
682 /*sense_key*/ SSD_KEY_ABORTED_COMMAND,
683 /*asc*/ 0x45,
684 /*ascq*/ 0x00,
685 SSD_ELEM_NONE);
686 }
687
688 void
ctl_set_lba_out_of_range(struct ctl_scsiio * ctsio)689 ctl_set_lba_out_of_range(struct ctl_scsiio *ctsio)
690 {
691 /* "Logical block address out of range" */
692 ctl_set_sense(ctsio,
693 /*current_error*/ 1,
694 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
695 /*asc*/ 0x21,
696 /*ascq*/ 0x00,
697 SSD_ELEM_NONE);
698 }
699
700 void
ctl_set_lun_stopped(struct ctl_scsiio * ctsio)701 ctl_set_lun_stopped(struct ctl_scsiio *ctsio)
702 {
703 /* "Logical unit not ready, initializing cmd. required" */
704 ctl_set_sense(ctsio,
705 /*current_error*/ 1,
706 /*sense_key*/ SSD_KEY_NOT_READY,
707 /*asc*/ 0x04,
708 /*ascq*/ 0x02,
709 SSD_ELEM_NONE);
710 }
711
712 void
ctl_set_lun_not_ready(struct ctl_scsiio * ctsio)713 ctl_set_lun_not_ready(struct ctl_scsiio *ctsio)
714 {
715 /* "Logical unit not ready, manual intervention required" */
716 ctl_set_sense(ctsio,
717 /*current_error*/ 1,
718 /*sense_key*/ SSD_KEY_NOT_READY,
719 /*asc*/ 0x04,
720 /*ascq*/ 0x03,
721 SSD_ELEM_NONE);
722 }
723
724 void
ctl_set_illegal_pr_release(struct ctl_scsiio * ctsio)725 ctl_set_illegal_pr_release(struct ctl_scsiio *ctsio)
726 {
727 /* "Invalid release of persistent reservation" */
728 ctl_set_sense(ctsio,
729 /*current_error*/ 1,
730 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
731 /*asc*/ 0x26,
732 /*ascq*/ 0x04,
733 SSD_ELEM_NONE);
734 }
735
736 void
ctl_set_lun_standby(struct ctl_scsiio * ctsio)737 ctl_set_lun_standby(struct ctl_scsiio *ctsio)
738 {
739 /* "Logical unit not ready, target port in standby state" */
740 ctl_set_sense(ctsio,
741 /*current_error*/ 1,
742 /*sense_key*/ SSD_KEY_NOT_READY,
743 /*asc*/ 0x04,
744 /*ascq*/ 0x0b,
745 SSD_ELEM_NONE);
746 }
747
748 void
ctl_set_medium_format_corrupted(struct ctl_scsiio * ctsio)749 ctl_set_medium_format_corrupted(struct ctl_scsiio *ctsio)
750 {
751 /* "Medium format corrupted" */
752 ctl_set_sense(ctsio,
753 /*current_error*/ 1,
754 /*sense_key*/ SSD_KEY_MEDIUM_ERROR,
755 /*asc*/ 0x31,
756 /*ascq*/ 0x00,
757 SSD_ELEM_NONE);
758 }
759
760 void
ctl_set_medium_magazine_inaccessible(struct ctl_scsiio * ctsio)761 ctl_set_medium_magazine_inaccessible(struct ctl_scsiio *ctsio)
762 {
763 /* "Medium magazine not accessible" */
764 ctl_set_sense(ctsio,
765 /*current_error*/ 1,
766 /*sense_key*/ SSD_KEY_NOT_READY,
767 /*asc*/ 0x3b,
768 /*ascq*/ 0x11,
769 SSD_ELEM_NONE);
770 }
771
772 void
ctl_set_data_phase_error(struct ctl_scsiio * ctsio)773 ctl_set_data_phase_error(struct ctl_scsiio *ctsio)
774 {
775 /* "Data phase error" */
776 ctl_set_sense(ctsio,
777 /*current_error*/ 1,
778 /*sense_key*/ SSD_KEY_NOT_READY,
779 /*asc*/ 0x4b,
780 /*ascq*/ 0x00,
781 SSD_ELEM_NONE);
782 }
783
784 void
ctl_set_reservation_conflict(struct ctl_scsiio * ctsio)785 ctl_set_reservation_conflict(struct ctl_scsiio *ctsio)
786 {
787 struct scsi_sense_data *sense;
788
789 sense = &ctsio->sense_data;
790 memset(sense, 0, sizeof(*sense));
791 ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT;
792 ctsio->sense_len = 0;
793 ctsio->io_hdr.status = CTL_SCSI_ERROR;
794 }
795
796 void
ctl_set_queue_full(struct ctl_scsiio * ctsio)797 ctl_set_queue_full(struct ctl_scsiio *ctsio)
798 {
799 struct scsi_sense_data *sense;
800
801 sense = &ctsio->sense_data;
802 memset(sense, 0, sizeof(*sense));
803 ctsio->scsi_status = SCSI_STATUS_QUEUE_FULL;
804 ctsio->sense_len = 0;
805 ctsio->io_hdr.status = CTL_SCSI_ERROR;
806 }
807
808 void
ctl_set_busy(struct ctl_scsiio * ctsio)809 ctl_set_busy(struct ctl_scsiio *ctsio)
810 {
811 struct scsi_sense_data *sense;
812
813 sense = &ctsio->sense_data;
814 memset(sense, 0, sizeof(*sense));
815 ctsio->scsi_status = SCSI_STATUS_BUSY;
816 ctsio->sense_len = 0;
817 ctsio->io_hdr.status = CTL_SCSI_ERROR;
818 }
819
820 void
ctl_set_task_aborted(struct ctl_scsiio * ctsio)821 ctl_set_task_aborted(struct ctl_scsiio *ctsio)
822 {
823 struct scsi_sense_data *sense;
824
825 sense = &ctsio->sense_data;
826 memset(sense, 0, sizeof(*sense));
827 ctsio->scsi_status = SCSI_STATUS_TASK_ABORTED;
828 ctsio->sense_len = 0;
829 ctsio->io_hdr.status = CTL_CMD_ABORTED;
830 }
831
832 void
ctl_set_space_alloc_fail(struct ctl_scsiio * ctsio)833 ctl_set_space_alloc_fail(struct ctl_scsiio *ctsio)
834 {
835 /* "Space allocation failed write protect" */
836 ctl_set_sense(ctsio,
837 /*current_error*/ 1,
838 /*sense_key*/ SSD_KEY_DATA_PROTECT,
839 /*asc*/ 0x27,
840 /*ascq*/ 0x07,
841 SSD_ELEM_NONE);
842 }
843
844 void
ctl_set_success(struct ctl_scsiio * ctsio)845 ctl_set_success(struct ctl_scsiio *ctsio)
846 {
847 struct scsi_sense_data *sense;
848
849 sense = &ctsio->sense_data;
850 memset(sense, 0, sizeof(*sense));
851 ctsio->scsi_status = SCSI_STATUS_OK;
852 ctsio->sense_len = 0;
853 ctsio->io_hdr.status = CTL_SUCCESS;
854 }
855