share/man/man4/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 without 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$
  28 .\"
  29 .Dd December 8, 1994
  30 .Dt MCD 4
  31 .Os
  32 .Sh NAME
  33 .Nm mcd
  34 .Nd Mitsumi CD-ROM driver
  35 .Sh SYNOPSIS
  36 .Cd "device mcd"
  37 .Pp
  38 In
  39 .Pa /boot/device.hints :
  40 .Cd hint.mcd.0.at="isa"
  41 .Cd hint.mcd.0.port="0x300"
  42 .Cd hint.mcd.0.irq="10"
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 driver provides a data and audio interface to the Mitsumi-brand CD-ROM
  47 player.
  48 The CD-ROM player must be interfaced to the ISA bus through
  49 one of the Mitsumi proprietary controller boards.
  50 The controller
  51 boards supported are the LU002S, LU005S, the FX001 and the quite
  52 common FX001D.
  53 .Pp
  54 The
  55 .Nm
  56 driver responds to disk-specific
  57 .Fn ioctl
  58 commands, namely the
  59 .Dv DIOCGDINFO ,
  60 .Dv DIOCGPART ,
  61 .Dv DIOCWDINFO ,
  62 and
  63 .Dv DIOCSDINFO ,
  64 commands.
  65 Other disk-specific
  66 .Fn ioctl
  67 commands will return an error.
  68 .Pp
  69 The
  70 .Nm
  71 driver also responds to special CD-ROM
  72 .Fn ioctl
  73 commands.
  74 These commands
  75 control the CD-ROM player's audio features.
  76 The commands are:
  77 .Pp
  78 .Bl -tag -width CDIOCREADSUBCHANNEL -compact -offset indent
  79 .It CDIOCREADSUBCHANNEL
  80 get sub-channel information on current status of disc playing
  81 .It CDIOCREADTOCHEADER
  82 get table of contents header
  83 .It CDIOCREADTOCENTRYS
  84 gets all of the table of contents
  85 .It CDIOCPLAYTRACKS
  86 begins audio playing at location specified
  87 .It CDIOCPLAYBLOCKS
  88 fails with error
  89 .Er EINVAL
  90 .It CDIOCPLAYMSF
  91 begins audio playing at location specified
  92 .It CDIOCRESUME
  93 resumes playing a previously paused disc
  94 .It CDIOCPAUSE
  95 pauses a playing disc
  96 .It CDIOCSTART
  97 begins playing a disc
  98 .It CDIOCSTOP
  99 stops a previously playing disc
 100 .It CDIOCEJECT
 101 opens the disc tray (there is no support for a corresponding un-eject
 102 command).
 103 .It CDIOCRESET
 104 stops any play and resets the Mitsumi controller board
 105 .It CDIOCSETDEBUG
 106 cause the kernel to print debug messages to the console about the
 107 .Nm
 108 driver
 109 .It CDIOCCLRDEBUG
 110 cause the kernel to quit printing debug messages about the
 111 .Nm
 112 driver
 113 .El
 114 .Pp
 115 The
 116 .Fn ioctl
 117 commands defined above are the only ones that the
 118 .Nm
 119 driver supports.
 120 There are other CD-ROM related
 121 .Fn ioctl
 122 commands (such as
 123 .Dv CDIOCSETVOL
 124 and
 125 .Dv CDIOCSETSTERIO )
 126 which are available
 127 and may be supported by future versions of the driver.
 128 .Sh FILES
 129 .Bl -tag -width /dev/(r)mcd0a -compact
 130 .It Pa /dev/(r)mcd0a
 131 accesses
 132 .Bx
 133 partition on the disc.
 134 Normally, there is only
 135 one file system on a CD-ROM disc.
 136 .It Pa /dev/(r)mcd0c
 137 accesses raw device.
 138 .El
 139 .Sh NOTES
 140 The character-mode devices for the
 141 .Nm
 142 driver should only be used for accessing the audio features of the
 143 CD-ROM player as the performance on data is abysmal.
 144 .Pp
 145 The current version of the driver uses neither the DMA or IRQ
 146 features of the interface board, although it has an interrupt handler
 147 for any IRQ requests that are generated.
 148 Until the DMA features are
 149 supported, the only interrupts that the board generates are those that
 150 are not supported by the driver anyway.
 151 .Sh SEE ALSO
 152 .In sys/cdio.h
 153 .Sh HISTORY
 154 An
 155 .Nm
 156 driver appeared in
 157 .Fx 1.0 .
 158 .Sh AUTHORS
 159 .An -nosplit
 160 The driver was written by
 161 .An Holger Veit
 162 (data part) and
 163 .An Brian Moore
 164 (audio part).
 165 Changes were provided by
 166 .An Gary Clark II ,
 167 .An Andrew A. Chernov ,
 168 and
 169 .An Jordan K. Hubbard .