d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f6e633a9e1
freebsd-nq/share/man/man4/snd_uaudio.4

103 lines
3.0 KiB
Groff
Raw Normal View History

Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.\" $NetBSD: uaudio.4,v 1.15 2002/02/12 19:53:57 jdolecek Exp $
.\"
.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Lennart Augustsson.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
Protect "e.g." from being interpreted as end of sentence.
2004-07-08 12:36:20 +00:00
.\" $FreeBSD$
.\"
- Add missing xhci(4) manual page. - Minor update in some USB manual pages. MFC after: 3 days Approved by: thompsa (mentor)
2011-02-24 18:08:23 +00:00
.Dd February 24, 2011
Update sound-related manpages to account for the recent change in device and module naming. The following files were repo-copied: csa.4 -> snd_csa.4 gusc.4 -> snd_gusc.4 maestro3.4 -> snd_maestro3.4 sbc.4 -> snd_sbc.4 uaudio.4 -> snd_uaudio.4 The pcm(4) manpage wasn't renamed to sound(4) as there are nearby plans to rename "device sound" to "device snd", to address the ambiguity in naming, so pcm.4 is linked to sound.4 for the moment. (We also mumble something about the future plans in the manpage.) Removed links from pcm.4 to als4000.4 and emu10k1.4 -- they now have their own snd_*.4 manpages. Fixes for recent snd_*.4 manpages: added missing "device sound" to the SYNOPSIS, fixed hints (they are still "hint.pcm.<unit>" in most cases). MT5 after: 3 days
2004-09-08 08:28:02 +00:00
.Dt SND_UAUDIO 4
Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.Os
.Sh NAME
Update sound-related manpages to account for the recent change in device and module naming. The following files were repo-copied: csa.4 -> snd_csa.4 gusc.4 -> snd_gusc.4 maestro3.4 -> snd_maestro3.4 sbc.4 -> snd_sbc.4 uaudio.4 -> snd_uaudio.4 The pcm(4) manpage wasn't renamed to sound(4) as there are nearby plans to rename "device sound" to "device snd", to address the ambiguity in naming, so pcm.4 is linked to sound.4 for the moment. (We also mumble something about the future plans in the manpage.) Removed links from pcm.4 to als4000.4 and emu10k1.4 -- they now have their own snd_*.4 manpages. Fixes for recent snd_*.4 manpages: added missing "device sound" to the SYNOPSIS, fixed hints (they are still "hint.pcm.<unit>" in most cases). MT5 after: 3 days
2004-09-08 08:28:02 +00:00
.Nm snd_uaudio
- Add missing xhci(4) manual page. - Minor update in some USB manual pages. MFC after: 3 days Approved by: thompsa (mentor)
2011-02-24 18:08:23 +00:00
.Nd USB audio and MIDI device driver
Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.Sh SYNOPSIS
Make the SYNOPSIS section a bit more informative.
2005-12-15 20:25:41 +00:00
To compile this driver into the kernel, place the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
Update sound-related manpages to account for the recent change in device and module naming. The following files were repo-copied: csa.4 -> snd_csa.4 gusc.4 -> snd_gusc.4 maestro3.4 -> snd_maestro3.4 sbc.4 -> snd_sbc.4 uaudio.4 -> snd_uaudio.4 The pcm(4) manpage wasn't renamed to sound(4) as there are nearby plans to rename "device sound" to "device snd", to address the ambiguity in naming, so pcm.4 is linked to sound.4 for the moment. (We also mumble something about the future plans in the manpage.) Removed links from pcm.4 to als4000.4 and emu10k1.4 -- they now have their own snd_*.4 manpages. Fixes for recent snd_*.4 manpages: added missing "device sound" to the SYNOPSIS, fixed hints (they are still "hint.pcm.<unit>" in most cases). MT5 after: 3 days
2004-09-08 08:28:02 +00:00
.Cd "device sound"
Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.Cd "device usb"
Update sound-related manpages to account for the recent change in device and module naming. The following files were repo-copied: csa.4 -> snd_csa.4 gusc.4 -> snd_gusc.4 maestro3.4 -> snd_maestro3.4 sbc.4 -> snd_sbc.4 uaudio.4 -> snd_uaudio.4 The pcm(4) manpage wasn't renamed to sound(4) as there are nearby plans to rename "device sound" to "device snd", to address the ambiguity in naming, so pcm.4 is linked to sound.4 for the moment. (We also mumble something about the future plans in the manpage.) Removed links from pcm.4 to als4000.4 and emu10k1.4 -- they now have their own snd_*.4 manpages. Fixes for recent snd_*.4 manpages: added missing "device sound" to the SYNOPSIS, fixed hints (they are still "hint.pcm.<unit>" in most cases). MT5 after: 3 days
2004-09-08 08:28:02 +00:00
.Cd "device snd_uaudio"
Make the SYNOPSIS section a bit more informative.
2005-12-15 20:25:41 +00:00
.Ed
.Pp
Alternatively, to load the driver as a module at boot time, place the
following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
snd_uaudio_load="YES"
.Ed
Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.Sh DESCRIPTION
The
.Nm
driver provides support for
.Tn USB
- Add missing xhci(4) manual page. - Minor update in some USB manual pages. MFC after: 3 days Approved by: thompsa (mentor)
2011-02-24 18:08:23 +00:00
audio class devices and
.Tn USB
MIDI class devices.
Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.Pp
A
.Tn USB
audio device consists of a number of components:
Protect "e.g." from being interpreted as end of sentence.
2004-07-08 12:36:20 +00:00
input terminals (e.g.\& USB digital input), output terminals (e.g.\&
Mechanically kill hard sentence breaks and double whitespaces.
2004-07-03 18:29:24 +00:00
speakers), and a number of units in between (e.g.\& volume control).
Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.Pp
Refer to the
.Ql USB Audio Class Specification
for more information.
.Sh SEE ALSO
Update sound-related manpages to account for the recent change in device and module naming. The following files were repo-copied: csa.4 -> snd_csa.4 gusc.4 -> snd_gusc.4 maestro3.4 -> snd_maestro3.4 sbc.4 -> snd_sbc.4 uaudio.4 -> snd_uaudio.4 The pcm(4) manpage wasn't renamed to sound(4) as there are nearby plans to rename "device sound" to "device snd", to address the ambiguity in naming, so pcm.4 is linked to sound.4 for the moment. (We also mumble something about the future plans in the manpage.) Removed links from pcm.4 to als4000.4 and emu10k1.4 -- they now have their own snd_*.4 manpages. Fixes for recent snd_*.4 manpages: added missing "device sound" to the SYNOPSIS, fixed hints (they are still "hint.pcm.<unit>" in most cases). MT5 after: 3 days
2004-09-08 08:28:02 +00:00
.Xr sound 4 ,
Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.Xr usb 4
.Rs
.%T "USB Audio Class Specifications"
Use the newly brought %U macro.
2010-01-15 16:01:22 +00:00
.%U http://www.usb.org/developers/devclass_docs/
Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.Re
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 4.7 .
.Sh AUTHORS
This manual page was adopted from
.Nx 1.6
and modified for
.Fx
by
.An Hiten Pandya Aq hmp@FreeBSD.org .
.Sh BUGS
The
.Tn PCM
framework in
.Fx ,
as of this writing, does not handle device un-registrations in a properly
Mechanically kill hard sentence breaks and double whitespaces.
2004-07-03 18:29:24 +00:00
abstracted manner, i.e., a detach request is refused by the
Add a manual page for the USB Audio support in FreeBSD, interfaced via the PCM framework. This manual page was obtained from NetBSD, and the required changes were made to adapt it to our uaudio driver. Pre-cursor review: joe@
2003-11-10 20:25:40 +00:00
.Tn PCM
framework if the device is in use.
- Add missing xhci(4) manual page. - Minor update in some USB manual pages. MFC after: 3 days Approved by: thompsa (mentor)
2011-02-24 18:08:23 +00:00
It is necessary to allow the device un-registration to complete
successfully, otherwise the
.Tn PCM
layer will panic.
Reference in New Issue Copy Permalink