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 DIOCGPART
  60 command.
  61 Other disk-specific
  62 .Fn ioctl
  63 commands will return an error.
  64 .Pp
  65 The
  66 .Nm
  67 driver also responds to special CD-ROM
  68 .Fn ioctl
  69 commands.
  70 These commands
  71 control the CD-ROM player's audio features.
  72 The commands are:
  73 .Pp
  74 .Bl -tag -width CDIOCREADSUBCHANNEL -compact -offset indent
  75 .It CDIOCREADSUBCHANNEL
  76 get sub-channel information on current status of disc playing
  77 .It CDIOCREADTOCHEADER
  78 get table of contents header
  79 .It CDIOCREADTOCENTRYS
  80 gets all of the table of contents
  81 .It CDIOCPLAYTRACKS
  82 begins audio playing at location specified
  83 .It CDIOCPLAYBLOCKS
  84 fails with error
  85 .Er EINVAL
  86 .It CDIOCPLAYMSF
  87 begins audio playing at location specified
  88 .It CDIOCRESUME
  89 resumes playing a previously paused disc
  90 .It CDIOCPAUSE
  91 pauses a playing disc
  92 .It CDIOCSTART
  93 begins playing a disc
  94 .It CDIOCSTOP
  95 stops a previously playing disc
  96 .It CDIOCEJECT
  97 opens the disc tray (there is no support for a corresponding un-eject
  98 command).
  99 .It CDIOCRESET
 100 stops any play and resets the Mitsumi controller board
 101 .It CDIOCSETDEBUG
 102 cause the kernel to print debug messages to the console about the
 103 .Nm
 104 driver
 105 .It CDIOCCLRDEBUG
 106 cause the kernel to quit printing debug messages about the
 107 .Nm
 108 driver
 109 .El
 110 .Pp
 111 The
 112 .Fn ioctl
 113 commands defined above are the only ones that the
 114 .Nm
 115 driver supports.
 116 There are other CD-ROM related
 117 .Fn ioctl
 118 commands (such as
 119 .Dv CDIOCSETVOL
 120 and
 121 .Dv CDIOCSETSTERIO )
 122 which are available
 123 and may be supported by future versions of the driver.
 124 .Sh FILES
 125 .Bl -tag -width /dev/(r)mcd0a -compact
 126 .It Pa /dev/(r)mcd0a
 127 accesses
 128 .Bx
 129 partition on the disc.
 130 Normally, there is only
 131 one file system on a CD-ROM disc.
 132 .It Pa /dev/(r)mcd0c
 133 accesses raw device.
 134 .El
 135 .Sh NOTES
 136 The character-mode devices for the
 137 .Nm
 138 driver should only be used for accessing the audio features of the
 139 CD-ROM player as the performance on data is abysmal.
 140 .Pp
 141 The current version of the driver uses neither the DMA or IRQ
 142 features of the interface board, although it has an interrupt handler
 143 for any IRQ requests that are generated.
 144 Until the DMA features are
 145 supported, the only interrupts that the board generates are those that
 146 are not supported by the driver anyway.
 147 .Sh SEE ALSO
 148 .In sys/cdio.h
 149 .Sh HISTORY
 150 An
 151 .Nm
 152 driver appeared in
 153 .Fx 1.0 .
 154 .Sh AUTHORS
 155 .An -nosplit
 156 The driver was written by
 157 .An Holger Veit
 158 (data part) and
 159 .An Brian Moore
 160 (audio part).
 161 Changes were provided by
 162 .An Gary Clark II ,
 163 .An Andrew A. Chernov ,
 164 and
 165 .An Jordan K. Hubbard .