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