freebsd-nq/share/man/man4/snd_sbc.4

.\"
.\" Copyright (c) 1999 Seigo Tanimura
.\" 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_SBC 4
.Os
.Sh NAME
.Nm snd_sbc
.Nd Creative Sound Blaster ISA and compatible 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_sbc"
.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_sbc_load="YES"
.Ed
.Pp
Non-PnP cards require the following lines in
.Xr device.hints 5 :
.Bd -literal -offset indent
hint.sbc.0.at="isa"
hint.sbc.0.port="0x220"
hint.sbc.0.irq="5"
hint.sbc.0.drq="1"
hint.sbc.0.flags="0x15"
.Ed
.Sh DESCRIPTION
The
.Nm
bridge driver allows the generic audio drivers including
.Xr sound 4
to attach to Creative Sound Blaster ISA compatible audio cards.
.Pp
The value of flags specifies the secondary DMA channel.
If the secondary
DMA channel is C, set the flags to (C | 0x10).
For a sound card without the
secondary DMA channel, the flags should be set to zero.
.Sh HARDWARE
The
.Nm
driver supports the following sound cards:
.Pp
.Bl -bullet -compact
.It
Avance Asound 110
.It
Avance Logic ALS100+
.It
Avance Logic ALS120
.It
Creative SB16
.It
Creative SB32
.It
Creative AWE64
.It
Creative AWE64 Gold
.It
Creative ViBRA16C
.It
Creative ViBRA16X
.It
ESS ES1681
.It
ESS ES1688
.It
ESS ES1868
.It
ESS ES1869
.It
ESS ES1878
.It
ESS ES1879
.It
ESS ES1888
.El
.Sh DIAGNOSTICS
.Bl -diag
.It sb_dspwr(XX) timed out.
A command to the DSP has timed out.
Check the I/O port configuration.
.It bad irq XX (5/7/9/10 valid)
The IRQ given to the driver is not valid.
.El
.Sh SEE ALSO
.Xr sound 4
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 4.0 .
.Sh AUTHORS
.An Seigo Tanimura Aq tanimura@r.dl.itc.u-tokyo.ac.jp
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.\"`
			`.\" Copyright (c) 1999 Seigo Tanimura`
			`.\" 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`
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			`.Dt SND_SBC 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.Sh NAME`
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			`.Nm snd_sbc`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.Nd Creative Sound Blaster ISA and compatible 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"`
			`.Cd "device snd_sbc"`
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_sbc_load="YES"`
			`.Ed`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.Pp`
Grammar nit. 2001-11-21 10:39:12 +00:00			`Non-PnP cards require the following lines in`
Make the SYNOPSIS section a bit more informative. 2005-12-15 20:25:41 +00:00			`.Xr device.hints 5 :`
			`.Bd -literal -offset indent`
			`hint.sbc.0.at="isa"`
			`hint.sbc.0.port="0x220"`
			`hint.sbc.0.irq="5"`
			`hint.sbc.0.drq="1"`
			`hint.sbc.0.flags="0x15"`
			`.Ed`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`bridge driver allows the generic audio drivers including`
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			`.Xr sound 4`
- move information about supported hardware into a HARDWARE section - bump .Dd MFC after: 3 days 2005-02-23 23:57:36 +00:00			`to attach to Creative Sound Blaster ISA compatible audio cards.`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.Pp`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`The value of flags specifies the secondary DMA channel.`
			`If the secondary`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`DMA channel is C, set the flags to (C \| 0x10).`
			`For a sound card without the`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`secondary DMA channel, the flags should be set to zero.`
- move information about supported hardware into a HARDWARE section - bump .Dd MFC after: 3 days 2005-02-23 23:57:36 +00:00			`.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:`
- move information about supported hardware into a HARDWARE section - bump .Dd MFC after: 3 days 2005-02-23 23:57:36 +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			`Avance Asound 110`
- move information about supported hardware into a HARDWARE section - bump .Dd MFC after: 3 days 2005-02-23 23:57:36 +00:00			`.It`
Be more specific about supported chipsets. Approved by: brueffer (mentor) 2005-08-17 16:36:07 +00:00			`Avance Logic ALS100+`
- move information about supported hardware into a HARDWARE section - bump .Dd MFC after: 3 days 2005-02-23 23:57:36 +00:00			`.It`
Be more specific about supported chipsets. Approved by: brueffer (mentor) 2005-08-17 16:36:07 +00:00			`Avance Logic ALS120`
- move information about supported hardware into a HARDWARE section - bump .Dd MFC after: 3 days 2005-02-23 23:57:36 +00:00			`.It`
Be more specific about supported chipsets. Approved by: brueffer (mentor) 2005-08-17 16:36:07 +00:00			`Creative SB16`
			`.It`
			`Creative SB32`
			`.It`
			`Creative AWE64`
			`.It`
			`Creative AWE64 Gold`
			`.It`
			`Creative ViBRA16C`
			`.It`
			`Creative ViBRA16X`
			`.It`
			`ESS ES1681`
			`.It`
			`ESS ES1688`
			`.It`
			`ESS ES1868`
			`.It`
			`ESS ES1869`
			`.It`
			`ESS ES1878`
			`.It`
			`ESS ES1879`
			`.It`
			`ESS ES1888`
- move information about supported hardware into a HARDWARE section - bump .Dd MFC after: 3 days 2005-02-23 23:57:36 +00:00			`.El`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.Sh DIAGNOSTICS`
mdoc(7) police: properly use a -diag list in the DIAGNOSTICS section. Reviewed by: ru 2001-04-13 19:59:47 +00:00			`.Bl -diag`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.It sb_dspwr(XX) timed out.`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`A command to the DSP has timed out.`
			`Check the I/O port configuration.`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.It bad irq XX (5/7/9/10 valid)`
			`The IRQ given to the driver is not valid.`
			`.El`
Sort sections. 2005-01-21 08:36:40 +00:00			`.Sh SEE ALSO`
			`.Xr sound 4`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`device driver first appeared in`
			`.Fx 4.0 .`
mdoc(7) police: use certified section headers wherever possible. 2000-11-17 11:44:16 +00:00			`.Sh AUTHORS`
- Add the man pages for sound card bridge drivers. (sbc(4), gusc(4), csa(4)) - Update pcm(4) for newpcm. 2000-01-15 06:25:09 +00:00			`.An Seigo Tanimura Aq tanimura@r.dl.itc.u-tokyo.ac.jp`