Use .Xr for manpage references.
[dragonfly.git] / share / man / man4 / snd_via8233.4
1 .\" Copyright (c) 2005 Joel Dahl
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: src/share/man/man4/snd_via8233.4,v 1.6 2006/11/29 17:07:02 joel Exp $
26 .\" $DragonFly: src/share/man/man4/snd_via8233.4,v 1.2 2007/02/25 19:12:28 swildner Exp $
27 .\"
28 .Dd November 29, 2006
29 .Dt SND_VIA8233 4
30 .Os
31 .Sh NAME
32 .Nm snd_via8233
33 .Nd "VIA Technologies VT8233 bridge device driver"
34 .Sh SYNOPSIS
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 pcm"
39 .Cd "device snd_via8233"
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_via8233_load="YES"
47 .Ed
48 .Sh DESCRIPTION
49 The
50 .Nm
51 bridge driver allows the generic audio driver,
52 .Xr sound 4 ,
53 to attach to the VIA VT8233 audio devices.
54 These audio chipsets are integrated in the southbridge on many VIA based
55 motherboards.
56 .Ss Runtime Configuration
57 The following
58 .Xr sysctl 8
59 variables are available in addition to those available to all
60 .Xr sound 4
61 devices:
62 .Bl -tag -width ".Va dev.pcm.%d.polling" -offset indent
63 .It Va dev.pcm.%d.polling
64 Experimental polling mode, where the driver operates by querying the device
65 state on each tick using
66 .Xr callout 9 .
67 Polling is disabled by default.
68 Do not enable it unless you are facing weird interrupt problems or if the
69 device cannot generate interrupts at all.
70 .El
71 .Sh HARDWARE
72 The
73 .Nm
74 driver supports the following audio chipsets:
75 .Pp
76 .Bl -bullet -compact
77 .It
78 VIA VT8233
79 .It
80 VIA VT8233A
81 .It
82 VIA VT8233C
83 .It
84 VIA VT8235
85 .It
86 VIA VT8237
87 .It
88 VIA VT8251
89 .El
90 .Sh SEE ALSO
91 .Xr sound 4
92 .Sh HISTORY
93 The
94 .Nm
95 device driver first appeared in
96 .Fx 4.7 .
97 .Sh AUTHORS
98 This manual page was written by
99 .An Joel Dahl Aq joel@FreeBSD.org .
100 .Sh BUGS
101 The
102 .Nm
103 driver
104 does not support S/PDIF.
105 There is partial support in the code, so implementing it should be fairly
106 easy if the right hardware is available.