From 3a5f5a844fc76737555f9e43023266d66e5fa5a6 Mon Sep 17 00:00:00 2001 From: brueffer Date: Sun, 16 Jul 2006 20:43:12 +0000 Subject: General cleanup, not quite finished yet. --- share/man/man4/snd_emu10kx.4 | 120 +++++++++++++++++++++++++++---------------- 1 file changed, 75 insertions(+), 45 deletions(-) (limited to 'share/man/man4/snd_emu10kx.4') diff --git a/share/man/man4/snd_emu10kx.4 b/share/man/man4/snd_emu10kx.4 index 2ac4e40..cf0fac7 100644 --- a/share/man/man4/snd_emu10kx.4 +++ b/share/man/man4/snd_emu10kx.4 @@ -26,17 +26,30 @@ .\" $Id: snd_emu10kx.4,v 1.19 2006/06/07 11:18:57 chibis Exp $ .\" $FreeBSD$ .\" -.Dd May 31, 2003 +.Dd July 15, 2006 .Dt SND_EMU10KX 4 .Os .Sh NAME .Nm snd_emu10kx .Nd Creative SoundBlaster Live! and Audigy sound cards device driver .Sh SYNOPSIS +To compile this driver into the kernel, place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent .Cd "device sound" .Cd "device snd_emu10kx" +.Pp +For additional options: .Cd "options EMU10KX_MULTICHANNEL" .Cd "options EMU10KX_DEBUG" +.Ed +.Pp +Alternatively, to load the driver as a module at boot time, place the +following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +snd_emu10kx_load="YES" +.Ed .Sh DESCRIPTION The .Nm @@ -46,12 +59,12 @@ to attach to the Creative sound cards based on EMU10K1, CA0100, CA0101, CA0102 and CA0108 DSPs. .Pp .Nm -sound cards have a PCM part, that's accessible through one to five +sound cards have a PCM part, which is accessible through one to five .Xr pcm 4 devices (see .Sx MULTICHANNEL PLAYBACK -for details), and MPU401-compatible MIDI I/O controller, that's accessible -through the midi device. +for details), and MPU401-compatible MIDI I/O controller, which is accessible +through the midi device. Wave table synthesizer is not supported. .Sh HARDWARE The @@ -60,71 +73,86 @@ driver supports the following sound cards: .Pp .Bl -bullet -compact .It -Creative Sound Blaster Live!\& (EMU10K1 Chipset). Both PCM and MIDI interfaces -are available. +Creative Sound Blaster Live!\& (EMU10K1 Chipset). +Both PCM and MIDI interfaces are available. .It -Creative Sound Blaster Audigy (CA0100 and CA0101 Chipset). PCM and two MIDI -interfaces available. +Creative Sound Blaster Audigy (CA0100 and CA0101 Chipset). +PCM and two MIDI interfaces available. .It Creative Sound Blaster Audigy 2 and Creative Sound Blaster Audigy 4 (CA0102 -Chipset). PCM support is limited to 48kHz/16 bit stereo (192kHz/24 bit part +Chipset). +PCM support is limited to 48kHz/16 bit stereo (192kHz/24 bit part of this chipset is not supported). .It -Creative Sound Blaster Audigy 2 Value (CA0108 Chipset). PCM support is limited +Creative Sound Blaster Audigy 2 Value (CA0108 Chipset). +PCM support is limited to 48kHz/16 bit stereo (192kHz/24 bit part of this chipset is not supported).\& There is no MIDI support for this card. .El .Pp The .Nm -driver does not supports the following sound cards (although they are named +driver does +.Em not +support the following sound cards (although they are named similar to some supported ones): .Pp .Bl -bullet -compact .It Creative Sound Blaster Live!\& 24-Bit, identified by FreeBSD as -"emu10k1x Soundblaster Live! 5.1". +.Li Qq emu10k1x Soundblaster Live! 5.1 . .It Creative Sound Blaster Audigy LS / ES, identified by FreeBSD as -"CA0106-DAT Audigy LS". +.Li Qq CA0106-DAT Audigy LS . .It -All other cards on -DAT chipsets. +All other cards with -DAT chipsets. .El .Sh MULTICHANNEL PLAYBACK .Pp -It is possible to build this driver with multichannel playback capabilites. If -you enable EMU10KX_MULTICHANNEL option in your kernel configuration (or +It is possible to build this driver with multichannel playback capabilites. +If you enable the +.Dq Dv EMU10KX_MULTICHANNEL +option in your kernel configuration (or build it as a module) you will get up to five DSP devices, one for each sound -card output. Only "FRONT" output can play and record sound from external +card output. +Only +.Dq FRONT +output can play and record sound from external sources (like line or S/PDIF inputs). .Sh OSS MIXER CONTROLS .Pp -These are controls available through standard OSS programming interface. -You can use +These are controls available through the standard OSS programming interface. +You can use .Xr mixer 8 to change them. .Pp -On EMU10K1-based cards OSS mixer directly control AC97 codec on card. On -newer cards OSS mixer control some parameters of AC97 codec and +On EMU10K1-based cards the OSS mixer directly controls the AC97 codec on card. +On newer cards the OSS mixer controls some parameters of the AC97 codec and some DSP-based mixer controls. .Pp "vol" mixer control is overall sound volume. .Pp -"pcm" mixer control is PCM playback volume. It controls only front output -volume in multichannel mode and all outputs volume in single chennel mode. +"pcm" mixer control is PCM playback volume. +It controls only front output +volume in multichannel mode and all output volume in single chennel mode. .Pp "rec" mixer control acts very different on EMU10K1 and other cards. -On EMU10K1 cards it controls AC97 codec recording level. On non-EMU10K1 cards -it controls amount of AC97 "stereo mix" entering DSP. AC97 recording -level and AC97 recording source are fixed -on CA0100, CA0101, CA0102 and CA0108 cards. AC97 recording level always set to +On EMU10K1 cards it controls the AC97 codec recording level. +On non-EMU10K1 cards +it controls the amount of AC97 "stereo mix" entering the DSP. +AC97 recording level and AC97 recording source are fixed +on CA0100, CA0101, CA0102 and CA0108 cards. +AC97 recording level are always set to maximum and recording source is always "stereo mix". .Pp -Other OSS mixer controls does not work. +Other OSS mixer controls do not work. .Sh PRIVATE DEVICE CONTROLS .Pp You can control most of EMU10Kx operation and configuration parameters through -dev.emu10kx.X sysctls. This sysctls are temporary and should not be relied +dev.emu10kx.X sysctls. +These +.Xr sysctl 8 +values are temporary and should not be relied upon. .Sh DRIVER CONFIGURATION .Ss Kernel Configuration Options @@ -135,7 +163,7 @@ driver. .It Em EMU10KX_MULTICHANNEL This option enables .Sx MULTICHANNEL PLAYBACK -for all instances of +for all instances of the .Nm driver. .It Em EMU10KX_DEBUG @@ -143,36 +171,38 @@ This option enables additional debug messages. .El .Pp .Sh FILES -.Bl -tag -width /boot/kernel/snd_emu10kx.ko -compact +.Bl -tag -width /dev/emu10kx? -compact .It Pa /dev/emu10kx? emu10kx management interface -.It Pa /boot/kernel/snd_emu10kx.ko -emu10kx loadable module .El .Sh SEE ALSO -.Xr pcm 4 , +.Xr sound 4 .Sh HISTORY The .Nm -device driver first appeared in +device driver first appeared in +.Fx 7.0 . .Sh AUTHORS -PCM part of driver is based on -.Xr emu10k1 9 -SB Live! driver by Cameron Grant, MIDI interface is based on -.Xr emu10k1 9 +The PCM part of the driver is based on the +.Xr snd_emu10k1 4 +SB Live! driver by Cameron Grant. +The MIDI interface is based on the +.Xr snd_emu10k1 4 MIDI interface code by Mathew Kanner. +The .Nm device driver and this manual page were written by .An Yuriy Tsibizov . .Sh BUGS 8kHz/8bit/mono recording does not work. -8kHz recording removed from driver capabilites. +8kHz recording was removed from the driver capabilites. .Pp -Driver does not detect lost S/PDIF signal and produce noise when S/PDIF +The Driver does not detect lost S/PDIF signal and produces noise when S/PDIF is not connected and S/PDIF volume is not zero. .Pp -PCM driver can't detect presence of Live!Drive or AudigyDrive breakout boxes -and tries to use them (and list their connectors in mixer). +The PCM driver cannot detect the presence of Live!Drive or AudigyDrive +breakout boxes +and tries to use them (and list their connectors in the mixer). .Pp -MIDI driver can't detect presence of Live!Drive or AudigyDrive breakout boxes -and tries to enable IR receiver on them anyway. +The MIDI driver cannot detect the presence of Live!Drive or AudigyDrive +breakout boxes and tries to enable the IR receiver on them anyway. -- cgit v1.1