Say hello to a sound system update from FreeBSD. This includes the long
[dragonfly.git] / share / man / man4 / snd_es137x.4
1 .\" Copyright (c) 2004 Atte Peltomaki
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/share/man/man4/snd_es137x.4,v 1.9 2006/11/29 17:07:02 joel Exp $
26 .\" $DragonFly: src/share/man/man4/snd_es137x.4,v 1.1 2007/01/04 21:47:00 corecode Exp $
27 .\"
28 .Dd November 29, 2006
29 .Dt SND_ES137X 4
30 .Os
31 .Sh NAME
32 .Nm snd_es137x
33 .Nd "Ensoniq AudioPCI ES137x bridge device driver"
34 .Sh SYNOPSIS
35 To compile this driver into the kernel, place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
38 .Cd "device pcm"
39 .Cd "device snd_es137x"
40 .Ed
41 .Pp
42 Alternatively, to load the driver as a module at boot time, place the
43 following line in
44 .Xr loader.conf 5 :
45 .Bd -literal -offset indent
46 snd_es137x_load="YES"
47 .Ed
48 .Sh DESCRIPTION
49 The
50 .Nm
51 bridge driver allows the generic audio driver
52 .Xr sound 4
53 to attach to the Ensoniq 137x audio cards.
54 .Ss Runtime Configuration
55 The following
56 .Xr sysctl 8
57 variables are available in addition to those available to all
58 .Xr sound 4
59 devices:
60 .Bl -tag -width ".Va hw.snd.pcm%d.latency_timer" -offset indent
61 .It Va hw.snd.pcm%d.latency_timer
62 Controls the PCI latency timer setting.
63 Increasing this value will solve most popping and crackling issues
64 (especially on VIA motherboards).
65 .It Va hw.snd.pcm%d.spdif_enabled
66 Enables S/PDIF output on the primary playback channel.
67 This
68 .Xr sysctl 8
69 variable is available only if the device is known to support S/PDIF output.
70 .It Va dev.pcm.%d.polling
71 Experimental polling mode, where the driver operates by querying the device
72 state on each tick using
73 .Xr callout 9 .
74 Polling is disabled by default.
75 Do not enable it unless you are facing weird interrupt problems or if the
76 device cannot generate interrupts at all.
77 .El
78 .Sh HARDWARE
79 The
80 .Nm
81 driver supports the following sound cards:
82 .Pp
83 .Bl -bullet -compact
84 .It
85 Creative CT5880-A
86 .It
87 Creative CT5880-C
88 .It
89 Creative CT5880-D
90 .It
91 Creative CT5880-E
92 .It
93 Creative SB AudioPCI CT4730
94 .It
95 Ensoniq AudioPCI ES1370
96 .It
97 Ensoniq AudioPCI ES1371-A
98 .It
99 Ensoniq AudioPCI ES1371-B
100 .It
101 Ensoniq AudioPCI ES1373-A
102 .It
103 Ensoniq AudioPCI ES1373-B
104 .It
105 Ensoniq AudioPCI ES1373-8
106 .El
107 .Sh SEE ALSO
108 .Xr sound 4
109 .Sh HISTORY
110 The
111 .Nm
112 device driver first appeared in
113 .Fx 4.0 .
114 .Sh AUTHORS
115 .An "Russell Cattelan" Aq cattelan@thebarn.com
116 .An "Cameron Grant" Aq cg@FreeBSD.org
117 .An "Joachim Kuebart"
118 .An "Jonathan Noack" Aq noackjr@alumni.rice.edu