freebsd-skq/share/man/man4/snd_cmi.4

.\" Copyright (c) 2004 Atte Peltomaki
.\" 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$
.\"
.Dd December 15, 2005
.Dt SND_CMI 4
.Os
.Sh NAME
.Nm snd_cmi
.Nd "CMedia CMI8338/CMI8738 PCI bridge device driver"
.Sh SYNOPSIS
To compile this driver into the kernel, place the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device sound"
.Cd "device snd_cmi"
.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_cmi_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
bridge driver allows the generic audio driver
.Xr sound 4
to attach to the CMedia CMI8338/CMI8738 audio cards.
.Sh HARDWARE
The
.Nm
driver supports the following sound cards:
.Pp
.Bl -bullet -compact
.It
CMedia CMI8338A
.It
CMedia CMI8338B
.It
CMedia CMI8738
.It
CMedia CMI8738B
.El
.Sh SEE ALSO
.Xr sound 4
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 4.3 .
.Sh AUTHORS
.An "Orion Hodson" Aq O.Hodson@cs.ucl.ac.uk
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days 2004-08-27 22:06:56 +00:00			`.\" Copyright (c) 2004 Atte Peltomaki`
			`.\" 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`
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days 2004-08-27 22:06:56 +00:00			`.Dt SND_CMI 4`
			`.Os`
			`.Sh NAME`
			`.Nm snd_cmi`
			`.Nd "CMedia CMI8338/CMI8738 PCI bridge device driver"`
			`.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"`
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days 2004-08-27 22:06:56 +00:00			`.Cd "device snd_cmi"`
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_cmi_load="YES"`
			`.Ed`
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days 2004-08-27 22:06:56 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`bridge driver allows the generic audio driver`
			`.Xr sound 4`
			`to attach to the CMedia CMI8338/CMI8738 audio cards.`
			`.Sh HARDWARE`
			`The`
			`.Nm`
soundcard -> sound card MFC after: 3 days 2005-05-22 16:14:55 +00:00			`driver supports the following sound cards:`
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days 2004-08-27 22:06:56 +00:00			`.Pp`
			`.Bl -bullet -compact`
			`.It`
Be more specific about supported chipsets. Approved by: brueffer (mentor) 2005-08-17 16:36:07 +00:00			`CMedia CMI8338A`
			`.It`
			`CMedia CMI8338B`
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days 2004-08-27 22:06:56 +00:00			`.It`
			`CMedia CMI8738`
Be more specific about supported chipsets. Approved by: brueffer (mentor) 2005-08-17 16:36:07 +00:00			`.It`
			`CMedia CMI8738B`
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days 2004-08-27 22:06:56 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr sound 4`
			`.Sh HISTORY`
			`The`
			`.Nm`
No one cares about when the manual page first appeared. Mention when the driver appeared instead. 2005-11-28 18:47:00 +00:00			`device driver first appeared in`
			`.Fx 4.3 .`
Add manual pages for several sound drivers. Submitted by: Atte Peltomaki <koston@iki.fi> Reviewed by: cg MFC after: 5 days 2004-08-27 22:06:56 +00:00			`.Sh AUTHORS`
			`.An "Orion Hodson" Aq O.Hodson@cs.ucl.ac.uk`