README.OSS 67 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455
  1. Introduction
  2. ------------
  3. This file is a collection of all the old Readme files distributed with
  4. OSS/Lite by Hannu Savolainen. Since the new Linux sound driver is founded
  5. on it I think these information may still be interesting for users that
  6. have to configure their sound system.
  7. Be warned: Alan Cox is the current maintainer of the Linux sound driver so if
  8. you have problems with it, please contact him or the current device-specific
  9. driver maintainer (e.g. for aedsp16 specific problems contact me). If you have
  10. patches, contributions or suggestions send them to Alan: I'm sure they are
  11. welcome.
  12. In this document you will find a lot of references about OSS/Lite or ossfree:
  13. they are gone forever. Keeping this in mind and with a grain of salt this
  14. document can be still interesting and very helpful.
  15. [ File edited 17.01.1999 - Riccardo Facchetti ]
  16. [ Edited miroSOUND section 19.04.2001 - Robert Siemer ]
  17. OSS/Free version 3.8 release notes
  18. ----------------------------------
  19. Please read the SOUND-HOWTO (available from sunsite.unc.edu and other Linux FTP
  20. sites). It gives instructions about using sound with Linux. It's bit out of
  21. date but still very useful. Information about bug fixes and such things
  22. is available from the web page (see above).
  23. Please check http://www.opensound.com/pguide for more info about programming
  24. with OSS API.
  25. ====================================================
  26. - THIS VERSION ____REQUIRES____ Linux 2.1.57 OR LATER.
  27. ====================================================
  28. Packages "snd-util-3.8.tar.gz" and "snd-data-0.1.tar.Z"
  29. contain useful utilities to be used with this driver.
  30. See http://www.opensound.com/ossfree/ for
  31. download instructions.
  32. If you are looking for the installation instructions, please
  33. look forward into this document.
  34. Supported sound cards
  35. ---------------------
  36. See below.
  37. Contributors
  38. ------------
  39. This driver contains code by several contributors. In addition several other
  40. persons have given useful suggestions. The following is a list of major
  41. contributors. (I could have forgotten some names.)
  42. Craig Metz 1/2 of the PAS16 Mixer and PCM support
  43. Rob Hooft Volume computation algorithm for the FM synth.
  44. Mika Liljeberg uLaw encoding and decoding routines
  45. Jeff Tranter Linux SOUND HOWTO document
  46. Greg Lee Volume computation algorithm for the GUS and
  47. lots of valuable suggestions.
  48. Andy Warner ISC port
  49. Jim Lowe,
  50. Amancio Hasty Jr FreeBSD/NetBSD port
  51. Anders Baekgaard Bug hunting and valuable suggestions.
  52. Joerg Schubert SB16 DSP support (initial version).
  53. Andrew Robinson Improvements to the GUS driver
  54. Megens SA MIDI recording for SB and SB Pro (initial version).
  55. Mikael Nordqvist Linear volume support for GUS and
  56. nonblocking /dev/sequencer.
  57. Ian Hartas SVR4.2 port
  58. Markus Aroharju and
  59. Risto Kankkunen Major contributions to the mixer support
  60. of GUS v3.7.
  61. Hunyue Yau Mixer support for SG NX Pro.
  62. Marc Hoffman PSS support (initial version).
  63. Rainer Vranken Initialization for Jazz16 (initial version).
  64. Peter Trattler Initial version of loadable module support for Linux.
  65. JRA Gibson 16 bit mode for Jazz16 (initial version)
  66. Davor Jadrijevic MAD16 support (initial version)
  67. Gregor Hoffleit Mozart support (initial version)
  68. Riccardo Facchetti Audio Excel DSP 16 (aedsp16) support
  69. James Hightower Spotting a tiny but important bug in CS423x support.
  70. Denis Sablic OPTi 82C924 specific enhancements (non PnP mode)
  71. Tim MacKenzie Full duplex support for OPTi 82C930.
  72. Please look at lowlevel/README for more contributors.
  73. There are probably many other names missing. If you have sent me some
  74. patches and your name is not in the above list, please inform me.
  75. Sending your contributions or patches
  76. -------------------------------------
  77. First of all it's highly recommended to contact me before sending anything
  78. or before even starting to do any work. Tell me what you suggest to be
  79. changed or what you have planned to do. Also ensure you are using the
  80. very latest (development) version of OSS/Free since the change may already be
  81. implemented there. In general it's a major waste of time to try to improve a
  82. several months old version. Information about the latest version can be found
  83. from http://www.opensound.com/ossfree. In general there is no point in
  84. sending me patches relative to production kernels.
  85. Sponsors etc.
  86. -------------
  87. The following companies have greatly helped development of this driver
  88. in form of a free copy of their product:
  89. Novell, Inc. UnixWare personal edition + SDK
  90. The Santa Cruz Operation, Inc. A SCO OpenServer + SDK
  91. Ensoniq Corp, a SoundScape card and extensive amount of assistance
  92. MediaTrix Peripherals Inc, a AudioTrix Pro card + SDK
  93. Acer, Inc. a pair of AcerMagic S23 cards.
  94. In addition the following companies have provided me sufficient amount
  95. of technical information at least some of their products (free or $$$):
  96. Advanced Gravis Computer Technology Ltd.
  97. Media Vision Inc.
  98. Analog Devices Inc.
  99. Logitech Inc.
  100. Aztech Labs Inc.
  101. Crystal Semiconductor Corporation,
  102. Integrated Circuit Systems Inc.
  103. OAK Technology
  104. OPTi
  105. Turtle Beach
  106. miro
  107. Ad Lib Inc. ($$)
  108. Music Quest Inc. ($$)
  109. Creative Labs ($$$)
  110. If you have some problems
  111. =========================
  112. Read the sound HOWTO (sunsite.unc.edu:/pub/Linux/docs/...?).
  113. Also look at the home page (http://www.opensound.com/ossfree). It may
  114. contain info about some recent bug fixes.
  115. It's likely that you have some problems when trying to use the sound driver
  116. first time. Sound cards don't have standard configuration so there are no
  117. good default configuration to use. Please try to use same I/O, DMA and IRQ
  118. values for the sound card than with DOS.
  119. If you get an error message when trying to use the driver, please look
  120. at /var/adm/messages for more verbose error message.
  121. The following errors are likely with /dev/dsp and /dev/audio.
  122. - "No such device or address".
  123. This error indicates that there are no suitable hardware for the
  124. device file or the sound driver has been compiled without support for
  125. this particular device. For example /dev/audio and /dev/dsp will not
  126. work if "digitized voice support" was not enabled during "make config".
  127. - "Device or resource busy". Probably the IRQ (or DMA) channel
  128. required by the sound card is in use by some other device/driver.
  129. - "I/O error". Almost certainly (99%) it's an IRQ or DMA conflict.
  130. Look at the kernel messages in /var/adm/notice for more info.
  131. - "Invalid argument". The application is calling ioctl()
  132. with impossible parameters. Check that the application is
  133. for sound driver version 2.X or later.
  134. Linux installation
  135. ==================
  136. IMPORTANT! Read this if you are installing a separately
  137. distributed version of this driver.
  138. Check that your kernel version works with this
  139. release of the driver (see Readme). Also verify
  140. that your current kernel version doesn't have more
  141. recent sound driver version than this one. IT'S HIGHLY
  142. RECOMMENDED THAT YOU USE THE SOUND DRIVER VERSION THAT
  143. IS DISTRIBUTED WITH KERNEL SOURCES.
  144. - When installing separately distributed sound driver you should first
  145. read the above notice. Then try to find proper directory where and how
  146. to install the driver sources. You should not try to install a separately
  147. distributed driver version if you are not able to find the proper way
  148. yourself (in this case use the version that is distributed with kernel
  149. sources). Remove old version of linux/drivers/sound directory before
  150. installing new files.
  151. - To build the device files you need to run the enclosed shell script
  152. (see below). You need to do this only when installing sound driver
  153. first time or when upgrading to much recent version than the earlier
  154. one.
  155. - Configure and compile Linux as normally (remember to include the
  156. sound support during "make config"). Please refer to kernel documentation
  157. for instructions about configuring and compiling kernel. File Readme.cards
  158. contains card specific instructions for configuring this driver for
  159. use with various sound cards.
  160. Boot time configuration (using lilo and insmod)
  161. -----------------------------------------------
  162. This information has been removed. Too many users didn't believe
  163. that it's really not necessary to use this method. Please look at
  164. Readme of sound driver version 3.0.1 if you still want to use this method.
  165. Problems
  166. --------
  167. Common error messages:
  168. - /dev/???????: No such file or directory.
  169. Run the script at the end of this file.
  170. - /dev/???????: No such device.
  171. You are not running kernel which contains the sound driver. When using
  172. modularized sound driver this error means that the sound driver is not
  173. loaded.
  174. - /dev/????: No such device or address.
  175. Sound driver didn't detect suitable card when initializing. Please look at
  176. Readme.cards for info about configuring the driver with your card. Also
  177. check for possible boot (insmod) time error messages in /var/adm/messages.
  178. - Other messages or problems
  179. Please check http://www.opensound.com/ossfree for more info.
  180. Configuring version 3.8 (for Linux) with some common sound cards
  181. ================================================================
  182. This document describes configuring sound cards with the freeware version of
  183. Open Sound Systems (OSS/Free). Information about the commercial version
  184. (OSS/Linux) and its configuration is available from
  185. http://www.opensound.com/linux.html. Information presented here is
  186. not valid for OSS/Linux.
  187. If you are unsure about how to configure OSS/Free
  188. you can download the free evaluation version of OSS/Linux from the above
  189. address. There is a chance that it can autodetect your sound card. In this case
  190. you can use the information included in soundon.log when configuring OSS/Free.
  191. IMPORTANT! This document covers only cards that were "known" when
  192. this driver version was released. Please look at
  193. http://www.opensound.com/ossfree for info about
  194. cards introduced recently.
  195. When configuring the sound driver, you should carefully
  196. check each sound configuration option (particularly
  197. "Support for /dev/dsp and /dev/audio"). The default values
  198. offered by these programs are not necessarily valid.
  199. THE BIGGEST MISTAKES YOU CAN MAKE
  200. =================================
  201. 1. Assuming that the card is Sound Blaster compatible when it's not.
  202. --------------------------------------------------------------------
  203. The number one mistake is to assume that your card is compatible with
  204. Sound Blaster. Only the cards made by Creative Technology or which have
  205. one or more chips labeled by Creative are SB compatible. In addition there
  206. are few sound chipsets which are SB compatible in Linux such as ESS1688 or
  207. Jazz16. Note that SB compatibility in DOS/Windows does _NOT_ mean anything
  208. in Linux.
  209. IF YOU REALLY ARE 150% SURE YOU HAVE A SOUND BLASTER YOU CAN SKIP THE REST OF
  210. THIS CHAPTER.
  211. For most other "supposed to be SB compatible" cards you have to use other
  212. than SB drivers (see below). It is possible to get most sound cards to work
  213. in SB mode but in general it's a complete waste of time. There are several
  214. problems which you will encounter by using SB mode with cards that are not
  215. truly SB compatible:
  216. - The SB emulation is at most SB Pro (DSP version 3.x) which means that
  217. you get only 8 bit audio (there is always an another ("native") mode which
  218. gives the 16 bit capability). The 8 bit only operation is the reason why
  219. many users claim that sound quality in Linux is much worse than in DOS.
  220. In addition some applications require 16 bit mode and they produce just
  221. noise with a 8 bit only device.
  222. - The card may work only in some cases but refuse to work most of the
  223. time. The SB compatible mode always requires special initialization which is
  224. done by the DOS/Windows drivers. This kind of cards work in Linux after
  225. you have warm booted it after DOS but they don't work after cold boot
  226. (power on or reset).
  227. - You get the famous "DMA timed out" messages. Usually all SB clones have
  228. software selectable IRQ and DMA settings. If the (power on default) values
  229. currently used by the card don't match configuration of the driver you will
  230. get the above error message whenever you try to record or play. There are
  231. few other reasons to the DMA timeout message but using the SB mode seems
  232. to be the most common cause.
  233. 2. Trying to use a PnP (Plug & Play) card just like an ordinary sound card
  234. --------------------------------------------------------------------------
  235. Plug & Play is a protocol defined by Intel and Microsoft. It lets operating
  236. systems to easily identify and reconfigure I/O ports, IRQs and DMAs of ISA
  237. cards. The problem with PnP cards is that the standard Linux doesn't currently
  238. (versions 2.1.x and earlier) don't support PnP. This means that you will have
  239. to use some special tricks (see later) to get a PnP card alive. Many PnP cards
  240. work after they have been initialized but this is not always the case.
  241. There are sometimes both PnP and non-PnP versions of the same sound card.
  242. The non-PnP version is the original model which usually has been discontinued
  243. more than an year ago. The PnP version has the same name but with "PnP"
  244. appended to it (sometimes not). This causes major confusion since the non-PnP
  245. model works with Linux but the PnP one doesn't.
  246. You should carefully check if "Plug & Play" or "PnP" is mentioned in the name
  247. of the card or in the documentation or package that came with the card.
  248. Everything described in the rest of this document is not necessarily valid for
  249. PnP models of sound cards even you have managed to wake up the card properly.
  250. Many PnP cards are simply too different from their non-PnP ancestors which are
  251. covered by this document.
  252. Cards that are not (fully) supported by this driver
  253. ===================================================
  254. See http://www.opensound.com/ossfree for information about sound cards
  255. to be supported in future.
  256. How to use sound without recompiling kernel and/or sound driver
  257. ===============================================================
  258. There is a commercial sound driver which comes in precompiled form and doesn't
  259. require recompiling of the kernel. See http://www.4Front-tech.com/oss.html for
  260. more info.
  261. Configuring PnP cards
  262. =====================
  263. New versions of most sound cards use the so-called ISA PnP protocol for
  264. soft configuring their I/O, IRQ, DMA and shared memory resources.
  265. Currently at least cards made by Creative Technology (SB32 and SB32AWE
  266. PnP), Gravis (GUS PnP and GUS PnP Pro), Ensoniq (Soundscape PnP) and
  267. Aztech (some Sound Galaxy models) use PnP technology. The CS4232/4236 audio
  268. chip by Crystal Semiconductor (Intel Atlantis, HP Pavilion and many other
  269. motherboards) is also based on PnP technology but there is a "native" driver
  270. available for it (see information about CS4232 later in this document).
  271. PnP sound cards (as well as most other PnP ISA cards) are not supported
  272. by this version of the driver . Proper
  273. support for them should be released during 97 once the kernel level
  274. PnP support is available.
  275. There is a method to get most of the PnP cards to work. The basic method
  276. is the following:
  277. 1) Boot DOS so the card's DOS drivers have a chance to initialize it.
  278. 2) _Cold_ boot to Linux by using "loadlin.exe". Hitting ctrl-alt-del
  279. works with older machines but causes a hard reset of all cards on recent
  280. (Pentium) machines.
  281. 3) If you have the sound driver in Linux configured properly, the card should
  282. work now. "Proper" means that I/O, IRQ and DMA settings are the same as in
  283. DOS. The hard part is to find which settings were used. See the documentation of
  284. your card for more info.
  285. Windows 95 could work as well as DOS but running loadlin may be difficult.
  286. Probably you should "shut down" your machine to MS-DOS mode before running it.
  287. Some machines have a BIOS utility for setting PnP resources. This is a good
  288. way to configure some cards. In this case you don't need to boot DOS/Win95
  289. before starting Linux.
  290. Another way to initialize PnP cards without DOS/Win95 is a Linux based
  291. PnP isolation tool. When writing this there is a pre alpha test version
  292. of such a tool available from ftp://ftp.demon.co.uk/pub/unix/linux/utils. The
  293. file is called isapnptools-*. Please note that this tool is just a temporary
  294. solution which may be incompatible with future kernel versions having proper
  295. support for PnP cards. There are bugs in setting DMA channels in earlier
  296. versions of isapnptools so at least version 1.6 is required with sound cards.
  297. Yet another way to use PnP cards is to use (commercial) OSS/Linux drivers. See
  298. http://www.opensound.com/linux.html for more info. This is probably the way you
  299. should do it if you don't want to spend time recompiling the kernel and
  300. required tools.
  301. Read this before trying to configure the driver
  302. ===============================================
  303. There are currently many cards that work with this driver. Some of the cards
  304. have native support while others work since they emulate some other
  305. card (usually SB, MSS/WSS and/or MPU401). The following cards have native
  306. support in the driver. Detailed instructions for configuring these cards
  307. will be given later in this document.
  308. Pro Audio Spectrum 16 (PAS16) and compatibles:
  309. Pro Audio Spectrum 16
  310. Pro Audio Studio 16
  311. Logitech Sound Man 16
  312. NOTE! The original Pro Audio Spectrum as well as the PAS+ are not
  313. and will not be supported by the driver.
  314. Media Vision Jazz16 based cards
  315. Pro Sonic 16
  316. Logitech SoundMan Wave
  317. (Other Jazz based cards should work but I don't have any reports
  318. about them).
  319. Sound Blasters
  320. SB 1.0 to 2.0
  321. SB Pro
  322. SB 16
  323. SB32/64/AWE
  324. Configure SB32/64/AWE just like SB16. See lowlevel/README.awe
  325. for information about using the wave table synth.
  326. NOTE! AWE63/Gold and 16/32/AWE "PnP" cards need to be activated
  327. using isapnptools before they work with OSS/Free.
  328. SB16 compatible cards by other manufacturers than Creative.
  329. You have been fooled since there are _no_ SB16 compatible
  330. cards on the market (as of May 1997). It's likely that your card
  331. is compatible just with SB Pro but there is also a non-SB-
  332. compatible 16 bit mode. Usually it's MSS/WSS but it could also
  333. be a proprietary one like MV Jazz16 or ESS ES688. OPTi
  334. MAD16 chips are very common in so called "SB 16 bit cards"
  335. (try with the MAD16 driver).
  336. ======================================================================
  337. "Supposed to be SB compatible" cards.
  338. Forget the SB compatibility and check for other alternatives
  339. first. The only cards that work with the SB driver in
  340. Linux have been made by Creative Technology (there is at least
  341. one chip on the card with "CREATIVE" printed on it). The
  342. only other SB compatible chips are ESS and Jazz16 chips
  343. (maybe ALSxxx chips too but they probably don't work).
  344. Most other "16 bit SB compatible" cards such as "OPTi/MAD16" or
  345. "Crystal" are _NOT_ SB compatible in Linux.
  346. Practically all sound cards have some kind of SB emulation mode
  347. in addition to their native (16 bit) mode. In most cases this
  348. (8 bit only) SB compatible mode doesn't work with Linux. If
  349. you get it working it may cause problems with games and
  350. applications which require 16 bit audio. Some 16 bit only
  351. applications don't check if the card actually supports 16 bits.
  352. They just dump 16 bit data to a 8 bit card which produces just
  353. noise.
  354. In most cases the 16 bit native mode is supported by Linux.
  355. Use the SB mode with "clones" only if you don't find anything
  356. better from the rest of this doc.
  357. ======================================================================
  358. Gravis Ultrasound (GUS)
  359. GUS
  360. GUS + the 16 bit option
  361. GUS MAX
  362. GUS ACE (No MIDI port and audio recording)
  363. GUS PnP (with RAM)
  364. MPU-401 and compatibles
  365. The driver works both with the full (intelligent mode) MPU-401
  366. cards (such as MPU IPC-T and MQX-32M) and with the UART only
  367. dumb MIDI ports. MPU-401 is currently the most common MIDI
  368. interface. Most sound cards are compatible with it. However,
  369. don't enable MPU401 mode blindly. Many cards with native support
  370. in the driver have their own MPU401 driver. Enabling the standard one
  371. will cause a conflict with these cards. So check if your card is
  372. in the list of supported cards before enabling MPU401.
  373. Windows Sound System (MSS/WSS)
  374. Even when Microsoft has discontinued their own Sound System card
  375. they managed to make it a standard. MSS compatible cards are based on
  376. a codec chip which is easily available from at least two manufacturers
  377. (AD1848 by Analog Devices and CS4231/CS4248 by Crystal Semiconductor).
  378. Currently most sound cards are based on one of the MSS compatible codec
  379. chips. The CS4231 is used in the high quality cards such as GUS MAX,
  380. MediaTrix AudioTrix Pro and TB Tropez (GUS MAX is not MSS compatible).
  381. Having a AD1848, CS4248 or CS4231 codec chip on the card is a good
  382. sign. Even if the card is not MSS compatible, it could be easy to write
  383. support for it. Note also that most MSS compatible cards
  384. require special boot time initialization which may not be present
  385. in the driver. Also, some MSS compatible cards have native support.
  386. Enabling the MSS support with these cards is likely to
  387. cause a conflict. So check if your card is listed in this file before
  388. enabling the MSS support.
  389. Yamaha FM synthesizers (OPL2, OPL3 (not OPL3-SA) and OPL4)
  390. Most sound cards have a FM synthesizer chip. The OPL2 is a 2
  391. operator chip used in the original AdLib card. Currently it's used
  392. only in the cheapest (8 bit mono) cards. The OPL3 is a 4 operator
  393. FM chip which provides better sound quality and/or more available
  394. voices than the OPL2. The OPL4 is a new chip that has an OPL3 and
  395. a wave table synthesizer packed onto the same chip. The driver supports
  396. just the OPL3 mode directly. Most cards with an OPL4 (like
  397. SM Wave and AudioTrix Pro) support the OPL4 mode using MPU401
  398. emulation. Writing a native OPL4 support is difficult
  399. since Yamaha doesn't give information about their sample ROM chip.
  400. Enable the generic OPL2/OPL3 FM synthesizer support if your
  401. card has a FM chip made by Yamaha. Don't enable it if your card
  402. has a software (TRS) based FM emulator.
  403. ----------------------------------------------------------------
  404. NOTE! OPL3-SA is different chip than the ordinary OPL3. In addition
  405. to the FM synth this chip has also digital audio (WSS) and
  406. MIDI (MPU401) capabilities. Support for OPL3-SA is described below.
  407. ----------------------------------------------------------------
  408. Yamaha OPL3-SA1
  409. Yamaha OPL3-SA1 (YMF701) is an audio controller chip used on some
  410. (Intel) motherboards and on cheap sound cards. It should not be
  411. confused with the original OPL3 chip (YMF278) which is entirely
  412. different chip. OPL3-SA1 has support for MSS, MPU401 and SB Pro
  413. (not used in OSS/Free) in addition to the OPL3 FM synth.
  414. There are also chips called OPL3-SA2, OPL3-SA3, ..., OPL3SA-N. They
  415. are PnP chips and will not work with the OPL3-SA1 driver. You should
  416. use the standard MSS, MPU401 and OPL3 options with these chips and to
  417. activate the card using isapnptools.
  418. 4Front Technologies SoftOSS
  419. SoftOSS is a software based wave table emulation which works with
  420. any 16 bit stereo sound card. Due to its nature a fast CPU is
  421. required (P133 is minimum). Although SoftOSS does _not_ use MMX
  422. instructions it has proven out that recent processors (which appear
  423. to have MMX) perform significantly better with SoftOSS than earlier
  424. ones. For example a P166MMX beats a PPro200. SoftOSS should not be used
  425. on 486 or 386 machines.
  426. The amount of CPU load caused by SoftOSS can be controlled by
  427. selecting the CONFIG_SOFTOSS_RATE and CONFIG_SOFTOSS_VOICES
  428. parameters properly (they will be prompted by make config). It's
  429. recommended to set CONFIG_SOFTOSS_VOICES to 32. If you have a
  430. P166MMX or faster (PPro200 is not faster) you can set
  431. CONFIG_SOFTOSS_RATE to 44100 (kHz). However with slower systems it
  432. recommended to use sampling rates around 22050 or even 16000 kHz.
  433. Selecting too high values for these parameters may hang your
  434. system when playing MIDI files with hight degree of polyphony
  435. (number of concurrently playing notes). It's also possible to
  436. decrease CONFIG_SOFTOSS_VOICES. This makes it possible to use
  437. higher sampling rates. However using fewer voices decreases
  438. playback quality more than decreasing the sampling rate.
  439. SoftOSS keeps the samples loaded on the system's RAM so much RAM is
  440. required. SoftOSS should never be used on machines with less than 16 MB
  441. of RAM since this is potentially dangerous (you may accidentally run out
  442. of memory which probably crashes the machine).
  443. SoftOSS implements the wave table API originally designed for GUS. For
  444. this reason all applications designed for GUS should work (at least
  445. after minor modifications). For example gmod/xgmod and playmidi -g are
  446. known to work.
  447. To work SoftOSS will require GUS compatible
  448. patch files to be installed on the system (in /dos/ultrasnd/midi). You
  449. can use the public domain MIDIA patchset available from several ftp
  450. sites.
  451. *********************************************************************
  452. IMPORTANT NOTICE! The original patch set distributed with the Gravis
  453. Ultrasound card is not in public domain (even though it's available from
  454. some FTP sites). You should contact Voice Crystal (www.voicecrystal.com)
  455. if you like to use these patches with SoftOSS included in OSS/Free.
  456. *********************************************************************
  457. PSS based cards (AD1848 + ADSP-2115 + Echo ESC614 ASIC)
  458. Analog Devices and Echo Speech have together defined a sound card
  459. architecture based on the above chips. The DSP chip is used
  460. for emulation of SB Pro, FM and General MIDI/MT32.
  461. There are several cards based on this architecture. The most known
  462. ones are Orchid SW32 and Cardinal DSP16.
  463. The driver supports downloading DSP algorithms to these cards.
  464. NOTE! You will have to use the "old" config script when configuring
  465. PSS cards.
  466. MediaTrix AudioTrix Pro
  467. The ATP card is built around a CS4231 codec and an OPL4 synthesizer
  468. chips. The OPL4 mode is supported by a microcontroller running a
  469. General MIDI emulator. There is also a SB 1.5 compatible playback mode.
  470. Ensoniq SoundScape and compatibles
  471. Ensoniq has designed a sound card architecture based on the
  472. OTTO synthesizer chip used in their professional MIDI synthesizers.
  473. Several companies (including Ensoniq, Reveal and Spea) are selling
  474. cards based on this architecture.
  475. NOTE! The SoundScape PnP is not supported by OSS/Free. Ensoniq VIVO and
  476. VIVO90 cards are not compatible with Soundscapes so the Soundscape
  477. driver will not work with them. You may want to use OSS/Linux with these
  478. cards.
  479. OPTi MAD16 and Mozart based cards
  480. The Mozart (OAK OTI-601), MAD16 (OPTi 82C928), MAD16 Pro (OPTi 82C929),
  481. OPTi 82C924/82C925 (in _non_ PnP mode) and OPTi 82C930 interface
  482. chips are used in many different sound cards, including some
  483. cards by Reveal miro and Turtle Beach (Tropez). The purpose of these
  484. chips is to connect other audio components to the PC bus. The
  485. interface chip performs address decoding for the other chips.
  486. NOTE! Tropez Plus is not MAD16 but CS4232 based.
  487. NOTE! MAD16 PnP cards (82C924, 82C925, 82C931) are not MAD16 compatible
  488. in the PnP mode. You will have to use them in MSS mode after having
  489. initialized them using isapnptools or DOS. 82C931 probably requires
  490. initialization using DOS/Windows (running isapnptools is not enough).
  491. It's possible to use 82C931 with OSS/Free by jumpering it to non-PnP
  492. mode (provided that the card has a jumper for this). In non-PnP mode
  493. 82C931 is compatible with 82C930 and should work with the MAD16 driver
  494. (without need to use isapnptools or DOS to initialize it). All OPTi
  495. chips are supported by OSS/Linux (both in PnP and non-PnP modes).
  496. Audio Excel DSP16
  497. Support for this card was written by Riccardo Faccetti
  498. (riccardo@cdc8g5.cdc.polimi.it). The AEDSP16 driver included in
  499. the lowlevel/ directory. To use it you should enable the
  500. "Additional low level drivers" option.
  501. Crystal CS4232 and CS4236 based cards such as AcerMagic S23, TB Tropez _Plus_ and
  502. many PC motherboards (Compaq, HP, Intel, ...)
  503. CS4232 is a PnP multimedia chip which contains a CS3231A codec,
  504. SB and MPU401 emulations. There is support for OPL3 too.
  505. Unfortunately the MPU401 mode doesn't work (I don't know how to
  506. initialize it). CS4236 is an enhanced (compatible) version of CS4232.
  507. NOTE! Don't ever try to use isapnptools with CS4232 since this will just
  508. freeze your machine (due to chip bugs). If you have problems in getting
  509. CS4232 working you could try initializing it with DOS (CS4232C.EXE) and
  510. then booting Linux using loadlin. CS4232C.EXE loads a secret firmware
  511. patch which is not documented by Crystal.
  512. Turtle Beach Maui and Tropez "classic"
  513. This driver version supports sample, patch and program loading commands
  514. described in the Maui/Tropez User's manual.
  515. There is now full initialization support too. The audio side of
  516. the Tropez is based on the MAD16 chip (see above).
  517. NOTE! Tropez Plus is different card than Tropez "classic" and will not
  518. work fully in Linux. You can get audio features working by configuring
  519. the card as a CS4232 based card (above).
  520. Jumpers and software configuration
  521. ==================================
  522. Some of the earliest sound cards were jumper configurable. You have to
  523. configure the driver use I/O, IRQ and DMA settings
  524. that match the jumpers. Just few 8 bit cards are fully jumper
  525. configurable (SB 1.x/2.x, SB Pro and clones).
  526. Some cards made by Aztech have an EEPROM which contains the
  527. config info. These cards behave much like hardware jumpered cards.
  528. Most cards have jumper for the base I/O address but other parameters
  529. are software configurable. Sometimes there are few other jumpers too.
  530. Latest cards are fully software configurable or they are PnP ISA
  531. compatible. There are no jumpers on the board.
  532. The driver handles software configurable cards automatically. Just configure
  533. the driver to use I/O, IRQ and DMA settings which are known to work.
  534. You could usually use the same values than with DOS and/or Windows.
  535. Using different settings is possible but not recommended since it may cause
  536. some trouble (for example when warm booting from an OS to another or
  537. when installing new hardware to the machine).
  538. Sound driver sets the soft configurable parameters of the card automatically
  539. during boot. Usually you don't need to run any extra initialization
  540. programs when booting Linux but there are some exceptions. See the
  541. card-specific instructions below for more info.
  542. The drawback of software configuration is that the driver needs to know
  543. how the card must be initialized. It cannot initialize unknown cards
  544. even if they are otherwise compatible with some other cards (like SB,
  545. MPU401 or Windows Sound System).
  546. What if your card was not listed above?
  547. =======================================
  548. The first thing to do is to look at the major IC chips on the card.
  549. Many of the latest sound cards are based on some standard chips. If you
  550. are lucky, all of them could be supported by the driver. The most common ones
  551. are the OPTi MAD16, Mozart, SoundScape (Ensoniq) and the PSS architectures
  552. listed above. Also look at the end of this file for list of unsupported
  553. cards and the ones which could be supported later.
  554. The last resort is to send _exact_ name and model information of the card
  555. to me together with a list of the major IC chips (manufactured, model) to
  556. me. I could then try to check if your card looks like something familiar.
  557. There are many more cards in the world than listed above. The first thing to
  558. do with these cards is to check if they emulate some other card or interface
  559. such as SB, MSS and/or MPU401. In this case there is a chance to get the
  560. card to work by booting DOS before starting Linux (boot DOS, hit ctrl-alt-del
  561. and boot Linux without hard resetting the machine). In this method the
  562. DOS based driver initializes the hardware to use known I/O, IRQ and DMA
  563. settings. If sound driver is configured to use the same settings, everything
  564. should work OK.
  565. Configuring sound driver (with Linux)
  566. =====================================
  567. The sound driver is currently distributed as part of the Linux kernel. The
  568. files are in /usr/src/linux/drivers/sound/.
  569. ****************************************************************************
  570. * ALWAYS USE THE SOUND DRIVER VERSION WHICH IS DISTRIBUTED WITH *
  571. * THE KERNEL SOURCE PACKAGE YOU ARE USING. SOME ALPHA AND BETA TEST *
  572. * VERSIONS CAN BE INSTALLED FROM A SEPARATELY DISTRIBUTED PACKAGE *
  573. * BUT CHECK THAT THE PACKAGE IS NOT MUCH OLDER (OR NEWER) THAN THE *
  574. * KERNEL YOU ARE USING. IT'S POSSIBLE THAT THE KERNEL/DRIVER *
  575. * INTERFACE CHANGES BETWEEN KERNEL RELEASES WHICH MAY CAUSE SOME *
  576. * INCOMPATIBILITY PROBLEMS. *
  577. * *
  578. * IN CASE YOU INSTALL A SEPARATELY DISTRIBUTED SOUND DRIVER VERSION, *
  579. * BE SURE TO REMOVE OR RENAME THE OLD SOUND DRIVER DIRECTORY BEFORE *
  580. * INSTALLING THE NEW ONE. LEAVING OLD FILES TO THE SOUND DRIVER *
  581. * DIRECTORY _WILL_ CAUSE PROBLEMS WHEN THE DRIVER IS USED OR *
  582. * COMPILED. *
  583. ****************************************************************************
  584. To configure the driver, run "make config" in the kernel source directory
  585. (/usr/src/linux). Answer "y" or "m" to the question about Sound card support
  586. (after the questions about mouse, CD-ROM, ftape, etc. support). Questions
  587. about options for sound will then be asked.
  588. After configuring the kernel and sound driver and compile the kernel
  589. following instructions in the kernel README.
  590. The sound driver configuration dialog
  591. -------------------------------------
  592. Sound configuration starts by making some yes/no questions. Be careful
  593. when answering to these questions since answering y to a question may
  594. prevent some later ones from being asked. For example don't answer y to
  595. the first question (PAS16) if you don't really have a PAS16. Don't enable
  596. more cards than you really need since they just consume memory. Also
  597. some drivers (like MPU401) may conflict with your SCSI controller and
  598. prevent kernel from booting. If you card was in the list of supported
  599. cards (above), please look at the card specific config instructions
  600. (later in this file) before starting to configure. Some cards must be
  601. configured in way which is not obvious.
  602. So here is the beginning of the config dialog. Answer 'y' or 'n' to these
  603. questions. The default answer is shown so that (y/n) means 'y' by default and
  604. (n/y) means 'n'. To use the default value, just hit ENTER. But be careful
  605. since using the default _doesn't_ guarantee anything.
  606. Note also that all questions may not be asked. The configuration program
  607. may disable some questions depending on the earlier choices. It may also
  608. select some options automatically as well.
  609. "ProAudioSpectrum 16 support",
  610. - Answer 'y'_ONLY_ if you have a Pro Audio Spectrum _16_,
  611. Pro Audio Studio 16 or Logitech SoundMan 16 (be sure that
  612. you read the above list correctly). Don't answer 'y' if you
  613. have some other card made by Media Vision or Logitech since they
  614. are not PAS16 compatible.
  615. NOTE! Since 3.5-beta10 you need to enable SB support (next question)
  616. if you want to use the SB emulation of PAS16. It's also possible to
  617. the emulation if you want to use a true SB card together with PAS16
  618. (there is another question about this that is asked later).
  619. "Sound Blaster support",
  620. - Answer 'y' if you have an original SB card made by Creative Labs
  621. or a full 100% hardware compatible clone (like Thunderboard or
  622. SM Games). If your card was in the list of supported cards (above),
  623. please look at the card specific instructions later in this file
  624. before answering this question. For an unknown card you may answer
  625. 'y' if the card claims to be SB compatible.
  626. Enable this option also with PAS16 (changed since v3.5-beta9).
  627. Don't enable SB if you have a MAD16 or Mozart compatible card.
  628. "Generic OPL2/OPL3 FM synthesizer support",
  629. - Answer 'y' if your card has a FM chip made by Yamaha (OPL2/OPL3/OPL4).
  630. Answering 'y' is usually a safe and recommended choice. However some
  631. cards may have software (TSR) FM emulation. Enabling FM support
  632. with these cards may cause trouble. However I don't currently know
  633. such cards.
  634. "Gravis Ultrasound support",
  635. - Answer 'y' if you have GUS or GUS MAX. Answer 'n' if you don't
  636. have GUS since the GUS driver consumes much memory.
  637. Currently I don't have experiences with the GUS ACE so I don't
  638. know what to answer with it.
  639. "MPU-401 support (NOT for SB16)",
  640. - Be careful with this question. The MPU401 interface is supported
  641. by almost any sound card today. However some natively supported cards
  642. have their own driver for MPU401. Enabling the MPU401 option with
  643. these cards will cause a conflict. Also enabling MPU401 on a system
  644. that doesn't really have a MPU401 could cause some trouble. If your
  645. card was in the list of supported cards (above), please look at
  646. the card specific instructions later in this file.
  647. In MOST cases this MPU401 driver should only be used with "true"
  648. MIDI-only MPU401 professional cards. In most other cases there
  649. is another way to get the MPU401 compatible interface of a
  650. sound card to work.
  651. Support for the MPU401 compatible MIDI port of SB16, ESS1688
  652. and MV Jazz16 cards is included in the SB driver. Use it instead
  653. of this separate MPU401 driver with these cards. As well
  654. Soundscape, PSS and Maui drivers include their own MPU401
  655. options.
  656. It's safe to answer 'y' if you have a true MPU401 MIDI interface
  657. card.
  658. "6850 UART Midi support",
  659. - It's safe to answer 'n' to this question in all cases. The 6850
  660. UART interface is so rarely used.
  661. "PSS (ECHO-ADI2111) support",
  662. - Answer 'y' only if you have Orchid SW32, Cardinal DSP16 or some
  663. other card based on the PSS chipset (AD1848 codec + ADSP-2115
  664. DSP chip + Echo ESC614 ASIC CHIP).
  665. "16 bit sampling option of GUS (_NOT_ GUS MAX)",
  666. - Answer 'y' if you have installed the 16 bit sampling daughtercard
  667. to your GUS. Answer 'n' if you have GUS MAX. Enabling this option
  668. disables GUS MAX support.
  669. "GUS MAX support",
  670. - Answer 'y' only if you have a GUS MAX.
  671. "Microsoft Sound System support",
  672. - Again think carefully before answering 'y' to this question. It's
  673. safe to answer 'y' in case you have the original Windows Sound
  674. System card made by Microsoft or Aztech SG 16 Pro (or NX16 Pro).
  675. Also you may answer 'y' in case your card was not listed earlier
  676. in this file. For cards having native support in the driver, consult
  677. the card specific instructions later in this file. Some drivers
  678. have their own MSS support and enabling this option will cause a
  679. conflict.
  680. Note! The MSS driver permits configuring two DMA channels. This is a
  681. "nonstandard" feature and works only with very few cards (if any).
  682. In most cases the second DMA channel should be disabled or set to
  683. the same channel than the first one. Trying to configure two separate
  684. channels with cards that don't support this feature will prevent
  685. audio (at least recording) from working.
  686. "Ensoniq Soundscape support",
  687. - Answer 'y' if you have a sound card based on the Ensoniq SoundScape
  688. chipset. Such cards are being manufactured at least by Ensoniq,
  689. Spea and Reveal (note that Reveal makes other cards also). The oldest
  690. cards made by Spea don't work properly with Linux.
  691. Soundscape PnP as well as Ensoniq VIVO work only with the commercial
  692. OSS/Linux version.
  693. "MediaTrix AudioTrix Pro support",
  694. - Answer 'y' if you have the AudioTrix Pro.
  695. "Support for MAD16 and/or Mozart based cards",
  696. - Answer y if your card has a Mozart (OAK OTI-601) or MAD16
  697. (OPTi 82C928, 82C929, 82C924/82C925 or 82C930) audio interface chip.
  698. These chips are
  699. currently quite common so it's possible that many no-name cards
  700. have one of them. In addition the MAD16 chip is used in some
  701. cards made by known manufacturers such as Turtle Beach (Tropez),
  702. Reveal (some models) and Diamond (some recent models).
  703. Note OPTi 82C924 and 82C925 are MAD16 compatible only in non PnP
  704. mode (jumper selectable on many cards).
  705. "Support for TB Maui"
  706. - This enables TB Maui specific initialization. Works with TB Maui
  707. and TB Tropez (may not work with Tropez Plus).
  708. Then the configuration program asks some y/n questions about the higher
  709. level services. It's recommended to answer 'y' to each of these questions.
  710. Answer 'n' only if you know you will not need the option.
  711. "MIDI interface support",
  712. - Answering 'n' disables /dev/midi## devices and access to any
  713. MIDI ports using /dev/sequencer and /dev/music. This option
  714. also affects any MPU401 and/or General MIDI compatible devices.
  715. "FM synthesizer (YM3812/OPL-3) support",
  716. - Answer 'y' here.
  717. "/dev/sequencer support",
  718. - Answering 'n' disables /dev/sequencer and /dev/music.
  719. Entering the I/O, IRQ and DMA config parameters
  720. -----------------------------------------------
  721. After the above questions the configuration program prompts for the
  722. card specific configuration information. Usually just a set of
  723. I/O address, IRQ and DMA numbers are asked. With some cards the program
  724. asks for some files to be used during initialization of the card. For example
  725. many cards have a DSP chip or microprocessor which must be initialized by
  726. downloading a program (microcode) file to the card.
  727. Instructions for answering these questions are given in the next section.
  728. Card specific information
  729. =========================
  730. This section gives additional instructions about configuring some cards.
  731. Please refer manual of your card for valid I/O, IRQ and DMA numbers. Using
  732. the same settings with DOS/Windows and Linux is recommended. Using
  733. different values could cause some problems when switching between
  734. different operating systems.
  735. Sound Blasters (the original ones by Creative)
  736. ---------------------------------------------
  737. NOTE! Check if you have a PnP Sound Blaster (cards sold after summer 1995
  738. are almost certainly PnP ones). With PnP cards you should use isapnptools
  739. to activate them (see above).
  740. It's possible to configure these cards to use different I/O, IRQ and
  741. DMA settings. Since the possible/default settings have changed between various
  742. models, you have to consult manual of your card for the proper ones. It's
  743. a good idea to use the same values than with DOS/Windows. With SB and SB Pro
  744. it's the only choice. SB16 has software selectable IRQ and DMA channels but
  745. using different values with DOS and Linux is likely to cause troubles. The
  746. DOS driver is not able to reset the card properly after warm boot from Linux
  747. if Linux has used different IRQ or DMA values.
  748. The original (steam) Sound Blaster (versions 1.x and 2.x) use always
  749. DMA1. There is no way to change it.
  750. The SB16 needs two DMA channels. A 8 bit one (1 or 3) is required for
  751. 8 bit operation and a 16 bit one (5, 6 or 7) for the 16 bit mode. In theory
  752. it's possible to use just one (8 bit) DMA channel by answering the 8 bit
  753. one when the configuration program asks for the 16 bit one. This may work
  754. in some systems but is likely to cause terrible noise on some other systems.
  755. It's possible to use two SB16/32/64 at the same time. To do this you should
  756. first configure OSS/Free for one card. Then edit local.h manually and define
  757. SB2_BASE, SB2_IRQ, SB2_DMA and SB2_DMA2 for the second one. You can't get
  758. the OPL3, MIDI and EMU8000 devices of the second card to work. If you are
  759. going to use two PnP Sound Blasters, ensure that they are of different model
  760. and have different PnP IDs. There is no way to get two cards with the same
  761. card ID and serial number to work. The easiest way to check this is trying
  762. if isapnptools can see both cards or just one.
  763. NOTE! Don't enable the SM Games option (asked by the configuration program)
  764. if you are not 101% sure that your card is a Logitech Soundman Games
  765. (not a SM Wave or SM16).
  766. SB Clones
  767. ---------
  768. First of all: There are no SB16 clones. There are SB Pro clones with a
  769. 16 bit mode which is not SB16 compatible. The most likely alternative is that
  770. the 16 bit mode means MSS/WSS.
  771. There are just a few fully 100% hardware SB or SB Pro compatible cards.
  772. I know just Thunderboard and SM Games. Other cards require some kind of
  773. hardware initialization before they become SB compatible. Check if your card
  774. was listed in the beginning of this file. In this case you should follow
  775. instructions for your card later in this file.
  776. For other not fully SB clones you may try initialization using DOS in
  777. the following way:
  778. - Boot DOS so that the card specific driver gets run.
  779. - Hit ctrl-alt-del (or use loadlin) to boot Linux. Don't
  780. switch off power or press the reset button.
  781. - If you use the same I/O, IRQ and DMA settings in Linux, the
  782. card should work.
  783. If your card is both SB and MSS compatible, I recommend using the MSS mode.
  784. Most cards of this kind are not able to work in the SB and the MSS mode
  785. simultaneously. Using the MSS mode provides 16 bit recording and playback.
  786. ProAudioSpectrum 16 and compatibles
  787. -----------------------------------
  788. PAS16 has a SB emulation chip which can be used together with the native
  789. (16 bit) mode of the card. To enable this emulation you should configure
  790. the driver to have SB support too (this has been changed since version
  791. 3.5-beta9 of this driver).
  792. With current driver versions it's also possible to use PAS16 together with
  793. another SB compatible card. In this case you should configure SB support
  794. for the other card and to disable the SB emulation of PAS16 (there is a
  795. separate questions about this).
  796. With PAS16 you can use two audio device files at the same time. /dev/dsp (and
  797. /dev/audio) is connected to the 8/16 bit native codec and the /dev/dsp1 (and
  798. /dev/audio1) is connected to the SB emulation (8 bit mono only).
  799. Gravis Ultrasound
  800. -----------------
  801. There are many different revisions of the Ultrasound card (GUS). The
  802. earliest ones (pre 3.7) don't have a hardware mixer. With these cards
  803. the driver uses a software emulation for synth and pcm playbacks. It's
  804. also possible to switch some of the inputs (line in, mic) off by setting
  805. mixer volume of the channel level below 10%. For recording you have
  806. to select the channel as a recording source and to use volume above 10%.
  807. GUS 3.7 has a hardware mixer.
  808. GUS MAX and the 16 bit sampling daughtercard have a CS4231 codec chip which
  809. also contains a mixer.
  810. Configuring GUS is simple. Just enable the GUS support and GUS MAX or
  811. the 16 bit daughtercard if you have them. Note that enabling the daughter
  812. card disables GUS MAX driver.
  813. NOTE for owners of the 16 bit daughtercard: By default the daughtercard
  814. uses /dev/dsp (and /dev/audio). Command "ln -sf /dev/dsp1 /dev/dsp"
  815. selects the daughter card as the default device.
  816. With just the standard GUS enabled the configuration program prompts
  817. for the I/O, IRQ and DMA numbers for the card. Use the same values than
  818. with DOS.
  819. With the daughter card option enabled you will be prompted for the I/O,
  820. IRQ and DMA numbers for the daughter card. You have to use different I/O
  821. and DMA values than for the standard GUS. The daughter card permits
  822. simultaneous recording and playback. Use /dev/dsp (the daughtercard) for
  823. recording and /dev/dsp1 (GUS GF1) for playback.
  824. GUS MAX uses the same I/O address and IRQ settings than the original GUS
  825. (GUS MAX = GUS + a CS4231 codec). In addition an extra DMA channel may be used.
  826. Using two DMA channels permits simultaneous playback using two devices
  827. (dev/dsp0 and /dev/dsp1). The second DMA channel is required for
  828. full duplex audio.
  829. To enable the second DMA channels, give a valid DMA channel when the config
  830. program asks for the GUS MAX DMA (entering -1 disables the second DMA).
  831. Using 16 bit DMA channels (5,6 or 7) is recommended.
  832. If you have problems in recording with GUS MAX, you could try to use
  833. just one 8 bit DMA channel. Recording will not work with one DMA
  834. channel if it's a 16 bit one.
  835. Microphone input of GUS MAX is connected to mixer in little bit nonstandard
  836. way. There is actually two microphone volume controls. Normal "mic" controls
  837. only recording level. Mixer control "speaker" is used to control volume of
  838. microphone signal connected directly to line/speaker out. So just decrease
  839. volume of "speaker" if you have problems with microphone feedback.
  840. GUS ACE works too but any attempt to record or to use the MIDI port
  841. will fail.
  842. GUS PnP (with RAM) is partially supported but it needs to be initialized using
  843. DOS or isapnptools before starting the driver.
  844. MPU401 and Windows Sound System
  845. -------------------------------
  846. Again. Don't enable these options in case your card is listed
  847. somewhere else in this file.
  848. Configuring these cards is obvious (or it should be). With MSS
  849. you should probably enable the OPL3 synth also since
  850. most MSS compatible cards have it. However check that this is true
  851. before enabling OPL3.
  852. Sound driver supports more than one MPU401 compatible cards at the same time
  853. but the config program asks config info for just the first of them.
  854. Adding the second or third MPU interfaces must be done manually by
  855. editing sound/local.h (after running the config program). Add defines for
  856. MPU2_BASE & MPU2_IRQ (and MPU3_BASE & MPU3_IRQ) to the file.
  857. CAUTION!
  858. The default I/O base of Adaptec AHA-1542 SCSI controller is 0x330 which
  859. is also the default of the MPU401 driver. Don't configure the sound driver to
  860. use 0x330 as the MPU401 base if you have a AHA1542. The kernel will not boot
  861. if you make this mistake.
  862. PSS
  863. ---
  864. Even the PSS cards are compatible with SB, MSS and MPU401, you must not
  865. enable these options when configuring the driver. The configuration
  866. program handles these options itself. (You may use the SB, MPU and MSS options
  867. together with PSS if you have another card on the system).
  868. The PSS driver enables MSS and MPU401 modes of the card. SB is not enabled
  869. since it doesn't work concurrently with MSS. The driver loads also a
  870. DSP algorithm which is used to for the general MIDI emulation. The
  871. algorithm file (.ld) is read by the config program and written to a
  872. file included when the pss.c is compiled. For this reason the config
  873. program asks if you want to download the file. Use the genmidi.ld file
  874. distributed with the DOS/Windows drivers of the card (don't use the mt32.ld).
  875. With some cards the file is called 'synth.ld'. You must have access to
  876. the file when configuring the driver. The easiest way is to mount the DOS
  877. partition containing the file with Linux.
  878. It's possible to load your own DSP algorithms and run them with the card.
  879. Look at the directory pss_test of snd-util-3.0.tar.gz for more info.
  880. AudioTrix Pro
  881. -------------
  882. You have to enable the OPL3 and SB (not SB Pro or SB16) drivers in addition
  883. to the native AudioTrix driver. Don't enable MSS or MPU drivers.
  884. Configuring ATP is little bit tricky since it uses so many I/O, IRQ and
  885. DMA numbers. Using the same values than with DOS/Win is a good idea. Don't
  886. attempt to use the same IRQ or DMA channels twice.
  887. The SB mode of ATP is implemented so the ATP driver just enables SB
  888. in the proper address. The SB driver handles the rest. You have to configure
  889. both the SB driver and the SB mode of ATP to use the same IRQ, DMA and I/O
  890. settings.
  891. Also the ATP has a microcontroller for the General MIDI emulation (OPL4).
  892. For this reason the driver asks for the name of a file containing the
  893. microcode (TRXPRO.HEX). This file is usually located in the directory
  894. where the DOS drivers were installed. You must have access to this file
  895. when configuring the driver.
  896. If you have the effects daughtercard, it must be initialized by running
  897. the setfx program of snd-util-3.0.tar.gz package. This step is not required
  898. when using the (future) binary distribution version of the driver.
  899. Ensoniq SoundScape
  900. ------------------
  901. NOTE! The new PnP SoundScape is not supported yet. Soundscape compatible
  902. cards made by Reveal don't work with Linux. They use older revision
  903. of the Soundscape chipset which is not fully compatible with
  904. newer cards made by Ensoniq.
  905. The SoundScape driver handles initialization of MSS and MPU supports
  906. itself so you don't need to enable other drivers than SoundScape
  907. (enable also the /dev/dsp, /dev/sequencer and MIDI supports).
  908. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  909. !!!!! !!!!
  910. !!!!! NOTE! Before version 3.5-beta6 there WERE two sets of audio !!!!
  911. !!!!! device files (/dev/dsp0 and /dev/dsp1). The first one WAS !!!!
  912. !!!!! used only for card initialization and the second for audio !!!!
  913. !!!!! purposes. It WAS required to change /dev/dsp (a symlink) to !!!!
  914. !!!!! point to /dev/dsp1. !!!!
  915. !!!!! !!!!
  916. !!!!! This is not required with OSS versions 3.5-beta6 and later !!!!
  917. !!!!! since there is now just one audio device file. Please !!!!
  918. !!!!! change /dev/dsp to point back to /dev/dsp0 if you are !!!!
  919. !!!!! upgrading from an earlier driver version using !!!!
  920. !!!!! (cd /dev;rm dsp;ln -s dsp0 dsp). !!!!
  921. !!!!! !!!!
  922. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  923. The configuration program asks one DMA channel and two interrupts. One IRQ
  924. and one DMA is used by the MSS codec. The second IRQ is required for the
  925. MPU401 mode (you have to use different IRQs for both purposes).
  926. There were earlier two DMA channels for SoundScape but the current driver
  927. version requires just one.
  928. The SoundScape card has a Motorola microcontroller which must initialized
  929. _after_ boot (the driver doesn't initialize it during boot).
  930. The initialization is done by running the 'ssinit' program which is
  931. distributed in the snd-util-3.0.tar.gz package. You have to edit two
  932. defines in the ssinit.c and then compile the program. You may run ssinit
  933. manually (after each boot) or add it to /etc/rc.d/rc.local.
  934. The ssinit program needs the microcode file that comes with the DOS/Windows
  935. driver of the card. You will need to use version 1.30.00 or later
  936. of the microcode file (sndscape.co0 or sndscape.co1 depending on
  937. your card model). THE OLD sndscape.cod WILL NOT WORK. IT WILL HANG YOUR
  938. MACHINE. The only way to get the new microcode file is to download
  939. and install the DOS/Windows driver from ftp://ftp.ensoniq.com/pub.
  940. Then you have to select the proper microcode file to use: soundscape.co0
  941. is the right one for most cards and sndscape.co1 is for few (older) cards
  942. made by Reveal and/or Spea. The driver has capability to detect the card
  943. version during boot. Look at the boot log messages in /var/adm/messages
  944. and locate the sound driver initialization message for the SoundScape
  945. card. If the driver displays string <Ensoniq Soundscape (old)>, you have
  946. an old card and you will need to use sndscape.co1. For other cards use
  947. soundscape.co0. New Soundscape revisions such as Elite and PnP use
  948. code files with higher numbers (.co2, .co3, etc.).
  949. NOTE! Ensoniq Soundscape VIVO is not compatible with other Soundscape cards.
  950. Currently it's possible to use it in Linux only with OSS/Linux
  951. drivers.
  952. Check /var/adm/messages after running ssinit. The driver prints
  953. the board version after downloading the microcode file. That version
  954. number must match the number in the name of the microcode file (extension).
  955. Running ssinit with a wrong version of the sndscape.co? file is not
  956. dangerous as long as you don't try to use a file called sndscape.cod.
  957. If you have initialized the card using a wrong microcode file (sounds
  958. are terrible), just modify ssinit.c to use another microcode file and try
  959. again. It's possible to use an earlier version of sndscape.co[01] but it
  960. may sound weird.
  961. MAD16 (Pro) and Mozart
  962. ----------------------
  963. You need to enable just the MAD16 /Mozart support when configuring
  964. the driver. _Don't_ enable SB, MPU401 or MSS. However you will need the
  965. /dev/audio, /dev/sequencer and MIDI supports.
  966. Mozart and OPTi 82C928 (the original MAD16) chips don't support
  967. MPU401 mode so enter just 0 when the configuration program asks the
  968. MPU/MIDI I/O base. The MAD16 Pro (OPTi 82C929) and 82C930 chips have MPU401
  969. mode.
  970. TB Tropez is based on the 82C929 chip. It has two MIDI ports.
  971. The one connected to the MAD16 chip is the second one (there is a second
  972. MIDI connector/pins somewhere??). If you have not connected the second MIDI
  973. port, just disable the MIDI port of MAD16. The 'Maui' compatible synth of
  974. Tropez is jumper configurable and not connected to the MAD16 chip (the
  975. Maui driver can be used with it).
  976. Some MAD16 based cards may cause feedback, whistle or terrible noise if the
  977. line3 mixer channel is turned too high. This happens at least with Shuttle
  978. Sound System. Current driver versions set volume of line3 low enough so
  979. this should not be a problem.
  980. If you have a MAD16 card which have an OPL4 (FM + Wave table) synthesizer
  981. chip (_not_ an OPL3), you have to append a line containing #define MAD16_OPL4
  982. to the file linux/drivers/sound/local.h (after running make config).
  983. MAD16 cards having a CS4231 codec support full duplex mode. This mode
  984. can be enabled by configuring the card to use two DMA channels. Possible
  985. DMA channel pairs are: 0&1, 1&0 and 3&0.
  986. NOTE! Cards having an OPTi 82C924/82C925 chip work with OSS/Free only in
  987. non-PnP mode (usually jumper selectable). The PnP mode is supported only
  988. by OSS/Linux.
  989. MV Jazz (ProSonic)
  990. ------------------
  991. The Jazz16 driver is just a hack made to the SB Pro driver. However it works
  992. fairly well. You have to enable SB, SB Pro (_not_ SB16) and MPU401 supports
  993. when configuring the driver. The configuration program asks later if you
  994. want support for MV Jazz16 based cards (after asking SB base address). Answer
  995. 'y' here and the driver asks the second (16 bit) DMA channel.
  996. The Jazz16 driver uses the MPU401 driver in a way which will cause
  997. problems if you have another MPU401 compatible card. In this case you must
  998. give address of the Jazz16 based MPU401 interface when the config
  999. program prompts for the MPU401 information. Then look at the MPU401
  1000. specific section for instructions about configuring more than one MPU401 cards.
  1001. Logitech Soundman Wave
  1002. ----------------------
  1003. Read the above MV Jazz specific instructions first.
  1004. The Logitech SoundMan Wave (don't confuse this with the SM16 or SM Games) is
  1005. a MV Jazz based card which has an additional OPL4 based wave table
  1006. synthesizer. The OPL4 chip is handled by an on board microcontroller
  1007. which must be initialized during boot. The config program asks if
  1008. you have a SM Wave immediately after asking the second DMA channel of jazz16.
  1009. If you answer 'y', the config program will ask name of the file containing
  1010. code to be loaded to the microcontroller. The file is usually called
  1011. MIDI0001.BIN and it's located in the DOS/Windows driver directory. The file
  1012. may also be called as TSUNAMI.BIN or something else (older cards?).
  1013. The OPL4 synth will be inaccessible without loading the microcontroller code.
  1014. Also remember to enable SB MPU401 support if you want to use the OPL4 mode.
  1015. (Don't enable the 'normal' MPU401 device as with some earlier driver
  1016. versions (pre 3.5-alpha8)).
  1017. NOTE! Don't answer 'y' when the driver asks about SM Games support
  1018. (the next question after the MIDI0001.BIN name). However
  1019. answering 'y' doesn't cause damage your computer so don't panic.
  1020. Sound Galaxies
  1021. --------------
  1022. There are many different Sound Galaxy cards made by Aztech. The 8 bit
  1023. ones are fully SB or SB Pro compatible and there should be no problems
  1024. with them.
  1025. The older 16 bit cards (SG Pro16, SG NX Pro16, Nova and Lyra) have
  1026. an EEPROM chip for storing the configuration data. There is a microcontroller
  1027. which initializes the card to match the EEPROM settings when the machine
  1028. is powered on. These cards actually behave just like they have jumpers
  1029. for all of the settings. Configure driver for MSS, MPU, SB/SB Pro and OPL3
  1030. supports with these cards.
  1031. There are some new Sound Galaxies in the market. I have no experience with
  1032. them so read the card's manual carefully.
  1033. ESS ES1688 and ES688 'AudioDrive' based cards
  1034. ---------------------------------------------
  1035. Support for these two ESS chips is embedded in the SB driver.
  1036. Configure these cards just like SB. Enable the 'SB MPU401 MIDI port'
  1037. if you want to use MIDI features of ES1688. ES688 doesn't have MPU mode
  1038. so you don't need to enable it (the driver uses normal SB MIDI automatically
  1039. with ES688).
  1040. NOTE! ESS cards are not compatible with MSS/WSS so don't worry if MSS support
  1041. of OSS doesn't work with it.
  1042. There are some ES1688/688 based sound cards and (particularly) motherboards
  1043. which use software configurable I/O port relocation feature of the chip.
  1044. This ESS proprietary feature is supported only by OSS/Linux.
  1045. There are ES1688 based cards which use different interrupt pin assignment than
  1046. recommended by ESS (5, 7, 9/2 and 10). In this case all IRQs don't work.
  1047. At least a card called (Pearl?) Hypersound 16 supports IRQ 15 but it doesn't
  1048. work.
  1049. ES1868 is a PnP chip which is (supposed to be) compatible with ESS1688
  1050. probably works with OSS/Free after initialization using isapnptools.
  1051. Reveal cards
  1052. ------------
  1053. There are several different cards made/marketed by Reveal. Some of them
  1054. are compatible with SoundScape and some use the MAD16 chip. You may have
  1055. to look at the card and try to identify its origin.
  1056. Diamond
  1057. -------
  1058. The oldest (Sierra Aria based) sound cards made by Diamond are not supported
  1059. (they may work if the card is initialized using DOS). The recent (LX?)
  1060. models are based on the MAD16 chip which is supported by the driver.
  1061. Audio Excel DSP16
  1062. -----------------
  1063. Support for this card is currently not functional. A new driver for it
  1064. should be available later this year.
  1065. PCMCIA cards
  1066. ------------
  1067. Sorry, can't help. Some cards may work and some don't.
  1068. TI TM4000M notebooks
  1069. --------------------
  1070. These computers have a built in sound support based on the Jazz chipset.
  1071. Look at the instructions for MV Jazz (above). It's also important to note
  1072. that there is something wrong with the mouse port and sound at least on
  1073. some TM models. Don't enable the "C&T 82C710 mouse port support" when
  1074. configuring Linux. Having it enabled is likely to cause mysterious problems
  1075. and kernel failures when sound is used.
  1076. miroSOUND
  1077. ---------
  1078. The miroSOUND PCM1-pro, PCM12 and PCM20 radio has been used
  1079. successfully. These cards are based on the MAD16, OPL4, and CS4231A chips
  1080. and everything said in the section about MAD16 cards applies here,
  1081. too. The only major difference between the PCMxx and other MAD16 cards
  1082. is that instead of the mixer in the CS4231 codec a separate mixer
  1083. controlled by an on-board 80C32 microcontroller is used. Control of
  1084. the mixer takes place via the ACI (miro's audio control interface)
  1085. protocol that is implemented in a separate lowlevel driver. Make sure
  1086. you compile this ACI driver together with the normal MAD16 support
  1087. when you use a miroSOUND PCMxx card. The ACI mixer is controlled by
  1088. /dev/mixer and the CS4231 mixer by /dev/mixer1 (depends on load
  1089. time). Only in special cases you want to change something regularly on
  1090. the CS4231 mixer.
  1091. The miroSOUND PCM12 and PCM20 radio is capable of full duplex
  1092. operation (simultaneous PCM replay and recording), which allows you to
  1093. implement nice real-time signal processing audio effect software and
  1094. network telephones. The ACI mixer has to be switched into the "solo"
  1095. mode for duplex operation in order to avoid feedback caused by the
  1096. mixer (input hears output signal). You can de-/activate this mode
  1097. through toggling the record button for the wave controller with an
  1098. OSS-mixer.
  1099. The PCM20 contains a radio tuner, which is also controlled by
  1100. ACI. This radio tuner is supported by the ACI driver together with the
  1101. miropcm20.o module. Also the 7-band equalizer is integrated
  1102. (limited by the OSS-design). Development has started and maybe
  1103. finished for the RDS decoder on this card, too. You will be able to
  1104. read RadioText, the Programme Service name, Programme TYpe and
  1105. others. Even the v4l radio module benefits from it with a refined
  1106. strength value. See aci.[ch] and miropcm20*.[ch] for more details.
  1107. The following configuration parameters have worked fine for the PCM12
  1108. in Markus Kuhn's system, many other configurations might work, too:
  1109. CONFIG_MAD16_BASE=0x530, CONFIG_MAD16_IRQ=11, CONFIG_MAD16_DMA=3,
  1110. CONFIG_MAD16_DMA2=0, CONFIG_MAD16_MPU_BASE=0x330, CONFIG_MAD16_MPU_IRQ=10,
  1111. DSP_BUFFSIZE=65536, SELECTED_SOUND_OPTIONS=0x00281000.
  1112. Bas van der Linden is using his PCM1-pro with a configuration that
  1113. differs in: CONFIG_MAD16_IRQ=7, CONFIG_MAD16_DMA=1, CONFIG_MAD16_MPU_IRQ=9
  1114. Compaq Deskpro XL
  1115. -----------------
  1116. The builtin sound hardware of Compaq Deskpro XL is now supported.
  1117. You need to configure the driver with MSS and OPL3 supports enabled.
  1118. In addition you need to manually edit linux/drivers/sound/local.h and
  1119. to add a line containing "#define DESKPROXL" if you used
  1120. make menuconfig/xconfig.
  1121. Others?
  1122. -------
  1123. Since there are so many different sound cards, it's likely that I have
  1124. forgotten to mention many of them. Please inform me if you know yet another
  1125. card which works with Linux, please inform me (or is anybody else
  1126. willing to maintain a database of supported cards (just like in XF86)?).
  1127. Cards not supported yet
  1128. =======================
  1129. Please check the version of sound driver you are using before
  1130. complaining that your card is not supported. It's possible you are
  1131. using a driver version which was released months before your card was
  1132. introduced.
  1133. First of all, there is an easy way to make most sound cards work with Linux.
  1134. Just use the DOS based driver to initialize the card to a known state, then use
  1135. loadlin.exe to boot Linux. If Linux is configured to use the same I/O, IRQ and
  1136. DMA numbers as DOS, the card could work.
  1137. (ctrl-alt-del can be used in place of loadlin.exe but it doesn't work with
  1138. new motherboards). This method works also with all/most PnP sound cards.
  1139. Don't get fooled with SB compatibility. Most cards are compatible with
  1140. SB but that may require a TSR which is not possible with Linux. If
  1141. the card is compatible with MSS, it's a better choice. Some cards
  1142. don't work in the SB and MSS modes at the same time.
  1143. Then there are cards which are no longer manufactured and/or which
  1144. are relatively rarely used (such as the 8 bit ProAudioSpectrum
  1145. models). It's extremely unlikely that such cards ever get supported.
  1146. Adding support for a new card requires much work and increases time
  1147. required in maintaining the driver (some changes need to be done
  1148. to all low level drivers and be tested too, maybe with multiple
  1149. operating systems). For this reason I have made a decision to not support
  1150. obsolete cards. It's possible that someone else makes a separately
  1151. distributed driver (diffs) for the card.
  1152. Writing a driver for a new card is not possible if there are no
  1153. programming information available about the card. If you don't
  1154. find your new card from this file, look from the home page
  1155. (http://www.opensound.com/ossfree). Then please contact
  1156. manufacturer of the card and ask if they have (or are willing to)
  1157. released technical details of the card. Do this before contacting me. I
  1158. can only answer 'no' if there are no programming information available.
  1159. I have made decision to not accept code based on reverse engineering
  1160. to the driver. There are three main reasons: First I don't want to break
  1161. relationships to sound card manufacturers. The second reason is that
  1162. maintaining and supporting a driver without any specs will be a pain.
  1163. The third reason is that companies have freedom to refuse selling their
  1164. products to other than Windows users.
  1165. Some companies don't give low level technical information about their
  1166. products to public or at least their require signing a NDA. It's not
  1167. possible to implement a freeware driver for them. However it's possible
  1168. that support for such cards become available in the commercial version
  1169. of this driver (see http://www.4Front-tech.com/oss.html for more info).
  1170. There are some common audio chipsets that are not supported yet. For example
  1171. Sierra Aria and IBM Mwave. It's possible that these architectures
  1172. get some support in future but I can't make any promises. Just look
  1173. at the home page (http://www.opensound.com/ossfree/)
  1174. for latest info.
  1175. Information about unsupported sound cards and chipsets is welcome as well
  1176. as free copies of sound cards, SDKs and operating systems.
  1177. If you have any corrections and/or comments, please contact me.
  1178. Hannu Savolainen
  1179. hannu@opensound.com
  1180. home page of OSS/Free: http://www.opensound.com/ossfree
  1181. home page of commercial OSS
  1182. (Open Sound System) drivers: http://www.opensound.com/oss.html