am_hw_string_primitive.h

来自「Motorola synergy audio component」· C头文件 代码 · 共 125 行

#ifndef AM_HW_STRING_PRIMITIVE_INCLUDE
#define AM_HW_STRING_PRIMITIVE_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.
 */

/******************************* REVISION HISTORY ******************************
 
Date        Author      Reference Number
========    ========    ================
02.09.24    w18944      CR - LIBbb50981
            Support for TCMD use of audio mdi queues

97.11.20    gdrumma     PR - CSGce14786
            Fix word alignment prob in AM/DSP
            - Changed length descriptors to UINT16s.

97-08-11    gdrumma     PR - CSGce11316
            Update Audio Manager for Whitecap
            - Added new constants
            - Updated to coding standard.

97-03-19    gdrumma     PR - CSGce09178
            Add Warm Plug Codec support
            - Added 'AM_HW_SP_WARMPLUG_AUD_DEACTIVATE_BIT' to the status register
              byte.  (For deactivating the codec during a warm plug).

********************************************************************************/


/************** HEADER FILE INCLUDES ******************************************/
          
/************** CONSTANTS *****************************************************/
#include <SUAPI/su_basictypes.h>
#include "td_vr_defs.h"
#define AM_HW_MSG_HEADER_WORD_LEN    (2)                /* 4 UINT8S!!! */
/*  15                                     0
 *  ----------------------------------------
 *  |                MSG_ID                |
 *  ----------------------------------------
 *  |   TIME_STAMP     |        LENGTH     |  
 *  ----------------------------------------
 */

 
/* the size of req with one argument. (three words) */ 
#define AM_HW_STRING_PRIMITIVE_SIZE_OF_ONE_ARG_PRIM      (3)

/* Length of timestamp counter.  NOTE if this increases, timestamp will have to be
   bigger than a UINT8.   
*/
#define AM_HW_STRING_PRIMITIVE_TIMESTAMP_MAX             (240)


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

/* Enumerate the types of hardware string primitives we have   */
enum {     
        AM_HW_CMD_STRING_PRIMITIVE,
        AM_HW_DATA_STRING_PRIMITIVE
     };
typedef UINT8 AM_HW_STRING_TYPE;


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

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

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

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








    /*******************************************************************************************/
    /*               Everything under here can be removed when references are resolved.        */

#define AM_HW_STRING_PRIMITIVE_HEADER_STATUS_REG  0   /* byte contains all flags used by layer 1 */

#define AM_HW_STRING_PRIMITIVE_HEADER_TONE_TAG    1   /* tone tag we want layer to send back */

#define AM_HW_STRING_PRIMITIVE_HEADER_TIME        2   /* playing time for the above tone */ 
 
    /* the index of cpsm id */
#define AM_HW_STRING_PRIMITIVE_HEADER_ID          4   /* CPSM_SPEECH_CODER_CMD_ID */
    /* the length of total command attached */
#define AM_HW_STRING_PRIMITIVE_HEADER_LENGTH      5   /* total length of data that followed */

    /* bit position in status reg byte */
#define AM_HW_SP_CONFIRM_BIT                      0    /* if set, layer one will send tone 
                                                          tag and time back to audio */

#define AM_HW_SP_AUDIO_ACTIVE_BIT                 1    /* if set, layer one must turn on the 
                                                          audio section of smoc */ 

#define AM_HW_SP_AUDIO_DEACTIVE_BIT               2    /* if set, layer one can turn on or off 
                                                          audio section smoc safely */
 /*Note: bits 1 and 2 are mutually exclusive: either bit 1 is set, bit 2 is set, or neither are 
   set. Never are both set */

#define AM_HW_SP_WARMPLUG_AUD_DEACTIVATE_BIT      3    /* if set, layer one will make sure that the codec is turned off,
                                                             if clear, layer one MAY turn the codec on or off as desired. */

/***********************************************************************************************************************/


#ifdef __cplusplus                  /* allow #include in a C++ file */
}
#endif

#endif