sys/cam/scsi/scsi_cd.c

   1 /*-
   2  * Copyright (c) 1997 Justin T. Gibbs.
   3  * Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003 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  * Portions of this driver taken from the original FreeBSD cd driver.
  30  * Written by Julian Elischer (julian@tfs.com)
  31  * for TRW Financial Systems for use under the MACH(2.5) operating system.
  32  *
  33  * TRW Financial Systems, in accordance with their agreement with Carnegie
  34  * Mellon University, makes this software available to CMU to distribute
  35  * or use in any manner that they see fit as long as this message is kept with
  36  * the software. For this reason TFS also grants any other persons or
  37  * organisations permission to use or modify this software.
  38  *
  39  * TFS supplies this software to be publicly redistributed
  40  * on the understanding that TFS is not responsible for the correct
  41  * functioning of this software in any circumstances.
  42  *
  43  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
  44  *
  45  *      from: cd.c,v 1.83 1997/05/04 15:24:22 joerg Exp $
  46  */
  47
  48 #include <sys/cdefs.h>
  49 __FBSDID("$FreeBSD$");
  50
  51 #include "opt_cd.h"
  52
  53 #include <sys/param.h>
  54 #include <sys/systm.h>
  55 #include <sys/kernel.h>
  56 #include <sys/bio.h>
  57 #include <sys/conf.h>
  58 #include <sys/disk.h>
  59 #include <sys/malloc.h>
  60 #include <sys/cdio.h>
  61 #include <sys/cdrio.h>
  62 #include <sys/dvdio.h>
  63 #include <sys/devicestat.h>
  64 #include <sys/sysctl.h>
  65 #include <sys/taskqueue.h>
  66 #include <geom/geom_disk.h>
  67
  68 #include <cam/cam.h>
  69 #include <cam/cam_ccb.h>
  70 #include <cam/cam_periph.h>
  71 #include <cam/cam_xpt_periph.h>
  72 #include <cam/cam_queue.h>
  73 #include <cam/cam_sim.h>
  74
  75 #include <cam/scsi/scsi_message.h>
  76 #include <cam/scsi/scsi_da.h>
  77 #include <cam/scsi/scsi_cd.h>
  78
  79 #define LEADOUT         0xaa            /* leadout toc entry */
  80
  81 struct cd_params {
  82         u_int32_t blksize;
  83         u_long    disksize;
  84 };
  85
  86 typedef enum {
  87         CD_Q_NONE               = 0x00,
  88         CD_Q_NO_TOUCH           = 0x01,
  89         CD_Q_BCD_TRACKS         = 0x02,
  90         CD_Q_NO_CHANGER         = 0x04,
  91         CD_Q_CHANGER            = 0x08,
  92         CD_Q_10_BYTE_ONLY       = 0x10
  93 } cd_quirks;
  94
  95 typedef enum {
  96         CD_FLAG_INVALID         = 0x0001,
  97         CD_FLAG_NEW_DISC        = 0x0002,
  98         CD_FLAG_DISC_LOCKED     = 0x0004,
  99         CD_FLAG_DISC_REMOVABLE  = 0x0008,
 100         CD_FLAG_CHANGER         = 0x0040,
 101         CD_FLAG_ACTIVE          = 0x0080,
 102         CD_FLAG_SCHED_ON_COMP   = 0x0100,
 103         CD_FLAG_RETRY_UA        = 0x0200,
 104         CD_FLAG_VALID_MEDIA     = 0x0400,
 105         CD_FLAG_VALID_TOC       = 0x0800,
 106         CD_FLAG_SCTX_INIT       = 0x1000
 107 } cd_flags;
 108
 109 typedef enum {
 110         CD_CCB_PROBE            = 0x01,
 111         CD_CCB_BUFFER_IO        = 0x02,
 112         CD_CCB_WAITING          = 0x03,
 113         CD_CCB_TYPE_MASK        = 0x0F,
 114         CD_CCB_RETRY_UA         = 0x10
 115 } cd_ccb_state;
 116
 117 typedef enum {
 118         CHANGER_TIMEOUT_SCHED           = 0x01,
 119         CHANGER_SHORT_TMOUT_SCHED       = 0x02,
 120         CHANGER_MANUAL_CALL             = 0x04,
 121         CHANGER_NEED_TIMEOUT            = 0x08
 122 } cd_changer_flags;
 123
 124 #define ccb_state ppriv_field0
 125 #define ccb_bp ppriv_ptr1
 126
 127 struct cd_tocdata {
 128         struct ioc_toc_header header;
 129         struct cd_toc_entry entries[100];
 130 };
 131
 132 struct cd_toc_single {
 133         struct ioc_toc_header header;
 134         struct cd_toc_entry entry;
 135 };
 136
 137 typedef enum {
 138         CD_STATE_PROBE,
 139         CD_STATE_NORMAL
 140 } cd_state;
 141
 142 struct cd_softc {
 143         cam_pinfo               pinfo;
 144         cd_state                state;
 145         volatile cd_flags       flags;
 146         struct bio_queue_head   bio_queue;
 147         LIST_HEAD(, ccb_hdr)    pending_ccbs;
 148         struct cd_params        params;
 149         union ccb               saved_ccb;
 150         cd_quirks               quirks;
 151         STAILQ_ENTRY(cd_softc)  changer_links;
 152         struct cdchanger        *changer;
 153         int                     bufs_left;
 154         struct cam_periph       *periph;
 155         int                     minimum_command_size;
 156         int                     outstanding_cmds;
 157         struct task             sysctl_task;
 158         struct sysctl_ctx_list  sysctl_ctx;
 159         struct sysctl_oid       *sysctl_tree;
 160         STAILQ_HEAD(, cd_mode_params)   mode_queue;
 161         struct cd_tocdata       toc;
 162         struct disk             *disk;
 163 };
 164
 165 struct cd_page_sizes {
 166         int page;
 167         int page_size;
 168 };
 169
 170 static struct cd_page_sizes cd_page_size_table[] =
 171 {
 172         { AUDIO_PAGE, sizeof(struct cd_audio_page)}
 173 };
 174
 175 struct cd_quirk_entry {
 176         struct scsi_inquiry_pattern inq_pat;
 177         cd_quirks quirks;
 178 };
 179
 180 /*
 181  * The changer quirk entries aren't strictly necessary.  Basically, what
 182  * they do is tell cdregister() up front that a device is a changer.
 183  * Otherwise, it will figure that fact out once it sees a LUN on the device
 184  * that is greater than 0.  If it is known up front that a device is a changer,
 185  * all I/O to the device will go through the changer scheduling routines, as
 186  * opposed to the "normal" CD code.
 187  *
 188  * NOTE ON 10_BYTE_ONLY quirks:  Any 10_BYTE_ONLY quirks MUST be because
 189  * your device hangs when it gets a 10 byte command.  Adding a quirk just
 190  * to get rid of the informative diagnostic message is not acceptable.  All
 191  * 10_BYTE_ONLY quirks must be documented in full in a PR (which should be
 192  * referenced in a comment along with the quirk) , and must be approved by
 193  * ken@FreeBSD.org.  Any quirks added that don't adhere to this policy may
 194  * be removed until the submitter can explain why they are needed.
 195  * 10_BYTE_ONLY quirks will be removed (as they will no longer be necessary)
 196  * when the CAM_NEW_TRAN_CODE work is done.
 197  */
 198 static struct cd_quirk_entry cd_quirk_table[] =
 199 {
 200         {
 201                 { T_CDROM, SIP_MEDIA_REMOVABLE, "NRC", "MBR-7", "*"},
 202                  /*quirks*/ CD_Q_CHANGER
 203         },
 204         {
 205                 { T_CDROM, SIP_MEDIA_REMOVABLE, "PIONEER", "CD-ROM DRM*",
 206                   "*"}, /* quirks */ CD_Q_CHANGER
 207         },
 208         {
 209                 { T_CDROM, SIP_MEDIA_REMOVABLE, "NAKAMICH", "MJ-*", "*"},
 210                  /* quirks */ CD_Q_CHANGER
 211         },
 212         {
 213                 { T_CDROM, SIP_MEDIA_REMOVABLE, "CHINON", "CD-ROM CDS-535","*"},
 214                 /* quirks */ CD_Q_BCD_TRACKS
 215         }
 216 };
 217
 218 static  disk_open_t     cdopen;
 219 static  disk_close_t    cdclose;
 220 static  disk_ioctl_t    cdioctl;
 221 static  disk_strategy_t cdstrategy;
 222
 223 static  periph_init_t   cdinit;
 224 static  periph_ctor_t   cdregister;
 225 static  periph_dtor_t   cdcleanup;
 226 static  periph_start_t  cdstart;
 227 static  periph_oninv_t  cdoninvalidate;
 228 static  void            cdasync(void *callback_arg, u_int32_t code,
 229                                 struct cam_path *path, void *arg);
 230 static  int             cdcmdsizesysctl(SYSCTL_HANDLER_ARGS);
 231 static  void            cdshorttimeout(void *arg);
 232 static  void            cdschedule(struct cam_periph *periph, int priority);
 233 static  void            cdrunchangerqueue(void *arg);
 234 static  void            cdchangerschedule(struct cd_softc *softc);
 235 static  int             cdrunccb(union ccb *ccb,
 236                                  int (*error_routine)(union ccb *ccb,
 237                                                       u_int32_t cam_flags,
 238                                                       u_int32_t sense_flags),
 239                                  u_int32_t cam_flags, u_int32_t sense_flags);
 240 static  union ccb       *cdgetccb(struct cam_periph *periph,
 241                                   u_int32_t priority);
 242 static  void            cddone(struct cam_periph *periph,
 243                                union ccb *start_ccb);
 244 static  union cd_pages  *cdgetpage(struct cd_mode_params *mode_params);
 245 static  int             cdgetpagesize(int page_num);
 246 static  void            cdprevent(struct cam_periph *periph, int action);
 247 static  int             cdcheckmedia(struct cam_periph *periph);
 248 static  int             cdsize(struct cam_periph *periph, u_int32_t *size);
 249 static  int             cd6byteworkaround(union ccb *ccb);
 250 static  int             cderror(union ccb *ccb, u_int32_t cam_flags,
 251                                 u_int32_t sense_flags);
 252 static  int             cdreadtoc(struct cam_periph *periph, u_int32_t mode,
 253                                   u_int32_t start, u_int8_t *data,
 254                                   u_int32_t len, u_int32_t sense_flags);
 255 static  int             cdgetmode(struct cam_periph *periph,
 256                                   struct cd_mode_params *data, u_int32_t page);
 257 static  int             cdsetmode(struct cam_periph *periph,
 258                                   struct cd_mode_params *data);
 259 static  int             cdplay(struct cam_periph *periph, u_int32_t blk,
 260                                u_int32_t len);
 261 static  int             cdreadsubchannel(struct cam_periph *periph,
 262                                          u_int32_t mode, u_int32_t format,
 263                                          int track,
 264                                          struct cd_sub_channel_info *data,
 265                                          u_int32_t len);
 266 static  int             cdplaymsf(struct cam_periph *periph, u_int32_t startm,
 267                                   u_int32_t starts, u_int32_t startf,
 268                                   u_int32_t endm, u_int32_t ends,
 269                                   u_int32_t endf);
 270 static  int             cdplaytracks(struct cam_periph *periph,
 271                                      u_int32_t strack, u_int32_t sindex,
 272                                      u_int32_t etrack, u_int32_t eindex);
 273 static  int             cdpause(struct cam_periph *periph, u_int32_t go);
 274 static  int             cdstopunit(struct cam_periph *periph, u_int32_t eject);
 275 static  int             cdstartunit(struct cam_periph *periph, int load);
 276 static  int             cdsetspeed(struct cam_periph *periph,
 277                                    u_int32_t rdspeed, u_int32_t wrspeed);
 278 static  int             cdreportkey(struct cam_periph *periph,
 279                                     struct dvd_authinfo *authinfo);
 280 static  int             cdsendkey(struct cam_periph *periph,
 281                                   struct dvd_authinfo *authinfo);
 282 static  int             cdreaddvdstructure(struct cam_periph *periph,
 283                                            struct dvd_struct *dvdstruct);
 284
 285 static struct periph_driver cddriver =
 286 {
 287         cdinit, "cd",
 288         TAILQ_HEAD_INITIALIZER(cddriver.units), /* generation */ 0
 289 };
 290
 291 PERIPHDRIVER_DECLARE(cd, cddriver);
 292
 293 #ifndef CD_DEFAULT_RETRY
 294 #define CD_DEFAULT_RETRY        4
 295 #endif
 296 #ifndef CHANGER_MIN_BUSY_SECONDS
 297 #define CHANGER_MIN_BUSY_SECONDS        5
 298 #endif
 299 #ifndef CHANGER_MAX_BUSY_SECONDS
 300 #define CHANGER_MAX_BUSY_SECONDS        15
 301 #endif
 302
 303 static int cd_retry_count = CD_DEFAULT_RETRY;
 304 static int changer_min_busy_seconds = CHANGER_MIN_BUSY_SECONDS;
 305 static int changer_max_busy_seconds = CHANGER_MAX_BUSY_SECONDS;
 306
 307 SYSCTL_NODE(_kern_cam, OID_AUTO, cd, CTLFLAG_RD, 0, "CAM CDROM driver");
 308 SYSCTL_NODE(_kern_cam_cd, OID_AUTO, changer, CTLFLAG_RD, 0, "CD Changer");
 309 SYSCTL_INT(_kern_cam_cd, OID_AUTO, retry_count, CTLFLAG_RW,
 310            &cd_retry_count, 0, "Normal I/O retry count");
 311 TUNABLE_INT("kern.cam.cd.retry_count", &cd_retry_count);
 312 SYSCTL_INT(_kern_cam_cd_changer, OID_AUTO, min_busy_seconds, CTLFLAG_RW,
 313            &changer_min_busy_seconds, 0, "Minimum changer scheduling quantum");
 314 TUNABLE_INT("kern.cam.cd.changer.min_busy_seconds", &changer_min_busy_seconds);
 315 SYSCTL_INT(_kern_cam_cd_changer, OID_AUTO, max_busy_seconds, CTLFLAG_RW,
 316            &changer_max_busy_seconds, 0, "Maximum changer scheduling quantum");
 317 TUNABLE_INT("kern.cam.cd.changer.max_busy_seconds", &changer_max_busy_seconds);
 318
 319 struct cdchanger {
 320         path_id_t                        path_id;
 321         target_id_t                      target_id;
 322         int                              num_devices;
 323         struct camq                      devq;
 324         struct timeval                   start_time;
 325         struct cd_softc                  *cur_device;
 326         struct callout                   short_handle;
 327         struct callout                   long_handle;
 328         volatile cd_changer_flags        flags;
 329         STAILQ_ENTRY(cdchanger)          changer_links;
 330         STAILQ_HEAD(chdevlist, cd_softc) chluns;
 331 };
 332
 333 static struct mtx changerq_mtx;
 334 static STAILQ_HEAD(changerlist, cdchanger) changerq;
 335 static int num_changers;
 336
 337 MALLOC_DEFINE(M_SCSICD, "scsi_cd", "scsi_cd buffers");
 338
 339 static void
 340 cdinit(void)
 341 {
 342         cam_status status;
 343
 344         mtx_init(&changerq_mtx, "cdchangerq", "SCSI CD Changer List", MTX_DEF);
 345         STAILQ_INIT(&changerq);
 346
 347         /*
 348          * Install a global async callback.  This callback will
 349          * receive async callbacks like "new device found".
 350          */
 351         status = xpt_register_async(AC_FOUND_DEVICE, cdasync, NULL, NULL);
 352
 353         if (status != CAM_REQ_CMP) {
 354                 printf("cd: Failed to attach master async callback "
 355                        "due to status 0x%x!\n", status);
 356         }
 357 }
 358
 359 /*
 360  * Callback from GEOM, called when it has finished cleaning up its
 361  * resources.
 362  */
 363 static void
 364 cddiskgonecb(struct disk *dp)
 365 {
 366         struct cam_periph *periph;
 367
 368         periph = (struct cam_periph *)dp->d_drv1;
 369
 370         cam_periph_release(periph);
 371 }
 372
 373 static void
 374 cdoninvalidate(struct cam_periph *periph)
 375 {
 376         struct cd_softc *softc;
 377
 378         softc = (struct cd_softc *)periph->softc;
 379
 380         /*
 381          * De-register any async callbacks.
 382          */
 383         xpt_register_async(0, cdasync, periph, periph->path);
 384
 385         softc->flags |= CD_FLAG_INVALID;
 386
 387         /*
 388          * Return all queued I/O with ENXIO.
 389          * XXX Handle any transactions queued to the card
 390          *     with XPT_ABORT_CCB.
 391          */
 392         bioq_flush(&softc->bio_queue, NULL, ENXIO);
 393
 394         /*
 395          * If this device is part of a changer, and it was scheduled
 396          * to run, remove it from the run queue since we just nuked
 397          * all of its scheduled I/O.
 398          */
 399         if ((softc->flags & CD_FLAG_CHANGER)
 400          && (softc->pinfo.index != CAM_UNQUEUED_INDEX))
 401                 camq_remove(&softc->changer->devq, softc->pinfo.index);
 402
 403         disk_gone(softc->disk);
 404         xpt_print(periph->path, "lost device, %d refs\n", periph->refcount);
 405 }
 406
 407 static void
 408 cdcleanup(struct cam_periph *periph)
 409 {
 410         struct cd_softc *softc;
 411
 412         softc = (struct cd_softc *)periph->softc;
 413
 414         xpt_print(periph->path, "removing device entry\n");
 415
 416         /*
 417          * In the queued, non-active case, the device in question
 418          * has already been removed from the changer run queue.  Since this
 419          * device is active, we need to de-activate it, and schedule
 420          * another device to run.  (if there is another one to run)
 421          */
 422         if ((softc->flags & CD_FLAG_CHANGER)
 423          && (softc->flags & CD_FLAG_ACTIVE)) {
 424
 425                 /*
 426                  * The purpose of the short timeout is soley to determine
 427                  * whether the current device has finished or not.  Well,
 428                  * since we're removing the active device, we know that it
 429                  * is finished.  So, get rid of the short timeout.
 430                  * Otherwise, if we're in the time period before the short
 431                  * timeout fires, and there are no other devices in the
 432                  * queue to run, there won't be any other device put in the
 433                  * active slot.  i.e., when we call cdrunchangerqueue()
 434                  * below, it won't do anything.  Then, when the short
 435                  * timeout fires, it'll look at the "current device", which
 436                  * we are free below, and possibly panic the kernel on a
 437                  * bogus pointer reference.
 438                  *
 439                  * The long timeout doesn't really matter, since we
 440                  * decrement the qfrozen_cnt to indicate that there is
 441                  * nothing in the active slot now.  Therefore, there won't
 442                  * be any bogus pointer references there.
 443                  */
 444                 if (softc->changer->flags & CHANGER_SHORT_TMOUT_SCHED) {
 445                         callout_stop(&softc->changer->short_handle);
 446                         softc->changer->flags &= ~CHANGER_SHORT_TMOUT_SCHED;
 447                 }
 448                 softc->changer->devq.qfrozen_cnt[0]--;
 449                 softc->changer->flags |= CHANGER_MANUAL_CALL;
 450                 cdrunchangerqueue(softc->changer);
 451         }
 452
 453         /*
 454          * If we're removing the last device on the changer, go ahead and
 455          * remove the changer device structure.
 456          */
 457         if ((softc->flags & CD_FLAG_CHANGER)
 458          && (--softc->changer->num_devices == 0)) {
 459
 460                 /*
 461                  * Theoretically, there shouldn't be any timeouts left, but
 462                  * I'm not completely sure that that will be the case.  So,
 463                  * it won't hurt to check and see if there are any left.
 464                  */
 465                 if (softc->changer->flags & CHANGER_TIMEOUT_SCHED) {
 466                         callout_stop(&softc->changer->long_handle);
 467                         softc->changer->flags &= ~CHANGER_TIMEOUT_SCHED;
 468                 }
 469
 470                 if (softc->changer->flags & CHANGER_SHORT_TMOUT_SCHED) {
 471                         callout_stop(&softc->changer->short_handle);
 472                         softc->changer->flags &= ~CHANGER_SHORT_TMOUT_SCHED;
 473                 }
 474
 475                 mtx_lock(&changerq_mtx);
 476                 STAILQ_REMOVE(&changerq, softc->changer, cdchanger,
 477                               changer_links);
 478                 num_changers--;
 479                 mtx_unlock(&changerq_mtx);
 480                 xpt_print(periph->path, "removing changer entry\n");
 481                 free(softc->changer, M_DEVBUF);
 482         }
 483         cam_periph_unlock(periph);
 484         if ((softc->flags & CD_FLAG_SCTX_INIT) != 0
 485             && sysctl_ctx_free(&softc->sysctl_ctx) != 0) {
 486                 xpt_print(periph->path, "can't remove sysctl context\n");
 487         }
 488
 489         disk_destroy(softc->disk);
 490         free(softc, M_DEVBUF);
 491         cam_periph_lock(periph);
 492 }
 493
 494 static void
 495 cdasync(void *callback_arg, u_int32_t code,
 496         struct cam_path *path, void *arg)
 497 {
 498         struct cam_periph *periph;
 499
 500         periph = (struct cam_periph *)callback_arg;
 501         switch (code) {
 502         case AC_FOUND_DEVICE:
 503         {
 504                 struct ccb_getdev *cgd;
 505                 cam_status status;
 506
 507                 cgd = (struct ccb_getdev *)arg;
 508                 if (cgd == NULL)
 509                         break;
 510
 511                 if (cgd->protocol != PROTO_SCSI)
 512                         break;
 513
 514                 if (SID_TYPE(&cgd->inq_data) != T_CDROM
 515                     && SID_TYPE(&cgd->inq_data) != T_WORM)
 516                         break;
 517
 518                 /*
 519                  * Allocate a peripheral instance for
 520                  * this device and start the probe
 521                  * process.
 522                  */
 523                 status = cam_periph_alloc(cdregister, cdoninvalidate,
 524                                           cdcleanup, cdstart,
 525                                           "cd", CAM_PERIPH_BIO,
 526                                           cgd->ccb_h.path, cdasync,
 527                                           AC_FOUND_DEVICE, cgd);
 528
 529                 if (status != CAM_REQ_CMP
 530                  && status != CAM_REQ_INPROG)
 531                         printf("cdasync: Unable to attach new device "
 532                                "due to status 0x%x\n", status);
 533
 534                 break;
 535         }
 536         case AC_SENT_BDR:
 537         case AC_BUS_RESET:
 538         {
 539                 struct cd_softc *softc;
 540                 struct ccb_hdr *ccbh;
 541
 542                 softc = (struct cd_softc *)periph->softc;
 543                 /*
 544                  * Don't fail on the expected unit attention
 545                  * that will occur.
 546                  */
 547                 softc->flags |= CD_FLAG_RETRY_UA;
 548                 LIST_FOREACH(ccbh, &softc->pending_ccbs, periph_links.le)
 549                         ccbh->ccb_state |= CD_CCB_RETRY_UA;
 550                 /* FALLTHROUGH */
 551         }
 552         default:
 553                 cam_periph_async(periph, code, path, arg);
 554                 break;
 555         }
 556 }
 557
 558 static void
 559 cdsysctlinit(void *context, int pending)
 560 {
 561         struct cam_periph *periph;
 562         struct cd_softc *softc;
 563         char tmpstr[80], tmpstr2[80];
 564
 565         periph = (struct cam_periph *)context;
 566         if (cam_periph_acquire(periph) != CAM_REQ_CMP)
 567                 return;
 568
 569         softc = (struct cd_softc *)periph->softc;
 570         snprintf(tmpstr, sizeof(tmpstr), "CAM CD unit %d", periph->unit_number);
 571         snprintf(tmpstr2, sizeof(tmpstr2), "%d", periph->unit_number);
 572
 573         sysctl_ctx_init(&softc->sysctl_ctx);
 574         softc->flags |= CD_FLAG_SCTX_INIT;
 575         softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
 576                 SYSCTL_STATIC_CHILDREN(_kern_cam_cd), OID_AUTO,
 577                 tmpstr2, CTLFLAG_RD, 0, tmpstr);
 578
 579         if (softc->sysctl_tree == NULL) {
 580                 printf("cdsysctlinit: unable to allocate sysctl tree\n");
 581                 cam_periph_release(periph);
 582                 return;
 583         }
 584
 585         /*
 586          * Now register the sysctl handler, so the user can the value on
 587          * the fly.
 588          */
 589         SYSCTL_ADD_PROC(&softc->sysctl_ctx,SYSCTL_CHILDREN(softc->sysctl_tree),
 590                 OID_AUTO, "minimum_cmd_size", CTLTYPE_INT | CTLFLAG_RW,
 591                 &softc->minimum_command_size, 0, cdcmdsizesysctl, "I",
 592                 "Minimum CDB size");
 593
 594         cam_periph_release(periph);
 595 }
 596
 597 /*
 598  * We have a handler function for this so we can check the values when the
 599  * user sets them, instead of every time we look at them.
 600  */
 601 static int
 602 cdcmdsizesysctl(SYSCTL_HANDLER_ARGS)
 603 {
 604         int error, value;
 605
 606         value = *(int *)arg1;
 607
 608         error = sysctl_handle_int(oidp, &value, 0, req);
 609
 610         if ((error != 0)
 611          || (req->newptr == NULL))
 612                 return (error);
 613
 614         /*
 615          * The only real values we can have here are 6 or 10.  I don't
 616          * really forsee having 12 be an option at any time in the future.
 617          * So if the user sets something less than or equal to 6, we'll set
 618          * it to 6.  If he sets something greater than 6, we'll set it to 10.
 619          *
 620          * I suppose we could just return an error here for the wrong values,
 621          * but I don't think it's necessary to do so, as long as we can
 622          * determine the user's intent without too much trouble.
 623          */
 624         if (value < 6)
 625                 value = 6;
 626         else if (value > 6)
 627                 value = 10;
 628
 629         *(int *)arg1 = value;
 630
 631         return (0);
 632 }
 633
 634 static cam_status
 635 cdregister(struct cam_periph *periph, void *arg)
 636 {
 637         struct cd_softc *softc;
 638         struct ccb_pathinq cpi;
 639         struct ccb_getdev *cgd;
 640         char tmpstr[80];
 641         caddr_t match;
 642
 643         cgd = (struct ccb_getdev *)arg;
 644         if (periph == NULL) {
 645                 printf("cdregister: periph was NULL!!\n");
 646                 return(CAM_REQ_CMP_ERR);
 647         }
 648         if (cgd == NULL) {
 649                 printf("cdregister: no getdev CCB, can't register device\n");
 650                 return(CAM_REQ_CMP_ERR);
 651         }
 652
 653         softc = (struct cd_softc *)malloc(sizeof(*softc),M_DEVBUF,
 654             M_NOWAIT | M_ZERO);
 655         if (softc == NULL) {
 656                 printf("cdregister: Unable to probe new device. "
 657                        "Unable to allocate softc\n");
 658                 return(CAM_REQ_CMP_ERR);
 659         }
 660
 661         LIST_INIT(&softc->pending_ccbs);
 662         STAILQ_INIT(&softc->mode_queue);
 663         softc->state = CD_STATE_PROBE;
 664         bioq_init(&softc->bio_queue);
 665         if (SID_IS_REMOVABLE(&cgd->inq_data))
 666                 softc->flags |= CD_FLAG_DISC_REMOVABLE;
 667
 668         periph->softc = softc;
 669         softc->periph = periph;
 670
 671         /*
 672          * See if this device has any quirks.
 673          */
 674         match = cam_quirkmatch((caddr_t)&cgd->inq_data,
 675                                (caddr_t)cd_quirk_table,
 676                                sizeof(cd_quirk_table)/sizeof(*cd_quirk_table),
 677                                sizeof(*cd_quirk_table), scsi_inquiry_match);
 678
 679         if (match != NULL)
 680                 softc->quirks = ((struct cd_quirk_entry *)match)->quirks;
 681         else
 682                 softc->quirks = CD_Q_NONE;
 683
 684         /* Check if the SIM does not want 6 byte commands */
 685         bzero(&cpi, sizeof(cpi));
 686         xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 687         cpi.ccb_h.func_code = XPT_PATH_INQ;
 688         xpt_action((union ccb *)&cpi);
 689         if (cpi.ccb_h.status == CAM_REQ_CMP && (cpi.hba_misc & PIM_NO_6_BYTE))
 690                 softc->quirks |= CD_Q_10_BYTE_ONLY;
 691
 692         TASK_INIT(&softc->sysctl_task, 0, cdsysctlinit, periph);
 693
 694         /* The default is 6 byte commands, unless quirked otherwise */
 695         if (softc->quirks & CD_Q_10_BYTE_ONLY)
 696                 softc->minimum_command_size = 10;
 697         else
 698                 softc->minimum_command_size = 6;
 699
 700         /*
 701          * Refcount and block open attempts until we are setup
 702          * Can't block
 703          */
 704         (void)cam_periph_hold(periph, PRIBIO);
 705         cam_periph_unlock(periph);
 706         /*
 707          * Load the user's default, if any.
 708          */
 709         snprintf(tmpstr, sizeof(tmpstr), "kern.cam.cd.%d.minimum_cmd_size",
 710                  periph->unit_number);
 711         TUNABLE_INT_FETCH(tmpstr, &softc->minimum_command_size);
 712
 713         /* 6 and 10 are the only permissible values here. */
 714         if (softc->minimum_command_size < 6)
 715                 softc->minimum_command_size = 6;
 716         else if (softc->minimum_command_size > 6)
 717                 softc->minimum_command_size = 10;
 718
 719         /*
 720          * We need to register the statistics structure for this device,
 721          * but we don't have the blocksize yet for it.  So, we register
 722          * the structure and indicate that we don't have the blocksize
 723          * yet.  Unlike other SCSI peripheral drivers, we explicitly set
 724          * the device type here to be CDROM, rather than just ORing in
 725          * the device type.  This is because this driver can attach to either
 726          * CDROM or WORM devices, and we want this peripheral driver to
 727          * show up in the devstat list as a CD peripheral driver, not a
 728          * WORM peripheral driver.  WORM drives will also have the WORM
 729          * driver attached to them.
 730          */
 731         softc->disk = disk_alloc();
 732         softc->disk->d_devstat = devstat_new_entry("cd",
 733                           periph->unit_number, 0,
 734                           DEVSTAT_BS_UNAVAILABLE,
 735                           DEVSTAT_TYPE_CDROM |
 736                           XPORT_DEVSTAT_TYPE(cpi.transport),
 737                           DEVSTAT_PRIORITY_CD);
 738         softc->disk->d_open = cdopen;
 739         softc->disk->d_close = cdclose;
 740         softc->disk->d_strategy = cdstrategy;
 741         softc->disk->d_gone = cddiskgonecb;
 742         softc->disk->d_ioctl = cdioctl;
 743         softc->disk->d_name = "cd";
 744         cam_strvis(softc->disk->d_descr, cgd->inq_data.vendor,
 745             sizeof(cgd->inq_data.vendor), sizeof(softc->disk->d_descr));
 746         strlcat(softc->disk->d_descr, " ", sizeof(softc->disk->d_descr));
 747         cam_strvis(&softc->disk->d_descr[strlen(softc->disk->d_descr)],
 748             cgd->inq_data.product, sizeof(cgd->inq_data.product),
 749             sizeof(softc->disk->d_descr) - strlen(softc->disk->d_descr));
 750         softc->disk->d_unit = periph->unit_number;
 751         softc->disk->d_drv1 = periph;
 752         if (cpi.maxio == 0)
 753                 softc->disk->d_maxsize = DFLTPHYS;      /* traditional default */
 754         else if (cpi.maxio > MAXPHYS)
 755                 softc->disk->d_maxsize = MAXPHYS;       /* for safety */
 756         else
 757                 softc->disk->d_maxsize = cpi.maxio;
 758         softc->disk->d_flags = 0;
 759         softc->disk->d_hba_vendor = cpi.hba_vendor;
 760         softc->disk->d_hba_device = cpi.hba_device;
 761         softc->disk->d_hba_subvendor = cpi.hba_subvendor;
 762         softc->disk->d_hba_subdevice = cpi.hba_subdevice;
 763
 764         /*
 765          * Acquire a reference to the periph before we register with GEOM.
 766          * We'll release this reference once GEOM calls us back (via
 767          * dadiskgonecb()) telling us that our provider has been freed.
 768          */
 769         if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
 770                 xpt_print(periph->path, "%s: lost periph during "
 771                           "registration!\n", __func__);
 772                 cam_periph_lock(periph);
 773                 return (CAM_REQ_CMP_ERR);
 774         }
 775
 776         disk_create(softc->disk, DISK_VERSION);
 777         cam_periph_lock(periph);
 778
 779         /*
 780          * Add an async callback so that we get
 781          * notified if this device goes away.
 782          */
 783         xpt_register_async(AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE,
 784                            cdasync, periph, periph->path);
 785
 786         /*
 787          * If the target lun is greater than 0, we most likely have a CD
 788          * changer device.  Check the quirk entries as well, though, just
 789          * in case someone has a CD tower with one lun per drive or
 790          * something like that.  Also, if we know up front that a
 791          * particular device is a changer, we can mark it as such starting
 792          * with lun 0, instead of lun 1.  It shouldn't be necessary to have
 793          * a quirk entry to define something as a changer, however.
 794          */
 795         if (((cgd->ccb_h.target_lun > 0)
 796           && ((softc->quirks & CD_Q_NO_CHANGER) == 0))
 797          || ((softc->quirks & CD_Q_CHANGER) != 0)) {
 798                 struct cdchanger *nchanger;
 799                 struct cam_periph *nperiph;
 800                 struct cam_path *path;
 801                 cam_status status;
 802                 int found;
 803
 804                 /* Set the changer flag in the current device's softc */
 805                 softc->flags |= CD_FLAG_CHANGER;
 806
 807                 /*
 808                  * Now, look around for an existing changer device with the
 809                  * same path and target ID as the current device.
 810                  */
 811                 mtx_lock(&changerq_mtx);
 812                 for (found = 0,
 813                      nchanger = (struct cdchanger *)STAILQ_FIRST(&changerq);
 814                      nchanger != NULL;
 815                      nchanger = STAILQ_NEXT(nchanger, changer_links)){
 816                         if ((nchanger->path_id == cgd->ccb_h.path_id)
 817                          && (nchanger->target_id == cgd->ccb_h.target_id)) {
 818                                 found = 1;
 819                                 break;
 820                         }
 821                 }
 822                 mtx_unlock(&changerq_mtx);
 823
 824                 /*
 825                  * If we found a matching entry, just add this device to
 826                  * the list of devices on this changer.
 827                  */
 828                 if (found == 1) {
 829                         struct chdevlist *chlunhead;
 830
 831                         chlunhead = &nchanger->chluns;
 832
 833                         /*
 834                          * XXX KDM look at consolidating this code with the
 835                          * code below in a separate function.
 836                          */
 837
 838                         /*
 839                          * Create a path with lun id 0, and see if we can
 840                          * find a matching device
 841                          */
 842                         status = xpt_create_path(&path, /*periph*/ periph,
 843                                                  cgd->ccb_h.path_id,
 844                                                  cgd->ccb_h.target_id, 0);
 845
 846                         if ((status == CAM_REQ_CMP)
 847                          && ((nperiph = cam_periph_find(path, "cd")) != NULL)){
 848                                 struct cd_softc *nsoftc;
 849
 850                                 nsoftc = (struct cd_softc *)nperiph->softc;
 851
 852                                 if ((nsoftc->flags & CD_FLAG_CHANGER) == 0){
 853                                         nsoftc->flags |= CD_FLAG_CHANGER;
 854                                         nchanger->num_devices++;
 855                                         if (camq_resize(&nchanger->devq,
 856                                            nchanger->num_devices)!=CAM_REQ_CMP){
 857                                                 printf("cdregister: "
 858                                                        "camq_resize "
 859                                                        "failed, changer "
 860                                                        "support may "
 861                                                        "be messed up\n");
 862                                         }
 863                                         nsoftc->changer = nchanger;
 864                                         nsoftc->pinfo.index =CAM_UNQUEUED_INDEX;
 865
 866                                         STAILQ_INSERT_TAIL(&nchanger->chluns,
 867                                                           nsoftc,changer_links);
 868                                 }
 869                                 xpt_free_path(path);
 870                         } else if (status == CAM_REQ_CMP)
 871                                 xpt_free_path(path);
 872                         else {
 873                                 printf("cdregister: unable to allocate path\n"
 874                                        "cdregister: changer support may be "
 875                                        "broken\n");
 876                         }
 877
 878                         nchanger->num_devices++;
 879
 880                         softc->changer = nchanger;
 881                         softc->pinfo.index = CAM_UNQUEUED_INDEX;
 882
 883                         if (camq_resize(&nchanger->devq,
 884                             nchanger->num_devices) != CAM_REQ_CMP) {
 885                                 printf("cdregister: camq_resize "
 886                                        "failed, changer support may "
 887                                        "be messed up\n");
 888                         }
 889
 890                         STAILQ_INSERT_TAIL(chlunhead, softc, changer_links);
 891                 }
 892                 /*
 893                  * In this case, we don't already have an entry for this
 894                  * particular changer, so we need to create one, add it to
 895                  * the queue, and queue this device on the list for this
 896                  * changer.  Before we queue this device, however, we need
 897                  * to search for lun id 0 on this target, and add it to the
 898                  * queue first, if it exists.  (and if it hasn't already
 899                  * been marked as part of the changer.)
 900                  */
 901                 else {
 902                         nchanger = malloc(sizeof(struct cdchanger),
 903                                 M_DEVBUF, M_NOWAIT | M_ZERO);
 904                         if (nchanger == NULL) {
 905                                 softc->flags &= ~CD_FLAG_CHANGER;
 906                                 printf("cdregister: unable to malloc "
 907                                        "changer structure\ncdregister: "
 908                                        "changer support disabled\n");
 909
 910                                 /*
 911                                  * Yes, gotos can be gross but in this case
 912                                  * I think it's justified..
 913                                  */
 914                                 goto cdregisterexit;
 915                         }
 916                         if (camq_init(&nchanger->devq, 1) != 0) {
 917                                 softc->flags &= ~CD_FLAG_CHANGER;
 918                                 printf("cdregister: changer support "
 919                                        "disabled\n");
 920                                 goto cdregisterexit;
 921                         }
 922
 923                         nchanger->path_id = cgd->ccb_h.path_id;
 924                         nchanger->target_id = cgd->ccb_h.target_id;
 925
 926                         /* this is superfluous, but it makes things clearer */
 927                         nchanger->num_devices = 0;
 928
 929                         STAILQ_INIT(&nchanger->chluns);
 930
 931                         callout_init_mtx(&nchanger->long_handle,
 932                             periph->sim->mtx, 0);
 933                         callout_init_mtx(&nchanger->short_handle,
 934                             periph->sim->mtx, 0);
 935
 936                         mtx_lock(&changerq_mtx);
 937                         num_changers++;
 938                         STAILQ_INSERT_TAIL(&changerq, nchanger,
 939                                            changer_links);
 940                         mtx_unlock(&changerq_mtx);
 941
 942                         /*
 943                          * Create a path with lun id 0, and see if we can
 944                          * find a matching device
 945                          */
 946                         status = xpt_create_path(&path, /*periph*/ periph,
 947                                                  cgd->ccb_h.path_id,
 948                                                  cgd->ccb_h.target_id, 0);
 949
 950                         /*
 951                          * If we were able to allocate the path, and if we
 952                          * find a matching device and it isn't already
 953                          * marked as part of a changer, then we add it to
 954                          * the current changer.
 955                          */
 956                         if ((status == CAM_REQ_CMP)
 957                          && ((nperiph = cam_periph_find(path, "cd")) != NULL)
 958                          && ((((struct cd_softc *)periph->softc)->flags &
 959                                CD_FLAG_CHANGER) == 0)) {
 960                                 struct cd_softc *nsoftc;
 961
 962                                 nsoftc = (struct cd_softc *)nperiph->softc;
 963
 964                                 nsoftc->flags |= CD_FLAG_CHANGER;
 965                                 nchanger->num_devices++;
 966                                 if (camq_resize(&nchanger->devq,
 967                                     nchanger->num_devices) != CAM_REQ_CMP) {
 968                                         printf("cdregister: camq_resize "
 969                                                "failed, changer support may "
 970                                                "be messed up\n");
 971                                 }
 972                                 nsoftc->changer = nchanger;
 973                                 nsoftc->pinfo.index = CAM_UNQUEUED_INDEX;
 974
 975                                 STAILQ_INSERT_TAIL(&nchanger->chluns,
 976                                                    nsoftc, changer_links);
 977                                 xpt_free_path(path);
 978                         } else if (status == CAM_REQ_CMP)
 979                                 xpt_free_path(path);
 980                         else {
 981                                 printf("cdregister: unable to allocate path\n"
 982                                        "cdregister: changer support may be "
 983                                        "broken\n");
 984                         }
 985
 986                         softc->changer = nchanger;
 987                         softc->pinfo.index = CAM_UNQUEUED_INDEX;
 988                         nchanger->num_devices++;
 989                         if (camq_resize(&nchanger->devq,
 990                             nchanger->num_devices) != CAM_REQ_CMP) {
 991                                 printf("cdregister: camq_resize "
 992                                        "failed, changer support may "
 993                                        "be messed up\n");
 994                         }
 995                         STAILQ_INSERT_TAIL(&nchanger->chluns, softc,
 996                                            changer_links);
 997                 }
 998         }
 999
1000 cdregisterexit:
1001
1002         if ((softc->flags & CD_FLAG_CHANGER) == 0)
1003                 xpt_schedule(periph, CAM_PRIORITY_DEV);
1004         else
1005                 cdschedule(periph, CAM_PRIORITY_DEV);
1006
1007         return(CAM_REQ_CMP);
1008 }
1009
1010 static int
1011 cdopen(struct disk *dp)
1012 {
1013         struct cam_periph *periph;
1014         struct cd_softc *softc;
1015         int error;
1016
1017         periph = (struct cam_periph *)dp->d_drv1;
1018         if (periph == NULL)
1019                 return (ENXIO);
1020
1021         softc = (struct cd_softc *)periph->softc;
1022
1023         if (cam_periph_acquire(periph) != CAM_REQ_CMP)
1024                 return(ENXIO);
1025
1026         cam_periph_lock(periph);
1027
1028         if (softc->flags & CD_FLAG_INVALID) {
1029                 cam_periph_release_locked(periph);
1030                 cam_periph_unlock(periph);
1031                 return(ENXIO);
1032         }
1033
1034         if ((error = cam_periph_hold(periph, PRIBIO | PCATCH)) != 0) {
1035                 cam_periph_release_locked(periph);
1036                 cam_periph_unlock(periph);
1037                 return (error);
1038         }
1039
1040         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
1041             ("cdopen\n"));
1042
1043         /*
1044          * Check for media, and set the appropriate flags.  We don't bail
1045          * if we don't have media, but then we don't allow anything but the
1046          * CDIOCEJECT/CDIOCCLOSE ioctls if there is no media.
1047          */
1048         cdcheckmedia(periph);
1049
1050         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("leaving cdopen\n"));
1051         cam_periph_unhold(periph);
1052
1053         cam_periph_unlock(periph);
1054
1055         return (0);
1056 }
1057
1058 static int
1059 cdclose(struct disk *dp)
1060 {
1061         struct  cam_periph *periph;
1062         struct  cd_softc *softc;
1063
1064         periph = (struct cam_periph *)dp->d_drv1;
1065         if (periph == NULL)
1066                 return (ENXIO);
1067
1068         softc = (struct cd_softc *)periph->softc;
1069
1070         cam_periph_lock(periph);
1071         if (cam_periph_hold(periph, PRIBIO) != 0) {
1072                 cam_periph_unlock(periph);
1073                 cam_periph_release(periph);
1074                 return (0);
1075         }
1076
1077         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
1078             ("cdclose\n"));
1079
1080         if ((softc->flags & CD_FLAG_DISC_REMOVABLE) != 0)
1081                 cdprevent(periph, PR_ALLOW);
1082
1083         /*
1084          * Since we're closing this CD, mark the blocksize as unavailable.
1085          * It will be marked as available when the CD is opened again.
1086          */
1087         softc->disk->d_devstat->flags |= DEVSTAT_BS_UNAVAILABLE;
1088
1089         /*
1090          * We'll check the media and toc again at the next open().
1091          */
1092         softc->flags &= ~(CD_FLAG_VALID_MEDIA|CD_FLAG_VALID_TOC);
1093
1094         cam_periph_unhold(periph);
1095         cam_periph_release_locked(periph);
1096         cam_periph_unlock(periph);
1097
1098         return (0);
1099 }
1100
1101 static void
1102 cdshorttimeout(void *arg)
1103 {
1104         struct cdchanger *changer;
1105
1106         changer = (struct cdchanger *)arg;
1107
1108         /* Always clear the short timeout flag, since that's what we're in */
1109         changer->flags &= ~CHANGER_SHORT_TMOUT_SCHED;
1110
1111         /*
1112          * Check to see if there is any more pending or outstanding I/O for
1113          * this device.  If not, move it out of the active slot.
1114          */
1115         if ((bioq_first(&changer->cur_device->bio_queue) == NULL)
1116          && (changer->cur_device->outstanding_cmds == 0)) {
1117                 changer->flags |= CHANGER_MANUAL_CALL;
1118                 cdrunchangerqueue(changer);
1119         }
1120 }
1121
1122 /*
1123  * This is a wrapper for xpt_schedule.  It only applies to changers.
1124  */
1125 static void
1126 cdschedule(struct cam_periph *periph, int priority)
1127 {
1128         struct cd_softc *softc;
1129
1130         softc = (struct cd_softc *)periph->softc;
1131
1132         /*
1133          * If this device isn't currently queued, and if it isn't
1134          * the active device, then we queue this device and run the
1135          * changer queue if there is no timeout scheduled to do it.
1136          * If this device is the active device, just schedule it
1137          * to run again.  If this device is queued, there should be
1138          * a timeout in place already that will make sure it runs.
1139          */
1140         if ((softc->pinfo.index == CAM_UNQUEUED_INDEX)
1141          && ((softc->flags & CD_FLAG_ACTIVE) == 0)) {
1142                 /*
1143                  * We don't do anything with the priority here.
1144                  * This is strictly a fifo queue.
1145                  */
1146                 softc->pinfo.priority = CAM_PRIORITY_NORMAL;
1147                 softc->pinfo.generation = ++softc->changer->devq.generation;
1148                 camq_insert(&softc->changer->devq, (cam_pinfo *)softc);
1149
1150                 /*
1151                  * Since we just put a device in the changer queue,
1152                  * check and see if there is a timeout scheduled for
1153                  * this changer.  If so, let the timeout handle
1154                  * switching this device into the active slot.  If
1155                  * not, manually call the timeout routine to
1156                  * bootstrap things.
1157                  */
1158                 if (((softc->changer->flags & CHANGER_TIMEOUT_SCHED)==0)
1159                  && ((softc->changer->flags & CHANGER_NEED_TIMEOUT)==0)
1160                  && ((softc->changer->flags & CHANGER_SHORT_TMOUT_SCHED)==0)){
1161                         softc->changer->flags |= CHANGER_MANUAL_CALL;
1162                         cdrunchangerqueue(softc->changer);
1163                 }
1164         } else if ((softc->flags & CD_FLAG_ACTIVE)
1165                 && ((softc->flags & CD_FLAG_SCHED_ON_COMP) == 0))
1166                 xpt_schedule(periph, priority);
1167 }
1168
1169 static void
1170 cdrunchangerqueue(void *arg)
1171 {
1172         struct cd_softc *softc;
1173         struct cdchanger *changer;
1174         int called_from_timeout;
1175
1176         changer = (struct cdchanger *)arg;
1177
1178         /*
1179          * If we have NOT been called from cdstrategy() or cddone(), and
1180          * instead from a timeout routine, go ahead and clear the
1181          * timeout flag.
1182          */
1183         if ((changer->flags & CHANGER_MANUAL_CALL) == 0) {
1184                 changer->flags &= ~CHANGER_TIMEOUT_SCHED;
1185                 called_from_timeout = 1;
1186         } else
1187                 called_from_timeout = 0;
1188
1189         /* Always clear the manual call flag */
1190         changer->flags &= ~CHANGER_MANUAL_CALL;
1191
1192         /* nothing to do if the queue is empty */
1193         if (changer->devq.entries <= 0) {
1194                 return;
1195         }
1196
1197         /*
1198          * If the changer queue is frozen, that means we have an active
1199          * device.
1200          */
1201         if (changer->devq.qfrozen_cnt[0] > 0) {
1202
1203                 /*
1204                  * We always need to reset the frozen count and clear the
1205                  * active flag.
1206                  */
1207                 changer->devq.qfrozen_cnt[0]--;
1208                 changer->cur_device->flags &= ~CD_FLAG_ACTIVE;
1209                 changer->cur_device->flags &= ~CD_FLAG_SCHED_ON_COMP;
1210
1211                 if (changer->cur_device->outstanding_cmds > 0) {
1212                         changer->cur_device->flags |= CD_FLAG_SCHED_ON_COMP;
1213                         changer->cur_device->bufs_left =
1214                                 changer->cur_device->outstanding_cmds;
1215                         if (called_from_timeout) {
1216                                 callout_reset(&changer->long_handle,
1217                                     changer_max_busy_seconds * hz,
1218                                     cdrunchangerqueue, changer);
1219                                 changer->flags |= CHANGER_TIMEOUT_SCHED;
1220                         }
1221                         return;
1222                 }
1223
1224                 /*
1225                  * Check to see whether the current device has any I/O left
1226                  * to do.  If so, requeue it at the end of the queue.  If
1227                  * not, there is no need to requeue it.
1228                  */
1229                 if (bioq_first(&changer->cur_device->bio_queue) != NULL) {
1230
1231                         changer->cur_device->pinfo.generation =
1232                                 ++changer->devq.generation;
1233                         camq_insert(&changer->devq,
1234                                 (cam_pinfo *)changer->cur_device);
1235                 }
1236         }
1237
1238         softc = (struct cd_softc *)camq_remove(&changer->devq, CAMQ_HEAD);
1239
1240         changer->cur_device = softc;
1241
1242         changer->devq.qfrozen_cnt[0]++;
1243         softc->flags |= CD_FLAG_ACTIVE;
1244
1245         /* Just in case this device is waiting */
1246         wakeup(&softc->changer);
1247         xpt_schedule(softc->periph, CAM_PRIORITY_NORMAL);
1248
1249         /*
1250          * Get rid of any pending timeouts, and set a flag to schedule new
1251          * ones so this device gets its full time quantum.
1252          */
1253         if (changer->flags & CHANGER_TIMEOUT_SCHED) {
1254                 callout_stop(&changer->long_handle);
1255                 changer->flags &= ~CHANGER_TIMEOUT_SCHED;
1256         }
1257
1258         if (changer->flags & CHANGER_SHORT_TMOUT_SCHED) {
1259                 callout_stop(&changer->short_handle);
1260                 changer->flags &= ~CHANGER_SHORT_TMOUT_SCHED;
1261         }
1262
1263         /*
1264          * We need to schedule timeouts, but we only do this after the
1265          * first transaction has completed.  This eliminates the changer
1266          * switch time.
1267          */
1268         changer->flags |= CHANGER_NEED_TIMEOUT;
1269 }
1270
1271 static void
1272 cdchangerschedule(struct cd_softc *softc)
1273 {
1274         struct cdchanger *changer;
1275
1276         changer = softc->changer;
1277
1278         /*
1279          * If this is a changer, and this is the current device,
1280          * and this device has at least the minimum time quantum to
1281          * run, see if we can switch it out.
1282          */
1283         if ((softc->flags & CD_FLAG_ACTIVE)
1284          && ((changer->flags & CHANGER_SHORT_TMOUT_SCHED) == 0)
1285          && ((changer->flags & CHANGER_NEED_TIMEOUT) == 0)) {
1286                 /*
1287                  * We try three things here.  The first is that we
1288                  * check to see whether the schedule on completion
1289                  * flag is set.  If it is, we decrement the number
1290                  * of buffers left, and if it's zero, we reschedule.
1291                  * Next, we check to see whether the pending buffer
1292                  * queue is empty and whether there are no
1293                  * outstanding transactions.  If so, we reschedule.
1294                  * Next, we see if the pending buffer queue is empty.
1295                  * If it is, we set the number of buffers left to
1296                  * the current active buffer count and set the
1297                  * schedule on complete flag.
1298                  */
1299                 if (softc->flags & CD_FLAG_SCHED_ON_COMP) {
1300                         if (--softc->bufs_left == 0) {
1301                                 softc->changer->flags |=
1302                                         CHANGER_MANUAL_CALL;
1303                                 softc->flags &= ~CD_FLAG_SCHED_ON_COMP;
1304                                 cdrunchangerqueue(softc->changer);
1305                         }
1306                 } else if ((bioq_first(&softc->bio_queue) == NULL)
1307                         && (softc->outstanding_cmds == 0)) {
1308                         softc->changer->flags |= CHANGER_MANUAL_CALL;
1309                         cdrunchangerqueue(softc->changer);
1310                 }
1311         } else if ((softc->changer->flags & CHANGER_NEED_TIMEOUT)
1312                 && (softc->flags & CD_FLAG_ACTIVE)) {
1313
1314                 /*
1315                  * Now that the first transaction to this
1316                  * particular device has completed, we can go ahead
1317                  * and schedule our timeouts.
1318                  */
1319                 if ((changer->flags & CHANGER_TIMEOUT_SCHED) == 0) {
1320                         callout_reset(&changer->long_handle,
1321                             changer_max_busy_seconds * hz,
1322                             cdrunchangerqueue, changer);
1323                         changer->flags |= CHANGER_TIMEOUT_SCHED;
1324                 } else
1325                         printf("cdchangerschedule: already have a long"
1326                                " timeout!\n");
1327
1328                 if ((changer->flags & CHANGER_SHORT_TMOUT_SCHED) == 0) {
1329                         callout_reset(&changer->short_handle,
1330                             changer_min_busy_seconds * hz,
1331                             cdshorttimeout, changer);
1332                         changer->flags |= CHANGER_SHORT_TMOUT_SCHED;
1333                 } else
1334                         printf("cdchangerschedule: already have a short "
1335                                "timeout!\n");
1336
1337                 /*
1338                  * We just scheduled timeouts, no need to schedule
1339                  * more.
1340                  */
1341                 changer->flags &= ~CHANGER_NEED_TIMEOUT;
1342
1343         }
1344 }
1345
1346 static int
1347 cdrunccb(union ccb *ccb, int (*error_routine)(union ccb *ccb,
1348                                               u_int32_t cam_flags,
1349                                               u_int32_t sense_flags),
1350          u_int32_t cam_flags, u_int32_t sense_flags)
1351 {
1352         struct cd_softc *softc;
1353         struct cam_periph *periph;
1354         int error;
1355
1356         periph = xpt_path_periph(ccb->ccb_h.path);
1357         softc = (struct cd_softc *)periph->softc;
1358
1359         error = cam_periph_runccb(ccb, error_routine, cam_flags, sense_flags,
1360                                   softc->disk->d_devstat);
1361
1362         if (softc->flags & CD_FLAG_CHANGER)
1363                 cdchangerschedule(softc);
1364
1365         return(error);
1366 }
1367
1368 static union ccb *
1369 cdgetccb(struct cam_periph *periph, u_int32_t priority)
1370 {
1371         struct cd_softc *softc;
1372
1373         softc = (struct cd_softc *)periph->softc;
1374
1375         if (softc->flags & CD_FLAG_CHANGER) {
1376                 /*
1377                  * This should work the first time this device is woken up,
1378                  * but just in case it doesn't, we use a while loop.
1379                  */
1380                 while ((softc->flags & CD_FLAG_ACTIVE) == 0) {
1381                         /*
1382                          * If this changer isn't already queued, queue it up.
1383                          */
1384                         if (softc->pinfo.index == CAM_UNQUEUED_INDEX) {
1385                                 softc->pinfo.priority = CAM_PRIORITY_NORMAL;
1386                                 softc->pinfo.generation =
1387                                         ++softc->changer->devq.generation;
1388                                 camq_insert(&softc->changer->devq,
1389                                             (cam_pinfo *)softc);
1390                         }
1391                         if (((softc->changer->flags & CHANGER_TIMEOUT_SCHED)==0)
1392                          && ((softc->changer->flags & CHANGER_NEED_TIMEOUT)==0)
1393                          && ((softc->changer->flags
1394                               & CHANGER_SHORT_TMOUT_SCHED)==0)) {
1395                                 softc->changer->flags |= CHANGER_MANUAL_CALL;
1396                                 cdrunchangerqueue(softc->changer);
1397                         } else
1398                                 msleep(&softc->changer, periph->sim->mtx,
1399                                     PRIBIO, "cgticb", 0);
1400                 }
1401         }
1402         return(cam_periph_getccb(periph, priority));
1403 }
1404
1405
1406 /*
1407  * Actually translate the requested transfer into one the physical driver
1408  * can understand.  The transfer is described by a buf and will include
1409  * only one physical transfer.
1410  */
1411 static void
1412 cdstrategy(struct bio *bp)
1413 {
1414         struct cam_periph *periph;
1415         struct cd_softc *softc;
1416
1417         periph = (struct cam_periph *)bp->bio_disk->d_drv1;
1418         if (periph == NULL) {
1419                 biofinish(bp, NULL, ENXIO);
1420                 return;
1421         }
1422
1423         cam_periph_lock(periph);
1424         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
1425             ("cdstrategy(%p)\n", bp));
1426
1427         softc = (struct cd_softc *)periph->softc;
1428
1429         /*
1430          * If the device has been made invalid, error out
1431          */
1432         if ((softc->flags & CD_FLAG_INVALID)) {
1433                 cam_periph_unlock(periph);
1434                 biofinish(bp, NULL, ENXIO);
1435                 return;
1436         }
1437
1438         /*
1439          * If we don't have valid media, look for it before trying to
1440          * schedule the I/O.
1441          */
1442         if ((softc->flags & CD_FLAG_VALID_MEDIA) == 0) {
1443                 int error;
1444
1445                 error = cdcheckmedia(periph);
1446                 if (error != 0) {
1447                         cam_periph_unlock(periph);
1448                         biofinish(bp, NULL, error);
1449                         return;
1450                 }
1451         }
1452
1453         /*
1454          * Place it in the queue of disk activities for this disk
1455          */
1456         bioq_disksort(&softc->bio_queue, bp);
1457
1458         /*
1459          * Schedule ourselves for performing the work.  We do things
1460          * differently for changers.
1461          */
1462         if ((softc->flags & CD_FLAG_CHANGER) == 0)
1463                 xpt_schedule(periph, CAM_PRIORITY_NORMAL);
1464         else
1465                 cdschedule(periph, CAM_PRIORITY_NORMAL);
1466
1467         cam_periph_unlock(periph);
1468         return;
1469 }
1470
1471 static void
1472 cdstart(struct cam_periph *periph, union ccb *start_ccb)
1473 {
1474         struct cd_softc *softc;
1475         struct bio *bp;
1476         struct ccb_scsiio *csio;
1477         struct scsi_read_capacity_data *rcap;
1478
1479         softc = (struct cd_softc *)periph->softc;
1480
1481         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cdstart\n"));
1482
1483         switch (softc->state) {
1484         case CD_STATE_NORMAL:
1485         {
1486                 bp = bioq_first(&softc->bio_queue);
1487                 if (periph->immediate_priority <= periph->pinfo.priority) {
1488                         start_ccb->ccb_h.ccb_state = CD_CCB_WAITING;
1489
1490                         SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
1491                                           periph_links.sle);
1492                         periph->immediate_priority = CAM_PRIORITY_NONE;
1493                         wakeup(&periph->ccb_list);
1494                 } else if (bp == NULL) {
1495                         xpt_release_ccb(start_ccb);
1496                 } else {
1497                         bioq_remove(&softc->bio_queue, bp);
1498
1499                         scsi_read_write(&start_ccb->csio,
1500                                         /*retries*/ cd_retry_count,
1501                                         /* cbfcnp */ cddone,
1502                                         MSG_SIMPLE_Q_TAG,
1503                                         /* read */bp->bio_cmd == BIO_READ,
1504                                         /* byte2 */ 0,
1505                                         /* minimum_cmd_size */ 10,
1506                                         /* lba */ bp->bio_offset /
1507                                           softc->params.blksize,
1508                                         bp->bio_bcount / softc->params.blksize,
1509                                         /* data_ptr */ bp->bio_data,
1510                                         /* dxfer_len */ bp->bio_bcount,
1511                                         /* sense_len */ SSD_FULL_SIZE,
1512                                         /* timeout */ 30000);
1513                         /* Use READ CD command for audio tracks. */
1514                         if (softc->params.blksize == 2352) {
1515                                 start_ccb->csio.cdb_io.cdb_bytes[0] = READ_CD;
1516                                 start_ccb->csio.cdb_io.cdb_bytes[9] = 0xf8;
1517                                 start_ccb->csio.cdb_io.cdb_bytes[10] = 0;
1518                                 start_ccb->csio.cdb_io.cdb_bytes[11] = 0;
1519                                 start_ccb->csio.cdb_len = 12;
1520                         }
1521                         start_ccb->ccb_h.ccb_state = CD_CCB_BUFFER_IO;
1522
1523
1524                         LIST_INSERT_HEAD(&softc->pending_ccbs,
1525                                          &start_ccb->ccb_h, periph_links.le);
1526                         softc->outstanding_cmds++;
1527
1528                         /* We expect a unit attention from this device */
1529                         if ((softc->flags & CD_FLAG_RETRY_UA) != 0) {
1530                                 start_ccb->ccb_h.ccb_state |= CD_CCB_RETRY_UA;
1531                                 softc->flags &= ~CD_FLAG_RETRY_UA;
1532                         }
1533
1534                         start_ccb->ccb_h.ccb_bp = bp;
1535                         bp = bioq_first(&softc->bio_queue);
1536
1537                         xpt_action(start_ccb);
1538                 }
1539                 if (bp != NULL) {
1540                         /* Have more work to do, so ensure we stay scheduled */
1541                         xpt_schedule(periph, CAM_PRIORITY_NORMAL);
1542                 }
1543                 break;
1544         }
1545         case CD_STATE_PROBE:
1546         {
1547
1548                 rcap = (struct scsi_read_capacity_data *)malloc(sizeof(*rcap),
1549                     M_SCSICD, M_NOWAIT | M_ZERO);
1550                 if (rcap == NULL) {
1551                         xpt_print(periph->path,
1552                             "cdstart: Couldn't malloc read_capacity data\n");
1553                         /* cd_free_periph??? */
1554                         break;
1555                 }
1556                 csio = &start_ccb->csio;
1557                 scsi_read_capacity(csio,
1558                                    /*retries*/ cd_retry_count,
1559                                    cddone,
1560                                    MSG_SIMPLE_Q_TAG,
1561                                    rcap,
1562                                    SSD_FULL_SIZE,
1563                                    /*timeout*/20000);
1564                 start_ccb->ccb_h.ccb_bp = NULL;
1565                 start_ccb->ccb_h.ccb_state = CD_CCB_PROBE;
1566                 xpt_action(start_ccb);
1567                 break;
1568         }
1569         }
1570 }
1571
1572 static void
1573 cddone(struct cam_periph *periph, union ccb *done_ccb)
1574 {
1575         struct cd_softc *softc;
1576         struct ccb_scsiio *csio;
1577
1578         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cddone\n"));
1579
1580         softc = (struct cd_softc *)periph->softc;
1581         csio = &done_ccb->csio;
1582
1583         switch (csio->ccb_h.ccb_state & CD_CCB_TYPE_MASK) {
1584         case CD_CCB_BUFFER_IO:
1585         {
1586                 struct bio      *bp;
1587                 int             error;
1588
1589                 bp = (struct bio *)done_ccb->ccb_h.ccb_bp;
1590                 error = 0;
1591
1592                 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1593                         int sf;
1594
1595                         if ((done_ccb->ccb_h.ccb_state & CD_CCB_RETRY_UA) != 0)
1596                                 sf = SF_RETRY_UA;
1597                         else
1598                                 sf = 0;
1599
1600                         error = cderror(done_ccb, CAM_RETRY_SELTO, sf);
1601                         if (error == ERESTART) {
1602                                 /*
1603                                  * A retry was scheuled, so
1604                                  * just return.
1605                                  */
1606                                 return;
1607                         }
1608                 }
1609
1610                 if (error != 0) {
1611                         xpt_print(periph->path,
1612                             "cddone: got error %#x back\n", error);
1613                         bioq_flush(&softc->bio_queue, NULL, EIO);
1614                         bp->bio_resid = bp->bio_bcount;
1615                         bp->bio_error = error;
1616                         bp->bio_flags |= BIO_ERROR;
1617                         if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1618                                 cam_release_devq(done_ccb->ccb_h.path,
1619                                          /*relsim_flags*/0,
1620                                          /*reduction*/0,
1621                                          /*timeout*/0,
1622                                          /*getcount_only*/0);
1623
1624                 } else {
1625                         bp->bio_resid = csio->resid;
1626                         bp->bio_error = 0;
1627                         if (bp->bio_resid != 0) {
1628                                 /*
1629                                  * Short transfer ???
1630                                  * XXX: not sure this is correct for partial
1631                                  * transfers at EOM
1632                                  */
1633                                 bp->bio_flags |= BIO_ERROR;
1634                         }
1635                 }
1636
1637                 LIST_REMOVE(&done_ccb->ccb_h, periph_links.le);
1638                 softc->outstanding_cmds--;
1639
1640                 if (softc->flags & CD_FLAG_CHANGER)
1641                         cdchangerschedule(softc);
1642
1643                 biofinish(bp, NULL, 0);
1644                 break;
1645         }
1646         case CD_CCB_PROBE:
1647         {
1648                 struct     scsi_read_capacity_data *rdcap;
1649                 char       announce_buf[120]; /*
1650                                                * Currently (9/30/97) the
1651                                                * longest possible announce
1652                                                * buffer is 108 bytes, for the
1653                                                * first error case below.
1654                                                * That is 39 bytes for the
1655                                                * basic string, 16 bytes for the
1656                                                * biggest sense key (hardware
1657                                                * error), 52 bytes for the
1658                                                * text of the largest sense
1659                                                * qualifier valid for a CDROM,
1660                                                * (0x72, 0x03 or 0x04,
1661                                                * 0x03), and one byte for the
1662                                                * null terminating character.
1663                                                * To allow for longer strings,
1664                                                * the announce buffer is 120
1665                                                * bytes.
1666                                                */
1667                 struct     cd_params *cdp;
1668
1669                 cdp = &softc->params;
1670
1671                 rdcap = (struct scsi_read_capacity_data *)csio->data_ptr;
1672
1673                 cdp->disksize = scsi_4btoul (rdcap->addr) + 1;
1674                 cdp->blksize = scsi_4btoul (rdcap->length);
1675
1676                 if ((csio->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP) {
1677
1678                         snprintf(announce_buf, sizeof(announce_buf),
1679                                 "cd present [%lu x %lu byte records]",
1680                                 cdp->disksize, (u_long)cdp->blksize);
1681
1682                 } else {
1683                         int     error;
1684                         /*
1685                          * Retry any UNIT ATTENTION type errors.  They
1686                          * are expected at boot.
1687                          */
1688                         error = cderror(done_ccb, CAM_RETRY_SELTO,
1689                                         SF_RETRY_UA | SF_NO_PRINT);
1690                         if (error == ERESTART) {
1691                                 /*
1692                                  * A retry was scheuled, so
1693                                  * just return.
1694                                  */
1695                                 return;
1696                         } else if (error != 0) {
1697
1698                                 struct scsi_sense_data *sense;
1699                                 int asc, ascq;
1700                                 int sense_key, error_code;
1701                                 int have_sense;
1702                                 cam_status status;
1703                                 struct ccb_getdev cgd;
1704
1705                                 /* Don't wedge this device's queue */
1706                                 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1707                                         cam_release_devq(done_ccb->ccb_h.path,
1708                                                  /*relsim_flags*/0,
1709                                                  /*reduction*/0,
1710                                                  /*timeout*/0,
1711                                                  /*getcount_only*/0);
1712
1713                                 status = done_ccb->ccb_h.status;
1714
1715                                 xpt_setup_ccb(&cgd.ccb_h,
1716                                               done_ccb->ccb_h.path,
1717                                               CAM_PRIORITY_NORMAL);
1718                                 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1719                                 xpt_action((union ccb *)&cgd);
1720
1721                                 if (((csio->ccb_h.flags & CAM_SENSE_PHYS) != 0)
1722                                  || ((csio->ccb_h.flags & CAM_SENSE_PTR) != 0)
1723                                  || ((status & CAM_AUTOSNS_VALID) == 0))
1724                                         have_sense = FALSE;
1725                                 else
1726                                         have_sense = TRUE;
1727
1728                                 if (have_sense) {
1729                                         sense = &csio->sense_data;
1730                                         scsi_extract_sense_len(sense,
1731                                             csio->sense_len - csio->sense_resid,
1732                                             &error_code, &sense_key, &asc,
1733                                             &ascq, /*show_errors*/ 1);
1734                                 }
1735                                 /*
1736                                  * Attach to anything that claims to be a
1737                                  * CDROM or WORM device, as long as it
1738                                  * doesn't return a "Logical unit not
1739                                  * supported" (0x25) error.
1740                                  */
1741                                 if ((have_sense) && (asc != 0x25)
1742                                  && (error_code == SSD_CURRENT_ERROR)) {
1743                                         const char *sense_key_desc;
1744                                         const char *asc_desc;
1745
1746                                         scsi_sense_desc(sense_key, asc, ascq,
1747                                                         &cgd.inq_data,
1748                                                         &sense_key_desc,
1749                                                         &asc_desc);
1750                                         snprintf(announce_buf,
1751                                             sizeof(announce_buf),
1752                                                 "Attempt to query device "
1753                                                 "size failed: %s, %s",
1754                                                 sense_key_desc,
1755                                                 asc_desc);
1756                                 } else if ((have_sense == 0)
1757                                       && ((status & CAM_STATUS_MASK) ==
1758                                            CAM_SCSI_STATUS_ERROR)
1759                                       && (csio->scsi_status ==
1760                                           SCSI_STATUS_BUSY)) {
1761                                         snprintf(announce_buf,
1762                                             sizeof(announce_buf),
1763                                             "Attempt to query device "
1764                                             "size failed: SCSI Status: %s",
1765                                             scsi_status_string(csio));
1766                                 } else if (SID_TYPE(&cgd.inq_data) == T_CDROM) {
1767                                         /*
1768                                          * We only print out an error for
1769                                          * CDROM type devices.  For WORM
1770                                          * devices, we don't print out an
1771                                          * error since a few WORM devices
1772                                          * don't support CDROM commands.
1773                                          * If we have sense information, go
1774                                          * ahead and print it out.
1775                                          * Otherwise, just say that we
1776                                          * couldn't attach.
1777                                          */
1778
1779                                         /*
1780                                          * Just print out the error, not
1781                                          * the full probe message, when we
1782                                          * don't attach.
1783                                          */
1784                                         if (have_sense)
1785                                                 scsi_sense_print(
1786                                                         &done_ccb->csio);
1787                                         else {
1788                                                 xpt_print(periph->path,
1789                                                     "got CAM status %#x\n",
1790                                                     done_ccb->ccb_h.status);
1791                                         }
1792                                         xpt_print(periph->path, "fatal error, "
1793                                             "failed to attach to device\n");
1794                                         /*
1795                                          * Invalidate this peripheral.
1796                                          */
1797                                         cam_periph_invalidate(periph);
1798
1799                                         announce_buf[0] = '\0';
1800                                 } else {
1801
1802                                         /*
1803                                          * Invalidate this peripheral.
1804                                          */
1805                                         cam_periph_invalidate(periph);
1806                                         announce_buf[0] = '\0';
1807                                 }
1808                         }
1809                 }
1810                 free(rdcap, M_SCSICD);
1811                 if (announce_buf[0] != '\0') {
1812                         xpt_announce_periph(periph, announce_buf);
1813                         if (softc->flags & CD_FLAG_CHANGER)
1814                                 cdchangerschedule(softc);
1815                         /*
1816                          * Create our sysctl variables, now that we know
1817                          * we have successfully attached.
1818                          */
1819                         taskqueue_enqueue(taskqueue_thread,&softc->sysctl_task);
1820                 }
1821                 softc->state = CD_STATE_NORMAL;
1822                 /*
1823                  * Since our peripheral may be invalidated by an error
1824                  * above or an external event, we must release our CCB
1825                  * before releasing the probe lock on the peripheral.
1826                  * The peripheral will only go away once the last lock
1827                  * is removed, and we need it around for the CCB release
1828                  * operation.
1829                  */
1830                 xpt_release_ccb(done_ccb);
1831                 cam_periph_unhold(periph);
1832                 return;
1833         }
1834         case CD_CCB_WAITING:
1835         {
1836                 /* Caller will release the CCB */
1837                 CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
1838                           ("trying to wakeup ccbwait\n"));
1839
1840                 wakeup(&done_ccb->ccb_h.cbfcnp);
1841                 return;
1842         }
1843         default:
1844                 break;
1845         }
1846         xpt_release_ccb(done_ccb);
1847 }
1848
1849 static union cd_pages *
1850 cdgetpage(struct cd_mode_params *mode_params)
1851 {
1852         union cd_pages *page;
1853
1854         if (mode_params->cdb_size == 10)
1855                 page = (union cd_pages *)find_mode_page_10(
1856                         (struct scsi_mode_header_10 *)mode_params->mode_buf);
1857         else
1858                 page = (union cd_pages *)find_mode_page_6(
1859                         (struct scsi_mode_header_6 *)mode_params->mode_buf);
1860
1861         return (page);
1862 }
1863
1864 static int
1865 cdgetpagesize(int page_num)
1866 {
1867         int i;
1868
1869         for (i = 0; i < (sizeof(cd_page_size_table)/
1870              sizeof(cd_page_size_table[0])); i++) {
1871                 if (cd_page_size_table[i].page == page_num)
1872                         return (cd_page_size_table[i].page_size);
1873         }
1874
1875         return (-1);
1876 }
1877
1878 static int
1879 cdioctl(struct disk *dp, u_long cmd, void *addr, int flag, struct thread *td)
1880 {
1881
1882         struct  cam_periph *periph;
1883         struct  cd_softc *softc;
1884         int     nocopyout, error = 0;
1885
1886         periph = (struct cam_periph *)dp->d_drv1;
1887         if (periph == NULL)
1888                 return(ENXIO);
1889
1890         cam_periph_lock(periph);
1891
1892         softc = (struct cd_softc *)periph->softc;
1893
1894         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE,
1895             ("cdioctl(%#lx)\n", cmd));
1896
1897         if ((error = cam_periph_hold(periph, PRIBIO | PCATCH)) != 0) {
1898                 cam_periph_unlock(periph);
1899                 cam_periph_release(periph);
1900                 return (error);
1901         }
1902
1903         /*
1904          * If we don't have media loaded, check for it.  If still don't
1905          * have media loaded, we can only do a load or eject.
1906          *
1907          * We only care whether media is loaded if this is a cd-specific ioctl
1908          * (thus the IOCGROUP check below).  Note that this will break if
1909          * anyone adds any ioctls into the switch statement below that don't
1910          * have their ioctl group set to 'c'.
1911          */
1912         if (((softc->flags & CD_FLAG_VALID_MEDIA) == 0)
1913          && ((cmd != CDIOCCLOSE)
1914           && (cmd != CDIOCEJECT))
1915          && (IOCGROUP(cmd) == 'c')) {
1916                 error = cdcheckmedia(periph);
1917                 if (error != 0) {
1918                         cam_periph_unhold(periph);
1919                         cam_periph_unlock(periph);
1920                         return (error);
1921                 }
1922         }
1923         /*
1924          * Drop the lock here so later mallocs can use WAITOK.  The periph
1925          * is essentially locked still with the cam_periph_hold call above.
1926          */
1927         cam_periph_unlock(periph);
1928
1929         nocopyout = 0;
1930         switch (cmd) {
1931
1932         case CDIOCPLAYTRACKS:
1933                 {
1934                         struct ioc_play_track *args
1935                             = (struct ioc_play_track *) addr;
1936                         struct cd_mode_params params;
1937                         union cd_pages *page;
1938
1939                         params.alloc_len = sizeof(union cd_mode_data_6_10);
1940                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
1941                                                  M_WAITOK | M_ZERO);
1942
1943                         cam_periph_lock(periph);
1944                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
1945                                   ("trying to do CDIOCPLAYTRACKS\n"));
1946
1947                         error = cdgetmode(periph, &params, AUDIO_PAGE);
1948                         if (error) {
1949                                 free(params.mode_buf, M_SCSICD);
1950                                 cam_periph_unlock(periph);
1951                                 break;
1952                         }
1953                         page = cdgetpage(&params);
1954
1955                         page->audio.flags &= ~CD_PA_SOTC;
1956                         page->audio.flags |= CD_PA_IMMED;
1957                         error = cdsetmode(periph, &params);
1958                         free(params.mode_buf, M_SCSICD);
1959                         if (error) {
1960                                 cam_periph_unlock(periph);
1961                                 break;
1962                         }
1963
1964                         /*
1965                          * This was originally implemented with the PLAY
1966                          * AUDIO TRACK INDEX command, but that command was
1967                          * deprecated after SCSI-2.  Most (all?) SCSI CDROM
1968                          * drives support it but ATAPI and ATAPI-derivative
1969                          * drives don't seem to support it.  So we keep a
1970                          * cache of the table of contents and translate
1971                          * track numbers to MSF format.
1972                          */
1973                         if (softc->flags & CD_FLAG_VALID_TOC) {
1974                                 union msf_lba *sentry, *eentry;
1975                                 int st, et;
1976
1977                                 if (args->end_track <
1978                                     softc->toc.header.ending_track + 1)
1979                                         args->end_track++;
1980                                 if (args->end_track >
1981                                     softc->toc.header.ending_track + 1)
1982                                         args->end_track =
1983                                             softc->toc.header.ending_track + 1;
1984                                 st = args->start_track -
1985                                         softc->toc.header.starting_track;
1986                                 et = args->end_track -
1987                                         softc->toc.header.starting_track;
1988                                 if ((st < 0)
1989                                  || (et < 0)
1990                                  || (st > (softc->toc.header.ending_track -
1991                                      softc->toc.header.starting_track))) {
1992                                         error = EINVAL;
1993                                         break;
1994                                 }
1995                                 sentry = &softc->toc.entries[st].addr;
1996                                 eentry = &softc->toc.entries[et].addr;
1997                                 error = cdplaymsf(periph,
1998                                                   sentry->msf.minute,
1999                                                   sentry->msf.second,
2000                                                   sentry->msf.frame,
2001                                                   eentry->msf.minute,
2002                                                   eentry->msf.second,
2003                                                   eentry->msf.frame);
2004                         } else {
2005                                 /*
2006                                  * If we don't have a valid TOC, try the
2007                                  * play track index command.  It is part of
2008                                  * the SCSI-2 spec, but was removed in the
2009                                  * MMC specs.  ATAPI and ATAPI-derived
2010                                  * drives don't support it.
2011                                  */
2012                                 if (softc->quirks & CD_Q_BCD_TRACKS) {
2013                                         args->start_track =
2014                                                 bin2bcd(args->start_track);
2015                                         args->end_track =
2016                                                 bin2bcd(args->end_track);
2017                                 }
2018                                 error = cdplaytracks(periph,
2019                                                      args->start_track,
2020                                                      args->start_index,
2021                                                      args->end_track,
2022                                                      args->end_index);
2023                         }
2024                         cam_periph_unlock(periph);
2025                 }
2026                 break;
2027         case CDIOCPLAYMSF:
2028                 {
2029                         struct ioc_play_msf *args
2030                                 = (struct ioc_play_msf *) addr;
2031                         struct cd_mode_params params;
2032                         union cd_pages *page;
2033
2034                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2035                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2036                                                  M_WAITOK | M_ZERO);
2037
2038                         cam_periph_lock(periph);
2039                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2040                                   ("trying to do CDIOCPLAYMSF\n"));
2041
2042                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2043                         if (error) {
2044                                 free(params.mode_buf, M_SCSICD);
2045                                 cam_periph_unlock(periph);
2046                                 break;
2047                         }
2048                         page = cdgetpage(&params);
2049
2050                         page->audio.flags &= ~CD_PA_SOTC;
2051                         page->audio.flags |= CD_PA_IMMED;
2052                         error = cdsetmode(periph, &params);
2053                         free(params.mode_buf, M_SCSICD);
2054                         if (error) {
2055                                 cam_periph_unlock(periph);
2056                                 break;
2057                         }
2058                         error = cdplaymsf(periph,
2059                                           args->start_m,
2060                                           args->start_s,
2061                                           args->start_f,
2062                                           args->end_m,
2063                                           args->end_s,
2064                                           args->end_f);
2065                         cam_periph_unlock(periph);
2066                 }
2067                 break;
2068         case CDIOCPLAYBLOCKS:
2069                 {
2070                         struct ioc_play_blocks *args
2071                                 = (struct ioc_play_blocks *) addr;
2072                         struct cd_mode_params params;
2073                         union cd_pages *page;
2074
2075                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2076                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2077                                                  M_WAITOK | M_ZERO);
2078
2079                         cam_periph_lock(periph);
2080                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2081                                   ("trying to do CDIOCPLAYBLOCKS\n"));
2082
2083
2084                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2085                         if (error) {
2086                                 free(params.mode_buf, M_SCSICD);
2087                                 cam_periph_unlock(periph);
2088                                 break;
2089                         }
2090                         page = cdgetpage(&params);
2091
2092                         page->audio.flags &= ~CD_PA_SOTC;
2093                         page->audio.flags |= CD_PA_IMMED;
2094                         error = cdsetmode(periph, &params);
2095                         free(params.mode_buf, M_SCSICD);
2096                         if (error) {
2097                                 cam_periph_unlock(periph);
2098                                 break;
2099                         }
2100                         error = cdplay(periph, args->blk, args->len);
2101                         cam_periph_unlock(periph);
2102                 }
2103                 break;
2104         case CDIOCREADSUBCHANNEL_SYSSPACE:
2105                 nocopyout = 1;
2106                 /* Fallthrough */
2107         case CDIOCREADSUBCHANNEL:
2108                 {
2109                         struct ioc_read_subchannel *args
2110                                 = (struct ioc_read_subchannel *) addr;
2111                         struct cd_sub_channel_info *data;
2112                         u_int32_t len = args->data_len;
2113
2114                         data = malloc(sizeof(struct cd_sub_channel_info),
2115                                       M_SCSICD, M_WAITOK | M_ZERO);
2116
2117                         cam_periph_lock(periph);
2118                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2119                                   ("trying to do CDIOCREADSUBCHANNEL\n"));
2120
2121                         if ((len > sizeof(struct cd_sub_channel_info)) ||
2122                             (len < sizeof(struct cd_sub_channel_header))) {
2123                                 printf(
2124                                         "scsi_cd: cdioctl: "
2125                                         "cdioreadsubchannel: error, len=%d\n",
2126                                         len);
2127                                 error = EINVAL;
2128                                 free(data, M_SCSICD);
2129                                 cam_periph_unlock(periph);
2130                                 break;
2131                         }
2132
2133                         if (softc->quirks & CD_Q_BCD_TRACKS)
2134                                 args->track = bin2bcd(args->track);
2135
2136                         error = cdreadsubchannel(periph, args->address_format,
2137                                 args->data_format, args->track, data, len);
2138
2139                         if (error) {
2140                                 free(data, M_SCSICD);
2141                                 cam_periph_unlock(periph);
2142                                 break;
2143                         }
2144                         if (softc->quirks & CD_Q_BCD_TRACKS)
2145                                 data->what.track_info.track_number =
2146                                     bcd2bin(data->what.track_info.track_number);
2147                         len = min(len, ((data->header.data_len[0] << 8) +
2148                                 data->header.data_len[1] +
2149                                 sizeof(struct cd_sub_channel_header)));
2150                         cam_periph_unlock(periph);
2151                         if (nocopyout == 0) {
2152                                 if (copyout(data, args->data, len) != 0) {
2153                                         error = EFAULT;
2154                                 }
2155                         } else {
2156                                 bcopy(data, args->data, len);
2157                         }
2158                         free(data, M_SCSICD);
2159                 }
2160                 break;
2161
2162         case CDIOREADTOCHEADER:
2163                 {
2164                         struct ioc_toc_header *th;
2165
2166                         th = malloc(sizeof(struct ioc_toc_header), M_SCSICD,
2167                                     M_WAITOK | M_ZERO);
2168
2169                         cam_periph_lock(periph);
2170                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2171                                   ("trying to do CDIOREADTOCHEADER\n"));
2172
2173                         error = cdreadtoc(periph, 0, 0, (u_int8_t *)th,
2174                                           sizeof (*th), /*sense_flags*/SF_NO_PRINT);
2175                         if (error) {
2176                                 free(th, M_SCSICD);
2177                                 cam_periph_unlock(periph);
2178                                 break;
2179                         }
2180                         if (softc->quirks & CD_Q_BCD_TRACKS) {
2181                                 /* we are going to have to convert the BCD
2182                                  * encoding on the cd to what is expected
2183                                  */
2184                                 th->starting_track =
2185                                         bcd2bin(th->starting_track);
2186                                 th->ending_track = bcd2bin(th->ending_track);
2187                         }
2188                         th->len = ntohs(th->len);
2189                         bcopy(th, addr, sizeof(*th));
2190                         free(th, M_SCSICD);
2191                         cam_periph_unlock(periph);
2192                 }
2193                 break;
2194         case CDIOREADTOCENTRYS:
2195                 {
2196                         struct cd_tocdata *data;
2197                         struct cd_toc_single *lead;
2198                         struct ioc_read_toc_entry *te =
2199                                 (struct ioc_read_toc_entry *) addr;
2200                         struct ioc_toc_header *th;
2201                         u_int32_t len, readlen, idx, num;
2202                         u_int32_t starting_track = te->starting_track;
2203
2204                         data = malloc(sizeof(*data), M_SCSICD, M_WAITOK | M_ZERO);
2205                         lead = malloc(sizeof(*lead), M_SCSICD, M_WAITOK | M_ZERO);
2206
2207                         cam_periph_lock(periph);
2208                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2209                                   ("trying to do CDIOREADTOCENTRYS\n"));
2210
2211                         if (te->data_len < sizeof(struct cd_toc_entry)
2212                          || (te->data_len % sizeof(struct cd_toc_entry)) != 0
2213                          || (te->address_format != CD_MSF_FORMAT
2214                           && te->address_format != CD_LBA_FORMAT)) {
2215                                 error = EINVAL;
2216                                 printf("scsi_cd: error in readtocentries, "
2217                                        "returning EINVAL\n");
2218                                 free(data, M_SCSICD);
2219                                 free(lead, M_SCSICD);
2220                                 cam_periph_unlock(periph);
2221                                 break;
2222                         }
2223
2224                         th = &data->header;
2225                         error = cdreadtoc(periph, 0, 0, (u_int8_t *)th,
2226                                           sizeof (*th), /*sense_flags*/0);
2227                         if (error) {
2228                                 free(data, M_SCSICD);
2229                                 free(lead, M_SCSICD);
2230                                 cam_periph_unlock(periph);
2231                                 break;
2232                         }
2233
2234                         if (softc->quirks & CD_Q_BCD_TRACKS) {
2235                                 /* we are going to have to convert the BCD
2236                                  * encoding on the cd to what is expected
2237                                  */
2238                                 th->starting_track =
2239                                     bcd2bin(th->starting_track);
2240                                 th->ending_track = bcd2bin(th->ending_track);
2241                         }
2242
2243                         if (starting_track == 0)
2244                                 starting_track = th->starting_track;
2245                         else if (starting_track == LEADOUT)
2246                                 starting_track = th->ending_track + 1;
2247                         else if (starting_track < th->starting_track ||
2248                                  starting_track > th->ending_track + 1) {
2249                                 printf("scsi_cd: error in readtocentries, "
2250                                        "returning EINVAL\n");
2251                                 free(data, M_SCSICD);
2252                                 free(lead, M_SCSICD);
2253                                 cam_periph_unlock(periph);
2254                                 error = EINVAL;
2255                                 break;
2256                         }
2257
2258                         /* calculate reading length without leadout entry */
2259                         readlen = (th->ending_track - starting_track + 1) *
2260                                   sizeof(struct cd_toc_entry);
2261
2262                         /* and with leadout entry */
2263                         len = readlen + sizeof(struct cd_toc_entry);
2264                         if (te->data_len < len) {
2265                                 len = te->data_len;
2266                                 if (readlen > len)
2267                                         readlen = len;
2268                         }
2269                         if (len > sizeof(data->entries)) {
2270                                 printf("scsi_cd: error in readtocentries, "
2271                                        "returning EINVAL\n");
2272                                 error = EINVAL;
2273                                 free(data, M_SCSICD);
2274                                 free(lead, M_SCSICD);
2275                                 cam_periph_unlock(periph);
2276                                 break;
2277                         }
2278                         num = len / sizeof(struct cd_toc_entry);
2279
2280                         if (readlen > 0) {
2281                                 error = cdreadtoc(periph, te->address_format,
2282                                                   starting_track,
2283                                                   (u_int8_t *)data,
2284                                                   readlen + sizeof (*th),
2285                                                   /*sense_flags*/0);
2286                                 if (error) {
2287                                         free(data, M_SCSICD);
2288                                         free(lead, M_SCSICD);
2289                                         cam_periph_unlock(periph);
2290                                         break;
2291                                 }
2292                         }
2293
2294                         /* make leadout entry if needed */
2295                         idx = starting_track + num - 1;
2296                         if (softc->quirks & CD_Q_BCD_TRACKS)
2297                                 th->ending_track = bcd2bin(th->ending_track);
2298                         if (idx == th->ending_track + 1) {
2299                                 error = cdreadtoc(periph, te->address_format,
2300                                                   LEADOUT, (u_int8_t *)lead,
2301                                                   sizeof(*lead),
2302                                                   /*sense_flags*/0);
2303                                 if (error) {
2304                                         free(data, M_SCSICD);
2305                                         free(lead, M_SCSICD);
2306                                         cam_periph_unlock(periph);
2307                                         break;
2308                                 }
2309                                 data->entries[idx - starting_track] =
2310                                         lead->entry;
2311                         }
2312                         if (softc->quirks & CD_Q_BCD_TRACKS) {
2313                                 for (idx = 0; idx < num - 1; idx++) {
2314                                         data->entries[idx].track =
2315                                             bcd2bin(data->entries[idx].track);
2316                                 }
2317                         }
2318
2319                         cam_periph_unlock(periph);
2320                         error = copyout(data->entries, te->data, len);
2321                         free(data, M_SCSICD);
2322                         free(lead, M_SCSICD);
2323                 }
2324                 break;
2325         case CDIOREADTOCENTRY:
2326                 {
2327                         struct cd_toc_single *data;
2328                         struct ioc_read_toc_single_entry *te =
2329                                 (struct ioc_read_toc_single_entry *) addr;
2330                         struct ioc_toc_header *th;
2331                         u_int32_t track;
2332
2333                         data = malloc(sizeof(*data), M_SCSICD, M_WAITOK | M_ZERO);
2334
2335                         cam_periph_lock(periph);
2336                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2337                                   ("trying to do CDIOREADTOCENTRY\n"));
2338
2339                         if (te->address_format != CD_MSF_FORMAT
2340                             && te->address_format != CD_LBA_FORMAT) {
2341                                 printf("error in readtocentry, "
2342                                        " returning EINVAL\n");
2343                                 free(data, M_SCSICD);
2344                                 error = EINVAL;
2345                                 cam_periph_unlock(periph);
2346                                 break;
2347                         }
2348
2349                         th = &data->header;
2350                         error = cdreadtoc(periph, 0, 0, (u_int8_t *)th,
2351                                           sizeof (*th), /*sense_flags*/0);
2352                         if (error) {
2353                                 free(data, M_SCSICD);
2354                                 cam_periph_unlock(periph);
2355                                 break;
2356                         }
2357
2358                         if (softc->quirks & CD_Q_BCD_TRACKS) {
2359                                 /* we are going to have to convert the BCD
2360                                  * encoding on the cd to what is expected
2361                                  */
2362                                 th->starting_track =
2363                                     bcd2bin(th->starting_track);
2364                                 th->ending_track = bcd2bin(th->ending_track);
2365                         }
2366                         track = te->track;
2367                         if (track == 0)
2368                                 track = th->starting_track;
2369                         else if (track == LEADOUT)
2370                                 /* OK */;
2371                         else if (track < th->starting_track ||
2372                                  track > th->ending_track + 1) {
2373                                 printf("error in readtocentry, "
2374                                        " returning EINVAL\n");
2375                                 free(data, M_SCSICD);
2376                                 error = EINVAL;
2377                                 cam_periph_unlock(periph);
2378                                 break;
2379                         }
2380
2381                         error = cdreadtoc(periph, te->address_format, track,
2382                                           (u_int8_t *)data, sizeof(*data),
2383                                           /*sense_flags*/0);
2384                         if (error) {
2385                                 free(data, M_SCSICD);
2386                                 cam_periph_unlock(periph);
2387                                 break;
2388                         }
2389
2390                         if (softc->quirks & CD_Q_BCD_TRACKS)
2391                                 data->entry.track = bcd2bin(data->entry.track);
2392                         bcopy(&data->entry, &te->entry,
2393                               sizeof(struct cd_toc_entry));
2394                         free(data, M_SCSICD);
2395                         cam_periph_unlock(periph);
2396                 }
2397                 break;
2398         case CDIOCSETPATCH:
2399                 {
2400                         struct ioc_patch *arg = (struct ioc_patch *)addr;
2401                         struct cd_mode_params params;
2402                         union cd_pages *page;
2403
2404                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2405                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2406                                                  M_WAITOK | M_ZERO);
2407
2408                         cam_periph_lock(periph);
2409                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2410                                   ("trying to do CDIOCSETPATCH\n"));
2411
2412                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2413                         if (error) {
2414                                 free(params.mode_buf, M_SCSICD);
2415                                 cam_periph_unlock(periph);
2416                                 break;
2417                         }
2418                         page = cdgetpage(&params);
2419
2420                         page->audio.port[LEFT_PORT].channels =
2421                                 arg->patch[0];
2422                         page->audio.port[RIGHT_PORT].channels =
2423                                 arg->patch[1];
2424                         page->audio.port[2].channels = arg->patch[2];
2425                         page->audio.port[3].channels = arg->patch[3];
2426                         error = cdsetmode(periph, &params);
2427                         free(params.mode_buf, M_SCSICD);
2428                         cam_periph_unlock(periph);
2429                 }
2430                 break;
2431         case CDIOCGETVOL:
2432                 {
2433                         struct ioc_vol *arg = (struct ioc_vol *) addr;
2434                         struct cd_mode_params params;
2435                         union cd_pages *page;
2436
2437                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2438                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2439                                                  M_WAITOK | M_ZERO);
2440
2441                         cam_periph_lock(periph);
2442                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2443                                   ("trying to do CDIOCGETVOL\n"));
2444
2445                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2446                         if (error) {
2447                                 free(params.mode_buf, M_SCSICD);
2448                                 cam_periph_unlock(periph);
2449                                 break;
2450                         }
2451                         page = cdgetpage(&params);
2452
2453                         arg->vol[LEFT_PORT] =
2454                                 page->audio.port[LEFT_PORT].volume;
2455                         arg->vol[RIGHT_PORT] =
2456                                 page->audio.port[RIGHT_PORT].volume;
2457                         arg->vol[2] = page->audio.port[2].volume;
2458                         arg->vol[3] = page->audio.port[3].volume;
2459                         free(params.mode_buf, M_SCSICD);
2460                         cam_periph_unlock(periph);
2461                 }
2462                 break;
2463         case CDIOCSETVOL:
2464                 {
2465                         struct ioc_vol *arg = (struct ioc_vol *) addr;
2466                         struct cd_mode_params params;
2467                         union cd_pages *page;
2468
2469                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2470                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2471                                                  M_WAITOK | M_ZERO);
2472
2473                         cam_periph_lock(periph);
2474                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2475                                   ("trying to do CDIOCSETVOL\n"));
2476
2477                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2478                         if (error) {
2479                                 free(params.mode_buf, M_SCSICD);
2480                                 cam_periph_unlock(periph);
2481                                 break;
2482                         }
2483                         page = cdgetpage(&params);
2484
2485                         page->audio.port[LEFT_PORT].channels = CHANNEL_0;
2486                         page->audio.port[LEFT_PORT].volume =
2487                                 arg->vol[LEFT_PORT];
2488                         page->audio.port[RIGHT_PORT].channels = CHANNEL_1;
2489                         page->audio.port[RIGHT_PORT].volume =
2490                                 arg->vol[RIGHT_PORT];
2491                         page->audio.port[2].volume = arg->vol[2];
2492                         page->audio.port[3].volume = arg->vol[3];
2493                         error = cdsetmode(periph, &params);
2494                         cam_periph_unlock(periph);
2495                         free(params.mode_buf, M_SCSICD);
2496                 }
2497                 break;
2498         case CDIOCSETMONO:
2499                 {
2500                         struct cd_mode_params params;
2501                         union cd_pages *page;
2502
2503                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2504                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2505                                                  M_WAITOK | M_ZERO);
2506
2507                         cam_periph_lock(periph);
2508                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2509                                   ("trying to do CDIOCSETMONO\n"));
2510
2511                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2512                         if (error) {
2513                                 free(params.mode_buf, M_SCSICD);
2514                                 cam_periph_unlock(periph);
2515                                 break;
2516                         }
2517                         page = cdgetpage(&params);
2518
2519                         page->audio.port[LEFT_PORT].channels =
2520                                 LEFT_CHANNEL | RIGHT_CHANNEL;
2521                         page->audio.port[RIGHT_PORT].channels =
2522                                 LEFT_CHANNEL | RIGHT_CHANNEL;
2523                         page->audio.port[2].channels = 0;
2524                         page->audio.port[3].channels = 0;
2525                         error = cdsetmode(periph, &params);
2526                         cam_periph_unlock(periph);
2527                         free(params.mode_buf, M_SCSICD);
2528                 }
2529                 break;
2530         case CDIOCSETSTEREO:
2531                 {
2532                         struct cd_mode_params params;
2533                         union cd_pages *page;
2534
2535                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2536                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2537                                                  M_WAITOK | M_ZERO);
2538
2539                         cam_periph_lock(periph);
2540                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2541                                   ("trying to do CDIOCSETSTEREO\n"));
2542
2543                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2544                         if (error) {
2545                                 free(params.mode_buf, M_SCSICD);
2546                                 cam_periph_unlock(periph);
2547                                 break;
2548                         }
2549                         page = cdgetpage(&params);
2550
2551                         page->audio.port[LEFT_PORT].channels =
2552                                 LEFT_CHANNEL;
2553                         page->audio.port[RIGHT_PORT].channels =
2554                                 RIGHT_CHANNEL;
2555                         page->audio.port[2].channels = 0;
2556                         page->audio.port[3].channels = 0;
2557                         error = cdsetmode(periph, &params);
2558                         free(params.mode_buf, M_SCSICD);
2559                         cam_periph_unlock(periph);
2560                 }
2561                 break;
2562         case CDIOCSETMUTE:
2563                 {
2564                         struct cd_mode_params params;
2565                         union cd_pages *page;
2566
2567                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2568                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2569                                                  M_WAITOK | M_ZERO);
2570
2571                         cam_periph_lock(periph);
2572                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2573                                   ("trying to do CDIOCSETMUTE\n"));
2574
2575                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2576                         if (error) {
2577                                 free(params.mode_buf, M_SCSICD);
2578                                 cam_periph_unlock(periph);
2579                                 break;
2580                         }
2581                         page = cdgetpage(&params);
2582
2583                         page->audio.port[LEFT_PORT].channels = 0;
2584                         page->audio.port[RIGHT_PORT].channels = 0;
2585                         page->audio.port[2].channels = 0;
2586                         page->audio.port[3].channels = 0;
2587                         error = cdsetmode(periph, &params);
2588                         free(params.mode_buf, M_SCSICD);
2589                         cam_periph_unlock(periph);
2590                 }
2591                 break;
2592         case CDIOCSETLEFT:
2593                 {
2594                         struct cd_mode_params params;
2595                         union cd_pages *page;
2596
2597                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2598                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2599                                                  M_WAITOK | M_ZERO);
2600
2601                         cam_periph_lock(periph);
2602                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2603                                   ("trying to do CDIOCSETLEFT\n"));
2604
2605                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2606                         if (error) {
2607                                 free(params.mode_buf, M_SCSICD);
2608                                 cam_periph_unlock(periph);
2609                                 break;
2610                         }
2611                         page = cdgetpage(&params);
2612
2613                         page->audio.port[LEFT_PORT].channels = LEFT_CHANNEL;
2614                         page->audio.port[RIGHT_PORT].channels = LEFT_CHANNEL;
2615                         page->audio.port[2].channels = 0;
2616                         page->audio.port[3].channels = 0;
2617                         error = cdsetmode(periph, &params);
2618                         free(params.mode_buf, M_SCSICD);
2619                         cam_periph_unlock(periph);
2620                 }
2621                 break;
2622         case CDIOCSETRIGHT:
2623                 {
2624                         struct cd_mode_params params;
2625                         union cd_pages *page;
2626
2627                         params.alloc_len = sizeof(union cd_mode_data_6_10);
2628                         params.mode_buf = malloc(params.alloc_len, M_SCSICD,
2629                                                  M_WAITOK | M_ZERO);
2630
2631                         cam_periph_lock(periph);
2632                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
2633                                   ("trying to do CDIOCSETRIGHT\n"));
2634
2635                         error = cdgetmode(periph, &params, AUDIO_PAGE);
2636                         if (error) {
2637                                 free(params.mode_buf, M_SCSICD);
2638                                 cam_periph_unlock(periph);
2639                                 break;
2640                         }
2641                         page = cdgetpage(&params);
2642
2643                         page->audio.port[LEFT_PORT].channels = RIGHT_CHANNEL;
2644                         page->audio.port[RIGHT_PORT].channels = RIGHT_CHANNEL;
2645                         page->audio.port[2].channels = 0;
2646                         page->audio.port[3].channels = 0;
2647                         error = cdsetmode(periph, &params);
2648                         free(params.mode_buf, M_SCSICD);
2649                         cam_periph_unlock(periph);
2650                 }
2651                 break;
2652         case CDIOCRESUME:
2653                 cam_periph_lock(periph);
2654                 error = cdpause(periph, 1);
2655                 cam_periph_unlock(periph);
2656                 break;
2657         case CDIOCPAUSE:
2658                 cam_periph_lock(periph);
2659                 error = cdpause(periph, 0);
2660                 cam_periph_unlock(periph);
2661                 break;
2662         case CDIOCSTART:
2663                 cam_periph_lock(periph);
2664                 error = cdstartunit(periph, 0);
2665                 cam_periph_unlock(periph);
2666                 break;
2667         case CDIOCCLOSE:
2668                 cam_periph_lock(periph);
2669                 error = cdstartunit(periph, 1);
2670                 cam_periph_unlock(periph);
2671                 break;
2672         case CDIOCSTOP:
2673                 cam_periph_lock(periph);
2674                 error = cdstopunit(periph, 0);
2675                 cam_periph_unlock(periph);
2676                 break;
2677         case CDIOCEJECT:
2678                 cam_periph_lock(periph);
2679                 error = cdstopunit(periph, 1);
2680                 cam_periph_unlock(periph);
2681                 break;
2682         case CDIOCALLOW:
2683                 cam_periph_lock(periph);
2684                 cdprevent(periph, PR_ALLOW);
2685                 cam_periph_unlock(periph);
2686                 break;
2687         case CDIOCPREVENT:
2688                 cam_periph_lock(periph);
2689                 cdprevent(periph, PR_PREVENT);
2690                 cam_periph_unlock(periph);
2691                 break;
2692         case CDIOCSETDEBUG:
2693                 /* sc_link->flags |= (SDEV_DB1 | SDEV_DB2); */
2694                 error = ENOTTY;
2695                 break;
2696         case CDIOCCLRDEBUG:
2697                 /* sc_link->flags &= ~(SDEV_DB1 | SDEV_DB2); */
2698                 error = ENOTTY;
2699                 break;
2700         case CDIOCRESET:
2701                 /* return (cd_reset(periph)); */
2702                 error = ENOTTY;
2703                 break;
2704         case CDRIOCREADSPEED:
2705                 cam_periph_lock(periph);
2706                 error = cdsetspeed(periph, *(u_int32_t *)addr, CDR_MAX_SPEED);
2707                 cam_periph_unlock(periph);
2708                 break;
2709         case CDRIOCWRITESPEED:
2710                 cam_periph_lock(periph);
2711                 error = cdsetspeed(periph, CDR_MAX_SPEED, *(u_int32_t *)addr);
2712                 cam_periph_unlock(periph);
2713                 break;
2714         case CDRIOCGETBLOCKSIZE:
2715                 *(int *)addr = softc->params.blksize;
2716                 break;
2717         case CDRIOCSETBLOCKSIZE:
2718                 if (*(int *)addr <= 0) {
2719                         error = EINVAL;
2720                         break;
2721                 }
2722                 softc->disk->d_sectorsize = softc->params.blksize = *(int *)addr;
2723                 break;
2724         case DVDIOCSENDKEY:
2725         case DVDIOCREPORTKEY: {
2726                 struct dvd_authinfo *authinfo;
2727
2728                 authinfo = (struct dvd_authinfo *)addr;
2729
2730                 if (cmd == DVDIOCREPORTKEY)
2731                         error = cdreportkey(periph, authinfo);
2732                 else
2733                         error = cdsendkey(periph, authinfo);
2734                 break;
2735                 }
2736         case DVDIOCREADSTRUCTURE: {
2737                 struct dvd_struct *dvdstruct;
2738
2739                 dvdstruct = (struct dvd_struct *)addr;
2740
2741                 error = cdreaddvdstructure(periph, dvdstruct);
2742
2743                 break;
2744         }
2745         default:
2746                 cam_periph_lock(periph);
2747                 error = cam_periph_ioctl(periph, cmd, addr, cderror);
2748                 cam_periph_unlock(periph);
2749                 break;
2750         }
2751
2752         cam_periph_lock(periph);
2753         cam_periph_unhold(periph);
2754
2755         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("leaving cdioctl\n"));
2756         if (error && bootverbose) {
2757                 printf("scsi_cd.c::ioctl cmd=%08lx error=%d\n", cmd, error);
2758         }
2759         cam_periph_unlock(periph);
2760
2761         return (error);
2762 }
2763
2764 static void
2765 cdprevent(struct cam_periph *periph, int action)
2766 {
2767         union   ccb *ccb;
2768         struct  cd_softc *softc;
2769         int     error;
2770
2771         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cdprevent\n"));
2772
2773         softc = (struct cd_softc *)periph->softc;
2774
2775         if (((action == PR_ALLOW)
2776           && (softc->flags & CD_FLAG_DISC_LOCKED) == 0)
2777          || ((action == PR_PREVENT)
2778           && (softc->flags & CD_FLAG_DISC_LOCKED) != 0)) {
2779                 return;
2780         }
2781
2782         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
2783
2784         scsi_prevent(&ccb->csio,
2785                      /*retries*/ cd_retry_count,
2786                      cddone,
2787                      MSG_SIMPLE_Q_TAG,
2788                      action,
2789                      SSD_FULL_SIZE,
2790                      /* timeout */60000);
2791
2792         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
2793                         /*sense_flags*/SF_RETRY_UA|SF_NO_PRINT);
2794
2795         xpt_release_ccb(ccb);
2796
2797         if (error == 0) {
2798                 if (action == PR_ALLOW)
2799                         softc->flags &= ~CD_FLAG_DISC_LOCKED;
2800                 else
2801                         softc->flags |= CD_FLAG_DISC_LOCKED;
2802         }
2803 }
2804
2805 /*
2806  * XXX: the disk media and sector size is only really able to change
2807  * XXX: while the device is closed.
2808  */
2809 static int
2810 cdcheckmedia(struct cam_periph *periph)
2811 {
2812         struct cd_softc *softc;
2813         struct ioc_toc_header *toch;
2814         struct cd_toc_single leadout;
2815         u_int32_t size, toclen;
2816         int error, num_entries, cdindex;
2817
2818         softc = (struct cd_softc *)periph->softc;
2819
2820         cdprevent(periph, PR_PREVENT);
2821         softc->disk->d_sectorsize = 2048;
2822         softc->disk->d_mediasize = 0;
2823
2824         /*
2825          * Get the disc size and block size.  If we can't get it, we don't
2826          * have media, most likely.
2827          */
2828         if ((error = cdsize(periph, &size)) != 0) {
2829                 softc->flags &= ~(CD_FLAG_VALID_MEDIA|CD_FLAG_VALID_TOC);
2830                 cdprevent(periph, PR_ALLOW);
2831                 return (error);
2832         } else {
2833                 softc->flags |= CD_FLAG_VALID_MEDIA;
2834                 softc->disk->d_sectorsize = softc->params.blksize;
2835                 softc->disk->d_mediasize =
2836                     (off_t)softc->params.blksize * softc->params.disksize;
2837         }
2838
2839         /*
2840          * Now we check the table of contents.  This (currently) is only
2841          * used for the CDIOCPLAYTRACKS ioctl.  It may be used later to do
2842          * things like present a separate entry in /dev for each track,
2843          * like that acd(4) driver does.
2844          */
2845         bzero(&softc->toc, sizeof(softc->toc));
2846         toch = &softc->toc.header;
2847         /*
2848          * We will get errors here for media that doesn't have a table of
2849          * contents.  According to the MMC-3 spec: "When a Read TOC/PMA/ATIP
2850          * command is presented for a DDCD/CD-R/RW media, where the first TOC
2851          * has not been recorded (no complete session) and the Format codes
2852          * 0000b, 0001b, or 0010b are specified, this command shall be rejected
2853          * with an INVALID FIELD IN CDB.  Devices that are not capable of
2854          * reading an incomplete session on DDC/CD-R/RW media shall report
2855          * CANNOT READ MEDIUM - INCOMPATIBLE FORMAT."
2856          *
2857          * So this isn't fatal if we can't read the table of contents, it
2858          * just means that the user won't be able to issue the play tracks
2859          * ioctl, and likely lots of other stuff won't work either.  They
2860          * need to burn the CD before we can do a whole lot with it.  So
2861          * we don't print anything here if we get an error back.
2862          */
2863         error = cdreadtoc(periph, 0, 0, (u_int8_t *)toch, sizeof(*toch),
2864                           SF_NO_PRINT);
2865         /*
2866          * Errors in reading the table of contents aren't fatal, we just
2867          * won't have a valid table of contents cached.
2868          */
2869         if (error != 0) {
2870                 error = 0;
2871                 bzero(&softc->toc, sizeof(softc->toc));
2872                 goto bailout;
2873         }
2874
2875         if (softc->quirks & CD_Q_BCD_TRACKS) {
2876                 toch->starting_track = bcd2bin(toch->starting_track);
2877                 toch->ending_track = bcd2bin(toch->ending_track);
2878         }
2879
2880         /* Number of TOC entries, plus leadout */
2881         num_entries = (toch->ending_track - toch->starting_track) + 2;
2882
2883         if (num_entries <= 0)
2884                 goto bailout;
2885
2886         toclen = num_entries * sizeof(struct cd_toc_entry);
2887
2888         error = cdreadtoc(periph, CD_MSF_FORMAT, toch->starting_track,
2889                           (u_int8_t *)&softc->toc, toclen + sizeof(*toch),
2890                           SF_NO_PRINT);
2891         if (error != 0) {
2892                 error = 0;
2893                 bzero(&softc->toc, sizeof(softc->toc));
2894                 goto bailout;
2895         }
2896
2897         if (softc->quirks & CD_Q_BCD_TRACKS) {
2898                 toch->starting_track = bcd2bin(toch->starting_track);
2899                 toch->ending_track = bcd2bin(toch->ending_track);
2900         }
2901         /*
2902          * XXX KDM is this necessary?  Probably only if the drive doesn't
2903          * return leadout information with the table of contents.
2904          */
2905         cdindex = toch->starting_track + num_entries -1;
2906         if (cdindex == toch->ending_track + 1) {
2907
2908                 error = cdreadtoc(periph, CD_MSF_FORMAT, LEADOUT,
2909                                   (u_int8_t *)&leadout, sizeof(leadout),
2910                                   SF_NO_PRINT);
2911                 if (error != 0) {
2912                         error = 0;
2913                         goto bailout;
2914                 }
2915                 softc->toc.entries[cdindex - toch->starting_track] =
2916                         leadout.entry;
2917         }
2918         if (softc->quirks & CD_Q_BCD_TRACKS) {
2919                 for (cdindex = 0; cdindex < num_entries - 1; cdindex++) {
2920                         softc->toc.entries[cdindex].track =
2921                                 bcd2bin(softc->toc.entries[cdindex].track);
2922                 }
2923         }
2924
2925         softc->flags |= CD_FLAG_VALID_TOC;
2926
2927         /* If the first track is audio, correct sector size. */
2928         if ((softc->toc.entries[0].control & 4) == 0) {
2929                 softc->disk->d_sectorsize = softc->params.blksize = 2352;
2930                 softc->disk->d_mediasize =
2931                     (off_t)softc->params.blksize * softc->params.disksize;
2932         }
2933
2934 bailout:
2935
2936         /*
2937          * We unconditionally (re)set the blocksize each time the
2938          * CD device is opened.  This is because the CD can change,
2939          * and therefore the blocksize might change.
2940          * XXX problems here if some slice or partition is still
2941          * open with the old size?
2942          */
2943         if ((softc->disk->d_devstat->flags & DEVSTAT_BS_UNAVAILABLE) != 0)
2944                 softc->disk->d_devstat->flags &= ~DEVSTAT_BS_UNAVAILABLE;
2945         softc->disk->d_devstat->block_size = softc->params.blksize;
2946
2947         return (error);
2948 }
2949
2950 static int
2951 cdsize(struct cam_periph *periph, u_int32_t *size)
2952 {
2953         struct cd_softc *softc;
2954         union ccb *ccb;
2955         struct scsi_read_capacity_data *rcap_buf;
2956         int error;
2957
2958         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cdsize\n"));
2959
2960         softc = (struct cd_softc *)periph->softc;
2961
2962         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
2963
2964         /* XXX Should be M_WAITOK */
2965         rcap_buf = malloc(sizeof(struct scsi_read_capacity_data),
2966                           M_SCSICD, M_NOWAIT | M_ZERO);
2967         if (rcap_buf == NULL)
2968                 return (ENOMEM);
2969
2970         scsi_read_capacity(&ccb->csio,
2971                            /*retries*/ cd_retry_count,
2972                            cddone,
2973                            MSG_SIMPLE_Q_TAG,
2974                            rcap_buf,
2975                            SSD_FULL_SIZE,
2976                            /* timeout */20000);
2977
2978         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
2979                          /*sense_flags*/SF_RETRY_UA|SF_NO_PRINT);
2980
2981         xpt_release_ccb(ccb);
2982
2983         softc->params.disksize = scsi_4btoul(rcap_buf->addr) + 1;
2984         softc->params.blksize  = scsi_4btoul(rcap_buf->length);
2985         /* Make sure we got at least some block size. */
2986         if (error == 0 && softc->params.blksize == 0)
2987                 error = EIO;
2988         /*
2989          * SCSI-3 mandates that the reported blocksize shall be 2048.
2990          * Older drives sometimes report funny values, trim it down to
2991          * 2048, or other parts of the kernel will get confused.
2992          *
2993          * XXX we leave drives alone that might report 512 bytes, as
2994          * well as drives reporting more weird sizes like perhaps 4K.
2995          */
2996         if (softc->params.blksize > 2048 && softc->params.blksize <= 2352)
2997                 softc->params.blksize = 2048;
2998
2999         free(rcap_buf, M_SCSICD);
3000         *size = softc->params.disksize;
3001
3002         return (error);
3003
3004 }
3005
3006 static int
3007 cd6byteworkaround(union ccb *ccb)
3008 {
3009         u_int8_t *cdb;
3010         struct cam_periph *periph;
3011         struct cd_softc *softc;
3012         struct cd_mode_params *params;
3013         int frozen, found;
3014
3015         periph = xpt_path_periph(ccb->ccb_h.path);
3016         softc = (struct cd_softc *)periph->softc;
3017
3018         cdb = ccb->csio.cdb_io.cdb_bytes;
3019
3020         if ((ccb->ccb_h.flags & CAM_CDB_POINTER)
3021          || ((cdb[0] != MODE_SENSE_6)
3022           && (cdb[0] != MODE_SELECT_6)))
3023                 return (0);
3024
3025         /*
3026          * Because there is no convenient place to stash the overall
3027          * cd_mode_params structure pointer, we have to grab it like this.
3028          * This means that ALL MODE_SENSE and MODE_SELECT requests in the
3029          * cd(4) driver MUST go through cdgetmode() and cdsetmode()!
3030          *
3031          * XXX It would be nice if, at some point, we could increase the
3032          * number of available peripheral private pointers.  Both pointers
3033          * are currently used in most every peripheral driver.
3034          */
3035         found = 0;
3036
3037         STAILQ_FOREACH(params, &softc->mode_queue, links) {
3038                 if (params->mode_buf == ccb->csio.data_ptr) {
3039                         found = 1;
3040                         break;
3041                 }
3042         }
3043
3044         /*
3045          * This shouldn't happen.  All mode sense and mode select
3046          * operations in the cd(4) driver MUST go through cdgetmode() and
3047          * cdsetmode()!
3048          */
3049         if (found == 0) {
3050                 xpt_print(periph->path,
3051                     "mode buffer not found in mode queue!\n");
3052                 return (0);
3053         }
3054
3055         params->cdb_size = 10;
3056         softc->minimum_command_size = 10;
3057         xpt_print(ccb->ccb_h.path,
3058             "%s(6) failed, increasing minimum CDB size to 10 bytes\n",
3059             (cdb[0] == MODE_SENSE_6) ? "MODE_SENSE" : "MODE_SELECT");
3060
3061         if (cdb[0] == MODE_SENSE_6) {
3062                 struct scsi_mode_sense_10 ms10;
3063                 struct scsi_mode_sense_6 *ms6;
3064                 int len;
3065
3066                 ms6 = (struct scsi_mode_sense_6 *)cdb;
3067
3068                 bzero(&ms10, sizeof(ms10));
3069                 ms10.opcode = MODE_SENSE_10;
3070                 ms10.byte2 = ms6->byte2;
3071                 ms10.page = ms6->page;
3072
3073                 /*
3074                  * 10 byte mode header, block descriptor,
3075                  * sizeof(union cd_pages)
3076                  */
3077                 len = sizeof(struct cd_mode_data_10);
3078                 ccb->csio.dxfer_len = len;
3079
3080                 scsi_ulto2b(len, ms10.length);
3081                 ms10.control = ms6->control;
3082                 bcopy(&ms10, cdb, 10);
3083                 ccb->csio.cdb_len = 10;
3084         } else {
3085                 struct scsi_mode_select_10 ms10;
3086                 struct scsi_mode_select_6 *ms6;
3087                 struct scsi_mode_header_6 *header6;
3088                 struct scsi_mode_header_10 *header10;
3089                 struct scsi_mode_page_header *page_header;
3090                 int blk_desc_len, page_num, page_size, len;
3091
3092                 ms6 = (struct scsi_mode_select_6 *)cdb;
3093
3094                 bzero(&ms10, sizeof(ms10));
3095                 ms10.opcode = MODE_SELECT_10;
3096                 ms10.byte2 = ms6->byte2;
3097
3098                 header6 = (struct scsi_mode_header_6 *)params->mode_buf;
3099                 header10 = (struct scsi_mode_header_10 *)params->mode_buf;
3100
3101                 page_header = find_mode_page_6(header6);
3102                 page_num = page_header->page_code;
3103
3104                 blk_desc_len = header6->blk_desc_len;
3105
3106                 page_size = cdgetpagesize(page_num);
3107
3108                 if (page_size != (page_header->page_length +
3109                     sizeof(*page_header)))
3110                         page_size = page_header->page_length +
3111                                 sizeof(*page_header);
3112
3113                 len = sizeof(*header10) + blk_desc_len + page_size;
3114
3115                 len = min(params->alloc_len, len);
3116
3117                 /*
3118                  * Since the 6 byte parameter header is shorter than the 10
3119                  * byte parameter header, we need to copy the actual mode
3120                  * page data, and the block descriptor, if any, so things wind
3121                  * up in the right place.  The regions will overlap, but
3122                  * bcopy() does the right thing.
3123                  */
3124                 bcopy(params->mode_buf + sizeof(*header6),
3125                       params->mode_buf + sizeof(*header10),
3126                       len - sizeof(*header10));
3127
3128                 /* Make sure these fields are set correctly. */
3129                 scsi_ulto2b(0, header10->data_length);
3130                 header10->medium_type = 0;
3131                 scsi_ulto2b(blk_desc_len, header10->blk_desc_len);
3132
3133                 ccb->csio.dxfer_len = len;
3134
3135                 scsi_ulto2b(len, ms10.length);
3136                 ms10.control = ms6->control;
3137                 bcopy(&ms10, cdb, 10);
3138                 ccb->csio.cdb_len = 10;
3139         }
3140
3141         frozen = (ccb->ccb_h.status & CAM_DEV_QFRZN) != 0;
3142         ccb->ccb_h.status = CAM_REQUEUE_REQ;
3143         xpt_action(ccb);
3144         if (frozen) {
3145                 cam_release_devq(ccb->ccb_h.path,
3146                                  /*relsim_flags*/0,
3147                                  /*openings*/0,
3148                                  /*timeout*/0,
3149                                  /*getcount_only*/0);
3150         }
3151
3152         return (ERESTART);
3153 }
3154
3155 static int
3156 cderror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
3157 {
3158         struct cd_softc *softc;
3159         struct cam_periph *periph;
3160         int error;
3161
3162         periph = xpt_path_periph(ccb->ccb_h.path);
3163         softc = (struct cd_softc *)periph->softc;
3164
3165         error = 0;
3166
3167         /*
3168          * We use a status of CAM_REQ_INVALID as shorthand -- if a 6 byte
3169          * CDB comes back with this particular error, try transforming it
3170          * into the 10 byte version.
3171          */
3172         if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INVALID) {
3173                 error = cd6byteworkaround(ccb);
3174         } else if (((ccb->ccb_h.status & CAM_STATUS_MASK) ==
3175                      CAM_SCSI_STATUS_ERROR)
3176          && (ccb->ccb_h.status & CAM_AUTOSNS_VALID)
3177          && (ccb->csio.scsi_status == SCSI_STATUS_CHECK_COND)
3178          && ((ccb->ccb_h.flags & CAM_SENSE_PHYS) == 0)
3179          && ((ccb->ccb_h.flags & CAM_SENSE_PTR) == 0)) {
3180                 int sense_key, error_code, asc, ascq;
3181
3182                 scsi_extract_sense_len(&ccb->csio.sense_data,
3183                     ccb->csio.sense_len - ccb->csio.sense_resid, &error_code,
3184                     &sense_key, &asc, &ascq, /*show_errors*/ 1);
3185                 if (sense_key == SSD_KEY_ILLEGAL_REQUEST)
3186                         error = cd6byteworkaround(ccb);
3187         }
3188
3189         if (error == ERESTART)
3190                 return (error);
3191
3192         /*
3193          * XXX
3194          * Until we have a better way of doing pack validation,
3195          * don't treat UAs as errors.
3196          */
3197         sense_flags |= SF_RETRY_UA;
3198         return (cam_periph_error(ccb, cam_flags, sense_flags,
3199                                  &softc->saved_ccb));
3200 }
3201
3202 /*
3203  * Read table of contents
3204  */
3205 static int
3206 cdreadtoc(struct cam_periph *periph, u_int32_t mode, u_int32_t start,
3207           u_int8_t *data, u_int32_t len, u_int32_t sense_flags)
3208 {
3209         struct scsi_read_toc *scsi_cmd;
3210         u_int32_t ntoc;
3211         struct ccb_scsiio *csio;
3212         union ccb *ccb;
3213         int error;
3214
3215         ntoc = len;
3216         error = 0;
3217
3218         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3219
3220         csio = &ccb->csio;
3221
3222         cam_fill_csio(csio,
3223                       /* retries */ cd_retry_count,
3224                       /* cbfcnp */ cddone,
3225                       /* flags */ CAM_DIR_IN,
3226                       /* tag_action */ MSG_SIMPLE_Q_TAG,
3227                       /* data_ptr */ data,
3228                       /* dxfer_len */ len,
3229                       /* sense_len */ SSD_FULL_SIZE,
3230                       sizeof(struct scsi_read_toc),
3231                       /* timeout */ 50000);
3232
3233         scsi_cmd = (struct scsi_read_toc *)&csio->cdb_io.cdb_bytes;
3234         bzero (scsi_cmd, sizeof(*scsi_cmd));
3235
3236         if (mode == CD_MSF_FORMAT)
3237                 scsi_cmd->byte2 |= CD_MSF;
3238         scsi_cmd->from_track = start;
3239         /* scsi_ulto2b(ntoc, (u_int8_t *)scsi_cmd->data_len); */
3240         scsi_cmd->data_len[0] = (ntoc) >> 8;
3241         scsi_cmd->data_len[1] = (ntoc) & 0xff;
3242
3243         scsi_cmd->op_code = READ_TOC;
3244
3245         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3246                          /*sense_flags*/SF_RETRY_UA | sense_flags);
3247
3248         xpt_release_ccb(ccb);
3249
3250         return(error);
3251 }
3252
3253 static int
3254 cdreadsubchannel(struct cam_periph *periph, u_int32_t mode,
3255                  u_int32_t format, int track,
3256                  struct cd_sub_channel_info *data, u_int32_t len)
3257 {
3258         struct scsi_read_subchannel *scsi_cmd;
3259         struct ccb_scsiio *csio;
3260         union ccb *ccb;
3261         int error;
3262
3263         error = 0;
3264
3265         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3266
3267         csio = &ccb->csio;
3268
3269         cam_fill_csio(csio,
3270                       /* retries */ cd_retry_count,
3271                       /* cbfcnp */ cddone,
3272                       /* flags */ CAM_DIR_IN,
3273                       /* tag_action */ MSG_SIMPLE_Q_TAG,
3274                       /* data_ptr */ (u_int8_t *)data,
3275                       /* dxfer_len */ len,
3276                       /* sense_len */ SSD_FULL_SIZE,
3277                       sizeof(struct scsi_read_subchannel),
3278                       /* timeout */ 50000);
3279
3280         scsi_cmd = (struct scsi_read_subchannel *)&csio->cdb_io.cdb_bytes;
3281         bzero (scsi_cmd, sizeof(*scsi_cmd));
3282
3283         scsi_cmd->op_code = READ_SUBCHANNEL;
3284         if (mode == CD_MSF_FORMAT)
3285                 scsi_cmd->byte1 |= CD_MSF;
3286         scsi_cmd->byte2 = SRS_SUBQ;
3287         scsi_cmd->subchan_format = format;
3288         scsi_cmd->track = track;
3289         scsi_ulto2b(len, (u_int8_t *)scsi_cmd->data_len);
3290         scsi_cmd->control = 0;
3291
3292         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3293                          /*sense_flags*/SF_RETRY_UA);
3294
3295         xpt_release_ccb(ccb);
3296
3297         return(error);
3298 }
3299
3300
3301 /*
3302  * All MODE_SENSE requests in the cd(4) driver MUST go through this
3303  * routine.  See comments in cd6byteworkaround() for details.
3304  */
3305 static int
3306 cdgetmode(struct cam_periph *periph, struct cd_mode_params *data,
3307           u_int32_t page)
3308 {
3309         struct ccb_scsiio *csio;
3310         struct cd_softc *softc;
3311         union ccb *ccb;
3312         int param_len;
3313         int error;
3314
3315         softc = (struct cd_softc *)periph->softc;
3316
3317         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3318
3319         csio = &ccb->csio;
3320
3321         data->cdb_size = softc->minimum_command_size;
3322         if (data->cdb_size < 10)
3323                 param_len = sizeof(struct cd_mode_data);
3324         else
3325                 param_len = sizeof(struct cd_mode_data_10);
3326
3327         /* Don't say we've got more room than we actually allocated */
3328         param_len = min(param_len, data->alloc_len);
3329
3330         scsi_mode_sense_len(csio,
3331                             /* retries */ cd_retry_count,
3332                             /* cbfcnp */ cddone,
3333                             /* tag_action */ MSG_SIMPLE_Q_TAG,
3334                             /* dbd */ 0,
3335                             /* page_code */ SMS_PAGE_CTRL_CURRENT,
3336                             /* page */ page,
3337                             /* param_buf */ data->mode_buf,
3338                             /* param_len */ param_len,
3339                             /* minimum_cmd_size */ softc->minimum_command_size,
3340                             /* sense_len */ SSD_FULL_SIZE,
3341                             /* timeout */ 50000);
3342
3343         /*
3344          * It would be nice not to have to do this, but there's no
3345          * available pointer in the CCB that would allow us to stuff the
3346          * mode params structure in there and retrieve it in
3347          * cd6byteworkaround(), so we can set the cdb size.  The cdb size
3348          * lets the caller know what CDB size we ended up using, so they
3349          * can find the actual mode page offset.
3350          */
3351         STAILQ_INSERT_TAIL(&softc->mode_queue, data, links);
3352
3353         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3354                          /*sense_flags*/SF_RETRY_UA);
3355
3356         xpt_release_ccb(ccb);
3357
3358         STAILQ_REMOVE(&softc->mode_queue, data, cd_mode_params, links);
3359
3360         /*
3361          * This is a bit of belt-and-suspenders checking, but if we run
3362          * into a situation where the target sends back multiple block
3363          * descriptors, we might not have enough space in the buffer to
3364          * see the whole mode page.  Better to return an error than
3365          * potentially access memory beyond our malloced region.
3366          */
3367         if (error == 0) {
3368                 u_int32_t data_len;
3369
3370                 if (data->cdb_size == 10) {
3371                         struct scsi_mode_header_10 *hdr10;
3372
3373                         hdr10 = (struct scsi_mode_header_10 *)data->mode_buf;
3374                         data_len = scsi_2btoul(hdr10->data_length);
3375                         data_len += sizeof(hdr10->data_length);
3376                 } else {
3377                         struct scsi_mode_header_6 *hdr6;
3378
3379                         hdr6 = (struct scsi_mode_header_6 *)data->mode_buf;
3380                         data_len = hdr6->data_length;
3381                         data_len += sizeof(hdr6->data_length);
3382                 }
3383
3384                 /*
3385                  * Complain if there is more mode data available than we
3386                  * allocated space for.  This could potentially happen if
3387                  * we miscalculated the page length for some reason, if the
3388                  * drive returns multiple block descriptors, or if it sets
3389                  * the data length incorrectly.
3390                  */
3391                 if (data_len > data->alloc_len) {
3392                         xpt_print(periph->path, "allocated modepage %d length "
3393                             "%d < returned length %d\n", page, data->alloc_len,
3394                             data_len);
3395                         error = ENOSPC;
3396                 }
3397         }
3398         return (error);
3399 }
3400
3401 /*
3402  * All MODE_SELECT requests in the cd(4) driver MUST go through this
3403  * routine.  See comments in cd6byteworkaround() for details.
3404  */
3405 static int
3406 cdsetmode(struct cam_periph *periph, struct cd_mode_params *data)
3407 {
3408         struct ccb_scsiio *csio;
3409         struct cd_softc *softc;
3410         union ccb *ccb;
3411         int cdb_size, param_len;
3412         int error;
3413
3414         softc = (struct cd_softc *)periph->softc;
3415
3416         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3417
3418         csio = &ccb->csio;
3419
3420         error = 0;
3421
3422         /*
3423          * If the data is formatted for the 10 byte version of the mode
3424          * select parameter list, we need to use the 10 byte CDB.
3425          * Otherwise, we use whatever the stored minimum command size.
3426          */
3427         if (data->cdb_size == 10)
3428                 cdb_size = data->cdb_size;
3429         else
3430                 cdb_size = softc->minimum_command_size;
3431
3432         if (cdb_size >= 10) {
3433                 struct scsi_mode_header_10 *mode_header;
3434                 u_int32_t data_len;
3435
3436                 mode_header = (struct scsi_mode_header_10 *)data->mode_buf;
3437
3438                 data_len = scsi_2btoul(mode_header->data_length);
3439
3440                 scsi_ulto2b(0, mode_header->data_length);
3441                 /*
3442                  * SONY drives do not allow a mode select with a medium_type
3443                  * value that has just been returned by a mode sense; use a
3444                  * medium_type of 0 (Default) instead.
3445                  */
3446                 mode_header->medium_type = 0;
3447
3448                 /*
3449                  * Pass back whatever the drive passed to us, plus the size
3450                  * of the data length field.
3451                  */
3452                 param_len = data_len + sizeof(mode_header->data_length);
3453
3454         } else {
3455                 struct scsi_mode_header_6 *mode_header;
3456
3457                 mode_header = (struct scsi_mode_header_6 *)data->mode_buf;
3458
3459                 param_len = mode_header->data_length + 1;
3460
3461                 mode_header->data_length = 0;
3462                 /*
3463                  * SONY drives do not allow a mode select with a medium_type
3464                  * value that has just been returned by a mode sense; use a
3465                  * medium_type of 0 (Default) instead.
3466                  */
3467                 mode_header->medium_type = 0;
3468         }
3469
3470         /* Don't say we've got more room than we actually allocated */
3471         param_len = min(param_len, data->alloc_len);
3472
3473         scsi_mode_select_len(csio,
3474                              /* retries */ cd_retry_count,
3475                              /* cbfcnp */ cddone,
3476                              /* tag_action */ MSG_SIMPLE_Q_TAG,
3477                              /* scsi_page_fmt */ 1,
3478                              /* save_pages */ 0,
3479                              /* param_buf */ data->mode_buf,
3480                              /* param_len */ param_len,
3481                              /* minimum_cmd_size */ cdb_size,
3482                              /* sense_len */ SSD_FULL_SIZE,
3483                              /* timeout */ 50000);
3484
3485         /* See comments in cdgetmode() and cd6byteworkaround(). */
3486         STAILQ_INSERT_TAIL(&softc->mode_queue, data, links);
3487
3488         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3489                          /*sense_flags*/SF_RETRY_UA);
3490
3491         xpt_release_ccb(ccb);
3492
3493         STAILQ_REMOVE(&softc->mode_queue, data, cd_mode_params, links);
3494
3495         return (error);
3496 }
3497
3498
3499 static int
3500 cdplay(struct cam_periph *periph, u_int32_t blk, u_int32_t len)
3501 {
3502         struct ccb_scsiio *csio;
3503         union ccb *ccb;
3504         int error;
3505         u_int8_t cdb_len;
3506
3507         error = 0;
3508         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3509         csio = &ccb->csio;
3510         /*
3511          * Use the smallest possible command to perform the operation.
3512          */
3513         if ((len & 0xffff0000) == 0) {
3514                 /*
3515                  * We can fit in a 10 byte cdb.
3516                  */
3517                 struct scsi_play_10 *scsi_cmd;
3518
3519                 scsi_cmd = (struct scsi_play_10 *)&csio->cdb_io.cdb_bytes;
3520                 bzero (scsi_cmd, sizeof(*scsi_cmd));
3521                 scsi_cmd->op_code = PLAY_10;
3522                 scsi_ulto4b(blk, (u_int8_t *)scsi_cmd->blk_addr);
3523                 scsi_ulto2b(len, (u_int8_t *)scsi_cmd->xfer_len);
3524                 cdb_len = sizeof(*scsi_cmd);
3525         } else  {
3526                 struct scsi_play_12 *scsi_cmd;
3527
3528                 scsi_cmd = (struct scsi_play_12 *)&csio->cdb_io.cdb_bytes;
3529                 bzero (scsi_cmd, sizeof(*scsi_cmd));
3530                 scsi_cmd->op_code = PLAY_12;
3531                 scsi_ulto4b(blk, (u_int8_t *)scsi_cmd->blk_addr);
3532                 scsi_ulto4b(len, (u_int8_t *)scsi_cmd->xfer_len);
3533                 cdb_len = sizeof(*scsi_cmd);
3534         }
3535         cam_fill_csio(csio,
3536                       /*retries*/ cd_retry_count,
3537                       cddone,
3538                       /*flags*/CAM_DIR_NONE,
3539                       MSG_SIMPLE_Q_TAG,
3540                       /*dataptr*/NULL,
3541                       /*datalen*/0,
3542                       /*sense_len*/SSD_FULL_SIZE,
3543                       cdb_len,
3544                       /*timeout*/50 * 1000);
3545
3546         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3547                          /*sense_flags*/SF_RETRY_UA);
3548
3549         xpt_release_ccb(ccb);
3550
3551         return(error);
3552 }
3553
3554 static int
3555 cdplaymsf(struct cam_periph *periph, u_int32_t startm, u_int32_t starts,
3556           u_int32_t startf, u_int32_t endm, u_int32_t ends, u_int32_t endf)
3557 {
3558         struct scsi_play_msf *scsi_cmd;
3559         struct ccb_scsiio *csio;
3560         union ccb *ccb;
3561         int error;
3562
3563         error = 0;
3564
3565         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3566
3567         csio = &ccb->csio;
3568
3569         cam_fill_csio(csio,
3570                       /* retries */ cd_retry_count,
3571                       /* cbfcnp */ cddone,
3572                       /* flags */ CAM_DIR_NONE,
3573                       /* tag_action */ MSG_SIMPLE_Q_TAG,
3574                       /* data_ptr */ NULL,
3575                       /* dxfer_len */ 0,
3576                       /* sense_len */ SSD_FULL_SIZE,
3577                       sizeof(struct scsi_play_msf),
3578                       /* timeout */ 50000);
3579
3580         scsi_cmd = (struct scsi_play_msf *)&csio->cdb_io.cdb_bytes;
3581         bzero (scsi_cmd, sizeof(*scsi_cmd));
3582
3583         scsi_cmd->op_code = PLAY_MSF;
3584         scsi_cmd->start_m = startm;
3585         scsi_cmd->start_s = starts;
3586         scsi_cmd->start_f = startf;
3587         scsi_cmd->end_m = endm;
3588         scsi_cmd->end_s = ends;
3589         scsi_cmd->end_f = endf;
3590
3591         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3592                          /*sense_flags*/SF_RETRY_UA);
3593
3594         xpt_release_ccb(ccb);
3595
3596         return(error);
3597 }
3598
3599
3600 static int
3601 cdplaytracks(struct cam_periph *periph, u_int32_t strack, u_int32_t sindex,
3602              u_int32_t etrack, u_int32_t eindex)
3603 {
3604         struct scsi_play_track *scsi_cmd;
3605         struct ccb_scsiio *csio;
3606         union ccb *ccb;
3607         int error;
3608
3609         error = 0;
3610
3611         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3612
3613         csio = &ccb->csio;
3614
3615         cam_fill_csio(csio,
3616                       /* retries */ cd_retry_count,
3617                       /* cbfcnp */ cddone,
3618                       /* flags */ CAM_DIR_NONE,
3619                       /* tag_action */ MSG_SIMPLE_Q_TAG,
3620                       /* data_ptr */ NULL,
3621                       /* dxfer_len */ 0,
3622                       /* sense_len */ SSD_FULL_SIZE,
3623                       sizeof(struct scsi_play_track),
3624                       /* timeout */ 50000);
3625
3626         scsi_cmd = (struct scsi_play_track *)&csio->cdb_io.cdb_bytes;
3627         bzero (scsi_cmd, sizeof(*scsi_cmd));
3628
3629         scsi_cmd->op_code = PLAY_TRACK;
3630         scsi_cmd->start_track = strack;
3631         scsi_cmd->start_index = sindex;
3632         scsi_cmd->end_track = etrack;
3633         scsi_cmd->end_index = eindex;
3634
3635         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3636                          /*sense_flags*/SF_RETRY_UA);
3637
3638         xpt_release_ccb(ccb);
3639
3640         return(error);
3641 }
3642
3643 static int
3644 cdpause(struct cam_periph *periph, u_int32_t go)
3645 {
3646         struct scsi_pause *scsi_cmd;
3647         struct ccb_scsiio *csio;
3648         union ccb *ccb;
3649         int error;
3650
3651         error = 0;
3652
3653         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3654
3655         csio = &ccb->csio;
3656
3657         cam_fill_csio(csio,
3658                       /* retries */ cd_retry_count,
3659                       /* cbfcnp */ cddone,
3660                       /* flags */ CAM_DIR_NONE,
3661                       /* tag_action */ MSG_SIMPLE_Q_TAG,
3662                       /* data_ptr */ NULL,
3663                       /* dxfer_len */ 0,
3664                       /* sense_len */ SSD_FULL_SIZE,
3665                       sizeof(struct scsi_pause),
3666                       /* timeout */ 50000);
3667
3668         scsi_cmd = (struct scsi_pause *)&csio->cdb_io.cdb_bytes;
3669         bzero (scsi_cmd, sizeof(*scsi_cmd));
3670
3671         scsi_cmd->op_code = PAUSE;
3672         scsi_cmd->resume = go;
3673
3674         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3675                          /*sense_flags*/SF_RETRY_UA);
3676
3677         xpt_release_ccb(ccb);
3678
3679         return(error);
3680 }
3681
3682 static int
3683 cdstartunit(struct cam_periph *periph, int load)
3684 {
3685         union ccb *ccb;
3686         int error;
3687
3688         error = 0;
3689
3690         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3691
3692         scsi_start_stop(&ccb->csio,
3693                         /* retries */ cd_retry_count,
3694                         /* cbfcnp */ cddone,
3695                         /* tag_action */ MSG_SIMPLE_Q_TAG,
3696                         /* start */ TRUE,
3697                         /* load_eject */ load,
3698                         /* immediate */ FALSE,
3699                         /* sense_len */ SSD_FULL_SIZE,
3700                         /* timeout */ 50000);
3701
3702         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3703                          /*sense_flags*/SF_RETRY_UA);
3704
3705         xpt_release_ccb(ccb);
3706
3707         return(error);
3708 }
3709
3710 static int
3711 cdstopunit(struct cam_periph *periph, u_int32_t eject)
3712 {
3713         union ccb *ccb;
3714         int error;
3715
3716         error = 0;
3717
3718         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3719
3720         scsi_start_stop(&ccb->csio,
3721                         /* retries */ cd_retry_count,
3722                         /* cbfcnp */ cddone,
3723                         /* tag_action */ MSG_SIMPLE_Q_TAG,
3724                         /* start */ FALSE,
3725                         /* load_eject */ eject,
3726                         /* immediate */ FALSE,
3727                         /* sense_len */ SSD_FULL_SIZE,
3728                         /* timeout */ 50000);
3729
3730         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3731                          /*sense_flags*/SF_RETRY_UA);
3732
3733         xpt_release_ccb(ccb);
3734
3735         return(error);
3736 }
3737
3738 static int
3739 cdsetspeed(struct cam_periph *periph, u_int32_t rdspeed, u_int32_t wrspeed)
3740 {
3741         struct scsi_set_speed *scsi_cmd;
3742         struct ccb_scsiio *csio;
3743         union ccb *ccb;
3744         int error;
3745
3746         error = 0;
3747         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3748         csio = &ccb->csio;
3749
3750         /* Preserve old behavior: units in multiples of CDROM speed */
3751         if (rdspeed < 177)
3752                 rdspeed *= 177;
3753         if (wrspeed < 177)
3754                 wrspeed *= 177;
3755
3756         cam_fill_csio(csio,
3757                       /* retries */ cd_retry_count,
3758                       /* cbfcnp */ cddone,
3759                       /* flags */ CAM_DIR_NONE,
3760                       /* tag_action */ MSG_SIMPLE_Q_TAG,
3761                       /* data_ptr */ NULL,
3762                       /* dxfer_len */ 0,
3763                       /* sense_len */ SSD_FULL_SIZE,
3764                       sizeof(struct scsi_set_speed),
3765                       /* timeout */ 50000);
3766
3767         scsi_cmd = (struct scsi_set_speed *)&csio->cdb_io.cdb_bytes;
3768         bzero(scsi_cmd, sizeof(*scsi_cmd));
3769
3770         scsi_cmd->opcode = SET_CD_SPEED;
3771         scsi_ulto2b(rdspeed, scsi_cmd->readspeed);
3772         scsi_ulto2b(wrspeed, scsi_cmd->writespeed);
3773
3774         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3775                          /*sense_flags*/SF_RETRY_UA);
3776
3777         xpt_release_ccb(ccb);
3778
3779         return(error);
3780 }
3781
3782 static int
3783 cdreportkey(struct cam_periph *periph, struct dvd_authinfo *authinfo)
3784 {
3785         union ccb *ccb;
3786         u_int8_t *databuf;
3787         u_int32_t lba;
3788         int error;
3789         int length;
3790
3791         error = 0;
3792         databuf = NULL;
3793         lba = 0;
3794
3795         switch (authinfo->format) {
3796         case DVD_REPORT_AGID:
3797                 length = sizeof(struct scsi_report_key_data_agid);
3798                 break;
3799         case DVD_REPORT_CHALLENGE:
3800                 length = sizeof(struct scsi_report_key_data_challenge);
3801                 break;
3802         case DVD_REPORT_KEY1:
3803                 length = sizeof(struct scsi_report_key_data_key1_key2);
3804                 break;
3805         case DVD_REPORT_TITLE_KEY:
3806                 length = sizeof(struct scsi_report_key_data_title);
3807                 /* The lba field is only set for the title key */
3808                 lba = authinfo->lba;
3809                 break;
3810         case DVD_REPORT_ASF:
3811                 length = sizeof(struct scsi_report_key_data_asf);
3812                 break;
3813         case DVD_REPORT_RPC:
3814                 length = sizeof(struct scsi_report_key_data_rpc);
3815                 break;
3816         case DVD_INVALIDATE_AGID:
3817                 length = 0;
3818                 break;
3819         default:
3820                 return (EINVAL);
3821         }
3822
3823         if (length != 0) {
3824                 databuf = malloc(length, M_DEVBUF, M_WAITOK | M_ZERO);
3825         } else
3826                 databuf = NULL;
3827
3828         cam_periph_lock(periph);
3829         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
3830
3831         scsi_report_key(&ccb->csio,
3832                         /* retries */ cd_retry_count,
3833                         /* cbfcnp */ cddone,
3834                         /* tag_action */ MSG_SIMPLE_Q_TAG,
3835                         /* lba */ lba,
3836                         /* agid */ authinfo->agid,
3837                         /* key_format */ authinfo->format,
3838                         /* data_ptr */ databuf,
3839                         /* dxfer_len */ length,
3840                         /* sense_len */ SSD_FULL_SIZE,
3841                         /* timeout */ 50000);
3842
3843         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
3844                          /*sense_flags*/SF_RETRY_UA);
3845
3846         if (error != 0)
3847                 goto bailout;
3848
3849         if (ccb->csio.resid != 0) {
3850                 xpt_print(periph->path, "warning, residual for report key "
3851                     "command is %d\n", ccb->csio.resid);
3852         }
3853
3854         switch(authinfo->format) {
3855         case DVD_REPORT_AGID: {
3856                 struct scsi_report_key_data_agid *agid_data;
3857
3858                 agid_data = (struct scsi_report_key_data_agid *)databuf;
3859
3860                 authinfo->agid = (agid_data->agid & RKD_AGID_MASK) >>
3861                         RKD_AGID_SHIFT;
3862                 break;
3863         }
3864         case DVD_REPORT_CHALLENGE: {
3865                 struct scsi_report_key_data_challenge *chal_data;
3866
3867                 chal_data = (struct scsi_report_key_data_challenge *)databuf;
3868
3869                 bcopy(chal_data->challenge_key, authinfo->keychal,
3870                       min(sizeof(chal_data->challenge_key),
3871                           sizeof(authinfo->keychal)));
3872                 break;
3873         }
3874         case DVD_REPORT_KEY1: {
3875                 struct scsi_report_key_data_key1_key2 *key1_data;
3876
3877                 key1_data = (struct scsi_report_key_data_key1_key2 *)databuf;
3878
3879                 bcopy(key1_data->key1, authinfo->keychal,
3880                       min(sizeof(key1_data->key1), sizeof(authinfo->keychal)));
3881                 break;
3882         }
3883         case DVD_REPORT_TITLE_KEY: {
3884                 struct scsi_report_key_data_title *title_data;
3885
3886                 title_data = (struct scsi_report_key_data_title *)databuf;
3887
3888                 authinfo->cpm = (title_data->byte0 & RKD_TITLE_CPM) >>
3889                         RKD_TITLE_CPM_SHIFT;
3890                 authinfo->cp_sec = (title_data->byte0 & RKD_TITLE_CP_SEC) >>
3891                         RKD_TITLE_CP_SEC_SHIFT;
3892                 authinfo->cgms = (title_data->byte0 & RKD_TITLE_CMGS_MASK) >>
3893                         RKD_TITLE_CMGS_SHIFT;
3894                 bcopy(title_data->title_key, authinfo->keychal,
3895                       min(sizeof(title_data->title_key),
3896                           sizeof(authinfo->keychal)));
3897                 break;
3898         }
3899         case DVD_REPORT_ASF: {
3900                 struct scsi_report_key_data_asf *asf_data;
3901
3902                 asf_data = (struct scsi_report_key_data_asf *)databuf;
3903
3904                 authinfo->asf = asf_data->success & RKD_ASF_SUCCESS;
3905                 break;
3906         }
3907         case DVD_REPORT_RPC: {
3908                 struct scsi_report_key_data_rpc *rpc_data;
3909
3910                 rpc_data = (struct scsi_report_key_data_rpc *)databuf;
3911
3912                 authinfo->reg_type = (rpc_data->byte4 & RKD_RPC_TYPE_MASK) >>
3913                         RKD_RPC_TYPE_SHIFT;
3914                 authinfo->vend_rsts =
3915                         (rpc_data->byte4 & RKD_RPC_VENDOR_RESET_MASK) >>
3916                         RKD_RPC_VENDOR_RESET_SHIFT;
3917                 authinfo->user_rsts = rpc_data->byte4 & RKD_RPC_USER_RESET_MASK;
3918                 authinfo->region = rpc_data->region_mask;
3919                 authinfo->rpc_scheme = rpc_data->rpc_scheme1;
3920                 break;
3921         }
3922         case DVD_INVALIDATE_AGID:
3923                 break;
3924         default:
3925                 /* This should be impossible, since we checked above */
3926                 error = EINVAL;
3927                 goto bailout;
3928                 break; /* NOTREACHED */
3929         }
3930
3931 bailout:
3932         xpt_release_ccb(ccb);
3933         cam_periph_unlock(periph);
3934
3935         if (databuf != NULL)
3936                 free(databuf, M_DEVBUF);
3937
3938         return(error);
3939 }
3940
3941 static int
3942 cdsendkey(struct cam_periph *periph, struct dvd_authinfo *authinfo)
3943 {
3944         union ccb *ccb;
3945         u_int8_t *databuf;
3946         int length;
3947         int error;
3948
3949         error = 0;
3950         databuf = NULL;
3951
3952         switch(authinfo->format) {
3953         case DVD_SEND_CHALLENGE: {
3954                 struct scsi_report_key_data_challenge *challenge_data;
3955
3956                 length = sizeof(*challenge_data);
3957
3958                 challenge_data = malloc(length, M_DEVBUF, M_WAITOK | M_ZERO);
3959
3960                 databuf = (u_int8_t *)challenge_data;
3961
3962                 scsi_ulto2b(length - sizeof(challenge_data->data_len),
3963                             challenge_data->data_len);
3964
3965                 bcopy(authinfo->keychal, challenge_data->challenge_key,
3966                       min(sizeof(authinfo->keychal),
3967                           sizeof(challenge_data->challenge_key)));
3968                 break;
3969         }
3970         case DVD_SEND_KEY2: {
3971                 struct scsi_report_key_data_key1_key2 *key2_data;
3972
3973                 length = sizeof(*key2_data);
3974
3975                 key2_data = malloc(length, M_DEVBUF, M_WAITOK | M_ZERO);
3976
3977                 databuf = (u_int8_t *)key2_data;
3978
3979                 scsi_ulto2b(length - sizeof(key2_data->data_len),
3980                             key2_data->data_len);
3981
3982                 bcopy(authinfo->keychal, key2_data->key1,
3983                       min(sizeof(authinfo->keychal), sizeof(key2_data->key1)));
3984
3985                 break;
3986         }
3987         case DVD_SEND_RPC: {
3988                 struct scsi_send_key_data_rpc *rpc_data;
3989
3990                 length = sizeof(*rpc_data);
3991
3992                 rpc_data = malloc(length, M_DEVBUF, M_WAITOK | M_ZERO);
3993
3994                 databuf = (u_int8_t *)rpc_data;
3995
3996                 scsi_ulto2b(length - sizeof(rpc_data->data_len),
3997                             rpc_data->data_len);
3998
3999                 rpc_data->region_code = authinfo->region;
4000                 break;
4001         }
4002         default:
4003                 return (EINVAL);
4004         }
4005
4006         cam_periph_lock(periph);
4007         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
4008
4009         scsi_send_key(&ccb->csio,
4010                       /* retries */ cd_retry_count,
4011                       /* cbfcnp */ cddone,
4012                       /* tag_action */ MSG_SIMPLE_Q_TAG,
4013                       /* agid */ authinfo->agid,
4014                       /* key_format */ authinfo->format,
4015                       /* data_ptr */ databuf,
4016                       /* dxfer_len */ length,
4017                       /* sense_len */ SSD_FULL_SIZE,
4018                       /* timeout */ 50000);
4019
4020         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
4021                          /*sense_flags*/SF_RETRY_UA);
4022
4023         xpt_release_ccb(ccb);
4024         cam_periph_unlock(periph);
4025
4026         if (databuf != NULL)
4027                 free(databuf, M_DEVBUF);
4028
4029         return(error);
4030 }
4031
4032 static int
4033 cdreaddvdstructure(struct cam_periph *periph, struct dvd_struct *dvdstruct)
4034 {
4035         union ccb *ccb;
4036         u_int8_t *databuf;
4037         u_int32_t address;
4038         int error;
4039         int length;
4040
4041         error = 0;
4042         databuf = NULL;
4043         /* The address is reserved for many of the formats */
4044         address = 0;
4045
4046         switch(dvdstruct->format) {
4047         case DVD_STRUCT_PHYSICAL:
4048                 length = sizeof(struct scsi_read_dvd_struct_data_physical);
4049                 break;
4050         case DVD_STRUCT_COPYRIGHT:
4051                 length = sizeof(struct scsi_read_dvd_struct_data_copyright);
4052                 break;
4053         case DVD_STRUCT_DISCKEY:
4054                 length = sizeof(struct scsi_read_dvd_struct_data_disc_key);
4055                 break;
4056         case DVD_STRUCT_BCA:
4057                 length = sizeof(struct scsi_read_dvd_struct_data_bca);
4058                 break;
4059         case DVD_STRUCT_MANUFACT:
4060                 length = sizeof(struct scsi_read_dvd_struct_data_manufacturer);
4061                 break;
4062         case DVD_STRUCT_CMI:
4063                 return (ENODEV);
4064         case DVD_STRUCT_PROTDISCID:
4065                 length = sizeof(struct scsi_read_dvd_struct_data_prot_discid);
4066                 break;
4067         case DVD_STRUCT_DISCKEYBLOCK:
4068                 length = sizeof(struct scsi_read_dvd_struct_data_disc_key_blk);
4069                 break;
4070         case DVD_STRUCT_DDS:
4071                 length = sizeof(struct scsi_read_dvd_struct_data_dds);
4072                 break;
4073         case DVD_STRUCT_MEDIUM_STAT:
4074                 length = sizeof(struct scsi_read_dvd_struct_data_medium_status);
4075                 break;
4076         case DVD_STRUCT_SPARE_AREA:
4077                 length = sizeof(struct scsi_read_dvd_struct_data_spare_area);
4078                 break;
4079         case DVD_STRUCT_RMD_LAST:
4080                 return (ENODEV);
4081         case DVD_STRUCT_RMD_RMA:
4082                 return (ENODEV);
4083         case DVD_STRUCT_PRERECORDED:
4084                 length = sizeof(struct scsi_read_dvd_struct_data_leadin);
4085                 break;
4086         case DVD_STRUCT_UNIQUEID:
4087                 length = sizeof(struct scsi_read_dvd_struct_data_disc_id);
4088                 break;
4089         case DVD_STRUCT_DCB:
4090                 return (ENODEV);
4091         case DVD_STRUCT_LIST:
4092                 /*
4093                  * This is the maximum allocation length for the READ DVD
4094                  * STRUCTURE command.  There's nothing in the MMC3 spec
4095                  * that indicates a limit in the amount of data that can
4096                  * be returned from this call, other than the limits
4097                  * imposed by the 2-byte length variables.
4098                  */
4099                 length = 65535;
4100                 break;
4101         default:
4102                 return (EINVAL);
4103         }
4104
4105         if (length != 0) {
4106                 databuf = malloc(length, M_DEVBUF, M_WAITOK | M_ZERO);
4107         } else
4108                 databuf = NULL;
4109
4110         cam_periph_lock(periph);
4111         ccb = cdgetccb(periph, CAM_PRIORITY_NORMAL);
4112
4113         scsi_read_dvd_structure(&ccb->csio,
4114                                 /* retries */ cd_retry_count,
4115                                 /* cbfcnp */ cddone,
4116                                 /* tag_action */ MSG_SIMPLE_Q_TAG,
4117                                 /* lba */ address,
4118                                 /* layer_number */ dvdstruct->layer_num,
4119                                 /* key_format */ dvdstruct->format,
4120                                 /* agid */ dvdstruct->agid,
4121                                 /* data_ptr */ databuf,
4122                                 /* dxfer_len */ length,
4123                                 /* sense_len */ SSD_FULL_SIZE,
4124                                 /* timeout */ 50000);
4125
4126         error = cdrunccb(ccb, cderror, /*cam_flags*/CAM_RETRY_SELTO,
4127                          /*sense_flags*/SF_RETRY_UA);
4128
4129         if (error != 0)
4130                 goto bailout;
4131
4132         switch(dvdstruct->format) {
4133         case DVD_STRUCT_PHYSICAL: {
4134                 struct scsi_read_dvd_struct_data_layer_desc *inlayer;
4135                 struct dvd_layer *outlayer;
4136                 struct scsi_read_dvd_struct_data_physical *phys_data;
4137
4138                 phys_data =
4139                         (struct scsi_read_dvd_struct_data_physical *)databuf;
4140                 inlayer = &phys_data->layer_desc;
4141                 outlayer = (struct dvd_layer *)&dvdstruct->data;
4142
4143                 dvdstruct->length = sizeof(*inlayer);
4144
4145                 outlayer->book_type = (inlayer->book_type_version &
4146                         RDSD_BOOK_TYPE_MASK) >> RDSD_BOOK_TYPE_SHIFT;
4147                 outlayer->book_version = (inlayer->book_type_version &
4148                         RDSD_BOOK_VERSION_MASK);
4149                 outlayer->disc_size = (inlayer->disc_size_max_rate &
4150                         RDSD_DISC_SIZE_MASK) >> RDSD_DISC_SIZE_SHIFT;
4151                 outlayer->max_rate = (inlayer->disc_size_max_rate &
4152                         RDSD_MAX_RATE_MASK);
4153                 outlayer->nlayers = (inlayer->layer_info &
4154                         RDSD_NUM_LAYERS_MASK) >> RDSD_NUM_LAYERS_SHIFT;
4155                 outlayer->track_path = (inlayer->layer_info &
4156                         RDSD_TRACK_PATH_MASK) >> RDSD_TRACK_PATH_SHIFT;
4157                 outlayer->layer_type = (inlayer->layer_info &
4158                         RDSD_LAYER_TYPE_MASK);
4159                 outlayer->linear_density = (inlayer->density &
4160                         RDSD_LIN_DENSITY_MASK) >> RDSD_LIN_DENSITY_SHIFT;
4161                 outlayer->track_density = (inlayer->density &
4162                         RDSD_TRACK_DENSITY_MASK);
4163                 outlayer->bca = (inlayer->bca & RDSD_BCA_MASK) >>
4164                         RDSD_BCA_SHIFT;
4165                 outlayer->start_sector = scsi_3btoul(inlayer->main_data_start);
4166                 outlayer->end_sector = scsi_3btoul(inlayer->main_data_end);
4167                 outlayer->end_sector_l0 =
4168                         scsi_3btoul(inlayer->end_sector_layer0);
4169                 break;
4170         }
4171         case DVD_STRUCT_COPYRIGHT: {
4172                 struct scsi_read_dvd_struct_data_copyright *copy_data;
4173
4174                 copy_data = (struct scsi_read_dvd_struct_data_copyright *)
4175                         databuf;
4176
4177                 dvdstruct->cpst = copy_data->cps_type;
4178                 dvdstruct->rmi = copy_data->region_info;
4179                 dvdstruct->length = 0;
4180
4181                 break;
4182         }
4183         default:
4184                 /*
4185                  * Tell the user what the overall length is, no matter
4186                  * what we can actually fit in the data buffer.
4187                  */
4188                 dvdstruct->length = length - ccb->csio.resid -
4189                         sizeof(struct scsi_read_dvd_struct_data_header);
4190
4191                 /*
4192                  * But only actually copy out the smaller of what we read
4193                  * in or what the structure can take.
4194                  */
4195                 bcopy(databuf + sizeof(struct scsi_read_dvd_struct_data_header),
4196                       dvdstruct->data,
4197                       min(sizeof(dvdstruct->data), dvdstruct->length));
4198                 break;
4199         }
4200
4201 bailout:
4202         xpt_release_ccb(ccb);
4203         cam_periph_unlock(periph);
4204
4205         if (databuf != NULL)
4206                 free(databuf, M_DEVBUF);
4207
4208         return(error);
4209 }
4210
4211 void
4212 scsi_report_key(struct ccb_scsiio *csio, u_int32_t retries,
4213                 void (*cbfcnp)(struct cam_periph *, union ccb *),
4214                 u_int8_t tag_action, u_int32_t lba, u_int8_t agid,
4215                 u_int8_t key_format, u_int8_t *data_ptr, u_int32_t dxfer_len,
4216                 u_int8_t sense_len, u_int32_t timeout)
4217 {
4218         struct scsi_report_key *scsi_cmd;
4219
4220         scsi_cmd = (struct scsi_report_key *)&csio->cdb_io.cdb_bytes;
4221         bzero(scsi_cmd, sizeof(*scsi_cmd));
4222         scsi_cmd->opcode = REPORT_KEY;
4223         scsi_ulto4b(lba, scsi_cmd->lba);
4224         scsi_ulto2b(dxfer_len, scsi_cmd->alloc_len);
4225         scsi_cmd->agid_keyformat = (agid << RK_KF_AGID_SHIFT) |
4226                 (key_format & RK_KF_KEYFORMAT_MASK);
4227
4228         cam_fill_csio(csio,
4229                       retries,
4230                       cbfcnp,
4231                       /*flags*/ (dxfer_len == 0) ? CAM_DIR_NONE : CAM_DIR_IN,
4232                       tag_action,
4233                       /*data_ptr*/ data_ptr,
4234                       /*dxfer_len*/ dxfer_len,
4235                       sense_len,
4236                       sizeof(*scsi_cmd),
4237                       timeout);
4238 }
4239
4240 void
4241 scsi_send_key(struct ccb_scsiio *csio, u_int32_t retries,
4242               void (*cbfcnp)(struct cam_periph *, union ccb *),
4243               u_int8_t tag_action, u_int8_t agid, u_int8_t key_format,
4244               u_int8_t *data_ptr, u_int32_t dxfer_len, u_int8_t sense_len,
4245               u_int32_t timeout)
4246 {
4247         struct scsi_send_key *scsi_cmd;
4248
4249         scsi_cmd = (struct scsi_send_key *)&csio->cdb_io.cdb_bytes;
4250         bzero(scsi_cmd, sizeof(*scsi_cmd));
4251         scsi_cmd->opcode = SEND_KEY;
4252
4253         scsi_ulto2b(dxfer_len, scsi_cmd->param_len);
4254         scsi_cmd->agid_keyformat = (agid << RK_KF_AGID_SHIFT) |
4255                 (key_format & RK_KF_KEYFORMAT_MASK);
4256
4257         cam_fill_csio(csio,
4258                       retries,
4259                       cbfcnp,
4260                       /*flags*/ CAM_DIR_OUT,
4261                       tag_action,
4262                       /*data_ptr*/ data_ptr,
4263                       /*dxfer_len*/ dxfer_len,
4264                       sense_len,
4265                       sizeof(*scsi_cmd),
4266                       timeout);
4267 }
4268
4269
4270 void
4271 scsi_read_dvd_structure(struct ccb_scsiio *csio, u_int32_t retries,
4272                         void (*cbfcnp)(struct cam_periph *, union ccb *),
4273                         u_int8_t tag_action, u_int32_t address,
4274                         u_int8_t layer_number, u_int8_t format, u_int8_t agid,
4275                         u_int8_t *data_ptr, u_int32_t dxfer_len,
4276                         u_int8_t sense_len, u_int32_t timeout)
4277 {
4278         struct scsi_read_dvd_structure *scsi_cmd;
4279
4280         scsi_cmd = (struct scsi_read_dvd_structure *)&csio->cdb_io.cdb_bytes;
4281         bzero(scsi_cmd, sizeof(*scsi_cmd));
4282         scsi_cmd->opcode = READ_DVD_STRUCTURE;
4283
4284         scsi_ulto4b(address, scsi_cmd->address);
4285         scsi_cmd->layer_number = layer_number;
4286         scsi_cmd->format = format;
4287         scsi_ulto2b(dxfer_len, scsi_cmd->alloc_len);
4288         /* The AGID is the top two bits of this byte */
4289         scsi_cmd->agid = agid << 6;
4290
4291         cam_fill_csio(csio,
4292                       retries,
4293                       cbfcnp,
4294                       /*flags*/ CAM_DIR_IN,
4295                       tag_action,
4296                       /*data_ptr*/ data_ptr,
4297                       /*dxfer_len*/ dxfer_len,
4298                       sense_len,
4299                       sizeof(*scsi_cmd),
4300                       timeout);
4301 }