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_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 void 358 ctl_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 368 static void 369 ctl_ua_to_acsq(struct ctl_lun *lun, ctl_ua_type ua_to_build, int *asc, 370 int *ascq, ctl_ua_type *ua_to_clear, uint8_t **info) 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 *info = lun->ua_tpt_info; 457 break; 458 default: 459 panic("%s: Unknown UA %x", __func__, ua_to_build); 460 } 461 } 462 463 ctl_ua_type 464 ctl_build_qae(struct ctl_lun *lun, uint32_t initidx, uint8_t *resp) 465 { 466 ctl_ua_type ua; 467 ctl_ua_type ua_to_build, ua_to_clear; 468 uint8_t *info; 469 int asc, ascq; 470 uint32_t p, i; 471 472 mtx_assert(&lun->lun_lock, MA_OWNED); 473 p = initidx / CTL_MAX_INIT_PER_PORT; 474 i = initidx % CTL_MAX_INIT_PER_PORT; 475 if (lun->pending_ua[p] == NULL) 476 ua = CTL_UA_POWERON; 477 else 478 ua = lun->pending_ua[p][i]; 479 if (ua == CTL_UA_NONE) 480 return (CTL_UA_NONE); 481 482 ua_to_build = (1 << (ffs(ua) - 1)); 483 ua_to_clear = ua_to_build; 484 info = NULL; 485 ctl_ua_to_acsq(lun, ua_to_build, &asc, &ascq, &ua_to_clear, &info); 486 487 resp[0] = SSD_KEY_UNIT_ATTENTION; 488 if (ua_to_build == ua) 489 resp[0] |= 0x10; 490 else 491 resp[0] |= 0x20; 492 resp[1] = asc; 493 resp[2] = ascq; 494 return (ua); 495 } 496 497 ctl_ua_type 498 ctl_build_ua(struct ctl_lun *lun, uint32_t initidx, 499 struct scsi_sense_data *sense, scsi_sense_data_type sense_format) 500 { 501 ctl_ua_type *ua; 502 ctl_ua_type ua_to_build, ua_to_clear; 503 uint8_t *info; 504 int asc, ascq; 505 uint32_t p, i; 506 507 mtx_assert(&lun->lun_lock, MA_OWNED); 508 p = initidx / CTL_MAX_INIT_PER_PORT; 509 if ((ua = lun->pending_ua[p]) == NULL) { 510 mtx_unlock(&lun->lun_lock); 511 ua = malloc(sizeof(ctl_ua_type) * CTL_MAX_INIT_PER_PORT, 512 M_CTL, M_WAITOK); 513 mtx_lock(&lun->lun_lock); 514 if (lun->pending_ua[p] == NULL) { 515 lun->pending_ua[p] = ua; 516 for (i = 0; i < CTL_MAX_INIT_PER_PORT; i++) 517 ua[i] = CTL_UA_POWERON; 518 } else { 519 free(ua, M_CTL); 520 ua = lun->pending_ua[p]; 521 } 522 } 523 i = initidx % CTL_MAX_INIT_PER_PORT; 524 if (ua[i] == CTL_UA_NONE) 525 return (CTL_UA_NONE); 526 527 ua_to_build = (1 << (ffs(ua[i]) - 1)); 528 ua_to_clear = ua_to_build; 529 info = NULL; 530 ctl_ua_to_acsq(lun, ua_to_build, &asc, &ascq, &ua_to_clear, &info); 531 532 ctl_set_sense_data(sense, lun, sense_format, /*current_error*/ 1, 533 /*sense_key*/ SSD_KEY_UNIT_ATTENTION, asc, ascq, 534 ((info != NULL) ? SSD_ELEM_INFO : SSD_ELEM_SKIP), 8, info, 535 SSD_ELEM_NONE); 536 537 /* We're reporting this UA, so clear it */ 538 ua[i] &= ~ua_to_clear; 539 540 return (ua_to_build); 541 } 542 543 void 544 ctl_set_overlapped_cmd(struct ctl_scsiio *ctsio) 545 { 546 /* OVERLAPPED COMMANDS ATTEMPTED */ 547 ctl_set_sense(ctsio, 548 /*current_error*/ 1, 549 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST, 550 /*asc*/ 0x4E, 551 /*ascq*/ 0x00, 552 SSD_ELEM_NONE); 553 } 554 555 void 556 ctl_set_overlapped_tag(struct ctl_scsiio *ctsio, uint8_t tag) 557 { 558 /* TAGGED OVERLAPPED COMMANDS (NN = QUEUE TAG) */ 559 ctl_set_sense(ctsio, 560 /*current_error*/ 1, 561 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST, 562 /*asc*/ 0x4D, 563 /*ascq*/ tag, 564 SSD_ELEM_NONE); 565 } 566 567 /* 568 * Tell the user that there was a problem with the command or data he sent. 569 */ 570 void 571 ctl_set_invalid_field(struct ctl_scsiio *ctsio, int sks_valid, int command, 572 int field, int bit_valid, int bit) 573 { 574 uint8_t sks[3]; 575 int asc; 576 577 if (command != 0) { 578 /* "Invalid field in CDB" */ 579 asc = 0x24; 580 } else { 581 /* "Invalid field in parameter list" */ 582 asc = 0x26; 583 } 584 585 if (sks_valid) { 586 sks[0] = SSD_SCS_VALID; 587 if (command) 588 sks[0] |= SSD_FIELDPTR_CMD; 589 scsi_ulto2b(field, &sks[1]); 590 591 if (bit_valid) 592 sks[0] |= SSD_BITPTR_VALID | bit; 593 } 594 595 ctl_set_sense(ctsio, 596 /*current_error*/ 1, 597 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST, 598 asc, 599 /*ascq*/ 0x00, 600 /*type*/ (sks_valid != 0) ? SSD_ELEM_SKS : SSD_ELEM_SKIP, 601 /*size*/ sizeof(sks), 602 /*data*/ sks, 603 SSD_ELEM_NONE); 604 } 605 606 void 607 ctl_set_invalid_opcode(struct ctl_scsiio *ctsio) 608 { 609 uint8_t sks[3]; 610 611 sks[0] = SSD_SCS_VALID | SSD_FIELDPTR_CMD; 612 scsi_ulto2b(0, &sks[1]); 613 614 /* "Invalid command operation code" */ 615 ctl_set_sense(ctsio, 616 /*current_error*/ 1, 617 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST, 618 /*asc*/ 0x20, 619 /*ascq*/ 0x00, 620 /*type*/ SSD_ELEM_SKS, 621 /*size*/ sizeof(sks), 622 /*data*/ sks, 623 SSD_ELEM_NONE); 624 } 625 626 void 627 ctl_set_param_len_error(struct ctl_scsiio *ctsio) 628 { 629 /* "Parameter list length error" */ 630 ctl_set_sense(ctsio, 631 /*current_error*/ 1, 632 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST, 633 /*asc*/ 0x1a, 634 /*ascq*/ 0x00, 635 SSD_ELEM_NONE); 636 } 637 638 void 639 ctl_set_already_locked(struct ctl_scsiio *ctsio) 640 { 641 /* Vendor unique "Somebody already is locked" */ 642 ctl_set_sense(ctsio, 643 /*current_error*/ 1, 644 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST, 645 /*asc*/ 0x81, 646 /*ascq*/ 0x00, 647 SSD_ELEM_NONE); 648 } 649 650 void 651 ctl_set_unsupported_lun(struct ctl_scsiio *ctsio) 652 { 653 /* "Logical unit not supported" */ 654 ctl_set_sense(ctsio, 655 /*current_error*/ 1, 656 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST, 657 /*asc*/ 0x25, 658 /*ascq*/ 0x00, 659 SSD_ELEM_NONE); 660 } 661 662 void 663 ctl_set_internal_failure(struct ctl_scsiio *ctsio, int sks_valid, 664 uint16_t retry_count) 665 { 666 uint8_t sks[3]; 667 668 if (sks_valid) { 669 sks[0] = SSD_SCS_VALID; 670 sks[1] = (retry_count >> 8) & 0xff; 671 sks[2] = retry_count & 0xff; 672 } 673 674 /* "Internal target failure" */ 675 ctl_set_sense(ctsio, 676 /*current_error*/ 1, 677 /*sense_key*/ SSD_KEY_HARDWARE_ERROR, 678 /*asc*/ 0x44, 679 /*ascq*/ 0x00, 680 /*type*/ (sks_valid != 0) ? SSD_ELEM_SKS : SSD_ELEM_SKIP, 681 /*size*/ sizeof(sks), 682 /*data*/ sks, 683 SSD_ELEM_NONE); 684 } 685 686 void 687 ctl_set_medium_error(struct ctl_scsiio *ctsio, int read) 688 { 689 if (read) { 690 /* "Unrecovered read error" */ 691 ctl_set_sense(ctsio, 692 /*current_error*/ 1, 693 /*sense_key*/ SSD_KEY_MEDIUM_ERROR, 694 /*asc*/ 0x11, 695 /*ascq*/ 0x00, 696 SSD_ELEM_NONE); 697 } else { 698 /* "Write error - auto reallocation failed" */ 699 ctl_set_sense(ctsio, 700 /*current_error*/ 1, 701 /*sense_key*/ SSD_KEY_MEDIUM_ERROR, 702 /*asc*/ 0x0C, 703 /*ascq*/ 0x02, 704 SSD_ELEM_NONE); 705 } 706 } 707 708 void 709 ctl_set_aborted(struct ctl_scsiio *ctsio) 710 { 711 ctl_set_sense(ctsio, 712 /*current_error*/ 1, 713 /*sense_key*/ SSD_KEY_ABORTED_COMMAND, 714 /*asc*/ 0x45, 715 /*ascq*/ 0x00, 716 SSD_ELEM_NONE); 717 } 718 719 void 720 ctl_set_lba_out_of_range(struct ctl_scsiio *ctsio) 721 { 722 /* "Logical block address out of range" */ 723 ctl_set_sense(ctsio, 724 /*current_error*/ 1, 725 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST, 726 /*asc*/ 0x21, 727 /*ascq*/ 0x00, 728 SSD_ELEM_NONE); 729 } 730 731 void 732 ctl_set_lun_stopped(struct ctl_scsiio *ctsio) 733 { 734 /* "Logical unit not ready, initializing cmd. required" */ 735 ctl_set_sense(ctsio, 736 /*current_error*/ 1, 737 /*sense_key*/ SSD_KEY_NOT_READY, 738 /*asc*/ 0x04, 739 /*ascq*/ 0x02, 740 SSD_ELEM_NONE); 741 } 742 743 void 744 ctl_set_lun_not_ready(struct ctl_scsiio *ctsio) 745 { 746 /* "Logical unit not ready, manual intervention required" */ 747 ctl_set_sense(ctsio, 748 /*current_error*/ 1, 749 /*sense_key*/ SSD_KEY_NOT_READY, 750 /*asc*/ 0x04, 751 /*ascq*/ 0x03, 752 SSD_ELEM_NONE); 753 } 754 755 void 756 ctl_set_illegal_pr_release(struct ctl_scsiio *ctsio) 757 { 758 /* "Invalid release of persistent reservation" */ 759 ctl_set_sense(ctsio, 760 /*current_error*/ 1, 761 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST, 762 /*asc*/ 0x26, 763 /*ascq*/ 0x04, 764 SSD_ELEM_NONE); 765 } 766 767 void 768 ctl_set_lun_transit(struct ctl_scsiio *ctsio) 769 { 770 /* "Logical unit not ready, asymmetric access state transition" */ 771 ctl_set_sense(ctsio, 772 /*current_error*/ 1, 773 /*sense_key*/ SSD_KEY_NOT_READY, 774 /*asc*/ 0x04, 775 /*ascq*/ 0x0a, 776 SSD_ELEM_NONE); 777 } 778 779 void 780 ctl_set_lun_standby(struct ctl_scsiio *ctsio) 781 { 782 /* "Logical unit not ready, target port in standby state" */ 783 ctl_set_sense(ctsio, 784 /*current_error*/ 1, 785 /*sense_key*/ SSD_KEY_NOT_READY, 786 /*asc*/ 0x04, 787 /*ascq*/ 0x0b, 788 SSD_ELEM_NONE); 789 } 790 791 void 792 ctl_set_lun_unavail(struct ctl_scsiio *ctsio) 793 { 794 /* "Logical unit not ready, target port in unavailable state" */ 795 ctl_set_sense(ctsio, 796 /*current_error*/ 1, 797 /*sense_key*/ SSD_KEY_NOT_READY, 798 /*asc*/ 0x04, 799 /*ascq*/ 0x0c, 800 SSD_ELEM_NONE); 801 } 802 803 void 804 ctl_set_medium_format_corrupted(struct ctl_scsiio *ctsio) 805 { 806 /* "Medium format corrupted" */ 807 ctl_set_sense(ctsio, 808 /*current_error*/ 1, 809 /*sense_key*/ SSD_KEY_MEDIUM_ERROR, 810 /*asc*/ 0x31, 811 /*ascq*/ 0x00, 812 SSD_ELEM_NONE); 813 } 814 815 void 816 ctl_set_medium_magazine_inaccessible(struct ctl_scsiio *ctsio) 817 { 818 /* "Medium magazine not accessible" */ 819 ctl_set_sense(ctsio, 820 /*current_error*/ 1, 821 /*sense_key*/ SSD_KEY_NOT_READY, 822 /*asc*/ 0x3b, 823 /*ascq*/ 0x11, 824 SSD_ELEM_NONE); 825 } 826 827 void 828 ctl_set_data_phase_error(struct ctl_scsiio *ctsio) 829 { 830 /* "Data phase error" */ 831 ctl_set_sense(ctsio, 832 /*current_error*/ 1, 833 /*sense_key*/ SSD_KEY_NOT_READY, 834 /*asc*/ 0x4b, 835 /*ascq*/ 0x00, 836 SSD_ELEM_NONE); 837 } 838 839 void 840 ctl_set_reservation_conflict(struct ctl_scsiio *ctsio) 841 { 842 struct scsi_sense_data *sense; 843 844 sense = &ctsio->sense_data; 845 memset(sense, 0, sizeof(*sense)); 846 ctsio->scsi_status = SCSI_STATUS_RESERV_CONFLICT; 847 ctsio->sense_len = 0; 848 ctsio->io_hdr.status = CTL_SCSI_ERROR; 849 } 850 851 void 852 ctl_set_queue_full(struct ctl_scsiio *ctsio) 853 { 854 struct scsi_sense_data *sense; 855 856 sense = &ctsio->sense_data; 857 memset(sense, 0, sizeof(*sense)); 858 ctsio->scsi_status = SCSI_STATUS_QUEUE_FULL; 859 ctsio->sense_len = 0; 860 ctsio->io_hdr.status = CTL_SCSI_ERROR; 861 } 862 863 void 864 ctl_set_busy(struct ctl_scsiio *ctsio) 865 { 866 struct scsi_sense_data *sense; 867 868 sense = &ctsio->sense_data; 869 memset(sense, 0, sizeof(*sense)); 870 ctsio->scsi_status = SCSI_STATUS_BUSY; 871 ctsio->sense_len = 0; 872 ctsio->io_hdr.status = CTL_SCSI_ERROR; 873 } 874 875 void 876 ctl_set_task_aborted(struct ctl_scsiio *ctsio) 877 { 878 struct scsi_sense_data *sense; 879 880 sense = &ctsio->sense_data; 881 memset(sense, 0, sizeof(*sense)); 882 ctsio->scsi_status = SCSI_STATUS_TASK_ABORTED; 883 ctsio->sense_len = 0; 884 ctsio->io_hdr.status = CTL_CMD_ABORTED; 885 } 886 887 void 888 ctl_set_hw_write_protected(struct ctl_scsiio *ctsio) 889 { 890 /* "Hardware write protected" */ 891 ctl_set_sense(ctsio, 892 /*current_error*/ 1, 893 /*sense_key*/ SSD_KEY_DATA_PROTECT, 894 /*asc*/ 0x27, 895 /*ascq*/ 0x01, 896 SSD_ELEM_NONE); 897 } 898 899 void 900 ctl_set_space_alloc_fail(struct ctl_scsiio *ctsio) 901 { 902 /* "Space allocation failed write protect" */ 903 ctl_set_sense(ctsio, 904 /*current_error*/ 1, 905 /*sense_key*/ SSD_KEY_DATA_PROTECT, 906 /*asc*/ 0x27, 907 /*ascq*/ 0x07, 908 SSD_ELEM_NONE); 909 } 910 911 void 912 ctl_set_success(struct ctl_scsiio *ctsio) 913 { 914 struct scsi_sense_data *sense; 915 916 sense = &ctsio->sense_data; 917 memset(sense, 0, sizeof(*sense)); 918 ctsio->scsi_status = SCSI_STATUS_OK; 919 ctsio->sense_len = 0; 920 ctsio->io_hdr.status = CTL_SUCCESS; 921 } 922