Merge Btrfs into fs/btrfs
[linux-2.6] / Documentation / sound / oss / README.ymfsb
1 Legacy audio driver for YMF7xx PCI cards.
2
3
4 FIRST OF ALL
5 ============
6
7   This code references YAMAHA's sample codes and data sheets.
8   I respect and thank for all people they made open the informations
9   about YMF7xx cards.
10
11   And this codes heavily based on Jeff Garzik <jgarzik@pobox.com>'s
12   old VIA 82Cxxx driver (via82cxxx.c). I also respect him.
13
14
15 DISCLIMER
16 =========
17
18  This driver is currently at early ALPHA stage. It may cause serious
19  damage to your computer when used.
20  PLEASE USE IT AT YOUR OWN RISK.
21
22
23 ABOUT THIS DRIVER
24 =================
25
26   This code enables you to use your YMF724[A-F], YMF740[A-C], YMF744, YMF754
27  cards. When enabled, your card acts as "SoundBlaster Pro" compatible card.
28  It can only play 22.05kHz / 8bit / Stereo samples, control external MIDI
29  port.
30  If you want to use your card as recent "16-bit" card, you should use
31  Alsa or OSS/Linux driver. Of course you can write native PCI driver for
32  your cards :)
33
34
35 USAGE
36 =====
37
38  # modprobe ymfsb (options)
39
40
41 OPTIONS FOR MODULE
42 ==================
43
44   io           : SB base address     (0x220, 0x240, 0x260, 0x280)
45   synth_io     : OPL3 base address   (0x388, 0x398, 0x3a0, 0x3a8)
46   dma          : DMA number          (0,1,3)
47   master_volume: AC'97 PCM out Vol   (0-100)
48   spdif_out    : SPDIF-out flag      (0:disable 1:enable)
49
50  These options will change in future...
51
52
53 FREQUENCY
54 =========
55
56   When playing sounds via this driver, you will hear its pitch is slightly
57  lower than original sounds. Since this driver recognizes your card acts
58  with 21.739kHz sample rates rather than 22.050kHz (I think it must be
59  hardware restriction). So many players become tone deafness.
60  To prevent this, you should express some options to your sound player
61  that specify correct sample frequency. For example, to play your MP3 file
62  correctly with mpg123, specify the frequency like following:
63
64   %  mpg123 -r 21739 foo.mp3
65
66
67 SPDIF OUT
68 =========
69
70   With installing modules with option 'spdif_out=1', you can enjoy your
71  sounds from SPDIF-out of your card (if it had).
72  Its Fs is fixed to 48kHz (It never means the sample frequency become 
73  up to 48kHz. All sounds via SPDIF-out also 22kHz samples). So your
74  digital-in capable components has to be able to handle 48kHz Fs.
75
76
77 COPYING
78 =======
79
80  This program is free software; you can redistribute it and/or modify
81  it under the terms of the GNU General Public License as published by
82  the Free Software Foundation; either version 2, or (at your option)
83  any later version.
84
85  This program is distributed in the hope that it will be useful, but
86  WITHOUT ANY WARRANTY; without even the implied warranty of
87  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
88  General Public License for more details.
89
90  You should have received a copy of the GNU General Public License
91  along with this program; if not, write to the Free Software
92  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
93
94
95 TODO
96 ====
97  * support for multiple cards
98    (set the different SB_IO,MPU_IO,OPL_IO for each cards)
99
100  * support for OPL (dmfm) : There will be no requirements... :-<
101
102
103 AUTHOR
104 ======
105
106  Daisuke Nagano <breeze.nagano@nifty.ne.jp>
107