xref: /freebsd/share/man/man4/snd_maestro3.4 (revision 6574b8ed19b093f0af09501d2c9676c28993cb97)
1.\" Copyright (c) 2001 Scott Long
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd December 15, 2005
28.Dt SND_MAESTRO3 4
29.Os
30.Sh NAME
31.Nm snd_maestro3
32.Nd "ESS Maestro3/Allegro-1 bridge device driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel, place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device sound"
38.Cd "device snd_maestro3"
39.Ed
40.Pp
41Alternatively, to load the driver as a module at boot time, place the
42following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45snd_maestro3_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver provides support for the ESS Maestro3 and Allegro-1 sound chips
51under the PCM framework.
52These chips are mostly found in laptop computers and feature an AC97 mixer,
53a multi-channel sample rate converter that can mix up to four digital audio
54streams in hardware, recording support, and external volume control buttons.
55.Pp
56The firmware for the sound processor is licensed under the GNU Public
57License, and thus this driver is not included in the default
58.Pa GENERIC
59kernel.
60.Sh HARDWARE
61The
62.Nm
63driver supports the following audio devices:
64.Pp
65.Bl -bullet -compact
66.It
67ESS Technology Allegro-1
68.It
69ESS Technology Maestro3
70.El
71.Sh DIAGNOSTICS
72The hardware volume control buttons can be connected to two different pin
73sets (GPIO or GD) on the chip, depending on the manufacturer.
74The driver has no way of determining this configuration, so a hint may be
75used to override the default guess.
76The default setting for hardware volume control assumes that GD pins
77are wired to control the hardware volume.
78For systems that have the GPIO pins wired to the hardware volume control
79buttons, add the line
80.Dq Li hint.pcm.0.hwvol_config="0"
81to the file
82.Pa /boot/device.hints
83to override the default setting.
84.Sh SEE ALSO
85.Xr sound 4 ,
86.Xr loader.conf 5
87.Sh HISTORY
88The
89.Nm
90driver first appeared in
91.Fx 4.3 .
92.Sh AUTHORS
93.An Scott Long Aq Mt scottl@FreeBSD.org
94.An Darrel Anderson Aq Mt anderson@cs.duke.edu
95