sys/bus/cam/cam_periph.c

   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  * $FreeBSD: src/sys/cam/cam_periph.c,v 1.24.2.3 2003/01/25 19:04:40 dillon Exp $
  30  * $DragonFly: src/sys/bus/cam/cam_periph.c,v 1.9 2005/03/15 20:42:12 dillon Exp $
  31  */
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/types.h>
  36 #include <sys/malloc.h>
  37 #include <sys/linker_set.h>
  38 #include <sys/buf.h>
  39 #include <sys/proc.h>
  40 #include <sys/devicestat.h>
  41 #include <sys/bus.h>
  42 #include <vm/vm.h>
  43 #include <vm/vm_extern.h>
  44
  45 #include "cam.h"
  46 #include "cam_ccb.h"
  47 #include "cam_xpt_periph.h"
  48 #include "cam_periph.h"
  49 #include "cam_debug.h"
  50
  51 #include <bus/cam/scsi/scsi_all.h>
  52 #include <bus/cam/scsi/scsi_message.h>
  53 #include <bus/cam/scsi/scsi_da.h>
  54 #include <bus/cam/scsi/scsi_pass.h>
  55
  56 static  u_int           camperiphnextunit(struct periph_driver *p_drv,
  57                                           u_int newunit, int wired,
  58                                           path_id_t pathid, target_id_t target,
  59                                           lun_id_t lun);
  60 static  u_int           camperiphunit(struct periph_driver *p_drv,
  61                                       path_id_t pathid, target_id_t target,
  62                                       lun_id_t lun);
  63 static  void            camperiphdone(struct cam_periph *periph,
  64                                         union ccb *done_ccb);
  65 static  void            camperiphfree(struct cam_periph *periph);
  66
  67 cam_status
  68 cam_periph_alloc(periph_ctor_t *periph_ctor,
  69                  periph_oninv_t *periph_oninvalidate,
  70                  periph_dtor_t *periph_dtor, periph_start_t *periph_start,
  71                  char *name, cam_periph_type type, struct cam_path *path,
  72                  ac_callback_t *ac_callback, ac_code code, void *arg)
  73 {
  74         struct          periph_driver **p_drv;
  75         struct          cam_periph *periph;
  76         struct          cam_periph *cur_periph;
  77         path_id_t       path_id;
  78         target_id_t     target_id;
  79         lun_id_t        lun_id;
  80         cam_status      status;
  81         u_int           init_level;
  82         int s;
  83
  84         init_level = 0;
  85         /*
  86          * Handle Hot-Plug scenarios.  If there is already a peripheral
  87          * of our type assigned to this path, we are likely waiting for
  88          * final close on an old, invalidated, peripheral.  If this is
  89          * the case, queue up a deferred call to the peripheral's async
  90          * handler.  If it looks like a mistaken re-alloation, complain.
  91          */
  92         if ((periph = cam_periph_find(path, name)) != NULL) {
  93
  94                 if ((periph->flags & CAM_PERIPH_INVALID) != 0
  95                  && (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) == 0) {
  96                         periph->flags |= CAM_PERIPH_NEW_DEV_FOUND;
  97                         periph->deferred_callback = ac_callback;
  98                         periph->deferred_ac = code;
  99                         return (CAM_REQ_INPROG);
 100                 } else {
 101                         printf("cam_periph_alloc: attempt to re-allocate "
 102                                "valid device %s%d rejected\n",
 103                                periph->periph_name, periph->unit_number);
 104                 }
 105                 return (CAM_REQ_INVALID);
 106         }
 107
 108         periph = malloc(sizeof(*periph), M_DEVBUF, M_INTWAIT);
 109
 110         init_level++;
 111
 112         SET_FOREACH(p_drv, periphdriver_set) {
 113                 if (strcmp((*p_drv)->driver_name, name) == 0)
 114                         break;
 115         }
 116
 117         path_id = xpt_path_path_id(path);
 118         target_id = xpt_path_target_id(path);
 119         lun_id = xpt_path_lun_id(path);
 120         bzero(periph, sizeof(*periph));
 121         cam_init_pinfo(&periph->pinfo);
 122         periph->periph_start = periph_start;
 123         periph->periph_dtor = periph_dtor;
 124         periph->periph_oninval = periph_oninvalidate;
 125         periph->type = type;
 126         periph->periph_name = name;
 127         periph->unit_number = camperiphunit(*p_drv, path_id, target_id, lun_id);
 128         periph->immediate_priority = CAM_PRIORITY_NONE;
 129         periph->refcount = 0;
 130         SLIST_INIT(&periph->ccb_list);
 131         status = xpt_create_path(&path, periph, path_id, target_id, lun_id);
 132         if (status != CAM_REQ_CMP)
 133                 goto failure;
 134
 135         periph->path = path;
 136         init_level++;
 137
 138         status = xpt_add_periph(periph);
 139
 140         if (status != CAM_REQ_CMP)
 141                 goto failure;
 142
 143         s = splsoftcam();
 144         cur_periph = TAILQ_FIRST(&(*p_drv)->units);
 145         while (cur_periph != NULL
 146             && cur_periph->unit_number < periph->unit_number)
 147                 cur_periph = TAILQ_NEXT(cur_periph, unit_links);
 148
 149         if (cur_periph != NULL)
 150                 TAILQ_INSERT_BEFORE(cur_periph, periph, unit_links);
 151         else {
 152                 TAILQ_INSERT_TAIL(&(*p_drv)->units, periph, unit_links);
 153                 (*p_drv)->generation++;
 154         }
 155
 156         splx(s);
 157
 158         init_level++;
 159
 160         status = periph_ctor(periph, arg);
 161
 162         if (status == CAM_REQ_CMP)
 163                 init_level++;
 164
 165 failure:
 166         switch (init_level) {
 167         case 4:
 168                 /* Initialized successfully */
 169                 break;
 170         case 3:
 171                 s = splsoftcam();
 172                 TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
 173                 splx(s);
 174                 xpt_remove_periph(periph);
 175         case 2:
 176                 xpt_free_path(periph->path);
 177         case 1:
 178                 free(periph, M_DEVBUF);
 179         case 0:
 180                 /* No cleanup to perform. */
 181                 break;
 182         default:
 183                 panic("cam_periph_alloc: Unkown init level");
 184         }
 185         return(status);
 186 }
 187
 188 /*
 189  * Find a peripheral structure with the specified path, target, lun,
 190  * and (optionally) type.  If the name is NULL, this function will return
 191  * the first peripheral driver that matches the specified path.
 192  */
 193 struct cam_periph *
 194 cam_periph_find(struct cam_path *path, char *name)
 195 {
 196         struct periph_driver **p_drv;
 197         struct cam_periph *periph;
 198         int s;
 199
 200         SET_FOREACH(p_drv, periphdriver_set) {
 201                 if (name != NULL && (strcmp((*p_drv)->driver_name, name) != 0))
 202                         continue;
 203
 204                 s = splsoftcam();
 205                 for (periph = TAILQ_FIRST(&(*p_drv)->units); periph != NULL;
 206                      periph = TAILQ_NEXT(periph, unit_links)) {
 207                         if (xpt_path_comp(periph->path, path) == 0) {
 208                                 splx(s);
 209                                 return(periph);
 210                         }
 211                 }
 212                 splx(s);
 213                 if (name != NULL)
 214                         return(NULL);
 215         }
 216         return(NULL);
 217 }
 218
 219 cam_status
 220 cam_periph_acquire(struct cam_periph *periph)
 221 {
 222         int s;
 223
 224         if (periph == NULL)
 225                 return(CAM_REQ_CMP_ERR);
 226
 227         s = splsoftcam();
 228         periph->refcount++;
 229         splx(s);
 230
 231         return(CAM_REQ_CMP);
 232 }
 233
 234 void
 235 cam_periph_release(struct cam_periph *periph)
 236 {
 237         int s;
 238
 239         if (periph == NULL)
 240                 return;
 241
 242         s = splsoftcam();
 243         if ((--periph->refcount == 0)
 244          && (periph->flags & CAM_PERIPH_INVALID)) {
 245                 camperiphfree(periph);
 246         }
 247         splx(s);
 248
 249 }
 250
 251 /*
 252  * Look for the next unit number that is not currently in use for this
 253  * peripheral type starting at "newunit".  Also exclude unit numbers that
 254  * are reserved by for future "hardwiring" unless we already know that this
 255  * is a potential wired device.  Only assume that the device is "wired" the
 256  * first time through the loop since after that we'll be looking at unit
 257  * numbers that did not match a wiring entry.
 258  */
 259 static u_int
 260 camperiphnextunit(struct periph_driver *p_drv, u_int newunit, int wired,
 261                   path_id_t pathid, target_id_t target, lun_id_t lun)
 262 {
 263         struct  cam_periph *periph;
 264         char    *periph_name, *strval;
 265         int     s;
 266         int     i, val, dunit;
 267         const char *dname;
 268
 269         s = splsoftcam();
 270         periph_name = p_drv->driver_name;
 271         for (;;newunit++) {
 272
 273                 for (periph = TAILQ_FIRST(&p_drv->units);
 274                      periph != NULL && periph->unit_number != newunit;
 275                      periph = TAILQ_NEXT(periph, unit_links))
 276                         ;
 277
 278                 if (periph != NULL && periph->unit_number == newunit) {
 279                         if (wired != 0) {
 280                                 xpt_print_path(periph->path);
 281                                 printf("Duplicate Wired Device entry!\n");
 282                                 xpt_print_path(periph->path);
 283                                 printf("Second device (%s device at scbus%d "
 284                                        "target %d lun %d) will not be wired\n",
 285                                        periph_name, pathid, target, lun);
 286                                 wired = 0;
 287                         }
 288                         continue;
 289                 }
 290                 if (wired)
 291                         break;
 292
 293                 /*
 294                  * Don't match entries like "da 4" as a wired down
 295                  * device, but do match entries like "da 4 target 5"
 296                  * or even "da 4 scbus 1".
 297                  */
 298                 i = -1;
 299                 while ((i = resource_locate(i, periph_name)) != -1) {
 300                         dname = resource_query_name(i);
 301                         dunit = resource_query_unit(i);
 302                         /* if no "target" and no specific scbus, skip */
 303                         if (resource_int_value(dname, dunit, "target", &val) &&
 304                             (resource_string_value(dname, dunit, "at",&strval)||
 305                              strcmp(strval, "scbus") == 0))
 306                                 continue;
 307                         if (newunit == dunit)
 308                                 break;
 309                 }
 310                 if (i == -1)
 311                         break;
 312         }
 313         splx(s);
 314         return (newunit);
 315 }
 316
 317 static u_int
 318 camperiphunit(struct periph_driver *p_drv, path_id_t pathid,
 319               target_id_t target, lun_id_t lun)
 320 {
 321         u_int   unit;
 322         int     hit, i, val, dunit;
 323         const char *dname;
 324         char    pathbuf[32], *strval, *periph_name;
 325
 326         unit = 0;
 327
 328         periph_name = p_drv->driver_name;
 329         snprintf(pathbuf, sizeof(pathbuf), "scbus%d", pathid);
 330         i = -1;
 331         for (hit = 0; (i = resource_locate(i, periph_name)) != -1; hit = 0) {
 332                 dname = resource_query_name(i);
 333                 dunit = resource_query_unit(i);
 334                 if (resource_string_value(dname, dunit, "at", &strval) == 0) {
 335                         if (strcmp(strval, pathbuf) != 0)
 336                                 continue;
 337                         hit++;
 338                 }
 339                 if (resource_int_value(dname, dunit, "target", &val) == 0) {
 340                         if (val != target)
 341                                 continue;
 342                         hit++;
 343                 }
 344                 if (resource_int_value(dname, dunit, "lun", &val) == 0) {
 345                         if (val != lun)
 346                                 continue;
 347                         hit++;
 348                 }
 349                 if (hit != 0) {
 350                         unit = dunit;
 351                         break;
 352                 }
 353         }
 354
 355         /*
 356          * Either start from 0 looking for the next unit or from
 357          * the unit number given in the resource config.  This way,
 358          * if we have wildcard matches, we don't return the same
 359          * unit number twice.
 360          */
 361         unit = camperiphnextunit(p_drv, unit, /*wired*/hit, pathid,
 362                                  target, lun);
 363
 364         return (unit);
 365 }
 366
 367 void
 368 cam_periph_invalidate(struct cam_periph *periph)
 369 {
 370         int s;
 371
 372         s = splsoftcam();
 373         /*
 374          * We only call this routine the first time a peripheral is
 375          * invalidated.  The oninvalidate() routine is always called at
 376          * splsoftcam().
 377          */
 378         if (((periph->flags & CAM_PERIPH_INVALID) == 0)
 379          && (periph->periph_oninval != NULL))
 380                 periph->periph_oninval(periph);
 381
 382         periph->flags |= CAM_PERIPH_INVALID;
 383         periph->flags &= ~CAM_PERIPH_NEW_DEV_FOUND;
 384
 385         if (periph->refcount == 0)
 386                 camperiphfree(periph);
 387         else if (periph->refcount < 0)
 388                 printf("cam_invalidate_periph: refcount < 0!!\n");
 389         splx(s);
 390 }
 391
 392 static void
 393 camperiphfree(struct cam_periph *periph)
 394 {
 395         int s;
 396         struct periph_driver **p_drv;
 397
 398         SET_FOREACH(p_drv, periphdriver_set) {
 399                 if (strcmp((*p_drv)->driver_name, periph->periph_name) == 0)
 400                         break;
 401         }
 402
 403         if (*p_drv == NULL) {
 404                 printf("camperiphfree: attempt to free "
 405                         "non-existant periph: %s\n", periph->periph_name);
 406                 return;
 407         }
 408
 409         if (periph->periph_dtor != NULL)
 410                 periph->periph_dtor(periph);
 411
 412         s = splsoftcam();
 413         TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
 414         (*p_drv)->generation++;
 415         splx(s);
 416
 417         xpt_remove_periph(periph);
 418
 419         if (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) {
 420                 union ccb ccb;
 421                 void *arg;
 422
 423                 switch (periph->deferred_ac) {
 424                 case AC_FOUND_DEVICE:
 425                         ccb.ccb_h.func_code = XPT_GDEV_TYPE;
 426                         xpt_setup_ccb(&ccb.ccb_h, periph->path, /*priority*/ 1);
 427                         xpt_action(&ccb);
 428                         arg = &ccb;
 429                         break;
 430                 case AC_PATH_REGISTERED:
 431                         ccb.ccb_h.func_code = XPT_PATH_INQ;
 432                         xpt_setup_ccb(&ccb.ccb_h, periph->path, /*priority*/ 1);
 433                         xpt_action(&ccb);
 434                         arg = &ccb;
 435                         break;
 436                 default:
 437                         arg = NULL;
 438                         break;
 439                 }
 440                 periph->deferred_callback(NULL, periph->deferred_ac,
 441                                           periph->path, arg);
 442         }
 443         xpt_free_path(periph->path);
 444         free(periph, M_DEVBUF);
 445 }
 446
 447 /*
 448  * Wait interruptibly for an exclusive lock.
 449  */
 450 int
 451 cam_periph_lock(struct cam_periph *periph, int flags)
 452 {
 453         int error;
 454
 455         while ((periph->flags & CAM_PERIPH_LOCKED) != 0) {
 456                 periph->flags |= CAM_PERIPH_LOCK_WANTED;
 457                 if ((error = tsleep(periph, flags, "caplck", 0)) != 0)
 458                         return error;
 459         }
 460
 461         if (cam_periph_acquire(periph) != CAM_REQ_CMP)
 462                 return(ENXIO);
 463
 464         periph->flags |= CAM_PERIPH_LOCKED;
 465         return 0;
 466 }
 467
 468 /*
 469  * Unlock and wake up any waiters.
 470  */
 471 void
 472 cam_periph_unlock(struct cam_periph *periph)
 473 {
 474         periph->flags &= ~CAM_PERIPH_LOCKED;
 475         if ((periph->flags & CAM_PERIPH_LOCK_WANTED) != 0) {
 476                 periph->flags &= ~CAM_PERIPH_LOCK_WANTED;
 477                 wakeup(periph);
 478         }
 479
 480         cam_periph_release(periph);
 481 }
 482
 483 /*
 484  * Map user virtual pointers into kernel virtual address space, so we can
 485  * access the memory.  This won't work on physical pointers, for now it's
 486  * up to the caller to check for that.  (XXX KDM -- should we do that here
 487  * instead?)  This also only works for up to MAXPHYS memory.  Since we use
 488  * buffers to map stuff in and out, we're limited to the buffer size.
 489  */
 490 int
 491 cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
 492 {
 493         int numbufs, i, j;
 494         int flags[CAM_PERIPH_MAXMAPS];
 495         u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
 496         u_int32_t lengths[CAM_PERIPH_MAXMAPS];
 497         u_int32_t dirs[CAM_PERIPH_MAXMAPS];
 498
 499         switch(ccb->ccb_h.func_code) {
 500         case XPT_DEV_MATCH:
 501                 if (ccb->cdm.match_buf_len == 0) {
 502                         printf("cam_periph_mapmem: invalid match buffer "
 503                                "length 0\n");
 504                         return(EINVAL);
 505                 }
 506                 if (ccb->cdm.pattern_buf_len > 0) {
 507                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
 508                         lengths[0] = ccb->cdm.pattern_buf_len;
 509                         dirs[0] = CAM_DIR_OUT;
 510                         data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
 511                         lengths[1] = ccb->cdm.match_buf_len;
 512                         dirs[1] = CAM_DIR_IN;
 513                         numbufs = 2;
 514                 } else {
 515                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
 516                         lengths[0] = ccb->cdm.match_buf_len;
 517                         dirs[0] = CAM_DIR_IN;
 518                         numbufs = 1;
 519                 }
 520                 break;
 521         case XPT_SCSI_IO:
 522         case XPT_CONT_TARGET_IO:
 523                 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
 524                         return(0);
 525
 526                 data_ptrs[0] = &ccb->csio.data_ptr;
 527                 lengths[0] = ccb->csio.dxfer_len;
 528                 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
 529                 numbufs = 1;
 530                 break;
 531         default:
 532                 return(EINVAL);
 533                 break; /* NOTREACHED */
 534         }
 535
 536         /*
 537          * Check the transfer length and permissions first, so we don't
 538          * have to unmap any previously mapped buffers.
 539          */
 540         for (i = 0; i < numbufs; i++) {
 541
 542                 flags[i] = 0;
 543
 544                 /*
 545                  * The userland data pointer passed in may not be page
 546                  * aligned.  vmapbuf() truncates the address to a page
 547                  * boundary, so if the address isn't page aligned, we'll
 548                  * need enough space for the given transfer length, plus
 549                  * whatever extra space is necessary to make it to the page
 550                  * boundary.
 551                  */
 552                 if ((lengths[i] +
 553                     (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)) > DFLTPHYS){
 554                         printf("cam_periph_mapmem: attempt to map %lu bytes, "
 555                                "which is greater than DFLTPHYS(%d)\n",
 556                                (long)(lengths[i] +
 557                                (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)),
 558                                DFLTPHYS);
 559                         return(E2BIG);
 560                 }
 561
 562                 if (dirs[i] & CAM_DIR_OUT) {
 563                         flags[i] = B_WRITE;
 564                         if (!useracc(*data_ptrs[i], lengths[i],
 565                                      VM_PROT_READ)) {
 566                                 printf("cam_periph_mapmem: error, "
 567                                         "address %p, length %lu isn't "
 568                                         "user accessible for READ\n",
 569                                         (void *)*data_ptrs[i],
 570                                         (u_long)lengths[i]);
 571                                 return(EACCES);
 572                         }
 573                 }
 574
 575                 /*
 576                  * XXX this check is really bogus, since B_WRITE currently
 577                  * is all 0's, and so it is "set" all the time.
 578                  */
 579                 if (dirs[i] & CAM_DIR_IN) {
 580                         flags[i] |= B_READ;
 581                         if (!useracc(*data_ptrs[i], lengths[i],
 582                                      VM_PROT_WRITE)) {
 583                                 printf("cam_periph_mapmem: error, "
 584                                         "address %p, length %lu isn't "
 585                                         "user accessible for WRITE\n",
 586                                         (void *)*data_ptrs[i],
 587                                         (u_long)lengths[i]);
 588
 589                                 return(EACCES);
 590                         }
 591                 }
 592
 593         }
 594
 595         for (i = 0; i < numbufs; i++) {
 596                 /*
 597                  * Get the buffer.
 598                  */
 599                 mapinfo->bp[i] = getpbuf(NULL);
 600
 601                 /* save the buffer's data address */
 602                 mapinfo->bp[i]->b_saveaddr = mapinfo->bp[i]->b_data;
 603
 604                 /* put our pointer in the data slot */
 605                 mapinfo->bp[i]->b_data = *data_ptrs[i];
 606
 607                 /* set the transfer length, we know it's < DFLTPHYS */
 608                 mapinfo->bp[i]->b_bufsize = lengths[i];
 609
 610                 /* set the flags */
 611                 mapinfo->bp[i]->b_flags = flags[i] | B_PHYS;
 612
 613                 /* map the buffer into kernel memory */
 614                 if (vmapbuf(mapinfo->bp[i]) < 0) {
 615                         printf("cam_periph_mapmem: error, "
 616                                 "address %p, length %lu isn't "
 617                                 "user accessible any more\n",
 618                                 (void *)*data_ptrs[i],
 619                                 (u_long)lengths[i]);
 620                         for (j = 0; j < i; ++j) {
 621                                 *data_ptrs[j] = mapinfo->bp[j]->b_saveaddr;
 622                                 mapinfo->bp[j]->b_flags &= ~B_PHYS;
 623                                 relpbuf(mapinfo->bp[j], NULL);
 624                         }
 625                         return(EACCES);
 626                 }
 627
 628                 /* set our pointer to the new mapped area */
 629                 *data_ptrs[i] = mapinfo->bp[i]->b_data;
 630
 631                 mapinfo->num_bufs_used++;
 632         }
 633
 634         return(0);
 635 }
 636
 637 /*
 638  * Unmap memory segments mapped into kernel virtual address space by
 639  * cam_periph_mapmem().
 640  */
 641 void
 642 cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
 643 {
 644         int numbufs, i;
 645         u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
 646
 647         if (mapinfo->num_bufs_used <= 0) {
 648                 /* allow ourselves to be swapped once again */
 649                 return;
 650         }
 651
 652         switch (ccb->ccb_h.func_code) {
 653         case XPT_DEV_MATCH:
 654                 numbufs = min(mapinfo->num_bufs_used, 2);
 655
 656                 if (numbufs == 1) {
 657                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
 658                 } else {
 659                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
 660                         data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
 661                 }
 662                 break;
 663         case XPT_SCSI_IO:
 664         case XPT_CONT_TARGET_IO:
 665                 data_ptrs[0] = &ccb->csio.data_ptr;
 666                 numbufs = min(mapinfo->num_bufs_used, 1);
 667                 break;
 668         default:
 669                 /* allow ourselves to be swapped once again */
 670                 return;
 671                 break; /* NOTREACHED */
 672         }
 673
 674         for (i = 0; i < numbufs; i++) {
 675                 /* Set the user's pointer back to the original value */
 676                 *data_ptrs[i] = mapinfo->bp[i]->b_saveaddr;
 677
 678                 /* unmap the buffer */
 679                 vunmapbuf(mapinfo->bp[i]);
 680
 681                 /* clear the flags we set above */
 682                 mapinfo->bp[i]->b_flags &= ~B_PHYS;
 683
 684                 /* release the buffer */
 685                 relpbuf(mapinfo->bp[i], NULL);
 686         }
 687
 688         /* allow ourselves to be swapped once again */
 689 }
 690
 691 union ccb *
 692 cam_periph_getccb(struct cam_periph *periph, u_int32_t priority)
 693 {
 694         struct ccb_hdr *ccb_h;
 695         int s;
 696
 697         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cdgetccb\n"));
 698
 699         s = splsoftcam();
 700
 701         while (periph->ccb_list.slh_first == NULL) {
 702                 if (periph->immediate_priority > priority)
 703                         periph->immediate_priority = priority;
 704                 xpt_schedule(periph, priority);
 705                 if ((periph->ccb_list.slh_first != NULL)
 706                  && (periph->ccb_list.slh_first->pinfo.priority == priority))
 707                         break;
 708                 tsleep(&periph->ccb_list, 0, "cgticb", 0);
 709         }
 710
 711         ccb_h = periph->ccb_list.slh_first;
 712         SLIST_REMOVE_HEAD(&periph->ccb_list, periph_links.sle);
 713         splx(s);
 714         return ((union ccb *)ccb_h);
 715 }
 716
 717 void
 718 cam_periph_ccbwait(union ccb *ccb)
 719 {
 720         int s;
 721
 722         s = splsoftcam();
 723         if ((ccb->ccb_h.pinfo.index != CAM_UNQUEUED_INDEX)
 724          || ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG))
 725                 tsleep(&ccb->ccb_h.cbfcnp, 0, "cbwait", 0);
 726
 727         splx(s);
 728 }
 729
 730 int
 731 cam_periph_ioctl(struct cam_periph *periph, int cmd, caddr_t addr,
 732                  int (*error_routine)(union ccb *ccb,
 733                                       cam_flags camflags,
 734                                       u_int32_t sense_flags))
 735 {
 736         union ccb            *ccb;
 737         int                  error;
 738         int                  found;
 739
 740         error = found = 0;
 741
 742         switch(cmd){
 743         case CAMGETPASSTHRU:
 744                 ccb = cam_periph_getccb(periph, /* priority */ 1);
 745                 xpt_setup_ccb(&ccb->ccb_h,
 746                               ccb->ccb_h.path,
 747                               /*priority*/1);
 748                 ccb->ccb_h.func_code = XPT_GDEVLIST;
 749
 750                 /*
 751                  * Basically, the point of this is that we go through
 752                  * getting the list of devices, until we find a passthrough
 753                  * device.  In the current version of the CAM code, the
 754                  * only way to determine what type of device we're dealing
 755                  * with is by its name.
 756                  */
 757                 while (found == 0) {
 758                         ccb->cgdl.index = 0;
 759                         ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS;
 760                         while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) {
 761
 762                                 /* we want the next device in the list */
 763                                 xpt_action(ccb);
 764                                 if (strncmp(ccb->cgdl.periph_name,
 765                                     "pass", 4) == 0){
 766                                         found = 1;
 767                                         break;
 768                                 }
 769                         }
 770                         if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) &&
 771                             (found == 0)) {
 772                                 ccb->cgdl.periph_name[0] = '\0';
 773                                 ccb->cgdl.unit_number = 0;
 774                                 break;
 775                         }
 776                 }
 777
 778                 /* copy the result back out */
 779                 bcopy(ccb, addr, sizeof(union ccb));
 780
 781                 /* and release the ccb */
 782                 xpt_release_ccb(ccb);
 783
 784                 break;
 785         default:
 786                 error = ENOTTY;
 787                 break;
 788         }
 789         return(error);
 790 }
 791
 792 int
 793 cam_periph_runccb(union ccb *ccb,
 794                   int (*error_routine)(union ccb *ccb,
 795                                        cam_flags camflags,
 796                                        u_int32_t sense_flags),
 797                   cam_flags camflags, u_int32_t sense_flags,
 798                   struct devstat *ds)
 799 {
 800         int error;
 801
 802         error = 0;
 803
 804         /*
 805          * If the user has supplied a stats structure, and if we understand
 806          * this particular type of ccb, record the transaction start.
 807          */
 808         if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO))
 809                 devstat_start_transaction(ds);
 810
 811         xpt_action(ccb);
 812
 813         do {
 814                 cam_periph_ccbwait(ccb);
 815                 if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
 816                         error = 0;
 817                 else if (error_routine != NULL)
 818                         error = (*error_routine)(ccb, camflags, sense_flags);
 819                 else
 820                         error = 0;
 821
 822         } while (error == ERESTART);
 823
 824         if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
 825                 cam_release_devq(ccb->ccb_h.path,
 826                                  /* relsim_flags */0,
 827                                  /* openings */0,
 828                                  /* timeout */0,
 829                                  /* getcount_only */ FALSE);
 830
 831         if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO))
 832                 devstat_end_transaction(ds,
 833                                         ccb->csio.dxfer_len,
 834                                         ccb->csio.tag_action & 0xf,
 835                                         ((ccb->ccb_h.flags & CAM_DIR_MASK) ==
 836                                         CAM_DIR_NONE) ?  DEVSTAT_NO_DATA :
 837                                         (ccb->ccb_h.flags & CAM_DIR_OUT) ?
 838                                         DEVSTAT_WRITE :
 839                                         DEVSTAT_READ);
 840
 841         return(error);
 842 }
 843
 844 void
 845 cam_freeze_devq(struct cam_path *path)
 846 {
 847         struct ccb_hdr ccb_h;
 848
 849         xpt_setup_ccb(&ccb_h, path, /*priority*/1);
 850         ccb_h.func_code = XPT_NOOP;
 851         ccb_h.flags = CAM_DEV_QFREEZE;
 852         xpt_action((union ccb *)&ccb_h);
 853 }
 854
 855 u_int32_t
 856 cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
 857                  u_int32_t openings, u_int32_t timeout,
 858                  int getcount_only)
 859 {
 860         struct ccb_relsim crs;
 861
 862         xpt_setup_ccb(&crs.ccb_h, path,
 863                       /*priority*/1);
 864         crs.ccb_h.func_code = XPT_REL_SIMQ;
 865         crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0;
 866         crs.release_flags = relsim_flags;
 867         crs.openings = openings;
 868         crs.release_timeout = timeout;
 869         xpt_action((union ccb *)&crs);
 870         return (crs.qfrozen_cnt);
 871 }
 872
 873 #define saved_ccb_ptr ppriv_ptr0
 874 static void
 875 camperiphdone(struct cam_periph *periph, union ccb *done_ccb)
 876 {
 877         cam_status      status;
 878         int             frozen;
 879         int             sense;
 880         struct scsi_start_stop_unit *scsi_cmd;
 881         u_int32_t       relsim_flags, timeout;
 882         u_int32_t       qfrozen_cnt;
 883
 884         status = done_ccb->ccb_h.status;
 885         frozen = (status & CAM_DEV_QFRZN) != 0;
 886         sense  = (status & CAM_AUTOSNS_VALID) != 0;
 887         status &= CAM_STATUS_MASK;
 888
 889         timeout = 0;
 890         relsim_flags = 0;
 891
 892         /*
 893          * Unfreeze the queue once if it is already frozen..
 894          */
 895         if (frozen != 0) {
 896                 qfrozen_cnt = cam_release_devq(done_ccb->ccb_h.path,
 897                                               /*relsim_flags*/0,
 898                                               /*openings*/0,
 899                                               /*timeout*/0,
 900                                               /*getcount_only*/0);
 901         }
 902
 903         switch (status) {
 904
 905         case CAM_REQ_CMP:
 906
 907                 /*
 908                  * If we have successfully taken a device from the not
 909                  * ready to ready state, re-scan the device and re-get the
 910                  * inquiry information.  Many devices (mostly disks) don't
 911                  * properly report their inquiry information unless they
 912                  * are spun up.
 913                  */
 914                 if (done_ccb->ccb_h.func_code == XPT_SCSI_IO) {
 915                         scsi_cmd = (struct scsi_start_stop_unit *)
 916                                         &done_ccb->csio.cdb_io.cdb_bytes;
 917
 918                         if (scsi_cmd->opcode == START_STOP_UNIT)
 919                                 xpt_async(AC_INQ_CHANGED,
 920                                           done_ccb->ccb_h.path, NULL);
 921                 }
 922                 bcopy(done_ccb->ccb_h.saved_ccb_ptr, done_ccb,
 923                       sizeof(union ccb));
 924
 925                 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
 926
 927                 xpt_action(done_ccb);
 928
 929                 break;
 930         case CAM_SCSI_STATUS_ERROR:
 931                 scsi_cmd = (struct scsi_start_stop_unit *)
 932                                 &done_ccb->csio.cdb_io.cdb_bytes;
 933                 if (sense != 0) {
 934                         struct scsi_sense_data *sense;
 935                         int    error_code, sense_key, asc, ascq;
 936
 937                         sense = &done_ccb->csio.sense_data;
 938                         scsi_extract_sense(sense, &error_code,
 939                                            &sense_key, &asc, &ascq);
 940
 941                         /*
 942                          * If the error is "invalid field in CDB",
 943                          * and the load/eject flag is set, turn the
 944                          * flag off and try again.  This is just in
 945                          * case the drive in question barfs on the
 946                          * load eject flag.  The CAM code should set
 947                          * the load/eject flag by default for
 948                          * removable media.
 949                          */
 950
 951                         /* XXX KDM
 952                          * Should we check to see what the specific
 953                          * scsi status is??  Or does it not matter
 954                          * since we already know that there was an
 955                          * error, and we know what the specific
 956                          * error code was, and we know what the
 957                          * opcode is..
 958                          */
 959                         if ((scsi_cmd->opcode == START_STOP_UNIT) &&
 960                             ((scsi_cmd->how & SSS_LOEJ) != 0) &&
 961                              (asc == 0x24) && (ascq == 0x00) &&
 962                              (done_ccb->ccb_h.retry_count > 0)) {
 963
 964                                 scsi_cmd->how &= ~SSS_LOEJ;
 965
 966                                 xpt_action(done_ccb);
 967
 968                         } else if (done_ccb->ccb_h.retry_count > 0) {
 969                                 /*
 970                                  * In this case, the error recovery
 971                                  * command failed, but we've got
 972                                  * some retries left on it.  Give
 973                                  * it another try.
 974                                  */
 975
 976                                 /* set the timeout to .5 sec */
 977                                 relsim_flags =
 978                                         RELSIM_RELEASE_AFTER_TIMEOUT;
 979                                 timeout = 500;
 980
 981                                 xpt_action(done_ccb);
 982
 983                                 break;
 984
 985                         } else {
 986                                 /*
 987                                  * Copy the original CCB back and
 988                                  * send it back to the caller.
 989                                  */
 990                                 bcopy(done_ccb->ccb_h.saved_ccb_ptr,
 991                                       done_ccb, sizeof(union ccb));
 992
 993                                 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
 994
 995                                 xpt_action(done_ccb);
 996                         }
 997                 } else {
 998                         /*
 999                          * Eh??  The command failed, but we don't
1000                          * have any sense.  What's up with that?
1001                          * Fire the CCB again to return it to the
1002                          * caller.
1003                          */
1004                         bcopy(done_ccb->ccb_h.saved_ccb_ptr,
1005                               done_ccb, sizeof(union ccb));
1006
1007                         periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
1008
1009                         xpt_action(done_ccb);
1010
1011                 }
1012                 break;
1013         default:
1014                 bcopy(done_ccb->ccb_h.saved_ccb_ptr, done_ccb,
1015                       sizeof(union ccb));
1016
1017                 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
1018
1019                 xpt_action(done_ccb);
1020
1021                 break;
1022         }
1023
1024         /* decrement the retry count */
1025         if (done_ccb->ccb_h.retry_count > 0)
1026                 done_ccb->ccb_h.retry_count--;
1027
1028         qfrozen_cnt = cam_release_devq(done_ccb->ccb_h.path,
1029                                       /*relsim_flags*/relsim_flags,
1030                                       /*openings*/0,
1031                                       /*timeout*/timeout,
1032                                       /*getcount_only*/0);
1033 }
1034
1035 /*
1036  * Generic Async Event handler.  Peripheral drivers usually
1037  * filter out the events that require personal attention,
1038  * and leave the rest to this function.
1039  */
1040 void
1041 cam_periph_async(struct cam_periph *periph, u_int32_t code,
1042                  struct cam_path *path, void *arg)
1043 {
1044         switch (code) {
1045         case AC_LOST_DEVICE:
1046                 cam_periph_invalidate(periph);
1047                 break;
1048         case AC_SENT_BDR:
1049         case AC_BUS_RESET:
1050         {
1051                 cam_periph_bus_settle(periph, SCSI_DELAY);
1052                 break;
1053         }
1054         default:
1055                 break;
1056         }
1057 }
1058
1059 void
1060 cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle)
1061 {
1062         struct ccb_getdevstats cgds;
1063
1064         xpt_setup_ccb(&cgds.ccb_h, periph->path, /*priority*/1);
1065         cgds.ccb_h.func_code = XPT_GDEV_STATS;
1066         xpt_action((union ccb *)&cgds);
1067         cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle);
1068 }
1069
1070 void
1071 cam_periph_freeze_after_event(struct cam_periph *periph,
1072                               struct timeval* event_time, u_int duration_ms)
1073 {
1074         struct timeval delta;
1075         struct timeval duration_tv;
1076
1077         microuptime(&delta);
1078         timevalsub(&delta, event_time);
1079         duration_tv.tv_sec = duration_ms / 1000;
1080         duration_tv.tv_usec = (duration_ms % 1000) * 1000;
1081         if (timevalcmp(&delta, &duration_tv, <)) {
1082                 timevalsub(&duration_tv, &delta);
1083
1084                 duration_ms = duration_tv.tv_sec * 1000;
1085                 duration_ms += duration_tv.tv_usec / 1000;
1086                 cam_freeze_devq(periph->path);
1087                 cam_release_devq(periph->path,
1088                                 RELSIM_RELEASE_AFTER_TIMEOUT,
1089                                 /*reduction*/0,
1090                                 /*timeout*/duration_ms,
1091                                 /*getcount_only*/0);
1092         }
1093
1094 }
1095
1096 /*
1097  * Generic error handler.  Peripheral drivers usually filter
1098  * out the errors that they handle in a unique mannor, then
1099  * call this function.
1100  */
1101 int
1102 cam_periph_error(union ccb *ccb, cam_flags camflags,
1103                  u_int32_t sense_flags, union ccb *save_ccb)
1104 {
1105         cam_status status;
1106         int        frozen;
1107         int        sense;
1108         int        error;
1109         int        openings;
1110         int        retry;
1111         u_int32_t  relsim_flags;
1112         u_int32_t  timeout;
1113
1114         status = ccb->ccb_h.status;
1115         frozen = (status & CAM_DEV_QFRZN) != 0;
1116         sense  = (status & CAM_AUTOSNS_VALID) != 0;
1117         status &= CAM_STATUS_MASK;
1118         relsim_flags = 0;
1119
1120         switch (status) {
1121         case CAM_REQ_CMP:
1122                 /* decrement the number of retries */
1123                 retry = ccb->ccb_h.retry_count > 0;
1124                 if (retry)
1125                         ccb->ccb_h.retry_count--;
1126                 error = 0;
1127                 break;
1128         case CAM_AUTOSENSE_FAIL:
1129         case CAM_SCSI_STATUS_ERROR:
1130
1131                 switch (ccb->csio.scsi_status) {
1132                 case SCSI_STATUS_OK:
1133                 case SCSI_STATUS_COND_MET:
1134                 case SCSI_STATUS_INTERMED:
1135                 case SCSI_STATUS_INTERMED_COND_MET:
1136                         error = 0;
1137                         break;
1138                 case SCSI_STATUS_CMD_TERMINATED:
1139                 case SCSI_STATUS_CHECK_COND:
1140                         if (sense != 0) {
1141                                 struct scsi_sense_data *sense;
1142                                 int    error_code, sense_key, asc, ascq;
1143                                 struct cam_periph *periph;
1144                                 scsi_sense_action err_action;
1145                                 struct ccb_getdev cgd;
1146
1147                                 sense = &ccb->csio.sense_data;
1148                                 scsi_extract_sense(sense, &error_code,
1149                                                    &sense_key, &asc, &ascq);
1150                                 periph = xpt_path_periph(ccb->ccb_h.path);
1151
1152                                 /*
1153                                  * Grab the inquiry data for this device.
1154                                  */
1155                                 xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path,
1156                                               /*priority*/ 1);
1157                                 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1158                                 xpt_action((union ccb *)&cgd);
1159
1160                                 err_action = scsi_error_action(asc, ascq,
1161                                                                &cgd.inq_data);
1162
1163                                 /*
1164                                  * Send a Test Unit Ready to the device.
1165                                  * If the 'many' flag is set, we send 120
1166                                  * test unit ready commands, one every half
1167                                  * second.  Otherwise, we just send one TUR.
1168                                  * We only want to do this if the retry
1169                                  * count has not been exhausted.
1170                                  */
1171                                 if (((err_action & SS_MASK) == SS_TUR)
1172                                  && save_ccb != NULL
1173                                  && ccb->ccb_h.retry_count > 0) {
1174
1175                                         /*
1176                                          * Since error recovery is already
1177                                          * in progress, don't attempt to
1178                                          * process this error.  It is probably
1179                                          * related to the error that caused
1180                                          * the currently active error recovery
1181                                          * action.  Also, we only have
1182                                          * space for one saved CCB, so if we
1183                                          * had two concurrent error recovery
1184                                          * actions, we would end up
1185                                          * over-writing one error recovery
1186                                          * CCB with another one.
1187                                          */
1188                                         if (periph->flags &
1189                                             CAM_PERIPH_RECOVERY_INPROG) {
1190                                                 error = ERESTART;
1191                                                 break;
1192                                         }
1193
1194                                         periph->flags |=
1195                                                 CAM_PERIPH_RECOVERY_INPROG;
1196
1197                                         /* decrement the number of retries */
1198                                         if ((err_action &
1199                                              SSQ_DECREMENT_COUNT) != 0) {
1200                                                 retry = 1;
1201                                                 ccb->ccb_h.retry_count--;
1202                                         }
1203
1204                                         bcopy(ccb, save_ccb, sizeof(*save_ccb));
1205
1206                                         /*
1207                                          * We retry this one every half
1208                                          * second for a minute.  If the
1209                                          * device hasn't become ready in a
1210                                          * minute's time, it's unlikely to
1211                                          * ever become ready.  If the table
1212                                          * doesn't specify SSQ_MANY, we can
1213                                          * only try this once.  Oh well.
1214                                          */
1215                                         if ((err_action & SSQ_MANY) != 0)
1216                                                 scsi_test_unit_ready(&ccb->csio,
1217                                                                /*retries*/120,
1218                                                                camperiphdone,
1219                                                                MSG_SIMPLE_Q_TAG,
1220                                                                SSD_FULL_SIZE,
1221                                                                /*timeout*/5000);
1222                                         else
1223                                                 scsi_test_unit_ready(&ccb->csio,
1224                                                                /*retries*/1,
1225                                                                camperiphdone,
1226                                                                MSG_SIMPLE_Q_TAG,
1227                                                                SSD_FULL_SIZE,
1228                                                                /*timeout*/5000);
1229
1230                                         /* release the queue after .5 sec.  */
1231                                         relsim_flags =
1232                                                 RELSIM_RELEASE_AFTER_TIMEOUT;
1233                                         timeout = 500;
1234                                         /*
1235                                          * Drop the priority to 0 so that
1236                                          * we are the first to execute.  Also
1237                                          * freeze the queue after this command
1238                                          * is sent so that we can restore the
1239                                          * old csio and have it queued in the
1240                                          * proper order before we let normal
1241                                          * transactions go to the drive.
1242                                          */
1243                                         ccb->ccb_h.pinfo.priority = 0;
1244                                         ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1245
1246                                         /*
1247                                          * Save a pointer to the original
1248                                          * CCB in the new CCB.
1249                                          */
1250                                         ccb->ccb_h.saved_ccb_ptr = save_ccb;
1251
1252                                         error = ERESTART;
1253                                 }
1254                                 /*
1255                                  * Send a start unit command to the device,
1256                                  * and then retry the command.  We only
1257                                  * want to do this if the retry count has
1258                                  * not been exhausted.  If the user
1259                                  * specified 0 retries, then we follow
1260                                  * their request and do not retry.
1261                                  */
1262                                 else if (((err_action & SS_MASK) == SS_START)
1263                                       && save_ccb != NULL
1264                                       && ccb->ccb_h.retry_count > 0) {
1265                                         int le;
1266
1267                                         /*
1268                                          * Only one error recovery action
1269                                          * at a time.  See above.
1270                                          */
1271                                         if (periph->flags &
1272                                             CAM_PERIPH_RECOVERY_INPROG) {
1273                                                 error = ERESTART;
1274                                                 break;
1275                                         }
1276
1277                                         periph->flags |=
1278                                                 CAM_PERIPH_RECOVERY_INPROG;
1279
1280                                         /* decrement the number of retries */
1281                                         retry = 1;
1282                                         ccb->ccb_h.retry_count--;
1283
1284                                         /*
1285                                          * Check for removable media and
1286                                          * set load/eject flag
1287                                          * appropriately.
1288                                          */
1289                                         if (SID_IS_REMOVABLE(&cgd.inq_data))
1290                                                 le = TRUE;
1291                                         else
1292                                                 le = FALSE;
1293
1294                                         /*
1295                                          * Attempt to start the drive up.
1296                                          *
1297                                          * Save the current ccb so it can
1298                                          * be restored and retried once the
1299                                          * drive is started up.
1300                                          */
1301                                         bcopy(ccb, save_ccb, sizeof(*save_ccb));
1302
1303                                         scsi_start_stop(&ccb->csio,
1304                                                         /*retries*/1,
1305                                                         camperiphdone,
1306                                                         MSG_SIMPLE_Q_TAG,
1307                                                         /*start*/TRUE,
1308                                                         /*load/eject*/le,
1309                                                         /*immediate*/FALSE,
1310                                                         SSD_FULL_SIZE,
1311                                                         /*timeout*/50000);
1312                                         /*
1313                                          * Drop the priority to 0 so that
1314                                          * we are the first to execute.  Also
1315                                          * freeze the queue after this command
1316                                          * is sent so that we can restore the
1317                                          * old csio and have it queued in the
1318                                          * proper order before we let normal
1319                                          * transactions go to the drive.
1320                                          */
1321                                         ccb->ccb_h.pinfo.priority = 0;
1322                                         ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1323
1324                                         /*
1325                                          * Save a pointer to the original
1326                                          * CCB in the new CCB.
1327                                          */
1328                                         ccb->ccb_h.saved_ccb_ptr = save_ccb;
1329
1330                                         error = ERESTART;
1331                                 } else if ((sense_flags & SF_RETRY_UA) != 0) {
1332                                         /*
1333                                          * XXX KDM this is a *horrible*
1334                                          * hack.
1335                                          */
1336                                         error = scsi_interpret_sense(ccb,
1337                                                                   sense_flags,
1338                                                                   &relsim_flags,
1339                                                                   &openings,
1340                                                                   &timeout,
1341                                                                   err_action);
1342                                 }
1343
1344                                 /*
1345                                  * Theoretically, this code should send a
1346                                  * test unit ready to the given device, and
1347                                  * if it returns and error, send a start
1348                                  * unit command.  Since we don't yet have
1349                                  * the capability to do two-command error
1350                                  * recovery, just send a start unit.
1351                                  * XXX KDM fix this!
1352                                  */
1353                                 else if (((err_action & SS_MASK) == SS_TURSTART)
1354                                       && save_ccb != NULL
1355                                       && ccb->ccb_h.retry_count > 0) {
1356                                         int le;
1357
1358                                         /*
1359                                          * Only one error recovery action
1360                                          * at a time.  See above.
1361                                          */
1362                                         if (periph->flags &
1363                                             CAM_PERIPH_RECOVERY_INPROG) {
1364                                                 error = ERESTART;
1365                                                 break;
1366                                         }
1367
1368                                         periph->flags |=
1369                                                 CAM_PERIPH_RECOVERY_INPROG;
1370
1371                                         /* decrement the number of retries */
1372                                         retry = 1;
1373                                         ccb->ccb_h.retry_count--;
1374
1375                                         /*
1376                                          * Check for removable media and
1377                                          * set load/eject flag
1378                                          * appropriately.
1379                                          */
1380                                         if (SID_IS_REMOVABLE(&cgd.inq_data))
1381                                                 le = TRUE;
1382                                         else
1383                                                 le = FALSE;
1384
1385                                         /*
1386                                          * Attempt to start the drive up.
1387                                          *
1388                                          * Save the current ccb so it can
1389                                          * be restored and retried once the
1390                                          * drive is started up.
1391                                          */
1392                                         bcopy(ccb, save_ccb, sizeof(*save_ccb));
1393
1394                                         scsi_start_stop(&ccb->csio,
1395                                                         /*retries*/1,
1396                                                         camperiphdone,
1397                                                         MSG_SIMPLE_Q_TAG,
1398                                                         /*start*/TRUE,
1399                                                         /*load/eject*/le,
1400                                                         /*immediate*/FALSE,
1401                                                         SSD_FULL_SIZE,
1402                                                         /*timeout*/50000);
1403
1404                                         /* release the queue after .5 sec.  */
1405                                         relsim_flags =
1406                                                 RELSIM_RELEASE_AFTER_TIMEOUT;
1407                                         timeout = 500;
1408                                         /*
1409                                          * Drop the priority to 0 so that
1410                                          * we are the first to execute.  Also
1411                                          * freeze the queue after this command
1412                                          * is sent so that we can restore the
1413                                          * old csio and have it queued in the
1414                                          * proper order before we let normal
1415                                          * transactions go to the drive.
1416                                          */
1417                                         ccb->ccb_h.pinfo.priority = 0;
1418                                         ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1419
1420                                         /*
1421                                          * Save a pointer to the original
1422                                          * CCB in the new CCB.
1423                                          */
1424                                         ccb->ccb_h.saved_ccb_ptr = save_ccb;
1425
1426                                         error = ERESTART;
1427                                 } else {
1428                                         error = scsi_interpret_sense(ccb,
1429                                                                   sense_flags,
1430                                                                   &relsim_flags,
1431                                                                   &openings,
1432                                                                   &timeout,
1433                                                                   err_action);
1434                                 }
1435                         } else if (ccb->csio.scsi_status ==
1436                                    SCSI_STATUS_CHECK_COND
1437                                 && status != CAM_AUTOSENSE_FAIL) {
1438                                 /* no point in decrementing the retry count */
1439                                 panic("cam_periph_error: scsi status of "
1440                                       "CHECK COND returned but no sense "
1441                                       "information is availible.  "
1442                                       "Controller should have returned "
1443                                       "CAM_AUTOSENSE_FAILED");
1444                                 /* NOTREACHED */
1445                                 error = EIO;
1446                         } else if (ccb->ccb_h.retry_count == 0) {
1447                                 /*
1448                                  * XXX KDM shouldn't there be a better
1449                                  * argument to return??
1450                                  */
1451                                 error = EIO;
1452                         } else {
1453                                 /* decrement the number of retries */
1454                                 retry = ccb->ccb_h.retry_count > 0;
1455                                 if (retry)
1456                                         ccb->ccb_h.retry_count--;
1457                                 /*
1458                                  * If it was aborted with no
1459                                  * clue as to the reason, just
1460                                  * retry it again.
1461                                  */
1462                                 error = ERESTART;
1463                         }
1464                         break;
1465                 case SCSI_STATUS_QUEUE_FULL:
1466                 {
1467                         /* no decrement */
1468                         struct ccb_getdevstats cgds;
1469
1470                         /*
1471                          * First off, find out what the current
1472                          * transaction counts are.
1473                          */
1474                         xpt_setup_ccb(&cgds.ccb_h,
1475                                       ccb->ccb_h.path,
1476                                       /*priority*/1);
1477                         cgds.ccb_h.func_code = XPT_GDEV_STATS;
1478                         xpt_action((union ccb *)&cgds);
1479
1480                         /*
1481                          * If we were the only transaction active, treat
1482                          * the QUEUE FULL as if it were a BUSY condition.
1483                          */
1484                         if (cgds.dev_active != 0) {
1485                                 int total_openings;
1486
1487                                 /*
1488                                  * Reduce the number of openings to
1489                                  * be 1 less than the amount it took
1490                                  * to get a queue full bounded by the
1491                                  * minimum allowed tag count for this
1492                                  * device.
1493                                  */
1494                                 total_openings =
1495                                     cgds.dev_active+cgds.dev_openings;
1496                                 openings = cgds.dev_active;
1497                                 if (openings < cgds.mintags)
1498                                         openings = cgds.mintags;
1499                                 if (openings < total_openings)
1500                                         relsim_flags = RELSIM_ADJUST_OPENINGS;
1501                                 else {
1502                                         /*
1503                                          * Some devices report queue full for
1504                                          * temporary resource shortages.  For
1505                                          * this reason, we allow a minimum
1506                                          * tag count to be entered via a
1507                                          * quirk entry to prevent the queue
1508                                          * count on these devices from falling
1509                                          * to a pessimisticly low value.  We
1510                                          * still wait for the next successful
1511                                          * completion, however, before queueing
1512                                          * more transactions to the device.
1513                                          */
1514                                         relsim_flags =
1515                                             RELSIM_RELEASE_AFTER_CMDCMPLT;
1516                                 }
1517                                 timeout = 0;
1518                                 error = ERESTART;
1519                                 break;
1520                         }
1521                         /* FALLTHROUGH */
1522                 }
1523                 case SCSI_STATUS_BUSY:
1524                         /*
1525                          * Restart the queue after either another
1526                          * command completes or a 1 second timeout.
1527                          * If we have any retries left, that is.
1528                          */
1529                         retry = ccb->ccb_h.retry_count > 0;
1530                         if (retry) {
1531                                 ccb->ccb_h.retry_count--;
1532                                 error = ERESTART;
1533                                 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT
1534                                              | RELSIM_RELEASE_AFTER_CMDCMPLT;
1535                                 timeout = 1000;
1536                         } else {
1537                                 error = EIO;
1538                         }
1539                         break;
1540                 case SCSI_STATUS_RESERV_CONFLICT:
1541                         error = EIO;
1542                         break;
1543                 default:
1544                         error = EIO;
1545                         break;
1546                 }
1547                 break;
1548         case CAM_REQ_CMP_ERR:
1549         case CAM_CMD_TIMEOUT:
1550         case CAM_UNEXP_BUSFREE:
1551         case CAM_UNCOR_PARITY:
1552         case CAM_DATA_RUN_ERR:
1553                 /* decrement the number of retries */
1554                 retry = ccb->ccb_h.retry_count > 0;
1555                 if (retry) {
1556                         ccb->ccb_h.retry_count--;
1557                         error = ERESTART;
1558                 } else {
1559                         error = EIO;
1560                 }
1561                 break;
1562         case CAM_UA_ABORT:
1563         case CAM_UA_TERMIO:
1564         case CAM_MSG_REJECT_REC:
1565                 /* XXX Don't know that these are correct */
1566                 error = EIO;
1567                 break;
1568         case CAM_SEL_TIMEOUT:
1569         {
1570                 /*
1571                  * XXX
1572                  * A single selection timeout should not be enough
1573                  * to invalidate a device.  We should retry for multiple
1574                  * seconds assuming this isn't a probe.  We'll probably
1575                  * need a special flag for that.
1576                  */
1577 #if 0
1578                 struct cam_path *newpath;
1579
1580                 /* Should we do more if we can't create the path?? */
1581                 if (xpt_create_path(&newpath, xpt_path_periph(ccb->ccb_h.path),
1582                                     xpt_path_path_id(ccb->ccb_h.path),
1583                                     xpt_path_target_id(ccb->ccb_h.path),
1584                                     CAM_LUN_WILDCARD) != CAM_REQ_CMP)
1585                         break;
1586                 /*
1587                  * Let peripheral drivers know that this device has gone
1588                  * away.
1589                  */
1590                 xpt_async(AC_LOST_DEVICE, newpath, NULL);
1591                 xpt_free_path(newpath);
1592 #endif
1593                 if ((sense_flags & SF_RETRY_SELTO) != 0) {
1594                         retry = ccb->ccb_h.retry_count > 0;
1595                         if (retry) {
1596                                 ccb->ccb_h.retry_count--;
1597                                 error = ERESTART;
1598                                 /*
1599                                  * Wait half a second to give the device
1600                                  * time to recover before we try again.
1601                                  */
1602                                 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1603                                 timeout = 500;
1604                         } else {
1605                                 error = ENXIO;
1606                         }
1607                 } else {
1608                         error = ENXIO;
1609                 }
1610                 break;
1611         }
1612         case CAM_REQ_INVALID:
1613         case CAM_PATH_INVALID:
1614         case CAM_DEV_NOT_THERE:
1615         case CAM_NO_HBA:
1616         case CAM_PROVIDE_FAIL:
1617         case CAM_REQ_TOO_BIG:
1618                 error = EINVAL;
1619                 break;
1620         case CAM_SCSI_BUS_RESET:
1621         case CAM_BDR_SENT:
1622         case CAM_REQUEUE_REQ:
1623                 /* Unconditional requeue, dammit */
1624                 error = ERESTART;
1625                 break;
1626         case CAM_RESRC_UNAVAIL:
1627         case CAM_BUSY:
1628                 /* timeout??? */
1629         default:
1630                 /* decrement the number of retries */
1631                 retry = ccb->ccb_h.retry_count > 0;
1632                 if (retry) {
1633                         ccb->ccb_h.retry_count--;
1634                         error = ERESTART;
1635                 } else {
1636                         /* Check the sense codes */
1637                         error = EIO;
1638                 }
1639                 break;
1640         }
1641
1642         /* Attempt a retry */
1643         if (error == ERESTART || error == 0) {
1644                 if (frozen != 0)
1645                         ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1646
1647                 if (error == ERESTART)
1648                         xpt_action(ccb);
1649
1650                 if (frozen != 0) {
1651                         cam_release_devq(ccb->ccb_h.path,
1652                                          relsim_flags,
1653                                          openings,
1654                                          timeout,
1655                                          /*getcount_only*/0);
1656                 }
1657         }
1658
1659
1660         return (error);
1661 }