am_hw_primitive_builder_main.h

Motorola synergy audio component

#ifndef AM_HW_PRIMITIVE_BUILDER_MAIN_INCLUDE
#define AM_HW_PRIMITIVE_BUILDER_MAIN_INCLUDE

#ifdef __cplusplus  /* allow #include in a C++ file (only put this in .h files) */
extern "C" {
#endif

/* (c) Copyright Motorola 1995 - 2005, All rights reserved.        
   Motorola Confidential Proprietary
   Contains confidential proprietary information of Motorola, Inc.
   Reverse engineering is prohibited.
   The copyright notice does not imply publication.
  
   DESCRIPTION: 
       This file defines the 32 bit instruction mask that tells the 
       speech coder and hw what to do 
 
 ************** REVISION HISTORY **********************************************
  
   Date       Author      Reference
   ========   ========    ==========================
   2005-11-04 e42737      CR - LIBhh30280
              Add Hi-Fi carkit companding
   2005-10-28 w18944      CR - LIBhh29834
              Companding for MM playback with EMU stereo hs

   2005-07-22 W17860      CR - LIBgg54754
              Cleartalk parameters are not getting sent if hdset is plugged in call

   2004-05-25 w17860      CR - LIBff87431
              Feature:13698 - MME support for ClearTalk Support 

   2005-06-09 w17860      CR - LIBgg07476   
              MFT distortion during mp3 playback

   2005-04-12 w16355      CR - LIBff83601
              Changes in AM for implementing new Call sequence.

   2004-06-01 w17860      CR - LIBee16565
              Clean up companding code to make it more efficient 

   02-19-04   w17860      CR - LIBdd78611
              Back out the CLK_INV and DF_RESET changes done
              - Back out some of the changes done in LIBdd62178 as this is
              fixed in hardware

   12-15-03   w17860      CR - LIBdd62178
              AM: Configure for various modes ( call resp hapi signals) for Razor

   12-11-03   w17860      CR - LIBdd60209
              Haptics Updates for E398
              - Speakerphone compand parameters should follow haptics
                settings.

   03-10-03   w17860      CR - LIBdd45461
              Headset Compander needs to be activated for FM Headset 
              and MP3 Player

   03-09-09   w17860      CR - LIBdd34023
              Need to add place holders in the code for future companding parameters

   03-08-08   w17860      CR - LIBdd25168
              Move the compander parameters into the file system

   03-03-17   w17860      CR - LIBbb87685
              MRS 8245: Haptics support for E390

   03-03-18   e11237      CR - LIBbb83903
              various compander options

   03-01-27   w18944      CR - LIBbb72192 
              MP3 companding

   02-09-15   e11237      CR - LIBbb51978
              Added MIDI companding support
              - added new mask bit AM_I_MASK_MIDI_COMPAND

   02-09-04   w18944      CR - LIBbb33892
              Send mode select msg before VR

   02-05-15   r58514      LIBbb29284
              LCA: Added support for reading parameters for audio shaping, audio 
              companding, SAP and AVC from external flash.

   02-01-17   bal023      LIBbb16809
              LCA support for TTY - catchup from CR LIBbb05515 
	        
   01-04-20   w17860      CR - LIBbb05515
              Audio support for the TTY accessory in digital call mode.
              - Added defines for the TTY modes.
              - Added a global to communicate the mode from set_hardware_mask()
                to execute().

   02-02-07   arc095      CR - LIBbb18270
              Echo Mode investigation for Bluetooth
              - added a new #define for ECHO_MODE_BT_HEADSET

   01-07-27   arc095      CR - LIBbb00912
              Operator Defined Ringer Support
              - added a new tone category AM_HW_OPERATOR_RING_TONE

   01-05-23   mloutris    CR - LIBaa02320
              Adding call for DSP audio shaping filter to reduce noise in Sapphire.

   01-04-20   w17860      CR - LIBbb05515
              Audio support for the TTY accessory in digital call mode.
              - Added defines for the TTY modes.
              - Added a global to communicate the mode from set_hardware_mask()
                to execute().
		
   01-04-03   ktang       CR - CSGce93816
              AM needs to wait for tone cmp for AVC UL DTMF before disconnecting it
              - conditional compile 

   00-12-07   mloutris    CR - CSGce75636
              Inhibit sleep mode when a bluetooth device is attached for frame sync.
              - Added an enum to define the needed sleep state for bluetooth.

   00-12-21   mtaraba     CSGce82934
              main_comp_hardware.h within engine_audio vob should be removed

   00-08-09   mtaraba     CR - CSGce55882
              Eliminate file gsm.h from audio manager

   00-04-25   mkloza      PR - CSGce54341
              Matrix command imlementation
              - modified instruction mask enum
         
*/
/************** HEADER FILE INCLUDES ******************************************/
#include <SUAPI/suapi.h>
#include <ENGINE_AUDIO/audio_conditional_compile_def.h>
#if (AUDIO_RAINBOW == FALSE)
#include <BUILD/feature.h>
#include <BUILD/memory_usage.h>
#endif   
#include <ENGINE_AUDIO/am_c_utilities.h>
#include <ENGINE_HAPI/hapi_mdi_message_ids.h>

/************** CONSTANTS *****************************************************/

/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/

enum
{
    AM_I_MASK_ECHO_CONTROL,        /* echo control            0 = disable echo control, 1 = enable echo control */
    AM_I_MASK_NOISE_SUPPRESS,      /* noise suppress          0 = disable noise sup.,   1 = enable noise supp.  */
    AM_I_MASK_ACTIVE_AUDIO,        /* audio active            0 = allow low power mode, 1 = disallow low power  */
    AM_I_MASK_VA_PB_UNMUTE,        /* VA audio mute           0 = mute VA audio,        1 = unmute VA audio     */
    AM_I_MASK_DISABLE_STOP_MODE,   /* stop mode(helps pop)    0 = enable                1 = disable             */     
    AM_I_MASK_SEL_VIBRATOR,        /* vibrator                1 indicates vibrator is selected                  */
    AM_I_MASK_SPKR_FILTER,         /* speaker HP filter       1 indicates that speaker filter is enabled        */
    AM_I_MASK_MIC_FILTER,          /* mic HP filter           1 indicates that mic filter is enabled            */
    AM_I_MASK_AUDIO_DITHER,        /* dither enable           1 indicates that dihter filter is enabled         */
    AM_I_MASK_INT_SPEAKER_PHONE_VOICE_COMPAND, /* Boost and limit signal 0 = companding disabled 1 = companding enabled.*/
    AM_I_MASK_PLOVER_VOICE_COMPAND,    /* Boost and limit signal 0 = companding disabled 1 = companding enabled. */
    AM_I_MASK_PLOVER_HIFI_COMPAND,     /* Boost and limit signal 0 = companding disabled 1 = companding enabled. */
    AM_I_MASK_BT_HEADSET_COMPAND,      /* Boost and limit signal 0 = companding disabled 1 = companding enabled. */
    AM_I_MASK_HEADSET_VOICE_COMPAND,   /* Boost and limit signal 0 = companding disabled 1 = companding enabled. */
    AM_I_MASK_MIDI_COMPAND,            /* Boost and limit signal 0 = companding disabled 1 = companding enabled. */
    AM_I_MASK_MP3_COMPAND,             /* Boost and limit signal 0 = companding disabled 1 = companding enabled. */
    AM_I_MASK_AUDIO_HANDSET_FILTERING, /* Shape filter to compensate for HW. 0 = dont filter,  1 = filter        */
    AM_I_MASK_HAPTICS_AS,              /* Enable low freq to vibrate MFT. 0 = disable Haptics, 1 = enable Haptics*/
    AM_I_MASK_ZIHF_VOICE_COMPAND,      /* Boost and limit signal 0 = companding disabled       1 = companding enabled.*/
    AM_I_MASK_ZIHF_HIFI_COMPAND,      /* Boost and limit signal 0 = companding disabled       1 = companding enabled.*/
    AM_I_MASK_CLIP_ON_SPEAKER_PHONE_COMPAND,/* Boost and limit signal  0 = companding disabled 1 = companding enabled.*/
    AM_I_MASK_STEREO_EMU_HS_MM_COMPAND, /*For Multimedia playback with Stereo EMU headset */
    AM_I_MASK_NOTIFY_UAC_BLUEPHN_CALL,  /* Tell UAC we're in bluephone call 0 = not a UAC call, 1 = a UAC call.   */
    AM_I_MASK_ANM_HANDSET,              /* DSP Automatic Noise masking  0 = disabled   1 = enabled. */
    AM_I_MASK_ANM_HEADSET,              /* DSP Automatic Noise masking  0 = disabled   1 = enabled. */
    AM_I_MASK_ANM_INT_SPKRPH            /* DSP Automatic Noise masking  0 = disabled   1 = enabled. */
};
 
typedef UINT32 AM_HW_MAIN_I_MASK_ATTRIBUTE;

enum
{
    AM_HW_DSP_SLEEP_STATE_UNCHANGED ,
    AM_HW_DSP_SLEEP_STATE_DISABLED  ,
    AM_HW_DSP_SLEEP_STATE_ENABLED
};

#if (MAKE_FTR_TA02_TTY == TRUE)
enum
{
    AM_HW_TTY_MODE_DISABLED ,
    AM_HW_TTY_MODE_VCO ,
    AM_HW_TTY_MODE_HCO , 
    AM_HW_TTY_MODE_FULL
    
};
#endif

#define MUTE_DSP_AUDIO          0x0000

#define MAX_MATRIX_CONNECTIONS  62

#if (AUDIO_CDMA == TRUE)