share/man/man4/snd_uaudio.4

   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 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"        This product includes software developed by the NetBSD
  20 .\"        Foundation, Inc. and its contributors.
  21 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  22 .\"    contributors may be used to endorse or promote products derived
  23 .\"    from this software without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  26 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 .\" POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd August 28, 2004
  40 .Dt SND_UAUDIO 4
  41 .Os
  42 .Sh NAME
  43 .Nm snd_uaudio
  44 .Nd USB audio device driver
  45 .Sh SYNOPSIS
  46 .Cd "device sound"
  47 .Cd "device usb"
  48 .Cd "device snd_uaudio"
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver provides support for
  53 .Tn USB
  54 audio class devices.
  55 .Pp
  56 A
  57 .Tn USB
  58 audio device consists of a number of components:
  59 input terminals (e.g.\& USB digital input), output terminals (e.g.\&
  60 speakers), and a number of units in between (e.g.\& volume control).
  61 .Pp
  62 Refer to the
  63 .Ql USB Audio Class Specification
  64 for more information.
  65 .Sh SEE ALSO
  66 .Xr sound 4 ,
  67 .Xr usb 4
  68 .Rs
  69 .%T "USB Audio Class Specifications"
  70 .%O http://www.usb.org/developers/devclass_docs/
  71 .Re
  72 .Sh HISTORY
  73 The
  74 .Nm
  75 driver first appeared in
  76 .Fx 4.7 .
  77 .Sh AUTHORS
  78 This manual page was adopted from
  79 .Nx 1.6
  80 and modified for
  81 .Fx
  82 by
  83 .An Hiten Pandya Aq hmp@FreeBSD.org .
  84 .Sh BUGS
  85 The
  86 .Tn PCM
  87 framework in
  88 .Fx ,
  89 as of this writing, does not handle device un-registrations in a properly
  90 abstracted manner, i.e., a detach request is refused by the
  91 .Tn PCM
  92 framework if the device is in use.
  93 For
  94 .Tn USB
  95 and supposedly other detach-able busses, it is necessary to allow the
  96 device un-registration to complete successfully, otherwise the driver
  97 leaves wild pointers to invalid data structures and thus leading to a panic.