readme.txt  9/96  Mwave Developers Toolkit      Release 1.31 for Windows
========================================================================

Please take a moment to carefully read this file before using
the tools or sample applications.

Installation:
=============

Assuming your floppy is disk a:

        1. select FILE | RUN from the Windows Program Manager
        2. enter a:\setup

During the installation procedure, you will be asked which
options you wish to install.  Here is a brief description
of each option, to help you decide what to install.

         o PC Application Development
            Select this option if you plan to develop application that
            run on the PC and interface with standard Mwave drivers or
            tasks.  Includes API interfaces and PC sample applications
            (including source code).

         o DSP Task Development
            Select this option if you plan to develop Mwave tasks that
            run on the Mwave DSP.  Includes C compiler, assembler,
            linker, debugger libraries and demonstrations of task
            programming and debugging.

         o DSP Task Library Source
            Select this option if you wish to install the source for
            the C runtime library and DSP libraries.  The libraries are
            written in C and Mwave assembly language.


 For more details see the: "Mwave Developers Toolkit Directory
 Structure" section below.



* * * * * IMPORTANT * * * * *
=============================

   For your convenience, some updated Mwave system Software has been
included in this release and will be installed regardless of the
installation options selected.  Read \MWAVETKW\MWUPDATE\README.TXT
to determine whether you need to update your Mwave Manager software.

   If you have an early revision of WindSurfer (1.0 or 1.01), we
strongly recommend that you update all of your Mwave system software.
You can obtain an update from IBM by calling  PC Company Bulletin Board or
downloading from the IBM PC Company Website at http://www.pc.ibm.com


=============================

Release 1.1
============


 - The documentation and software from the ADK and PDK (APIs, sample
   applications and tools) have been included in the toolkit.

 - The installation procedure now allows you to select which components
   (Application Development, Task Development, Library Source Code) you
   wish to install.

 - C Compiler:

    o #pragma public has been added to define global C variables
      and functions as Mwave Manager PUBLIC symbols.

 - Debugger modifications:

    o The scope control panel screen positions are maintained in
      the configuration file.

    o The bias control now operates with a positive or negative displacement.

    o The "update" command has been added to speed script execution

    o The "goto" and "done" commands have been added for
      script flow control.

The following features have been added to the debugger but are not
documented in the Debugger User's Guide:

    o The breakpoint command has been extended to allow simple
      breakpoints to be toggled by appending a ".." to the end
      of the command:

        breakpoint <address> ..

    o Double-clicking on source line in the source window causes
      a simple breakpoint to be toggled at the instruction location
      associated with the source line.

    o A script can be changed to from continuous to interactive
      playback mode using the "<<" command (without specifying a
      filename).  This form of the "<<" command has no effect in
      interactive mode.  For example:

                ...
        # Executes in continuous mode
        <<
        # Interactive mode, press Enter to continue
                ...



Errata
======

  o MwQuery

    - A few additional features were added to MwQuery after the
      printed manuals went to press:

      Data segment contents can be displayed.  After selecting a data
      segment, click  on the DUMP button to display selected data
      segment.

      GPC contents can be displayed.  After selecting a GPC, click on
      CONTENTS button to display GPC contents.

      ITCB contents can be displayed.  After selecting an ITCB, click on
      CONTENTS button to display ITCB contents.

    - When you cancel a print request to MwQuery, a spurious error box
      is presented.  You should ignore the error.

    o FAX and TAM documentation and support

        - The following corrections apply to the FAX and TAM
          documentation in the Application Programmer's Guide:

          Under MCI_FAX_SET_MODEM_TYPES, should say "Only V27 and V29
          modem types supported in current FAX driver."

          PHONE_EVENT_FAX_POLL is supported in the current FAX driver.

          MCI_FAX_SET_RING_COUNT is supported in current FAX driver.  It
          is only the setting of the value to zero to request that the
          phone not be answered that is not supported

          For the PHONE_EVENT_CALL_PROGRESS message:  Fast Busy and
          Slow Busy both return CALL_PROGRESS_BUSY.  No specific
          support is provided for CALL_PROGRESS_FAST_BUSY and
          CALL_PROGRESS_SLOW_BUSY.  Also, CALL_PROGRESS_ANSWER_TONE and
          CALL_PROGRESS_UNIDENTIFIED_TONE are not supported.

          MCI_TAM_SET_AUDIO_MUTE is supported in current TAM drivers.

          Check with your Mwave board manufacturer to determine if
          currently unsupported features become available with software
          updates.

OS/2 Version Compatibility
==========================

  - The mwdebug.ini file is a standard Windows .ini file and is not
    compatible with the mwdebug.ini file of OS/2.  If the Windows version
    of the debugger encounters an OS/2 version of the mwdebug.ini file
    it will be ignored.

  - The Windows debugger can read OS/2 scope configuration files.  Due
    to differences in the coordinate system, fonts and colors between
    OS/2 and Windows, the scope window can not be identically reproduced.

Mwave Developers Toolkit Directory Structure
============================================

    The following is a list of directories for the Mwave Developers
Toolkit and the installation option for which each is included:

 |------------------- PC Application Development
 |  |---------------- DSP Development
 |  |  |------------- Source code
 v  v  v
 X        +---API
    X     +---BIN
    X     +---DSP
    X     +---HELP
    X     +---INCLUDE
    X     +---LIB
 X  X  X  +---MWUPDATE
    X     +---QUERY
 X  X     +---SAMPLES
    X     |   +---CDDEMO
    X     |   +---DBGDEMO
 X        |   +---FAX
    X     |   +---MUSICBOX
 X        |   +---TAM
    X     |   +---VIODEMO
 X        |   +---MANAGER
 X        |   |   +---DMA
 X        |   |   +---GPC
 X        |   |   +---IPC
 X        |   |   +---ITCB
 X        |   |   \---LOADMOD
 X  X     |   +---DATAMOVR
 X  X     |   |   +---PLYSAMPL
 X  X     |   |   \---RCDSAMPL
    X     |   \---TASKWTR
    X     |       +---ALU
    X     |       +---CDWRAP
    X     |       +---CIRC
    X     |       +---FIRDEMO
    X     |       +---IIRDEMO
    X     |       +---ITCB
    X     |       +---R4TA
    X     |       +---RAMPGEN
    X     |       +---SINEGEN
    X     |       +---MISC
    X     |       |   +---CCP
    X     |       |   +---CMCP
    X     |       |   +---CURCC
    X     |       |   +---DMA
    X     |       |   \---VGPC
    X     |       +---GPC
    X     |       |   +---SYNC
    X     |       |   +---USERDD
    X     |       |   \---OWNERDD
    X     |       \---TAIODEMO
    X  X  +---SOURCE
       X  |   +---CDSPLIB
    X     |   +---MWSTDIO
       X  |   \---CLIB
    X     +---TUTORIAL


List of supported connections on current Mwave cards
====================================================

MEIO connections for the following cards are listed below:

        o ACE Adapter
        o Audiovation and Eduquest Adapter
        o Multimedia Modem/Spectrum Solo
        o Windsurfer Adapter
        o 2781 PNP/2780 Pro Reference Design card
        o 2781 PNP Modem only Reference Design card
        o Aptiva card
        o 2780 Reference Design card
        o Thinkpad 755 card
        o Thinkpad 760 card

ACE Adapter:
    LineIn_L1   to CdAdc_L1
    LineIn_R1   to CdAdc_R1
    LineIn_S1   to CdAdc_S1
    Mic_L1      to CdAdc_L1
    Mic_R1      to CdAdc_R1
    Mic_S1      to CdAdc_S1
    CddAIn_L1   to CdAdc_L1
    CddAIn_R1   to CdAdc_R1
    CddAIn_S1   to CdAdc_S1
    CdDac_L1    to LineOut_L1
    CdDac_R1    to LineOut_R1
    CdDac_S1    to LineOut_S1
    CdDac_L1    to Head_L1
    CdDac_R1    to Head_R1
    CdDac_S1    to Head_S1
    CdDac_L1    to Head_L2
    Mic_L1      to VoiceAdc_1
    HandIn_1    to VoiceAdc_1
    HandIn_1    to TeleOut_1
    VoiceDac_1  to HandOut_1
    VoiceDac_1  to Head_L2
    VoiceDac_1  to LineOut_L1
    TeleIn_1    to TeleAdc_1
    TeleDac_1   to TeleOut_1
    MidiIn_1    to MidiRx_1
    MidiTx_1    to MidiOut_1
    MidiIn_1    to MidiThruOut_1
    MidiTx_1    to MidiThruOut_1
    CommTx_1    to UartOut_1
    UartIn_1    to CommRx_1

Audiovation and Eduquest Adapter:
    LineIn_L1   to CdAdc_L1
    LineIn_R1   to CdAdc_R1
    LineIn_S1   to CdAdc_S1
    LineIn_L2   to CdAdc_L1
    LineIn_R2   to CdAdc_R1
    LineIn_S2   to CdAdc_S1
    LineIn_L3   to CdAdc_L1
    LineIn_R3   to CdAdc_R1
    LineIn_S3   to CdAdc_S1
    LineIn_L4   to CdAdc_L1
    LineIn_R4   to CdAdc_R1
    LineIn_S4   to CdAdc_S1
    Mic_L1      to CdAdc_L1
    Mic_R1      to CdAdc_R1
    Mic_S1      to CdAdc_S1
    Mic_L2      to CdAdc_L1
    Mic_R2      to CdAdc_R1
    Mic_S2      to CdAdc_S1
    CddAIn_L1   to CdAdc_L1
    CddAIn_R1   to CdAdc_R1
    CddAIn_S1   to CdAdc_S1
    CdDac_L1    to LineOut_L1
    CdDac_R1    to LineOut_R1
    CdDac_S1    to LineOut_S1
    CdDac_L1    to Head_L1
    CdDac_R1    to Head_R1
    CdDac_S1    to Head_S1
    CdDac_L1    to IntSpkrOut_L1
    CdDac_R1    to IntSpkrOut_L1
    CdDac_S1    to IntSpkrOut_L1
    CddAIn_S1   to CdAdc_S1
    MidiIn_1    to MidiRx_1
    MidiTx_1    to MidiOut_1
    MidiIn_1    to MidiThruOut_1
    MidiTx_1    to MidiThruOut_1

Multimedia Modem/Spectrum Solo:
    Mic_L1      to CdAdc_L1
    Mic_R1      to CdAdc_R1
    Mic_S1      to CdAdc_S1
    CddAIn_L1   to CdAdc_L1
    CddAIn_R1   to CdAdc_R1
    CddAIn_S1   to CdAdc_S1
    CdDac_L1    to LineOut_L1
    CdDac_R1    to LineOut_R1
    CdDac_S1    to LineOut_S1
    CdDac_L1    to Head_L1
    CdDac_R1    to Head_R1
    CdDac_S1    to Head_S1
    CdDac_S1    to IntSpkrOut_L1
    Mic_L1      to VoiceAdc_1
    HandIn_1    to VoiceAdc_1
    HandIn_1    to TeleOut_1
    VoiceDac_1  to HandOut_1
    VoiceDac_1  to LineOutL1
    TeleIn1     to HandOut1
    TeleIn_1    to TeleAdc_1
    TeleDac_1   to TeleOut_1
    CommTx_1    to UartOut_1
    UartIn_1    to CommRx_1


Windsurfer Adapter:
    LineIn_L1   to CdAdc_L1
    LineIn_R1   to CdAdc_R1
    LineIn_S1   to CdAdc_S1
    LineIn_L2   to CdAdc_L1
    LineIn_R2   to CdAdc_R1
    LineIn_S2   to CdAdc_S1
    Mic_L1      to CdAdc_L1
    Mic_R1      to CdAdc_R1
    Mic_S1      to CdAdc_S1
    CddAIn_L1   to CdAdc_L1
    CddAIn_R1   to CdAdc_R1
    CddAIn_S1   to CdAdc_S1
    CdDac_L1    to LineOut_L1
    CdDac_R1    to LineOut_R1
    CdDac_S1    to LineOut_S1
    CdDac_L1    to LineOut_L2
    CdDac_R1    to LineOut_R2
    CdDac_S1    to LineOut_S2
    CdDac_L1    to Head_L1
    CdDac_R1    to Head_R1
    CdDac_S1    to Head_S1
    CdDac_L1    to IntSpkrOut_L1
    CdDac_R1    to IntSpkrOut_L1
    CdDac_S1    to IntSpkrOut_L1
    Mic_L1      to VoiceAdc_1
    HandIn_1    to VoiceAdc_1
    HandIn_1    to TeleOut_1
    VoiceDac_1  to HandOut_1
    TeleIn_1    to TeleAdc_1
    TeleDac_1   to TeleOut_1
    MidiIn_1    to MidiRx_1
    MidiTx_1    to MidiOut_1
    MidiIn_1    to MidiThruOut_1
    MidiTx_1    to MidiThruOut_1
    CommTx_1    to UartOut_1
    UartIn_1    to CommRx_1

For the 2781 PNP/2780 Pro Reference card:
    LineInS1    to CdAdcS1
    LineInL1    to CdAdcL1
    LineInR1    to CdAdcR1
    MicS1       to CdAdcS1
    MicL1       to CdAdcL1
    MicR1       to CdAdcR1
    HeadMicL1   to CdAdcL1
    HeadMicR1   to CdAdcR1
    HeadMicS1   to CdAdcS1
    CddAInS1    to CdAdcS1
    CddAInL1    to CdAdcL1
    CddAInR1    to CdAdcR1
    LineOutS1   to CdAdcS
    LineOutL1   to CdAdcL1
    LineOutR1   to CdAdcR1
    LineInS1    to LineOutS1
    LineInL1    to LineOutL1
    LineInR1    to LineOutR1
    CddAInS1    to LineOutS1
    CddAInL1    to LineOutL1
    CddAInR1    to LineOutR1
    LineInS2    to LineOutS1
    LineInL2    to LineOutL1
    LineInR2    to LineOutR1
    CdDacS1     to LineOutS1
    CdDacL1     to LineOutL1
    CdDacR1     to LineOutR1
    MonoIn1     to LineOutS1
    MonoIn1     to MonoOut1
    CdDacS1     to MonoOut1
    CdAdcS1     to CdDacS1
    TeleIn1     to TeleAdc1
    TeleDac1    to TeleOut1
    HandIn1     to TeleOut1
    MicL1       to VoiceAdc1
    HeadMicL1   to VoiceAdc1
    HandIn1     to VoiceAdc1
    VoiceDac1   to HandOut1
    CommTx1     to UartOut1
    UartIn1     to CommRx1
    VoiceDac1   to LineOutL1
    V96Dac1     to LineOutL1
    MicL1       to V96Adc1

    For the 2781 PNP Modem only card:
    MicS1       to CdAdcS1
    MicL1       to CdAdcL1
    MicR1       to CdAdcR1
    HeadMicL1   to CdAdcL1
    HeadMicR1   to CdAdcR1
    HeadMicS1   to CdAdcS1
    LineOutS1   to CdAdcS
    LineOutL1   to CdAdcL1
    LineOutR1   to CdAdcR1
    CdDacS1     to LineOutS1
    CdDacL1     to LineOutL1
    CdDacR1     to LineOutR1
    TeleIn1     to TeleAdc1
    TeleDac1    to TeleOut1
    HandIn1     to TeleOut1
    MicL1       to VoiceAdc1
    HeadMicL1   to VoiceAdc1
    HandIn1     to VoiceAdc1
    VoiceDac1   to HandOut1
    CommTx1     to UartOut1
    UartIn1     to CommRx1
    VoiceDac1   to LineOutL1
    V96Dac1     to LineOutL1
    MicL1       to V96Adc1

    For the Aptiva card:
    LineInL1    to CdAdcL1
    LineInR1    to CdAdcR1
    LineInS1    to CdAdcS1
    MicL1       to CdAdcL1
    MicL1       to CdAdcR1
    MicL1       to EmulCdAdcR1
    MicR1       to CdAdcR1
    MicS1       to CdAdcS1
    HeadMicL1   to CdAdcL1
    HeadMicL1   to CdAdcR1
    HeadMicR1   to CdAdcR1
    HeadMicS1   to CdAdcS1
    CddAInL1    to CdAdcL1
    CddAInR1    to CdAdcR1
    CddAInS1    to CdAdcS1
    CdDacL1     to LineOutL1
    CdDacR1     to LineOutR1
    CdDacS1     to LineOutS1
    CdDacL1     to HeadL1
    CdDacR1     to HeadR1
    CdDacS1     to HeadS1
    CdDacL1     to HeadSpkrL1
    CdDacR1     to HeadSpkrR1
    CdDacS1     to HeadSpkrS1
    CdDacL1     to IntSpkrOutL1
    CdDacR1     to IntSpkrOutL1
    CdDacS1     to IntSpkrOutL1
    MicL1       to VoiceAdc1
    HeadMicL1   to VoiceAdc1
    HandIn1     to VoiceAdc1
    HandIn1     to TeleOut1
    VoiceDac1   to HandOut1
    TeleIn1     to TeleAdc1
    TeleDac1    to TeleOut1
    MidiIn1     to MidiRx1
    MidiTx1     to MidiOut1
    MidiIn1     to MidiThruOut1
    MidiTx1     to MidiThruOut1
    CommTx1     to UartOut1
    UartIn1     to CommRx1

    For the 2780 reference design card:
    LineInL1    to CdAdcL1
    LineInR1    to CdAdcR1
    LineInS1    to CdAdcS1
    MicL1       to CdAdcL1
    MicL1       to CdAdcR1
    MicL1       to EmulCdAdcR1
    MicR1       to CdAdcR1
    MicS1       to CdAdcS1
    HeadMicL1   to CdAdcL1
    HeadMicL1   to CdAdcR1
    HeadMicR1   to CdAdcR1
    HeadMicS1   to CdAdcS1
    CddAInL1    to CdAdcL1
    CddAInR1    to CdAdcR1
    CddAInS1    to CdAdcS1
    CdDacL1     to LineOutL1
    CdDacR1     to LineOutR1
    CdDacS1     to LineOutS1
    CdDacL1     to HeadL1
    CdDacR1     to HeadR1
    CdDacS1     to HeadS1
    CdDacL1     to HeadSpkrL1
    CdDacR1     to HeadSpkrR1
    CdDacS1     to HeadSpkrS1
    CdDacL1     to IntSpkrOutL1
    CdDacR1     to IntSpkrOutL1
    CdDacS1     to IntSpkrOutL1
    MicL1       to VoiceAdc1
    HeadMicL1   to VoiceAdc1
    HandIn1     to VoiceAdc1
    HandIn1     to TeleOut1
    VoiceDac1   to HandOut1
    TeleIn1     to TeleAdc1
    TeleDac1    to TeleOut1
    MidiIn1     to MidiRx1
    MidiTx1     to MidiOut1
    MidiIn1     to MidiThruOut1
    MidiTx1     to MidiThruOut1
    CommTx1     to UartOut1
    UartIn1     to CommRx1

    For the Thinkpad 755 card:
    LineInL1    to CdAdcL1
    LineInR1    to CdAdcR1
    LineInS1    to CdAdcS1
    MicL1       to CdAdcL1
    MicR1       to CdAdcR1
    MicS1       to CdAdcS1
    CddAInL1    to CdAdcL1
    CddAInR1    to CdAdcR1
    CddAInS1    to CdAdcS1
    CdDacL1     to LineOutL1
    CdDacR1     to LineOutR1
    CdDacS1     to LineOutS1
    CdDacL1     to HeadL1
    CdDacR1     to HeadR1
    CdDacS1     to HeadS1
    CdDacS1     to IntSpkrOutL1
    CdDacL1     to IntSpkrOutL1
    CdDacR1     to IntSpkrOutL1
    MicL1       to VoiceAdc1
    HandIn1     to VoiceAdc1
    HandIn1     to TeleOut1
    VoiceDac1   to HandOut1
    TeleIn1     to TeleAdc1
    TeleDac1    to TeleOut1
    CommTx1     to UartOut1
    UartIn1     to CommRx1

    For the Thinkpad 760 card:
    LineInL1    to CdAdcL1
    LineInR1    to CdAdcR1
    LineInS1    to CdAdcS1
    LineInS1    to LineOutS1
    CddaInS1    to LineOutS1
    MicL1       to CdAdcL1
    MicR1       to CdAdcR1
    MicS1       to CdAdcS1
    CddAInL1    to CdAdcL1
    CddAInR1    to CdAdcR1
    CddAInS1    to CdAdcS1
    CdDacL1     to LineOutL1
    CdDacR1     to LineOutR1
    CdDacS1     to LineOutS1
    CdDacL1     to HeadL1
    CdDacR1     to HeadR1
    CdDacS1     to HeadS1
    CdDacS1     to IntSpkrOutL1
    CdDacL1     to IntSpkrOutL1
    CdDacR1     to IntSpkrOutL1
    MicL1       to VoiceAdc1
    HandIn1     to VoiceAdc1
    HandIn1     to TeleOut1
    VoiceDac1   to HandOut1
    TeleIn1     to TeleAdc1
    TeleDac1    to TeleOut1
    CommTx1     to UartOut1
    UartIn1     to CommRx1
    [ End of File ]
