xref: /freebsd/share/man/man4/snd_hda.4 (revision 0efd6615cd5f39b67cec82a7034e655f3b5801e3)
1.\" Copyright (c) 2006 Joel Dahl <joel@FreeBSD.org>
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$
26.\"
27.Dd December 17, 2006
28.Dt SND_HDA 4
29.Os
30.Sh NAME
31.Nm snd_hda
32.Nd "Intel High Definition Audio bridge device driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel, place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device sound"
38.Cd "device snd_hda"
39.Ed
40.Pp
41Alternatively, to load the driver as a module at boot time, place the
42following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45snd_hda_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50bridge device driver allows the generic audio driver,
51.Xr sound 4 ,
52to attach to Intel High Definition Audio devices.
53The
54.Nm
55driver supports hardware that conforms with revision 1.0 of the Intel High
56Definition Audio specification and tries to behave much like the Microsoft
57Universal Audio Architecture (UAA) draft (revision 0.7b) for handling audio
58devices.
59HDA acts like a primary bus, similar to
60.Xr miibus 4 ,
61for handling various child buses such as audio, modem and HDMI (High Definition
62Multimedia Interface).
63Only audio is implemented in the
64.Nm
65driver.
66.Pp
67The High Definition (HD) Audio specification was developed by Intel as the
68logical successor of the old AC'97 specification and has several advantages,
69such as higher bandwidth which allows more channels and more detailed formats,
70support for several logical audio devices, and general purpose DMA channels.
71.Pp
72The HDA specification defines the register-level interface, physical link
73characteristics, codec programming models, and codec architectural components.
74This specification is intended for both device driver developers and hardware
75component designers.
76.Ss Runtime Configuration
77The following
78.Xr sysctl 8
79variables are available in addition to those available to all
80.Xr sound 4
81devices:
82.Bl -tag -width ".Va dev.pcm.%d.polling" -offset indent
83.It Va dev.pcm.%d.polling
84Experimental polling mode, where the driver operates by querying the device
85state on each tick using
86.Xr callout 9 .
87Polling is disabled by default.
88Do not enable it unless you are facing weird interrupt problems or if the
89device cannot generate interrupts at all.
90.El
91.Sh HARDWARE
92The
93.Nm
94driver supports the following audio chipsets:
95.Pp
96.Bl -bullet -compact
97.It
98ATI SB450
99.It
100ATI SB600
101.It
102Intel 631x/632xESB
103.It
104Intel 82801F
105.It
106Intel 82801G
107.It
108Intel 82801H
109.It
110nVidia MCP51
111.It
112nVidia MCP55
113.It
114nVidia MCP61A
115.It
116nVidia MCP61B
117.It
118nVidia MCP65A
119.It
120nVidia MCP65B
121.It
122SiS 966
123.It
124VIA VT8251/8237A
125.El
126.Pp
127Generic Audio chipsets compatible with the Intel HDA specification should work,
128but have not been verified yet.
129The following codecs have been verified to work:
130.Pp
131.Bl -bullet -compact
132.It
133Analog Device AD1981HD
134.It
135Analog Device AD1983
136.It
137Analog Device AD1986A
138.It
139CMedia CMI9880
140.It
141Conexant Venice
142.It
143Conexant Waikiki
144.It
145Realtek ALC260
146.It
147Realtek ALC861
148.It
149Realtek ALC880
150.It
151Realtek ALC882
152.It
153Realtek ALC883
154.It
155Realtek ALC888
156.It
157Sigmatel STAC9220
158.It
159Sigmatel STAC9220D/9223D
160.It
161Sigmatel STAC9221
162.It
163Sigmatel STAC9221D
164.It
165Sigmatel STAC9227
166.El
167.Sh SEE ALSO
168.Xr sound 4 ,
169.Xr loader.conf 5
170.Sh HISTORY
171The
172.Nm
173device driver first appeared in
174.Fx 7.0 .
175.Sh AUTHORS
176.An -nosplit
177The
178.Nm
179driver was written by
180.An Stephane E. Potvin Aq sepotvin@videotron.ca
181and
182.An Ariff Abdullah Aq ariff@FreeBSD.org .
183This manual page was written by
184.An Joel Dahl Aq joel@FreeBSD.org .
185.Sh BUGS
186There are a couple of missing features, such as support for Digital
187S/PDIF and multichannel output.
188.Pp
189A few Hardware/OEM vendors tend to screw up BIOS settings, thus
190rendering the
191.Nm
192driver useless, which usually results in a state where the
193.Nm
194driver seems to attach and work, but without any sound.
195