xref: /utopia/UTPA2-700.0.x/modules/audio/hal/k6lite/audio/halAUDIO.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_AUDIO_H_
96 #define _DEV_AUDIO_H_
97 #include "MsCommon.h"
98 #include "halAUR2.h"
99 
100 
101 #include "MsTypes.h"
102 #include "drvAUDIO_if.h"
103 #include "../../../drv/audio/internal/drvAUDIO_internal.h"
104 #include "../../drv/mbx/apiMBX_St.h"
105 #include "../../drv/mbx/apiMBX.h"
106 
107 
108 
109 //-------------------------------------------------------------------------------------------------
110 //  Macro and Define
111 //-------------------------------------------------------------------------------------------------
112 
113 #define AUDIO_SHM_NAME    "Linux AUDIO driver"
114 #define AUDIO_TEE_INFO_SHM_NAME    "AUDIO TEE INFO SHM"
115 
116 #define AUD_CHK_DSP_READ_RDY            0x08
117 #define AUD_CHK_DSP_WRITE_RDY           0x10
118 #define AUD_R2_DMA_BURST_BYTES          0x4C
119 
120 #define AUMASK_BIT0    0x0001
121 #define AUMASK_BIT1    0x0002
122 #define AUMASK_BIT2    0x0004
123 #define AUMASK_BIT3    0x0008
124 #define AUMASK_BIT4    0x0010
125 #define AUMASK_BIT5    0x0020
126 #define AUMASK_BIT6    0x0040
127 #define AUMASK_BIT7    0x0080
128 
129 #define au_bit0_(val)  ((MS_U8)(val & AUMASK_BIT0))
130 #define au_bit1_(val)  ((MS_U8)(val & AUMASK_BIT1))
131 #define au_bit2_(val)  ((MS_U8)(val & AUMASK_BIT2))
132 #define au_bit3_(val)  ((MS_U8)(val & AUMASK_BIT3))
133 #define au_bit4_(val)  ((MS_U8)(val & AUMASK_BIT4))
134 #define au_bit5_(val)  ((MS_U8)(val & AUMASK_BIT5))
135 #define au_bit6_(val)  ((MS_U8)(val & AUMASK_BIT6))
136 #define au_bit7_(val)  ((MS_U8)(val & AUMASK_BIT7))
137 
138 #define R1BYTE(u32Addr, u8mask) \
139     (READ_BYTE ((MS_VIRT)_gMIO_MapBase + ((u32Addr) << 1) - ((u32Addr) & 1)) & (u8mask))
140 
141 #define W1BYTE(u32Addr, u8Val, u8mask)      \
142     (WRITE_BYTE((MS_VIRT)_gMIO_MapBase + ((u32Addr) << 1) - ((u32Addr) & 1), (R1BYTE(u32Addr, 0xFF) & ~(u8mask)) | ((u8Val) & (u8mask))))
143 
144 // u32Addr must be 16bit aligned
145 #define R2BYTE(u32Addr, u16mask)  \
146     (READ_WORD ((MS_VIRT)_gMIO_MapBase + ((u32Addr) << 1)) & (u16mask))
147 
148 // u32Addr must be 16bit aligned
149 #define W2BYTE(u32Addr, u16Val, u16mask)    \
150     (WRITE_WORD((MS_VIRT)_gMIO_MapBase + ((u32Addr) << 1), (R2BYTE(u32Addr, 15:0) & ~(u16mask)) | ((u16Val) & (u16mask))))
151 
152 ///////////////////////////////////////////////////////////////
153 #define _AU_AbsWriteByte( u32Reg, u8Val )   \
154      do {   \
155      (WRITE_BYTE((MS_VIRT)_gMIO_MapBase + ((u32Reg) << 1) - ((u32Reg) & 1), u8Val)); \
156           }while(0)
157 
158 #define _AU_AbsWrite2Byte( u32Reg, u16Val ) \
159      do {   \
160      (WRITE_WORD((MS_VIRT)_gMIO_MapBase + ((u32Reg) << 1), u16Val)); \
161           }while(0)
162 
163 #define _AU_AbsWriteMaskByte( u32Reg, u8Mask, u8Val )   \
164     do {    \
165     (WRITE_BYTE((MS_VIRT)_gMIO_MapBase + ((u32Reg) << 1) - ((u32Reg) & 1), (R1BYTE((u32Reg), 0xFF) & ~(u8Mask)) | ((u8Val) & (u8Mask))));    \
166         }while(0)
167 
168 #define _AU_AbsReadByte( u32Reg) (READ_BYTE ((MS_VIRT)_gMIO_MapBase + ((u32Reg) << 1) - ((u32Reg) & 1)))
169 #define _AU_AbsRead2Byte( u32Reg)  (READ_WORD ((MS_VIRT)_gMIO_MapBase + ((u32Reg) << 1)) )
170 
171 #define HAL_AUDIO_DecReadReg    HAL_AUDIO_ReadReg
172 #define HAL_AUDIO_SeReadReg    HAL_AUDIO_ReadReg
173 #define HAL_AUDIO_DecReadByte   HAL_AUDIO_ReadByte
174 #define HAL_AUDIO_SeReadByte   HAL_AUDIO_ReadByte
175 #define HAL_AUDIO_DecWriteByte  HAL_AUDIO_WriteByte
176 #define HAL_AUDIO_SeWriteByte  HAL_AUDIO_WriteByte
177 #define HAL_AUDIO_DecWriteMaskByte  HAL_AUDIO_WriteMaskByte
178 #define HAL_AUDIO_SeWriteMaskByte  HAL_AUDIO_WriteMaskByte
179 #define HAL_AUDIO_DecWriteReg  HAL_AUDIO_WriteReg
180 #define HAL_AUDIO_SeWriteReg  HAL_AUDIO_WriteReg
181 #define HAL_AUDIO_DecWriteMaskReg  HAL_AUDIO_WriteMaskReg
182 #define HAL_AUDIO_SeWriteMaskReg  HAL_AUDIO_WriteMaskReg
183 
184 //Enable MS10 DDT Dual decode
185 #define MS10_DDT_DUAL
186 
187 #if (defined(CONFIG_MBOOT))
188     #define AUDIO_DELAY1US(x)                {int xxxx, jjjj, iiii=0; for(xxxx=0; xxxx<x; xxxx++) for(jjjj=0; jjjj<10; jjjj++) iiii++; }
189     #define AUDIO_DELAY1MS(x)                {int xxxx, jjjj, iiii=0; for(xxxx=0; xxxx<x; xxxx++) for(jjjj=0; jjjj<10000; jjjj++) iiii++; }
190 #elif (defined(MCU_AEON))
191     #define AUDIO_DELAY1US(x)                MsOS_DelayTaskUs(x)
192     #define AUDIO_DELAY1MS(x)                AUDIO_DELAY1US(x*1000)
193 #else
194     #define AUDIO_DELAY1US(x)                MsOS_DelayTaskUs(x)
195     #define AUDIO_DELAY1MS(x)                MsOS_DelayTask(x)
196 #endif
197 
198 #define AUDIO_HW_DMA_READER1_SUPPORT    1
199 #define AUDIO_HW_DMA_READER2_SUPPORT    1
200 #define AUDIO_SW_DMA_READER1_SUPPORT    0
201 #define AUDIO_R2_DMA_READER1_SUPPORT    0
202 #define AUDIO_R2_DMA_READER2_SUPPORT    0
203 #define AUDIO_PCM_CAPTURE1_SUPPORT    1
204 #define AUDIO_PCM_CAPTURE2_SUPPORT    1
205 #define AUDIO_HW_DMA_WRITER1_SUPPORT    0
206 
207 #define AUDIO_MP3_ENCODER1_SUPPORT    0
208 #define AUDIO_MP3_ENCODER2_SUPPORT    0
209 
210 #define ASND_R2_SUPPORT    0
211 
212 #define AUDIO_AD_SUPPORT    1
213 
214 //-------------------------------------------------------------------------------------------------
215 //  Type and Structure
216 //-------------------------------------------------------------------------------------------------
217 typedef struct
218 {
219     MS_S64 curPTS;
220     MS_U32 os_Time;
221     MS_BOOL set2Clr;
222 } AUDIO_PTS_INFO;
223 
224 typedef struct
225 {
226     MS_U32 Mem_addr;
227     MS_U32 Mem_size;
228 } AUDIO_RTSP_INFO;
229 
230 /// Audio register structure
231 typedef struct
232 {
233     MS_U32  u32Addr;                    ///< Reg address
234     MS_U8   u8Mask;                     ///<Reg Mask
235     MS_U8   u8Value;                    ///<Reg Value
236 }AUDIO_REG_TYPE, *PAUDIO_REG_TYPE;
237 
238 /// Audio register structure2
239 typedef struct
240 {
241     MS_U32   u32Addr;                    ///< Reg address2
242     MS_U16   u16Mask;                     ///<Reg Mask2
243     MS_U16   u16Value;                    ///<Reg Value2
244 }AUDIO_REG_TYPE2, *PAUDIO_REG_TYPE2;
245 
246 //================================================================
247 //  Structure
248 //================================================================
249 
250 //-------------------------------------------------------------------------------------------------
251 //  Function and Variable
252 //-------------------------------------------------------------------------------------------------
253 MS_BOOL HAL_AUDIO_InitialVars(void);
254 MS_BOOL HAL_AUDIO_DeInitialVars(void);
255 void HAL_AUDIO_SET_INIT_FLAG(MS_BOOL bSet);
256 MS_BOOL HAL_AUDIO_GET_INIT_FLAG(void);
257 MS_BOOL HAL_AUDIO_Mutex_Init(void);
258 MS_BOOL HAL_AUDIO_Mutex_DeInit(void);
259 void    HAL_AUDIO_Set_MMIO_BASE(MS_VIRT _MMIO_MapBase);
260 AU_CHIP_TYPE HAL_AUDIO_GetChipType(void);
261 void HAL_AUDIO_SET_IPAUTH(MS_U32 ip_auth);
262 
263 //================================================================
264 //  Basic Register read/write function
265 //================================================================
266 MS_U8   HAL_AUDIO_AbsReadByte(MS_U32 u32RegAddr);
267 MS_U8   HAL_AUDIO_ReadByte(MS_U32 u32RegAddr);
268 MS_U16  HAL_AUDIO_AbsReadReg(MS_U32 u32RegAddr);
269 MS_U16  HAL_AUDIO_ReadReg(MS_U32 u32RegAddr);
270 void    HAL_AUDIO_AbsWriteByte(MS_U32 u32RegAddr, MS_U8 u8Val);
271 void    HAL_AUDIO_WriteByte(MS_U32 u32RegAddr, MS_U8 u8Val);
272 void    HAL_AUDIO_AbsWriteReg(MS_U32 u32RegAddr, MS_U16 u16Val);
273 void    HAL_AUDIO_WriteReg(MS_U32 u32RegAddr, MS_U16 u16Val);
274 void    HAL_AUDIO_AbsWriteMaskReg(MS_U32 u32RegAddr, MS_U16 u16Mask, MS_U16 u16Val);
275 void    HAL_AUDIO_WriteMaskReg(MS_U32 u32RegAddr, MS_U16 u16Mask, MS_U16 u16Val);
276 void    HAL_AUDIO_AbsWriteMaskByte(MS_U32 u32RegAddr, MS_U8 u8Mask, MS_U8 u8Val);
277 void    HAL_AUDIO_WriteMaskByte(MS_U32 u32RegAddr, MS_U8 u8Mask, MS_U8 u8Val);
278 
279 void    _HAL_AUDIO_Write4Byte(MS_U32 u32RegAddr, MS_U32 u32Val);
280 
281 void    HAL_AUDIO_WriteMailBox(MS_BOOL bDspType, MS_U8 u8ParamNum, MS_U16 u16Data);
282 MS_U16  HAL_AUDIO_ReadMailBox(MS_BOOL bDspType, MS_U8 u8ParamNum);
283 void    HAL_AUDIO_DmaReader_AllInput_Init(void);
284 
285 //================================================================
286 //  For Audio initialize
287 //================================================================
288 MS_BOOL HAL_AUDIO_Init(MS_BOOL Initype);
289 void    HAL_AUDIO_WriteInitTable(void);
290 void    HAL_AUDIO_WritePreInitTable(void);                //Refine power on sequence for earphone & DAC pop noise issue
291 void    HAL_AUDIO_WriteStopDecTable(void);                //Set stop command to R2/DSP
292 void    HAL_AUDIO_EnaEarphone_LowPower_Stage(void);        //Refine power on sequence for earphone & DAC pop noise issue
293 void    HAL_AUDIO_EnaEarphone_HighDriving_Stage(void);    //Refine power on sequence for earphone & DAC pop noise issue
294 void    HAL_AUDIO_SetPowerOn(MS_BOOL bPower_on);
295 void    HAL_AUDIO_ADCInit(void);
296 void    HAL_AUDIO_SwResetMAD(void);
297 void    HAL_AUDIO_ResetDSP(void);
298 void    HAL_AUDIO_TriggerSifPLL(void);
299 
300 void    HAL_AUDIO_DecDspISR(void);
301 void    HAL_AUDIO_SeDspISR(void);
302 
303 void    HAL_AUDIO_SetPlayFileFlag(MS_BOOL bDspType, MS_BOOL bSet);
304 MS_BOOL HAL_AUDIO_GetPlayFileFlag(MS_BOOL bDspType);
305 void    HAL_AUDIO_SetEncodeDoneFlag(MS_BOOL bSet);
306 MS_BOOL HAL_AUDIO_GetEncodeDoneFlag(void);
307 void    HAL_AUDIO_DmaWriter_Init(void);
308 MS_BOOL HAL_AUDIO_DmaWriter_Read(void* buffer, MS_U32 bytes);
309 void    HAL_AUDIO_DMIOReset(void);
310 MS_BOOL HAL_AUDIO_CheckBootOnInitState(void);
311 
312 //================================================================
313 // Audio I/O Config. function
314 //================================================================
315 AUDIO_PATH_GROUP_TYPE HAL_AUDIO_GetPathGroup(void);
316 void    HAL_AUDIO_SetNormalPath(AUDIO_PATH_TYPE path, AUDIO_INPUT_TYPE input, AUDIO_OUTPUT_TYPE output);
317 void    HAL_AUDIO_SetInputPath(AUDIO_INPUT_TYPE u8Input, AUDIO_PATH_TYPE u8Path);
318 void    HAL_AUDIO_SetOutputPath(AUDIO_PATH_TYPE u8Path, AUDIO_OUTPUT_TYPE u8Output);
319 void    HAL_AUDIO_SetInternalPath(AUDIO_INTERNAL_PATH_TYPE u8Path,  AUDIO_OUTPUT_TYPE u8Output);
320 void    HAL_AUDIO_FwTriggerDSP(MS_U16 u16Cmd);
321 void    HAL_AUDIO_DspBootOnDDR(MS_BOOL bEnable);
322 MS_BOOL HAL_AUDIO_GetIsDtvFlag(void);
323 void    HAL_AUDIO_SetIsDtvFlag(MS_BOOL);
324 
325 MS_U8   HAL_AUDIO_ReadDspCodeType(void);
326 MS_U8   HAL_AUDIO_Dec_Status(void);
327 MS_U8   HAL_AUDIO_Se_Status(void);
328 void    HAL_AUDIO_Set_Fading(MS_U32 u32VolFading);
329 
330 void    HAL_AUDIO_BT_SetUploadRate(MS_BOOL bEnable,MS_U8 u8Samprate);
331 void    HAL_AUDIO_BT_SetBufferCounter(MS_U32 u32Counter);
332 void    HAL_AUDIO_USBPCM_Enable(MS_BOOL bEnable);
333 MS_BOOL HAL_AUDIO_USBPCM_GetFlag(void);
334 void    HAL_AUDIO_USBPCM_SetFlag(MS_BOOL bEnable);
335 void    HAL_AUDIO_USBPCM_GetMemInfo(AUDIO_UPLOAD_INFO *uploadInfo);
336 MS_BOOL HAL_AUDIO_SetDataCaptureSource(AUDIO_DEVICE_TYPE eID, AUDIO_CAPTURE_SOURCE_TYPE eSource);
337 MS_BOOL HAL_AUDIO_PCMCapture_Init(const AUDIO_DEVICE_TYPE eID, const AUDIO_CAPTURE_SOURCE_TYPE eSource);
338 MS_BOOL HAL_AUDIO_PCMCapture_Start(const AUDIO_DEVICE_TYPE eID);
339 MS_BOOL HAL_AUDIO_PCMCapture_Stop(const AUDIO_DEVICE_TYPE eID);
340 MS_BOOL HAL_AUDIO_PCMCapture_Read(const AUDIO_DEVICE_TYPE eID, void* buffer, const MS_U32 bytes);
341 
342 void    _HAL_AUDIO_I2S_SetMode(MS_U8 u8Mode, MS_U8 u8Val);
343 
344 //=====================================================
345 // AUDIO SPDIF Relational Hal Function
346 //=====================================================
347 void    _HAL_AUDIO_SPDIF_HWEN(MS_BOOL bEnable);
348 void    _HAL_AUDIO_SPDIF_SetMute(MS_BOOL bEnMute);
349 void    HAL_AUDIO_SPDIF_SetMode(MS_U8 u8Spdif_mode, MS_U8 u8Input_src);
350 MS_U8   _HAL_AUDIO_SPDIF_GetMode(void);
351 void    _HAL_AUDIO_SPDIF_ByPassChannel(MS_BOOL bEnable);
352 void    HAL_AUDIO_SPDIF_SetSCMS(MS_U8 C_bit_en, MS_U8 L_bit_en);
353 MS_U8   HAL_AUDIO_SPDIF_GetSCMS(void);
354 void    HAL_AUDIO_SetChannelStatus(SPDIF_CS_MODE_TYPE eType, SPDIF_CS_MODE_VALUE eValue);
355 MS_BOOL HAL_AUDIO_SPDIF_ChannelStatus_CTRL(AUDIO_SPDIF_CS_TYPE cs_mode, AUDIO_SPDIF_CS_TYPE_STATUS status);
356 void    HAL_AUDIO_SPDIF_Monitor_SamplingRate(void);
357 void    HAL_AUDIO_SPDIF_SetOutputType(AUDIO_SOURCE_INFO_TYPE eSource, AUDIO_SPDIF_OUTPUT_TYPE eType);
358 
359 void HAL_AUDIO_SetDigitalOut(DIGITAL_OUTPUT_TYPE ePath, AUDIO_DIGITAL_OUTPUT_TYPE eDigitalMode);
360 MS_BOOL HAL_AUDIO_DigitalOut_SetChannelStatus(DIGITAL_OUTPUT_TYPE ePath, Digital_Out_Channel_Status_t *stChannelStatus);
361 MS_BOOL HAL_AUDIO_DigitalOut_GetChannelStatus(DIGITAL_OUTPUT_TYPE ePath, Digital_Out_Channel_Status_t *stChannelStatus);
362 void  HAL_AUDIO_Set_DecimationMode(AUDIO_OUTPUT_TYPE Output_Type, Audio_id ID);
363 
364 //=====================================================
365 // AUDIO HDMI Relational Hal Function
366 //=====================================================
367 void    _HAL_AUDIO_HDMI_Tx_SetMute(MS_BOOL bEnMute);
368 MS_BOOL HAL_AUDIO_HDMI_NonpcmMonitor(void);
369 MS_U8   HAL_AUDIO_HDMI_NonpcmMonitor2(void);
370 MS_U8   HAL_AUDIO_HDMI_DolbyMonitor(void);
371 void    HAL_AUDIO_HDMI_SetNonpcm(MS_U8 u8NonPCM_en);
372 void    HAL_AUDIO_HDMI_AC3_PathCFG(MS_U8 u8Ctrl);
373 MS_U16  HAL_AUDIO_HDMI_Get_SYNTH_FREQ(void);
374 void    HAL_AUDIO_HDMI_Set_DwonSample(MS_U8 ratio);
375 void    HAL_AUDIO_HDMIAutoMute(MS_U8 ch, MS_U8 value);
376 void    HAL_AUDIO_HDMI_Tx_GetStatus(MS_BOOL *onOff, AUDIO_FS_TYPE *hdmi_SmpFreq, HDMI_TX_OUTPUT_TYPE *outType );
377 void    HAL_AUDIO_HDMI_TX_SetMode(HDMI_TX_OUTPUT_TYPE outType, AUDIO_SOURCE_INFO_TYPE eSource);
378 MS_BOOL HAL_AUDIO_HDMI_RX_GetHdmiInAudioStatus( ST_HDMI_AUDIO_STATUS *p_hdmiAudioSts);
379 //================================================================
380 // for audio driver internal use function
381 //================================================================
382 void    _HAL_AUDIO_InitStep1(void);
383 void    HAL_AUDIO_SetDspBaseAddr(MS_U8 u8Index, MS_PHY phyBin_Base_Address, MS_PHY phyMad_Base_Buffer_Adr);
384 MS_PHY  HAL_AUDIO_GetDspMadBaseAddr(MS_U8 u8Index);
385 MS_PHY  HAL_AUDIO_GetDspBinBaseAddr(MS_U8 u8Index);
386 void    HAL_AUDIO_SetDspCodeType(AUDIO_DSP_CODE_TYPE dspCodeType, MS_BOOL bFlag);
387 AUDIO_DSP_CODE_TYPE   HAL_AUDIO_GetDspCodeType(void);
388 void HAL_AUDIO_SetDsp2CodeType(AUDIO_DSP_CODE_TYPE dspCodeType, MS_BOOL bFlag);
389 AUDIO_DSP_CODE_TYPE   HAL_AUDIO_GetDsp2CodeType(void);
390 MS_U8   HAL_AUDIO_GetDSPalive(void);
391 void    HAL_AUDIO_SetDSPalive(MS_U8 alive);
392 void    HAL_AUDIO_SetAdvSndEffDspCodeType(AUDIO_DSP_CODE_TYPE dspCodeType, MS_BOOL bFlag);
393 AUDIO_DSP_CODE_TYPE HAL_AUDIO_GetAdvSndEffDspCodeType(void);
394 void    HAL_AUDIO_BackupMailbox(void);
395 void    HAL_AUDIO_RestoreMailbox(void);
396 MS_U8   HAL_AUDIO_Enc_Status(void);
397 void    HAL_AUDIO_DmaReader_Init(SAMPLE_RATE sampleRate);
398 void    HAL_AUDIO_DmaReader_AllInput_Init(void);
399 MS_BOOL HAL_AUDIO_DmaReader_WritePCM(void* buffer, MS_U32 bytes);
400 void    HAL_AUDIO_SetEntertainmentMode(AUDIO_ENTERTAINMENT_MODE eMode);
401 MS_BOOL HAL_AUDIO_AlgReloadCode(AUDIO_DSP_CODE_TYPE dspCodeType);
402 MS_BOOL HAL_AUDIO_Alg2ReloadCode(AUDIO_DSP_CODE_TYPE dspCodeType);
403 
404 MS_BOOL HAL_AUDIO_SetSystem(En_DVB_decSystemType enDecSystem);
405 MS_BOOL HAL_AUDIO_GetDecSysSupportStatus(En_DVB_decSystemType enDecSystem);
406 
407 MS_U16  HAL_AUDIO_GetUniDecodeDoneTag(void);
408 MS_U16  HAL_AUDIO_GetUniDecodeFrameCnt(AUDIO_DEC_ID eDSPId);
409 void    HAL_AUDIO_PTS_info( MS_VIRT );
410 
411 void    HAL_AUDIO_RebootDecDSP(void);
412 MS_U8   HAL_AUDIO_ReadDspCounter(AUDIO_DSP_COUNTER_TYPE  CounterType);
413 void    HAL_AUDIO_DspReboot(MS_U8 alive);
414 void    HAL_AUDIO_SetPowerDownWait(MS_BOOL bEnable);
415 void    HAL_AUDIO_SendIntrupt(MS_BOOL bDspType,MS_U16 u8Cmd);
416 MS_BOOL HAL_AUDIO_SeSystemLoadCode(void);
417 MS_BOOL HAL_AUDIO_DecoderLoadCode(void);
418 
419 extern MS_BOOL HAL_AUDSP_DspLoadCode(AUDIO_DSP_CODE_TYPE dspCodeType);
420 void    HAL_AUDIO_update_DspUsage(AUDIO_SOURCE_INFO_TYPE eSourceType);
421 Audio_id HAL_AUDIO_Convert_DecId_to_ADECId(AUDIO_DEC_ID dec_id);
422 
423 MS_U32 HAL_AUDIO_GetCaps(AUDIO_DEC_ID DecId, MS_U32 *pCaps);
424 MS_BOOL HAL_AUDIO_CheckPlayDone(void);
425 
426 MS_S32 HAL_AUDIO_InputSwitch(AUDIO_SWITCH_GROUP enGroup);
427 
428 //================================================================
429 // Audio ALSA Interface Relational Function
430 //================================================================
431 MS_BOOL HAL_AUDIO_ALSA_Check(void);
432 MS_BOOL HAL_AUDIO_ALSA_Enable(MS_BOOL bEnable);
433 
434 MS_BOOL HAL_AUDIO_ReloadCode(AUDIO_DSP_ID id, AUDIO_DSP_CODE_TYPE code_type);
435 MS_BOOL HAL_AUDIO_AlgReloadCode2(AUDIO_DSP_ID id, void * pau_info);
436 MS_BOOL HAL_AUDIO_SetSystem2(AUDIO_DEC_ID DecId, En_DVB_decSystemType Param);
437 MS_BOOL HAL_AUDIO_SetDecodeSystem(AUDIO_DEC_ID DecId, AudioDecStatus_t *p_AudioDecStatus);
438 //================================================================
439 // Audio dump debug message
440 //================================================================
441 void HAL_AUDIO_DumpDspInfo(void);
442 AUDIO_DEC_ID HAL_AUDIO_OpenDecodeSystem(AudioDecStatus_t * p_AudioDecStatus);
443 MS_PHY HAL_AUDIO_GetDDRInfo(AUDIO_DEC_ID DecId, EN_AUDIO_DDRINFO DDRInfo);
444 MS_BOOL HAL_AUDIO_CheckVersionInfo(void);
445 
446 //================================================================
447 // Audio Common PCM Interface
448 //================================================================
449 #if AUDIO_HW_DMA_READER1_SUPPORT
450 MS_S32 HAL_AUDIO_PCM_HwDma_Reader1_Open(void *pData);
451 MS_S32 HAL_AUDIO_PCM_HwDma_Reader1_Close(void);
452 MS_S32 HAL_AUDIO_PCM_HwDma_Reader1_Start(void);
453 MS_S32 HAL_AUDIO_PCM_HwDma_Reader1_Stop(void);
454 MS_S32 HAL_AUDIO_PCM_HwDma_Reader1_Set(MS_U32 u32Cmd, const void *pData);
455 MS_S32 HAL_AUDIO_PCM_HwDma_Reader1_Get(MS_U32 u32Cmd, void *pData);
456 MS_U32 HAL_AUDIO_PCM_HwDma_Reader1_Write(const void *pBuf, MS_U32 u32Size);
457 MS_S32 HAL_AUDIO_PCM_HwDma_Reader1_Flush(void);
458 #endif
459 
460 #if AUDIO_HW_DMA_READER2_SUPPORT
461 MS_S32 HAL_AUDIO_PCM_HwDma_Reader2_Open(void *pData);
462 MS_S32 HAL_AUDIO_PCM_HwDma_Reader2_Close(void);
463 MS_S32 HAL_AUDIO_PCM_HwDma_Reader2_Start(void);
464 MS_S32 HAL_AUDIO_PCM_HwDma_Reader2_Stop(void);
465 MS_S32 HAL_AUDIO_PCM_HwDma_Reader2_Set(MS_U32 u32Cmd, const void *pData);
466 MS_S32 HAL_AUDIO_PCM_HwDma_Reader2_Get(MS_U32 u32Cmd, void *pData);
467 MS_U32 HAL_AUDIO_PCM_HwDma_Reader2_Write(const void *pBuf, MS_U32 u32Size);
468 MS_S32 HAL_AUDIO_PCM_HwDma_Reader2_Flush(void);
469 #endif
470 
471 #if AUDIO_SW_DMA_READER1_SUPPORT
472 MS_S32 HAL_AUDIO_PCM_SwDma_Reader1_Open(void *pData);
473 MS_S32 HAL_AUDIO_PCM_SwDma_Reader1_Close(void);
474 MS_S32 HAL_AUDIO_PCM_SwDma_Reader1_Start(void);
475 MS_S32 HAL_AUDIO_PCM_SwDma_Reader1_Stop(void);
476 MS_S32 HAL_AUDIO_PCM_SwDma_Reader1_Set(MS_U32 u32Cmd, const void *pData);
477 MS_S32 HAL_AUDIO_PCM_SwDma_Reader1_Get(MS_U32 u32Cmd, void *pData);
478 MS_U32 HAL_AUDIO_PCM_SwDma_Reader1_Write(const void *pBuf, MS_U32 u32Size);
479 MS_S32 HAL_AUDIO_PCM_SwDma_Reader1_Flush(void);
480 #endif
481 
482 #if AUDIO_R2_DMA_READER1_SUPPORT
483 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader1_Open(void *pData);
484 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader1_Close(void);
485 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader1_Start(void);
486 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader1_Stop(void);
487 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader1_Set(MS_U32 u32Cmd, const void *pData);
488 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader1_Get(MS_U32 u32Cmd, void *pData);
489 MS_U32 HAL_AUDIO_PCM_R2Dma_Reader1_Write(const void *pBuf, MS_U32 u32Size);
490 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader1_Flush(void);
491 #endif
492 
493 #if AUDIO_R2_DMA_READER2_SUPPORT
494 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader2_Open(void *pData);
495 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader2_Close(void);
496 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader2_Start(void);
497 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader2_Stop(void);
498 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader2_Set(MS_U32 u32Cmd, const void *pData);
499 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader2_Get(MS_U32 u32Cmd, void *pData);
500 MS_U32 HAL_AUDIO_PCM_R2Dma_Reader2_Write(const void *pBuf, MS_U32 u32Size);
501 MS_S32 HAL_AUDIO_PCM_R2Dma_Reader2_Flush(void);
502 #endif
503 
504 #if AUDIO_PCM_CAPTURE1_SUPPORT
505 MS_S32 HAL_AUDIO_PCM_Capture1_Open(void *pData);
506 MS_S32 HAL_AUDIO_PCM_Capture1_Close(void);
507 MS_S32 HAL_AUDIO_PCM_Capture1_Start(void);
508 MS_S32 HAL_AUDIO_PCM_Capture1_Stop(void);
509 MS_S32 HAL_AUDIO_PCM_Capture1_Set(MS_U32 u32Cmd, const void *pData);
510 MS_S32 HAL_AUDIO_PCM_Capture1_Get(MS_U32 u32Cmd, void *pData);
511 MS_U32 HAL_AUDIO_PCM_Capture1_Read(void *pBuf, MS_U32 u32Size);
512 MS_S32 HAL_AUDIO_PCM_Capture1_Flush(void);
513 #endif
514 
515 #if AUDIO_PCM_CAPTURE2_SUPPORT
516 MS_S32 HAL_AUDIO_PCM_Capture2_Open(void *pData);
517 MS_S32 HAL_AUDIO_PCM_Capture2_Close(void);
518 MS_S32 HAL_AUDIO_PCM_Capture2_Start(void);
519 MS_S32 HAL_AUDIO_PCM_Capture2_Stop(void);
520 MS_S32 HAL_AUDIO_PCM_Capture2_Set(MS_U32 u32Cmd, const void *pData);
521 MS_S32 HAL_AUDIO_PCM_Capture2_Get(MS_U32 u32Cmd, void *pData);
522 MS_U32 HAL_AUDIO_PCM_Capture2_Read(void *pBuf, MS_U32 u32Size);
523 MS_S32 HAL_AUDIO_PCM_Capture2_Flush(void);
524 #endif
525 
526 #if AUDIO_HW_DMA_WRITER1_SUPPORT
527 MS_S32 HAL_AUDIO_PCM_HwDma_Writer1_Open(void *pData);
528 MS_S32 HAL_AUDIO_PCM_HwDma_Writer1_Close(void);
529 MS_S32 HAL_AUDIO_PCM_HwDma_Writer1_Start(void);
530 MS_S32 HAL_AUDIO_PCM_HwDma_Writer1_Stop(void);
531 MS_S32 HAL_AUDIO_PCM_HwDma_Writer1_Set(MS_U32 u32Cmd, const void *pData);
532 MS_S32 HAL_AUDIO_PCM_HwDma_Writer1_Get(MS_U32 u32Cmd, void *pData);
533 MS_U32 HAL_AUDIO_PCM_HwDma_Writer1_Read(void *pBuf, MS_U32 u32Size);
534 MS_S32 HAL_AUDIO_PCM_HwDma_Writer1_Flush(void);
535 #endif
536 
537 //================================================================
538 // Audio Common Encoder Interface
539 //================================================================
540 //#if AUDIO_MP3_ENCODER1_SUPPORT
541 MS_S32 HAL_AUDIO_MP3_ENCODER1_Open(void);
542 MS_S32 HAL_AUDIO_MP3_ENCODER1_Close(void);
543 MS_S32 HAL_AUDIO_MP3_ENCODER1_Start(void);
544 MS_S32 HAL_AUDIO_MP3_ENCODER1_Stop(void);
545 MS_S32 HAL_AUDIO_MP3_ENCODER1_Ioctl(MS_U32 u32Cmd, void *pData);
546 MS_U32 HAL_AUDIO_MP3_ENCODER1_Read(void *pBuf, MS_U32 u32Size);
547 MS_S32 HAL_AUDIO_MP3_ENCODER1_Flush(void);
548 //#endif
549 
550 //#if AUDIO_MP3_ENCODER2_SUPPORT
551 MS_S32 HAL_AUDIO_MP3_ENCODER2_Open(void);
552 MS_S32 HAL_AUDIO_MP3_ENCODER2_Close(void);
553 MS_S32 HAL_AUDIO_MP3_ENCODER2_Start(void);
554 MS_S32 HAL_AUDIO_MP3_ENCODER2_Stop(void);
555 MS_S32 HAL_AUDIO_MP3_ENCODER2_Ioctl(MS_U32 u32Cmd, void *pData);
556 MS_U32 HAL_AUDIO_MP3_ENCODER2_Read(void *pBuf, MS_U32 u32Size);
557 MS_S32 HAL_AUDIO_MP3_ENCODER2_Flush(void);
558 //#endif
559 
560 //================================================================
561 // Specific Definitions for Audio TEE
562 //================================================================
563 #define ree_to_tee_mbx_msg    pAudioTeeInfoShm->ReeToTeeMbxMsg
564 #define tee_to_ree_mbx_msg    pAudioTeeInfoShm->TeeToReeMbxMsg
565 #define tee_mbx_msg_class    pAudioTeeInfoShm->u8MbxMsgClass
566 #define audio_tee_enabled    pAudioTeeInfoShm->g_bAudioTeeEnabled
567 #define audio_tee_mbx_initialized    pAudioTeeInfoShm->g_bAudioTeeMbxInitialized
568 #define dec_dsp_secure_tee_accessed    pAudioTeeInfoShm->g_bDecDspSecureTeeAccessed
569 #define snd_dsp_secure_tee_accessed    pAudioTeeInfoShm->g_bSndDspSecureTeeAccessed
570 #define mbx_msg_ack_status    pAudioTeeInfoShm->ack_status
571 
572 AUDIO_SOURCE_INFO_TYPE HAL_AUDIO_ConvertInputType2SourceInfo(AUDIO_INPUT_TYPE eInputType);
573 
574 #define HALAUDIO_CHECK_TEE_INFO_SHM_INIT \
575     do { \
576         if (pAudioTeeInfoShm == NULL) \
577         { \
578             if (HAL_AUDIO_AllocateTeeInfoShm() == NULL) \
579             { \
580                 MS_ASSERT(0); \
581             } \
582         } \
583     } while(0)
584 
585 #define AUDIO_TEE_INFO_SHM_CHECK_NULL \
586     do { \
587         MS_ASSERT(pAudioTeeInfoShm != NULL); \
588     } while(0)
589 
590 #define REE_TO_TEE_MBX_MSG_SET_PARAM_COUNT(count) \
591     do { \
592         ree_to_tee_mbx_msg.u8ParameterCount = count; \
593     } while(0)
594 
595 #define REE_TO_TEE_MBX_MSG_SET_PARAM(index, parameter) \
596     do { \
597         ree_to_tee_mbx_msg.u8Parameters[index] = parameter; \
598     } while(0)
599 
600 #define REE_TO_TEE_MBX_MSG_INIT \
601     do{ \
602         ree_to_tee_mbx_msg.eRoleID=E_MBX_CPU_MIPS_VPE1; \
603         ree_to_tee_mbx_msg.u8Ctrl=0; \
604         ree_to_tee_mbx_msg.eMsgType=E_MBX_MSG_TYPE_INSTANT; \
605     }while(0)
606 
607 #define TEE_TO_REE_MBX_MSG_INIT(msg) \
608     do{ \
609         msg.eRoleID=E_MBX_CPU_MIPS; \
610         msg.u8Ctrl=0; \
611         msg.eMsgType=E_MBX_MSG_TYPE_INSTANT; \
612     }while(0)
613 
614 #define MBX_MSG_SET_CLASSID(msg,classID)\
615     do{ \
616         msg.u8MsgClass = classID; \
617     }while(0)
618 
619 #define MBX_MSG_SET_CMD(msg,cmd)\
620     do{ \
621         msg.u8Index = cmd; \
622     }while(0)
623 
624 #define TEE_MBX_MSG_CLASS_SET(class) \
625     do{ \
626         tee_mbx_msg_class = class;	\
627     }while(0)
628 
629 //================================================================
630 // Audio TEE MBX Message Enum Definitions (REE side to TEE siede)
631 //================================================================
632 typedef enum
633 {
634     REE_TO_TEE_MBX_MSG_NULL                     = 0x0000,
635 
636     REE_TO_TEE_MBX_MSG_TYPE_GENERAL = 0x20,
637     REE_TO_TEE_MBX_MSG_TYPE_DEC = 0x40,
638     REE_TO_TEE_MBX_MSG_TYPE_SE = 0x80,
639     // NonDSP Specific General MBX Command
640     REE_TO_TEE_MBX_MSG_HAL_AUDIO_SetDspBaseAddr = 0x01,
641     // DSP Specific MBX Command
642     REE_TO_TEE_MBX_MSG_HAL_AUDSP_DspLoadCode    = 0x11
643 } REE_TO_TEE_MBX_MSG_TYPE;
644 
645 //================================================================
646 // Audio TEE MBX Message Enum Definitions (TEE side to REE siede)
647 //================================================================
648 typedef enum
649 {
650    TEE_TO_REE_MBX_MSG_NULL                 = 0x00,
651    TEE_TO_REE_MBX_ACK_MSG_INVALID          = 0x80,
652    TEE_TO_REE_MBX_ACK_MSG_NO_TEE           = 0x81,
653    TEE_TO_REE_MBX_ACK_MSG_ACTION_SUCCESS   = 0x90,
654    TEE_TO_REE_MBX_ACK_MSG_ACTION_FAIL      = 0x91
655 } TEE_TO_REE_MBX_ACK_MSG_TYPE;
656 
657 typedef struct
658 {
659    MS_U32 g_ShmID;
660    MS_BOOL g_bAudioTeeEnabled;
661    MS_BOOL g_bAudioTeeMbxInitialized;
662 
663    MS_BOOL g_bDecDspSecureTeeAccessed;
664    MS_BOOL g_bSndDspSecureTeeAccessed;
665 
666    MBX_Msg ReeToTeeMbxMsg;
667    MBX_Msg TeeToReeMbxMsg;
668    MS_U8 u8MbxMsgClass;
669    MS_U32 g_u32ClientCounter;
670    TEE_TO_REE_MBX_ACK_MSG_TYPE ack_status;
671 } AUDIO_TEE_INFO_SHARE_MEM;
672 
673 #ifndef MSOS_TYPE_NUTTX
674 MS_BOOL HAL_AUDIO_ResetTeeInfoShmToDefault(void);
675 AUDIO_TEE_INFO_SHARE_MEM *HAL_AUDIO_AllocateTeeInfoShm(void);
676 MS_BOOL HAL_AUDIO_DeAllocateTeeInfoShm(void);
677 
678 //================================================================
679 // Audio Mailbox Relational Function
680 //================================================================
681 MS_BOOL HAL_AUDIO_RegisterMBX(void);
682 TEE_TO_REE_MBX_ACK_MSG_TYPE HAL_AUDIO_SendMBXMsg(REE_TO_TEE_MBX_MSG_TYPE msg_type);
683 #endif
684 
685 AUDIO_DSP_CODE_TYPE HAL_AUDIO_Convert_EnDVBdecSystemType_to_AudioDspCodeType(En_DVB_decSystemType enDecSystem);
686 void HAL_AUDIO_ResetDspCodeType(void);
687 MS_S32 HAL_AUDIO_CheckHashkeyDone(MS_U32 ip_auth);
688 #endif // _DEV_AUDIO_H_
689