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