d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a61c693265
freebsd-skq/share/man/man4/snd_es137x.4

118 lines
3.4 KiB
Groff
Raw Normal View History

Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days
2004-08-27 22:06:56 +00:00
.\" Copyright (c) 2004 Atte Peltomaki
.\" All rights reserved.
.\"
.\" 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 AUTHOR 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 AUTHOR 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.
.\"
.\" $FreeBSD$
.\"
Add the dev.pcm.%d.polling sysctl and a short description. Reviewed by: ru
2006-11-29 17:07:02 +00:00
.Dd November 29, 2006
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days
2004-08-27 22:06:56 +00:00
.Dt SND_ES137X 4
.Os
.Sh NAME
.Nm snd_es137x
.Nd "Ensoniq AudioPCI ES137x bridge device driver"
.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 manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days
2004-08-27 22:06:56 +00:00
.Cd "device snd_es137x"
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_es137x_load="YES"
.Ed
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days
2004-08-27 22:06:56 +00:00
.Sh DESCRIPTION
The
.Nm
bridge driver allows the generic audio driver
.Xr sound 4
to attach to the Ensoniq 137x audio cards.
Document 2 new sysctl's. Submitted by: Ariff Abdullah <skywizard@MyBSD.org.my> Submitted by: Jonathan Noack <noackjr@alumni.rice.edu> (implicit)
2005-07-31 13:27:52 +00:00
.Ss Runtime Configuration
The following
.Xr sysctl 8
variables are available in addition to those available to all
.Xr sound 4
devices:
.Bl -tag -width ".Va hw.snd.pcm%d.latency_timer" -offset indent
.It Va hw.snd.pcm%d.latency_timer
Controls the PCI latency timer setting.
Increasing this value will solve most popping and crackling issues
(especially on VIA motherboards).
.It Va hw.snd.pcm%d.spdif_enabled
Enables S/PDIF output on the primary playback channel.
This
.Xr sysctl 8
variable is available only if the device is known to support S/PDIF output.
Add the dev.pcm.%d.polling sysctl and a short description. Reviewed by: ru
2006-11-29 17:07:02 +00:00
.It Va dev.pcm.%d.polling
Experimental polling mode, where the driver operates by querying the device
state on each tick using
.Xr callout 9 .
Polling is disabled by default.
Do not enable it unless you are facing weird interrupt problems or if the
device cannot generate interrupts at all.
Document 2 new sysctl's. Submitted by: Ariff Abdullah <skywizard@MyBSD.org.my> Submitted by: Jonathan Noack <noackjr@alumni.rice.edu> (implicit)
2005-07-31 13:27:52 +00:00
.El
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days
2004-08-27 22:06:56 +00:00
.Sh HARDWARE
The
.Nm
soundcard -> sound card MFC after: 3 days
2005-05-22 16:14:55 +00:00
driver supports the following sound cards:
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days
2004-08-27 22:06:56 +00:00
.Pp
.Bl -bullet -compact
.It
Be more specific about supported chipsets. Approved by: brueffer (mentor)
2005-08-18 19:12:14 +00:00
Creative CT5880-A
.It
Creative CT5880-C
.It
Creative CT5880-D
.It
Creative CT5880-E
.It
Creative SB AudioPCI CT4730
.It
Ensoniq AudioPCI ES1370
.It
Ensoniq AudioPCI ES1371-A
.It
Ensoniq AudioPCI ES1371-B
.It
Ensoniq AudioPCI ES1373-A
.It
Ensoniq AudioPCI ES1373-B
.It
Ensoniq AudioPCI ES1373-8
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days
2004-08-27 22:06:56 +00:00
.El
.Sh SEE ALSO
.Xr sound 4
.Sh HISTORY
The
.Nm
No one cares about when the manual page first appeared. Mention when the driver appeared instead.
2005-11-28 18:47:00 +00:00
device driver first appeared in
.Fx 4.0 .
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days
2004-08-27 22:06:56 +00:00
.Sh AUTHORS
.An "Russell Cattelan" Aq cattelan@thebarn.com
.An "Cameron Grant" Aq cg@FreeBSD.org
.An "Joachim Kuebart"
Document 2 new sysctl's. Submitted by: Ariff Abdullah <skywizard@MyBSD.org.my> Submitted by: Jonathan Noack <noackjr@alumni.rice.edu> (implicit)
2005-07-31 13:27:52 +00:00
.An "Jonathan Noack" Aq noackjr@alumni.rice.edu
Reference in New Issue Copy Permalink