share/man/man4/snd_maestro3.4

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