share/man/man4/cd.4

   1 .\" Copyright (c) 1996
   2 .\"     Julian Elischer <julian@FreeBSD.org>.  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 .\"
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd February 8, 2012
  29 .Dt CD 4
  30 .Os
  31 .Sh NAME
  32 .Nm cd
  33 .Nd SCSI CD-ROM driver
  34 .Sh SYNOPSIS
  35 .Cd device cd
  36 .Cd "options ""CHANGER_MIN_BUSY_SECONDS=3"""
  37 .Cd "options ""CHANGER_MAX_BUSY_SECONDS=11"""
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver provides support for a
  42 .Tn SCSI
  43 .Tn CD-ROM
  44 (Compact Disc-Read Only Memory) drive.
  45 In an attempt to look like a regular disk, the
  46 .Nm
  47 driver synthesizes a partition table, with one partition covering the entire
  48 .Tn CD-ROM .
  49 It is possible to modify this partition table using
  50 .Xr disklabel 8 ,
  51 but it will only last until the
  52 .Tn CD-ROM
  53 is unmounted.
  54 In general the interfaces are similar to those described by
  55 .Xr ada 4
  56 and
  57 .Xr da 4 .
  58 .Pp
  59 As the
  60 .Tn SCSI
  61 adapter is probed during boot, the
  62 .Tn SCSI
  63 bus is scanned for devices.
  64 Any devices found which answer as CDROM
  65 (type 5) or WORM (type 4) type devices will be `attached' to the
  66 .Nm
  67 driver.
  68 Prior to
  69 .Fx 2.1 ,
  70 the first device found will be attached as
  71 .Li cd0
  72 the next,
  73 .Li cd1 ,
  74 etc.
  75 Beginning in
  76 .Fx 2.1
  77 it is possible to specify what cd unit a device should
  78 come on line as; refer to
  79 .Xr scsi 4
  80 for details on kernel configuration.
  81 .Pp
  82 The system utility
  83 .Xr disklabel 8
  84 may be used to read the synthesized
  85 disk label
  86 structure, which will contain correct figures for the size of the
  87 .Tn CD-ROM
  88 should that information be required.
  89 .Sh KERNEL CONFIGURATION
  90 Any number of
  91 .Tn CD-ROM
  92 devices may be attached to the system regardless of system
  93 configuration as all resources are dynamically allocated.
  94 .Sh IOCTLS
  95 The following
  96 .Xr ioctl 2
  97 calls which apply to
  98 .Tn SCSI
  99 .Tn CD-ROM
 100 drives are defined
 101 in the header files
 102 .In sys/cdio.h
 103 and
 104 .In sys/disklabel.h .
 105 .Bl -tag -width CDIOCREADSUBCHANNEL
 106 .It Dv DIOCGDINFO
 107 .It Dv DIOCSDINFO
 108 .Pq Li "struct disklabel"
 109 Read or write the in-core copy of the disklabel for the
 110 drive.
 111 The disklabel is initialized with information
 112 read from the scsi inquiry commands, and should be the same as
 113 the information printed at boot.
 114 This structure is defined in the header file
 115 .In sys/disklabel.h .
 116 .It Dv CDIOCPLAYTRACKS
 117 .Pq Li "struct ioc_play_track"
 118 Start audio playback given a track address and length.
 119 The structure is defined as follows:
 120 .Bd -literal -offset indent
 121 struct ioc_play_track
 122 {
 123         u_char  start_track;
 124         u_char  start_index;
 125         u_char  end_track;
 126         u_char  end_index;
 127 };
 128 .Ed
 129 .It Dv CDIOCPLAYBLOCKS
 130 .Pq Li "struct ioc_play_blocks"
 131 Start audio playback given a block address and length.
 132 The structure is defined as follows:
 133 .Bd -literal -offset indent
 134 struct ioc_play_blocks
 135 {
 136         int     blk;
 137         int     len;
 138 };
 139 .Ed
 140 .It Dv CDIOCPLAYMSF
 141 .Pq Li "struct ioc_play_msf"
 142 Start audio playback given a `minutes-seconds-frames' address and
 143 length.
 144 The structure is defined as follows:
 145 .Bd -literal -offset indent
 146 struct ioc_play_msf
 147 {
 148         u_char  start_m;
 149         u_char  start_s;
 150         u_char  start_f;
 151         u_char  end_m;
 152         u_char  end_s;
 153         u_char  end_f;
 154 };
 155 .Ed
 156 .It Dv CDIOCREADSUBCHANNEL
 157 .Pq Li "struct ioc_read_subchannel"
 158 Read information from the subchannel at the location specified by this
 159 structure:
 160 .Bd -literal -offset indent
 161 struct ioc_read_subchannel {
 162         u_char address_format;
 163 #define CD_LBA_FORMAT   1
 164 #define CD_MSF_FORMAT   2
 165         u_char data_format;
 166 #define CD_SUBQ_DATA            0
 167 #define CD_CURRENT_POSITION     1
 168 #define CD_MEDIA_CATALOG        2
 169 #define CD_TRACK_INFO           3
 170         u_char track;
 171         int     data_len;
 172         struct  cd_sub_channel_info *data;
 173 };
 174 .Ed
 175 .It Dv CDIOREADTOCHEADER
 176 .Pq Li "struct ioc_toc_header"
 177 Return summary information about the table of contents for the mounted
 178 .Tn CD-ROM .
 179 The information is returned into the following structure:
 180 .Bd -literal -offset indent
 181 struct ioc_toc_header {
 182         u_short len;
 183         u_char  starting_track;
 184         u_char  ending_track;
 185 };
 186 .Ed
 187 .It Dv CDIOREADTOCENTRYS
 188 .Pq Li "struct ioc_read_toc_entry"
 189 Return information from the table of contents entries mentioned.
 190 .Pq Yes, this command name is misspelled.
 191 The argument structure is defined as follows:
 192 .Bd -literal -offset indent
 193 struct ioc_read_toc_entry {
 194         u_char  address_format;
 195         u_char  starting_track;
 196         u_short data_len;
 197         struct  cd_toc_entry *data;
 198 };
 199 .Ed
 200 The requested data is written into an area of size
 201 .Li data_len
 202 and pointed to by
 203 .Li data .
 204 .It Dv CDIOCSETPATCH
 205 .Pq Li "struct ioc_patch"
 206 Attach various audio channels to various output channels.
 207 The argument structure is defined thusly:
 208 .Bd -literal -offset indent
 209 struct ioc_patch {
 210         u_char  patch[4];
 211         /* one for each channel */
 212 };
 213 .Ed
 214 .It Dv CDIOCGETVOL
 215 .It Dv CDIOCSETVOL
 216 .Pq Li "struct ioc_vol"
 217 Get (set) information about the volume settings of the output channels.
 218 The argument structure is as follows:
 219 .Bd -literal -offset indent
 220 struct  ioc_vol
 221 {
 222         u_char  vol[4];
 223         /* one for each channel */
 224 };
 225 .Ed
 226 .It Dv CDIOCSETMONO
 227 Patch all output channels to all source channels.
 228 .It Dv CDIOCSETSTEREO
 229 Patch left source channel to the left output channel and the right
 230 source channel to the right output channel.
 231 .It Dv CDIOCSETMUTE
 232 Mute output without changing the volume settings.
 233 .It Dv CDIOCSETLEFT
 234 .It Dv CDIOCSETRIGHT
 235 Attach both output channels to the left (right) source channel.
 236 .It Dv CDIOCSETDEBUG
 237 .It Dv CDIOCCLRDEBUG
 238 Turn on (off) debugging for the appropriate device.
 239 .It Dv CDIOCPAUSE
 240 .It Dv CDIOCRESUME
 241 Pause (resume) audio play, without resetting the location of the read-head.
 242 .It Dv CDIOCRESET
 243 Reset the drive.
 244 .It Dv CDIOCSTART
 245 .It Dv CDIOCSTOP
 246 Tell the drive to spin-up (-down) the
 247 .Tn CD-ROM .
 248 .It Dv CDIOCALLOW
 249 .It Dv CDIOCPREVENT
 250 Tell the drive to allow (prevent) manual ejection of the
 251 .Tn CD-ROM
 252 disc.
 253 Not all drives support this feature.
 254 .It Dv CDIOCEJECT
 255 Eject the
 256 .Tn CD-ROM .
 257 .It Dv CDIOCCLOSE
 258 Tell the drive to close its door and load the media.
 259 Not all drives support this feature.
 260 .El
 261 .Sh NOTES
 262 When a
 263 .Tn CD-ROM
 264 is changed in a drive controlled by the
 265 .Nm
 266 driver, then the act of changing the media will invalidate the
 267 disklabel and information held within the kernel.
 268 To stop corruption,
 269 all accesses to the device will be discarded until there are no more
 270 open file descriptors referencing the device.
 271 During this period, all
 272 new open attempts will be rejected.
 273 When no more open file descriptors
 274 reference the device, the first next open will load a new set of
 275 parameters (including disklabel) for the drive.
 276 .Pp
 277 The audio code in the
 278 .Nm
 279 driver only support
 280 .Tn SCSI-2
 281 standard audio commands.
 282 As many
 283 .Tn CD-ROM
 284 manufacturers have not followed the standard, there are many
 285 .Tn CD-ROM
 286 drives for which audio will not work.
 287 Some work is planned to support
 288 some of the more common `broken'
 289 .Tn CD-ROM
 290 drives; however, this is not yet under way.
 291 .Sh CHANGER OPERATION
 292 This driver has built-in support for LUN-based CD changers.
 293 A LUN-based CD
 294 changer is a drive that can hold two or more CDs, but only has one CD
 295 player mechanism.
 296 Each CD in the drive shows up as a separate logical unit
 297 on the
 298 .Tn SCSI
 299 bus.
 300 The
 301 .Nm
 302 driver automatically recognizes LUN-based changers, and routes commands for
 303 changers through an internal scheduler.
 304 The scheduler prevents changer
 305 "thrashing", which is caused by sending commands to different LUNs in the
 306 changer at the same time.
 307 .Pp
 308 The scheduler honors minimum and maximum time
 309 quanta that the driver will spend on a particular LUN.
 310 The minimum time
 311 is the guaranteed minimum amount of time that the driver will spend on a
 312 given LUN, even if there is no outstanding I/O for that LUN.
 313 The maximum
 314 time is the maximum amount of time the changer will spend on a LUN if there
 315 is outstanding I/O for another LUN.
 316 If there is no outstanding I/O for
 317 another LUN, the driver will allow indefinite access to a given LUN.
 318 .Pp
 319 The minimum and maximum time quanta are configurable via kernel options and
 320 also via sysctl and kernel tunable variables.
 321 The kernel options are:
 322 .Pp
 323 .Bl -item -compact
 324 .It
 325 .Cd "options ""CHANGER_MIN_BUSY_SECONDS=3"""
 326 .It
 327 .Cd "options ""CHANGER_MAX_BUSY_SECONDS=11"""
 328 .El
 329 .Pp
 330 The sysctl/kernel tunable variables are:
 331 .Pp
 332 .Bl -item -compact
 333 .It
 334 .Va kern.cam.cd.changer.min_busy_seconds
 335 .It
 336 .Va kern.cam.cd.changer.max_busy_seconds
 337 .El
 338 .Pp
 339 It is suggested that the user try experimenting with the minimum and
 340 maximum timeouts via the sysctl variables to arrive at the proper values
 341 for your changer.
 342 Once you have settled on the proper timeouts for your
 343 changer, you can then put them in your kernel config file.
 344 .Pp
 345 If your system does have a LUN-based changer, you may notice that the
 346 probe messages for the various LUNs of the changer will continue to appear
 347 while the boot process is going on.
 348 This is normal, and is caused by the
 349 changer scheduling code.
 350 .Sh SYSCTL VARIABLES
 351 The following variables are available as both
 352 .Xr sysctl 8
 353 variables and
 354 .Xr loader 8
 355 tunables:
 356 .Bl -tag -width 12
 357 .It kern.cam.cd.retry_count
 358 .Pp
 359 This variable determines how many times the
 360 .Nm
 361 driver will retry a READ or WRITE command.
 362 This does not affect the number of retries used during probe time or for
 363 the
 364 .Nm
 365 driver dump routine.
 366 This value currently defaults to 4.
 367 .It kern.cam.cd.%d.minimum_cmd_size
 368 .Pp
 369 The
 370 .Nm
 371 driver attempts to automatically determine whether the drive it is talking
 372 to supports 6 byte or 10 byte MODE SENSE/MODE SELECT operations.
 373 Many
 374 .Tn SCSI
 375 drives only support 6 byte commands, and
 376 .Tn ATAPI
 377 drives only support 10 byte commands.
 378 The
 379 .Nm
 380 driver first attempts to determine whether the protocol in use typically
 381 supports 6 byte commands by issuing a CAM Path Inquiry CCB.
 382 It will then default to 6 byte or 10 byte commands as appropriate.
 383 After that, the
 384 .Nm
 385 driver defaults to using 6 byte commands (assuming the protocol the drive
 386 speaks claims to support 6 byte commands), until one fails with a
 387 .Tn SCSI
 388 ILLEGAL REQUEST error.
 389 Then it tries the 10 byte version of the command to
 390 see if that works instead.
 391 Users can change the default via per-drive
 392 sysctl variables and loader tunables.
 393 Where
 394 .Dq %d
 395 is the unit number of the drive in question.
 396 Valid minimum command sizes
 397 are 6 and 10.
 398 Any value above 6 will be rounded to 10, and any value below
 399 6 will be rounded to 6.
 400 .It kern.cam.cd.changer.min_busy_seconds
 401 .It kern.cam.cd.changer.max_busy_seconds
 402 .Pp
 403 Tune how long individual LUNs are 'locked' for I/O operations to
 404 optimize changer operation.
 405 See CHANGER OPERATION section for information on how to use these items.
 406 .El
 407 .Sh FILES
 408 .Bl -tag -width /dev/cd[0-9][a-h] -compact
 409 .It Pa /dev/cd[0-9][a-h]
 410 raw mode
 411 .Tn CD-ROM
 412 devices
 413 .El
 414 .Sh DIAGNOSTICS
 415 None.
 416 .Sh SEE ALSO
 417 .Xr cam 4 ,
 418 .Xr da 4 ,
 419 .Xr disklabel 8 ,
 420 .Xr cd 9
 421 .Sh HISTORY
 422 This
 423 .Nm
 424 driver is based upon the
 425 .Nm
 426 driver written by Julian Elischer, which appeared in
 427 .Bx 386 0.1 .
 428 The
 429 CAM version of the
 430 .Nm
 431 driver was written by Kenneth Merry and first appeared in
 432 .Fx 3.0 .
 433 .Sh BUGS
 434 The names of the structures used for the third argument to
 435 .Fn ioctl
 436 were poorly chosen, and a number of spelling errors have survived in
 437 the names of the
 438 .Fn ioctl
 439 commands.
 440 .Pp
 441 There is no mechanism currently to set different minimum and maximum
 442 timeouts for different CD changers; the timeout values set by the kernel
 443 options or the sysctl variables apply to all LUN-based CD changers in the
 444 system.
 445 It is possible to implement such support, but the sysctl
 446 implementation at least would be rather inelegant, because of the current
 447 inability of the sysctl code to handle the addition of nodes after compile
 448 time.
 449 Thus, it would take one dynamically sized sysctl variable and a
 450 userland utility to get/set the timeout values.
 451 Implementation of separate
 452 timeouts for different CD devices in the kernel config file would likely
 453 require modification of
 454 .Xr config 8
 455 to support the two timeouts when hardwiring
 456 .Nm
 457 devices.