xref: /utopia/UTPA2-700.0.x/modules/audio/hal/k6lite/audio/halMAD2.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_MAD2_H_
96 #define _DEV_MAD2_H_
97 #include "MsTypes.h"
98 #include "drvAUDIO_if.h"
99 #include "halMAD.h"
100 
101 //-------------------------------------------------------------------------------------------------
102 //  Macro and Define
103 //-------------------------------------------------------------------------------------------------
104 
105 
106 
107 //-------------------------------------------------------------------------------------------------
108 //  Type and Structure
109 //-------------------------------------------------------------------------------------------------
110 
111 //================================================================
112 //  Structure
113 //================================================================
114 
115 
116 
117 //================================================================
118 //  Enum
119 //================================================================
120 
121 //-------------------------------------------------------------------------------------------------
122 //  Function and Variable
123 //-------------------------------------------------------------------------------------------------
124 
125 //=====================================================
126 // AUDIO_MAD2 System Relational Hal Function
127 //=====================================================
128 void    HAL_MAD2_SetMemInfo(void);
129 void    HAL_MAD2_SetDecCmd(MS_U16 u16DecCmd);
130 void    HAL_MAD2_SetDecCmd2(MS_U16 u16DecCmd);
131 MS_U8   HAL_MAD2_GetDecCmd(void);
132 void    HAL_MAD2_SetFreeRun(MS_U8 u8Freerun);
133 void    HAL_MAD2_SetPIOCmd(MS_U8 Cmd);
134 MS_U32  HAL_MAD2_Read_DSP_sram(MS_U16 u16Dsp_addr,AUDIO_DSP_MEMORY_TYPE dsp_memory_type);
135 MS_BOOL HAL_MAD2_Write_DSP_sram(MS_U16 u16Dsp_addr, MS_U32 u32Value, AUDIO_DSP_MEMORY_TYPE dsp_memory_type);
136 void    HAL_MAD2_DisEn_MIUREQ(void);
137 void    HAL_MAD2_DisMiuReq(void);
138 void    HAL_MAD2_RSTMAD_DisEn_MIUREQ(void);
139 
140 void    HAL_MAD2_Backup_pathreg(void);
141 void    HAL_MAD2_Restore_pathreg(void);
142 
143 void    HAL_MAD2_EnableChIRQ(MS_BOOL bEnable);
144 void    HAL_MAD2_SetDspIDMA(void);
145 void    HAL_MAD2_TriggerPIO8(void);
146 
147 MS_U8   HAL_MAD2_GetReloadCodeAck(void);
148 MS_U8   HAL_MAD2_GetLoadCodeAck(void);
149 void    HAL_MAD2_SetMcuCmd(MS_U8 cmd);
150 extern MS_BOOL HAL_AUDSP_CheckSeIdmaReady(MS_U8 u8IdmaChk_type);
151 MS_BOOL HAL_MAD2_ReLoadCode(AUDIO_DSP_CODE_TYPE dspCodeType);
152 
153 void    HAL_MAD2_RebootDsp(void);
154 extern MS_U8   HAL_SIF_SendCmd(AU_SIF_CMD u8DecCmd, MS_U8 comm_arg1, MS_U8 comm_arg2);
155 void    HAL_MAD2_XPCM_setParam (XPCM_TYPE audioType, MS_U8  channels, MS_U16 sampleRate,
156                                                     MS_U8  bitsPerSample, MS_U16 blockSize, MS_U16 samplePerBlock);
157 MS_U16 HAL_MAD2_XPCM2_CheckIntStatus(void);
158 
159 MS_U32 HAL_MAD2_Read_DSP_Xbox(MS_U16 dsp_addr);
160 MS_BOOL HAL_MAD2_Write_DSP_Xbox(MS_U16 dsp_addr, MS_U32 value);
161 extern MS_BOOL HAL_AUDSP_Check_XBox_TransData_Ready(void);
162 
163 #endif // _DEV_MAD2_H_
164