am_app_logic_processor_mask.h

Motorola synergy audio component

#ifndef AM_APP_LOGIC_PROCESSOR_MASK_INCLUDE
#define AM_APP_LOGIC_PROCESSOR_MASK_INCLUDE

#ifdef __cplusplus
extern "C" {
#endif

/*(c) Copyright Motorola 2002, 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 all instruction masks.
 
 ************** REVISION HISTORY **********************************************
  
   Date       Author      Reference
   ========   ========    ==========================
   2004-04-21 w17860      CR - LIBdd97391
              ST:CAM: phone freezes after receiving SMS in camera with MP3 attached

   03-10-01   w17860      CR - LIBdd44508   
              ST:Accy:2: MP3 Player and FM Radio don't play 
              when camera is turned on

   02-05-15   r585134     CR - LIBbb29284
              LCA: Added support for reading SAP default config from external 
              flash

   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-03-08   cfarrel     CR - CSCce49800
              Common MDI Echo Control and Noise Suppression
              - Set correct bit for Echo Control in the default
                voice masks

   98-12-02   blamers     CR - CSGce17243
              Whitecap VA Audio Event Handler Changes
              - Allow SMOCFIRE_AVAILABLE to be set to FALSE

   98-05-04   mkloza      PR - CSGce17807
              Low Power mode updataed
              - Masks default to ACTIVE_AUDIO.

   98-05-04    mkloza      PR - CSGce18269
               Noise Suppress updated
               - masks default to noise suppress

   97-01-15    gswanson    PR - CSGce16125
               Fix DHFA for zap and VA
               - Added digital bits to the VA/VR output and VA/VR IO. This is
                 So we can use digital devices in VA/VR.
               - Added Select HS mic when in VA/VR HS IO. It was just lucky that
                 the HW layer worked with this and it should always have been set.
               
   97-12-23   slam        PR - CSGce15146
              Integration of VA and VR
              - Move tone insertion mask definitions out to
                am_app_logic_processor_main.h.

   97-09-09   slam        PR - CSGce12947
              Tone Control Support
              - Add tone insertion masks.

   97-08-05   slam        PR - CSGce11610
              Voice Annotation development
              - Expand VR masks to VA/VR masks.

   97-07-07   gswanson    PR - CSGce06712
   97-05-28   slam        PR - CSGce10240
*/
/************** HEADER FILE INCLUDES ******************************************/
#include <SUAPI/suapi.h>

#ifndef AM_HW_PRIMITIVE_BUILDER_MAIN_INCLUDE
#include "am_hw_primitive_builder_main.h"
#endif


/************** CONSTANTS *****************************************************/
    
/*  To use these bit masks, set up the mask to turn on both the desired        
analog and digital paths. The code will then use  AM_I_MASK_ANALOG_BITS or 
AM_I_MASK_DIGIAL_BITS to mask out (turn off) the unused paths).
*/

#define AUX_ALERT_MASK              ((UINT32) (1L << AM_I_MASK_AUX_ALERT))

#define ENT_MUTE_MASK               ((UINT32) (1L << AM_I_MASK_ENT_MUTE))

#define NON_VOICE_BASE_MASK         ((UINT32) ((1L << AM_I_MASK_DECODER_MUTE) | \
                                              (1L << AM_I_MASK_ENCODER_MUTE) | \
                                              (1L << AM_I_MASK_SPKR_UNMUTE)  | \
                                              (1L << AM_I_MASK_DSC_SPKR_UNMUTE) | \
                                              (1L << AM_I_MASK_NOISE_SUPPRESS) | \
                                              (1L << AM_I_MASK_ACTIVE_AUDIO)))

#define VOICE_BASE_MASK             ((UINT32) ((1L << AM_I_MASK_SPKR_UNMUTE)    | \
                                              (1L << AM_I_MASK_DSC_SPKR_UNMUTE)| \
                                              (1L << AM_I_MASK_MIC_UNMUTE)     | \
                                              (1L << AM_I_MASK_DSC_MIC_UNMUTE) | \
                                              (1L << AM_I_MASK_NOISE_SUPPRESS) | \
                                              (1L << AM_I_MASK_ACTIVE_AUDIO)))

#define HS_MASK                     ((UINT32) ((1L << AM_I_MASK_SEL_EARPIECE) | \
                                              (1L << AM_I_MASK_SEL_HS_MIC) | ENT_MUTE_MASK))

#define HF_MASK                     ((UINT32) ((1L << AM_I_MASK_SEL_AUX_SPKR) | \
                                              (1L << AM_I_MASK_SEL_EXT_MIC)| ENT_MUTE_MASK))

#define AM_DFLT_HS_KEY_TONE_MASK    ((UINT32) (NON_VOICE_BASE_MASK | HS_MASK))

#define AM_DFLT_HF_KEY_TONE_MASK    ((UINT32) (NON_VOICE_BASE_MASK | HF_MASK))

#define AM_DFLT_HS_STATUS_TONE_MASK ((UINT32) (NON_VOICE_BASE_MASK | \
                                             (1L << AM_I_MASK_MIC_UNMUTE) | HS_MASK))

#define AM_DFLT_HF_STATUS_TONE_MASK ((UINT32) (NON_VOICE_BASE_MASK | \
                                             (1L << AM_I_MASK_MIC_UNMUTE) | HF_MASK))

#define AM_DFLT_HS_ALERT_TONE_MASK  ((UINT32) (NON_VOICE_BASE_MASK | \
                                             (1L << AM_I_MASK_SEL_TRANSDUCER) | \
                                             (1L << AM_I_MASK_SEL_HS_MIC) | AUX_ALERT_MASK))

#define AM_DFLT_HF_ALERT_TONE_MASK  ((UINT32) (NON_VOICE_BASE_MASK | HF_MASK | AUX_ALERT_MASK))

#define AM_DFLT_HS_VOICE_MASK       ((UINT32) (VOICE_BASE_MASK | (1L << AM_I_MASK_SIDETONE) | \
                                             (1L << AM_I_MASK_ECHO_CONTROL) | HS_MASK))

#define AM_DFLT_HF_VOICE_MASK       ((UINT32) (VOICE_BASE_MASK | (1L << AM_I_MASK_ECHO_CONTROL) | \
                                             HF_MASK))

#define AM_DFLT_DATA_MASK           ((UINT32) ((1L << AM_I_MASK_DSC_MIC_UNMUTE) | \
                                             (1L << AM_I_MASK_ACTIVE_AUDIO)))

#define AM_DFLT_CURRENT_MIC_MASK    ((UINT32) ((1L << AM_I_MASK_MIC_UNMUTE)     | \
                                              (1L << AM_I_MASK_DSC_MIC_UNMUTE)))

/* These are the bits that can be turned off when the digital path is not active */
#define AM_I_MASK_DIGIAL_BITS       ((UINT32) ((1L << AM_I_MASK_DSC_MIC_UNMUTE) | \
                                              (1L << AM_I_MASK_DSC_SPKR_UNMUTE))) 

/* These are the bits that can be turned off when the analog path is not active 
   For backwards compatibility with the Att+Mot hardware layers, only the speaker
   can be turned off when digital devices are present */    
#define AM_I_MASK_ANALOG_BITS       ((UINT32) ((1L << AM_I_MASK_MIC_UNMUTE) | \
                                              (1L << AM_I_MASK_SPKR_UNMUTE)| \
                                              (1L << AM_I_MASK_SEL_EARPIECE)| \
                                              (1L << AM_I_MASK_SEL_TRANSDUCER)| \
                                              (1L << AM_I_MASK_SEL_AUX_SPKR)| \
                                              (1L << AM_I_MASK_SEL_HS_MIC)| \
                                              (1L << AM_I_MASK_SEL_EXT_MIC)))

#define AM_DFLT_HS_VA_VR_OUTPUT_MASK   ((UINT32) ((1L << AM_I_MASK_SEL_EARPIECE) | \
                                                 (1L << AM_I_MASK_ENT_MUTE) | \
                                                 (1L << AM_I_MASK_SPKR_UNMUTE) | \
                                                 (1L << AM_I_MASK_DSC_SPKR_UNMUTE) | \
                                                 (1L << AM_I_MASK_DECODER_MUTE) | \
                                                 (1L << AM_I_MASK_ENCODER_MUTE) | \
                                                 (1L << AM_I_MASK_ACTIVE_AUDIO)))


#define AM_DFLT_HF_VA_VR_OUTPUT_MASK   ((UINT32) ((1L << AM_I_MASK_SEL_AUX_SPKR) | \
                                                 (1L << AM_I_MASK_ENT_MUTE) | \
                                                 (1L << AM_I_MASK_SPKR_UNMUTE) | \
                                                 (1L << AM_I_MASK_DSC_SPKR_UNMUTE) | \
                                                 (1L << AM_I_MASK_DECODER_MUTE) |\
                                                 (1L << AM_I_MASK_ENCODER_MUTE) | \
                                                 (1L << AM_I_MASK_ACTIVE_AUDIO)))


#define AM_DFLT_HS_VA_VR_IO_MASK       ((UINT32) ((1L << AM_I_MASK_SEL_AUX_SPKR) | \
                                                 (1L << AM_I_MASK_SEL_HS_MIC)| \
                                                 (1L << AM_I_MASK_ENT_MUTE) | \
                                                 (1L << AM_I_MASK_MIC_UNMUTE) | \
                                                 (1L << AM_I_MASK_SPKR_UNMUTE) | \
                                                 (1L << AM_I_MASK_DSC_MIC_UNMUTE) | \
                                                 (1L << AM_I_MASK_DSC_SPKR_UNMUTE) | \
                                                 (1L << AM_I_MASK_DECODER_MUTE) |\
                                                 (1L << AM_I_MASK_ENCODER_MUTE) | \
                                                 (1L << AM_I_MASK_ACTIVE_AUDIO)))


#define AM_DFLT_HF_VA_VR_IO_MASK       ((UINT32) ((1L << AM_I_MASK_SEL_AUX_SPKR) | \
                                                 (1L << AM_I_MASK_SEL_EXT_MIC) | \
                                                 (1L << AM_I_MASK_ENT_MUTE) | \
                                                 (1L << AM_I_MASK_MIC_UNMUTE) | \
                                                 (1L << AM_I_MASK_SPKR_UNMUTE) | \
                                                 (1L << AM_I_MASK_DSC_MIC_UNMUTE) | \
                                                 (1L << AM_I_MASK_DSC_SPKR_UNMUTE) | \
                                                 (1L << AM_I_MASK_DECODER_MUTE) | \
                                                 (1L << AM_I_MASK_ENCODER_MUTE) | \
                                                 (1L << AM_I_MASK_ACTIVE_AUDIO)))


#define AM_DFLT_NON_AUDIO_MASK         ((UINT32)(1L << AM_I_MASK_ACTIVE_AUDIO))
 

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

/************** FUNCTION PROTOTYPES *******************************************/

/************** MACROS ********************************************************/

/************** CLASS DEFINITIONS *********************************************/

/************** GLOBAL VARIABLES **********************************************/
extern const UINT16 SAP_DEFAULT_CONFIG;

#ifdef __cplusplus
}
#endif
#endif