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

95 lines
3.2 KiB
Groff
Raw Normal View History

Add a manual page for the Maestro3 sound driver. This documents it's special nature under the GPL and a boot hint that can affect operation. MFC after: 3 days
2001-10-15 04:23:38 +00:00
.\" Copyright (c) 2001 Scott Long
.\" 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$
.\"
Make the SYNOPSIS section a bit more informative.
2005-12-15 20:25:41 +00:00
.Dd December 15, 2005
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_MAESTRO3 4
Add a manual page for the Maestro3 sound driver. This documents it's special nature under the GPL and a boot hint that can affect operation. MFC after: 3 days
2001-10-15 04:23:38 +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_maestro3
- Add a HARDWARE section which lists supported devices. - "device sound" does not pull in sound device drivers (like "device pcm" used to do), so do not mention that option. - Make the document title more like the title in the other sound device drivers. MFC after: 1 week
2004-12-14 16:17:12 +00:00
.Nd "ESS Maestro3/Allegro-1 bridge device driver"
Add a manual page for the Maestro3 sound driver. This documents it's special nature under the GPL and a boot hint that can affect operation. MFC after: 3 days
2001-10-15 04:23:38 +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"
.Cd "device snd_maestro3"
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_maestro3_load="YES"
.Ed
Add a manual page for the Maestro3 sound driver. This documents it's special nature under the GPL and a boot hint that can affect operation. MFC after: 3 days
2001-10-15 04:23:38 +00:00
.Sh DESCRIPTION
The
.Nm
driver provides support for the ESS Maestro3 and Allegro-1 sound chips
under the PCM framework.
These chips are mostly found in laptop computers and feature an AC97 mixer,
a multi-channel sample rate converter that can mix up to four digital audio
streams in hardware, recording support, and external volume control buttons.
.Pp
The firmware for the sound processor is licensed under the GNU Public
mdoc(7) police: minor markup and content fixes.
2001-11-21 17:12:31 +00:00
License, and thus this driver is not included in the default
.Pa GENERIC
- Add a HARDWARE section which lists supported devices. - "device sound" does not pull in sound device drivers (like "device pcm" used to do), so do not mention that option. - Make the document title more like the title in the other sound device drivers. MFC after: 1 week
2004-12-14 16:17:12 +00:00
kernel.
.Sh HARDWARE
The
.Nm
driver supports the following audio devices:
.Pp
.Bl -bullet -compact
.It
ESS Technology Allegro-1
.It
ESS Technology Maestro3
.El
Add a manual page for the Maestro3 sound driver. This documents it's special nature under the GPL and a boot hint that can affect operation. MFC after: 3 days
2001-10-15 04:23:38 +00:00
.Sh DIAGNOSTICS
The hardware volume control buttons can be connected to two different pin
Assorted markup fixes and minor wordsmithing. Approved by: re
2005-06-15 13:31:23 +00:00
sets (GPIO or GD) on the chip, depending on the manufacturer.
Add a manual page for the Maestro3 sound driver. This documents it's special nature under the GPL and a boot hint that can affect operation. MFC after: 3 days
2001-10-15 04:23:38 +00:00
The driver has no way of determining this configuration, so a hint may be
used to override the default guess.
Clarify that systems that have the GPIO pins wired to the hardware volume control need a device resource hint. Reviewed by: scottl
2005-06-08 05:23:39 +00:00
The default setting for hardware volume control assumes that GD pins
are wired to control the hardware volume.
For systems that have the GPIO pins wired to the hardware volume control
buttons, add the line
Add a manual page for the Maestro3 sound driver. This documents it's special nature under the GPL and a boot hint that can affect operation. MFC after: 3 days
2001-10-15 04:23:38 +00:00
.Dq Li hint.pcm.0.hwvol_config="0"
to the file
.Pa /boot/device.hints
to override the default setting.
.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 Maestro3 sound driver. This documents it's special nature under the GPL and a boot hint that can affect operation. MFC after: 3 days
2001-10-15 04:23:38 +00:00
.Xr loader.conf 5
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 4.3 .
.Sh AUTHORS
mdoc(7) police: minor markup and content fixes.
2001-11-21 17:12:31 +00:00
.An Scott Long Aq scottl@FreeBSD.org
.An Darrel Anderson Aq anderson@cs.duke.edu
Reference in New Issue Copy Permalink