freebsd-skq/share/man/man9/cd.9

.\" Copyright (c) 1997
.\"	John-Mark Gurney.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the author nor the names of any co-contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY John-Mark Gurney AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd October 10, 1998
.Dt CD 9
.Os
.Sh NAME
.Nm cd
.Nd CDROM driver for the CAM SCSI subsystem
.Sh DESCRIPTION
The
.Nm
device driver provides a read only interface for CDROM drives
.Tn ( SCSI
type 5)
and WORM drives
.Tn ( SCSI
type 4)
that support CDROM type commands.
Some drives don't behave as the driver expects.  See the section
QUIRKS for info on possible flags.
.Sh QUIRKS
Each
.Tn CD-ROM
device can have different interpretations of the
.Tn SCSI
spec.  This can lead to drives requiring special handling in the driver.  The
following is a list of quirks that the driver recognize.
.Bl -tag -width CD_Q_BCD_TRACKS
.It Dv CD_Q_NO_TOUCH
This flag tell the driver not to probe the drive at attach time to see if
there is a disk in the drive and find out what size it is.  This flag is
currently unimplemented in the CAM
.Nm
driver.
.It Dv CD_Q_BCD_TRACKS
This flag is for broken drives that return the track numbers in packed BCD
instead of straight decimal.  If the drive seems to skip tracks
(tracks 10-15 are skipped)
then you have a drive that is in need of this flag.
.It Dv CD_Q_NO_CHANGER
This flag tells the driver that the device in question is not a changer.
This is only necessary for a CDROM device with multiple luns that are not a
part of a changer.
.It Dv CD_Q_CHANGER
This flag tells the driver that the given device is a multi-lun changer.
In general, the driver will figure this out automatically when it sees a
LUN greater than 0.  Setting this flag only has the effect of telling the
driver to run the initial read capacity command for LUN 0 of the changer
through the changer scheduling code.
.El
.Sh FILES
.Bl -tag -width /sys/cam/scsi/scsi_cd.c -compact
.It Pa /sys/cam/scsi/scsi_cd.c
is the driver source file.
.El
.Sh SEE ALSO
.Xr cd 4 ,
.Xr scsi 4
.Sh HISTORY
The
.Nm
manual page first appeared in
.Fx 2.2 .
.Sh AUTHORS
.An -nosplit
This
manual page was written by
.An John-Mark Gurney Aq gurney_j@efn.org .
It was updated for CAM and
.Fx 3.0
by
.An Kenneth Merry Aq ken@FreeBSD.org .
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`.\" Copyright (c) 1997`
			`.\" John-Mark Gurney. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. Neither the name of the author nor the names of any co-contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY John-Mark Gurney AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`.\"`
Update the cd(9) man page for the CAM cd driver. This really just an update of the quirk entry descriptions to reflect the current state of things. Once I find out where such things belong, I'll document things like the changer scheduling mechanism, actions taken at probe, etc. 1998-10-12 04:09:49 +00:00			`.Dd October 10, 1998`
Correct section number in the .DT line. Pointed out by: bde 1997-02-23 18:00:03 +00:00			`.Dt CD 9`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`.Sh NAME`
			`.Nm cd`
Update the cd(9) man page for the CAM cd driver. This really just an update of the quirk entry descriptions to reflect the current state of things. Once I find out where such things belong, I'll document things like the changer scheduling mechanism, actions taken at probe, etc. 1998-10-12 04:09:49 +00:00			`.Nd CDROM driver for the CAM SCSI subsystem`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`.Sh DESCRIPTION`
Typo police. 1997-02-09 21:08:52 +00:00			`The`
			`.Nm`
mdoc(7) police: join split punctuation to macro calls. 2001-08-10 17:35:21 +00:00			`device driver provides a read only interface for CDROM drives`
			`.Tn ( SCSI`
Update the cd(9) man page for the CAM cd driver. This really just an update of the quirk entry descriptions to reflect the current state of things. Once I find out where such things belong, I'll document things like the changer scheduling mechanism, actions taken at probe, etc. 1998-10-12 04:09:49 +00:00			`type 5)`
mdoc(7) police: join split punctuation to macro calls. 2001-08-10 17:35:21 +00:00			`and WORM drives`
			`.Tn ( SCSI`
Update the cd(9) man page for the CAM cd driver. This really just an update of the quirk entry descriptions to reflect the current state of things. Once I find out where such things belong, I'll document things like the changer scheduling mechanism, actions taken at probe, etc. 1998-10-12 04:09:49 +00:00			`type 4)`
			`that support CDROM type commands.`
			`Some drives don't behave as the driver expects. See the section`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`QUIRKS for info on possible flags.`
			`.Sh QUIRKS`
			`Each`
			`.Tn CD-ROM`
			`device can have different interpretations of the`
			`.Tn SCSI`
			`spec. This can lead to drives requiring special handling in the driver. The`
Removed 2 lines from the cd(9) manual page. PR: 35944 2002-04-15 06:02:58 +00:00			`following is a list of quirks that the driver recognize.`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`.Bl -tag -width CD_Q_BCD_TRACKS`
			`.It Dv CD_Q_NO_TOUCH`
			`This flag tell the driver not to probe the drive at attach time to see if`
Update the cd(9) man page for the CAM cd driver. This really just an update of the quirk entry descriptions to reflect the current state of things. Once I find out where such things belong, I'll document things like the changer scheduling mechanism, actions taken at probe, etc. 1998-10-12 04:09:49 +00:00			`there is a disk in the drive and find out what size it is. This flag is`
			`currently unimplemented in the CAM`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Update the cd(9) man page for the CAM cd driver. This really just an update of the quirk entry descriptions to reflect the current state of things. Once I find out where such things belong, I'll document things like the changer scheduling mechanism, actions taken at probe, etc. 1998-10-12 04:09:49 +00:00			`driver.`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`.It Dv CD_Q_BCD_TRACKS`
			`This flag is for broken drives that return the track numbers in packed BCD`
uncomment CD_Q_BCD_TRACKS flag, add xref to scsi(4) 1997-04-02 09:41:16 +00:00			`instead of straight decimal. If the drive seems to skip tracks`
mdoc(7) police: Avoid using parenthesis enclosure macros (.Pq and .Po/.Pc) with plain text. Not only this slows down the mdoc(7) processing significantly, but it also has an undesired (in this case) effect of disabling hyphenation within the entire enclosed block. 2001-08-07 15:48:51 +00:00			`(tracks 10-15 are skipped)`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`then you have a drive that is in need of this flag.`
Update the cd(9) man page for the CAM cd driver. This really just an update of the quirk entry descriptions to reflect the current state of things. Once I find out where such things belong, I'll document things like the changer scheduling mechanism, actions taken at probe, etc. 1998-10-12 04:09:49 +00:00			`.It Dv CD_Q_NO_CHANGER`
			`This flag tells the driver that the device in question is not a changer.`
			`This is only necessary for a CDROM device with multiple luns that are not a`
			`part of a changer.`
			`.It Dv CD_Q_CHANGER`
			`This flag tells the driver that the given device is a multi-lun changer.`
			`In general, the driver will figure this out automatically when it sees a`
			`LUN greater than 0. Setting this flag only has the effect of telling the`
			`driver to run the initial read capacity command for LUN 0 of the changer`
			`through the changer scheduling code.`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`.El`
			`.Sh FILES`
Update the cd(9) man page for the CAM cd driver. This really just an update of the quirk entry descriptions to reflect the current state of things. Once I find out where such things belong, I'll document things like the changer scheduling mechanism, actions taken at probe, etc. 1998-10-12 04:09:49 +00:00			`.Bl -tag -width /sys/cam/scsi/scsi_cd.c -compact`
			`.It Pa /sys/cam/scsi/scsi_cd.c`
			`is the driver source file.`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr cd 4 ,`
Change the worm(4) man page to note that there is no longer a worm(4) driver, and point users in the right direction for similar functionality. The functionality that used to be provided there is now provided by the cd(4) driver and cdrecord. Fix cross-references in a few other man pages. (i.e. delete references to things I haven't written yet) 1998-10-16 00:26:28 +00:00			`.Xr scsi 4`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`manual page first appeared in`
These man pages will first appear in FreeBSD 2.2, not 3.0. 1997-02-17 15:22:20 +00:00			`.Fx 2.2 .`
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq. 1998-03-12 07:31:21 +00:00			`.Sh AUTHORS`
mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00			`.An -nosplit`
Various man pages describing the internals of the SCSI subsystem. Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu> 1997-02-09 20:29:15 +00:00			`This`
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq. 1998-03-12 07:31:21 +00:00			`manual page was written by`
			`.An John-Mark Gurney Aq gurney_j@efn.org .`
Update the cd(9) man page for the CAM cd driver. This really just an update of the quirk entry descriptions to reflect the current state of things. Once I find out where such things belong, I'll document things like the changer scheduling mechanism, actions taken at probe, etc. 1998-10-12 04:09:49 +00:00			`It was updated for CAM and`
			`.Fx 3.0`
			`by`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.An Kenneth Merry Aq ken@FreeBSD.org .`