home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 4 Drivers / 04-Drivers.zip / qd1t04a.txt < prev    next >
Text File  |  1998-10-26  |  30KB  |  642 lines
  1.                 Crystal Semiconductor Corporation
  2.                 ---------------------------------
  3.  
  4.  
  5. READ.ME - OS/2 Crystal Audio Device Driver Installation
  6. --------------------------------------------------------------------------
  7. This file contains information on how to install the Crystal Semiconductor
  8. Corporation OS/2 Audio Device drivers.
  9.  
  10. In addition to Crystal Audio driver installation, this diskette includes
  11. the IBM OPL3/FM MIDI synthesis device driver.
  12.  
  13. The following topics are covered in this READ.ME file:
  14. 1)  Installing on top of previous installations
  15. 2)  De-Installation of Sound Blaster Drivers
  16. 3)  System Requirements
  17. 4)  Files List for Crystal Audio Install Disk
  18. 5)  Crystal Audio for OS/2 Installation Procedure
  19. 6)  Device Driver Command Line Options
  20. 7)  Notes on Command Line Options
  21. 8)  Using Audio in DOS and Win-OS/2 Sessions
  22. 9)  Audio Concurrency Issues - OS/2, DOS, Win-OS/2
  23. 10) Plug and Play System Issues
  24. 11) Mixer Issues
  25. 12) DMA Buffer size and interrupt rates
  26. 13) MIDI Synthsis
  27. 14) MPU-401 - Wavetable installations
  28. 15) Web Site
  29. 16) Special notes on upgrading from driver version 1.xx to 2.xx.
  30. 17) Problems/Questions
  31.  
  32.  
  33. 1)  Installing on top of previous installations
  34. -------------------------------------------------------------------------------
  35. This installation supports installation over all previous installations of
  36. Crystal Audio device drivers as well as over-installation of IBM's
  37. OPL-3 device driver.
  38.  
  39. No de-install is necessary prior to executing the OS/2 Multimedia
  40. installation program, minstall.exe.
  41.  
  42. If you already have a non-Crystal device driver set installed,
  43. it may be necessary to de-install those drivers before installing
  44. Crystal Semiconductor audio device drivers.
  45.  
  46.  
  47. 2) De-Installation of Sound Blaster Drivers
  48. --------------------------------------------
  49. With some Crystal Semiconductor parts, when installing OS/2 Merlin,
  50. the system will incorrectly identify a Sound Blaster device - resulting
  51. in erroneous installation of Creative Technologies Sound Blaster OS/2
  52. device drivers.   This error occurs because most Crystal Semiconductor
  53. CODECs include hardware support for Sound Blaster compatibility for DOS
  54. game execution.
  55.  
  56. The Crystal Semiconductor installation (on this diskette) searches for
  57. previous installations of Crystal Semiconductor drivers and
  58. automatically de-installs them as part of the installation process.
  59. It does not de-install Sound Blaster device drivers.
  60.  
  61. If your system presently has Sound Blaster OS/2 device drivers installed
  62. and you do not have a Sound Blaster device installed, then you should
  63. de-install the Sound Blaster OS/2 drivers prior to running this installation.
  64.  
  65. The de-installation of the Sound Blaster OS/2 device drivers requires
  66. the following steps:
  67.  
  68. a) ERASE \MMOS2 and all subdirectories (this removes OS/2 multimedia support)
  69.    Some files won't delete, this is okay.
  70. b) Use OS/2 selective install to re-install OS/2 multimedia support.
  71.    It will auto-detect the wrong device.  You should override
  72.    the auto-detection to remove the Sound Blaster device driver.
  73.    When correct, the installation panel will have no audio devices listed.
  74. c) Complete selective installation and reboot
  75. d) You are now prepared to use this diskette to install Crystal drivers.
  76.  
  77.  
  78. 3)  System Requirements
  79. -------------------------------------------------------------------------------
  80.  
  81. This installation and device drivers work on the following OS/2 systems:
  82.     OS/2 Warp 3.0            ( Warp - Red box )
  83.     OS/2 Warp 3.0 Fullpack   ( Warp - Blue box )
  84.     OS/2 Warp Connect        ( Warp - Blue box )
  85.     OS/2 Warp 4.0            ( Merlin )
  86.  
  87. In the above "Bluebox" and "Redbox" refer literally to the color of the
  88. retail OS/2 box.
  89.  
  90.     Red box => "Warp for Windows".
  91.                Uses previously installed Windows 3.1 binaries for WinOS2.
  92.  
  93.     Blue box => "Full pack".
  94.                Windows 3.1 binaries are shipped with OS/2.
  95.  
  96.  
  97. 4)  File List for Crystal Audio Install Disk
  98. -------------------------------------------------------------------------------
  99.  
  100. List of all files (sorted by name)
  101. ----------------------------------
  102.     AMPMXMCD.DLL - IBM MMOS2 Amp Mixer update, installed Warp 3 if fixpack <26
  103.     AMPMXMCD.F26 - IBM MMOS2 Amp Mixer update, installed Warp 3 if fixpack =26
  104.     AUDIOIF.DLL  - IBM MMOS2 Audio VSD update, installed Warp 3 if fixpack <26
  105.     AUDIOIF.F26  - IBM MMOS2 Audio VSD update, installed Warp 3 if fixpack =26
  106.     CLOCK01.SYS  - IBM High res timer driver/clock, installed Warp 3 only
  107.     CLOCK02.SYS  - IBM High res timer driver/clock, installed Warp 3 only
  108.     CONTROL.SCR  - Installation control file
  109.     CWBAUDI3.DRV - Crystal Windows 3.1 audio driver
  110.     CWBAUDI3.INI - Crystal Windows 3.1 .INI file
  111.     CWBFM.DRV    - Crystal Windows 3.1 FM driver
  112.     CWADD.INI    - Crystal Windows 3.1 system.ini
  113.     CWAUDIO.sys  - Crystal OS/2 Audio PDD/BASEDEV
  114.     CARDINFO.DLL - Installation control resource DLL
  115.     CWINST.DLL   - Crystal installation executable
  116.     CWVAUDIO.SYS - Crystal OS/2 Audio VDD
  117.     FILAUDFM.SCR - Installation control file, audio + FM installation
  118.     FILAUDWT.SCR - Installation control file, audio + MPU-401 installation
  119.     INSTALL.CMD  - Support double-click start of minstall.exe
  120.     MIDIMAP.CFG  - Crystal Windows 3.1 FM MIDI map
  121.     MIDIPLAY.ICO - Installation ICON for FM driver
  122.     OPL3.SYS     - IBM OPL-3/FM OS/2 device driver
  123.     OPL3RES.DLL  - Runtime capabilities for FM driver
  124.     READ.ME      - This file
  125.     TIMER0.SYS   - IBM High res timer driver/clock, installed on Warp only
  126.  
  127.  
  128.  
  129. Files listed by function:
  130.  
  131. Crystal OS/2 Audio driver
  132. -------------------------
  133.     CWAUDIO.SYS  - Crystal OS/2 Audio PDD
  134.     CWVAUDIO.SYS - Crystal OS/2 Audio VDD
  135.  
  136. Crystal Windows 3.1 audio/fm driver
  137. -----------------------------------
  138.     CWBAUDI3.INI - Crystal Windows 3.1 .INI file     (installed on Merlin only)
  139.     MIDIMAP.CFG  - Crystal Windows 3.1 FM MIDI map   (installed on Merlin only)
  140.     CWBFM.DRV    - Crystal Windows 3.1 FM driver     (installed on Merlin only)
  141.     CWBAUDI3.DRV - Crystal Windows 3.1 audio driver  (installed on Merlin only)
  142.     CWADD.INI    - Crystal Windows 3.1 system.ini    (installed on Merlin only)
  143.  
  144. IBM OPL-3/FM OS/2 audio driver
  145. ------------------------------
  146.     OPL3.SYS     - IBM OPL-3/FM OS/2 device driver
  147.     OPL3RES.DLL  - Runtime capabilities for FM driver
  148.     MIDIPLAY.ICO - Installation ICON for OPL-3 driver
  149.  
  150. Warp 3.0 OS Updates: (These are installed only on Warp 3.0 systems)
  151. --------------------
  152.     AMPMXMCD.DLL - IBM MMOS2 Amp Mixer update        (installed Warp 3.0 only)
  153.     AUDIOIF.DLL  - IBM MMOS2 Audio VSD update (Dart) (installed Warp 3.0 only)
  154.     CLOCK01.SYS  - IBM High res timer driver/clock   (installed Warp 3.0 only)
  155.     CLOCK02.SYS  - IBM High res timer driver/clock   (installed Warp 3.0 only)
  156.     TIMER0.SYS   - IBM High res timer driver/clock   (installed Warp 3.0 only)
  157.  
  158. Installation files
  159. ------------------
  160.     CONTROL.SCR  - Installation control file         (read by minstall.exe)
  161.     CTRAUDFM SCR - Installation control file         (copied to control.scr)
  162.     CTRAUDWT SCR   Installation control file         (copied to control.scr)
  163.     FILAUDFM.SCR - Installation control file         (copy list for FM inst)
  164.     FILAUDWT.SCR - Installation control file         (copy list for WT inst)
  165.     CARDINFO.DLL - Installation resource DLL         (read by GenIn.dll)
  166.     CWINST.DLL   - Crystal installation executable   (called by minstall.exe)
  167.     READ.ME      - This file
  168.  
  169.  
  170. 5)  Crystal Audio for OS/2 Installation Procedure
  171. -------------------------------------------------------------------------------
  172. To install device support, insert the Crystal Audio for OS/2 diskette in
  173. drive A: (or whichever drive Crystal Audio for OS/2 diskette is in).
  174. Start the Multimedia Application Install program which is located in the
  175. Multimedia folder on the OS/2 desktop.
  176. Alternatively, you can execute MINSTALL from an OS/2 command prompt.
  177.  
  178. Once you are in the multimedia installation program, select
  179. Source Drive A: (or whichever drive Crystal Audio for OS/2 diskette is in).
  180.  
  181. The installation program will show
  182.    Crystal Audio      (Pre-selected)
  183.    IBM OPL-3 FM MIDI  (Pre-selected)
  184.  
  185. Click the install button to proceed with the installation.  Read and follow
  186. the instructions provided by the installation program.
  187.  
  188. The following files are installed:
  189.  
  190. If system is Pre-Merlin  (Pre OS/2 Warp version 4 - Update CLOCK drivers)
  191.    \OS2\BOOT\CLOCK01.SYS        IBM high resolution timer support
  192.    \OS2\BOOT\CLOCK02.SYS        IBM high resolution timer support
  193.    \OS2\BOOT\TIMER0.SYS         IBM high resolution timer support
  194.  
  195. If system is Pre-Merlin  (Pre OS/2 Warp version 4 and fixpack level < 26)
  196.    \MMOS2\DLL\AMPMXMCD.DLL      IBM DLL for mixer API/DART (from DART DevCon)
  197.    \MMOS2\DLL\AUDIOIF.DLL       IBM DLL for mixer API/DART (from DART DevCon)
  198.  
  199. If system is Pre-Merlin  (Pre OS/2 Warp version 4 and fixpack level is 26)
  200.    \MMOS2\DLL\AMPMXMCD.F26      IBM standard FP 26 DLL (un-do prior installs)
  201.    \MMOS2\DLL\AUDIOIF.F26       IBM standard FP 26 DLL (un-do prior installs)
  202.  
  203. If system is Pre-Merlin  (Pre OS/2 Warp version 4 and fixpack level > 26)
  204.    No MMPM/2 system DLLs are updated
  205.  
  206. If IBM OPL3 is installed:
  207.    \MMOS2\OPL3.SYS             IBM FM Driver
  208.    \MMOS2\DLL\OPL3RES.DLL      IBM FM Driver runtime support DLL
  209.    \MMOS2\INSTALL\MIDIPLAY.ICO Installation ICON
  210.  
  211. If Crystal Audio is installed:
  212.    \OS2\BOOT\CWAUDIO.SYS        Crystal OS/2 Audio device driver
  213.    \MMOS2\CWVAUDIO.sys          Crystal OS/2 Virtual Device Driver
  214.    \MMOS2\DLL\CWINST.DLL        Crystal installation DLL
  215.  
  216. These lines lines will be added to the OS/2 CONFIG.SYS file.:
  217.     BASEDEV=CWAUDIO.SYS /N:BSAUD1$ /X1:50 /X2:50 /LCAPT:X1X2
  218.     DEVICE=C:\MMOS2\CWVAUDIO.SYS BSAUD1$
  219.  
  220. If OPL-3/FM is installed:
  221.     BASEDEV=TIMER0.SYS
  222.     DEVICE=C:\MMOS2\OPL3.SYS /P:388 /N:OPL31$
  223.  
  224.  
  225. 6)  Device Driver Command Line Options
  226. -------------------------------------------------------------------------------
  227. The following tables describe the various command line options and setting
  228. available for the Crystal Audio device drivers.
  229.  
  230. The options for setting IRQ/IO/DMA should be used only where
  231. the default settings, BIOS assigned settings or operating system
  232. assigned settings are not appropriate.
  233.  
  234. Run driver with "/V" to query how the codec was initialized.
  235. See section "10" for more information.
  236.  
  237. CWAUDIO.SYS    -   OS/2 audio configuration device driver.
  238.  
  239. Option/Format  Description           Valid Values (* = Default Value)
  240. --------------------------------------------------------------------------------
  241. /N:<name>      Name of PDD           BSAUD1$ (Supplied by install)
  242. /V             Verbose Display
  243. /X1:<percent>  AUX1 unmute/gain      0..100 (decimal) (*50) (usually "Line-In")
  244. /X2:<percent>  AUX2 unmute/gain      0..100 (decimal) (*50) (usually CD-ROM)
  245. /L:<percent>   LINE unmute/gain      0..100 (decimal) (*100)(FM volume)
  246. /LCAPT:<input> Line-In record source X1, X2, *X1X2, L (X1X2 is mixed aux1+aux2)
  247. /T:<value>     Inactivity power down 1..5 minutes     (*1)
  248. /MBY:<0,1>     Mono bypass           *1 (mono-in connected to mono-out)
  249. /MIM:<0,1>     Mono input mute       *1 (mono-in not connected to input mixer)
  250. /MOM:<0,1>     Mono out mute         *0 (audible)
  251. /XCTRL0:<0,1>  XCTRL0 Pin set        System specific.  Sometimes used to
  252. /XCTRL1:<0,1>  XCTRL1 Pin set        control power to amplifier.  On IBM
  253.                                      Aptiva with Bose speakers, set both to 1
  254.  
  255. /P:<port>      Codec Port            *534, 608, (530..FF8, divisible by 4)
  256. /I:<irq>       Codec IRQ             *5, 7, 9, 11, 15 (decimal)
  257. /D:<pDMA,cDMA> Codec DMA             0, 1, 3 (Default 1,0)
  258. /C:<port>      Control Port          120, *538, (120..FF8, divisible by 8)
  259. /J:<port>      Joystick Port         *200, 208, NONE
  260. /S:<port>      Sound Blaster Port    *220, 240, 260, 280, NONE
  261. /M:<port,irq>  MPU Port and IRQ      *330, NONE, (300..3E0, divisible by 8)
  262.                                      IRQ: 7, 9, 11, 12, 15, *NONE
  263. /F:<port>      FM synth port         *388, NONE, (388..3F8, divisible by 8)
  264.  
  265. /IRQRate:dd    Target interrupt rate *32  Range: 1..64 interrupts per second
  266. /DMASize:nnnn  DMA Buf size maximum  *8192 Range: 256..16384 (2 IRQs/Buffer)
  267.                                      
  268.  
  269.  
  270. CWVAUDIO.SYS   - OS/2 audio virtual device driver.
  271.  
  272. Option/Format  Description               Valid Values (* = Default Value)
  273. ---------------------------------------------------------------------------
  274.                Name of PDD              Supplied by install program (*BSAUD1$)
  275. /S             Skip DOS Envir Var Scan  (*not enabled)
  276.  
  277.  
  278. OPL3.SYS       - IBM FM/OPL-3 MIDI Synthesis Physical Device Driver
  279.  
  280. /P:nnn         Base I/O: Sets the base I/O address for FM device.
  281.                Is almost always, 388 (nnn is in hex)
  282.  
  283.  
  284.  
  285. 7) Notes on Command Line Options
  286. -------------------------------------------------------------------------------
  287.  
  288.  CWVAUDIO.SYS /S Option:
  289.  The CWVAUDIO.SYS driver will automatically set a 'BLASTER' DOS environment
  290.  variable to the proper audio hardware settings.  This is done by adding a
  291.  '@SET BLASTER=' line to the beginning of all DOS session's autoexec file.
  292.  This file is specified in DOS session's DOS_AUTOEXEC property.  The /S option
  293.  for CWVAUDIO.SYS will skip the automatic setting of this environment variable.
  294.  
  295.  
  296. 8) Using Audio in DOS and Win-OS/2 Sessions
  297. -------------------------------------------------------------------------------
  298. Crystal Semiconductor device drivers provide outstanding support for WinOS2.
  299.  
  300. - Crystal Windows drivers are automatically installed for WinOS2 use.
  301. - Crystal Windows drivers are OS/2 aware and communicate with OS/2 audio
  302.   drivers to manage concurancy issues.
  303.  
  304.  
  305. For most users, this support prevents concurancy related errors from
  306. occuring.  Still, they can occur.  Some details on concurancy and
  307. other tips for WinOS2 and DOS game execution follow:
  308.  
  309.  
  310. The installation automatically configures WinOS2 Audio when you install Crystal
  311. Audio drivers.  Windows audio drivers are installed for OS/2 Fullpack systems
  312. only.  OS/2 Red Box systems which use the Microsoft Win 3.1 binaries will use
  313. the Crystal Audio Windows 3.1 drivers that are used in native DOS/Win 3.1.
  314. In either installation case, the Crystal Audio drivers used for WinOS2 are
  315. the same.  That is, there is no special set of drivers for WinOS2.
  316.  
  317. The Crystal Windows 3.1 drivers are OS/2 aware and when loaded under WinOS2
  318. communicate with the OS/2 Physical Device Drivers to negotiate access to
  319. the audio device.
  320.  
  321. To enable game processing, the following DOS properties are commonly set.
  322. This is not done automatically by the installation.  Many of the below
  323. DOS properties default to the correct settings.
  324.  
  325.     WIN_RUN_MODE                 3.1 ENHANCED COMPATIBILITY
  326.     AUDIO_ADAPTER_SHARING        Required
  327.     INT_DURING_IO                On  ( This is the most critical setting )
  328.     HW_TIMER                     On
  329.     VIDEO_SWITCH_NOTIFICATION    On
  330.     VIDEO_8514A_XGA_IOTRAP       Off
  331.     VIDEO_RETRACE_EMULATION      Off ( This setting critical for graphics )
  332.     DPMI_MEMORY_LIMIT            8
  333.  
  334.  
  335. 9) Audio Concurrency Issues - OS/2, DOS, Win-OS/2
  336. -------------------------------------------------------------------------------
  337.  
  338. When you have a single audio device, it is not possible for two programs
  339. to use the device at the same time.  For example, if one application has
  340. the device configured for audio playback, and a second application
  341. also wishes to perform audio playback, a conflict exists.
  342.  
  343. The OS/2 multimedia subsystem (MMPM/2) is designed such that, when an
  344. application is running in the foreground (has focus), then that application
  345. takes priority over others running in the background.
  346. MMPM/2 manages the device contention, forcing pauses and resumes to
  347. pass use of the device to the current focus application.
  348.  
  349. This robust support is only available for OS/2 native applications.
  350.  
  351. When DOS games or WinOS2 drivers try to use the device, MMPM/2 is not
  352. involved and cannot force an application off the device.  When the DOS
  353. environment is using the audio device, MMPM/2 is locked out.
  354. This creates an opportunity for contention.
  355.  
  356. To minimize the impact of this problem, Crystal Semiconductor's WinOS2
  357. drivers are OS/2 aware.  They communicate with their OS/2 counterparts
  358. to release use of the device at all times when WinOS2 is quiet.
  359. This is a vast improvement versus many other OS/2 device driver sets.
  360.  
  361. When WinOS2 is quiet, it is "idle" and will not prevent MMPM/2 or other
  362. WinOS2 or DOS sessions from using the device.  This also allows you to
  363. run multiple separate WinOS2 sessions with no concern of audio sharing
  364. between the sessions.
  365.  
  366. MMPM/2 by contrast considers the device "busy" when ever an OS/2
  367. multimedia application is loaded.  For example, loading the OS/2 shipped
  368. Digital Audio player will prevent WinOS2 from using the audio device.
  369. This is often not an issue as the most prevalent OS/2 multimedia
  370. application, system sounds, releases the device after each sound is played.
  371.  
  372. DOS games are unaware of other entities in the system and
  373. do not respond well to being kicked off the device.
  374. A running DOS game will prevent OS/2 and WinOS2 from using the audio device.
  375.  
  376.  
  377. For more information on this subject, see OS/2 online documentation
  378.  
  379.     VIEW /AUDIO
  380.     VIEW /MULTIMEDIA
  381.     VIEW /SOUNDS
  382.  
  383.  
  384. 10) Plug and Play System Issues
  385. -------------------------------------------------------------------------------
  386. PnP configuration is used to assign IRQ/IO/DMA resources to the Crystal
  387. audio device.
  388.  
  389. The following entities can perform PnP configuration:
  390.  
  391. 1. OS/2 Warp 4.0 configuration manager.  Warp 3 is not PnP aware.
  392. 2. PnP ISA BIOS - common on desktop computers
  393. 3. PnP BIOS System device node - common on notebook computers
  394. 4. Crystal audio driver can perform its own PnP initialization.
  395.  
  396. The final device settings are based on a set of default values
  397. in the device driver.  The driver communicates with the operating
  398. system and BIOS at boot to receive information on how these
  399. entities may have configured the audio device.
  400. Finally, the driver supports command line overrides so that
  401. the user can specify a particular set of resources.
  402.  
  403. Where the final settings are different from the BIOS/OS settings,
  404. the device driver performs its own PnP sequence to configure the
  405. audio codec.
  406.  
  407. The use of overrides should not be necessary as the assignment of
  408. resources to devices is a responsibility of the operating system and
  409. system BIOS.  While OS/2 Merlin is a PnP aware OS, it provides no
  410. means for a user to override an OS assigned resource.   This makes
  411. support of device driver overrides a necessiry.
  412.  
  413. Additionally, the Warp 4 OS does not (by default) perform a full
  414. PnP isolation on each boot.  It is possible for discrepancies
  415. to arrise where the OS database of installed devices does not
  416. match the hardware that is actually installed.  This will result
  417. in incorrect information being provided to the device driver at
  418. initialization.  You can command an OS/2 full PnP sequence by
  419. pressing Alt-F1 early in the boot sequence and selection option, F5.
  420.  
  421. The audio driver follows the sequence below for PnP initialization.
  422.  
  423. 1.  Crystal audio device driver has default values
  424. 2.  PnP ISA BIOS is queried to see if it has configured the audio device.
  425. 3.  Warp 4 PnP manager may specify values that it has assigned.
  426. 4.  PnP BIOS is queried regarding system device nodes (notebook computers)
  427. 5.  User supplied command line parameter override Warp and BIOS PnP settings
  428.  
  429.  
  430. 11) Mixer Issues
  431. -------------------------------------------------------------------------------
  432. As of this release, there is no generic OS/2 mixer application.
  433. Therefore, the volume control for devices attached to mixer LINE, AUX1,
  434. and AUX2 is established on the command line of the CWAUDIO.SYS driver.
  435. Refer to section 6, CWAUDIO.SYS, for the format of the unmute and gain
  436. setting  options.
  437.  
  438. These values for gain are set on each boot and cannot be altered during system
  439. operation.  The command line values represent a percentage range 0..100 where
  440. 0 is mute and 100 is maximum volume.
  441. NOTE: This is different than the format of these parameters in earlier
  442. version of the Crystal audio drivers where the settings were dB attenuators.
  443.  
  444. The devices attached to LINE, AUX1, and AUX2 are system dependent but
  445. generally reflect CD-ROM audio playback and sound card line-in jack.
  446. Refer to your system documentation for device configuration.
  447. With the default installation, all inputs are un-muted - which makes CD-ROM
  448. audible.
  449.  
  450. Note:  These settings do not effect standard wave audio volume or record
  451. source and gain which are controlled by the OS/2 volume control icon and
  452. application sliders.
  453.  
  454.  
  455. 12) DMA Buffer size and interrupt rates
  456. -------------------------------------------------------------------------------
  457. The Crystal audio device is a direct memory access (DMA) based audio codec.
  458. Audio data is placed into the DMA memory buffer and then when needed, it
  459. is extracted to the audio codec without action by the CPU.
  460.  
  461. DMA buffer size and interrupt rate are inversly related.  The smaller
  462. the DMA buffer, the higher the interrupt rate.  The audio device 
  463. generates 2 hardware interrupts for each full DMA buffer.
  464.  
  465. Small DMA buffers (high interrupt rates) are needed for applications 
  466. like software motion video and large DMA buffers are desired for high 
  467. datarate applications including playback or record of 16-bit 44K stereo.
  468.  
  469. Curiously, the audio buffers that the device driver receives from
  470. the operating system vary in size.  There is no information provided
  471. to the audio driver to let it know what size buffers will arrive.
  472. The audio driver must size the DMA buffer when a stream starts and
  473. must size the buffer based only on type of data and data rate.
  474.  
  475. For games, the MMPM/2 DART API allows the game developer to specify
  476. the size of data buffers which will be provided to the audio driver.
  477. Again, this information is not relayed to the audio device driver.
  478. Some DART games require DMA buffer sizes which can be at most 4KB.
  479. Sizing the DMA buffer to support these applications may break 
  480. other applications which require larger buffers (CD Audio streaming)
  481.  
  482. The calculation of DMA buffer size is primarly based on desired 
  483. interrupt rate.  The interrupt rate must exceed the frame rate of 
  484. software motion video.
  485.  
  486. The Crystal audio device driver defaults to a DMA buffer size and
  487. interrupt rate that supports the vast majority of applications.  
  488. Still, there are some applications that have particular needs which 
  489. are not served by the default selections.
  490.  
  491. To support cases where the default settings do not work, the driver
  492. supports /DMASIZE and /IRQRATE command line parameters.  
  493.  
  494. The default settings for IRQRATE and DMASIZE are:
  495.      32 Interrupts per second nominal rate.    Range 1..64
  496.    8192 Maximum DMA buffer size (2 IRQs per full buffer) Range 256..16384
  497.  
  498. The driver attempts to maintain 32 (IRQRATE) interrupts per second.  It
  499. should be noted that the interrupt rate must be greater than the frame
  500. rate for software motion video.  DMA buffer size is calculated based
  501. on desired interrupt rate and the physical size limits of DMA buffer.
  502.  
  503. For example: Playback of a system sound, startup.wav
  504.    11025 Sample rate
  505.      * 8 Bits per sample
  506.      * 1 Channel
  507.      / 8 Convert count of bits to count of bytes
  508.    -----
  509.    11025 Bytes per second
  510.  
  511.    Bytes per interrupt = 11025 / 32 => 344
  512.    Bytes for DMA buffer = 344*2 => 688 Bytes.
  513.  
  514. Notice that while DMASIZE defaults to 8KB, only 688 bytes are used
  515. for playback of this file.
  516.  
  517. Another example: Playback of CD quality data (CD digital transfer)
  518.    44100 Sample rate
  519.     * 16 Bits per sample
  520.     *  2 Channels
  521.      / 8 Convert to count of bytes
  522.    -----
  523.   176400 Bytes per second
  524.  
  525.    Bytes per interrupt = 176400 / 32 => 5512
  526.    Bytes for DMA buffer = 5512*2 => 11024 Bytes.
  527.    Since 11024 is greater than 8192 (DMASIZE), the DMA buffer is 
  528.    restricted to a length of 8192 bytes.
  529.    Resulting interrupt rate is 17600/8192 = 43 IRQs/Second.
  530.  
  531. The target interrupt rate and DMASIZE variables in this equation
  532. can be overridden via command line options.
  533.  
  534.  
  535. 13) MIDI Synthesis
  536. -------------------------------------------------------------------------------
  537. This installation diskette includes support to install the IBM OPL3
  538. device driver.   All of the Crystal Semiconductor audio codecs which
  539. support this device driver include an integrated FM synthesizer.
  540.  
  541. The installation pre-selects the IBM OPL3 driver and will install
  542. it unless you de-select this item.
  543.  
  544. You may find that the default FM playback volume is too high or too low.
  545. The output of the FM part is routed through the Crystal Audio CODEC and
  546. its gain/attenuation can be adjusted by changing mixer command line
  547. options on the CWAUDIO.sys audio device driver.
  548.  
  549.  
  550. 14) MPU-401 - Wavetable installations
  551. -------------------------------------------------------------------------------
  552. This section is only applicable if you have MIDI instruments
  553. connected to your computer or if you have a sound card with
  554. hardware wavetable support.
  555.  
  556. A note about having Multiple MPU-401 Devices:
  557.  
  558. To locate MPU-401 hardware, the driver CWMPU401.SYS uses a 
  559. port-scanning technique to find the base I/O address for the MPU-401 
  560. hardware on the sound card.  If there is another MPU-401 device in 
  561. the computer, the MPU-401 driver could detect and use that device 
  562. instead of the one on the sound card.  If this does occur, you 
  563. can perform the following actions to solve the problem:
  564. - Determine what the base I/O address is for the MPU-401 device.
  565.   For example, say it's 340.  On the DEVICE=...\CWMPU401.SYS line,
  566.   replace the "/O:ONLYONE" with "/P1:340".
  567.  
  568.  
  569. 15) Web Site - where to get updated drivers
  570. -------------------------------------------
  571. This device driver supports the following Crystal Semiconductor CODECS:
  572.    CS4236B, CS4237B, CS4238B, CS4235, CS4239
  573. These parts are "mode 3" capable.
  574.  
  575. This device driver should not be used for:
  576.    CS4231, CS4232, CS4236
  577. These parts are "mode 2" capable.  Please get the version 1.xx driver
  578. from the Crystal Semiconductor web site: http://www.crystal.com
  579.  
  580.  
  581. 16) Special notes on upgrading from driver version 1.xx to 2.xx.
  582.  
  583. The Crystal Audio driver included in this package has been
  584. significantly enhanced to utilize Crystals "mode 3" codecs.
  585.  
  586. The driver provides the following enhancements:
  587. a) Supports Crystal "mode 3" audio CODECS:
  588.       CS4236B, CS4237B, CS4238B, CS4235 and CS4239
  589.  
  590.    CS4231, CS4232, CS4236 customers should use driver version 1.7x
  591.    which is available on the Internet:
  592.       http://www.cirrus.com/drivers/audiodrv/
  593.  
  594. a) Full duplex play and record of independent data formats at
  595.    independent sample rates.  On prior driver, the data format
  596.    could be different, but the same rate had to be the same.
  597.  
  598. b) Support for INPUT Mixer.
  599.    Crystal mode 3 codecs can mix input sources in the same
  600.    manner that other devices can mix output signals.
  601.    That is, multiple input sources can be active at one time.
  602.    The signal recorded is the summation of all the selected sources.
  603.  
  604.    OS/2 API is however input "mux" (mutially exclusive) orientated.
  605.    It provides the ability to select record sources "Line-In" and "Mic".
  606.  
  607.    On past device drivers, the logical concept of "Line-In" has defaulted
  608.    to codec input Aux-2.  This did not work for all people as the
  609.    assignment of signals to codec (chip) inputs is board specific.
  610.    To work around board specific issues, the driver provides a
  611.    command line switch to specify the assignment of "line-in".
  612.  
  613.    The new driver is able to associate Line-In to the summation of
  614.    Aux-1 and Aux2 which will work in most cases for CD-Audio record.
  615.    Where necessary, the logical to physical mapping of "Line" can
  616.    be specifically stated with the (/LCAPT:).
  617.  
  618. c) Warp 3 FixPack 26 detection during install ( Warp 3 only )
  619.    Some Warp 3 users have noted that Warp 3 fixpack 26 has OS/2 DART
  620.    support which is better than the DART support installed with prior
  621.    versions of the Crystal installation.   We have historically
  622.    installed MMPM/2 DART DLLs which came from the Developers
  623.    Connection DART CD-ROM.  (ampmxmcd.dll and audioif.dll)
  624.    The Developers Connection version of these DLLs is slightly older
  625.    than the DART support included with MMPM/2 in fixpack 26.
  626.  
  627.    To accommodate both Warp 3 FP26 users and Warp 3 no-fixpack users,
  628.    the Crystal installer has been updated to auto-detect FP26 and
  629.    install DART DLLs appropriate to the service level of the target system.
  630.  
  631.    All files replaced during installation are backed up before being replaced.
  632.    Check file \mmos2\install\minstall.log for details on actions taken
  633.    during installation.
  634.  
  635.    Warp 4 (Merlin): The Crystal installer checks OS/2 version and only
  636.    performs the system component updates on Warp 3 systems.
  637.  
  638. 16) Problems/Questions
  639. -------------------------------------------------------------------------------
  640. Please e-mail problems/questions to the following address:
  641. montalvo@crystal.cirrus.com
  642.