Quick sound manpage upgrade (syncs with FreeBSD).
authorSascha Wildner <saw@online.de>
Thu, 8 Jan 2015 18:16:51 +0000 (19:16 +0100)
committerSascha Wildner <saw@online.de>
Thu, 8 Jan 2015 18:16:51 +0000 (19:16 +0100)
24 files changed:
share/man/man4/Makefile
share/man/man4/pcm.4
share/man/man4/snd_als4000.4
share/man/man4/snd_atiixp.4
share/man/man4/snd_cmi.4
share/man/man4/snd_cs4281.4
share/man/man4/snd_emu10k1.4
share/man/man4/snd_emu10kx.4 [new file with mode: 0644]
share/man/man4/snd_envy24.4
share/man/man4/snd_envy24ht.4
share/man/man4/snd_es137x.4
share/man/man4/snd_fm801.4
share/man/man4/snd_hda.4
share/man/man4/snd_hdspe.4 [copied from share/man/man4/snd_als4000.4 with 79% similarity]
share/man/man4/snd_ich.4
share/man/man4/snd_maestro.4
share/man/man4/snd_neomagic.4
share/man/man4/snd_solo.4
share/man/man4/snd_spicds.4
share/man/man4/snd_t4dwave.4
share/man/man4/snd_uaudio.4
share/man/man4/snd_via8233.4
share/man/man4/snd_via82c686.4
share/man/man4/snd_vibes.4

index 888fc24..00b2799 100644 (file)
@@ -285,11 +285,13 @@ MAN=      aac.4 \
        snd_cmi.4 \
        snd_cs4281.4 \
        snd_emu10k1.4 \
+       snd_emu10kx.4 \
        snd_envy24.4 \
        snd_envy24ht.4 \
        snd_es137x.4 \
        snd_fm801.4 \
        snd_hda.4 \
+       snd_hdspe.4 \
        snd_ich.4 \
        snd_maestro.4 \
        snd_neomagic.4 \
@@ -509,11 +511,13 @@ MLINKS+=snd_atiixp.4 atiixp.4
 MLINKS+=snd_cmi.4 cmi.4
 MLINKS+=snd_cs4281.4 cs4281.4
 MLINKS+=snd_emu10k1.4 emu10k1.4
+MLINKS+=snd_emu10kx.4 emu10kx.4
 MLINKS+=snd_envy24.4 envy24.4
 MLINKS+=snd_envy24ht.4 envy24ht.4
 MLINKS+=snd_es137x.4 es137x.4
 MLINKS+=snd_fm801.4 fm801.4
 MLINKS+=snd_hda.4 hda.4
+MLINKS+=snd_hdspe.4 hdspe.4
 MLINKS+=snd_ich.4 ich.4
 MLINKS+=snd_maestro.4 maestro.4
 MLINKS+=snd_neomagic.4 neomagic.4
index 59cc421..71e9496 100644 (file)
@@ -1,5 +1,5 @@
 .\"
-.\" Copyright (c) 1998, Luigi Rizzo
+.\" Copyright (c) 2009-2011 Joel Dahl <joel@FreeBSD.org>
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/pcm.4,v 1.39.2.6 2007/05/23 19:45:49 brueffer Exp $
+.\" $FreeBSD: head/share/man/man4/pcm.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd January 9, 2014
+.Dd January 8, 2015
 .Dt SOUND 4
 .Os
 .Sh NAME
-.Nm pcm ,
-.Nm sound
+.Nm sound ,
+.Nm pcm
 .Nd DragonFly PCM audio device infrastructure
 .Sh SYNOPSIS
 To compile this driver into the kernel, place the following line in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
-.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
-sound_load="YES"
+.Cd "device sound"
 .Ed
 .Sh DESCRIPTION
 The
 .Nm
-driver provides support for
-.Tn PCM
-audio play and capture.
-This driver also supports various
-.Tn PCI ,
-.Tn ISA ,
-.Tn WSS/MSS
-compatible
-sound cards, AC97 mixer and High Definition Audio.
-Once the
-.Nm
-driver attaches, supported devices provide audio record and
-playback channels.
-The
+driver is the main component of the
 .Dx
-sound system provides dynamic mixing
-.Dq VCHAN
-and rate conversion
-.Dq soft formats .
-True full duplex operation is available on most sound cards.
+sound system.
+It works in conjunction with a bridge device driver on supported devices
+and provides PCM audio record and playback once it attaches.
+Each bridge device driver supports a specific set of audio chipsets and
+needs to be enabled together with the
+.Nm
+driver.
 .Pp
-If the sound card is supported by a bridge driver, the
+Some of the main features of the
 .Nm
-driver works in conjunction with the bridge driver.
+driver are: multichannel audio, per-application
+volume control, dynamic mixing through virtual sound channels, true full
+duplex operation, bit perfect audio, rate conversion and low latency
+modes.
 .Pp
-Apart from the usual parameters, the flags field is used to specify
-the secondary
-.Tn DMA
-channel (generally used for capture in full duplex cards).
-Flags are set to 0 for cards not using a secondary
-.Tn DMA
-channel, or to 0x10 + C to specify channel C.
+The
+.Nm
+driver is enabled by default, along with several bridge device drivers.
+Those not enabled by default can be loaded during runtime with
+.Xr kldload 8
+or during boot via
+.Xr loader.conf 5 .
+The following bridge device drivers are available:
 .Pp
-The driver does its best to recognize the installed hardware and drive
-it correctly so the user is not required to add specific settings to
-the kernel config file.
-For
-.Tn PCI
-and
-.Tn ISA
-.Tn PnP
-cards this is actually easy
-since they identify themselves.
-For legacy
-.Tn ISA
-cards, the driver looks for
-.Tn MSS
-cards at addresses 0x530 and 0x604 (unless overridden
-in the kernel config file ) .
+.Bl -bullet -compact
+.It
+.Xr snd_als4000 4
+.It
+.Xr snd_atiixp 4
+.It
+.Xr snd_cmi 4
+.It
+.Xr snd_cs4281 4
+.It
+.Xr snd_emu10k1 4
+.It
+.Xr snd_emu10kx 4
+.It
+.Xr snd_envy24 4
+.It
+.Xr snd_envy24ht 4
+.It
+.Xr snd_es137x 4
+.It
+.Xr snd_fm801 4
+.It
+.Xr snd_hda 4
+.It
+.Xr snd_hdspe 4
+.It
+.Xr snd_ich 4
+.It
+.Xr snd_maestro 4
+.It
+.Xr snd_neomagic 4
+.It
+.Xr snd_solo 4
+.It
+.Xr snd_spicds 4
+.It
+.Xr snd_t4dwave 4
+.It
+.Xr snd_uaudio 4
+.It
+.Xr snd_via8233 4
+.It
+.Xr snd_via82c686 4
+.It
+.Xr snd_vibes 4
+.El
+.Pp
+Refer to the manual page for each bridge device driver for driver specific
+settings and information.
 .Ss Boot Variables
 In general, the module
 .Pa snd_foo
@@ -113,25 +132,66 @@ utility.
 Options which can be specified in
 .Pa /boot/loader.conf
 include:
-.Bl -tag -width ".Va snd_emu10k1_load" -offset indent
+.Bl -tag -width ".Va snd_driver_load" -offset indent
 .It Va snd_driver_load
 .Pq Dq Li NO
 If set to
 .Dq Li YES ,
 this option loads all available drivers.
-.It Va snd_emu10k1_load
+.It Va snd_hda_load
 .Pq Dq Li NO
 If set to
 .Dq Li YES ,
-only the SoundBlaster 5.1 driver and dependent modules will be loaded.
+only the Intel High Definition Audio bridge device driver and dependent
+modules will be loaded.
 .It Va snd_foo_load
 .Pq Dq Li NO
 If set to
 .Dq Li YES ,
 load driver for card/chipset foo.
 .El
+.Pp
+To define default values for the different mixer channels,
+set the channel to the preferred value using hints, e.g.:
+.Va hint.pcm.0.line Ns = Ns Qq Li 0 .
+This will mute the input channel per default.
+.Ss Multichannel Audio
+Multichannel audio, popularly referred to as
+.Dq surround sound
+is supported and enabled by default.
+The FreeBSD multichannel matrix processor supports up to 18 interleaved
+channels, but the limit is currently set to 8 channels (as commonly used
+for 7.1 surround sound).
+The internal matrix mapping can handle reduction, expansion or
+re-routing of channels.
+This provides a base interface for related multichannel
+.Fn ioctl
+support.
+Multichannel audio works both with and without
+.Tn VCHANs .
+.Pp
+Most bridge device drivers are still missing multichannel matrixing
+support, but in most cases this should be trivial to implement.
+Use the
+.Va dev.pcm.%d.[play|rec].vchanformat
+.Xr sysctl 8
+to adjust the number of channels used.
+The current multichannel interleaved structure and arrangement was
+implemented by inspecting various popular UNIX applications.
+There were no single standard, so much care has been taken to try
+to satisfy each possible scenario, despite the fact that each
+application has its own conflicting standard.
+.Ss EQ
+The Parametric Software Equalizer (EQ) enables the use of
+.Dq tone
+controls (bass and treble).
+Commonly used for ear-candy or frequency compensation due to the vast
+difference in hardware quality.
+EQ is disabled by default, but can be enabled with the
+.Va hint.pcm.%d.eq
+tunable.
 .Ss VCHANs
-Each device can optionally support more playback channels
+Each device can optionally support more playback and recording channels
 than physical hardware provides by using
 .Dq virtual channels
 or
@@ -140,34 +200,189 @@ or
 options can be configured via the
 .Xr sysctl 8
 interface but can only be manipulated while the device is inactive.
+.Ss VPC
+FreeBSD supports independent and individual volume controls for each active
+application, without touching the master
+.Nm
+volume.
+This is sometimes referred to as Volume Per Channel (VPC).
+The
+.Tn VPC
+feature is enabled by default.
+.Ss Loader Tunables
+The following loader tunables are used to set driver configuration at the
+.Xr loader 8
+prompt before booting the kernel, or they can be stored in
+.Pa /boot/loader.conf
+in order to automatically set them before booting the kernel.
+.\"It is also possible to use
+.\".Xr kenv 1
+.\"to change these tunables before loading the
+.\".Nm
+.\"driver.
+The following tunables can not be changed during runtime using
+.Xr sysctl 8 .
+.Bl -tag -width indent
+.It Va hint.pcm.%d.eq
+Set to 1 or 0 to explicitly enable (1) or disable (0) the equalizer.
+Requires a driver reload if changed.
+Enabling this will make bass and treble controls appear in mixer applications.
+This tunable is undefined by default.
+Equalizing is disabled by default.
+.It Va hint.pcm.%d.vpc
+Set to 1 or 0 to explicitly enable (1) or disable (0) the
+.Tn VPC
+feature.
+This tunable is undefined by default.
+.Tn VPC
+is however enabled by default.
+.El
 .Ss Runtime Configuration
-The following
+There are a number of
 .Xr sysctl 8
-variables are available:
-.Bl -tag -width ".Va hw.snd.report_soft_formats" -offset indent
-.It Va hw.snd.pcm%d.buffersize
-Configure the amount of
-.Tn DMA
-bufferspace available for a device.
-.It Va hw.snd.targetirqrate
-Set the default block size such that continuous
-playback will achieve this
-.Tn IRQ
-rate.
-This value can be tuned to improve application performance.
-Increase this value when the sound lags and decrease
-it if sound stutters or breaks up.
+variables available which can be modified during runtime.
+These values can also be stored in
+.Pa /etc/sysctl.conf
+in order to automatically set them during the boot process.
+.Va hw.snd.*
+are global settings and
+.Va dev.pcm.*
+are device specific.
+.Bl -tag -width indent
+.It Va hw.snd.compat_linux_mmap
+Linux
+.Xr mmap 2
+compatibility.
+The following values are supported (default is 0):
+.Bl -tag -width 2n
+.It -1
+Force disabling/denying PROT_EXEC
+.Xr mmap 2
+requests.
+.It 0
+Auto detect proc/ABI type, allow
+.Xr mmap 2
+for Linux applications, and deny for everything else.
+.It 1
+Always allow PROT_EXEC page mappings.
+.El
+.It Va hw.snd.default_auto
+Automatically assign the default sound unit.
+The following values are supported (default is 1):
+.Bl -tag -width 2n
+.It 0
+Do not assign the default sound unit automatically.
+.It 1
+Use the best available sound device based on playing and recording
+capabilities of the device.
+.It 2
+Use the most recently attached device.
+.El
+.It Va hw.snd.default_unit
+Default sound card for systems with multiple sound cards.
+When using
+.Xr devfs 5 ,
+the default device for
+.Pa /dev/dsp .
+Equivalent to a symlink from
+.Pa /dev/dsp
+to
+.Pa /dev/dsp Ns Va ${hw.snd.default_unit} .
+.It Va hw.snd.feeder_eq_exact_rate
+Only certain rates are allowed for precise processing.
+The default behavior is however to allow sloppy processing for all rates,
+even the unsupported ones.
+Enable to toggle this requirement and only allow processing for supported
+rates.
+.It Va hw.snd.feeder_rate_max
+Maximum allowable sample rate.
+.It Va hw.snd.feeder_rate_min
+Minimum allowable sample rate.
+.It Va hw.snd.feeder_rate_polyphase_max
+Adjust to set the maximum number of allowed polyphase entries during the
+process of building resampling filters.
+Disabling polyphase resampling has the benefit of reducing memory usage, at
+the expense of slower and lower quality conversion.
+Only applicable when the SINC interpolator is used.
+Default value is 183040.
+Set to 0 to disable polyphase resampling.
+.It Va hw.snd.feeder_rate_quality
+Sample rate converter quality.
+Default value is 1, linear interpolation.
+Available options include:
+.Bl -tag -width 2n
+.It 0
+Zero Order Hold, ZOH.
+Very fast, but with poor quality.
+.It 1
+Linear interpolation.
+Fast, quality is subject to personal preference.
+Technically the quality is poor however, due to the lack of anti-aliasing
+filtering.
+.It 2
+Bandlimited SINC interpolator.
+Implements polyphase banking to boost the conversion speed, at the cost of
+memory usage, with multiple high quality polynomial interpolators to improve
+the conversion accuracy.
+100% fixed point, 64bit accumulator with 32bit coefficients and high precision
+sample buffering.
+Quality values are 100dB stopband, 8 taps and 85% bandwidth.
+.It 3
+Continuation of the bandlimited SINC interpolator, with 100dB stopband, 36
+taps and 90% bandwidth as quality values.
+.It 4
+Continuation of the bandlimited SINC interprolator, with 100dB stopband, 164
+taps and 97% bandwidth as quality values.
+.El
+.It Va hw.snd.feeder_rate_round
+Sample rate rounding threshold, to avoid large prime division at the
+cost of accuracy.
+All requested sample rates will be rounded to the nearest threshold value.
+Possible values range between 0 (disabled) and 500.
+Default is 25.
+.It Va hw.snd.latency
+Configure the buffering latency.
+Only affects applications that do not explicitly request
+blocksize / fragments.
+This tunable provides finer granularity than the
+.Va hw.snd.latency_profile
+tunable.
+Possible values range between 0 (lowest latency) and 10 (highest latency).
+.It Va hw.snd.latency_profile
+Define sets of buffering latency conversion tables for the
+.Va hw.snd.latency
+tunable.
+A value of 0 will use a low and aggressive latency profile which can result
+in possible underruns if the application cannot keep up with a rapid irq
+rate, especially during high workload.
+The default value is 1, which is considered a moderate/safe latency profile.
+.It Va hw.snd.maxautovchans
+Global
+.Tn VCHAN
+setting that only affects devices with at least one playback or recording channel available.
+The sound system will dynamically create up to this many
+.Tn VCHANs .
+Set to
+.Dq 0
+if no
+.Tn VCHANs
+are desired.
+Maximum value is 256.
 .It Va hw.snd.report_soft_formats
 Controls the internal format conversion if it is
 available transparently to the application software.
 When disabled or not available, the application will
 only be able to select formats the device natively supports.
+.It Va hw.snd.report_soft_matrix
+Enable seamless channel matrixing even if the hardware does not support it.
+Makes it possible to play multichannel streams even with a simple stereo
+sound card.
 .It Va hw.snd.verbose
 Level of verbosity for the
 .Pa /dev/sndstat
 device.
 Higher values include more output and the highest level,
-three, should be used when reporting problems.
+four, should be used when reporting problems.
 Other options include:
 .Bl -tag -width 2n
 .It 0
@@ -181,19 +396,50 @@ current format, speed, and pseudo device statistics such as
 buffer overruns and buffer underruns.
 .It 3
 File names and versions of the currently loaded sound modules.
+.It 4
+Various messages intended for debugging.
 .El
-.It Va hw.snd.maxautovchans
-Global
+.It Va hw.snd.vpc_0db
+Default value for
+.Nm
+volume.
+Increase to give more room for attenuation control.
+Decrease for more amplification, with the possible cost of sound clipping.
+.It Va hw.snd.vpc_autoreset
+When a channel is closed the channel volume will be reset to 0db.
+This means that any changes to the volume will be lost.
+Enabling this will preserve the volume, at the cost of possible confusion
+when applications tries to re-open the same device.
+.It Va hw.snd.vpc_mixer_bypass
+The recommended way to use the
+.Tn VPC
+feature is to teach applications to use
+the correct
+.Fn ioctl :
+.Dv SNDCTL_DSP_GETPLAYVOL, SNDCTL_DSP_SETPLAYVOL,
+.Dv SNDCTL_DSP_SETRECVOL, SNDCTL_DSP_SETRECVOL.
+This is however not always possible.
+Enable this to allow applications to use their own existing mixer logic
+to control their own channel volume.
+.It Va hw.snd.vpc_reset
+Enable to restore all channel volumes back to the default value of 0db.
+.It Va dev.pcm.%d.bitperfect
+Enable or disable bitperfect mode.
+When enabled, channels will skip all dsp processing, such as channel
+matrixing, rate converting and equalizing.
+The pure
+.Nm
+stream will be fed directly to the hardware.
+If
+.Tn VCHANs
+are enabled, the bitperfect mode will use the
 .Tn VCHAN
-setting that only affects devices with only one playback channel available.
-The sound system will dynamically create up this many
-.Tn VCHANs .
-Set to
-.Dq 0
-if no
-.Tn VCHANS
-are desired.
-.It Va hw.snd.pcm%d.vchans
+format/rate as the definitive format/rate target.
+The recommended way to use bitperfect mode is to disable
+.Tn VCHANs
+and enable this sysctl.
+Default is disabled.
+.It Va dev.pcm.%d.[play|rec].vchans
 The current number of
 .Tn VCHANs
 allocated per device.
@@ -204,12 +450,95 @@ Setting this value to
 will disable
 .Tn VCHANs
 for this device.
+.It Va dev.pcm.%d.[play|rec].vchanformat
+Format for
+.Tn VCHAN
+mixing.
+All playback paths will be converted to this format before the mixing
+process begins.
+By default only 2 channels are enabled.
+Available options include:
+.Bl -tag -width 2n
+.It s16le:1.0
+Mono.
+.It s16le:2.0
+Stereo, 2 channels (left, right).
+.It s16le:2.1
+3 channels (left, right, LFE).
+.It s16le:3.0
+3 channels (left, right, rear center).
+.It s16le:4.0
+Quadraphonic, 4 channels (front/rear left and right).
+.It s16le:4.1
+5 channels (4.0 + LFE).
+.It s16le:5.0
+5 channels (4.0 + center).
+.It s16le:5.1
+6 channels (4.0 + center + LFE).
+.It s16le:6.0
+6 channels (4.0 + front/rear center).
+.It s16le:6.1
+7 channels (6.0 + LFE).
+.It s16le:7.1
+8 channels (4.0 + center + LFE + left and right side).
+.El
+.It Va dev.pcm.%d.[play|rec].vchanmode
+.Tn VCHAN
+format/rate selection.
+Available options include:
+.Bl -tag -width 2n
+.It fixed
+Channel mixing is done using fixed format/rate.
+Advanced operations such as digital passthrough will not work.
+Can be considered as a
+.Dq legacy
+mode.
+This is the default mode for hardware channels which lack support for digital
+formats.
+.It passthrough
+Channel mixing is done using fixed format/rate, but advanced operations such
+as digital passthrough also work.
+All channels will produce sound as usual until a digital format playback is
+requested.
+When this happens all other channels will be muted and the latest incoming
+digital format will be allowed to pass through undisturbed.
+Multiple concurrent digital streams are supported, but the latest stream will
+take precedence and mute all other streams.
+.It adaptive
+Works like the
+.Dq passthrough
+mode, but is a bit smarter, especially for
+multiple
+.Nm
+channels with different format/rate.
+When a new channel is about to start, the entire list of virtual channels will
+be scanned, and the channel with the best format/rate (usually the
+highest/biggest) will be selected.
+This ensures that mixing quality depends on the best channel.
+The downside is that the hardware DMA mode needs to be restarted, which may
+cause annoying pops or clicks.
+.El
+.It Va dev.pcm.%d.[play|rec].vchanrate
+Sample rate speed for
+.Tn VCHAN
+mixing.
+All playback paths will be converted to this sample rate before the mixing
+process begins.
+.It Va dev.pcm.%d.polling
+Experimental polling mode support where the driver operates by querying the
+device state on each tick using a
+.Xr callout 9
+mechanism.
+Disabled by default and currently only available for a few device drivers.
 .El
 .Ss Recording Channels
 On devices that have more than one recording source (ie: mic and line),
 there is a corresponding
-.Pa /dev/dspr%d.%d
+.Pa /dev/dsp%d.r%d
 device.
+The
+.Xr mixer 8
+utility can be used to start and stop recording from an specific device.
 .Ss Statistics
 Channel statistics are only kept while the device is open.
 So with situations involving overruns and underruns, consider the output
@@ -236,7 +565,7 @@ functions.
 .Sh FILES
 The
 .Nm
-drivers may use the following
+drivers may create the following
 device nodes:
 .Pp
 .Bl -tag -width ".Pa /dev/audio%d.%d" -compact
@@ -248,8 +577,14 @@ Digitized voice device.
 Like
 .Pa /dev/dsp ,
 but 16 bits per sample.
-.It Pa /dev/dspr%d.%d
-Should be connected to a record codec.
+.It Pa /dev/dsp%d.p%d
+Playback channel.
+.It Pa /dev/dsp%d.r%d
+Record channel.
+.It Pa /dev/dsp%d.vp%d
+Virtual playback channel.
+.It Pa /dev/dsp%d.vr%d
+Virtual recording channel.
 .It Pa /dev/sndstat
 Current
 .Nm
@@ -269,10 +604,45 @@ Additional messages are sometimes recorded when the
 device is probed and attached, these messages can be viewed with the
 .Xr dmesg 8
 utility.
+.Pp
+The above device nodes are only created on demand through the dynamic
+.Xr devfs 5
+clone handler.
+Users are strongly discouraged to access them directly.
+For specific sound card access, please instead use
+.Pa /dev/dsp
+or
+.Pa /dev/dsp%d .
+.Sh EXAMPLES
+Use the sound metadriver to load all
+.Nm
+bridge device drivers at once
+(for example if it is unclear which the correct driver to use is):
+.Pp
+.Dl kldload snd_driver
+.Pp
+Load a specific bridge device driver, in this case the Intel
+High Definition Audio driver:
+.Pp
+.Dl kldload snd_hda
+.Pp
+Check the status of all detected
+.Nm
+devices:
+.Pp
+.Dl cat /dev/sndstat
+.Pp
+Change the default sound device, in this case to the second device.
+This is handy if there are multiple
+.Nm
+devices available:
+.Pp
+.Dl sysctl hw.snd.default_unit=1
 .Sh DIAGNOSTICS
 .Bl -diag
-.It ac97: dac not ready
-AC97 codec is not likely to be accompanied with the sound card.
+.It pcm%d:play:%d:dsp%d.p%d: play interrupt timeout, channel dead
+The hardware does not generate interrupts to serve incoming (play)
+or outgoing (record) data.
 .It unsupported subdevice XX
 A device node is not created properly.
 .El
@@ -282,11 +652,13 @@ A device node is not created properly.
 .Xr snd_cmi 4 ,
 .Xr snd_cs4281 4 ,
 .Xr snd_emu10k1 4 ,
+.Xr snd_emu10kx 4 ,
 .Xr snd_envy24 4 ,
 .Xr snd_envy24ht 4 ,
 .Xr snd_es137x 4 ,
 .Xr snd_fm801 4 ,
 .Xr snd_hda 4 ,
+.Xr snd_hdspe 4 ,
 .Xr snd_ich 4 ,
 .Xr snd_maestro 4 ,
 .Xr snd_neomagic 4 ,
@@ -297,11 +669,25 @@ A device node is not created properly.
 .Xr snd_via8233 4 ,
 .Xr snd_via82c686 4 ,
 .Xr snd_vibes 4 ,
+.Xr devfs 5 ,
 .Xr loader.conf 5 ,
 .Xr dmesg 8 ,
 .Xr kldload 8 ,
+.Xr mixer 8 ,
 .Xr sysctl 8
 .Rs
+.%T "Cookbook formulae for audio EQ biquad filter coefficients, by Robert Bristow-Johnson"
+.%O "http://www.musicdsp.org/files/Audio-EQ-Cookbook.txt"
+.Re
+.Rs
+.%T "Julius O'Smith's Digital Audio Resampling"
+.%O "http://ccrma.stanford.edu/~jos/resample/"
+.Re
+.Rs
+.%T "Polynomial Interpolators for High-Quality Resampling of Oversampled Audio, by Olli Niemitalo"
+.%O "http://www.student.oulu.fi/~oniemita/dsp/deip.pdf"
+.Re
+.Rs
 .%T "The OSS API"
 .%O "http://www.opensound.com/pguide/oss.pdf"
 .Re
index ed3b340..c68b624 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_als4000.4,v 1.4.2.1 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_als4000.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 15, 2005
+.Dd January 8, 2015
 .Dt SND_ALS4000 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_als4000"
 .Ed
 .Pp
index 331c76a..7e4ca90 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_atiixp.4,v 1.2.2.2 2006/01/31 00:10:09 ariff Exp $
+.\" $FreeBSD: head/share/man/man4/snd_atiixp.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd November 28, 2005
+.Dd January 8, 2015
 .Dt SND_ATIIXP 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_atiixp"
 .Ed
 .Pp
@@ -52,6 +52,21 @@ bridge driver allows the generic audio driver,
 to attach to ATI IXP audio devices.
 This driver supports 16bit playback and recording, and 32bit native playback
 and recording.
+.Ss Runtime Configuration
+The following
+.Xr sysctl 8
+variables are available in addition to those available to all
+.Xr sound 4
+devices:
+.Bl -tag -width ".Va dev.pcm.%d.polling" -offset indent
+.It Va dev.pcm.%d.polling
+Experimental polling mode, where the driver operates by querying the device
+state on each tick using
+.Xr callout 9 .
+Polling is disabled by default.
+Do not enable it unless you are facing weird interrupt problems or if the
+device cannot generate interrupts at all.
+.El
 .Sh HARDWARE
 The
 .Nm
index c0b1fff..e16c98a 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_cmi.4,v 1.4.2.2 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_cmi.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 15, 2005
+.Dd January 8, 2015
 .Dt SND_CMI 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_cmi"
 .Ed
 .Pp
index b3cf920..7f0074a 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_cs4281.4,v 1.2.2.4 2005/05/25 15:41:28 brueffer Exp $
+.\" $FreeBSD: head/share/man/man4/snd_cs4281.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 15, 2005
+.Dd January 8, 2015
 .Dt SND_CS4281 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_cs4281"
 .Ed
 .Pp
index 4211cbe..93b8184 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_emu10k1.4,v 1.5.2.2 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_emu10k1.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 15, 2005
+.Dd January 8, 2015
 .Dt SND_EMU10K1 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_emu10k1"
 .Ed
 .Pp
diff --git a/share/man/man4/snd_emu10kx.4 b/share/man/man4/snd_emu10kx.4
new file mode 100644 (file)
index 0000000..926f6dc
--- /dev/null
@@ -0,0 +1,296 @@
+.\"
+.\" Copyright (c) 2003-2007 Yuriy Tsibizov
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: head/share/man/man4/snd_emu10kx.4 267938 2014-06-26 21:46:14Z bapt $
+.\"
+.Dd January 8, 2015
+.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"
+.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
+bridge driver allows the generic audio driver
+.Xr sound 4
+to attach to Creative sound cards based on the EMU10K1, CA0100, CA0101, CA0102
+and CA0108 DSPs.
+.Pp
+The
+.Nm
+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, which is accessible
+through the midi device.
+Wave table synthesizer support is not available.
+.Sh HARDWARE
+The
+.Nm
+driver supports the following sound cards:
+.Pp
+.Bl -bullet -compact
+.It
+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.
+.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
+of this chipset is not supported).
+.It
+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
+.Em not
+support the following sound cards (although they have names
+similar to some supported ones):
+.Pp
+.Bl -bullet -compact
+.It
+Creative Sound Blaster Live!\& 24-Bit, identified by
+.Fx
+as
+.Qq Li "emu10k1x Soundblaster Live! 5.1" .
+.It
+Creative Sound Blaster Audigy LS / ES, identified by
+.Fx
+as
+.Qq Li "CA0106-DAT Audigy LS" .
+.It
+All other Creative sound cards with -DAT chipsets.
+.It
+All Creative X-Fi series sound cards.
+.El
+.Sh MULTICHANNEL PLAYBACK
+By default the
+.Nm
+driver is loaded with multichannel playback capabilities enabled.
+If you do not set the
+.Dv hint.emu10kx.0.multichannel_disabled
+option in your
+.Xr loader.conf 5
+configuration file you will get up to five DSP devices, one for each
+sound card output.
+You can use additional software (like
+.Em audio/pulseaudio
+from
+.Em The Ports Collection )
+to do sound stream demultiplexing.
+Only
+.Dq FRONT
+output can play and record sound from external
+sources (like line or S/PDIF inputs).
+.Sh MULTICHANNEL RECORDING
+By default multichannel recording capabilities are not enabled when you load
+the
+.Nm
+driver.
+If you enable the
+.Dv hint.emu10kx.0.multichannel_recording
+option in
+.Xr loader.conf 5
+you will get one more DSP device that is rate-locked to 48kHz/16bit/mono.
+This is actually 48kHz/16bit/32 channels on SB Live! cards and
+48kHz/16bit/64channels on Audigy cards, but the current implementation of
+the sound subsystem does not support such an amount of PCM channels.
+This device can not be opened for read, thus confusing many applications.
+.Pp
+Within a multichannel stream, the first half (0-15 or 0-31) is a copy of all DSP
+outputs, the second half (15-30 or 32-63) is a copy of some DSP inputs.
+On Live! cards the last substream (31) is used as a sync stream and is always
+set to 0xc0de.
+Audigy cards do not need such sync data, because a stream always starts with
+substream 0.
+.Ss SB Live! substream map (in byte offsets, each substream is 2 bytes LE)
+.Bl -tag -width ".Dv +0x00..+0x1E"
+.It Dv Offset
+Substream
+.It +0x00..+0x1E
+PCM streams 0..15
+.It +0x20, +0x22
+Empty
+.It +0x24..+0x2A
+PCM inputs: front left, front right, rear left, rear right, center, sub
+.It +0x2C..+0x3C
+DSP inputs 0..8:
+.It +0x3E
+sync substream (0xc0de)
+.El
+.Ss Audigy substream map (in byte offsets, each substream is 2 bytes LE)
+.Bl -tag -width ".Dv +0x00..+0x3E"
+.It Dv Offset
+Substream
+.It +0x00..+0x3E
+PCM streams 0..31
+.It +0x40..+0x5E
+PCM inputs: front LR, rear LR, center, sub, ...
+.It +0x60..+0x7E
+DSP inputs 0..16
+.El
+.Sh OSS MIXER CONTROLS
+These are the controls available through the standard OSS programming interface.
+You can use
+.Xr mixer 8
+to change them.
+.Pp
+On EMU10K1-based cards the OSS mixer directly controls the AC97 codec.
+On newer cards the OSS mixer controls some parameters of the AC97 codec and
+some DSP-based mixer controls.
+.Bl -inset
+.It Qq vol
+mixer control for the overall sound volume.
+.It Qq pcm
+mixer control for the PCM playback volume.
+It controls only front output
+volume in multichannel mode and all output volume in single channel mode.
+.It Qq rec
+mixer control acts very differently on EMU10K1 and other cards.
+On EMU10K1 cards it controls the AC97 codec recording level.
+On non-EMU10K1 cards it controls the amount of AC97
+.Dq stereo mix
+ entering the DSP.
+AC97 recording level and AC97 recording source are fixed on CA0100, CA0101,
+CA0102 and CA0108 cards.
+The AC97 recording levels are always set to maximum and recording source is always
+.Dq Li "stereo mix" .
+.It Qq dig1
+is a CD S/PDIF (on-card) volume control
+.It Qq dig2
+is an AudigyDrive S/PDIF (Audigy series) or TOSLink (SB Live! series) volume
+control
+.It Qq dig3
+is an on-card S/PDIF volume control
+.It Qq line2
+is AudigyDrive "Line In 2" volume control
+.It Qq line3
+is AudigyDrive "AUX In 2" volume control
+.El
+.Pp
+Other OSS mixer controls control the inputs of the AC97 codec.
+.Sh PRIVATE DEVICE CONTROLS
+You can control some of EMU10Kx's operation and configuration parameters through
+.Va dev.emu10kx. Ns Aq Ar X
+sysctls.
+These
+.Xr sysctl 8
+values are temporary and should not be relied upon.
+.Sh DRIVER CONFIGURATION
+Loader tunables are used to set driver configuration.
+Tunables can be set at the
+.Xr loader 8
+prompt before booting the kernel or they can be stored in
+.Pa /boot/loader.conf .
+These tunables cannot be changed from a machine
+.Xr sysctl 8
+entry after boot, but you can change them using
+.Xr kenv 1
+before loading the
+.Nm
+driver.
+.Bl -tag -width indent
+.It Va hint.emu10kx. Ns Ao Ar X Ac Ns Va .disabled
+Disables loading a driver instance.
+.It Va hint.emu10kx. Ns Ao Ar X Ac Ns Va .multichannel_disabled
+Disables multichannel playback support, when one card is represented as
+several PCM devices.
+.It Va hint.emu10kx. Ns Ao Ar X Ac Ns Va .multichannel_recording
+Enables experimental multichannel recording support.
+.It Va hint.emu10kx. Ns Ao Ar X Ac Ns Va .debug
+Set debug output level.
+.Bl -tag -width 2n
+.It 0
+No additional debug options enabled
+.It 1
+Enables all DSP outputs to be connected, even those
+that are known to be unused on a particular card.
+.It 2
+Additional debug messages about in-driver events will be printed.
+.It 2
+Additional debug messages will be printed when memory allocation fails.
+.El
+.El
+.Sh FILES
+.Bl -tag -width ".Pa /dev/emu10kx?" -compact
+.It Pa /dev/emu10kx?
+.Nm
+management interface
+.El
+.Sh SEE ALSO
+.Xr sound 4
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx 7.0 .
+.Sh AUTHORS
+.An -nosplit
+The PCM part of the driver is based on the
+.Xr snd_emu10k1 4
+SB Live!\& driver by
+.An Cameron Grant Aq Mt cg@FreeBSD.org .
+The MIDI interface is based on the
+.Xr snd_emu10k1 4
+MIDI interface code by
+.An Mathew Kanner Aq Mt matk@FreeBSD.org .
+The
+.Nm
+device driver and this manual page were written by
+.An Yuriy Tsibizov .
+.Sh BUGS
+The driver does not detect lost S/PDIF signals and produces noise when
+S/PDIF is not connected and S/PDIF volume is not zero.
+.Pp
+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
+The MIDI driver cannot detect the presence of Live!Drive or AudigyDrive
+breakout boxes and tries to enable the IR receiver on them anyway.
index af6caa2..a854f0e 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_envy24.4,v 1.3.2.1 2007/05/15 18:40:22 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_envy24.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd September 30, 2006
+.Dd January 8, 2015
 .Dt SND_ENVY24 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_envy24"
 .Cd "device snd_spicds"
 .Ed
@@ -65,13 +65,15 @@ M-Audio Delta Dio 2496
 .It
 Terratec DMX 6fire
 .El
+Only analog playback is supported.
+Recording and other features of these cards are not supported.
 .Sh SEE ALSO
 .Xr sound 4
 .Sh HISTORY
 The
 .Nm
 device driver first appeared in
-.Fx 7.0 .
+.Fx 6.3 .
 .Sh AUTHORS
 .An -nosplit
 The
index 68212b1..1debebb 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_envy24ht.4,v 1.1.2.2 2007/06/13 13:46:01 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_envy24ht.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd May 28, 2007
+.Dd January 8, 2015
 .Dt SND_ENVY24HT 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_envy24ht"
 .Cd "device snd_spicds"
 .Ed
@@ -85,13 +85,15 @@ Terratec PHASE 22
 .It
 Terratec PHASE 28
 .El
+Only analog playback is supported.
+Recording and other features of these cards are not supported.
 .Sh SEE ALSO
 .Xr sound 4
 .Sh HISTORY
 The
 .Nm
 device driver first appeared in
-.Fx 7.0 .
+.Fx 6.3 .
 .Sh AUTHORS
 .An -nosplit
 The
index 5679d50..20a5f46 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_es137x.4,v 1.4.2.2 2005/12/30 19:55:55 netchild Exp $
+.\" $FreeBSD: head/share/man/man4/snd_es137x.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 15, 2005
+.Dd January 8, 2015
 .Dt SND_ES137X 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_es137x"
 .Ed
 .Pp
@@ -56,12 +56,23 @@ The following
 variables are available in addition to those available to all
 .Xr sound 4
 devices:
-.Bl -tag -width ".Va hw.snd.pcm%d.spdif_enabled" -offset indent
+.Bl -tag -width ".Va hw.snd.pcm%d.latency_timer" -offset indent
+.It Va hw.snd.pcm%d.latency_timer
+Controls the PCI latency timer setting.
+Increasing this value will solve most popping and crackling issues
+(especially on VIA motherboards).
 .It Va hw.snd.pcm%d.spdif_enabled
 Enables S/PDIF output on the primary playback channel.
 This
 .Xr sysctl 8
 variable is available only if the device is known to support S/PDIF output.
+.It Va dev.pcm.%d.polling
+Experimental polling mode, where the driver operates by querying the device
+state on each tick using
+.Xr callout 9 .
+Polling is disabled by default.
+Do not enable it unless you are facing weird interrupt problems or if the
+device cannot generate interrupts at all.
 .El
 .Sh HARDWARE
 The
index cb7d103..ed02e7b 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_fm801.4,v 1.1.4.1 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_fm801.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 1, 2005
+.Dd January 8, 2015
 .Dt SND_FM801 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_fm801"
 .Ed
 .Pp
index 20a698a..1f7cf01 100644 (file)
@@ -1,4 +1,5 @@
-.\" Copyright (c) 2006 Joel Dahl <joel@FreeBSD.org>
+.\" Copyright (c) 2006-2008 Joel Dahl <joel@FreeBSD.org>
+.\" Copyright (c) 2008 Alexander Motin <mav@FreeBSD.org>
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
@@ -22,9 +23,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_hda.4,v 1.10.2.1 2007/05/15 18:40:22 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_hda.4 275990 2014-12-21 09:53:29Z brueffer $
 .\"
-.Dd April 7, 2012
+.Dd January 8, 2015
 .Dt SND_HDA 4
 .Os
 .Sh NAME
@@ -34,7 +35,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_hda"
 .Ed
 .Pp
@@ -45,171 +46,590 @@ following line in
 snd_hda_load="YES"
 .Ed
 .Sh DESCRIPTION
+The High Definition (HD) Audio specification was developed by Intel as the
+logical successor of the old AC'97 specification and has several advantages,
+such as higher bandwidth which allows more channels and more detailed formats,
+support for several logical audio devices, and general purpose DMA channels.
+.Pp
 The
 .Nm
-bridge device driver allows the generic audio driver,
+driver includes HDA bus controller driver (hdac), HDA codec driver (hdacc)
+and HDA codecs audio functions bridge driver (hdaa) that allows
+the generic audio driver,
 .Xr sound 4 ,
-to attach to Intel High Definition Audio devices.
+to be used with this hardware.
+Only audio functions are supported by
+.Nm .
+Modem and other possible functions are not implemented.
+.Pp
 The
 .Nm
 driver supports hardware that conforms with revision 1.0 of the Intel High
 Definition Audio specification and tries to behave much like the Microsoft
 Universal Audio Architecture (UAA) draft (revision 0.7b) for handling audio
 devices.
-HDA acts like a primary bus, similar to
-.Xr miibus 4 ,
-for handling various child buses such as audio, modem and HDMI (High Definition
-Multimedia Interface).
-Only audio is implemented in the
+.Pp
+According to HDA and UAA specifications, depending on the number of HDA buses
+and codecs present in system, their audio capabilities and BIOS provided
+configuration, the
 .Nm
-driver.
+driver often provides several PCM audio devices.
+For example, one device for main rear 7.1 output and inputs, one device
+for independent headset connectors at front and one device for SPDIF or
+HDMI audio input/output.
+The assignment of audio inputs and outputs may be tuned with
+.Xr device.hints 5
+or
+.Xr sysctl 8 .
+The driver's verbose boot messages provide a lot of information about
+the operation of the driver and present audio setup.
 .Pp
-The High Definition (HD) Audio specification was developed by Intel as the
-logical successor of the old AC'97 specification and has several advantages,
-such as higher bandwidth which allows more channels and more detailed formats,
-support for several logical audio devices, and general purpose DMA channels.
+The default audio device may be tuned by setting the
+.Ar hw.snd.default_unit
+sysctl, as described in
+.Xr sound 4 ,
+or explicitly specified in application settings.
+.Ss Boot-time Configuration
+The following variables are available at boot-time through the
+.Xr device.hints 5
+file:
+.Bl -tag -width ".Va hint.hdac.%d.config"-offset indent
+.It Va hint.hdac.%d.config
+Configures a range of possible controller options.
+Possible values are:
+.Dq Li 64bit ,
+.Dq Li dmapos ,
+.Dq Li msi .
+An option prefixed with
+.Dq Li no ,
+such as
+.Dq Li nomsi ,
+will do the opposite and takes precedence.
+Options can be separated by whitespace and commas.
+.It Va hint.hdac.%d.msi
+Controls MSI (Message Signaled Interrupts) support.
+.It Va hint.hdac.%d.cad%d.nid%d.config
+Same as
+.Va hint.hdaa.%d.nid%d.config
+.It Va hint.hdaa.%d.config
+Configures a range of possible audio function options.
+Possible values are:
+.Dq Li eapdinv ,
+.Dq Li ivref ,
+.Dq Li ivref50 ,
+.Dq Li ivref80 ,
+.Dq Li ivref100 ,
+.Dq Li fixedrate ,
+.Dq Li forcestereo ,
+.Dq Li ovref ,
+.Dq Li ovref50 ,
+.Dq Li ovref80 ,
+.Dq Li ovref100 ,
+.Dq Li senseinv ,
+.Dq Li softpcmvol ,
+and
+.Dq Li vref .
+An option prefixed with
+.Dq Li no ,
+such as
+.Dq Li nofixedrate ,
+will do the opposite and takes precedence.
+Options can be separated by whitespace and commas.
 .Pp
-The HDA specification defines the register-level interface, physical link
-characteristics, codec programming models, and codec architectural components.
-This specification is intended for both device driver developers and hardware
-component designers.
+The
+.Dq Li eapdinv
+option inverts External Amplifier Power Down signal.
+The
+.Dq Li fixedrate
+denies all sampling rates except 48KHz.
+The
+.Dq Li forcestereo
+denies mono playback/recording.
+The
+.Dq Li senseinv
+option inverts jack sensing logic.
+The
+.Dq Li ivref Ns Ar X
+and
+.Dq Li ovref Ns Ar X
+options control the voltage used to power external microphones.
+.It Va hint.hdaa.%d.gpio_config
+Overrides audio function GPIO pins configuration set by BIOS.
+May be specified as a set of space-separated
+.Dq Ar num Ns = Ns Ar value
+pairs, where
+.Ar num
+is GPIO line number, and
+.Ar value
+is one of:
+.Dq Li keep ,
+.Dq Li set ,
+.Dq Li clear ,
+.Dq Li disable
+and
+.Dq Li input .
+.Pp
+.Dq Li GPIO Ns s
+are a codec's General Purpose I/O pins which system integrators sometimes
+use to control external muters, amplifiers and so on.
+If you have no sound, or sound volume is not adequate, you may have to
+experiment a bit with the GPIO setup to find the optimal setup for your
+system.
+.It Va hint.hdaa.%d.nid%d.config
+Overrides audio function pin configuration set by BIOS.
+May be specified as a 32-bit hexadecimal value with a leading
+.Dq 0x ,
+or as a set of space-separated
+.Dq Ar option Ns = Ns Ar value
+pairs.
+.It Va hint.pcm.%d.rec.autosrc
+Controls automatic recording source feature:
+.Bl -tag -width 2n -compact
+.It 0
+disabled,
+.It 1
+once on attach,
+.It 2
+enabled.
+.El
+When enabled, driver will automatically set recording source of the mixer to
+connected input using jack presence detection statuses.
+.El
+.Pp
+Pin configuration is the UAA driver's main source of information about codec
+usage.
+This information is usually provided by the codec manufacturer and tuned
+by system integrators for specific system requirements.
+The
+.Nm
+driver allows users to override it to fix integrator mistakes or to use the
+available codec in alternative ways (for example to get stereo output and 2
+inputs instead of a single 5.1 output).
+.Pp
+The following options are supported:
+.Bl -tag -width ".Va device=" -offset indent
+.It Va as
+Association number.
+Associations are used to group individual pins to form a complex multi-pin
+device.
+For example, to group 4 connectors for 7.1 input/output, or to treat several
+input connectors as sources for the same input device.
+Association numbers can be specified as numeric values from 0 to 15.
+A value of 0 means disabled pin.
+A value of 15 is a set of independent unassociated pins.
+Each association includes only pins of the same direction (in/out) and is
+detected atomically (all pins or none).
+A separate PCM audio device is created for every pair of input and
+output associations.
+.It Va seq
+Sequence number.
+A unique, per-association number used to order pins inside the
+particular association.
+Sequence numbers can be specified as numeric values from 0 to 15.
+.Pp
+The sequence number 15 has a special meaning for output associations.
+Output pins with this number and device type
+.Dq Ar Headphones
+will duplicate (with automatic mute if jack detection is supported) the
+first pin in that association.
+.Pp
+The sequence numbers 14 and 15 has a special meaning for input associations.
+Their presence in association defines it as multiplexed or mixed respectively.
+If none of them are present and there are more than one pin in association,
+the association will provide multichannel input.
+.Pp
+For multichannel input/output associations sequence numbers encode
+channel pairs positions:
+0 - Front, 1 - Center/LFE, 2 - Back, 3 - Front Wide Center, 4 - Side.
+Standard combinations are: (0) - Stereo; (0, 2), (0, 4) - Quadro;
+(0, 1, 2), (0, 1, 4) - 5.1; (0, 1, 2, 4) - 7.1.
+.It Va device
+Device type.
+Can be specified as a number from 0 to 15 or as a name:
+.Dq Li Line-out ,
+.Dq Li Speaker ,
+.Dq Li Headphones,
+.Dq Li CD ,
+.Dq Li SPDIF-out ,
+.Dq Li Digital-out ,
+.Dq Li Modem-line ,
+.Dq Li Modem-handset ,
+.Dq Li Line-in ,
+.Dq Li AUX ,
+.Dq Li Mic ,
+.Dq Li Telephony ,
+.Dq Li SPDIF-in ,
+.Dq Li Digital-in ,
+.Dq Li Res.E ,
+or
+.Dq Li Other .
+The device type also describes the pin direction (in/out).
+For example,
+.Dq Li CD
+always means an input pin, while
+.Dq Li Headphones
+always means an output.
+.It Va conn
+Connection type.
+Can be specified as a number from 0 to 3.
+The connection type can also be specified as one of the special names
+.Dq Li Jack ,
+.Dq Li None ,
+.Dq Li Fixed ,
+or
+.Dq Li Both .
+Pins with a connection type of
+.Dq Li None
+are disabled.
+.It Va ctype
+Connector physical type.
+Can be specified as a number from 0 to 15.
+This is a reference only value.
+It is ignored by the
+.Nm
+driver.
+.It Va color
+Connector color.
+Can be specified as a number from 0 to 15 or as one of the names
+.Dq Li Unknown ,
+.Dq Li Black ,
+.Dq Li Grey ,
+.Dq Li Blue ,
+.Dq Li Green ,
+.Dq Li Red ,
+.Dq Li Orange ,
+.Dq Li Yellow ,
+.Dq Li Purple ,
+.Dq Li Pink ,
+.Dq Li Res.A ,
+.Dq Li Res.B ,
+.Dq Li Res.C ,
+.Dq Li Res.D ,
+.Dq Li White ,
+or
+.Dq Li Other .
+This is a reference only value.
+It is ignored by the
+.Nm
+driver.
+.It Va loc
+Connector physical location.
+Can be specified as a number from 0 to 63.
+This is a reference only value.
+It is ignored by the
+.Nm
+driver.
+.It Va misc
+Misc bits.
+Can be specified as a number from 0 to 15.
+Bit 0 has a special meaning.  When set it means that jack detection is
+not implemented in hardware.
+.El
 .Ss Runtime Configuration
 The following
 .Xr sysctl 8
 variables are available in addition to those available to all
 .Xr sound 4
 devices:
-.Bl -tag -width ".Va dev.pcm.%d.polling" -offset indent
-.It Va dev.pcm.%d.polling
-Experimental polling mode, where the driver operates by querying the device
-state on each tick using
-.Xr callout 9 .
+.Bl -tag -width ".Va dev.hdaa.%d.nid%d_original" -offset indent
+.It Va dev.hdac.%d.pindump
+Setting this to a non-zero value dumps the current pin configuration, main
+capabilities and jack sense status of all audio functions on the controller
+to console and syslog.
+.It Va dev.hdac.%d.polling
+Enables polling mode.
+In this mode the driver operates by querying the device state on timer
+ticks using
+.Xr callout 9
+instead of interrupts.
 Polling is disabled by default.
 Do not enable it unless you are facing weird interrupt problems or if the
 device cannot generate interrupts at all.
+.It Va dev.hdaa.%d.config
+Run-time equivalent of the
+.Va hint.hdaa.%d.config
+tunable.
+.It Va dev.hdaa.%d.gpi_state
+Current state of GPI lines.
+.It Va dev.hdaa.%d.gpio_state
+Current state of GPIO lines.
+.It Va dev.hdaa.%d.gpio_config
+Run-time equivalent of the
+.Va hint.hdaa.%d.gpio.config
+tunable.
+.It Va dev.hdaa.%d.gpo_state
+Current state of GPO lines.
+.It Va dev.hdaa.%d.nid%d_config
+Run-time equivalent of the
+.Va hint.hdaa.%d.nid%d.config
+tunable.
+.It Va dev.hdaa.%d.nid%d_original
+Original pin configuration written by BIOS.
+.It Va dev.hdaa.%d.reconfig
+Setting this to a non-zero value makes driver to destroy existing pcm devices
+and process new pins configuration set via
+.Va dev.hdaa.%d.nid%d_config .
+.It Va dev.pcm.%d.play.32bit , dev.pcm.%d.rec.32bit
+HDA controller uses 32bit representation for all samples of more then 16 bits.
+These variables allow to specify how many bits of these 32 should be
+used by CODEC.
+Depending on codec capabilities, possible values are 20, 24 and 32 bit.
+The default value is 24.
+.It Va dev.pcm.%d.rec.autosrc
+Run-time equivalent of the
+.Va hint.pcm.%d.rec.autosrc
+tunable.
 .El
-.Sh LOADER TUNABLES
-.Bl -tag -width indent
-.It Va hw.snd.hdac.msi.enable
-By default, the driver will use MSI if it is supported.
-This behavior can be turned off by setting this tunable to 0.
+.Sh EXAMPLES
+Taking HP Compaq DX2300 with Realtek ALC888 HDA codec for example.
+This system has two audio connectors on a front side, three audio connectors
+on a rear side and one internal speaker.
+According to verbose driver output and the codec datasheet,
+this codec has five stereo DACs and two stereo ADCs, all of them are routable to
+any codec pin (external connector).
+All codec pins are reversible (could be configured either as input or output).
+.Pp
+So high codec uniformity and flexibility allow driver to configure it in many
+different ways, depending on requested pins usage described by pins configuration.
+The driver reports such default pin configuration when verbose messages enabled:
+.Bd -literal
+hdaa0: nid   0x    as seq device       conn  jack    loc        color   misc
+hdaa0: 20 01014020 2  0  Line-out      Jack  1/8     Rear       Green   0
+hdaa0: 21 99130110 1  0  Speaker       Fixed ATAPI   Onboard    Unknown 1
+hdaa0: 22 411111f0 15 0  Speaker       None  1/8     Rear       Black   1 DISA
+hdaa0: 23 411111f0 15 0  Speaker       None  1/8     Rear       Black   1 DISA
+hdaa0: 24 01a19830 3  0  Mic           Jack  1/8     Rear       Pink    8
+hdaa0: 25 02a1983f 3  15 Mic           Jack  1/8     Front      Pink    8
+hdaa0: 26 01813031 3  1  Line-in       Jack  1/8     Rear       Blue    0
+hdaa0: 27 0221401f 1  15 Headphones    Jack  1/8     Front      Green   0
+hdaa0: 28 411111f0 15 0  Speaker       None  1/8     Rear       Black   1 DISA
+hdaa0: 30 411111f0 15 0  Speaker       None  1/8     Rear       Black   1 DISA
+hdaa0: 31 411111f0 15 0  Speaker       None  1/8     Rear       Black   1 DISA
+.Ed
+.Pp
+Here we can see, that the nodes with ID (nid) 25 and 27 are front panel
+connectors (Jack, Front), nids 20, 24 and 26 are rear panel connectors
+(Jack, Rear) and nid 21 is a built-in speaker (Fixed, Onboard).
+Pins with nids 22, 23, 28, 30 and 31 will be disabled by driver due to "None"
+connectivity. So the pin count and description matches to connectors that
+we have.
+.Pp
+Using association (as) and sequence (seq) fields values pins are grouped into
+3 associations:
+.Bd -literal
+hdaa0: Association 0 (1) out:
+hdaa0:   Pin nid=21 seq=0
+hdaa0:   Pin nid=27 seq=15
+hdaa0: Association 1 (2) out:
+hdaa0:   Pin nid=20 seq=0
+hdaa0: Association 2 (3) in:
+hdaa0:   Pin nid=24 seq=0
+hdaa0:   Pin nid=26 seq=1
+hdaa0:   Pin nid=25 seq=15
+.Ed
+.Pp
+Each
+.Xr pcm 4
+device uses two associations: one for playback and one for recording.
+Associations processed and assigned to
+.Xr pcm 4
+devices in increasing numerical order.
+In this case association #0 (1) will become
+.Li pcm0
+device playback, using the internal speakers and
+.Ar Headphones
+jack with speaker automute on the headphones jack connection.
+Association #1 (2) will become
+.Li pcm1
+playback, using the
+.Ar Line-out
+jack.
+Association #2 (3) will become
+.Li pcm0
+recording, using the external microphones and the
+.Ar Line-in
+jack.
+.Pp
+The
+.Nm
+driver provides extensive verbose messages to diagnose its operation
+logic and describe its current codec configuration.
+.Pp
+Using
+.Xr device.hints 5
+it is possible to modify the configuration of the existing pins,
+allowing a broad range of different audio setups.
+Here are a few examples of some setups possible for this particular
+hardware:
+.Ss Example 1
+Setting the
+.Xr device.hints 5
+options
+.Bd -literal
+hint.hdac.0.cad0.nid20.config="as=1"
+hint.hdac.0.cad0.nid21.config="as=2"
+.Ed
+.Pp
+will swap line-out and speaker functions.
+So the
+.Li pcm0
+device will play to the line-out and headphones jacks. Line-out will
+be muted on the headphones jack connection.
+Recording on
+.Li pcm0
+will go from two external microphones and line-in jacks.
+.Li pcm1
+playback will go to the internal speaker.
+.Ss Example 2
+Setting the
+.Xr device.hints 5
+options
+.Bd -literal
+hint.hdac.0.cad0.nid20.config="as=1 seq=15 device=Headphones"
+hint.hdac.0.cad0.nid27.config="as=2 seq=0"
+hint.hdac.0.cad0.nid25.config="as=4 seq=0"
+.Ed
+.Pp
+will split the headphones and one of the microphones to a separate device.
+The
+.Li pcm0
+device will play to the internal speaker and to the line-out jack, with
+speaker automute on the line-out jack connection.
+Recording on
+.Li pcm0
+will use input from one external microphone and the line-in jacks.
+The
+.Li pcm1
+device will be completely dedicated to a headset (headphones and mic)
+connected to the front connectors.
+.Ss Example 3
+Setting the
+.Xr device.hints 5
+options
+.Bd -literal
+hint.hdac.0.cad0.nid20.config="as=1 seq=0"
+hint.hdac.0.cad0.nid26.config="as=2 seq=0"
+hint.hdac.0.cad0.nid27.config="as=3 seq=0"
+hint.hdac.0.cad0.nid25.config="as=4 seq=0"
+hint.hdac.0.cad0.nid24.config="as=5 seq=0 device=Line-out"
+hint.hdac.0.cad0.nid21.config="as=6 seq=0"
+.Ed
+.Pp
+will give 4 independent devices:
+.Li pcm0
+.Pq line-out and line-in ,
+.Li pcm1
+.Pq headphones and mic ,
+.Li pcm2
+.Pq additional line-out via retasked rear mic jack ,
+and
+.Li pcm3
+.Pq internal speaker .
+.Ss Example 4
+Setting the
+.Xr device.hints 5
+options
+.Bd -literal
+hint.hdac.0.cad0.nid20.config="as=1 seq=0"
+hint.hdac.0.cad0.nid24.config="as=1 seq=1 device=Line-out"
+hint.hdac.0.cad0.nid26.config="as=1 seq=2 device=Line-out"
+hint.hdac.0.cad0.nid21.config="as=2 seq=0"
+.Ed
+.Pp
+will give 2 devices:
+.Li pcm0
+for 5.1 playback via 3 rear connectors (line-out and retasked
+mic and line-in) and headset (headphones and mic) at front connectors.
+.Li pcm1
+for internal speaker playback.
+On headphones connection rear connectors will be muted.
+.Sh MIXER CONTROLS
+Depending on codec configuration, these controls and signal sources could be
+reported to
+.Xr sound 4 :
+.Bl -tag -width ".Va speaker" -offset indent
+.It Va vol
+overall output level (volume)
+.It Va rec
+overall recording level
+.It Va igain
+input-to-output monitoring loopback level
+.It Va ogain
+external amplifier control
+.It Va pcm
+PCM playback
+.It Va mix
+input mix
+.It Va mic
+first external or second internal microphone input
+.It Va monitor
+first internal or second external microphone input
+.It Va line , Va line1 , Va line2, Va line3
+analog (line) inputs
+.It Va dig1 , Va dig2 , Va dig3
+digital (S/PDIF, HDMI or DisplayPort) inputs
+.It Va cd
+CD input
+.It Va speaker
+PC speaker input
+.It Va phin , Va phout , Va radio . Va video
+other random inputs
 .El
+.Pp
+Controls have different precision. Some could be just an on/off triggers.
+Most of controls use logarithmic scale.
 .Sh HARDWARE
 The
 .Nm
-driver supports the following audio chipsets:
-.Pp
-.Bl -bullet -compact
-.It
-ATI SB450
-.It
-ATI SB600
-.It
-Intel 631x/632xESB
-.It
-Intel 82801F
-.It
-Intel 82801G
-.It
-Intel 82801H
-.It
-nVidia MCP51
-.It
-nVidia MCP55
-.It
-nVidia MCP61A
-.It
-nVidia MCP61B
-.It
-nVidia MCP65A
-.It
-nVidia MCP65B
-.It
-SiS 966
-.It
-VIA VT8251/8237A
-.El
+driver supports controllers having PCI class 4 (multimedia) and
+subclass 3 (HDA), compatible with Intel HDA specification.
 .Pp
-Generic audio chipsets compatible with the Intel HDA specification should work,
-but have not been verified yet.
-The following codecs have been verified to work:
-.Pp
-.Bl -bullet -compact
-.It
-Analog Device AD1981HD
-.It
-Analog Device AD1983
-.It
-Analog Device AD1986A
-.It
-Analog Device AD1988
-.It
-CMedia CMI9880
-.It
-Conexant Venice
-.It
-Conexant Waikiki
-.It
-Realtek ALC260
-.It
-Realtek ALC262
-.It
-Realtek ALC861
-.It
-Realtek ALC861VD
-.It
-Realtek ALC880
-.It
-Realtek ALC882
-.It
-Realtek ALC883
-.It
-Realtek ALC885
-.It
-Realtek ALC888
-.It
-Sigmatel STAC9220
-.It
-Sigmatel STAC9220D/9223D
-.It
-Sigmatel STAC9221
-.It
-Sigmatel STAC9221D
-.It
-Sigmatel STAC9227
-.It
-Sigmatel STAC9271D
-.It
-VIA VT1708
-.It
-VIA VT1709
-.El
+The
+.Nm
+driver supports more than two hundred different controllers and CODECs.
+There is no sense to list all of them here, as in most cases specific CODEC
+configuration and wiring are more important then type of the CODEC itself.
 .Sh SEE ALSO
+.Xr snd_ich 4 ,
 .Xr sound 4 ,
+.Xr device.hints 5 ,
 .Xr loader.conf 5 ,
 .Xr sysctl 8
 .Sh HISTORY
 The
 .Nm
 device driver first appeared in
-.Fx 7.0 .
+.Fx 6.3 .
 .Sh AUTHORS
 .An -nosplit
 The
 .Nm
 driver was written by
-.An Stephane E. Potvin Aq Mt sepotvin@videotron.ca
+.An Stephane E. Potvin Aq Mt sepotvin@videotron.ca ,
+.An Ariff Abdullah Aq Mt ariff@FreeBSD.org
 and
-.An Ariff Abdullah Aq Mt ariff@FreeBSD.org .
+.An Alexander Motin Aq Mt mav@FreeBSD.org .
 This manual page was written by
-.An Joel Dahl Aq Mt joel@FreeBSD.org .
+.An Joel Dahl Aq Mt joel@FreeBSD.org ,
+.An Alexander Motin Aq Mt mav@FreeBSD.org
+and
+.An Giorgos Keramidas Aq Mt keramida@FreeBSD.org .
 .Sh BUGS
-There are a couple of missing features, such as support for Digital
-S/PDIF and multichannel output.
-.Pp
-A few Hardware/OEM vendors tend to screw up BIOS settings, thus
-rendering the
-.Nm
-driver useless, which usually results in a state where the
+Some Hardware/OEM vendors tend to screw up BIOS settings or use custom
+unusual CODEC wiring that create problems to the driver.
+This may result in missing pcm devices, or a state where the
 .Nm
-driver seems to attach and work, but without any sound.
+driver seems to attach and work, but no sound is played.
+Some cases can be solved by tuning
+.Pa loader.conf
+variables.
+But before trying to fix problem that way, make sure that there really is
+a problem and that the PCM audio device in use really corresponds to the
+expected audio connector.
+.Pp
+Some vendors use non-standardized General Purpose I/O (GPIO) pins of the codec
+to control external amplifiers.
+In some cases setting a combination of GPIO bits may be needed to make
+sound work on a specific device.
+.Pp
+HDMI and DisplayPort audio may also require support from video driver.
similarity index 79%
copy from share/man/man4/snd_als4000.4
copy to share/man/man4/snd_hdspe.4
index ed3b340..941a488 100644 (file)
@@ -1,4 +1,4 @@
-.\" Copyright (c) 2004 Atte Peltomaki
+.\" Copyright (c) 2012 Ruslan Bukin <br@bsdpad.com>
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_als4000.4,v 1.4.2.1 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_hdspe.4 235317 2012-05-12 03:25:46Z gjb $
 .\"
-.Dd December 15, 2005
-.Dt SND_ALS4000 4
+.Dd January 8, 2015
+.Dt SND_HDSPE 4
 .Os
 .Sh NAME
-.Nm snd_als4000
-.Nd "Avance Logic ALS4000 PCI bridge device driver"
+.Nm snd_hdspe
+.Nd "RME HDSPe bridge 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 pcm"
-.Cd "device snd_als4000"
+.Cd "device sound"
+.Cd "device snd_hdspe"
 .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_als4000_load="YES"
+snd_hdspe_load="YES"
 .Ed
 .Sh DESCRIPTION
 The
 .Nm
 bridge driver allows the generic audio driver
 .Xr sound 4
-to attach to the ALS4000 sound card.
+to attach to RME HDSPe audio devices.
 .Sh HARDWARE
 The
 .Nm
-driver supports the following sound cards:
+driver supports the following audio devices:
 .Pp
 .Bl -bullet -compact
 .It
-Avance Logic ALS4000
+RME HDSPe AIO
+.It
+RME HDSPe RayDAT
 .El
 .Sh SEE ALSO
 .Xr sound 4
@@ -65,6 +67,10 @@ Avance Logic ALS4000
 The
 .Nm
 device driver first appeared in
-.Fx 4.4 .
+.Fx 10.0 .
 .Sh AUTHORS
-.An Orion Hodson Aq Mt oho@acm.org
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Ruslan Bukin <br@bsdpad.com> .
index f6f1679..f130f96 100644 (file)
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_ich.4,v 1.6.2.2 2006/06/21 04:28:05 brueffer Exp $
+.\" $FreeBSD: head/share/man/man4/snd_ich.4 275990 2014-12-21 09:53:29Z brueffer $
 .\"
-.Dd December 15, 2005
+.Dd January 8, 2015
 .Dt SND_ICH 4
 .Os
 .Sh NAME
 .Nm snd_ich
-.Nd "Intel ICH PCI and compatible bridge device driver"
+.Nd "Intel ICH AC'97 and compatible bridge 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 pcm"
+.Cd "device sound"
 .Cd "device snd_ich"
 .Ed
 .Pp
@@ -49,7 +49,12 @@ The
 .Nm
 bridge driver allows the generic audio driver
 .Xr sound 4
-to attach to Intel ICH and compatible audio devices.
+to attach to Intel ICH AC'97 and compatible audio devices.
+.Pp
+Some later chips, like ICH6/ICH7, depending on wiring can instead implement
+newer Intel HD Audio specification, which is supported by
+.Xr snd_hda 4
+driver.
 .Sh HARDWARE
 The
 .Nm
@@ -94,6 +99,7 @@ NVIDIA nForce4
 SiS 7012
 .El
 .Sh SEE ALSO
+.Xr snd_hda 4 ,
 .Xr sound 4
 .Sh HISTORY
 The
index 67318e1..8e01922 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_maestro.4,v 1.1.2.1 2004/12/21 15:06:33 simon Exp $
+.\" $FreeBSD: head/share/man/man4/snd_maestro.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 15, 2005
+.Dd January 8, 2015
 .Dt SND_MAESTRO 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_maestro"
 .Ed
 .Pp
index 70bb4f2..912bf9b 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_neomagic.4,v 1.3.4.1 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_neomagic.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 1, 2005
+.Dd January 8, 2015
 .Dt SND_NEOMAGIC 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_neomagic"
 .Ed
 .Pp
index 873c74d..0304088 100644 (file)
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_solo.4,v 1.4.2.1 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_solo.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd February 10, 2013
+.Dd January 8, 2015
 .Dt SND_SOLO 4
 .Os
 .Sh NAME
 .Nm snd_solo
 .Nd "ESS Solo-1/1E PCI bridge device driver"
 .Sh SYNOPSIS
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_solo"
 .Sh DESCRIPTION
 The
index 2b81644..863eec0 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_spicds.4,v 1.2.2.1 2007/05/15 18:40:22 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_spicds.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd September 30, 2006
+.Dd January 8, 2015
 .Dt SND_SPICDS 4
 .Os
 .Sh NAME
@@ -59,6 +59,8 @@ AK4358
 .It
 AK4381
 .It
+AK4396
+.It
 AK4524
 .It
 AK4528
@@ -73,7 +75,7 @@ WM8770
 The
 .Nm
 device driver first appeared in
-.Fx 7.0 .
+.Fx 6.3 .
 .Sh AUTHORS
 .An -nosplit
 The
index 8d0fa7c..51a1c63 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_t4dwave.4,v 1.1.2.2 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_t4dwave.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 1, 2005
+.Dd January 8, 2015
 .Dt SND_T4DWAVE 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_t4dwave"
 .Ed
 .Pp
index 51eb764..929ddd0 100644 (file)
@@ -29,7 +29,7 @@
 .\"
 .\" $FreeBSD: head/share/man/man4/snd_uaudio.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd November 10, 2014
+.Dd January 8, 2015
 .Dt SND_UAUDIO 4
 .Os
 .Sh NAME
@@ -39,7 +39,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device usb"
 .Cd "device snd_uaudio"
 .Ed
index e9326e0..596c097 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_via8233.4,v 1.2.2.1.2.1 2006/04/26 18:46:12 brueffer Exp $
+.\" $FreeBSD: head/share/man/man4/snd_via8233.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd April 25, 2006
+.Dd January 8, 2015
 .Dt SND_VIA8233 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_via8233"
 .Ed
 .Pp
@@ -52,6 +52,21 @@ bridge driver allows the generic audio driver,
 to attach to the VIA VT8233 audio devices.
 These audio chipsets are integrated in the southbridge on many VIA based
 motherboards.
+.Ss Runtime Configuration
+The following
+.Xr sysctl 8
+variables are available in addition to those available to all
+.Xr sound 4
+devices:
+.Bl -tag -width ".Va dev.pcm.%d.polling" -offset indent
+.It Va dev.pcm.%d.polling
+Experimental polling mode, where the driver operates by querying the device
+state on each tick using
+.Xr callout 9 .
+Polling is disabled by default.
+Do not enable it unless you are facing weird interrupt problems or if the
+device cannot generate interrupts at all.
+.El
 .Sh HARDWARE
 The
 .Nm
index 72534fb..ec5e85e 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_via82c686.4,v 1.1.4.1 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_via82c686.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 1, 2005
+.Dd January 8, 2015
 .Dt SND_VIA82C686 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_via82c686"
 .Ed
 .Pp
index 843f1c8..c8b13f0 100644 (file)
@@ -22,9 +22,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/snd_vibes.4,v 1.1.4.1 2006/01/09 12:48:39 joel Exp $
+.\" $FreeBSD: head/share/man/man4/snd_vibes.4 267938 2014-06-26 21:46:14Z bapt $
 .\"
-.Dd December 1, 2005
+.Dd January 8, 2015
 .Dt SND_VIBES 4
 .Os
 .Sh NAME
@@ -34,7 +34,7 @@
 To compile this driver into the kernel, place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device pcm"
+.Cd "device sound"
 .Cd "device snd_vibes"
 .Ed
 .Pp