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