patch-2.2.16 linux/Documentation/sound/README.ymfsb

Next file: linux/Documentation/sound/TODO.ymfsb
Previous file: linux/Documentation/sound/PSS-updates
Back to the patch index
Back to the overall index

diff -urN v2.2.15/linux/Documentation/sound/README.ymfsb linux/Documentation/sound/README.ymfsb
@@ -0,0 +1,143 @@
+Legacy audio driver for YMF7xx PCI cards.
+
+
+FIRST OF ALL
+============
+
+  This code references YAMAHA's sample codes and data sheets.
+  I respect and thank for all people they made open the informations
+  about YMF7xx cards.
+
+  And this codes heavily based on Jeff Garzik <jgarzik@pobox.com>'s
+  VIA 82Cxxx driver (via82cxxx.c). I also respect him.
+
+
+DISCLIMER
+=========
+
+ This driver is currently at early ALPHA stage. It may cause serious
+ damage to your computer when used.
+ PLEASE USE IT AT YOUR OWN RISK.
+
+
+ABOUT THIS DRIVER
+=================
+
+  This code enables you to use your YMF724[A-F], YMF740[A-C], YMF744, YMF754
+ cards. When enabled, your card acts as "SoundBlaster Pro" compatible card.
+ It can only play 22.05kHz / 8bit / Stereo samples, control external MIDI
+ port.
+ If you want to use your card as recent "16-bit" card, you should wait for
+ Alsa (or OSS) driver. Ofcource you can write native PCI driver for your
+ cards :)
+
+
+INSTALL
+=======
+
+  This codes currently requires YAMAHA's header file: Hwmcode.h and
+ 724hwmcode.c
+ It can be found at alsa's ftp (or mirror) sites. 
+
+   ftp://ftp.alsa-project.org/pub/manuals/yamaha/pci/
+
+ Hwmcode.h is contained in 754smpls.zip available at above URL.
+
+
+  To compile driver module, extract source archive and place above headers
+ in the directory.
+ And type 'make'. When it goes well, you will get ymfsb.o. 
+ Copy it to /lib/modules/<kernel_version>/misc/ and do 'depmod -a'.
+ Before modprobe, insert following line in /etc/modules.conf:
+
+  # /etc/modules.conf
+  options sb support=1
+
+
+USAGE
+=====
+
+ # modprobe ymfsb
+
+
+OPTIONS FOR MODULE
+==================
+
+  io           : SB base address     (0x220, 0x240, 0x260, 0x280)
+  synth_io     : OPL3 base address   (0x388, 0x398, 0x3a0, 0x3a8)
+  dma          : DMA number          (0,1,3)
+  master_volume: AC'97 PCM out Vol   (0-100)
+  spdif_out    : SPDIF-out flag      (0:disable 1:enable)
+
+ These options will change in future...
+
+
+TODO
+====
+
+ TOO LOT.
+ Ofcource we have not to satisfy such a poor code like this :-<
+
+
+FREQUENCY
+=========
+
+  When playing sounds via this driver, you will hear its pitch is slightly
+ lower than original sounds. Since this driver recognizes your card acts
+ with 21.739kHz sample rates rather than 22.050kHz (I think it must be
+ hardware restriction). So many players become tone deafness.
+ To prevent this, you should express some options to your sound player
+ that specify correct sample frequency. For example, to play your MP3 file
+ correctly with mpg123, specify the frequency like following:
+
+  %  mpg123 -r 21739 foo.mp3
+
+ Ofcource it potentially contains sample-rate-conversion, and may destroy
+ your sound. But you must remember that this card currently only handle
+ samples up to 21.739kHz B-(
+
+
+SPDIF OUT
+=========
+
+  With installing modules with option 'spdif_out=1', you can enjoy your
+ sounds from SPDIF-out of your card (if it had).
+ Its Fs is fixed to 48kHz (It never means the sample frequency become 
+ up to 48kHz. All sounds via SPDIF-out also 22kHz samples). So your
+ digital-in capable components has to be able to handle 48kHz Fs.
+
+
+COPYING
+=======
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2, or (at your option)
+ any later version.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+
+AVAILABILITY
+============
+
+ The latest version of this driver may be available at:
+
+   http://member.nifty.ne.jp/Breeze/linux/index.html
+
+ When the native DS-XG driver is available (from alsa, OSS, or else),
+ this code will have to be expired.
+
+
+AUTHOR
+======
+
+ Daisuke Nagano <breeze.nagano@nifty.ne.jp>
+

FUNET's LINUX-ADM group, linux-adm@nic.funet.fi
TCL-scripts by Sam Shen (who was at: slshen@lbl.gov)