Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / share / man / man4 / man4.i386 / mcd.4
1 .\"
2 .\" Copyright (c) 1994 Keith E. Walker
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    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.
13 .\" 3. The name of the author may not be used to endorse or promote products
14 .\"    derived from this software withough specific prior written permission
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: src/share/man/man4/man4.i386/mcd.4,v 1.10.2.3 2001/08/17 13:08:45 ru Exp $
28 .\" $DragonFly: src/share/man/man4/man4.i386/Attic/mcd.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
29 .\"
30 .Dd December 8, 1994
31 .Dt MCD 4 i386
32 .Os
33 .Sh NAME
34 .Nm mcd
35 .Nd Mitsumi CD-ROM driver
36 .Sh SYNOPSIS
37 .Cd "device mcd0 at isa? port 0x300 irq 10"
38 .Sh DESCRIPTION
39 The
40 .Nm
41 driver provides a data and audio interface to the Mitsumi-brand CD-ROM
42 player.
43 The CD-ROM player must be interfaced to the ISA bus through
44 one of the Mitsumi proprietary controller boards.
45 The controller
46 boards supported are the LU002S, LU005S, the FX001 and the quite
47 common FX001D.
48 .Pp
49 The
50 .Nm
51 driver responds to disk-specific
52 .Fn ioctl
53 commands, namely the
54 .Dv DIOCGDINFO ,
55 .Dv DIOCGPART ,
56 .Dv DIOCWDINFO ,
57 and
58 .Dv DIOCSDINFO ,
59 commands.
60 Other disk-specific
61 .Fn ioctl
62 commands will return an error.
63 .Pp
64 The
65 .Nm
66 driver also responds to special CD-ROM
67 .Fn ioctl
68 commands.
69 These commands
70 control the CD-ROM player's audio features.
71 The commands are:
72 .Pp
73 .Bl -tag -width CDIOCREADSUBCHANNEL -compact -offset indent
74 .It CDIOCREADSUBCHANNEL
75 get sub-channel information on current status of disc playing
76 .It CDIOCREADTOCHEADER
77 get table of contents header
78 .It CDIOCREADTOCENTRYS
79 gets all of the table of contents
80 .It CDIOCPLAYTRACKS
81 begins audio playing at location specified
82 .It CDIOCPLAYBLOCKS
83 fails with error
84 .Er EINVAL
85 .It CDIOCPLAYMSF
86 begins audio playing at location specified
87 .It CDIOCRESUME
88 resumes playing a previously paused disc
89 .It CDIOCPAUSE
90 pauses a playing disc
91 .It CDIOCSTART
92 begins playing a disc
93 .It CDIOCSTOP
94 stops a previously playing disc
95 .It CDIOCEJECT
96 opens the disc tray (there is no support for a corresponding un-eject
97 command).
98 .It CDIOCRESET
99 stops any play and resets the Mitsumi controller board
100 .It CDIOCSETDEBUG
101 cause the kernel to print debug messages to the console about the
102 .Nm
103 driver
104 .It CDIOCCLRDEBUG
105 cause the kernel to quit printing debug messages about the
106 .Nm
107 driver
108 .El
109 .Pp
110 The
111 .Fn ioctl
112 commands defined above are the only ones that the
113 .Nm
114 driver supports.
115 There are other CD-ROM related
116 .Fn ioctl
117 commands (such as
118 .Dv CDIOCSETVOL
119 and
120 .Dv CDIOCSETSTERIO )
121 which are available
122 and may be supported by future versions of the driver.
123 .Sh FILES
124 .Bl -tag -width /dev/(r)mcd0a -compact
125 .It Pa /dev/(r)mcd0a
126 accesses
127 .Bx
128 partition on the disc.
129 Normally, there is only
130 one file system on a CD-ROM disc.
131 .It Pa /dev/(r)mcd0c
132 accesses raw device.
133 .El
134 .Sh NOTES
135 The character-mode devices for the
136 .Nm
137 driver should only be used for accessing the audio features of the
138 CD-ROM player as the performance on data is abysmal.
139 .Pp
140 The current version of the driver uses neither the DMA or IRQ
141 features of the interface board, although it has an interrupt handler
142 for any IRQ requests that are generated.
143 Until the DMA features are
144 supported, the only interrupts that the board generates are those that
145 aren't supported by the driver anyway.
146 .Sh SEE ALSO
147 .Pa /usr/include/sys/cdio.h
148 .Sh AUTHORS
149 .An -nosplit
150 The driver was written by
151 .An Holger Veit
152 (data part) and
153 .An Brian Moore
154 (audio part).
155 Changes were provided by
156 .An Gary Clark II ,
157 .An Andrew A. Chernov ,
158 and
159 .An Jordan K. Hubbard .
160 .Sh HISTORY
161 An
162 .Nm
163 driver appeared in
164 .Fx 1.0 .