cam_periph.c revision 198394
1/*- 2 * Common functions for CAM "type" (peripheral) drivers. 3 * 4 * Copyright (c) 1997, 1998 Justin T. Gibbs. 5 * Copyright (c) 1997, 1998, 1999, 2000 Kenneth D. Merry. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions, and the following disclaimer, 13 * without modification, immediately at the beginning of the file. 14 * 2. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30#include <sys/cdefs.h> 31__FBSDID("$FreeBSD: head/sys/cam/cam_periph.c 198394 2009-10-23 13:39:30Z mav $"); 32 33#include <sys/param.h> 34#include <sys/systm.h> 35#include <sys/types.h> 36#include <sys/malloc.h> 37#include <sys/kernel.h> 38#include <sys/linker_set.h> 39#include <sys/bio.h> 40#include <sys/lock.h> 41#include <sys/mutex.h> 42#include <sys/buf.h> 43#include <sys/proc.h> 44#include <sys/devicestat.h> 45#include <sys/bus.h> 46#include <vm/vm.h> 47#include <vm/vm_extern.h> 48 49#include <cam/cam.h> 50#include <cam/cam_ccb.h> 51#include <cam/cam_queue.h> 52#include <cam/cam_xpt_periph.h> 53#include <cam/cam_periph.h> 54#include <cam/cam_debug.h> 55#include <cam/cam_sim.h> 56 57#include <cam/scsi/scsi_all.h> 58#include <cam/scsi/scsi_message.h> 59#include <cam/scsi/scsi_pass.h> 60 61static u_int camperiphnextunit(struct periph_driver *p_drv, 62 u_int newunit, int wired, 63 path_id_t pathid, target_id_t target, 64 lun_id_t lun); 65static u_int camperiphunit(struct periph_driver *p_drv, 66 path_id_t pathid, target_id_t target, 67 lun_id_t lun); 68static void camperiphdone(struct cam_periph *periph, 69 union ccb *done_ccb); 70static void camperiphfree(struct cam_periph *periph); 71static int camperiphscsistatuserror(union ccb *ccb, 72 cam_flags camflags, 73 u_int32_t sense_flags, 74 union ccb *save_ccb, 75 int *openings, 76 u_int32_t *relsim_flags, 77 u_int32_t *timeout); 78static int camperiphscsisenseerror(union ccb *ccb, 79 cam_flags camflags, 80 u_int32_t sense_flags, 81 union ccb *save_ccb, 82 int *openings, 83 u_int32_t *relsim_flags, 84 u_int32_t *timeout); 85 86static int nperiph_drivers; 87struct periph_driver **periph_drivers; 88 89MALLOC_DEFINE(M_CAMPERIPH, "CAM periph", "CAM peripheral buffers"); 90 91static int periph_selto_delay = 1000; 92TUNABLE_INT("kern.cam.periph_selto_delay", &periph_selto_delay); 93static int periph_noresrc_delay = 500; 94TUNABLE_INT("kern.cam.periph_noresrc_delay", &periph_noresrc_delay); 95static int periph_busy_delay = 500; 96TUNABLE_INT("kern.cam.periph_busy_delay", &periph_busy_delay); 97 98 99void 100periphdriver_register(void *data) 101{ 102 struct periph_driver **newdrivers, **old; 103 int ndrivers; 104 105 ndrivers = nperiph_drivers + 2; 106 newdrivers = malloc(sizeof(*newdrivers) * ndrivers, M_CAMPERIPH, 107 M_WAITOK); 108 if (periph_drivers) 109 bcopy(periph_drivers, newdrivers, 110 sizeof(*newdrivers) * nperiph_drivers); 111 newdrivers[nperiph_drivers] = (struct periph_driver *)data; 112 newdrivers[nperiph_drivers + 1] = NULL; 113 old = periph_drivers; 114 periph_drivers = newdrivers; 115 if (old) 116 free(old, M_CAMPERIPH); 117 nperiph_drivers++; 118} 119 120cam_status 121cam_periph_alloc(periph_ctor_t *periph_ctor, 122 periph_oninv_t *periph_oninvalidate, 123 periph_dtor_t *periph_dtor, periph_start_t *periph_start, 124 char *name, cam_periph_type type, struct cam_path *path, 125 ac_callback_t *ac_callback, ac_code code, void *arg) 126{ 127 struct periph_driver **p_drv; 128 struct cam_sim *sim; 129 struct cam_periph *periph; 130 struct cam_periph *cur_periph; 131 path_id_t path_id; 132 target_id_t target_id; 133 lun_id_t lun_id; 134 cam_status status; 135 u_int init_level; 136 137 init_level = 0; 138 /* 139 * Handle Hot-Plug scenarios. If there is already a peripheral 140 * of our type assigned to this path, we are likely waiting for 141 * final close on an old, invalidated, peripheral. If this is 142 * the case, queue up a deferred call to the peripheral's async 143 * handler. If it looks like a mistaken re-allocation, complain. 144 */ 145 if ((periph = cam_periph_find(path, name)) != NULL) { 146 147 if ((periph->flags & CAM_PERIPH_INVALID) != 0 148 && (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) == 0) { 149 periph->flags |= CAM_PERIPH_NEW_DEV_FOUND; 150 periph->deferred_callback = ac_callback; 151 periph->deferred_ac = code; 152 return (CAM_REQ_INPROG); 153 } else { 154 printf("cam_periph_alloc: attempt to re-allocate " 155 "valid device %s%d rejected\n", 156 periph->periph_name, periph->unit_number); 157 } 158 return (CAM_REQ_INVALID); 159 } 160 161 periph = (struct cam_periph *)malloc(sizeof(*periph), M_CAMPERIPH, 162 M_NOWAIT); 163 164 if (periph == NULL) 165 return (CAM_RESRC_UNAVAIL); 166 167 init_level++; 168 169 xpt_lock_buses(); 170 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) { 171 if (strcmp((*p_drv)->driver_name, name) == 0) 172 break; 173 } 174 xpt_unlock_buses(); 175 if (*p_drv == NULL) { 176 printf("cam_periph_alloc: invalid periph name '%s'\n", name); 177 free(periph, M_CAMPERIPH); 178 return (CAM_REQ_INVALID); 179 } 180 181 sim = xpt_path_sim(path); 182 path_id = xpt_path_path_id(path); 183 target_id = xpt_path_target_id(path); 184 lun_id = xpt_path_lun_id(path); 185 bzero(periph, sizeof(*periph)); 186 cam_init_pinfo(&periph->pinfo); 187 periph->periph_start = periph_start; 188 periph->periph_dtor = periph_dtor; 189 periph->periph_oninval = periph_oninvalidate; 190 periph->type = type; 191 periph->periph_name = name; 192 periph->unit_number = camperiphunit(*p_drv, path_id, target_id, lun_id); 193 periph->immediate_priority = CAM_PRIORITY_NONE; 194 periph->refcount = 0; 195 periph->sim = sim; 196 SLIST_INIT(&periph->ccb_list); 197 status = xpt_create_path(&path, periph, path_id, target_id, lun_id); 198 if (status != CAM_REQ_CMP) 199 goto failure; 200 201 periph->path = path; 202 init_level++; 203 204 status = xpt_add_periph(periph); 205 206 if (status != CAM_REQ_CMP) 207 goto failure; 208 209 cur_periph = TAILQ_FIRST(&(*p_drv)->units); 210 while (cur_periph != NULL 211 && cur_periph->unit_number < periph->unit_number) 212 cur_periph = TAILQ_NEXT(cur_periph, unit_links); 213 214 if (cur_periph != NULL) 215 TAILQ_INSERT_BEFORE(cur_periph, periph, unit_links); 216 else { 217 TAILQ_INSERT_TAIL(&(*p_drv)->units, periph, unit_links); 218 (*p_drv)->generation++; 219 } 220 221 init_level++; 222 223 status = periph_ctor(periph, arg); 224 225 if (status == CAM_REQ_CMP) 226 init_level++; 227 228failure: 229 switch (init_level) { 230 case 4: 231 /* Initialized successfully */ 232 break; 233 case 3: 234 TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links); 235 xpt_remove_periph(periph); 236 /* FALLTHROUGH */ 237 case 2: 238 xpt_free_path(periph->path); 239 /* FALLTHROUGH */ 240 case 1: 241 free(periph, M_CAMPERIPH); 242 /* FALLTHROUGH */ 243 case 0: 244 /* No cleanup to perform. */ 245 break; 246 default: 247 panic("cam_periph_alloc: Unkown init level"); 248 } 249 return(status); 250} 251 252/* 253 * Find a peripheral structure with the specified path, target, lun, 254 * and (optionally) type. If the name is NULL, this function will return 255 * the first peripheral driver that matches the specified path. 256 */ 257struct cam_periph * 258cam_periph_find(struct cam_path *path, char *name) 259{ 260 struct periph_driver **p_drv; 261 struct cam_periph *periph; 262 263 xpt_lock_buses(); 264 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) { 265 266 if (name != NULL && (strcmp((*p_drv)->driver_name, name) != 0)) 267 continue; 268 269 TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) { 270 if (xpt_path_comp(periph->path, path) == 0) { 271 xpt_unlock_buses(); 272 return(periph); 273 } 274 } 275 if (name != NULL) { 276 xpt_unlock_buses(); 277 return(NULL); 278 } 279 } 280 xpt_unlock_buses(); 281 return(NULL); 282} 283 284cam_status 285cam_periph_acquire(struct cam_periph *periph) 286{ 287 288 if (periph == NULL) 289 return(CAM_REQ_CMP_ERR); 290 291 xpt_lock_buses(); 292 periph->refcount++; 293 xpt_unlock_buses(); 294 295 return(CAM_REQ_CMP); 296} 297 298void 299cam_periph_release_locked(struct cam_periph *periph) 300{ 301 302 if (periph == NULL) 303 return; 304 305 xpt_lock_buses(); 306 if ((--periph->refcount == 0) 307 && (periph->flags & CAM_PERIPH_INVALID)) { 308 camperiphfree(periph); 309 } 310 xpt_unlock_buses(); 311} 312 313void 314cam_periph_release(struct cam_periph *periph) 315{ 316 struct cam_sim *sim; 317 318 if (periph == NULL) 319 return; 320 321 sim = periph->sim; 322 mtx_assert(sim->mtx, MA_NOTOWNED); 323 mtx_lock(sim->mtx); 324 cam_periph_release_locked(periph); 325 mtx_unlock(sim->mtx); 326} 327 328int 329cam_periph_hold(struct cam_periph *periph, int priority) 330{ 331 int error; 332 333 /* 334 * Increment the reference count on the peripheral 335 * while we wait for our lock attempt to succeed 336 * to ensure the peripheral doesn't disappear out 337 * from user us while we sleep. 338 */ 339 340 if (cam_periph_acquire(periph) != CAM_REQ_CMP) 341 return (ENXIO); 342 343 mtx_assert(periph->sim->mtx, MA_OWNED); 344 while ((periph->flags & CAM_PERIPH_LOCKED) != 0) { 345 periph->flags |= CAM_PERIPH_LOCK_WANTED; 346 if ((error = mtx_sleep(periph, periph->sim->mtx, priority, 347 "caplck", 0)) != 0) { 348 cam_periph_release_locked(periph); 349 return (error); 350 } 351 } 352 353 periph->flags |= CAM_PERIPH_LOCKED; 354 return (0); 355} 356 357void 358cam_periph_unhold(struct cam_periph *periph) 359{ 360 361 mtx_assert(periph->sim->mtx, MA_OWNED); 362 363 periph->flags &= ~CAM_PERIPH_LOCKED; 364 if ((periph->flags & CAM_PERIPH_LOCK_WANTED) != 0) { 365 periph->flags &= ~CAM_PERIPH_LOCK_WANTED; 366 wakeup(periph); 367 } 368 369 cam_periph_release_locked(periph); 370} 371 372/* 373 * Look for the next unit number that is not currently in use for this 374 * peripheral type starting at "newunit". Also exclude unit numbers that 375 * are reserved by for future "hardwiring" unless we already know that this 376 * is a potential wired device. Only assume that the device is "wired" the 377 * first time through the loop since after that we'll be looking at unit 378 * numbers that did not match a wiring entry. 379 */ 380static u_int 381camperiphnextunit(struct periph_driver *p_drv, u_int newunit, int wired, 382 path_id_t pathid, target_id_t target, lun_id_t lun) 383{ 384 struct cam_periph *periph; 385 char *periph_name; 386 int i, val, dunit, r; 387 const char *dname, *strval; 388 389 periph_name = p_drv->driver_name; 390 for (;;newunit++) { 391 392 for (periph = TAILQ_FIRST(&p_drv->units); 393 periph != NULL && periph->unit_number != newunit; 394 periph = TAILQ_NEXT(periph, unit_links)) 395 ; 396 397 if (periph != NULL && periph->unit_number == newunit) { 398 if (wired != 0) { 399 xpt_print(periph->path, "Duplicate Wired " 400 "Device entry!\n"); 401 xpt_print(periph->path, "Second device (%s " 402 "device at scbus%d target %d lun %d) will " 403 "not be wired\n", periph_name, pathid, 404 target, lun); 405 wired = 0; 406 } 407 continue; 408 } 409 if (wired) 410 break; 411 412 /* 413 * Don't match entries like "da 4" as a wired down 414 * device, but do match entries like "da 4 target 5" 415 * or even "da 4 scbus 1". 416 */ 417 i = 0; 418 dname = periph_name; 419 for (;;) { 420 r = resource_find_dev(&i, dname, &dunit, NULL, NULL); 421 if (r != 0) 422 break; 423 /* if no "target" and no specific scbus, skip */ 424 if (resource_int_value(dname, dunit, "target", &val) && 425 (resource_string_value(dname, dunit, "at",&strval)|| 426 strcmp(strval, "scbus") == 0)) 427 continue; 428 if (newunit == dunit) 429 break; 430 } 431 if (r != 0) 432 break; 433 } 434 return (newunit); 435} 436 437static u_int 438camperiphunit(struct periph_driver *p_drv, path_id_t pathid, 439 target_id_t target, lun_id_t lun) 440{ 441 u_int unit; 442 int wired, i, val, dunit; 443 const char *dname, *strval; 444 char pathbuf[32], *periph_name; 445 446 periph_name = p_drv->driver_name; 447 snprintf(pathbuf, sizeof(pathbuf), "scbus%d", pathid); 448 unit = 0; 449 i = 0; 450 dname = periph_name; 451 for (wired = 0; resource_find_dev(&i, dname, &dunit, NULL, NULL) == 0; 452 wired = 0) { 453 if (resource_string_value(dname, dunit, "at", &strval) == 0) { 454 if (strcmp(strval, pathbuf) != 0) 455 continue; 456 wired++; 457 } 458 if (resource_int_value(dname, dunit, "target", &val) == 0) { 459 if (val != target) 460 continue; 461 wired++; 462 } 463 if (resource_int_value(dname, dunit, "lun", &val) == 0) { 464 if (val != lun) 465 continue; 466 wired++; 467 } 468 if (wired != 0) { 469 unit = dunit; 470 break; 471 } 472 } 473 474 /* 475 * Either start from 0 looking for the next unit or from 476 * the unit number given in the resource config. This way, 477 * if we have wildcard matches, we don't return the same 478 * unit number twice. 479 */ 480 unit = camperiphnextunit(p_drv, unit, wired, pathid, target, lun); 481 482 return (unit); 483} 484 485void 486cam_periph_invalidate(struct cam_periph *periph) 487{ 488 489 /* 490 * We only call this routine the first time a peripheral is 491 * invalidated. 492 */ 493 if (((periph->flags & CAM_PERIPH_INVALID) == 0) 494 && (periph->periph_oninval != NULL)) 495 periph->periph_oninval(periph); 496 497 periph->flags |= CAM_PERIPH_INVALID; 498 periph->flags &= ~CAM_PERIPH_NEW_DEV_FOUND; 499 500 xpt_lock_buses(); 501 if (periph->refcount == 0) 502 camperiphfree(periph); 503 else if (periph->refcount < 0) 504 printf("cam_invalidate_periph: refcount < 0!!\n"); 505 xpt_unlock_buses(); 506} 507 508static void 509camperiphfree(struct cam_periph *periph) 510{ 511 struct periph_driver **p_drv; 512 513 for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) { 514 if (strcmp((*p_drv)->driver_name, periph->periph_name) == 0) 515 break; 516 } 517 if (*p_drv == NULL) { 518 printf("camperiphfree: attempt to free non-existant periph\n"); 519 return; 520 } 521 522 TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links); 523 (*p_drv)->generation++; 524 xpt_unlock_buses(); 525 526 if (periph->periph_dtor != NULL) 527 periph->periph_dtor(periph); 528 xpt_remove_periph(periph); 529 530 if (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) { 531 union ccb ccb; 532 void *arg; 533 534 switch (periph->deferred_ac) { 535 case AC_FOUND_DEVICE: 536 ccb.ccb_h.func_code = XPT_GDEV_TYPE; 537 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL); 538 xpt_action(&ccb); 539 arg = &ccb; 540 break; 541 case AC_PATH_REGISTERED: 542 ccb.ccb_h.func_code = XPT_PATH_INQ; 543 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL); 544 xpt_action(&ccb); 545 arg = &ccb; 546 break; 547 default: 548 arg = NULL; 549 break; 550 } 551 periph->deferred_callback(NULL, periph->deferred_ac, 552 periph->path, arg); 553 } 554 xpt_free_path(periph->path); 555 free(periph, M_CAMPERIPH); 556 xpt_lock_buses(); 557} 558 559/* 560 * Map user virtual pointers into kernel virtual address space, so we can 561 * access the memory. This won't work on physical pointers, for now it's 562 * up to the caller to check for that. (XXX KDM -- should we do that here 563 * instead?) This also only works for up to MAXPHYS memory. Since we use 564 * buffers to map stuff in and out, we're limited to the buffer size. 565 */ 566int 567cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo) 568{ 569 int numbufs, i, j; 570 int flags[CAM_PERIPH_MAXMAPS]; 571 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS]; 572 u_int32_t lengths[CAM_PERIPH_MAXMAPS]; 573 u_int32_t dirs[CAM_PERIPH_MAXMAPS]; 574 /* Some controllers may not be able to handle more data. */ 575 size_t maxmap = DFLTPHYS; 576 577 switch(ccb->ccb_h.func_code) { 578 case XPT_DEV_MATCH: 579 if (ccb->cdm.match_buf_len == 0) { 580 printf("cam_periph_mapmem: invalid match buffer " 581 "length 0\n"); 582 return(EINVAL); 583 } 584 if (ccb->cdm.pattern_buf_len > 0) { 585 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns; 586 lengths[0] = ccb->cdm.pattern_buf_len; 587 dirs[0] = CAM_DIR_OUT; 588 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches; 589 lengths[1] = ccb->cdm.match_buf_len; 590 dirs[1] = CAM_DIR_IN; 591 numbufs = 2; 592 } else { 593 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches; 594 lengths[0] = ccb->cdm.match_buf_len; 595 dirs[0] = CAM_DIR_IN; 596 numbufs = 1; 597 } 598 /* 599 * This request will not go to the hardware, no reason 600 * to be so strict. vmapbuf() is able to map up to MAXPHYS. 601 */ 602 maxmap = MAXPHYS; 603 break; 604 case XPT_SCSI_IO: 605 case XPT_CONT_TARGET_IO: 606 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE) 607 return(0); 608 609 data_ptrs[0] = &ccb->csio.data_ptr; 610 lengths[0] = ccb->csio.dxfer_len; 611 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK; 612 numbufs = 1; 613 break; 614 case XPT_ATA_IO: 615 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE) 616 return(0); 617 618 data_ptrs[0] = &ccb->ataio.data_ptr; 619 lengths[0] = ccb->ataio.dxfer_len; 620 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK; 621 numbufs = 1; 622 break; 623 default: 624 return(EINVAL); 625 break; /* NOTREACHED */ 626 } 627 628 /* 629 * Check the transfer length and permissions first, so we don't 630 * have to unmap any previously mapped buffers. 631 */ 632 for (i = 0; i < numbufs; i++) { 633 634 flags[i] = 0; 635 636 /* 637 * The userland data pointer passed in may not be page 638 * aligned. vmapbuf() truncates the address to a page 639 * boundary, so if the address isn't page aligned, we'll 640 * need enough space for the given transfer length, plus 641 * whatever extra space is necessary to make it to the page 642 * boundary. 643 */ 644 if ((lengths[i] + 645 (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)) > maxmap){ 646 printf("cam_periph_mapmem: attempt to map %lu bytes, " 647 "which is greater than %lu\n", 648 (long)(lengths[i] + 649 (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)), 650 (u_long)maxmap); 651 return(E2BIG); 652 } 653 654 if (dirs[i] & CAM_DIR_OUT) { 655 flags[i] = BIO_WRITE; 656 } 657 658 if (dirs[i] & CAM_DIR_IN) { 659 flags[i] = BIO_READ; 660 } 661 662 } 663 664 /* this keeps the current process from getting swapped */ 665 /* 666 * XXX KDM should I use P_NOSWAP instead? 667 */ 668 PHOLD(curproc); 669 670 for (i = 0; i < numbufs; i++) { 671 /* 672 * Get the buffer. 673 */ 674 mapinfo->bp[i] = getpbuf(NULL); 675 676 /* save the buffer's data address */ 677 mapinfo->bp[i]->b_saveaddr = mapinfo->bp[i]->b_data; 678 679 /* put our pointer in the data slot */ 680 mapinfo->bp[i]->b_data = *data_ptrs[i]; 681 682 /* set the transfer length, we know it's < MAXPHYS */ 683 mapinfo->bp[i]->b_bufsize = lengths[i]; 684 685 /* set the direction */ 686 mapinfo->bp[i]->b_iocmd = flags[i]; 687 688 /* 689 * Map the buffer into kernel memory. 690 * 691 * Note that useracc() alone is not a sufficient test. 692 * vmapbuf() can still fail due to a smaller file mapped 693 * into a larger area of VM, or if userland races against 694 * vmapbuf() after the useracc() check. 695 */ 696 if (vmapbuf(mapinfo->bp[i]) < 0) { 697 for (j = 0; j < i; ++j) { 698 *data_ptrs[j] = mapinfo->bp[j]->b_saveaddr; 699 vunmapbuf(mapinfo->bp[j]); 700 relpbuf(mapinfo->bp[j], NULL); 701 } 702 relpbuf(mapinfo->bp[i], NULL); 703 PRELE(curproc); 704 return(EACCES); 705 } 706 707 /* set our pointer to the new mapped area */ 708 *data_ptrs[i] = mapinfo->bp[i]->b_data; 709 710 mapinfo->num_bufs_used++; 711 } 712 713 /* 714 * Now that we've gotten this far, change ownership to the kernel 715 * of the buffers so that we don't run afoul of returning to user 716 * space with locks (on the buffer) held. 717 */ 718 for (i = 0; i < numbufs; i++) { 719 BUF_KERNPROC(mapinfo->bp[i]); 720 } 721 722 723 return(0); 724} 725 726/* 727 * Unmap memory segments mapped into kernel virtual address space by 728 * cam_periph_mapmem(). 729 */ 730void 731cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo) 732{ 733 int numbufs, i; 734 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS]; 735 736 if (mapinfo->num_bufs_used <= 0) { 737 /* allow ourselves to be swapped once again */ 738 PRELE(curproc); 739 return; 740 } 741 742 switch (ccb->ccb_h.func_code) { 743 case XPT_DEV_MATCH: 744 numbufs = min(mapinfo->num_bufs_used, 2); 745 746 if (numbufs == 1) { 747 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches; 748 } else { 749 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns; 750 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches; 751 } 752 break; 753 case XPT_SCSI_IO: 754 case XPT_CONT_TARGET_IO: 755 data_ptrs[0] = &ccb->csio.data_ptr; 756 numbufs = min(mapinfo->num_bufs_used, 1); 757 break; 758 case XPT_ATA_IO: 759 data_ptrs[0] = &ccb->ataio.data_ptr; 760 numbufs = min(mapinfo->num_bufs_used, 1); 761 break; 762 default: 763 /* allow ourselves to be swapped once again */ 764 PRELE(curproc); 765 return; 766 break; /* NOTREACHED */ 767 } 768 769 for (i = 0; i < numbufs; i++) { 770 /* Set the user's pointer back to the original value */ 771 *data_ptrs[i] = mapinfo->bp[i]->b_saveaddr; 772 773 /* unmap the buffer */ 774 vunmapbuf(mapinfo->bp[i]); 775 776 /* release the buffer */ 777 relpbuf(mapinfo->bp[i], NULL); 778 } 779 780 /* allow ourselves to be swapped once again */ 781 PRELE(curproc); 782} 783 784union ccb * 785cam_periph_getccb(struct cam_periph *periph, u_int32_t priority) 786{ 787 struct ccb_hdr *ccb_h; 788 789 mtx_assert(periph->sim->mtx, MA_OWNED); 790 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cdgetccb\n")); 791 792 while (SLIST_FIRST(&periph->ccb_list) == NULL) { 793 if (periph->immediate_priority > priority) 794 periph->immediate_priority = priority; 795 xpt_schedule(periph, priority); 796 if ((SLIST_FIRST(&periph->ccb_list) != NULL) 797 && (SLIST_FIRST(&periph->ccb_list)->pinfo.priority == priority)) 798 break; 799 mtx_assert(periph->sim->mtx, MA_OWNED); 800 mtx_sleep(&periph->ccb_list, periph->sim->mtx, PRIBIO, "cgticb", 801 0); 802 } 803 804 ccb_h = SLIST_FIRST(&periph->ccb_list); 805 SLIST_REMOVE_HEAD(&periph->ccb_list, periph_links.sle); 806 return ((union ccb *)ccb_h); 807} 808 809void 810cam_periph_ccbwait(union ccb *ccb) 811{ 812 struct cam_sim *sim; 813 814 sim = xpt_path_sim(ccb->ccb_h.path); 815 if ((ccb->ccb_h.pinfo.index != CAM_UNQUEUED_INDEX) 816 || ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)) 817 mtx_sleep(&ccb->ccb_h.cbfcnp, sim->mtx, PRIBIO, "cbwait", 0); 818} 819 820int 821cam_periph_ioctl(struct cam_periph *periph, u_long cmd, caddr_t addr, 822 int (*error_routine)(union ccb *ccb, 823 cam_flags camflags, 824 u_int32_t sense_flags)) 825{ 826 union ccb *ccb; 827 int error; 828 int found; 829 830 error = found = 0; 831 832 switch(cmd){ 833 case CAMGETPASSTHRU: 834 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL); 835 xpt_setup_ccb(&ccb->ccb_h, 836 ccb->ccb_h.path, 837 CAM_PRIORITY_NORMAL); 838 ccb->ccb_h.func_code = XPT_GDEVLIST; 839 840 /* 841 * Basically, the point of this is that we go through 842 * getting the list of devices, until we find a passthrough 843 * device. In the current version of the CAM code, the 844 * only way to determine what type of device we're dealing 845 * with is by its name. 846 */ 847 while (found == 0) { 848 ccb->cgdl.index = 0; 849 ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS; 850 while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) { 851 852 /* we want the next device in the list */ 853 xpt_action(ccb); 854 if (strncmp(ccb->cgdl.periph_name, 855 "pass", 4) == 0){ 856 found = 1; 857 break; 858 } 859 } 860 if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) && 861 (found == 0)) { 862 ccb->cgdl.periph_name[0] = '\0'; 863 ccb->cgdl.unit_number = 0; 864 break; 865 } 866 } 867 868 /* copy the result back out */ 869 bcopy(ccb, addr, sizeof(union ccb)); 870 871 /* and release the ccb */ 872 xpt_release_ccb(ccb); 873 874 break; 875 default: 876 error = ENOTTY; 877 break; 878 } 879 return(error); 880} 881 882int 883cam_periph_runccb(union ccb *ccb, 884 int (*error_routine)(union ccb *ccb, 885 cam_flags camflags, 886 u_int32_t sense_flags), 887 cam_flags camflags, u_int32_t sense_flags, 888 struct devstat *ds) 889{ 890 struct cam_sim *sim; 891 int error; 892 893 error = 0; 894 sim = xpt_path_sim(ccb->ccb_h.path); 895 mtx_assert(sim->mtx, MA_OWNED); 896 897 /* 898 * If the user has supplied a stats structure, and if we understand 899 * this particular type of ccb, record the transaction start. 900 */ 901 if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO)) 902 devstat_start_transaction(ds, NULL); 903 904 xpt_action(ccb); 905 906 do { 907 cam_periph_ccbwait(ccb); 908 if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP) 909 error = 0; 910 else if (error_routine != NULL) 911 error = (*error_routine)(ccb, camflags, sense_flags); 912 else 913 error = 0; 914 915 } while (error == ERESTART); 916 917 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) 918 cam_release_devq(ccb->ccb_h.path, 919 /* relsim_flags */0, 920 /* openings */0, 921 /* timeout */0, 922 /* getcount_only */ FALSE); 923 924 if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO)) 925 devstat_end_transaction(ds, 926 ccb->csio.dxfer_len, 927 ccb->csio.tag_action & 0xf, 928 ((ccb->ccb_h.flags & CAM_DIR_MASK) == 929 CAM_DIR_NONE) ? DEVSTAT_NO_DATA : 930 (ccb->ccb_h.flags & CAM_DIR_OUT) ? 931 DEVSTAT_WRITE : 932 DEVSTAT_READ, NULL, NULL); 933 934 return(error); 935} 936 937void 938cam_freeze_devq(struct cam_path *path) 939{ 940 struct ccb_hdr ccb_h; 941 942 xpt_setup_ccb(&ccb_h, path, CAM_PRIORITY_NORMAL); 943 ccb_h.func_code = XPT_NOOP; 944 ccb_h.flags = CAM_DEV_QFREEZE; 945 xpt_action((union ccb *)&ccb_h); 946} 947 948u_int32_t 949cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, 950 u_int32_t openings, u_int32_t timeout, 951 int getcount_only) 952{ 953 struct ccb_relsim crs; 954 955 xpt_setup_ccb(&crs.ccb_h, path, CAM_PRIORITY_NORMAL); 956 crs.ccb_h.func_code = XPT_REL_SIMQ; 957 crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0; 958 crs.release_flags = relsim_flags; 959 crs.openings = openings; 960 crs.release_timeout = timeout; 961 xpt_action((union ccb *)&crs); 962 return (crs.qfrozen_cnt); 963} 964 965#define saved_ccb_ptr ppriv_ptr0 966static void 967camperiphdone(struct cam_periph *periph, union ccb *done_ccb) 968{ 969 union ccb *saved_ccb; 970 cam_status status; 971 int frozen; 972 int sense; 973 struct scsi_start_stop_unit *scsi_cmd; 974 u_int32_t relsim_flags, timeout; 975 u_int32_t qfrozen_cnt; 976 int xpt_done_ccb; 977 978 xpt_done_ccb = FALSE; 979 status = done_ccb->ccb_h.status; 980 frozen = (status & CAM_DEV_QFRZN) != 0; 981 sense = (status & CAM_AUTOSNS_VALID) != 0; 982 status &= CAM_STATUS_MASK; 983 984 timeout = 0; 985 relsim_flags = 0; 986 saved_ccb = (union ccb *)done_ccb->ccb_h.saved_ccb_ptr; 987 988 /* 989 * Unfreeze the queue once if it is already frozen.. 990 */ 991 if (frozen != 0) { 992 qfrozen_cnt = cam_release_devq(done_ccb->ccb_h.path, 993 /*relsim_flags*/0, 994 /*openings*/0, 995 /*timeout*/0, 996 /*getcount_only*/0); 997 } 998 999 switch (status) { 1000 case CAM_REQ_CMP: 1001 { 1002 /* 1003 * If we have successfully taken a device from the not 1004 * ready to ready state, re-scan the device and re-get 1005 * the inquiry information. Many devices (mostly disks) 1006 * don't properly report their inquiry information unless 1007 * they are spun up. 1008 * 1009 * If we manually retrieved sense into a CCB and got 1010 * something other than "NO SENSE" send the updated CCB 1011 * back to the client via xpt_done() to be processed via 1012 * the error recovery code again. 1013 */ 1014 if (done_ccb->ccb_h.func_code == XPT_SCSI_IO) { 1015 scsi_cmd = (struct scsi_start_stop_unit *) 1016 &done_ccb->csio.cdb_io.cdb_bytes; 1017 1018 if (scsi_cmd->opcode == START_STOP_UNIT) 1019 xpt_async(AC_INQ_CHANGED, 1020 done_ccb->ccb_h.path, NULL); 1021 if (scsi_cmd->opcode == REQUEST_SENSE) { 1022 u_int sense_key; 1023 1024 sense_key = saved_ccb->csio.sense_data.flags; 1025 sense_key &= SSD_KEY; 1026 if (sense_key != SSD_KEY_NO_SENSE) { 1027 saved_ccb->ccb_h.status |= 1028 CAM_AUTOSNS_VALID; 1029#if 0 1030 xpt_print(saved_ccb->ccb_h.path, 1031 "Recovered Sense\n"); 1032 scsi_sense_print(&saved_ccb->csio); 1033 cam_error_print(saved_ccb, CAM_ESF_ALL, 1034 CAM_EPF_ALL); 1035#endif 1036 } else { 1037 saved_ccb->ccb_h.status &= 1038 ~CAM_STATUS_MASK; 1039 saved_ccb->ccb_h.status |= 1040 CAM_AUTOSENSE_FAIL; 1041 } 1042 xpt_done_ccb = TRUE; 1043 } 1044 } 1045 bcopy(done_ccb->ccb_h.saved_ccb_ptr, done_ccb, 1046 sizeof(union ccb)); 1047 1048 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG; 1049 1050 if (xpt_done_ccb == FALSE) 1051 xpt_action(done_ccb); 1052 1053 break; 1054 } 1055 case CAM_SCSI_STATUS_ERROR: 1056 scsi_cmd = (struct scsi_start_stop_unit *) 1057 &done_ccb->csio.cdb_io.cdb_bytes; 1058 if (sense != 0) { 1059 struct ccb_getdev cgd; 1060 struct scsi_sense_data *sense; 1061 int error_code, sense_key, asc, ascq; 1062 scsi_sense_action err_action; 1063 1064 sense = &done_ccb->csio.sense_data; 1065 scsi_extract_sense(sense, &error_code, 1066 &sense_key, &asc, &ascq); 1067 1068 /* 1069 * Grab the inquiry data for this device. 1070 */ 1071 xpt_setup_ccb(&cgd.ccb_h, done_ccb->ccb_h.path, 1072 CAM_PRIORITY_NORMAL); 1073 cgd.ccb_h.func_code = XPT_GDEV_TYPE; 1074 xpt_action((union ccb *)&cgd); 1075 err_action = scsi_error_action(&done_ccb->csio, 1076 &cgd.inq_data, 0); 1077 1078 /* 1079 * If the error is "invalid field in CDB", 1080 * and the load/eject flag is set, turn the 1081 * flag off and try again. This is just in 1082 * case the drive in question barfs on the 1083 * load eject flag. The CAM code should set 1084 * the load/eject flag by default for 1085 * removable media. 1086 */ 1087 1088 /* XXX KDM 1089 * Should we check to see what the specific 1090 * scsi status is?? Or does it not matter 1091 * since we already know that there was an 1092 * error, and we know what the specific 1093 * error code was, and we know what the 1094 * opcode is.. 1095 */ 1096 if ((scsi_cmd->opcode == START_STOP_UNIT) && 1097 ((scsi_cmd->how & SSS_LOEJ) != 0) && 1098 (asc == 0x24) && (ascq == 0x00) && 1099 (done_ccb->ccb_h.retry_count > 0)) { 1100 1101 scsi_cmd->how &= ~SSS_LOEJ; 1102 1103 xpt_action(done_ccb); 1104 1105 } else if ((done_ccb->ccb_h.retry_count > 1) 1106 && ((err_action & SS_MASK) != SS_FAIL)) { 1107 1108 /* 1109 * In this case, the error recovery 1110 * command failed, but we've got 1111 * some retries left on it. Give 1112 * it another try unless this is an 1113 * unretryable error. 1114 */ 1115 1116 /* set the timeout to .5 sec */ 1117 relsim_flags = 1118 RELSIM_RELEASE_AFTER_TIMEOUT; 1119 timeout = 500; 1120 1121 xpt_action(done_ccb); 1122 1123 break; 1124 1125 } else { 1126 /* 1127 * Perform the final retry with the original 1128 * CCB so that final error processing is 1129 * performed by the owner of the CCB. 1130 */ 1131 bcopy(done_ccb->ccb_h.saved_ccb_ptr, 1132 done_ccb, sizeof(union ccb)); 1133 1134 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG; 1135 1136 xpt_action(done_ccb); 1137 } 1138 } else { 1139 /* 1140 * Eh?? The command failed, but we don't 1141 * have any sense. What's up with that? 1142 * Fire the CCB again to return it to the 1143 * caller. 1144 */ 1145 bcopy(done_ccb->ccb_h.saved_ccb_ptr, 1146 done_ccb, sizeof(union ccb)); 1147 1148 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG; 1149 1150 xpt_action(done_ccb); 1151 1152 } 1153 break; 1154 default: 1155 bcopy(done_ccb->ccb_h.saved_ccb_ptr, done_ccb, 1156 sizeof(union ccb)); 1157 1158 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG; 1159 1160 xpt_action(done_ccb); 1161 1162 break; 1163 } 1164 1165 /* decrement the retry count */ 1166 /* 1167 * XXX This isn't appropriate in all cases. Restructure, 1168 * so that the retry count is only decremented on an 1169 * actual retry. Remeber that the orignal ccb had its 1170 * retry count dropped before entering recovery, so 1171 * doing it again is a bug. 1172 */ 1173 if (done_ccb->ccb_h.retry_count > 0) 1174 done_ccb->ccb_h.retry_count--; 1175 1176 qfrozen_cnt = cam_release_devq(done_ccb->ccb_h.path, 1177 /*relsim_flags*/relsim_flags, 1178 /*openings*/0, 1179 /*timeout*/timeout, 1180 /*getcount_only*/0); 1181 if (xpt_done_ccb == TRUE) 1182 (*done_ccb->ccb_h.cbfcnp)(periph, done_ccb); 1183} 1184 1185/* 1186 * Generic Async Event handler. Peripheral drivers usually 1187 * filter out the events that require personal attention, 1188 * and leave the rest to this function. 1189 */ 1190void 1191cam_periph_async(struct cam_periph *periph, u_int32_t code, 1192 struct cam_path *path, void *arg) 1193{ 1194 switch (code) { 1195 case AC_LOST_DEVICE: 1196 cam_periph_invalidate(periph); 1197 break; 1198 case AC_SENT_BDR: 1199 case AC_BUS_RESET: 1200 { 1201 cam_periph_bus_settle(periph, scsi_delay); 1202 break; 1203 } 1204 default: 1205 break; 1206 } 1207} 1208 1209void 1210cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle) 1211{ 1212 struct ccb_getdevstats cgds; 1213 1214 xpt_setup_ccb(&cgds.ccb_h, periph->path, CAM_PRIORITY_NORMAL); 1215 cgds.ccb_h.func_code = XPT_GDEV_STATS; 1216 xpt_action((union ccb *)&cgds); 1217 cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle); 1218} 1219 1220void 1221cam_periph_freeze_after_event(struct cam_periph *periph, 1222 struct timeval* event_time, u_int duration_ms) 1223{ 1224 struct timeval delta; 1225 struct timeval duration_tv; 1226 1227 microtime(&delta); 1228 timevalsub(&delta, event_time); 1229 duration_tv.tv_sec = duration_ms / 1000; 1230 duration_tv.tv_usec = (duration_ms % 1000) * 1000; 1231 if (timevalcmp(&delta, &duration_tv, <)) { 1232 timevalsub(&duration_tv, &delta); 1233 1234 duration_ms = duration_tv.tv_sec * 1000; 1235 duration_ms += duration_tv.tv_usec / 1000; 1236 cam_freeze_devq(periph->path); 1237 cam_release_devq(periph->path, 1238 RELSIM_RELEASE_AFTER_TIMEOUT, 1239 /*reduction*/0, 1240 /*timeout*/duration_ms, 1241 /*getcount_only*/0); 1242 } 1243 1244} 1245 1246static int 1247camperiphscsistatuserror(union ccb *ccb, cam_flags camflags, 1248 u_int32_t sense_flags, union ccb *save_ccb, 1249 int *openings, u_int32_t *relsim_flags, 1250 u_int32_t *timeout) 1251{ 1252 int error; 1253 1254 switch (ccb->csio.scsi_status) { 1255 case SCSI_STATUS_OK: 1256 case SCSI_STATUS_COND_MET: 1257 case SCSI_STATUS_INTERMED: 1258 case SCSI_STATUS_INTERMED_COND_MET: 1259 error = 0; 1260 break; 1261 case SCSI_STATUS_CMD_TERMINATED: 1262 case SCSI_STATUS_CHECK_COND: 1263 error = camperiphscsisenseerror(ccb, 1264 camflags, 1265 sense_flags, 1266 save_ccb, 1267 openings, 1268 relsim_flags, 1269 timeout); 1270 break; 1271 case SCSI_STATUS_QUEUE_FULL: 1272 { 1273 /* no decrement */ 1274 struct ccb_getdevstats cgds; 1275 1276 /* 1277 * First off, find out what the current 1278 * transaction counts are. 1279 */ 1280 xpt_setup_ccb(&cgds.ccb_h, 1281 ccb->ccb_h.path, 1282 CAM_PRIORITY_NORMAL); 1283 cgds.ccb_h.func_code = XPT_GDEV_STATS; 1284 xpt_action((union ccb *)&cgds); 1285 1286 /* 1287 * If we were the only transaction active, treat 1288 * the QUEUE FULL as if it were a BUSY condition. 1289 */ 1290 if (cgds.dev_active != 0) { 1291 int total_openings; 1292 1293 /* 1294 * Reduce the number of openings to 1295 * be 1 less than the amount it took 1296 * to get a queue full bounded by the 1297 * minimum allowed tag count for this 1298 * device. 1299 */ 1300 total_openings = cgds.dev_active + cgds.dev_openings; 1301 *openings = cgds.dev_active; 1302 if (*openings < cgds.mintags) 1303 *openings = cgds.mintags; 1304 if (*openings < total_openings) 1305 *relsim_flags = RELSIM_ADJUST_OPENINGS; 1306 else { 1307 /* 1308 * Some devices report queue full for 1309 * temporary resource shortages. For 1310 * this reason, we allow a minimum 1311 * tag count to be entered via a 1312 * quirk entry to prevent the queue 1313 * count on these devices from falling 1314 * to a pessimisticly low value. We 1315 * still wait for the next successful 1316 * completion, however, before queueing 1317 * more transactions to the device. 1318 */ 1319 *relsim_flags = RELSIM_RELEASE_AFTER_CMDCMPLT; 1320 } 1321 *timeout = 0; 1322 error = ERESTART; 1323 if (bootverbose) { 1324 xpt_print(ccb->ccb_h.path, "Queue Full\n"); 1325 } 1326 break; 1327 } 1328 /* FALLTHROUGH */ 1329 } 1330 case SCSI_STATUS_BUSY: 1331 /* 1332 * Restart the queue after either another 1333 * command completes or a 1 second timeout. 1334 */ 1335 if (bootverbose) { 1336 xpt_print(ccb->ccb_h.path, "Device Busy\n"); 1337 } 1338 if (ccb->ccb_h.retry_count > 0) { 1339 ccb->ccb_h.retry_count--; 1340 error = ERESTART; 1341 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT 1342 | RELSIM_RELEASE_AFTER_CMDCMPLT; 1343 *timeout = 1000; 1344 } else { 1345 error = EIO; 1346 } 1347 break; 1348 case SCSI_STATUS_RESERV_CONFLICT: 1349 xpt_print(ccb->ccb_h.path, "Reservation Conflict\n"); 1350 error = EIO; 1351 break; 1352 default: 1353 xpt_print(ccb->ccb_h.path, "SCSI Status 0x%x\n", 1354 ccb->csio.scsi_status); 1355 error = EIO; 1356 break; 1357 } 1358 return (error); 1359} 1360 1361static int 1362camperiphscsisenseerror(union ccb *ccb, cam_flags camflags, 1363 u_int32_t sense_flags, union ccb *save_ccb, 1364 int *openings, u_int32_t *relsim_flags, 1365 u_int32_t *timeout) 1366{ 1367 struct cam_periph *periph; 1368 int error; 1369 1370 periph = xpt_path_periph(ccb->ccb_h.path); 1371 if (periph->flags & CAM_PERIPH_RECOVERY_INPROG) { 1372 1373 /* 1374 * If error recovery is already in progress, don't attempt 1375 * to process this error, but requeue it unconditionally 1376 * and attempt to process it once error recovery has 1377 * completed. This failed command is probably related to 1378 * the error that caused the currently active error recovery 1379 * action so our current recovery efforts should also 1380 * address this command. Be aware that the error recovery 1381 * code assumes that only one recovery action is in progress 1382 * on a particular peripheral instance at any given time 1383 * (e.g. only one saved CCB for error recovery) so it is 1384 * imperitive that we don't violate this assumption. 1385 */ 1386 error = ERESTART; 1387 } else { 1388 scsi_sense_action err_action; 1389 struct ccb_getdev cgd; 1390 const char *action_string; 1391 union ccb* print_ccb; 1392 1393 /* A description of the error recovery action performed */ 1394 action_string = NULL; 1395 1396 /* 1397 * The location of the orignal ccb 1398 * for sense printing purposes. 1399 */ 1400 print_ccb = ccb; 1401 1402 /* 1403 * Grab the inquiry data for this device. 1404 */ 1405 xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path, CAM_PRIORITY_NORMAL); 1406 cgd.ccb_h.func_code = XPT_GDEV_TYPE; 1407 xpt_action((union ccb *)&cgd); 1408 1409 if ((ccb->ccb_h.status & CAM_AUTOSNS_VALID) != 0) 1410 err_action = scsi_error_action(&ccb->csio, 1411 &cgd.inq_data, 1412 sense_flags); 1413 else if ((ccb->ccb_h.flags & CAM_DIS_AUTOSENSE) == 0) 1414 err_action = SS_REQSENSE; 1415 else 1416 err_action = SS_RETRY|SSQ_DECREMENT_COUNT|EIO; 1417 1418 error = err_action & SS_ERRMASK; 1419 1420 /* 1421 * If the recovery action will consume a retry, 1422 * make sure we actually have retries available. 1423 */ 1424 if ((err_action & SSQ_DECREMENT_COUNT) != 0) { 1425 if (ccb->ccb_h.retry_count > 0) 1426 ccb->ccb_h.retry_count--; 1427 else { 1428 action_string = "Retries Exhausted"; 1429 goto sense_error_done; 1430 } 1431 } 1432 1433 if ((err_action & SS_MASK) >= SS_START) { 1434 /* 1435 * Do common portions of commands that 1436 * use recovery CCBs. 1437 */ 1438 if (save_ccb == NULL) { 1439 action_string = "No recovery CCB supplied"; 1440 goto sense_error_done; 1441 } 1442 bcopy(ccb, save_ccb, sizeof(*save_ccb)); 1443 print_ccb = save_ccb; 1444 periph->flags |= CAM_PERIPH_RECOVERY_INPROG; 1445 } 1446 1447 switch (err_action & SS_MASK) { 1448 case SS_NOP: 1449 action_string = "No Recovery Action Needed"; 1450 error = 0; 1451 break; 1452 case SS_RETRY: 1453 action_string = "Retrying Command (per Sense Data)"; 1454 error = ERESTART; 1455 break; 1456 case SS_FAIL: 1457 action_string = "Unretryable error"; 1458 break; 1459 case SS_START: 1460 { 1461 int le; 1462 1463 /* 1464 * Send a start unit command to the device, and 1465 * then retry the command. 1466 */ 1467 action_string = "Attempting to Start Unit"; 1468 1469 /* 1470 * Check for removable media and set 1471 * load/eject flag appropriately. 1472 */ 1473 if (SID_IS_REMOVABLE(&cgd.inq_data)) 1474 le = TRUE; 1475 else 1476 le = FALSE; 1477 1478 scsi_start_stop(&ccb->csio, 1479 /*retries*/1, 1480 camperiphdone, 1481 MSG_SIMPLE_Q_TAG, 1482 /*start*/TRUE, 1483 /*load/eject*/le, 1484 /*immediate*/FALSE, 1485 SSD_FULL_SIZE, 1486 /*timeout*/50000); 1487 break; 1488 } 1489 case SS_TUR: 1490 { 1491 /* 1492 * Send a Test Unit Ready to the device. 1493 * If the 'many' flag is set, we send 120 1494 * test unit ready commands, one every half 1495 * second. Otherwise, we just send one TUR. 1496 * We only want to do this if the retry 1497 * count has not been exhausted. 1498 */ 1499 int retries; 1500 1501 if ((err_action & SSQ_MANY) != 0) { 1502 action_string = "Polling device for readiness"; 1503 retries = 120; 1504 } else { 1505 action_string = "Testing device for readiness"; 1506 retries = 1; 1507 } 1508 scsi_test_unit_ready(&ccb->csio, 1509 retries, 1510 camperiphdone, 1511 MSG_SIMPLE_Q_TAG, 1512 SSD_FULL_SIZE, 1513 /*timeout*/5000); 1514 1515 /* 1516 * Accomplish our 500ms delay by deferring 1517 * the release of our device queue appropriately. 1518 */ 1519 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT; 1520 *timeout = 500; 1521 break; 1522 } 1523 case SS_REQSENSE: 1524 { 1525 /* 1526 * Send a Request Sense to the device. We 1527 * assume that we are in a contingent allegiance 1528 * condition so we do not tag this request. 1529 */ 1530 scsi_request_sense(&ccb->csio, /*retries*/1, 1531 camperiphdone, 1532 &save_ccb->csio.sense_data, 1533 sizeof(save_ccb->csio.sense_data), 1534 CAM_TAG_ACTION_NONE, 1535 /*sense_len*/SSD_FULL_SIZE, 1536 /*timeout*/5000); 1537 break; 1538 } 1539 default: 1540 panic("Unhandled error action %x", err_action); 1541 } 1542 1543 if ((err_action & SS_MASK) >= SS_START) { 1544 /* 1545 * Drop the priority, so that the recovery 1546 * CCB is the first to execute. Freeze the queue 1547 * after this command is sent so that we can 1548 * restore the old csio and have it queued in 1549 * the proper order before we release normal 1550 * transactions to the device. 1551 */ 1552 ccb->ccb_h.pinfo.priority = CAM_PRIORITY_DEV; 1553 ccb->ccb_h.flags |= CAM_DEV_QFREEZE; 1554 ccb->ccb_h.saved_ccb_ptr = save_ccb; 1555 error = ERESTART; 1556 } 1557 1558sense_error_done: 1559 if ((err_action & SSQ_PRINT_SENSE) != 0 1560 && (ccb->ccb_h.status & CAM_AUTOSNS_VALID) != 0) { 1561 cam_error_print(print_ccb, CAM_ESF_ALL, CAM_EPF_ALL); 1562 xpt_print_path(ccb->ccb_h.path); 1563 if (bootverbose) 1564 scsi_sense_print(&print_ccb->csio); 1565 printf("%s\n", action_string); 1566 } 1567 } 1568 return (error); 1569} 1570 1571/* 1572 * Generic error handler. Peripheral drivers usually filter 1573 * out the errors that they handle in a unique mannor, then 1574 * call this function. 1575 */ 1576int 1577cam_periph_error(union ccb *ccb, cam_flags camflags, 1578 u_int32_t sense_flags, union ccb *save_ccb) 1579{ 1580 const char *action_string; 1581 cam_status status; 1582 int frozen; 1583 int error, printed = 0; 1584 int openings; 1585 u_int32_t relsim_flags; 1586 u_int32_t timeout = 0; 1587 1588 action_string = NULL; 1589 status = ccb->ccb_h.status; 1590 frozen = (status & CAM_DEV_QFRZN) != 0; 1591 status &= CAM_STATUS_MASK; 1592 openings = relsim_flags = 0; 1593 1594 switch (status) { 1595 case CAM_REQ_CMP: 1596 error = 0; 1597 break; 1598 case CAM_SCSI_STATUS_ERROR: 1599 error = camperiphscsistatuserror(ccb, 1600 camflags, 1601 sense_flags, 1602 save_ccb, 1603 &openings, 1604 &relsim_flags, 1605 &timeout); 1606 break; 1607 case CAM_AUTOSENSE_FAIL: 1608 xpt_print(ccb->ccb_h.path, "AutoSense Failed\n"); 1609 error = EIO; /* we have to kill the command */ 1610 break; 1611 case CAM_ATA_STATUS_ERROR: 1612 if (bootverbose && printed == 0) { 1613 xpt_print(ccb->ccb_h.path, 1614 "Request completed with CAM_ATA_STATUS_ERROR\n"); 1615 printed++; 1616 } 1617 /* FALLTHROUGH */ 1618 case CAM_REQ_CMP_ERR: 1619 if (bootverbose && printed == 0) { 1620 xpt_print(ccb->ccb_h.path, 1621 "Request completed with CAM_REQ_CMP_ERR\n"); 1622 printed++; 1623 } 1624 /* FALLTHROUGH */ 1625 case CAM_CMD_TIMEOUT: 1626 if (bootverbose && printed == 0) { 1627 xpt_print(ccb->ccb_h.path, "Command timed out\n"); 1628 printed++; 1629 } 1630 /* FALLTHROUGH */ 1631 case CAM_UNEXP_BUSFREE: 1632 if (bootverbose && printed == 0) { 1633 xpt_print(ccb->ccb_h.path, "Unexpected Bus Free\n"); 1634 printed++; 1635 } 1636 /* FALLTHROUGH */ 1637 case CAM_UNCOR_PARITY: 1638 if (bootverbose && printed == 0) { 1639 xpt_print(ccb->ccb_h.path, 1640 "Uncorrected Parity Error\n"); 1641 printed++; 1642 } 1643 /* FALLTHROUGH */ 1644 case CAM_DATA_RUN_ERR: 1645 if (bootverbose && printed == 0) { 1646 xpt_print(ccb->ccb_h.path, "Data Overrun\n"); 1647 printed++; 1648 } 1649 error = EIO; /* we have to kill the command */ 1650 /* decrement the number of retries */ 1651 if (ccb->ccb_h.retry_count > 0) { 1652 ccb->ccb_h.retry_count--; 1653 error = ERESTART; 1654 } else { 1655 action_string = "Retries Exhausted"; 1656 error = EIO; 1657 } 1658 break; 1659 case CAM_UA_ABORT: 1660 case CAM_UA_TERMIO: 1661 case CAM_MSG_REJECT_REC: 1662 /* XXX Don't know that these are correct */ 1663 error = EIO; 1664 break; 1665 case CAM_SEL_TIMEOUT: 1666 { 1667 struct cam_path *newpath; 1668 1669 if ((camflags & CAM_RETRY_SELTO) != 0) { 1670 if (ccb->ccb_h.retry_count > 0) { 1671 1672 ccb->ccb_h.retry_count--; 1673 error = ERESTART; 1674 if (bootverbose && printed == 0) { 1675 xpt_print(ccb->ccb_h.path, 1676 "Selection Timeout\n"); 1677 printed++; 1678 } 1679 1680 /* 1681 * Wait a bit to give the device 1682 * time to recover before we try again. 1683 */ 1684 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT; 1685 timeout = periph_selto_delay; 1686 break; 1687 } 1688 } 1689 error = ENXIO; 1690 /* Should we do more if we can't create the path?? */ 1691 if (xpt_create_path(&newpath, xpt_path_periph(ccb->ccb_h.path), 1692 xpt_path_path_id(ccb->ccb_h.path), 1693 xpt_path_target_id(ccb->ccb_h.path), 1694 CAM_LUN_WILDCARD) != CAM_REQ_CMP) 1695 break; 1696 1697 /* 1698 * Let peripheral drivers know that this device has gone 1699 * away. 1700 */ 1701 xpt_async(AC_LOST_DEVICE, newpath, NULL); 1702 xpt_free_path(newpath); 1703 break; 1704 } 1705 case CAM_REQ_INVALID: 1706 case CAM_PATH_INVALID: 1707 case CAM_DEV_NOT_THERE: 1708 case CAM_NO_HBA: 1709 case CAM_PROVIDE_FAIL: 1710 case CAM_REQ_TOO_BIG: 1711 case CAM_LUN_INVALID: 1712 case CAM_TID_INVALID: 1713 error = EINVAL; 1714 break; 1715 case CAM_SCSI_BUS_RESET: 1716 case CAM_BDR_SENT: 1717 /* 1718 * Commands that repeatedly timeout and cause these 1719 * kinds of error recovery actions, should return 1720 * CAM_CMD_TIMEOUT, which allows us to safely assume 1721 * that this command was an innocent bystander to 1722 * these events and should be unconditionally 1723 * retried. 1724 */ 1725 if (bootverbose && printed == 0) { 1726 xpt_print_path(ccb->ccb_h.path); 1727 if (status == CAM_BDR_SENT) 1728 printf("Bus Device Reset sent\n"); 1729 else 1730 printf("Bus Reset issued\n"); 1731 printed++; 1732 } 1733 /* FALLTHROUGH */ 1734 case CAM_REQUEUE_REQ: 1735 /* Unconditional requeue */ 1736 error = ERESTART; 1737 if (bootverbose && printed == 0) { 1738 xpt_print(ccb->ccb_h.path, "Request Requeued\n"); 1739 printed++; 1740 } 1741 break; 1742 case CAM_RESRC_UNAVAIL: 1743 /* Wait a bit for the resource shortage to abate. */ 1744 timeout = periph_noresrc_delay; 1745 /* FALLTHROUGH */ 1746 case CAM_BUSY: 1747 if (timeout == 0) { 1748 /* Wait a bit for the busy condition to abate. */ 1749 timeout = periph_busy_delay; 1750 } 1751 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT; 1752 /* FALLTHROUGH */ 1753 default: 1754 /* decrement the number of retries */ 1755 if (ccb->ccb_h.retry_count > 0) { 1756 ccb->ccb_h.retry_count--; 1757 error = ERESTART; 1758 if (bootverbose && printed == 0) { 1759 xpt_print(ccb->ccb_h.path, "CAM Status 0x%x\n", 1760 status); 1761 printed++; 1762 } 1763 } else { 1764 error = EIO; 1765 action_string = "Retries Exhausted"; 1766 } 1767 break; 1768 } 1769 1770 /* 1771 * If we have and error and are booting verbosely, whine 1772 * *unless* this was a non-retryable selection timeout. 1773 */ 1774 if (error != 0 && bootverbose && 1775 !(status == CAM_SEL_TIMEOUT && (camflags & CAM_RETRY_SELTO) == 0)) { 1776 if (error != ERESTART) { 1777 if (action_string == NULL) 1778 action_string = "Unretryable Error"; 1779 xpt_print(ccb->ccb_h.path, "error %d\n", error); 1780 xpt_print(ccb->ccb_h.path, "%s\n", action_string); 1781 } else 1782 xpt_print(ccb->ccb_h.path, "Retrying Command\n"); 1783 } 1784 1785 /* Attempt a retry */ 1786 if (error == ERESTART || error == 0) { 1787 if (frozen != 0) 1788 ccb->ccb_h.status &= ~CAM_DEV_QFRZN; 1789 if (error == ERESTART) 1790 xpt_action(ccb); 1791 if (frozen != 0) 1792 cam_release_devq(ccb->ccb_h.path, 1793 relsim_flags, 1794 openings, 1795 timeout, 1796 /*getcount_only*/0); 1797 } 1798 1799 return (error); 1800} 1801