xref: /freebsd/share/man/man4/snd_uaudio.4 (revision cf7d8dea39cb00887476ad1a42480bce00b0b842)
1.\" $NetBSD: uaudio.4,v 1.15 2002/02/12 19:53:57 jdolecek Exp $
2.\"
3.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Lennart Augustsson.
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.\" $FreeBSD$
31.\"
32.Dd December 15, 2005
33.Dt SND_UAUDIO 4
34.Os
35.Sh NAME
36.Nm snd_uaudio
37.Nd USB audio device driver
38.Sh SYNOPSIS
39To compile this driver into the kernel, place the following lines in your
40kernel configuration file:
41.Bd -ragged -offset indent
42.Cd "device sound"
43.Cd "device usb"
44.Cd "device snd_uaudio"
45.Ed
46.Pp
47Alternatively, to load the driver as a module at boot time, place the
48following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51snd_uaudio_load="YES"
52.Ed
53.Sh DESCRIPTION
54The
55.Nm
56driver provides support for
57.Tn USB
58audio class devices.
59.Pp
60A
61.Tn USB
62audio device consists of a number of components:
63input terminals (e.g.\& USB digital input), output terminals (e.g.\&
64speakers), and a number of units in between (e.g.\& volume control).
65.Pp
66Refer to the
67.Ql USB Audio Class Specification
68for more information.
69.Sh SEE ALSO
70.Xr sound 4 ,
71.Xr usb 4
72.Rs
73.%T "USB Audio Class Specifications"
74.%U http://www.usb.org/developers/devclass_docs/
75.Re
76.Sh HISTORY
77The
78.Nm
79driver first appeared in
80.Fx 4.7 .
81.Sh AUTHORS
82This manual page was adopted from
83.Nx 1.6
84and modified for
85.Fx
86by
87.An Hiten Pandya Aq hmp@FreeBSD.org .
88.Sh BUGS
89The
90.Tn PCM
91framework in
92.Fx ,
93as of this writing, does not handle device un-registrations in a properly
94abstracted manner, i.e., a detach request is refused by the
95.Tn PCM
96framework if the device is in use.
97For
98.Tn USB
99and supposedly other detach-able busses, it is necessary to allow the
100device un-registration to complete successfully, otherwise the driver
101leaves wild pointers to invalid data structures and thus leading to a panic.
102