home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 4 Drivers / 04-Drivers.zip / cwos2175.zip / READ.ME < prev    next >
Text File  |  1998-01-06  |  22KB  |  459 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) MIDI Synthsis
  26. 13) De-Installation of Sound Blaster Drivers
  27. 14) Web Site
  28. 15) Problems/Questions
  29.  
  30.  
  31. 1)  Installing on top of previous installations
  32. -------------------------------------------------------------------------------
  33. This installation supports installation over previous
  34. installations of Crystal Audio device drivers as well as
  35. over-installation of IBM's OPL-3 device driver.
  36.  
  37. No de-install is necessary prior to executing the OS/2 Multimedia
  38. installation program, minstall.exe.
  39.  
  40. If you already have a non-Crystal device driver set installed,
  41. it may be necessary to de-install those drivers before installing
  42. Crystal Semiconductor audio device drivers.
  43.  
  44.  
  45. 2) De-Installation of Sound Blaster Drivers
  46. --------------------------------------------
  47. During OS/2 installation, the system auto-detects system audio device.
  48.  
  49. With many Crystal Semiconductor parts, the system will incorrectly
  50. identify a Sound Blaster device - resulting in erroneous installation
  51. of Creative Technologies Sound Blaster OS/2 device drivers.
  52. This error occurs because most Crystal Semiconductor CODECs include
  53. hardware support for Sound Blaster compatibility for DOS game execution.
  54.  
  55. The Crystal Semiconductor installation (on this diskette) searches for
  56. previous installations of Crystal Semiconductor drivers and
  57. automatically de-installs them as part of the installation process.
  58. It however does not de-install Sound Blaster device drivers.
  59.  
  60. If your system presently has Sound Blaster OS/2 device drivers installed
  61. and you do not have a Sound Blaster device installed, then you should
  62. de-install the Sound Blaster OS/2 drivers prior to running this installation.
  63.  
  64. The de-installation of the Sound Blaster OS/2 device drivers requires
  65. the following steps:
  66.  
  67. a) ERASE \MMOS2 and all subdirectories (this removes OS/2 multimedia support)
  68.    Some files won't delete, this is okay.
  69. b) Use OS/2 selective install to re-install OS/2 multimedia support.
  70.    It will auto-detect the wrong device.  You should override
  71.    the auto-detection to remove the Sound Blaster device driver.
  72.    When correct, the installation panel will have no audio devices listed.
  73. c) Complete selective installation and reboot
  74. d) You are now prepared to use this diskette to install Crystal drivers.
  75.  
  76.  
  77. 3)  System Requirements
  78. -------------------------------------------------------------------------------
  79.  
  80. This installation and device drivers work on the following OS/2 systems:
  81.     OS/2 Warp Version 3  ( Warp - Red box )
  82.     OS/2 Warp Fullpack   ( Warp - Blue box )
  83.     OS/2 Warp Connect    ( Warp - Blue box )
  84.     OS/2 Warp Version 4  ( Merlin )
  85.  
  86. In the above "Bluebox" and "Redbox" refer literally to the color of the
  87. retail OS/2 box.
  88.  
  89.     Red box => "Warp for Windows".
  90.                Uses previously installed Windows 3.1 binaries for WinOS2.
  91.  
  92.     Blue box => "Full pack".
  93.                Windows 3.1 binaries are shipped with OS/2.
  94.  
  95.  
  96. 4)  File List for Crystal Audio Install Disk
  97. -------------------------------------------------------------------------------
  98. Crystal Audio Files :
  99. -----------------------------
  100. BSAUDRES.DLL    -   OS/2 business audio support DLL.
  101. CARDINFO.DLL    -   Installation support DLL.
  102. CWAUDIO.HLP     -   Help file used during installation.
  103. CWAUDIO.BIN     -   Audio device microcode.
  104. CWAUDIO.INI     -   File for overriding audio device settings.
  105. CWAUDIO.SYS     -   Audio physical device driver.
  106. CWCONFIG.SYS    -   Audio device configuration device driver.
  107. CWINST.DLL      -   Installation support DLL.
  108. CWVAUDIO.SYS    -   Audio virtual device driver.
  109. CONTROL.SCR     -   Installation control file.
  110. FILES.SCR       -   Installation file list.
  111. READ.ME         -   This file.
  112. AUDIOIF.DLL     -   IBM DLL for mixer support (installed for Warp only)
  113. AMPMXMCD.DLL    -   IBM DLL for mixer support (installed for Warp only)
  114. AUDIOSH.DLL     -   IBM DLL for DART support  (installed for Warp only)
  115. RESOURCE.SYS    -   IBM PnP Resource Manager  (installed for Warp only)
  116. RMVIEW.EXE      -   IBM PnP Resource Manager  (installed for Warp only)
  117. RMINFO.DLL      -   IBM PnP Resource Manager  (installed for Warp only)
  118. TIMER0.SYS      -   IBM Highres timer driver  (installed for Warp only)
  119. CLOCK01.SYS     -   IBM ISA clock driver      (installed for Warp only)
  120. CLOCK02.SYS     -   IBM MCA clock driver      (installed for Warp only)
  121.  
  122. IBM OPL3 Files :
  123. -----------------------------
  124. OPL3.SYS        -   IBM OPL3 FM MIDI Physical Device Driver
  125. OPL3RES.DLL     -   IBM OPL3 FM MIDI device support DLL.
  126. MIDIPLAY.ICO    -   Installation ICON for MIDI driver.
  127.  
  128. WIN-OS/2 Drivers (Installed on Warp/Merlin fullpack systems only)
  129. ----------------
  130. CS32BA11.DRV    -   Windows Wave, Aux, and Mixer Driver
  131. CS32BA11.INI    -   Wave Driver Settings
  132. CSFM.DRV        -   FM MIDI Synthesis Driver
  133. MIDIMAP.CFG     -   Midimapper for FM MIDI Driver
  134. CWADD.INI       -   Sndsys Settings For System.ini
  135.  
  136.  
  137. 5)  Crystal Audio for OS/2 Installation Procedure
  138. -------------------------------------------------------------------------------
  139. To install device support, insert the Crystal Audio for OS/2 diskette in
  140. drive A: (or whichever drive Crystal Audio for OS/2 diskette is in).
  141. Start the Multimedia Application Install program which is located in the
  142. Multimedia folder on the OS/2 desktop.
  143. Alternatively, you can execute MINSTALL from an OS/2 command prompt.
  144.  
  145. Once you are in the multimedia installation program, select
  146. Source Drive A: (or whichever drive Crystal Audio for OS/2 diskette is in).
  147.  
  148. The installation program will show
  149.    Crystal Audio      (Pre-selected)
  150.    IBM OPL-3 FM MIDI  (Pre-selected)
  151.  
  152. Click the install button to proceed with the installation.  Read and follow
  153. the instructions provided by the installation program.  The following files
  154. will be moved onto your system, based on the devices selected :
  155.  
  156. If Crystal Audio is installed :
  157.    \MMOS2\DLL\BSAUDRES.DLL
  158.    \MMOS2\CWAUDIO.SYS
  159.    \MMOS2\CWAUDIO.INI
  160.    \MMOS2\CWAUDIO.BIN
  161.    \MMOS2\CWVAUDIO.SYS
  162.    \OS2\BOOT\CWCONFIG.SYS
  163.  
  164. If IBM OPL3 is installed :
  165.    \MMOS2\OPL3.SYS
  166.    \MMOS2\DLL\OPL3RES.DLL
  167.    \MMOS2\INSTALL\MIDIPLAY.ICO
  168.  
  169. If system is Pre-Merlin  (Pre OS/2 Warp version 4)
  170.    \OS2\BOOT\RESOURCE.SYS       IBM resource manager
  171.    \OS2\RMVIEW.EXE              IBM resource manager application
  172.    \OS2\DLL\RMINFO.DLL          IBM resource manager application
  173.    \OS2\BOOT\CLOCK01.SYS        IBM high resolution timer support
  174.    \OS2\BOOT\CLOCK02.SYS        IBM high resolution timer support
  175.    \OS2\BOOT\TIMER0.SYS         IBM high resolution timer support
  176.    \MMOS2\DLL\AMPMXMCD.DLL      IBM DLL for mixer API
  177.    \MMOS2\DLL\AUDIOIF.DLL       IBM DLL for mixer API
  178.  
  179. These lines lines will be added to the OS/2 CONFIG.SYS file.:
  180.  
  181.     BASEDEV=CWCONFIG.SYS /P:534 /I:5 /D:1,1 /SB:220 /M:330 /FM:388 /J:NONE /CD:NONE
  182.     DEVICE=C:\MMOS2\CWAUDIO.SYS /N:BSAUD1$ /X1:8 /X2:8 /L:8 /LCAPT:X1
  183.     DEVICE=C:\MMOS2\CWVAUDIO.SYS BSAUD1$
  184.  
  185.  
  186. If OPL-3/FM is installed:
  187.     BASEDEV=TIMER0.SYS
  188.     DEVICE=C:\MMOS2\OPL3.SYS /P:388 /N:OPL31$
  189.  
  190.  
  191. 6)  Device Driver Command Line Options
  192. -------------------------------------------------------------------------------
  193. The following tables describe the various command line options and setting
  194. available for the Crystal Audio device drivers.  On PnP systems, many of
  195. these command line parms are ignored.  See section "10" for more information.
  196.  
  197. The available choices for IRQ settings can vary based on the board
  198. implementation.  Consult your device docuementaiton for a list of
  199. valid settings supported by that board.  The settings listed below
  200. are generally valid, but may not be accurate in all cases.
  201.  
  202. CWCONFIG.SYS    -   OS/2 audio configuration device driver.
  203.  
  204. Option/Format       Description                 Valid Values (* = Default Value)
  205. -------------------------------------------------------------------------------
  206. /A:<asic type>      ASIC Type (CS4231 only)     OPTi928, OPTi929, MAD16, GALLANT, *NONE
  207. /P:<port>           Codec Port                  *534, 608, E84, F44 (hex)
  208. /I:<irq>            Codec IRQ                   *5, 7, 9, 10, 11, 12, 15 (dec)
  209. /D:<pDMA,cDMA>      Playback,Capture DMA        0, 1, 3 (*1,1)
  210. /CS:<port>          Control Port                (*not required)
  211. /SB:<port>          Sound Blaster Port          *220, 240, NONE
  212. /M:<port,irq>       MPU Port                    330, *NONE
  213.                     MPU IRQ                     7, 9, 11, 12, 15, *NONE
  214. /FM:<port>          FM Port                     *388, NONE
  215. /J:<port>           Joystick Port               100, 200, *NONE
  216. /CD:<type,port>     CD-ROM Type (CS4231 only)   Sony, Mitsumi, Panasonic, *NONE
  217.                     CD-ROM Port                 320, 330, 340, 360, *NONE
  218. /DL:<option>        Download microcode          Force, No (*not required)
  219. /IFM:<option>       Internal FM (CS4236 only)   *On, Off
  220. /O                  Override PnP settings       (*not enabled)
  221. /V                  Enable Verbose Display      (*not enabled)
  222.  
  223.  
  224. CWAUDIO.SYS     -   OS/2 audio physical device driver.  This driver supports all
  225.                     Crystal Audio devices.
  226.  
  227. Option/Format       Description                 Valid Values (* = Default Value)
  228. -------------------------------------------------------------------------------
  229. /N:<name>           Name of PDD                 Supplied by install program (*BSAUD1$)
  230. /X1:<value>         AUX1 unmute/gain            0..31 (8 = 0dB)  (*not enabled - muted)
  231. /X2:<value>         AUX2 unmute/gain            0..31 (8 = 0dB)  (*not enabled - muted)
  232. /L:<value>          LINE unmute/gain            0..31 (8 = 0dB)  (*not enabled - muted)
  233. /R:<rate>           Enable Adj Intrpt Rate      1..60 (interrupts/sec) (*not enabled)
  234. /EXT                Preserve Mixer Input        (*not enabled)
  235. /LCAPT:<source>     Line capture source         L (line), X1 (AUX1), MX (MixOut)
  236. /M:<option>         Microphone Monitoring       1, On (*not enabled)
  237. /S:<value>          Inactivity power down       1..5 minutes (*not enabled)
  238. /V                  Enable Verbose Display      (*not enabled)
  239.  
  240.  
  241.  
  242. CWVAUDIO.SYS     -  OS/2 audio virtual device driver.  This driver supports all
  243.                     Crystal Audio devices.
  244.  
  245. Option/Format       Description                 Valid Values (* = Default Value)
  246. -------------------------------------------------------------------------------
  247.                     Name of PDD                 Supplied by install program (*BSAUD1$)
  248. /S                  Skip DOS Envir Var Scan     (*not enabled)
  249.  
  250.  
  251.  
  252. OPL3.SYS         -  IBM FM/OPL-3 MIDI Synthesis Physical Device Driver
  253.  
  254.         /P:nnn   Base I/O: Sets the base I/O address for FM device.
  255.                  Is almost always, 388 (nnn is in hex)
  256.  
  257.  
  258.  
  259. 7)  Notes on Command Line Options
  260. -------------------------------------------------------------------------------
  261.  CWAUDIO.INI vs Command line options:
  262.  
  263.  There are two ways to supply CWAUDIO.SYS with options that override default
  264.  settings. The first method is by supplying command-line options in the
  265.  CONFIG.SYS file as specified above. The second method is by supplying entries
  266.  in the CWAUDIO.INI file in the \MMOS2 directory. The first method overrides
  267.  the second on an individual entry basis. Therefore, entries in CWAUDIO.INI
  268.  will be used only when that particular option is not specified in CONFIG.SYS.
  269.  
  270.  Do note, on Merlin systems with PnP audio device, the IRQ/DMA/IO settings
  271.  are taken from the PnP manager rather than the command line.  See readme
  272.  section on PnP for more information.
  273.  
  274.  CWVAUDIO.SYS /S Option:
  275.  The CWVAUDIO.SYS driver will automatically set a 'BLASTER' DOS environment
  276.  variable to the proper audio hardware settings.  This is done by adding a
  277.  '@SET BLASTER=' line to the beginning of all DOS session's autoexec file.
  278.  This file is specified in DOS session's DOS_AUTOEXEC property.  The /S option
  279.  for CWVAUDIO.SYS will skip the automatic setting of this environment variable.
  280.  
  281.  CWAUDIO.SYS /R Option:
  282.  The CWAUDIO.SYS /R option will allow the user to adjust the device interrupt
  283.  rate.  This option should be used with caution.  In most cases, an interrupt
  284.  rare of 32 interrupts per second is optimal.
  285.  
  286.  
  287. 8)  Using Audio in DOS and Win-OS/2 Sessions
  288. -------------------------------------------------------------------------------
  289. One of the great features of Crystal Semiconductor audio drivers is the
  290. industry leading support for WinOS2.
  291.  
  292. - Crystal Windows drivers are automatically installed for WinOS2 use.
  293. - Crystal Windows drivers are OS/2 aware and communicate with OS/2 audio
  294.   drivers to manage concurancy issues.
  295.  
  296. For most users, this support prevents concurancy related errors from
  297. occuring.  Still, they can occur.  Some details on concurancy and
  298. other tips for WinOS2 and DOS game execution follow:
  299.  
  300.  
  301. The installation automatically configures WinOS2 Audio when you install Crystal
  302. Audio drivers.  Windows audio drivers are installed for OS/2 Fullpack systems
  303. only.  OS/2 Red Box systems which use the Microsoft Win 3.1 binaries will use
  304. the Crystal Audio Windows 3.1 drivers that are used in native DOS/Win 3.1.
  305. In either installation case, the Crystal Audio drivers used for WinOS2 are
  306. the same.  That is, there is no special set of drivers for WinOS2.
  307.  
  308. The Crystal Windows 3.1 drivers are OS/2 aware and when loaded under WinOS2
  309. communicate with the OS/2 Physical Device Drivers to negotiate access to
  310. the audio device.
  311.  
  312. To enable game processing, the following DOS properties are commonly set.
  313. This is not done automatically by the installation.  Many of the below
  314. DOS properties default to the correct settings.
  315.  
  316.     WIN_RUN_MODE                 3.1 ENHANCED COMPATIBILITY
  317.     AUDIO_ADAPTER_SHARING        Required
  318.     INT_DURING_IO                On  ( This is the most critical setting )
  319.     HW_TIMER                     On
  320.     VIDEO_SWITCH_NOTIFICATION    On
  321.     VIDEO_8514A_XGA_IOTRAP       Off
  322.     VIDEO_RETRACE_EMULATION      Off
  323.     DPMI_MEMORY_LIMIT            8
  324.  
  325.  
  326. 9)  Audio Concurrency Issues - OS/2, DOS, Win-OS/2
  327. -------------------------------------------------------------------------------
  328. Industry leading WinOS2 support is one of the great advantages of
  329. Crystal Audio.
  330.  
  331. When you have a single audio device, it is not possible for two programs
  332. to use the device at the same time.  For example, if one application has
  333. the device configured for audio playback, and a second application also
  334. wishes to perform audio playback, a conflict exists.
  335.  
  336. The OS/2 multimedia subsystem (MMPM/2) is designed such that, when an
  337. application is running in the foreground (has focus), then that application
  338. takes priority over others running in the background.
  339. MMPM/2 manages the device contention, forcing pauses and resumes to
  340. pass use of the device to the current focus application.
  341.  
  342. This robust support is only available for OS/2 native applications.
  343.  
  344. When DOS games or WinOS2 drivers try to use the device, MMPM/2 is not
  345. involved and cannot force an application off the device.  When the DOS
  346. environment is using the audio device, MMPM/2 is locked out.
  347. This creates an opportunity for contention.
  348.  
  349. To minimize the impact of this problem, Crystal Semiconductor's WinOS2
  350. drivers are OS/2 aware.  They communicate with their OS/2 counterparts
  351. to release use of the device at all times when WinOS2 is quiet.
  352. This is a vast improvement versus many other OS/2 device driver sets.
  353.  
  354. When WinOS2 is quiet, it is "idle" and will not prevent MMPM/2 or other
  355. WinOS2 or DOS sessions from using the device.  This also allows you to
  356. run multiple separate WinOS2 sessions with no concern of audio sharing
  357. between the sessions.
  358.  
  359. MMPM/2 by contrast considers the device "busy" when ever an OS/2
  360. multimedia application is loaded.  For example, loading the OS/2 shipped
  361. Digital Audio player will prevent WinOS2 from using the audio device.
  362. This is often not an issue as the most prevalent OS/2 multimedia
  363. application, system sounds, releases the device after each sound is played.
  364.  
  365. DOS games are unaware of other entities in the system and normally
  366. do not respond well to being kicked off the device.
  367. A running DOS game will prevent OS/2 and WinOS2 from using the audio device.
  368.  
  369.  
  370. For more information on this subject, see OS/2 online documentation
  371.  
  372.     VIEW /AUDIO
  373.     VIEW /MULTIMEDIA
  374.     VIEW /SOUNDS
  375.  
  376.  
  377. 10) Plug and Play System Issues
  378. -------------------------------------------------------------------------------
  379. The CS4232, CS4236, CS4236B, CS4237B and CS4238B are Plug and Play (PnP)
  380. compatible devices.  Merlin is a Plug and Play aware OS.  Warp is not.
  381.  
  382. To use Crystal PnP aware device drivers on Warp, it is necessary to
  383. upgrade the OS/2 Warp Resource Manager system components to Merlin level.
  384. The Crystal installation checks Resource Manager level during install
  385. and performs this upgrade automatically. The installation checks OS version
  386. and will not update these files on a Merlin or post-Merlin system.
  387. It also checks file date/time and will not overwrite a newer file.
  388.  
  389. Where the Crystal Device driver set can find the function of a
  390. PnP BIOS or PnP Operating System (Merlin), it will use the PnP information
  391. provided by the PnP manager in preference to all command line options
  392. and .INI file setttings.  This means that many of the command line
  393. options provided for CWCONFIG.sys are "no-effect" parms.
  394.  
  395. The Crystal Semiconductor CS4231 Audio CODEC is not a PnP device.
  396. On CS4231 systems, the config.sys command line and configuration .INI
  397. file are not overridden by the PnP settings.  For most users, the default
  398. settings work work without conflict.
  399. On IBM Thinkpad 750 computers (which include CS4231 on motherboard), the
  400. Crystal device drivers read device configuration from BIOS SETUP memory and
  401. again, ignore all IRQ/DMA/IO related command line parameters.
  402.  
  403.  
  404. 11) Mixer Issues
  405. -------------------------------------------------------------------------------
  406. As of this release, there is no generic OS/2 mixer application.
  407. Therefore, the volume control for devices attached to mixer LINE, AUX1,
  408. and AUX2 is established on the command line of the CWAUDIO.SYS driver.
  409. Refer to section 5, CWAUDIO.SYS, for the format of the unmute and gain
  410. setting  options.
  411.  
  412. These values for gain are set on each boot and cannot be altered during system
  413. operation.  The command line values represent a gain setting where 8 is equal
  414. to 0 dB gain.  Each increment is 1.5 dB.  Values greater than 8 will reduce
  415. the volume and values less than 8 increase the volume.
  416.  
  417. The devices attached to LINE, AUX1, and AUX2 are system dependent and cannot be
  418. detailed here, but generally reflect CD-ROM audio playback and sound card
  419. line-in jack.  Refer to your system documentation for device configuration.
  420. With the default installation, all inputs are un-muted - which makes CD-ROM
  421. audible.
  422.  
  423. Note:  These settings do not effect standard wave audio volume which is
  424. controlled by the OS/2 volume control icon.
  425.  
  426.  
  427. 12) MIDI Synthesis
  428. -------------------------------------------------------------------------------
  429. This installation diskette includes support to install the IBM OPL3
  430. device driver.  Your system may or may not support MIDI audio, though most do.
  431. Please refer to your system documentation for information related to your
  432. system's ability to support MIDI.
  433.  
  434. The CS4236, CS4236B, CS4237B, CS4238B and later parts include an integrated FM
  435. synthesizer.  Also, most retail boards utilizing the CS4232 and CS4231 CODECs
  436. include OPL-3 compatible hardware for game support.  In all of these cases,
  437. the included OPL-3 device drivers will operate to provide MIDI playback.
  438.  
  439. It is recommended that you install the IBM OPL3 driver to make use of this
  440. feature.  Crystal Audio and the IBM OPL3 FM Synthesis drivers are
  441. pre-selected when you start the installation.
  442.  
  443. You may find that the default FM playback volume is too high or too low.
  444. The output of the FM part is routed through the Crystal Audio CODEC and
  445. its gain/attenuation can be adjusted by changing mixer command line
  446. options on the CWAUDIO.sys audio device driver.
  447.  
  448.  
  449. 13) Web Site - where to get updated drivers
  450. -------------------------------------------
  451. Crystal Web Page:
  452. http://www.crystal.com
  453.  
  454.  
  455. 14) Problems/Questions
  456. -------------------------------------------------------------------------------
  457. Please e-mail problems/questions to the following address:
  458. montalvo@crystal.cirrus.com
  459.