Cleanup remaining tsleep priority issues.
[dragonfly.git] / share / man / man9 / cd.9
1 .\" Copyright (c) 1997
2 .\"     John-Mark Gurney.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the author nor the names of any co-contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY John-Mark Gurney AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/share/man/man9/cd.9,v 1.11.2.3 2002/04/15 06:06:40 trhodes Exp $
29 .\" $DragonFly: src/share/man/man9/cd.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
30 .\"
31 .Dd October 10, 1998
32 .Dt CD 9
33 .Os
34 .Sh NAME
35 .Nm cd
36 .Nd CDROM driver for the CAM SCSI subsystem
37 .Sh DESCRIPTION
38 The
39 .Nm
40 device driver provides a read only interface for CDROM drives
41 .Tn ( SCSI
42 type 5)
43 and WORM drives
44 .Tn ( SCSI
45 type 4)
46 that support CDROM type commands.
47 Some drives don't behave as the driver expects.  See the section
48 QUIRKS for info on possible flags.
49 .Sh QUIRKS
50 Each
51 .Tn CD-ROM
52 device can have different interpretations of the
53 .Tn SCSI
54 spec.  This can lead to drives requiring special handling in the driver.  The
55 following is a list of quirks that the driver recognize.
56 .Bl -tag -width CD_Q_BCD_TRACKS
57 .It Dv CD_Q_NO_TOUCH
58 This flag tell the driver not to probe the drive at attach time to see if
59 there is a disk in the drive and find out what size it is.  This flag is
60 currently unimplemented in the CAM
61 .Nm
62 driver.
63 .It Dv CD_Q_BCD_TRACKS
64 This flag is for broken drives that return the track numbers in packed BCD
65 instead of straight decimal.  If the drive seems to skip tracks
66 (tracks 10-15 are skipped)
67 then you have a drive that is in need of this flag.
68 .It Dv CD_Q_NO_CHANGER
69 This flag tells the driver that the device in question is not a changer.
70 This is only necessary for a CDROM device with multiple luns that are not a
71 part of a changer.
72 .It Dv CD_Q_CHANGER
73 This flag tells the driver that the given device is a multi-lun changer.
74 In general, the driver will figure this out automatically when it sees a
75 LUN greater than 0.  Setting this flag only has the effect of telling the
76 driver to run the initial read capacity command for LUN 0 of the changer
77 through the changer scheduling code.
78 .El
79 .Sh FILES
80 .Bl -tag -width /sys/cam/scsi/scsi_cd.c -compact
81 .It Pa /sys/cam/scsi/scsi_cd.c
82 is the driver source file.
83 .El
84 .Sh SEE ALSO
85 .Xr cd 4 ,
86 .Xr scsi 4
87 .Sh HISTORY
88 The
89 .Nm
90 manual page first appeared in
91 .Fx 2.2 .
92 .Sh AUTHORS
93 .An -nosplit
94 This
95 manual page was written by
96 .An John-Mark Gurney Aq gurney_j@efn.org .
97 It was updated for CAM and
98 .Fx 3.0
99 by
100 .An Kenneth Merry Aq ken@FreeBSD.org .