xref: /dragonfly/share/man/man4/snd_emu10kx.4 (revision f02303f9)
1.\"
2.\" Copyright (c) 2003,2006 Yuriy Tsibizov,
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.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $Id: snd_emu10kx.4,v 1.19 2006/06/07 11:18:57 chibis Exp $
27.\" $FreeBSD: src/share/man/man4/snd_emu10kx.4,v 1.4 2006/12/14 16:40:57 mpp Exp $
28.\" $DragonFly: src/share/man/man4/Attic/snd_emu10kx.4,v 1.1 2007/01/04 21:47:00 corecode Exp $
29.\"
30.Dd July 15, 2006
31.Dt SND_EMU10KX 4
32.Os
33.Sh NAME
34.Nm snd_emu10kx
35.Nd Creative SoundBlaster Live! and Audigy sound cards device driver
36.Sh SYNOPSIS
37To compile this driver into the kernel, place the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device pcm"
41.Cd "device snd_emu10kx"
42.Pp
43For additional options:
44.Cd "options EMU10KX_MULTICHANNEL"
45.Cd "options EMU10KX_DEBUG"
46.Ed
47.Pp
48Alternatively, to load the driver as a module at boot time, place the
49following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52snd_emu10kx_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57bridge driver allows the generic audio driver
58.Xr sound 4
59to attach to the Creative sound cards based on EMU10K1, CA0100, CA0101, CA0102
60and CA0108 DSPs.
61.Pp
62The
63.Nm
64sound cards have a PCM part, which is accessible through one to five
65.Xr pcm 4
66devices (see
67.Sx MULTICHANNEL PLAYBACK
68for details), and MPU401-compatible MIDI I/O controller, which is accessible
69through the midi device.
70Wave table synthesizer is not supported.
71.Sh HARDWARE
72The
73.Nm
74driver supports the following sound cards:
75.Pp
76.Bl -bullet -compact
77.It
78Creative Sound Blaster Live!\& (EMU10K1 Chipset).
79Both PCM and MIDI interfaces are available.
80.It
81Creative Sound Blaster Audigy (CA0100 and CA0101 Chipset).
82PCM and two MIDI interfaces available.
83.It
84Creative Sound Blaster Audigy 2 and Creative Sound Blaster Audigy 4 (CA0102
85Chipset).
86PCM support is limited to 48kHz/16 bit stereo (192kHz/24 bit part
87of this chipset is not supported).
88.It
89Creative Sound Blaster Audigy 2 Value (CA0108 Chipset).
90PCM support is limited
91to 48kHz/16 bit stereo (192kHz/24 bit part of this chipset is not supported).
92There is no MIDI support for this card.
93.El
94.Pp
95The
96.Nm
97driver does
98.Em not
99support the following sound cards (although they are named
100similar to some supported ones):
101.Pp
102.Bl -bullet -compact
103.It
104Creative Sound Blaster Live!\& 24-Bit, identified by
105.Fx
106as
107.Qq Li "emu10k1x Soundblaster Live! 5.1" .
108.It
109Creative Sound Blaster Audigy LS / ES, identified by
110.Fx
111as
112.Qq Li "CA0106-DAT Audigy LS" .
113.It
114All other cards with -DAT chipsets.
115.El
116.Sh MULTICHANNEL PLAYBACK
117It is possible to build this driver with multichannel playback capabilities.
118If you enable the
119.Dv EMU10KX_MULTICHANNEL
120option in your kernel configuration (or
121build it as a module) you will get up to five DSP devices, one for each sound
122card output.
123Only
124.Dq FRONT
125output can play and record sound from external
126sources (like line or S/PDIF inputs).
127.Sh OSS MIXER CONTROLS
128These are controls available through the standard OSS programming interface.
129You can use
130.Xr mixer 8
131to change them.
132.Pp
133On EMU10K1-based cards the OSS mixer directly controls the AC97 codec on card.
134On newer cards the OSS mixer controls some parameters of the AC97 codec and
135some DSP-based mixer controls.
136.Bl -inset
137.It Qq vol
138mixer control is overall sound volume.
139.It Qq pcm
140mixer control is PCM playback volume.
141It controls only front output
142volume in multichannel mode and all output volume in single channel mode.
143.It Qq rec
144mixer control acts very different on EMU10K1 and other cards.
145On EMU10K1 cards it controls the AC97 codec recording level.
146On non-EMU10K1 cards
147it controls the amount of AC97 "stereo mix" entering the DSP.
148AC97 recording level and AC97 recording source are fixed
149on CA0100, CA0101, CA0102 and CA0108 cards.
150AC97 recording level are always set to
151maximum and recording source is always
152.Dq Li "stereo mix" .
153.El
154.Pp
155Other OSS mixer controls do not work.
156.Sh PRIVATE DEVICE CONTROLS
157You can control most of EMU10Kx operation and configuration parameters through
158.Va dev.emu10kx. Ns Aq Ar X
159sysctls.
160These
161.Xr sysctl 8
162values are temporary and should not be relied
163upon.
164.Sh DRIVER CONFIGURATION
165.Ss Kernel Configuration Options
166The following kernel configuration options control the
167.Nm
168driver.
169.Bl -tag -width ".Dv EMU10KX_MULTICHANNEL"
170.It Dv EMU10KX_MULTICHANNEL
171This option enables
172.Sx MULTICHANNEL PLAYBACK
173for all instances of the
174.Nm
175driver.
176.It Dv EMU10KX_DEBUG
177This option enables additional debug messages.
178.El
179.Sh FILES
180.Bl -tag -width ".Pa /dev/emu10kx?" -compact
181.It Pa /dev/emu10kx?
182.Nm
183management interface
184.El
185.Sh SEE ALSO
186.Xr sound 4
187.Sh HISTORY
188The
189.Nm
190device driver first appeared in
191.Fx 7.0 .
192.Sh AUTHORS
193.An -nosplit
194The PCM part of the driver is based on the
195.Xr snd_emu10k1 4
196SB Live!\& driver by
197.An "Cameron Grant" .
198The MIDI interface is based on the
199.Xr snd_emu10k1 4
200MIDI interface code by
201.An "Mathew Kanner" .
202The
203.Nm
204device driver and this manual page were written by
205.An Yuriy Tsibizov .
206.Sh BUGS
2078kHz/8bit/mono recording does not work.
2088kHz recording was removed from the driver capabilities.
209.Pp
210The driver does not detect lost S/PDIF signal and produces noise when S/PDIF
211is not connected and S/PDIF volume is not zero.
212.Pp
213The PCM driver cannot detect the presence of Live!Drive or AudigyDrive
214breakout boxes
215and tries to use them (and list their connectors in the mixer).
216.Pp
217The MIDI driver cannot detect the presence of Live!Drive or AudigyDrive
218breakout boxes and tries to enable the IR receiver on them anyway.
219