xref: /utopia/UTPA2-700.0.x/modules/audio/hal/kano/audsp/halAUDSP.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_AUDSP_H_
96 #define _DEV_AUDSP_H_
97 #include "MsCommon.h"
98 #include "MsTypes.h"
99 #include "drvAUDIO_if.h"
100 #include "../../drv/audio/internal/drvAUDIO_internal.h"
101 
102 //-------------------------------------------------------------------------------------------------
103 //  Macro and Define
104 //-------------------------------------------------------------------------------------------------
105 
106 #define code
107 #define BYTE MS_U8
108 
109 ////////////////////////////////////////////////////////////////////////////////
110 // Define & data type
111 ////////////////////////////////////////////////////////////////////////////////
112 
113 typedef struct
114 {
115     MS_U32            cm_addr;
116     MS_U32            cm_len;
117     MS_U8            *cm_buf;
118 
119     MS_U32            pm_addr;
120     MS_U32            pm_len;
121     MS_U8            *pm_buf;
122 
123     MS_U32            cache_addr;
124     MS_U32            cache_len;
125     MS_U8            *cache_buf;
126 
127     MS_U32            prefetch_addr;
128     MS_U32            prefetch_len;
129     MS_U8            *prefetch_buf;
130 
131     char            *AlgName;
132     AUDIO_DSP_CODE_TYPE    dspCodeType;
133 } AUDIO_ALG_INFO, *PAUDIO_ALG_INFO;
134 
135 typedef struct
136 {
137     AUDIO_ALG_INFO* pau_info;
138     MS_U8 DSP_select;
139 }LOAD_CODE_INFO;
140 //-------------------------------------------------------------------------------------------------
141 //  Type and Structure
142 //-------------------------------------------------------------------------------------------------
143 
144 //================================================================
145 //  Structure
146 //================================================================
147 
148 //-------------------------------------------------------------------------------------------------
149 //  Function and Variable
150 //-------------------------------------------------------------------------------------------------
151 //void    HAL_AUDIO_Set_MMIO_BASE(MS_U32 u32_MMIO_MapBase);
152 
153 //================================================================
154 //  Basic Register read/write function
155 //================================================================
156 extern MS_U8   HAL_AUDIO_ReadByte(MS_U32 u32RegAddr);
157 extern MS_U8   HAL_AUDIO_DecReadByte(MS_U32 u32RegAddr);
158 extern MS_U8   HAL_AUDIO_SeReadByte(MS_U32 u32RegAddr);
159 
160 extern MS_U16  HAL_AUDIO_ReadReg(MS_U32 u32RegAddr);
161 extern MS_U16  HAL_AUDIO_DecReadReg(MS_U32 u32RegAddr);
162 extern MS_U16  HAL_AUDIO_SeReadReg(MS_U32 u32RegAddr);
163 
164 extern void    HAL_AUDIO_WriteByte(MS_U32 u32RegAddr, MS_U8 u8Val);
165 extern void    HAL_AUDIO_DecWriteByte(MS_U32 u32RegAddr, MS_U8 u8Val);
166 extern void    HAL_AUDIO_SeWriteByte(MS_U32 u32RegAddr, MS_U8 u8Val);
167 
168 extern void    HAL_AUDIO_WriteReg(MS_U32 u32RegAddr, MS_U16 u16Val);
169 extern void    HAL_AUDIO_DecWriteReg(MS_U32 u32RegAddr, MS_U16 u16Val);
170 extern void    HAL_AUDIO_SeWriteReg(MS_U32 u32RegAddr, MS_U16 u16Val);
171 
172 extern void    HAL_AUDIO_WriteMaskReg(MS_U32 u32RegAddr, MS_U16 u16Mask, MS_U16 u16Val);
173 extern void    HAL_AUDIO_DecWriteMaskReg(MS_U32 u32RegAddr, MS_U16 u16Mask, MS_U16 u16Val);
174 extern void    HAL_AUDIO_SeWriteMaskReg(MS_U32 u32RegAddr, MS_U16 u16Mask, MS_U16 u16Val);
175 
176 extern void    HAL_AUDIO_WriteMaskByte(MS_U32 u32RegAddr, MS_U8 u8Mask, MS_U8 u8Val);
177 extern void    HAL_AUDIO_DecWriteMaskByte(MS_U32 u32RegAddr, MS_U8 u8Mask, MS_U8 u8Val);
178 extern void    HAL_AUDIO_SeWriteMaskByte(MS_U32 u32RegAddr, MS_U8 u8Mask, MS_U8 u8Val);
179 
180 extern void    _HAL_AUDIO_Write4Byte(MS_U32 u32RegAddr, MS_U32 u32Val);
181 
182 extern void    HAL_AUDIO_WriteMailBox(MS_BOOL bDspType, MS_U8 u8ParamNum, MS_U16 u16Data);
183 extern MS_U16  HAL_AUDIO_ReadMailBox(MS_BOOL bDspType, MS_U8 u8ParamNum);
184 extern MS_PHY HAL_AUDIO_GetDspMadBaseAddr(MS_U8 u8Index);
185 extern MS_PHY HAL_AUDIO_GetDspBinBaseAddr(MS_U8 u8Index);
186 extern MS_BOOL MDrv_FLASH_CheckWriteDone(void);
187 extern void    HAL_AUDIO_AbsWriteMaskByte(MS_U32 u32RegAddr, MS_U8 u8Mask, MS_U8 u8Val);
188 
189 MS_BOOL HAL_AUDSP_DspLoadCodeSegment(MS_U32 dsp_addr, MS_U8  *dspCode_buf, MS_U32 dspCode_buflen, MS_U8 DSP_select);
190 MS_BOOL HAL_AUDSP_DspVerifySegmentCode(MS_U32 dsp_addr, MS_U8 *dspCode_buf, MS_U32 dspCode_buflen, MS_U8 DSP_select);
191 
192 MS_BOOL HAL_AUDSP_CheckDecIdmaReady(MS_U8 u8IdmaChk_type);
193 MS_BOOL HAL_AUDSP_CheckSeIdmaReady(MS_U8 u8IdmaChk_type);
194 MS_U32 HAL_AUDSP_GetDspBinBaseAddr(MS_U8 u8Index);
195 void HAL_AUDSP_SetDspCodeTypeLoaded(AUDIO_DSP_CODE_TYPE dspCodeType);
196 AUDIO_DSP_CODE_TYPE HAL_AUDSP_GetDspCodeTypeLoaded(void);
197 MS_BOOL HAL_AUDSP_DspLoadCode(AUDIO_DSP_CODE_TYPE dspCodeType);
198 void HAL_AUDSP_SetDspLoadCodeInfo(AUDIO_ALG_INFO *pau_info, MS_U8 DSP_select);
199 LOAD_CODE_INFO* HAL_AUDSP_GetDspLoadCodeInfo(void);
200 MS_BOOL HAL_AUDSP_DspLoadCode2(MS_U8 DSP_select, void * info);
201 void HAL_AUDSP_DECR2LoadCode(void);
202 MS_BOOL HAL_AUDSP_Check_XBox_TransData_Ready(void);
203 #endif // _DEV_AUDSP_H_
204 
205