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.
This commit is contained in:
Kenneth D. Merry 1998-10-12 04:09:49 +00:00
parent 2d8eb2c034
commit e6c744a084
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=40247

View file

@ -25,22 +25,25 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: cd.9,v 1.6 1997/04/02 09:41:16 jmg Exp $
.\" $Id: cd.9,v 1.7 1998/03/12 07:31:16 charnier Exp $
.\"
.Dd February 1, 1997
.Dd October 10, 1998
.Dt CD 9
.Os FreeBSD
.Sh NAME
.Nm cd
.Nd device driver for SCSI subsystem
.Nd CDROM driver for the CAM SCSI subsystem
.Sh DESCRIPTION
The
.Nm
device driver provides the
device driver provides a read only interface for CDROM drives (
.Tn SCSI
subsystem a way to handle type 5
.Pq Dv T_READONLY
media. Some drives don't behave as the driver expects. See the section
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
@ -54,26 +57,35 @@ for more information on how to add quirk entries.
.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.
there is a disk in the drive and find out what size it is. This flag is
currently unimplemented in the CAM
.Nm cd
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
.Pq 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/scsi/scsiconf.h -compact
.It Pa /sys/scsi/cd.c
files contains actual driver code
.It Pa /sys/scsi/scsiconf.h
contains the defines of the
.Dv CD_Q_xxx
quirk flags
.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 ,
.Xr scsiconf 9
.Xr xpt 9
.Sh HISTORY
The
.Nm
@ -83,3 +95,7 @@ manual page first appeared in
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 .