xref: /freebsd/share/man/man4/snd_maestro3.4 (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
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.Dd December 15, 2005
26.Dt SND_MAESTRO3 4
27.Os
28.Sh NAME
29.Nm snd_maestro3
30.Nd "ESS Maestro3/Allegro-1 bridge device driver"
31.Sh SYNOPSIS
32To compile this driver into the kernel, place the following lines in your
33kernel configuration file:
34.Bd -ragged -offset indent
35.Cd "device sound"
36.Cd "device snd_maestro3"
37.Ed
38.Pp
39Alternatively, to load the driver as a module at boot time, place the
40following line in
41.Xr loader.conf 5 :
42.Bd -literal -offset indent
43snd_maestro3_load="YES"
44.Ed
45.Sh DESCRIPTION
46The
47.Nm
48driver provides support for the ESS Maestro3 and Allegro-1 sound chips
49under the PCM framework.
50These chips are mostly found in laptop computers and feature an AC97 mixer,
51a multi-channel sample rate converter that can mix up to four digital audio
52streams in hardware, recording support, and external volume control buttons.
53.Pp
54The firmware for the sound processor is licensed under the GNU Public
55License, and thus this driver is not included in the default
56.Pa GENERIC
57kernel.
58.Sh HARDWARE
59The
60.Nm
61driver supports the following audio devices:
62.Pp
63.Bl -bullet -compact
64.It
65ESS Technology Allegro-1
66.It
67ESS Technology Maestro3
68.El
69.Sh DIAGNOSTICS
70The hardware volume control buttons can be connected to two different pin
71sets (GPIO or GD) on the chip, depending on the manufacturer.
72The driver has no way of determining this configuration, so a hint may be
73used to override the default guess.
74The default setting for hardware volume control assumes that GD pins
75are wired to control the hardware volume.
76For systems that have the GPIO pins wired to the hardware volume control
77buttons, add the line
78.Dq Li hint.pcm.0.hwvol_config="0"
79to the file
80.Pa /boot/device.hints
81to override the default setting.
82.Sh SEE ALSO
83.Xr sound 4 ,
84.Xr loader.conf 5
85.Sh HISTORY
86The
87.Nm
88driver first appeared in
89.Fx 4.3 .
90.Sh AUTHORS
91.An Scott Long Aq Mt scottl@FreeBSD.org
92.An Darrel Anderson Aq Mt anderson@cs.duke.edu
93