2 .\" Julian Elischer <julian@FreeBSD.org>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
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.
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
33 .Nd SCSI CD-ROM driver
39 driver provides support for a
42 (Compact Disc-Read Only Memory) drive.
43 In an attempt to look like a regular disk, the
45 driver synthesizes a partition table, with one partition covering the entire
47 It is possible to modify this partition table using
49 but it will only last until the
52 In general the interfaces are similar to those described by
59 adapter is probed during boot, the
61 bus is scanned for devices.
62 Any devices found which answer as CDROM
63 (type 5) or WORM (type 4) type devices will be `attached' to the
68 the first device found will be attached as
75 it is possible to specify what cd unit a device should
76 come on line as; refer to
78 for details on kernel configuration.
82 may be used to read the synthesized
84 structure, which will contain correct figures for the size of the
86 should that information be required.
87 .Sh KERNEL CONFIGURATION
90 devices may be attached to the system regardless of system
91 configuration as all resources are dynamically allocated.
102 .In sys/disklabel.h .
103 .Bl -tag -width CDIOCREADSUBCHANNEL
104 .It Dv CDIOCPLAYTRACKS
105 .Pq Li "struct ioc_play_track"
106 Start audio playback given a track address and length.
107 The structure is defined as follows:
108 .Bd -literal -offset indent
109 struct ioc_play_track
117 .It Dv CDIOCPLAYBLOCKS
118 .Pq Li "struct ioc_play_blocks"
119 Start audio playback given a block address and length.
120 The structure is defined as follows:
121 .Bd -literal -offset indent
122 struct ioc_play_blocks
129 .Pq Li "struct ioc_play_msf"
130 Start audio playback given a `minutes-seconds-frames' address and
132 The structure is defined as follows:
133 .Bd -literal -offset indent
144 .It Dv CDIOCREADSUBCHANNEL
145 .Pq Li "struct ioc_read_subchannel"
146 Read information from the subchannel at the location specified by this
148 .Bd -literal -offset indent
149 struct ioc_read_subchannel {
150 u_char address_format;
151 #define CD_LBA_FORMAT 1
152 #define CD_MSF_FORMAT 2
154 #define CD_SUBQ_DATA 0
155 #define CD_CURRENT_POSITION 1
156 #define CD_MEDIA_CATALOG 2
157 #define CD_TRACK_INFO 3
160 struct cd_sub_channel_info *data;
163 .It Dv CDIOREADTOCHEADER
164 .Pq Li "struct ioc_toc_header"
165 Return summary information about the table of contents for the mounted
167 The information is returned into the following structure:
168 .Bd -literal -offset indent
169 struct ioc_toc_header {
171 u_char starting_track;
175 .It Dv CDIOREADTOCENTRYS
176 .Pq Li "struct ioc_read_toc_entry"
177 Return information from the table of contents entries mentioned.
178 .Pq Yes, this command name is misspelled.
179 The argument structure is defined as follows:
180 .Bd -literal -offset indent
181 struct ioc_read_toc_entry {
182 u_char address_format;
183 u_char starting_track;
185 struct cd_toc_entry *data;
188 The requested data is written into an area of size
193 .Pq Li "struct ioc_patch"
194 Attach various audio channels to various output channels.
195 The argument structure is defined thusly:
196 .Bd -literal -offset indent
199 /* one for each channel */
204 .Pq Li "struct ioc_vol"
205 Get (set) information about the volume settings of the output channels.
206 The argument structure is as follows:
207 .Bd -literal -offset indent
211 /* one for each channel */
215 Patch all output channels to all source channels.
216 .It Dv CDIOCSETSTEREO
217 Patch left source channel to the left output channel and the right
218 source channel to the right output channel.
220 Mute output without changing the volume settings.
223 Attach both output channels to the left (right) source channel.
226 Turn on (off) debugging for the appropriate device.
229 Pause (resume) audio play, without resetting the location of the read-head.
234 Tell the drive to spin-up (-down) the
238 Tell the drive to allow (prevent) manual ejection of the
241 Not all drives support this feature.
246 Tell the drive to close its door and load the media.
247 Not all drives support this feature.
252 is changed in a drive controlled by the
254 driver, then the act of changing the media will invalidate the
255 disklabel and information held within the kernel.
257 all accesses to the device will be discarded until there are no more
258 open file descriptors referencing the device.
259 During this period, all
260 new open attempts will be rejected.
261 When no more open file descriptors
262 reference the device, the first next open will load a new set of
263 parameters (including disklabel) for the drive.
265 The audio code in the
269 standard audio commands.
272 manufacturers have not followed the standard, there are many
274 drives for which audio will not work.
275 Some work is planned to support
276 some of the more common `broken'
278 drives; however, this is not yet under way.
280 The following variables are available as both
286 .It kern.cam.cd.retry_count
288 This variable determines how many times the
290 driver will retry a READ or WRITE command.
291 This does not affect the number of retries used during probe time or for
295 This value currently defaults to 4.
296 .It kern.cam.cd.%d.minimum_cmd_size
300 driver attempts to automatically determine whether the drive it is talking
301 to supports 6 byte or 10 byte MODE SENSE/MODE SELECT operations.
304 drives only support 6 byte commands, and
306 drives only support 10 byte commands.
309 driver first attempts to determine whether the protocol in use typically
310 supports 6 byte commands by issuing a CAM Path Inquiry CCB.
311 It will then default to 6 byte or 10 byte commands as appropriate.
314 driver defaults to using 6 byte commands (assuming the protocol the drive
315 speaks claims to support 6 byte commands), until one fails with a
317 ILLEGAL REQUEST error.
318 Then it tries the 10 byte version of the command to
319 see if that works instead.
320 Users can change the default via per-drive
321 sysctl variables and loader tunables.
324 is the unit number of the drive in question.
325 Valid minimum command sizes
327 Any value above 6 will be rounded to 10, and any value below
328 6 will be rounded to 6.
331 .Bl -tag -width /dev/cd[0-9][a-h] -compact
332 .It Pa /dev/cd[0-9][a-h]
347 driver is based upon the
349 driver written by Julian Elischer, which appeared in
354 driver was written by Kenneth Merry and first appeared in
357 The names of the structures used for the third argument to
359 were poorly chosen, and a number of spelling errors have survived in