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