1.\" $NetBSD: hdaudio.4,v 1.14 2014/09/19 17:27:12 christos Exp $ 2.\" 3.\" Copyright (c) 2009, 2010 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Precedence Technologies Ltd 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd September 19, 2014 31.Dt HDAUDIO 4 32.Os 33.Sh NAME 34.Nm hdaudio 35.Nd High Definition Audio device driver 36.Sh SYNOPSIS 37.Cd "hdaudio* at pci? dev ? function ?" 38.Cd "hdafg* at hdaudiobus?" 39.Cd "audio* at audiobus?" 40.Pp 41.Cd "options HDAUDIOVERBOSE" 42.Cd "options HDAUDIO_DEBUG" 43.Cd "options HDAFG_DEBUG" 44.Sh DESCRIPTION 45The 46.Nm 47device driver is expected to support any PCI device which is 48compliant to the High Definition Audio Specification 1.0. 49It is a replacement for 50.Xr azalia 4 . 51It was written from scratch following the Intel HD Audio and Microsoft 52Universal Audio Architecture specifications. 53.Pp 54The driver consists of two interlinked components, which reflects the 55hardware design. 56The 57.Nm 58component interfaces with a PCI/PCIe bus and provides an 59.Xr hdaudiobus 4 60onto which different function groups attach. 61Each function group (e.g. audio, vendor-specific modem) is exported as a 62separate child device of the 63.Nm 64controller. 65Audio function groups (a.k.a. audio codec) are exported as 66.Xr hdafg 4 67devices. 68.Pp 69Audio codecs are available from a number of manufacturers and are made up of a 70number of widgets (e.g. audio mixer, output pin, analog-to-digital converter). 71The way the widgets are interlinked varies significantly between 72implementations. 73The tree of widgets must be parsed and mapped to 74.Xr mixer 4 75controls. 76As part of this process, loops in the inter-codec links must be detected 77and muted, bi-directional pins must be set up appropriately and the locations 78of pins determined. 79Unlike the 80.Xr azalia 4 81driver (which tends to generate a large number of unclearly named 82.Xr mixer 4 83controls), 84.Nm 85works backwards by starting with a list of desired, consistent and compatible 86.Xr mixer 4 87controls and configuring/discovering appropriate widget link routes to fit. 88.Pp 89By following the published mechanisms for common implementations of widget 90parsing, it is expected that nearly all High Definition Audio devices will 91be supported without requiring per-device quirks. 92.Sh HARDWARE 93In addition to many on-board sound cards included in mainboards, the following 94add-on card is supported: 95.Bl -tag 96.It TerraTec Aureon 7.1 PCIe 97.El 98.Sh SEE ALSO 99.Xr audio 4 , 100.Xr mixer 4 , 101.Xr pci 4 , 102.Xr hdaudioctl 8 , 103.Pp 104.Lk http://www.intel.com/design/chipsets/hdaudio.htm "Intel High Definition Audio" 105.Pp 106.Lk http://www.microsoft.com/whdc/device/audio/ "Audio Device Technologies for Windows" 107.Sh HISTORY 108The 109.Nm 110device driver appeared in 111.Nx 5.1 . 112.Sh AUTHORS 113The 114.Nm 115driver was written by 116.An Jared McNeill Aq Mt jmcneill@NetBSD.org 117under contract by 118.Lk http://www.precedence.co.uk/ "Precedence Technologies Ltd." 119The UAA-compliant widget parser is derived from the 120.Fx 121snd_hda(4) driver. 122.Sh BUGS 123The following items are not yet implemented: 124.Bl -bullet 125.It 126Improve power management support when driver is idle 127.It 128Add support for non-PCM output formats 129.It 130Handle unsolicited RIRB messages 131.It 132Modem function groups 133.El 134