sys/cam/scsi/scsi_ch.c

   1 /*-
   2  * Copyright (c) 1997 Justin T. Gibbs.
   3  * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions, and the following disclaimer,
  11  *    without modification, immediately at the beginning of the file.
  12  * 2. The name of the author may not be used to endorse or promote products
  13  *    derived from this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 /*
  29  * Derived from the NetBSD SCSI changer driver.
  30  *
  31  *      $NetBSD: ch.c,v 1.32 1998/01/12 09:49:12 thorpej Exp $
  32  *
  33  */
  34 /*-
  35  * Copyright (c) 1996, 1997 Jason R. Thorpe <thorpej@and.com>
  36  * All rights reserved.
  37  *
  38  * Partially based on an autochanger driver written by Stefan Grefen
  39  * and on an autochanger driver written by the Systems Programming Group
  40  * at the University of Utah Computer Science Department.
  41  *
  42  * Redistribution and use in source and binary forms, with or without
  43  * modification, are permitted provided that the following conditions
  44  * are met:
  45  * 1. Redistributions of source code must retain the above copyright
  46  *    notice, this list of conditions and the following disclaimer.
  47  * 2. Redistributions in binary form must reproduce the above copyright
  48  *    notice, this list of conditions and the following disclaimer in the
  49  *    documentation and/or other materials provided with the distribution.
  50  * 3. All advertising materials mentioning features or use of this software
  51  *    must display the following acknowledgements:
  52  *      This product includes software developed by Jason R. Thorpe
  53  *      for And Communications, http://www.and.com/
  54  * 4. The name of the author may not be used to endorse or promote products
  55  *    derived from this software without specific prior written permission.
  56  *
  57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  62  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  63  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  64  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  65  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  66  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  67  * SUCH DAMAGE.
  68  */
  69
  70 #include <sys/cdefs.h>
  71 __FBSDID("$FreeBSD$");
  72
  73 #include <sys/param.h>
  74 #include <sys/queue.h>
  75 #include <sys/systm.h>
  76 #include <sys/kernel.h>
  77 #include <sys/types.h>
  78 #include <sys/malloc.h>
  79 #include <sys/fcntl.h>
  80 #include <sys/conf.h>
  81 #include <sys/chio.h>
  82 #include <sys/errno.h>
  83 #include <sys/devicestat.h>
  84
  85 #include <cam/cam.h>
  86 #include <cam/cam_ccb.h>
  87 #include <cam/cam_periph.h>
  88 #include <cam/cam_xpt_periph.h>
  89 #include <cam/cam_debug.h>
  90
  91 #include <cam/scsi/scsi_all.h>
  92 #include <cam/scsi/scsi_message.h>
  93 #include <cam/scsi/scsi_ch.h>
  94
  95 /*
  96  * Timeout definitions for various changer related commands.  They may
  97  * be too short for some devices (especially the timeout for INITIALIZE
  98  * ELEMENT STATUS).
  99  */
 100
 101 static const u_int32_t  CH_TIMEOUT_MODE_SENSE                = 6000;
 102 static const u_int32_t  CH_TIMEOUT_MOVE_MEDIUM               = 100000;
 103 static const u_int32_t  CH_TIMEOUT_EXCHANGE_MEDIUM           = 100000;
 104 static const u_int32_t  CH_TIMEOUT_POSITION_TO_ELEMENT       = 100000;
 105 static const u_int32_t  CH_TIMEOUT_READ_ELEMENT_STATUS       = 10000;
 106 static const u_int32_t  CH_TIMEOUT_SEND_VOLTAG               = 10000;
 107 static const u_int32_t  CH_TIMEOUT_INITIALIZE_ELEMENT_STATUS = 500000;
 108
 109 typedef enum {
 110         CH_FLAG_INVALID         = 0x001,
 111         CH_FLAG_OPEN            = 0x002
 112 } ch_flags;
 113
 114 typedef enum {
 115         CH_STATE_PROBE,
 116         CH_STATE_NORMAL
 117 } ch_state;
 118
 119 typedef enum {
 120         CH_CCB_PROBE,
 121         CH_CCB_WAITING
 122 } ch_ccb_types;
 123
 124 typedef enum {
 125         CH_Q_NONE       = 0x00,
 126         CH_Q_NO_DBD     = 0x01
 127 } ch_quirks;
 128
 129 #define CH_Q_BIT_STRING \
 130         "\020"          \
 131         "\001NO_DBD"
 132
 133 #define ccb_state       ppriv_field0
 134 #define ccb_bp          ppriv_ptr1
 135
 136 struct scsi_mode_sense_data {
 137         struct scsi_mode_header_6 header;
 138         struct scsi_mode_blk_desc blk_desc;
 139         union {
 140                 struct page_element_address_assignment ea;
 141                 struct page_transport_geometry_parameters tg;
 142                 struct page_device_capabilities cap;
 143         } pages;
 144 };
 145
 146 struct ch_softc {
 147         ch_flags        flags;
 148         ch_state        state;
 149         ch_quirks       quirks;
 150         union ccb       saved_ccb;
 151         struct devstat  *device_stats;
 152         struct cdev *dev;
 153
 154         int             sc_picker;      /* current picker */
 155
 156         /*
 157          * The following information is obtained from the
 158          * element address assignment page.
 159          */
 160         int             sc_firsts[CHET_MAX + 1];        /* firsts */
 161         int             sc_counts[CHET_MAX + 1];        /* counts */
 162
 163         /*
 164          * The following mask defines the legal combinations
 165          * of elements for the MOVE MEDIUM command.
 166          */
 167         u_int8_t        sc_movemask[CHET_MAX + 1];
 168
 169         /*
 170          * As above, but for EXCHANGE MEDIUM.
 171          */
 172         u_int8_t        sc_exchangemask[CHET_MAX + 1];
 173
 174         /*
 175          * Quirks; see below.  XXX KDM not implemented yet
 176          */
 177         int             sc_settledelay; /* delay for settle */
 178 };
 179
 180 static  d_open_t        chopen;
 181 static  d_close_t       chclose;
 182 static  d_ioctl_t       chioctl;
 183 static  periph_init_t   chinit;
 184 static  periph_ctor_t   chregister;
 185 static  periph_oninv_t  choninvalidate;
 186 static  periph_dtor_t   chcleanup;
 187 static  periph_start_t  chstart;
 188 static  void            chasync(void *callback_arg, u_int32_t code,
 189                                 struct cam_path *path, void *arg);
 190 static  void            chdone(struct cam_periph *periph,
 191                                union ccb *done_ccb);
 192 static  int             cherror(union ccb *ccb, u_int32_t cam_flags,
 193                                 u_int32_t sense_flags);
 194 static  int             chmove(struct cam_periph *periph,
 195                                struct changer_move *cm);
 196 static  int             chexchange(struct cam_periph *periph,
 197                                    struct changer_exchange *ce);
 198 static  int             chposition(struct cam_periph *periph,
 199                                    struct changer_position *cp);
 200 static  int             chgetelemstatus(struct cam_periph *periph,
 201                                 struct changer_element_status_request *csr);
 202 static  int             chsetvoltag(struct cam_periph *periph,
 203                                     struct changer_set_voltag_request *csvr);
 204 static  int             chielem(struct cam_periph *periph,
 205                                 unsigned int timeout);
 206 static  int             chgetparams(struct cam_periph *periph);
 207
 208 static struct periph_driver chdriver =
 209 {
 210         chinit, "ch",
 211         TAILQ_HEAD_INITIALIZER(chdriver.units), /* generation */ 0
 212 };
 213
 214 PERIPHDRIVER_DECLARE(ch, chdriver);
 215
 216 static struct cdevsw ch_cdevsw = {
 217         .d_version =    D_VERSION,
 218         .d_flags =      0,
 219         .d_open =       chopen,
 220         .d_close =      chclose,
 221         .d_ioctl =      chioctl,
 222         .d_name =       "ch",
 223 };
 224
 225 MALLOC_DEFINE(M_SCSICH, "scsi_ch", "scsi_ch buffers");
 226
 227 static void
 228 chinit(void)
 229 {
 230         cam_status status;
 231
 232         /*
 233          * Install a global async callback.  This callback will
 234          * receive async callbacks like "new device found".
 235          */
 236         status = xpt_register_async(AC_FOUND_DEVICE, chasync, NULL, NULL);
 237
 238         if (status != CAM_REQ_CMP) {
 239                 printf("ch: Failed to attach master async callback "
 240                        "due to status 0x%x!\n", status);
 241         }
 242 }
 243
 244 static void
 245 choninvalidate(struct cam_periph *periph)
 246 {
 247         struct ch_softc *softc;
 248
 249         softc = (struct ch_softc *)periph->softc;
 250
 251         /*
 252          * De-register any async callbacks.
 253          */
 254         xpt_register_async(0, chasync, periph, periph->path);
 255
 256         softc->flags |= CH_FLAG_INVALID;
 257
 258         xpt_print(periph->path, "lost device\n");
 259
 260 }
 261
 262 static void
 263 chcleanup(struct cam_periph *periph)
 264 {
 265         struct ch_softc *softc;
 266
 267         softc = (struct ch_softc *)periph->softc;
 268
 269         xpt_print(periph->path, "removing device entry\n");
 270         devstat_remove_entry(softc->device_stats);
 271         cam_periph_unlock(periph);
 272         destroy_dev(softc->dev);
 273         cam_periph_lock(periph);
 274         free(softc, M_DEVBUF);
 275 }
 276
 277 static void
 278 chasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg)
 279 {
 280         struct cam_periph *periph;
 281
 282         periph = (struct cam_periph *)callback_arg;
 283
 284         switch(code) {
 285         case AC_FOUND_DEVICE:
 286         {
 287                 struct ccb_getdev *cgd;
 288                 cam_status status;
 289
 290                 cgd = (struct ccb_getdev *)arg;
 291                 if (cgd == NULL)
 292                         break;
 293
 294                 if (cgd->protocol != PROTO_SCSI)
 295                         break;
 296
 297                 if (SID_TYPE(&cgd->inq_data)!= T_CHANGER)
 298                         break;
 299
 300                 /*
 301                  * Allocate a peripheral instance for
 302                  * this device and start the probe
 303                  * process.
 304                  */
 305                 status = cam_periph_alloc(chregister, choninvalidate,
 306                                           chcleanup, chstart, "ch",
 307                                           CAM_PERIPH_BIO, cgd->ccb_h.path,
 308                                           chasync, AC_FOUND_DEVICE, cgd);
 309
 310                 if (status != CAM_REQ_CMP
 311                  && status != CAM_REQ_INPROG)
 312                         printf("chasync: Unable to probe new device "
 313                                "due to status 0x%x\n", status);
 314
 315                 break;
 316
 317         }
 318         default:
 319                 cam_periph_async(periph, code, path, arg);
 320                 break;
 321         }
 322 }
 323
 324 static cam_status
 325 chregister(struct cam_periph *periph, void *arg)
 326 {
 327         struct ch_softc *softc;
 328         struct ccb_getdev *cgd;
 329         struct ccb_pathinq cpi;
 330
 331         cgd = (struct ccb_getdev *)arg;
 332         if (periph == NULL) {
 333                 printf("chregister: periph was NULL!!\n");
 334                 return(CAM_REQ_CMP_ERR);
 335         }
 336
 337         if (cgd == NULL) {
 338                 printf("chregister: no getdev CCB, can't register device\n");
 339                 return(CAM_REQ_CMP_ERR);
 340         }
 341
 342         softc = (struct ch_softc *)malloc(sizeof(*softc),M_DEVBUF,M_NOWAIT);
 343
 344         if (softc == NULL) {
 345                 printf("chregister: Unable to probe new device. "
 346                        "Unable to allocate softc\n");
 347                 return(CAM_REQ_CMP_ERR);
 348         }
 349
 350         bzero(softc, sizeof(*softc));
 351         softc->state = CH_STATE_PROBE;
 352         periph->softc = softc;
 353         softc->quirks = CH_Q_NONE;
 354
 355         bzero(&cpi, sizeof(cpi));
 356         xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 357         cpi.ccb_h.func_code = XPT_PATH_INQ;
 358         xpt_action((union ccb *)&cpi);
 359
 360         /*
 361          * Changers don't have a blocksize, and obviously don't support
 362          * tagged queueing.
 363          */
 364         cam_periph_unlock(periph);
 365         softc->device_stats = devstat_new_entry("ch",
 366                           periph->unit_number, 0,
 367                           DEVSTAT_NO_BLOCKSIZE | DEVSTAT_NO_ORDERED_TAGS,
 368                           SID_TYPE(&cgd->inq_data) |
 369                           XPORT_DEVSTAT_TYPE(cpi.transport),
 370                           DEVSTAT_PRIORITY_OTHER);
 371
 372         /* Register the device */
 373         softc->dev = make_dev(&ch_cdevsw, periph->unit_number, UID_ROOT,
 374                               GID_OPERATOR, 0600, "%s%d", periph->periph_name,
 375                               periph->unit_number);
 376         cam_periph_lock(periph);
 377         softc->dev->si_drv1 = periph;
 378
 379         /*
 380          * Add an async callback so that we get
 381          * notified if this device goes away.
 382          */
 383         xpt_register_async(AC_LOST_DEVICE, chasync, periph, periph->path);
 384
 385         /*
 386          * Lock this periph until we are setup.
 387          * This first call can't block
 388          */
 389         (void)cam_periph_hold(periph, PRIBIO);
 390         xpt_schedule(periph, CAM_PRIORITY_DEV);
 391
 392         return(CAM_REQ_CMP);
 393 }
 394
 395 static int
 396 chopen(struct cdev *dev, int flags, int fmt, struct thread *td)
 397 {
 398         struct cam_periph *periph;
 399         struct ch_softc *softc;
 400         int error;
 401
 402         periph = (struct cam_periph *)dev->si_drv1;
 403         if (cam_periph_acquire(periph) != CAM_REQ_CMP)
 404                 return (ENXIO);
 405
 406         softc = (struct ch_softc *)periph->softc;
 407
 408         cam_periph_lock(periph);
 409
 410         if (softc->flags & CH_FLAG_INVALID) {
 411                 cam_periph_unlock(periph);
 412                 cam_periph_release(periph);
 413                 return(ENXIO);
 414         }
 415
 416         if ((softc->flags & CH_FLAG_OPEN) == 0)
 417                 softc->flags |= CH_FLAG_OPEN;
 418         else
 419                 cam_periph_release(periph);
 420
 421         if ((error = cam_periph_hold(periph, PRIBIO | PCATCH)) != 0) {
 422                 cam_periph_unlock(periph);
 423                 cam_periph_release(periph);
 424                 return (error);
 425         }
 426
 427         /*
 428          * Load information about this changer device into the softc.
 429          */
 430         if ((error = chgetparams(periph)) != 0) {
 431                 softc->flags &= ~CH_FLAG_OPEN;
 432                 cam_periph_unlock(periph);
 433                 cam_periph_release(periph);
 434                 return(error);
 435         }
 436
 437         cam_periph_unhold(periph);
 438         cam_periph_unlock(periph);
 439
 440         return(error);
 441 }
 442
 443 static int
 444 chclose(struct cdev *dev, int flag, int fmt, struct thread *td)
 445 {
 446         struct  cam_periph *periph;
 447         struct  ch_softc *softc;
 448         int     error;
 449
 450         error = 0;
 451
 452         periph = (struct cam_periph *)dev->si_drv1;
 453         if (periph == NULL)
 454                 return(ENXIO);
 455
 456         softc = (struct ch_softc *)periph->softc;
 457
 458         cam_periph_lock(periph);
 459
 460         softc->flags &= ~CH_FLAG_OPEN;
 461
 462         cam_periph_unlock(periph);
 463         cam_periph_release(periph);
 464
 465         return(0);
 466 }
 467
 468 static void
 469 chstart(struct cam_periph *periph, union ccb *start_ccb)
 470 {
 471         struct ch_softc *softc;
 472
 473         softc = (struct ch_softc *)periph->softc;
 474
 475         switch (softc->state) {
 476         case CH_STATE_NORMAL:
 477         {
 478                 if (periph->immediate_priority <= periph->pinfo.priority){
 479                         start_ccb->ccb_h.ccb_state = CH_CCB_WAITING;
 480
 481                         SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
 482                                           periph_links.sle);
 483                         periph->immediate_priority = CAM_PRIORITY_NONE;
 484                         wakeup(&periph->ccb_list);
 485                 }
 486                 break;
 487         }
 488         case CH_STATE_PROBE:
 489         {
 490                 int mode_buffer_len;
 491                 void *mode_buffer;
 492
 493                 /*
 494                  * Include the block descriptor when calculating the mode
 495                  * buffer length,
 496                  */
 497                 mode_buffer_len = sizeof(struct scsi_mode_header_6) +
 498                                   sizeof(struct scsi_mode_blk_desc) +
 499                                  sizeof(struct page_element_address_assignment);
 500
 501                 mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
 502
 503                 if (mode_buffer == NULL) {
 504                         printf("chstart: couldn't malloc mode sense data\n");
 505                         break;
 506                 }
 507                 bzero(mode_buffer, mode_buffer_len);
 508
 509                 /*
 510                  * Get the element address assignment page.
 511                  */
 512                 scsi_mode_sense(&start_ccb->csio,
 513                                 /* retries */ 1,
 514                                 /* cbfcnp */ chdone,
 515                                 /* tag_action */ MSG_SIMPLE_Q_TAG,
 516                                 /* dbd */ (softc->quirks & CH_Q_NO_DBD) ?
 517                                         FALSE : TRUE,
 518                                 /* page_code */ SMS_PAGE_CTRL_CURRENT,
 519                                 /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
 520                                 /* param_buf */ (u_int8_t *)mode_buffer,
 521                                 /* param_len */ mode_buffer_len,
 522                                 /* sense_len */ SSD_FULL_SIZE,
 523                                 /* timeout */ CH_TIMEOUT_MODE_SENSE);
 524
 525                 start_ccb->ccb_h.ccb_bp = NULL;
 526                 start_ccb->ccb_h.ccb_state = CH_CCB_PROBE;
 527                 xpt_action(start_ccb);
 528                 break;
 529         }
 530         }
 531 }
 532
 533 static void
 534 chdone(struct cam_periph *periph, union ccb *done_ccb)
 535 {
 536         struct ch_softc *softc;
 537         struct ccb_scsiio *csio;
 538
 539         softc = (struct ch_softc *)periph->softc;
 540         csio = &done_ccb->csio;
 541
 542         switch(done_ccb->ccb_h.ccb_state) {
 543         case CH_CCB_PROBE:
 544         {
 545                 struct scsi_mode_header_6 *mode_header;
 546                 struct page_element_address_assignment *ea;
 547                 char announce_buf[80];
 548
 549
 550                 mode_header = (struct scsi_mode_header_6 *)csio->data_ptr;
 551
 552                 ea = (struct page_element_address_assignment *)
 553                         find_mode_page_6(mode_header);
 554
 555                 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP){
 556
 557                         softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
 558                         softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
 559                         softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
 560                         softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
 561                         softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
 562                         softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
 563                         softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
 564                         softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
 565                         softc->sc_picker = softc->sc_firsts[CHET_MT];
 566
 567 #define PLURAL(c)       (c) == 1 ? "" : "s"
 568                         snprintf(announce_buf, sizeof(announce_buf),
 569                                 "%d slot%s, %d drive%s, "
 570                                 "%d picker%s, %d portal%s",
 571                                 softc->sc_counts[CHET_ST],
 572                                 PLURAL(softc->sc_counts[CHET_ST]),
 573                                 softc->sc_counts[CHET_DT],
 574                                 PLURAL(softc->sc_counts[CHET_DT]),
 575                                 softc->sc_counts[CHET_MT],
 576                                 PLURAL(softc->sc_counts[CHET_MT]),
 577                                 softc->sc_counts[CHET_IE],
 578                                 PLURAL(softc->sc_counts[CHET_IE]));
 579 #undef PLURAL
 580                 } else {
 581                         int error;
 582
 583                         error = cherror(done_ccb, CAM_RETRY_SELTO,
 584                                         SF_RETRY_UA | SF_NO_PRINT);
 585                         /*
 586                          * Retry any UNIT ATTENTION type errors.  They
 587                          * are expected at boot.
 588                          */
 589                         if (error == ERESTART) {
 590                                 /*
 591                                  * A retry was scheuled, so
 592                                  * just return.
 593                                  */
 594                                 return;
 595                         } else if (error != 0) {
 596                                 int retry_scheduled;
 597                                 struct scsi_mode_sense_6 *sms;
 598
 599                                 sms = (struct scsi_mode_sense_6 *)
 600                                         done_ccb->csio.cdb_io.cdb_bytes;
 601
 602                                 /*
 603                                  * Check to see if block descriptors were
 604                                  * disabled.  Some devices don't like that.
 605                                  * We're taking advantage of the fact that
 606                                  * the first few bytes of the 6 and 10 byte
 607                                  * mode sense commands are the same.  If
 608                                  * block descriptors were disabled, enable
 609                                  * them and re-send the command.
 610                                  */
 611                                 if (sms->byte2 & SMS_DBD) {
 612                                         sms->byte2 &= ~SMS_DBD;
 613                                         xpt_action(done_ccb);
 614                                         softc->quirks |= CH_Q_NO_DBD;
 615                                         retry_scheduled = 1;
 616                                 } else
 617                                         retry_scheduled = 0;
 618
 619                                 /* Don't wedge this device's queue */
 620                                 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
 621                                         cam_release_devq(done_ccb->ccb_h.path,
 622                                                  /*relsim_flags*/0,
 623                                                  /*reduction*/0,
 624                                                  /*timeout*/0,
 625                                                  /*getcount_only*/0);
 626
 627                                 if (retry_scheduled)
 628                                         return;
 629
 630                                 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK)
 631                                     == CAM_SCSI_STATUS_ERROR)
 632                                         scsi_sense_print(&done_ccb->csio);
 633                                 else {
 634                                         xpt_print(periph->path,
 635                                             "got CAM status %#x\n",
 636                                             done_ccb->ccb_h.status);
 637                                 }
 638                                 xpt_print(periph->path, "fatal error, failed "
 639                                     "to attach to device\n");
 640
 641                                 cam_periph_invalidate(periph);
 642
 643                                 announce_buf[0] = '\0';
 644                         }
 645                 }
 646                 if (announce_buf[0] != '\0') {
 647                         xpt_announce_periph(periph, announce_buf);
 648                         xpt_announce_quirks(periph, softc->quirks,
 649                             CH_Q_BIT_STRING);
 650                 }
 651                 softc->state = CH_STATE_NORMAL;
 652                 free(mode_header, M_SCSICH);
 653                 /*
 654                  * Since our peripheral may be invalidated by an error
 655                  * above or an external event, we must release our CCB
 656                  * before releasing the probe lock on the peripheral.
 657                  * The peripheral will only go away once the last lock
 658                  * is removed, and we need it around for the CCB release
 659                  * operation.
 660                  */
 661                 xpt_release_ccb(done_ccb);
 662                 cam_periph_unhold(periph);
 663                 return;
 664         }
 665         case CH_CCB_WAITING:
 666         {
 667                 /* Caller will release the CCB */
 668                 wakeup(&done_ccb->ccb_h.cbfcnp);
 669                 return;
 670         }
 671         default:
 672                 break;
 673         }
 674         xpt_release_ccb(done_ccb);
 675 }
 676
 677 static int
 678 cherror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
 679 {
 680         struct ch_softc *softc;
 681         struct cam_periph *periph;
 682
 683         periph = xpt_path_periph(ccb->ccb_h.path);
 684         softc = (struct ch_softc *)periph->softc;
 685
 686         return (cam_periph_error(ccb, cam_flags, sense_flags,
 687                                  &softc->saved_ccb));
 688 }
 689
 690 static int
 691 chioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
 692 {
 693         struct cam_periph *periph;
 694         struct ch_softc *softc;
 695         int error;
 696
 697         periph = (struct cam_periph *)dev->si_drv1;
 698         if (periph == NULL)
 699                 return(ENXIO);
 700
 701         cam_periph_lock(periph);
 702         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering chioctl\n"));
 703
 704         softc = (struct ch_softc *)periph->softc;
 705
 706         error = 0;
 707
 708         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
 709                   ("trying to do ioctl %#lx\n", cmd));
 710
 711         /*
 712          * If this command can change the device's state, we must
 713          * have the device open for writing.
 714          */
 715         switch (cmd) {
 716         case CHIOGPICKER:
 717         case CHIOGPARAMS:
 718         case CHIOGSTATUS:
 719                 break;
 720
 721         default:
 722                 if ((flag & FWRITE) == 0) {
 723                         cam_periph_unlock(periph);
 724                         return (EBADF);
 725                 }
 726         }
 727
 728         switch (cmd) {
 729         case CHIOMOVE:
 730                 error = chmove(periph, (struct changer_move *)addr);
 731                 break;
 732
 733         case CHIOEXCHANGE:
 734                 error = chexchange(periph, (struct changer_exchange *)addr);
 735                 break;
 736
 737         case CHIOPOSITION:
 738                 error = chposition(periph, (struct changer_position *)addr);
 739                 break;
 740
 741         case CHIOGPICKER:
 742                 *(int *)addr = softc->sc_picker - softc->sc_firsts[CHET_MT];
 743                 break;
 744
 745         case CHIOSPICKER:
 746         {
 747                 int new_picker = *(int *)addr;
 748
 749                 if (new_picker > (softc->sc_counts[CHET_MT] - 1)) {
 750                         error = EINVAL;
 751                         break;
 752                 }
 753                 softc->sc_picker = softc->sc_firsts[CHET_MT] + new_picker;
 754                 break;
 755         }
 756         case CHIOGPARAMS:
 757         {
 758                 struct changer_params *cp = (struct changer_params *)addr;
 759
 760                 cp->cp_npickers = softc->sc_counts[CHET_MT];
 761                 cp->cp_nslots = softc->sc_counts[CHET_ST];
 762                 cp->cp_nportals = softc->sc_counts[CHET_IE];
 763                 cp->cp_ndrives = softc->sc_counts[CHET_DT];
 764                 break;
 765         }
 766         case CHIOIELEM:
 767                 error = chielem(periph, *(unsigned int *)addr);
 768                 break;
 769
 770         case CHIOGSTATUS:
 771         {
 772                 error = chgetelemstatus(periph,
 773                                (struct changer_element_status_request *) addr);
 774                 break;
 775         }
 776
 777         case CHIOSETVOLTAG:
 778         {
 779                 error = chsetvoltag(periph,
 780                                     (struct changer_set_voltag_request *) addr);
 781                 break;
 782         }
 783
 784         /* Implement prevent/allow? */
 785
 786         default:
 787                 error = cam_periph_ioctl(periph, cmd, addr, cherror);
 788                 break;
 789         }
 790
 791         cam_periph_unlock(periph);
 792         return (error);
 793 }
 794
 795 static int
 796 chmove(struct cam_periph *periph, struct changer_move *cm)
 797 {
 798         struct ch_softc *softc;
 799         u_int16_t fromelem, toelem;
 800         union ccb *ccb;
 801         int error;
 802
 803         error = 0;
 804         softc = (struct ch_softc *)periph->softc;
 805
 806         /*
 807          * Check arguments.
 808          */
 809         if ((cm->cm_fromtype > CHET_DT) || (cm->cm_totype > CHET_DT))
 810                 return (EINVAL);
 811         if ((cm->cm_fromunit > (softc->sc_counts[cm->cm_fromtype] - 1)) ||
 812             (cm->cm_tounit > (softc->sc_counts[cm->cm_totype] - 1)))
 813                 return (ENODEV);
 814
 815         /*
 816          * Check the request against the changer's capabilities.
 817          */
 818         if ((softc->sc_movemask[cm->cm_fromtype] & (1 << cm->cm_totype)) == 0)
 819                 return (ENODEV);
 820
 821         /*
 822          * Calculate the source and destination elements.
 823          */
 824         fromelem = softc->sc_firsts[cm->cm_fromtype] + cm->cm_fromunit;
 825         toelem = softc->sc_firsts[cm->cm_totype] + cm->cm_tounit;
 826
 827         ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
 828
 829         scsi_move_medium(&ccb->csio,
 830                          /* retries */ 1,
 831                          /* cbfcnp */ chdone,
 832                          /* tag_action */ MSG_SIMPLE_Q_TAG,
 833                          /* tea */ softc->sc_picker,
 834                          /* src */ fromelem,
 835                          /* dst */ toelem,
 836                          /* invert */ (cm->cm_flags & CM_INVERT) ? TRUE : FALSE,
 837                          /* sense_len */ SSD_FULL_SIZE,
 838                          /* timeout */ CH_TIMEOUT_MOVE_MEDIUM);
 839
 840         error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
 841                                   /*sense_flags*/ SF_RETRY_UA,
 842                                   softc->device_stats);
 843
 844         xpt_release_ccb(ccb);
 845
 846         return(error);
 847 }
 848
 849 static int
 850 chexchange(struct cam_periph *periph, struct changer_exchange *ce)
 851 {
 852         struct ch_softc *softc;
 853         u_int16_t src, dst1, dst2;
 854         union ccb *ccb;
 855         int error;
 856
 857         error = 0;
 858         softc = (struct ch_softc *)periph->softc;
 859         /*
 860          * Check arguments.
 861          */
 862         if ((ce->ce_srctype > CHET_DT) || (ce->ce_fdsttype > CHET_DT) ||
 863             (ce->ce_sdsttype > CHET_DT))
 864                 return (EINVAL);
 865         if ((ce->ce_srcunit > (softc->sc_counts[ce->ce_srctype] - 1)) ||
 866             (ce->ce_fdstunit > (softc->sc_counts[ce->ce_fdsttype] - 1)) ||
 867             (ce->ce_sdstunit > (softc->sc_counts[ce->ce_sdsttype] - 1)))
 868                 return (ENODEV);
 869
 870         /*
 871          * Check the request against the changer's capabilities.
 872          */
 873         if (((softc->sc_exchangemask[ce->ce_srctype] &
 874              (1 << ce->ce_fdsttype)) == 0) ||
 875             ((softc->sc_exchangemask[ce->ce_fdsttype] &
 876              (1 << ce->ce_sdsttype)) == 0))
 877                 return (ENODEV);
 878
 879         /*
 880          * Calculate the source and destination elements.
 881          */
 882         src = softc->sc_firsts[ce->ce_srctype] + ce->ce_srcunit;
 883         dst1 = softc->sc_firsts[ce->ce_fdsttype] + ce->ce_fdstunit;
 884         dst2 = softc->sc_firsts[ce->ce_sdsttype] + ce->ce_sdstunit;
 885
 886         ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
 887
 888         scsi_exchange_medium(&ccb->csio,
 889                              /* retries */ 1,
 890                              /* cbfcnp */ chdone,
 891                              /* tag_action */ MSG_SIMPLE_Q_TAG,
 892                              /* tea */ softc->sc_picker,
 893                              /* src */ src,
 894                              /* dst1 */ dst1,
 895                              /* dst2 */ dst2,
 896                              /* invert1 */ (ce->ce_flags & CE_INVERT1) ?
 897                                            TRUE : FALSE,
 898                              /* invert2 */ (ce->ce_flags & CE_INVERT2) ?
 899                                            TRUE : FALSE,
 900                              /* sense_len */ SSD_FULL_SIZE,
 901                              /* timeout */ CH_TIMEOUT_EXCHANGE_MEDIUM);
 902
 903         error = cam_periph_runccb(ccb, cherror, /*cam_flags*/CAM_RETRY_SELTO,
 904                                   /*sense_flags*/ SF_RETRY_UA,
 905                                   softc->device_stats);
 906
 907         xpt_release_ccb(ccb);
 908
 909         return(error);
 910 }
 911
 912 static int
 913 chposition(struct cam_periph *periph, struct changer_position *cp)
 914 {
 915         struct ch_softc *softc;
 916         u_int16_t dst;
 917         union ccb *ccb;
 918         int error;
 919
 920         error = 0;
 921         softc = (struct ch_softc *)periph->softc;
 922
 923         /*
 924          * Check arguments.
 925          */
 926         if (cp->cp_type > CHET_DT)
 927                 return (EINVAL);
 928         if (cp->cp_unit > (softc->sc_counts[cp->cp_type] - 1))
 929                 return (ENODEV);
 930
 931         /*
 932          * Calculate the destination element.
 933          */
 934         dst = softc->sc_firsts[cp->cp_type] + cp->cp_unit;
 935
 936         ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
 937
 938         scsi_position_to_element(&ccb->csio,
 939                                  /* retries */ 1,
 940                                  /* cbfcnp */ chdone,
 941                                  /* tag_action */ MSG_SIMPLE_Q_TAG,
 942                                  /* tea */ softc->sc_picker,
 943                                  /* dst */ dst,
 944                                  /* invert */ (cp->cp_flags & CP_INVERT) ?
 945                                               TRUE : FALSE,
 946                                  /* sense_len */ SSD_FULL_SIZE,
 947                                  /* timeout */ CH_TIMEOUT_POSITION_TO_ELEMENT);
 948
 949         error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
 950                                   /*sense_flags*/ SF_RETRY_UA,
 951                                   softc->device_stats);
 952
 953         xpt_release_ccb(ccb);
 954
 955         return(error);
 956 }
 957
 958 /*
 959  * Copy a volume tag to a volume_tag struct, converting SCSI byte order
 960  * to host native byte order in the volume serial number.  The volume
 961  * label as returned by the changer is transferred to user mode as
 962  * nul-terminated string.  Volume labels are truncated at the first
 963  * space, as suggested by SCSI-2.
 964  */
 965 static  void
 966 copy_voltag(struct changer_voltag *uvoltag, struct volume_tag *voltag)
 967 {
 968         int i;
 969         for (i=0; i<CH_VOLTAG_MAXLEN; i++) {
 970                 char c = voltag->vif[i];
 971                 if (c && c != ' ')
 972                         uvoltag->cv_volid[i] = c;
 973                 else
 974                         break;
 975         }
 976         uvoltag->cv_serial = scsi_2btoul(voltag->vsn);
 977 }
 978
 979 /*
 980  * Copy an an element status descriptor to a user-mode
 981  * changer_element_status structure.
 982  */
 983
 984 static  void
 985 copy_element_status(struct ch_softc *softc,
 986                     u_int16_t flags,
 987                     struct read_element_status_descriptor *desc,
 988                     struct changer_element_status *ces)
 989 {
 990         u_int16_t eaddr = scsi_2btoul(desc->eaddr);
 991         u_int16_t et;
 992
 993         ces->ces_int_addr = eaddr;
 994         /* set up logical address in element status */
 995         for (et = CHET_MT; et <= CHET_DT; et++) {
 996                 if ((softc->sc_firsts[et] <= eaddr)
 997                     && ((softc->sc_firsts[et] + softc->sc_counts[et])
 998                         > eaddr)) {
 999                         ces->ces_addr = eaddr - softc->sc_firsts[et];
1000                         ces->ces_type = et;
1001                         break;
1002                 }
1003         }
1004
1005         ces->ces_flags = desc->flags1;
1006
1007         ces->ces_sensecode = desc->sense_code;
1008         ces->ces_sensequal = desc->sense_qual;
1009
1010         if (desc->flags2 & READ_ELEMENT_STATUS_INVERT)
1011                 ces->ces_flags |= CES_INVERT;
1012
1013         if (desc->flags2 & READ_ELEMENT_STATUS_SVALID) {
1014
1015                 eaddr = scsi_2btoul(desc->ssea);
1016
1017                 /* convert source address to logical format */
1018                 for (et = CHET_MT; et <= CHET_DT; et++) {
1019                         if ((softc->sc_firsts[et] <= eaddr)
1020                             && ((softc->sc_firsts[et] + softc->sc_counts[et])
1021                                 > eaddr)) {
1022                                 ces->ces_source_addr =
1023                                         eaddr - softc->sc_firsts[et];
1024                                 ces->ces_source_type = et;
1025                                 ces->ces_flags |= CES_SOURCE_VALID;
1026                                 break;
1027                         }
1028                 }
1029
1030                 if (!(ces->ces_flags & CES_SOURCE_VALID))
1031                         printf("ch: warning: could not map element source "
1032                                "address %ud to a valid element type\n",
1033                                eaddr);
1034         }
1035
1036
1037         if (flags & READ_ELEMENT_STATUS_PVOLTAG)
1038                 copy_voltag(&(ces->ces_pvoltag), &(desc->pvoltag));
1039         if (flags & READ_ELEMENT_STATUS_AVOLTAG)
1040                 copy_voltag(&(ces->ces_avoltag), &(desc->avoltag));
1041
1042         if (desc->dt_scsi_flags & READ_ELEMENT_STATUS_DT_IDVALID) {
1043                 ces->ces_flags |= CES_SCSIID_VALID;
1044                 ces->ces_scsi_id = desc->dt_scsi_addr;
1045         }
1046
1047         if (desc->dt_scsi_addr & READ_ELEMENT_STATUS_DT_LUVALID) {
1048                 ces->ces_flags |= CES_LUN_VALID;
1049                 ces->ces_scsi_lun =
1050                         desc->dt_scsi_flags & READ_ELEMENT_STATUS_DT_LUNMASK;
1051         }
1052 }
1053
1054 static int
1055 chgetelemstatus(struct cam_periph *periph,
1056                 struct changer_element_status_request *cesr)
1057 {
1058         struct read_element_status_header *st_hdr;
1059         struct read_element_status_page_header *pg_hdr;
1060         struct read_element_status_descriptor *desc;
1061         caddr_t data = NULL;
1062         size_t size, desclen;
1063         int avail, i, error = 0;
1064         struct changer_element_status *user_data = NULL;
1065         struct ch_softc *softc;
1066         union ccb *ccb;
1067         int chet = cesr->cesr_element_type;
1068         int want_voltags = (cesr->cesr_flags & CESR_VOLTAGS) ? 1 : 0;
1069
1070         softc = (struct ch_softc *)periph->softc;
1071
1072         /* perform argument checking */
1073
1074         /*
1075          * Perform a range check on the cesr_element_{base,count}
1076          * request argument fields.
1077          */
1078         if ((softc->sc_counts[chet] - cesr->cesr_element_base) <= 0
1079             || (cesr->cesr_element_base + cesr->cesr_element_count)
1080                 > softc->sc_counts[chet])
1081                 return (EINVAL);
1082
1083         /*
1084          * Request one descriptor for the given element type.  This
1085          * is used to determine the size of the descriptor so that
1086          * we can allocate enough storage for all of them.  We assume
1087          * that the first one can fit into 1k.
1088          */
1089         cam_periph_unlock(periph);
1090         data = (caddr_t)malloc(1024, M_DEVBUF, M_WAITOK);
1091
1092         cam_periph_lock(periph);
1093         ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1094
1095         scsi_read_element_status(&ccb->csio,
1096                                  /* retries */ 1,
1097                                  /* cbfcnp */ chdone,
1098                                  /* tag_action */ MSG_SIMPLE_Q_TAG,
1099                                  /* voltag */ want_voltags,
1100                                  /* sea */ softc->sc_firsts[chet],
1101                                  /* count */ 1,
1102                                  /* data_ptr */ data,
1103                                  /* dxfer_len */ 1024,
1104                                  /* sense_len */ SSD_FULL_SIZE,
1105                                  /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1106
1107         error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1108                                   /*sense_flags*/ SF_RETRY_UA,
1109                                   softc->device_stats);
1110
1111         if (error)
1112                 goto done;
1113         cam_periph_unlock(periph);
1114
1115         st_hdr = (struct read_element_status_header *)data;
1116         pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1117                   sizeof(struct read_element_status_header));
1118         desclen = scsi_2btoul(pg_hdr->edl);
1119
1120         size = sizeof(struct read_element_status_header) +
1121                sizeof(struct read_element_status_page_header) +
1122                (desclen * cesr->cesr_element_count);
1123
1124         /*
1125          * Reallocate storage for descriptors and get them from the
1126          * device.
1127          */
1128         free(data, M_DEVBUF);
1129         data = (caddr_t)malloc(size, M_DEVBUF, M_WAITOK);
1130
1131         cam_periph_lock(periph);
1132         scsi_read_element_status(&ccb->csio,
1133                                  /* retries */ 1,
1134                                  /* cbfcnp */ chdone,
1135                                  /* tag_action */ MSG_SIMPLE_Q_TAG,
1136                                  /* voltag */ want_voltags,
1137                                  /* sea */ softc->sc_firsts[chet]
1138                                  + cesr->cesr_element_base,
1139                                  /* count */ cesr->cesr_element_count,
1140                                  /* data_ptr */ data,
1141                                  /* dxfer_len */ size,
1142                                  /* sense_len */ SSD_FULL_SIZE,
1143                                  /* timeout */ CH_TIMEOUT_READ_ELEMENT_STATUS);
1144
1145         error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1146                                   /*sense_flags*/ SF_RETRY_UA,
1147                                   softc->device_stats);
1148
1149         if (error)
1150                 goto done;
1151         cam_periph_unlock(periph);
1152
1153         /*
1154          * Fill in the user status array.
1155          */
1156         st_hdr = (struct read_element_status_header *)data;
1157         pg_hdr = (struct read_element_status_page_header *)((uintptr_t)st_hdr +
1158                   sizeof(struct read_element_status_header));
1159         avail = scsi_2btoul(st_hdr->count);
1160
1161         if (avail != cesr->cesr_element_count) {
1162                 xpt_print(periph->path,
1163                     "warning, READ ELEMENT STATUS avail != count\n");
1164         }
1165
1166         user_data = (struct changer_element_status *)
1167                 malloc(avail * sizeof(struct changer_element_status),
1168                        M_DEVBUF, M_WAITOK | M_ZERO);
1169
1170         desc = (struct read_element_status_descriptor *)((uintptr_t)data +
1171                 sizeof(struct read_element_status_header) +
1172                 sizeof(struct read_element_status_page_header));
1173         /*
1174          * Set up the individual element status structures
1175          */
1176         for (i = 0; i < avail; ++i) {
1177                 struct changer_element_status *ces = &(user_data[i]);
1178
1179                 copy_element_status(softc, pg_hdr->flags, desc, ces);
1180
1181                 desc = (struct read_element_status_descriptor *)
1182                        ((uintptr_t)desc + desclen);
1183         }
1184
1185         /* Copy element status structures out to userspace. */
1186         error = copyout(user_data,
1187                         cesr->cesr_element_status,
1188                         avail * sizeof(struct changer_element_status));
1189         cam_periph_lock(periph);
1190
1191  done:
1192         xpt_release_ccb(ccb);
1193
1194         if (data != NULL)
1195                 free(data, M_DEVBUF);
1196         if (user_data != NULL)
1197                 free(user_data, M_DEVBUF);
1198
1199         return (error);
1200 }
1201
1202 static int
1203 chielem(struct cam_periph *periph,
1204         unsigned int timeout)
1205 {
1206         union ccb *ccb;
1207         struct ch_softc *softc;
1208         int error;
1209
1210         if (!timeout) {
1211                 timeout = CH_TIMEOUT_INITIALIZE_ELEMENT_STATUS;
1212         } else {
1213                 timeout *= 1000;
1214         }
1215
1216         error = 0;
1217         softc = (struct ch_softc *)periph->softc;
1218
1219         ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1220
1221         scsi_initialize_element_status(&ccb->csio,
1222                                       /* retries */ 1,
1223                                       /* cbfcnp */ chdone,
1224                                       /* tag_action */ MSG_SIMPLE_Q_TAG,
1225                                       /* sense_len */ SSD_FULL_SIZE,
1226                                       /* timeout */ timeout);
1227
1228         error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1229                                   /*sense_flags*/ SF_RETRY_UA,
1230                                   softc->device_stats);
1231
1232         xpt_release_ccb(ccb);
1233
1234         return(error);
1235 }
1236
1237 static int
1238 chsetvoltag(struct cam_periph *periph,
1239             struct changer_set_voltag_request *csvr)
1240 {
1241         union ccb *ccb;
1242         struct ch_softc *softc;
1243         u_int16_t ea;
1244         u_int8_t sac;
1245         struct scsi_send_volume_tag_parameters ssvtp;
1246         int error;
1247         int i;
1248
1249         error = 0;
1250         softc = (struct ch_softc *)periph->softc;
1251
1252         bzero(&ssvtp, sizeof(ssvtp));
1253         for (i=0; i<sizeof(ssvtp.vitf); i++) {
1254                 ssvtp.vitf[i] = ' ';
1255         }
1256
1257         /*
1258          * Check arguments.
1259          */
1260         if (csvr->csvr_type > CHET_DT)
1261                 return EINVAL;
1262         if (csvr->csvr_addr > (softc->sc_counts[csvr->csvr_type] - 1))
1263                 return ENODEV;
1264
1265         ea = softc->sc_firsts[csvr->csvr_type] + csvr->csvr_addr;
1266
1267         if (csvr->csvr_flags & CSVR_ALTERNATE) {
1268                 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1269                 case CSVR_MODE_SET:
1270                         sac = SEND_VOLUME_TAG_ASSERT_ALTERNATE;
1271                         break;
1272                 case CSVR_MODE_REPLACE:
1273                         sac = SEND_VOLUME_TAG_REPLACE_ALTERNATE;
1274                         break;
1275                 case CSVR_MODE_CLEAR:
1276                         sac = SEND_VOLUME_TAG_UNDEFINED_ALTERNATE;
1277                         break;
1278                 default:
1279                         error = EINVAL;
1280                         goto out;
1281                 }
1282         } else {
1283                 switch (csvr->csvr_flags & CSVR_MODE_MASK) {
1284                 case CSVR_MODE_SET:
1285                         sac = SEND_VOLUME_TAG_ASSERT_PRIMARY;
1286                         break;
1287                 case CSVR_MODE_REPLACE:
1288                         sac = SEND_VOLUME_TAG_REPLACE_PRIMARY;
1289                         break;
1290                 case CSVR_MODE_CLEAR:
1291                         sac = SEND_VOLUME_TAG_UNDEFINED_PRIMARY;
1292                         break;
1293                 default:
1294                         error = EINVAL;
1295                         goto out;
1296                 }
1297         }
1298
1299         memcpy(ssvtp.vitf, csvr->csvr_voltag.cv_volid,
1300                min(strlen(csvr->csvr_voltag.cv_volid), sizeof(ssvtp.vitf)));
1301         scsi_ulto2b(csvr->csvr_voltag.cv_serial, ssvtp.minvsn);
1302
1303         ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1304
1305         scsi_send_volume_tag(&ccb->csio,
1306                              /* retries */ 1,
1307                              /* cbfcnp */ chdone,
1308                              /* tag_action */ MSG_SIMPLE_Q_TAG,
1309                              /* element_address */ ea,
1310                              /* send_action_code */ sac,
1311                              /* parameters */ &ssvtp,
1312                              /* sense_len */ SSD_FULL_SIZE,
1313                              /* timeout */ CH_TIMEOUT_SEND_VOLTAG);
1314
1315         error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1316                                   /*sense_flags*/ SF_RETRY_UA,
1317                                   softc->device_stats);
1318
1319         xpt_release_ccb(ccb);
1320
1321  out:
1322         return error;
1323 }
1324
1325 static int
1326 chgetparams(struct cam_periph *periph)
1327 {
1328         union ccb *ccb;
1329         struct ch_softc *softc;
1330         void *mode_buffer;
1331         int mode_buffer_len;
1332         struct page_element_address_assignment *ea;
1333         struct page_device_capabilities *cap;
1334         int error, from, dbd;
1335         u_int8_t *moves, *exchanges;
1336
1337         error = 0;
1338
1339         softc = (struct ch_softc *)periph->softc;
1340
1341         ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1342
1343         /*
1344          * The scsi_mode_sense_data structure is just a convenience
1345          * structure that allows us to easily calculate the worst-case
1346          * storage size of the mode sense buffer.
1347          */
1348         mode_buffer_len = sizeof(struct scsi_mode_sense_data);
1349
1350         mode_buffer = malloc(mode_buffer_len, M_SCSICH, M_NOWAIT);
1351
1352         if (mode_buffer == NULL) {
1353                 printf("chgetparams: couldn't malloc mode sense data\n");
1354                 return(ENOSPC);
1355         }
1356
1357         bzero(mode_buffer, mode_buffer_len);
1358
1359         if (softc->quirks & CH_Q_NO_DBD)
1360                 dbd = FALSE;
1361         else
1362                 dbd = TRUE;
1363
1364         /*
1365          * Get the element address assignment page.
1366          */
1367         scsi_mode_sense(&ccb->csio,
1368                         /* retries */ 1,
1369                         /* cbfcnp */ chdone,
1370                         /* tag_action */ MSG_SIMPLE_Q_TAG,
1371                         /* dbd */ dbd,
1372                         /* page_code */ SMS_PAGE_CTRL_CURRENT,
1373                         /* page */ CH_ELEMENT_ADDR_ASSIGN_PAGE,
1374                         /* param_buf */ (u_int8_t *)mode_buffer,
1375                         /* param_len */ mode_buffer_len,
1376                         /* sense_len */ SSD_FULL_SIZE,
1377                         /* timeout */ CH_TIMEOUT_MODE_SENSE);
1378
1379         error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1380                                   /* sense_flags */ SF_RETRY_UA|SF_NO_PRINT,
1381                                   softc->device_stats);
1382
1383         if (error) {
1384                 if (dbd) {
1385                         struct scsi_mode_sense_6 *sms;
1386
1387                         sms = (struct scsi_mode_sense_6 *)
1388                                 ccb->csio.cdb_io.cdb_bytes;
1389
1390                         sms->byte2 &= ~SMS_DBD;
1391                         error = cam_periph_runccb(ccb, cherror,
1392                                                   /*cam_flags*/ CAM_RETRY_SELTO,
1393                                                   /*sense_flags*/ SF_RETRY_UA,
1394                                                   softc->device_stats);
1395                 } else {
1396                         /*
1397                          * Since we disabled sense printing above, print
1398                          * out the sense here since we got an error.
1399                          */
1400                         scsi_sense_print(&ccb->csio);
1401                 }
1402
1403                 if (error) {
1404                         xpt_print(periph->path,
1405                             "chgetparams: error getting element "
1406                             "address page\n");
1407                         xpt_release_ccb(ccb);
1408                         free(mode_buffer, M_SCSICH);
1409                         return(error);
1410                 }
1411         }
1412
1413         ea = (struct page_element_address_assignment *)
1414                 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1415
1416         softc->sc_firsts[CHET_MT] = scsi_2btoul(ea->mtea);
1417         softc->sc_counts[CHET_MT] = scsi_2btoul(ea->nmte);
1418         softc->sc_firsts[CHET_ST] = scsi_2btoul(ea->fsea);
1419         softc->sc_counts[CHET_ST] = scsi_2btoul(ea->nse);
1420         softc->sc_firsts[CHET_IE] = scsi_2btoul(ea->fieea);
1421         softc->sc_counts[CHET_IE] = scsi_2btoul(ea->niee);
1422         softc->sc_firsts[CHET_DT] = scsi_2btoul(ea->fdtea);
1423         softc->sc_counts[CHET_DT] = scsi_2btoul(ea->ndte);
1424
1425         bzero(mode_buffer, mode_buffer_len);
1426
1427         /*
1428          * Now get the device capabilities page.
1429          */
1430         scsi_mode_sense(&ccb->csio,
1431                         /* retries */ 1,
1432                         /* cbfcnp */ chdone,
1433                         /* tag_action */ MSG_SIMPLE_Q_TAG,
1434                         /* dbd */ dbd,
1435                         /* page_code */ SMS_PAGE_CTRL_CURRENT,
1436                         /* page */ CH_DEVICE_CAP_PAGE,
1437                         /* param_buf */ (u_int8_t *)mode_buffer,
1438                         /* param_len */ mode_buffer_len,
1439                         /* sense_len */ SSD_FULL_SIZE,
1440                         /* timeout */ CH_TIMEOUT_MODE_SENSE);
1441
1442         error = cam_periph_runccb(ccb, cherror, /*cam_flags*/ CAM_RETRY_SELTO,
1443                                   /* sense_flags */ SF_RETRY_UA | SF_NO_PRINT,
1444                                   softc->device_stats);
1445
1446         if (error) {
1447                 if (dbd) {
1448                         struct scsi_mode_sense_6 *sms;
1449
1450                         sms = (struct scsi_mode_sense_6 *)
1451                                 ccb->csio.cdb_io.cdb_bytes;
1452
1453                         sms->byte2 &= ~SMS_DBD;
1454                         error = cam_periph_runccb(ccb, cherror,
1455                                                   /*cam_flags*/ CAM_RETRY_SELTO,
1456                                                   /*sense_flags*/ SF_RETRY_UA,
1457                                                   softc->device_stats);
1458                 } else {
1459                         /*
1460                          * Since we disabled sense printing above, print
1461                          * out the sense here since we got an error.
1462                          */
1463                         scsi_sense_print(&ccb->csio);
1464                 }
1465
1466                 if (error) {
1467                         xpt_print(periph->path,
1468                             "chgetparams: error getting device "
1469                             "capabilities page\n");
1470                         xpt_release_ccb(ccb);
1471                         free(mode_buffer, M_SCSICH);
1472                         return(error);
1473                 }
1474         }
1475
1476         xpt_release_ccb(ccb);
1477
1478         cap = (struct page_device_capabilities *)
1479                 find_mode_page_6((struct scsi_mode_header_6 *)mode_buffer);
1480
1481         bzero(softc->sc_movemask, sizeof(softc->sc_movemask));
1482         bzero(softc->sc_exchangemask, sizeof(softc->sc_exchangemask));
1483         moves = cap->move_from;
1484         exchanges = cap->exchange_with;
1485         for (from = CHET_MT; from <= CHET_MAX; ++from) {
1486                 softc->sc_movemask[from] = moves[from];
1487                 softc->sc_exchangemask[from] = exchanges[from];
1488         }
1489
1490         free(mode_buffer, M_SCSICH);
1491
1492         return(error);
1493 }
1494
1495 void
1496 scsi_move_medium(struct ccb_scsiio *csio, u_int32_t retries,
1497                  void (*cbfcnp)(struct cam_periph *, union ccb *),
1498                  u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1499                  u_int32_t dst, int invert, u_int8_t sense_len,
1500                  u_int32_t timeout)
1501 {
1502         struct scsi_move_medium *scsi_cmd;
1503
1504         scsi_cmd = (struct scsi_move_medium *)&csio->cdb_io.cdb_bytes;
1505         bzero(scsi_cmd, sizeof(*scsi_cmd));
1506
1507         scsi_cmd->opcode = MOVE_MEDIUM;
1508
1509         scsi_ulto2b(tea, scsi_cmd->tea);
1510         scsi_ulto2b(src, scsi_cmd->src);
1511         scsi_ulto2b(dst, scsi_cmd->dst);
1512
1513         if (invert)
1514                 scsi_cmd->invert |= MOVE_MEDIUM_INVERT;
1515
1516         cam_fill_csio(csio,
1517                       retries,
1518                       cbfcnp,
1519                       /*flags*/ CAM_DIR_NONE,
1520                       tag_action,
1521                       /*data_ptr*/ NULL,
1522                       /*dxfer_len*/ 0,
1523                       sense_len,
1524                       sizeof(*scsi_cmd),
1525                       timeout);
1526 }
1527
1528 void
1529 scsi_exchange_medium(struct ccb_scsiio *csio, u_int32_t retries,
1530                      void (*cbfcnp)(struct cam_periph *, union ccb *),
1531                      u_int8_t tag_action, u_int32_t tea, u_int32_t src,
1532                      u_int32_t dst1, u_int32_t dst2, int invert1,
1533                      int invert2, u_int8_t sense_len, u_int32_t timeout)
1534 {
1535         struct scsi_exchange_medium *scsi_cmd;
1536
1537         scsi_cmd = (struct scsi_exchange_medium *)&csio->cdb_io.cdb_bytes;
1538         bzero(scsi_cmd, sizeof(*scsi_cmd));
1539
1540         scsi_cmd->opcode = EXCHANGE_MEDIUM;
1541
1542         scsi_ulto2b(tea, scsi_cmd->tea);
1543         scsi_ulto2b(src, scsi_cmd->src);
1544         scsi_ulto2b(dst1, scsi_cmd->fdst);
1545         scsi_ulto2b(dst2, scsi_cmd->sdst);
1546
1547         if (invert1)
1548                 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV1;
1549
1550         if (invert2)
1551                 scsi_cmd->invert |= EXCHANGE_MEDIUM_INV2;
1552
1553         cam_fill_csio(csio,
1554                       retries,
1555                       cbfcnp,
1556                       /*flags*/ CAM_DIR_NONE,
1557                       tag_action,
1558                       /*data_ptr*/ NULL,
1559                       /*dxfer_len*/ 0,
1560                       sense_len,
1561                       sizeof(*scsi_cmd),
1562                       timeout);
1563 }
1564
1565 void
1566 scsi_position_to_element(struct ccb_scsiio *csio, u_int32_t retries,
1567                          void (*cbfcnp)(struct cam_periph *, union ccb *),
1568                          u_int8_t tag_action, u_int32_t tea, u_int32_t dst,
1569                          int invert, u_int8_t sense_len, u_int32_t timeout)
1570 {
1571         struct scsi_position_to_element *scsi_cmd;
1572
1573         scsi_cmd = (struct scsi_position_to_element *)&csio->cdb_io.cdb_bytes;
1574         bzero(scsi_cmd, sizeof(*scsi_cmd));
1575
1576         scsi_cmd->opcode = POSITION_TO_ELEMENT;
1577
1578         scsi_ulto2b(tea, scsi_cmd->tea);
1579         scsi_ulto2b(dst, scsi_cmd->dst);
1580
1581         if (invert)
1582                 scsi_cmd->invert |= POSITION_TO_ELEMENT_INVERT;
1583
1584         cam_fill_csio(csio,
1585                       retries,
1586                       cbfcnp,
1587                       /*flags*/ CAM_DIR_NONE,
1588                       tag_action,
1589                       /*data_ptr*/ NULL,
1590                       /*dxfer_len*/ 0,
1591                       sense_len,
1592                       sizeof(*scsi_cmd),
1593                       timeout);
1594 }
1595
1596 void
1597 scsi_read_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1598                          void (*cbfcnp)(struct cam_periph *, union ccb *),
1599                          u_int8_t tag_action, int voltag, u_int32_t sea,
1600                          u_int32_t count, u_int8_t *data_ptr,
1601                          u_int32_t dxfer_len, u_int8_t sense_len,
1602                          u_int32_t timeout)
1603 {
1604         struct scsi_read_element_status *scsi_cmd;
1605
1606         scsi_cmd = (struct scsi_read_element_status *)&csio->cdb_io.cdb_bytes;
1607         bzero(scsi_cmd, sizeof(*scsi_cmd));
1608
1609         scsi_cmd->opcode = READ_ELEMENT_STATUS;
1610
1611         scsi_ulto2b(sea, scsi_cmd->sea);
1612         scsi_ulto2b(count, scsi_cmd->count);
1613         scsi_ulto3b(dxfer_len, scsi_cmd->len);
1614
1615         if (voltag)
1616                 scsi_cmd->byte2 |= READ_ELEMENT_STATUS_VOLTAG;
1617
1618         cam_fill_csio(csio,
1619                       retries,
1620                       cbfcnp,
1621                       /*flags*/ CAM_DIR_IN,
1622                       tag_action,
1623                       data_ptr,
1624                       dxfer_len,
1625                       sense_len,
1626                       sizeof(*scsi_cmd),
1627                       timeout);
1628 }
1629
1630 void
1631 scsi_initialize_element_status(struct ccb_scsiio *csio, u_int32_t retries,
1632                                void (*cbfcnp)(struct cam_periph *, union ccb *),
1633                                u_int8_t tag_action, u_int8_t sense_len,
1634                                u_int32_t timeout)
1635 {
1636         struct scsi_initialize_element_status *scsi_cmd;
1637
1638         scsi_cmd = (struct scsi_initialize_element_status *)
1639                     &csio->cdb_io.cdb_bytes;
1640         bzero(scsi_cmd, sizeof(*scsi_cmd));
1641
1642         scsi_cmd->opcode = INITIALIZE_ELEMENT_STATUS;
1643
1644         cam_fill_csio(csio,
1645                       retries,
1646                       cbfcnp,
1647                       /*flags*/ CAM_DIR_NONE,
1648                       tag_action,
1649                       /* data_ptr */ NULL,
1650                       /* dxfer_len */ 0,
1651                       sense_len,
1652                       sizeof(*scsi_cmd),
1653                       timeout);
1654 }
1655
1656 void
1657 scsi_send_volume_tag(struct ccb_scsiio *csio, u_int32_t retries,
1658                      void (*cbfcnp)(struct cam_periph *, union ccb *),
1659                      u_int8_t tag_action,
1660                      u_int16_t element_address,
1661                      u_int8_t send_action_code,
1662                      struct scsi_send_volume_tag_parameters *parameters,
1663                      u_int8_t sense_len, u_int32_t timeout)
1664 {
1665         struct scsi_send_volume_tag *scsi_cmd;
1666
1667         scsi_cmd = (struct scsi_send_volume_tag *) &csio->cdb_io.cdb_bytes;
1668         bzero(scsi_cmd, sizeof(*scsi_cmd));
1669
1670         scsi_cmd->opcode = SEND_VOLUME_TAG;
1671         scsi_ulto2b(element_address, scsi_cmd->ea);
1672         scsi_cmd->sac = send_action_code;
1673         scsi_ulto2b(sizeof(*parameters), scsi_cmd->pll);
1674
1675         cam_fill_csio(csio,
1676                       retries,
1677                       cbfcnp,
1678                       /*flags*/ CAM_DIR_OUT,
1679                       tag_action,
1680                       /* data_ptr */ (u_int8_t *) parameters,
1681                       sizeof(*parameters),
1682                       sense_len,
1683                       sizeof(*scsi_cmd),
1684                       timeout);
1685 }