am_app_configuration_server.h

Motorola synergy audio component

#ifndef AM_APP_COFIGURATION_SERVER_INCLUDE
#define AM_APP_COFIGURATION_SERVER_INCLUDE

#ifdef __cplusplus         /*  Allow #include in a C++ file.  */
extern "C" {
#endif

/* (c) Copyright Motorola 1996 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
       Definition of current audio mode of operation.

 ************** REVISION HISTORY **********************************************
  
   Date       Author      Reference
   ========   ========    ==========================
   2005-06-13 w17860      CR - LIBff63840
              Apple 3990042: Sometimes after sync, phone only plays out right headphone

   03-10-14   mloutris    CR - LIBdd43633
              E398: New stereo headset detection AM sw to support new HW.
              - Added a new enum to track that we have detected a stereo
                headset and that we need to wait for the complete of the
                accy indication tone.

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

   00-05-03   mkloza      PR - CSGce54341
              MATRIX command implementation
              - removed unused bits

   00-03-14   mkloza      PR - CSGce51641
              Blue Tooth modifications for P2K
              - added AM_CONFIGURATION_BLUE_TOOTH_ACTIVE bit

   99-01-26   mkloza      PR - CSGce27430
              No audio if RS232 attached
              - added element AM_CONFIGURATION_ID_IN_DATA_CALL
                to determine if phone is in data call

   99-01-07   mkloza      PR - CSGce21917
              Secret Tone Feedback
              - added element AM_CONFIGURATION_ID_DTMF_SECRET
                to indicate if DTMF tones should be substituted for 
                generic keypress tone ( AUD_TONE_KEYPRESS ).

   98-06-02   rentring    PR - CSGce19275
              ZAP - ENT MUTE disables 3 secs after OK when not in call
              - add configuration bit to allow ENT MUTE in a call

   97-12-09   mgilot      PR - CSGce15146
              Integration of VA/VR
              - Merged VA/VR modifications to Latest code

   97-09-05   slam        PR - CSGce11610
              Voice Annotation development
              - Remove VA configuration bits.

   97-07-07   gswanson    PR - CSGce06712
              Rae DHFA, ignore the cradle state when an external handset 
              is connected
              - removed AM_CONFIGURATION_MASK_END since it is not used.
              - added  AM_CONFIGURATION_ID_DIGITAL_AUDIO and 
                AM_CONFIGURATION_ID_ANALOG_AUDIO 
                to keep track of whether analog or digital audio is selected.
              - removed AM_CONFIGURATION_ID_FLIP_TIMER since it is NOT used by anyone
              - moved AM_CONFIGURATION_ID_CRADLE and AM_CONFIGURATION_ID_FLIPSTATE to the 
                peripheral server. The cradle state is in the hookstate_info.handset_active_mask 
                and the flip state is in the hookstate_info.info_mask
              - renamed AM_CONFIGURATION_ID_MODE to AM_CONFIGURATION_ID_HF_MODE 
                since if it is set, we are in handsfree mode.
              - added AM_CONFIGURATION_ID_IN_HF_CALL to replace EH :: am_event_incall_and_handsfree 
                since the functionality was moved here and we only need to use a bit 
                rather than a UINT8.  AM_CONFIGURATION_ID_IN_HF_CALL keeps track of 
                the last thing we sent to the IP (intellegent periph)
              - added AM_CONFIGURATION_ID_SMS_PLAYED instead of EH :: am_event_one_shot_alert_played
                so only a bit needs to be used instead of a UINT8.

   97-04-04   mgilot      PR - CSGce09641
              - Add support for VA: Defined two additional Phone Audio modes
                one for VA Record and the ohter for VA Playback.

   97-01-22   gdrumma     PR - CSGce07471
              Warm Plug Audio Mute Support
              - Added bit AM_CONFIGURATION_ID_MUTE to config. 
                server.  Since there are now 9 bits, the 
                configuration server was increased from a UINT8
                to a UINT16.
  
*/
/************** HEADER FILE INCLUDES ******************************************/
#include <SUAPI/suapi.h>
          
/************** CONSTANTS *****************************************************/

/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/
enum
{
    AM_CONFIGURATION_ID_ANALOG_AUDIO,   /* analog audio is active. inactive = 0, active = 1 */
    AM_CONFIGURATION_ID_DIGITAL_AUDIO,  /* digital audio (DSC bus) is active, inactive=0, active=1 */
    AM_CONFIGURATION_ID_HF_MODE,        /* what mode phone is in (handset = 0, handsfree = 1)*/
    AM_CONFIGURATION_ID_INCALL,         /* if the phone is in call. not in call = 0, in call = 1   */

    AM_CONFIGURATION_ID_MUTE,           /* whether the audio is muted, not mute = 0, mute = 1     */
    AM_CONFIGURATION_ID_ALLOW_ENT_MUTE, /* whether ENT MUTE is allowed, do not allow ENT MUTE = 0, allow ENT MUTE = 1*/
    AM_CONFIGURATION_ID_SMS_PLAYED,     /* we have played the sms alert msg 
                                         did not play the sms alert=0, played it =1 */
    AM_CONFIGURATION_ID_DTMF_SECRET,    /* if TRUE indicates that keypress DTMF tones should 
                                         be substituted for generic key tone */
    AM_CONFIGURATION_ID_IN_DATA_CALL    /* 1 = in data call, 0 = phone is not in data call */
};
typedef UINT8 AM_APP_CONFIGURATION_MASK_ID;  /* used to refer to one of the bits in the mask */
typedef UINT16 AM_APP_CONFIGURATION_MASK;    /* the mask containing all of the above bits */

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

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

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

/************** GLOBAL VARIABLES **********************************************/

#ifdef __cplusplus
}
#endif
#endif