xref: /utopia/UTPA2-700.0.x/modules/audio/hal/M7621/audio/halMAD.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 ////////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2008-2009 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // ("MStar Confidential Information") by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 //
93 ////////////////////////////////////////////////////////////////////////////////
94 
95 #ifndef _DEV_MAD_H_
96 #define _DEV_MAD_H_
97 
98 #include "MsTypes.h"
99 #include "halAUDIO.h"
100 #include "drvAUDIO_if.h"
101 
102 //-------------------------------------------------------------------------------------------------
103 //  Macro and Define
104 //-------------------------------------------------------------------------------------------------
105 #define XPCM_PARA_BASEADDR  0x27F0 //0x3F00
106 #define ENC_BUF_SIZE 6;
107 
108 #define RTSP_MEM_ADDR   0x10000 //the base addr is a temporary space borrowed from MAD ES2(assuming it is idle in streaming application)
109 #define RTSP_MEM_SIZE   0x1000
110 
111 #define DMA_READER_TEMP_BUFFER_ADDR   0x052200  //ring tone read buffer (Size: 4KB)
112 
113 #define ACMOD_CH_MASK_C        0x0001
114 #define ACMOD_CH_MASK_L        0x0002
115 #define ACMOD_CH_MASK_R        0x0004
116 #define ACMOD_CH_MASK_LS       0x0008
117 #define ACMOD_CH_MASK_RS       0x0010
118 #define ACMOD_CH_MASK_LFE      0x0020
119 #define ACMOD_CH_MASK_LF       0x0040
120 #define ACMOD_CH_MASK_RF       0x0080
121 #define ACMOD_CH_MASK_NULL     0x0000
122 
123 //=====================================================
124 // AUDIO_MAD System Relational Hal Function
125 //=====================================================
126 MS_U32  HAL_MAD_Read_DSP_sram(MS_U16 dsp_addr,AUDIO_DSP_MEMORY_TYPE dsp_memory_type);
127 MS_BOOL HAL_MAD_Write_DSP_sram(MS_U16 dsp_addr, MS_U32 value, AUDIO_DSP_MEMORY_TYPE dsp_memory_type);
128 void    HAL_MAD_Init(void);
129 void    HAL_MAD_SetMemInfo(void);
130 void    HAL_MAD_SetDecCmd(AU_DVB_DECCMD decCmd);
131 void    HAL_MAD_SetDecCmd2(AUDIO_DEC_ID DecId, AU_DVB_DECCMD u8DecCmd);
132 void    HAL_MAD_SetDSP2DecCmd(AU_DVB_DECCMD decCmd);
133 //void HAL_AUDIO_SetEncodeDoneFlag(MS_BOOL bSet);
134 void    HAL_MAD_SetEncCmd(AU_DVB_ENCCMD u8EncCmd);
135 void    HAL_MAD_EncodeInit(AU_DVB_ENCBR u8EncBr, MS_U8 u8EncFrameNum);
136 void    HAL_AUDIO_GetEncodeFrameInfo(AU_DVB_ENC_FRAME_INFO *FrameInfo);
137 AU_DVB_DECCMD   HAL_MAD_GetDecCmd(En_DVB_AudioDecoder AdoDecoderNo);
138 void    HAL_MAD_DisEn_MIUREQ(void);
139 void    HAL_MAD_Dis_MIUREQ(void);
140 void    HAL_MAD_RSTMAD_DisEn_MIUREQ(void);
141 MS_U8   HAL_MAD_GetReloadCodeAck(void);
142 MS_U8   HAL_MAD_GetLoadCodeAck(void);
143 MS_U8   HAL_MAD_Rpt_DTVES(void);
144 void    HAL_MAD_SetStreamID_Mod(MS_U8 stream_id_mod);
145 void    HAL_MAD_SetAdMixMode (AD_MIX_MODE u8Mix_mode, MS_U8  u8En_mix);
146 void    HAL_MAD_SetDspIDMA(void);
147 void    HAL_MAD_SetMcuCmd(MS_U8 cmd);
148 void    HAL_MAD_SetPIOCmd(MS_U8 cmd);
149 void    HAL_MAD_TriggerPIO8(void);
150 void    HAL_MAD_DvbFLockSynthesizer_En(void);
151 MS_BOOL HAL_MAD_LoadCode(AUDIO_DSP_CODE_TYPE u8Type);
152 MS_BOOL HAL_AUDIO_SetCertMode( Audio_CertMode CertType,Audio_CertEnable enCert );
153 MS_BOOL HAL_MAD_MM2_initAesInfo( AUDIO_DEC_ID  dec_id );
154 MS_BOOL HAL_MAD_MM2_checkAesInfo( AUDIO_DEC_ID  dec_id, AES_INFO *aes_info );
155 MS_BOOL HAL_MAD_MM2_inputAesFinished( AUDIO_DEC_ID dec_id, MS_U32 es_size, MS_BOOL ptsExist, MS_U64 pts );
156 //=====================================================
157 // Function
158 //=====================================================
159 MS_BOOL HAL_MAD_SetCommInfo( Audio_COMM_infoType infoType, MS_VIRT param1, MS_VIRT param2 );
160 MS_U64 HAL_MAD_GetCommInfo( Audio_COMM_infoType infoType );
161 MS_BOOL HAL_MAD_SetMpegInfo( Audio_MPEG_infoType infoType, MS_VIRT param1, MS_VIRT param2 );
162 MS_U32  HAL_MAD_GetMpegInfo( Audio_MPEG_infoType infoType );
163 MS_BOOL HAL_MAD_SetWmaInfo( Audio_WMA_infoType infoType, MS_VIRT param1, MS_VIRT param2 );
164 MS_U32  HAL_MAD_GetWmaInfo( Audio_WMA_infoType infoType );
165 MS_BOOL HAL_MAD_SetAC3Info( Audio_AC3_infoType infoType, MS_VIRT param1, MS_VIRT param2 );
166 MS_U32  HAL_MAD_GetAC3Info( Audio_AC3_infoType infoType );
167 MS_BOOL HAL_MAD_SetAC3PInfo( Audio_AC3P_infoType infoType, MS_VIRT param1, MS_VIRT param2 );
168 MS_U32  HAL_MAD_GetAC3PInfo( Audio_AC3P_infoType infoType );
169 MS_BOOL HAL_MAD_SetDTSCommonCtrl( Audio_DTS_infoType infoType, Audio_DTS_CtrlType ctrl_type );
170 MS_U32  HAL_MAD_GetDTSInfo( Audio_DTS_infoType infoType );
171 MS_BOOL HAL_MAD_SetAACInfo( Audio_AAC_infoType infoType, MS_VIRT param1, MS_VIRT param2 );
172 MS_U32  HAL_MAD_GetAACInfo( Audio_AAC_infoType infoType );
173 MS_BOOL HAL_MAD_SetDtsInfo( Audio_DTS_infoType infoType, MS_U32 param1, MS_U32 param2 );
174 MS_U32  HAL_MAD_GetDtsInfo( Audio_DTS_infoType infoType );
175 MS_BOOL HAL_MAD_SetRA8LBRInfo( Audio_RA8LBR_infoType infoType, MS_U32 param1, MS_U32 param2 );
176 MS_U32  HAL_MAD_GetRA8LBRInfo( Audio_RA8LBR_infoType infoType );
177 
178 //=====================================================
179 // AUDIO_MAD MEPG Relational Hal Function
180 //=====================================================
181 MS_U32  HAL_MAD_MPEG_GetHeaderInfo(void);
182 MS_U16  HAL_MAD_MPEG_GetSampleRate(void);
183 MS_U16  HAL_MAD_MPEG_GetBitRate(void);
184 MPEG_SOUND_MODE   HAL_MAD_MPEG_GetSoundMode(void);
185 
186 //=====================================================
187 // AUDIO_MAD Dolby Relational Hal Function
188 //=====================================================
189 void    HAL_MAD_Monitor_DDPlus_SPDIF_Rate( void );
190 
191 //=====================================================
192 // AUDIO_MAD WMA Relational Hal Function
193 //=====================================================
194 void    HAL_MAD_WMA_SetASFParm(WMA_ASF_PARMTYPE parm_type, MS_U32 value);
195 
196 //=====================================================
197 // AUDIO_MAD AAC Relational Hal Function
198 //=====================================================
199 
200 //=====================================================
201 // AUDIO_MAD OTHERS Relational Driver Function
202 //=====================================================
203 MS_U16  HAL_MAD_XPCM_GetParaBase(void);
204 MS_U8   HAL_MAD_RA8_setParam(MS_U16 mNumCodecs, MS_U16 mSamples, MS_U16 mSampleRate,
205                            MS_U16* Channels, MS_U16* Regions, MS_U16* cplStart, MS_U16* cplQbits,
206                            MS_U16* FrameSize);
207 
208 MS_U16  HAL_MAD_Ra8_GetParaBase(void);
209 extern  MS_BOOL HAL_AUDSP_CheckDecIdmaReady(MS_U8 u8IdmaChk_type );
210 
211 MS_U8   HAL_MAD_XPCM_setParam(XPCM_TYPE audioType, MS_U8  channels, MS_U16 sampleRate,
212                                                     MS_U8  bitsPerSample, MS_U16 blockSize, MS_U16 samplePerBlock);
213 
214 //=====================================================
215 // AUDIO_MAD MM Mode Hal Function
216 //=====================================================
217 MS_U32  HAL_MAD_ReadTimeStamp(void);
218 
219 //====== STAOS PIP START 2012/02/02 ========
220 
221 MS_BOOL HAL_MAD_SetAudioParam2( AUDIO_DEC_ID DecId, Audio_ParamType paramType, MS_VIRT Param );
222 MS_BOOL HAL_MAD_GetAudioInfo2( AUDIO_DEC_ID DecId, Audio_InfoType infoType, void * pInfo );
223 MS_BOOL HAL_MAD_GetAudioCapability(AUDIO_DEC_ID eDecId, AudioDecStatus_t * p_AudioDecStatus);
224 
225 //====== STAOS PIP END 2012/02/02 ========
226 
227 MS_S32 HAL_MAD_CommonCmd_TrasferData(void *pSrc, MS_U32 u32SrcSize, void *pDst, MS_U32 u32DstSzie);
228 MS_S32 HAL_MAD_SetAudioOutputDeviceSelection(AUDIO_OUTPUT_DEVICE_SELECTION_t * pAudioOutputDeviceSelection);
229 MS_S32 HAL_MAD_SpecifyDigitalOutputCodec(AUDIO_SPECIFIED_DIGITAL_OUTPUT_t * pAudioSpecifiedDigitalOutput, DIGITAL_OUTPUT_TYPE u32DigitalOutputType);
230 MS_S32 HAL_MAD_DAP_Control(AUDIO_DAP_CONTROL_t * pDapControl);
231 MS_S32 HAL_MAD_GetDecoderInfo(AUDIO_DECODER_INFO_t * pDecoderInfo);
232 MS_S32 HAL_MAD_CommonCmd(AUDIO_COMMON_CMD_t * cmd);
233 
234 #endif // _DEV_MAD_H_