                Crystal Semiconductor Corporation
                ---------------------------------


READ.ME - OS/2 Crystal Audio Device Driver Installation
--------------------------------------------------------------------------
This file contains information on how to install the Crystal Semiconductor
Corporation OS/2 Audio Device drivers.

In addition to Crystal Audio driver installation, this diskette includes
the IBM OPL3/FM MIDI synthesis device driver.

The following topics are covered in this READ.ME file :
1)  Installing on top of previous installations
2)  De-Installation of Sound Blaster Drivers
3)  System Requirements
4)  Files List for Crystal Audio Install Disk
5)  Crystal Audio for OS/2 Installation Procedure
6)  Device Driver Command Line Options
7)  Notes on Command Line Options
8)  Using Audio in DOS and Win-OS/2 Sessions
9)  Audio Concurrency Issues - OS/2, DOS, Win-OS/2
10) Plug and Play System Issues
11) Mixer Issues
12) MIDI Synthesis
13) De-Installation of Sound Blaster Drivers
14) Web Site
15) Problems/Questions


1)  Installing on top of previous installations
-------------------------------------------------------------------------------
This installation supports installation over previous
installations of Crystal Audio device drivers as well as
over-installation of IBM's OPL-3 device driver.

No de-install is necessary prior to executing the OS/2 Multimedia
installation program, minstall.exe.

If you already have a non-Crystal device driver set installed,
it may be necessary to de-install those drivers before installing
Crystal Semiconductor audio device drivers.


2) De-Installation of Sound Blaster Drivers
--------------------------------------------
During OS/2 installation, the system auto-detects system audio device.

With many Crystal Semiconductor parts, the system will incorrectly
identify a Sound Blaster device - resulting in erroneous installation
of Creative Technologies Sound Blaster OS/2 device drivers.
This error occurs because most Crystal Semiconductor CODECs include
hardware support for Sound Blaster compatibility for DOS game execution.

The Crystal Semiconductor installation (on this diskette) searches for
previous installations of Crystal Semiconductor drivers and
automatically de-installs them as part of the installation process.
It however does not de-install Sound Blaster device drivers.

If your system presently has Sound Blaster OS/2 device drivers installed
and you do not have a Sound Blaster device installed, then you should
de-install the Sound Blaster OS/2 drivers prior to running this installation.

The de-installation of the Sound Blaster OS/2 device drivers requires
the following steps:

a) ERASE \MMOS2 and all subdirectories (this removes OS/2 multimedia support)
   Some files won't delete, this is okay.
b) Use OS/2 selective install to re-install OS/2 multimedia support.
   It will auto-detect the wrong device.  You should override
   the auto-detection to remove the Sound Blaster device driver.
   When correct, the installation panel will have no audio devices listed.
c) Complete selective installation and reboot
d) You are now prepared to use this diskette to install Crystal drivers.


3)  System Requirements
-------------------------------------------------------------------------------

This installation and device drivers work on the following OS/2 systems:
    OS/2 Warp Version 3  ( Warp - Red box )
    OS/2 Warp Fullpack   ( Warp - Blue box )
    OS/2 Warp Connect    ( Warp - Blue box )
    OS/2 Warp Version 4  ( Also calls "Merlin" )

In the above "Bluebox" and "Redbox" refer literally to the color of the
retail OS/2 box.

    Red box => "Warp for Windows".
               Uses previously installed Windows 3.1 binaries for WinOS2.

    Blue box => "Full pack".
               Windows 3.1 binaries are shipped with OS/2.


4)  File List for Crystal Audio Install Disk
-------------------------------------------------------------------------------
Crystal Audio Files :
-----------------------------
BSAUDRES.DLL    -   OS/2 business audio support DLL.
CARDINFO.DLL    -   Installation support DLL.
CWAUDIO.HLP     -   Help file used during installation.
CWAUDIO.BIN     -   Audio device microcode.
CWAUDIO.INI     -   File for overriding audio device settings.
CWAUDIO.SYS     -   Audio physical device driver.
CWCONFIG.SYS    -   Audio device configuration device driver.
CWINST.DLL      -   Installation support DLL.
CWVAUDIO.SYS    -   Audio virtual device driver.
CONTROL.SCR     -   Installation control file.
FILES.SCR       -   Installation file list.
READ.ME         -   This file.
AUDIOIF.DLL     -   IBM DLL for mixer support (installed for Warp only)
AMPMXMCD.DLL    -   IBM DLL for mixer support (installed for Warp only)
AUDIOSH.DLL     -   IBM DLL for DART support  (installed for Warp only)
RESOURCE.SYS    -   IBM PnP Resource Manager  (installed for Warp only)
TIMER0.SYS      -   IBM Highres timer driver  (installed for Warp only)
CLOCK01.SYS     -   IBM ISA clock driver      (installed for Warp only)
CLOCK02.SYS     -   IBM MCA clock driver      (installed for Warp only)

IBM OPL3 Files :
-----------------------------
OPL3.SYS        -   IBM OPL3 FM MIDI Physical Device Driver
OPL3RES.DLL     -   IBM OPL3 FM MIDI device support DLL.
MIDIPLAY.ICO    -   Installation ICON for MIDI driver.

WIN-OS/2 Drivers (Installed on fullpack systems only)
----------------
CS32BA11.DRV    -   Windows Wave, Aux, and Mixer Driver
CS32BA11.INI    -   Wave Driver Settings
CSFM.DRV        -   FM MIDI Synthesis Driver
MIDIMAP.CFG     -   Midimapper for FM MIDI Driver
CWADD.INI       -   Sndsys Settings For System.ini


5)  Crystal Audio for OS/2 Installation Procedure
-------------------------------------------------------------------------------
To install device support, insert the Crystal Audio for OS/2 diskette in
drive A: (or whichever drive Crystal Audio for OS/2 diskette is in).
Start the Multimedia Application Install program which is located in the
Multimedia folder on the OS/2 desktop.
Alternatively, you can execute MINSTALL from an OS/2 command prompt.

Once you are in the multimedia installation program, select
Source Drive A: (or whichever drive Crystal Audio for OS/2 diskette is in).

The installation program will show
   Crystal Audio      (Pre-selected)
   IBM OPL-3 FM MIDI  (Pre-selected)

Click the install button to proceed with the installation.  Read and follow
the instructions provided by the installation program.  The following files
will be moved onto your system, based on the devices selected :

If Crystal Audio is installed :
   \MMOS2\DLL\BSAUDRES.DLL
   \MMOS2\CWAUDIO.SYS
   \MMOS2\CWAUDIO.INI
   \MMOS2\CWAUDIO.BIN
   \MMOS2\CWVAUDIO.SYS
   \OS2\BOOT\CWCONFIG.SYS

If IBM OPL3 is installed :
   \MMOS2\OPL3.SYS
   \MMOS2\DLL\OPL3RES.DLL
   \MMOS2\INSTALL\MIDIPLAY.ICO

If system is OS/2 Warp version 3
   \OS2\BOOT\RESOURCE.SYS       IBM resource manager
   \OS2\BOOT\CLOCK01.SYS        IBM high resolution timer support
   \OS2\BOOT\CLOCK02.SYS        IBM high resolution timer support
   \OS2\BOOT\TIMER0.SYS         IBM high resolution timer support
   \MMOS2\DLL\AMPMXMCD.DLL      IBM DLL for mixer API
   \MMOS2\DLL\AUDIOIF.DLL       IBM DLL for mixer API

These lines lines will be added to the OS/2 CONFIG.SYS file.:

    BASEDEV=CWCONFIG.SYS /P:534 /I:5 /D:1,1 /SB:220 /M:330 /FM:388 /J:NONE /CD:NONE
    DEVICE=C:\MMOS2\CWAUDIO.SYS /N:BSAUD1$ /X1:8 /X2:8 /L:8 /LCAPT:X1
    DEVICE=C:\MMOS2\CWVAUDIO.SYS BSAUD1$


If OPL-3/FM is installed:
    BASEDEV=TIMER0.SYS
    DEVICE=C:\MMOS2\OPL3.SYS /P:388 /N:OPL31$


6)  Device Driver Command Line Options
-------------------------------------------------------------------------------
The following tables describe the various command line options and setting
available for the Crystal Audio device drivers.  On PnP systems, many of
these command line parms are ignored.  See section "10" for more information.

The available choices for IRQ settings can vary based on the board
implementation.  Consult your device docuementaiton for a list of
valid settings supported by that board.  The settings listed below
are generally valid, but may not be accurate in all cases.

CWCONFIG.SYS    -   OS/2 audio configuration device driver.

Option/Format       Description                 Valid Values (* = Default Value)
-------------------------------------------------------------------------------
/A:<asic type>      ASIC Type (CS4231 only)     OPTi928, OPTi929, MAD16, GALLANT, *NONE
/P:<port>           Codec Port                  *534, 608, E84, F44 (hex)
/I:<irq>            Codec IRQ                   *5, 7, 9, 10, 11, 12, 15 (dec)
/D:<pDMA,cDMA>      Playback,Capture DMA        0, 1, 3 (*1,1)
/CS:<port>          Control Port                (*not required)
/SB:<port>          Sound Blaster Port          *220, 240, NONE
/M:<port,irq>       MPU Port                    330, *NONE
                    MPU IRQ                     7, 9, 11, 12, 15, *NONE
/FM:<port>          FM Port                     *388, NONE
/J:<port>           Joystick Port               100, 200, *NONE
/CD:<type,port>     CD-ROM Type (CS4231 only)   Sony, Mitsumi, Panasonic, *NONE
                    CD-ROM Port                 320, 330, 340, 360, *NONE
/DL:<option>        Download microcode          Force, No (*not required)
/IFM:<option>       Internal FM (CS4236 only)   *On, Off
/O                  Override PnP settings       (*not enabled)
/V                  Enable Verbose Display      (*not enabled)


CWAUDIO.SYS     -   OS/2 audio physical device driver.  This driver supports all
                    Crystal Audio devices.

Option/Format       Description                 Valid Values (* = Default Value)
-------------------------------------------------------------------------------
/N:<name>           Name of PDD                 Supplied by install program (*BSAUD1$)
/X1:<value>         AUX1 unmute/gain            0..31 (8 = 0dB)  (*not enabled - muted)
/X2:<value>         AUX2 unmute/gain            0..31 (8 = 0dB)  (*not enabled - muted)
/L:<value>          LINE unmute/gain            0..31 (8 = 0dB)  (*not enabled - muted)
/R:<rate>           Enable Adj Intrpt Rate      1..60 (interrupts/sec) (*not enabled)
/EXT                Preserve Mixer Input        (*not enabled)
/LCAPT:<source>     Line capture source         L (line), X1 (AUX1), MX (MixOut)
/M:<option>         Microphone Monitoring       1, On (*not enabled)
/S:<value>          Inactivity power down       1..5 minutes (*not enabled)
/V                  Enable Verbose Display      (*not enabled)



CWVAUDIO.SYS     -  OS/2 audio virtual device driver.  This driver supports all
                    Crystal Audio devices.

Option/Format       Description                 Valid Values (* = Default Value)
-------------------------------------------------------------------------------
                    Name of PDD                 Supplied by install program (*BSAUD1$)
/S                  Skip DOS Envir Var Scan     (*not enabled)



OPL3.SYS         -  IBM FM/OPL-3 MIDI Synthesis Physical Device Driver

        /P:nnn   Base I/O: Sets the base I/O address for FM device.
                 Is almost always, 388 (nnn is in hex)



7)  Notes on Command Line Options
-------------------------------------------------------------------------------
 CWAUDIO.INI vs Command line options:

 There are two ways to supply CWAUDIO.SYS with options that override default
 settings. The first method is by supplying command-line options in the
 CONFIG.SYS file as specified above. The second method is by supplying entries
 in the CWAUDIO.INI file in the \MMOS2 directory. The first method overrides
 the second on an individual entry basis. Therefore, entries in CWAUDIO.INI
 will be used only when that particular option is not specified in CONFIG.SYS.

 Do note, on OS/2 version 3 systems with PnP audio device, the IRQ/DMA/IO 
 settings are taken from the PnP manager rather than the command line.  
 See readme section on PnP for more information.

 CWVAUDIO.SYS /S Option:
 The CWVAUDIO.SYS driver will automatically set a 'BLASTER' DOS environment
 variable to the proper audio hardware settings.  This is done by adding a
 '@SET BLASTER=' line to the beginning of all DOS session's autoexec file.
 This file is specified in DOS session's DOS_AUTOEXEC property.  The /S option
 for CWVAUDIO.SYS will skip the automatic setting of this environment variable.

 CWAUDIO.SYS /R Option:
 The CWAUDIO.SYS /R option will allow the user to adjust the device interrupt
 rate.  This option should be used with caution.  In most cases, an interrupt
 rare of 32 interrupts per second is optimal.


8)  Using Audio in DOS and Win-OS/2 Sessions
-------------------------------------------------------------------------------
One of the great features of Crystal Semiconductor audio drivers is the
industry leading support for WinOS2.

- Crystal Windows drivers are automatically installed for WinOS2 use.
- Crystal Windows drivers are OS/2 aware and communicate with OS/2 audio
  drivers to manage concurancy issues.

For most users, this support prevents concurancy related errors from
occuring.  Still, they can occur.  Some details on concurancy and
other tips for WinOS2 and DOS game execution follow:


The installation automatically configures WinOS2 Audio when you install Crystal
Audio drivers.  Windows audio drivers are installed for OS/2 Fullpack systems
only.  OS/2 Red Box systems which use the Microsoft Win 3.1 binaries will use
the Crystal Audio Windows 3.1 drivers that are used in native DOS/Win 3.1.
In either installation case, the Crystal Audio drivers used for WinOS2 are
the same.  That is, there is no special set of drivers for WinOS2.

The Crystal Windows 3.1 drivers are OS/2 aware and when loaded under WinOS2
communicate with the OS/2 Physical Device Drivers to negotiate access to
the audio device.

To enable game processing, the following DOS properties are commonly set.
This is not done automatically by the installation.  Many of the below
DOS properties default to the correct settings.

    WIN_RUN_MODE                 3.1 ENHANCED COMPATIBILITY
    AUDIO_ADAPTER_SHARING        Required
    INT_DURING_IO                On  ( This is the most critical setting )
    HW_TIMER                     On
    VIDEO_SWITCH_NOTIFICATION    On
    VIDEO_8514A_XGA_IOTRAP       Off
    VIDEO_RETRACE_EMULATION      Off
    DPMI_MEMORY_LIMIT            8


9)  Audio Concurrency Issues - OS/2, DOS, Win-OS/2
-------------------------------------------------------------------------------
Industry leading WinOS2 support is one of the great advantages of
Crystal Audio.

When you have a single audio device, it is not possible for two programs
to use the device at the same time.  For example, if one application has
the device configured for audio playback, and a second application also
wishes to perform audio playback, a conflict exists.

The OS/2 multimedia subsystem (MMPM/2) is designed such that, when an
application is running in the foreground (has focus), then that application
takes priority over others running in the background.
MMPM/2 manages the device contention, forcing pauses and resumes to
pass use of the device to the current focus application.

This robust support is only available for OS/2 native applications.

When DOS games or WinOS2 drivers try to use the device, MMPM/2 is not
involved and cannot force an application off the device.  When the DOS
environment is using the audio device, MMPM/2 is locked out.
This creates an opportunity for contention.

To minimize the impact of this problem, Crystal Semiconductor's WinOS2
drivers are OS/2 aware.  They communicate with their OS/2 counterparts
to release use of the device at all times when WinOS2 is quiet.
This is a vast improvement versus many other OS/2 device driver sets.

When WinOS2 is quiet, it is "idle" and will not prevent MMPM/2 or other
WinOS2 or DOS sessions from using the device.  This also allows you to
run multiple separate WinOS2 sessions with no concern of audio sharing
between the sessions.

MMPM/2 by contrast considers the device "busy" when ever an OS/2
multimedia application is loaded.  For example, loading the OS/2 shipped
Digital Audio player will prevent WinOS2 from using the audio device.
This is often not an issue as the most prevalent OS/2 multimedia
application, system sounds, releases the device after each sound is played.

DOS games are unaware of other entities in the system and normally
do not respond well to being kicked off the device.
A running DOS game will prevent OS/2 and WinOS2 from using the audio device.


For more information on this subject, see OS/2 online documentation

    VIEW /AUDIO
    VIEW /MULTIMEDIA
    VIEW /SOUNDS


10) Plug and Play System Issues
-------------------------------------------------------------------------------
The CS4232, CS4236, CS4236B, CS4237B and CS4238B are Plug and Play (PnP)
compatible devices.  OS/2 Warp version 4 is a Plug and Play aware OS.  
OS/2 Warp version 3 is not.

Where the Crystal Device driver set can find the function of a
PnP BIOS or PnP Operating System (OS/2 Version 4), it will use the 
PnP information provided by the PnP manager in preference to all 
command line options and .INI file setttings.  
This means that many of the command line options provided for 
CWCONFIG.sys are "no-effect" parms.

The Crystal Semiconductor CS4231 Audio CODEC is not a PnP device.
On CS4231 systems, the config.sys command line and configuration .INI
file are not overridden by the PnP settings.  For most users, the default
settings work work without conflict.
On IBM Thinkpad 750 computers (which include CS4231 on motherboard), the
Crystal device drivers read device configuration from BIOS SETUP memory and
again, ignore all IRQ/DMA/IO related command line parameters.


11) Mixer Issues
-------------------------------------------------------------------------------
As of this release, there is no generic OS/2 mixer application.
Therefore, the volume control for devices attached to mixer LINE, AUX1,
and AUX2 is established on the command line of the CWAUDIO.SYS driver.
Refer to section 5, CWAUDIO.SYS, for the format of the unmute and gain
setting  options.

These values for gain are set on each boot and cannot be altered during system
operation.  The command line values represent a gain setting where 8 is equal
to 0 dB gain.  Each increment is 1.5 dB.  Values greater than 8 will reduce
the volume and values less than 8 increase the volume.

The devices attached to LINE, AUX1, and AUX2 are system dependent and cannot be
detailed here, but generally reflect CD-ROM audio playback and sound card
line-in jack.  Refer to your system documentation for device configuration.
With the default installation, all inputs are un-muted - which makes CD-ROM
audible.

Note:  These settings do not effect standard wave audio volume which is
controlled by the OS/2 volume control icon.


12) MIDI Synthesis
-------------------------------------------------------------------------------
This installation diskette includes support to install the IBM OPL3
device driver.  Your system may or may not support MIDI audio, though most do.
Please refer to your system documentation for information related to your
system's ability to support MIDI.

The CS4236, CS4236B, CS4237B, CS4238B and later parts include an integrated FM
synthesizer.  Also, most retail boards utilizing the CS4232 and CS4231 CODECs
include OPL-3 compatible hardware for game support.  In all of these cases,
the included OPL-3 device drivers will operate to provide MIDI playback.

It is recommended that you install the IBM OPL3 driver to make use of this
feature.  Crystal Audio and the IBM OPL3 FM Synthesis drivers are
pre-selected when you start the installation.

You may find that the default FM playback volume is too high or too low.
The output of the FM part is routed through the Crystal Audio CODEC and
its gain/attenuation can be adjusted by changing mixer command line
options on the CWAUDIO.sys audio device driver.

Some sound cards also include hardware wavetable devices.  
The Crystal device driver set does not itself exploit the capabilities
of this device.  You can however install MPU-401 device drivers to 
use wave table for MIDI synthesis.  Follow these steps.
a) Install Crystal Audio support from this distribution.
b) Be careful to NOT install the FM driver included with this distribution.
   This requres de-selecting the FM driver on minstall installation panel.
   OS/2 Warp version 4 supports only one MIDI device in a system.
c) Download and install MPU-401 (Wavetable) driver from IBM web site.
   http://service.boulder.ibm.com/os2ddpak/


13) Web Site - where to get updated drivers
-------------------------------------------
Crystal Web Page:
http://www.crystal.com


14) Problems/Questions
-------------------------------------------------------------------------------
Please e-mail problems/questions to the following address:
montalvo@crystal.cirrus.com
