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