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