start adding .Mt to email addresses in man pages
[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 .\"
30 .Dd October 10, 1998
31 .Dt CD 9
32 .Os
33 .Sh NAME
34 .Nm cd
35 .Nd CDROM driver for the CAM SCSI subsystem
36 .Sh DESCRIPTION
37 The
38 .Nm
39 device driver provides a read only interface for CDROM drives
40 .Tn ( SCSI
41 type 5)
42 and WORM drives
43 .Tn ( SCSI
44 type 4)
45 that support CDROM type commands.
46 Some drives don't behave as the driver expects.  See the section
47 QUIRKS for info on possible flags.
48 .Sh QUIRKS
49 Each
50 .Tn CD-ROM
51 device can have different interpretations of the
52 .Tn SCSI
53 spec.  This can lead to drives requiring special handling in the driver.  The
54 following is a list of quirks that the driver recognize.
55 .Bl -tag -width CD_Q_BCD_TRACKS
56 .It Dv CD_Q_NO_TOUCH
57 This flag tell the driver not to probe the drive at attach time to see if
58 there is a disk in the drive and find out what size it is.  This flag is
59 currently unimplemented in the CAM
60 .Nm
61 driver.
62 .It Dv CD_Q_BCD_TRACKS
63 This flag is for broken drives that return the track numbers in packed BCD
64 instead of straight decimal.  If the drive seems to skip tracks
65 (tracks 10-15 are skipped)
66 then you have a drive that is in need of this flag.
67 .It Dv CD_Q_NO_CHANGER
68 This flag tells the driver that the device in question is not a changer.
69 This is only necessary for a CDROM device with multiple luns that are not a
70 part of a changer.
71 .It Dv CD_Q_CHANGER
72 This flag tells the driver that the given device is a multi-lun changer.
73 In general, the driver will figure this out automatically when it sees a
74 LUN greater than 0.  Setting this flag only has the effect of telling the
75 driver to run the initial read capacity command for LUN 0 of the changer
76 through the changer scheduling code.
77 .El
78 .Sh FILES
79 .Bl -tag -width /sys/bus/cam/scsi/scsi_cd.c -compact
80 .It Pa /sys/bus/cam/scsi/scsi_cd.c
81 is the driver source file.
82 .El
83 .Sh SEE ALSO
84 .Xr cd 4 ,
85 .Xr scsi 4
86 .Sh HISTORY
87 The
88 .Nm
89 manual page first appeared in
90 .Fx 2.2 .
91 .Sh AUTHORS
92 .An -nosplit
93 This
94 manual page was written by
95 .An John-Mark Gurney Aq Mt gurney_j@efn.org .
96 It was updated for CAM and
97 .Fx 3.0
98 by
99 .An Kenneth Merry Aq Mt ken@FreeBSD.org .