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