xref: /utopia/UTPA2-700.0.x/modules/xc/drv/xc/include/drv_sc_menuload.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!�L) 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 
96 #ifndef DRV_SC_MENULOAD_H
97 #define DRV_SC_MENULOAD_H
98 
99 #include "mhal_menuload.h"
100 
101 #define MLOAD_MUTEX
102 #define MLOAD_MUTEX_DBG	0
103 
104 
105 #ifdef DRV_SC_MENULOAD_C
106 #define INTERFACE
107 INTERFACE MS_S32            _MLOAD_MUTEX = -1;
108 #else
109 #define INTERFACE extern
110 INTERFACE MS_S32            _MLOAD_MUTEX;
111 #endif
112 
113 #define _MLOAD_MUTEX_TIME_OUT                 MSOS_WAIT_FOREVER
114 
115 #ifdef MLOAD_MUTEX
116 #if(MLOAD_MUTEX_DBG)
117 #define _MLOAD_ENTRY(pInstance)                                                                  \
118             _XC_SEMAPHORE_ENTRY(pInstance,E_XC_ID_MLD);                                      \
119             printf("0,==========================Prepare to get mutex\n");                             \
120             printf("[%s][%s][%06d]\n",__FILE__,__FUNCTION__,__LINE__);    \
121             if(!MsOS_ObtainMutex(_MLOAD_MUTEX, _MLOAD_MUTEX_TIME_OUT))                     \
122             {                                                                        \
123                 printf("==========================\n");                              \
124                 printf("[%s][%s][%06d] Mutex taking timeout\n",__FILE__,__FUNCTION__,__LINE__);    \
125             }\
126             printf("[%s][%06d] menuload mutex got\n",__FUNCTION__,__LINE__);
127 
128 #define _MLOAD_RETURN(pInstance)                                                                \
129             printf("1,==========================\n");                              \
130             printf("[%s][%s][%06d] \n",__FILE__,__FUNCTION__,__LINE__);    \
131             MsOS_ReleaseMutex(_MLOAD_MUTEX);                                          \
132             printf("==========================prepare to release semaphore\n");                    \
133             _XC_SEMAPHORE_RETURN(pInstance,E_XC_ID_MLD);                           \
134             printf("[%s][%06d] menuload mutex released\n",__FUNCTION__,__LINE__);
135                                 //return _ret;
136 #else
137 #define _MLOAD_ENTRY(pInstance)                                                                  \
138             _XC_SEMAPHORE_ENTRY(pInstance,E_XC_ID_MLD);                  \
139             if(!MsOS_ObtainMutex(_MLOAD_MUTEX, _MLOAD_MUTEX_TIME_OUT))                     \
140             {                                                                        \
141             }
142 #define _MLOAD_RETURN(pInstance)                                                                    \
143             MsOS_ReleaseMutex(_MLOAD_MUTEX);                                               \
144             _XC_SEMAPHORE_RETURN(pInstance,E_XC_ID_MLD);
145                                 //return _ret;
146 
147 #endif
148 #else // #if not def MLOAD_MUTEX
149 #define _MLOAD_ENTRY()         while(0)
150 #define _MLOAD_RETURN()    while(0)
151 #endif // #ifdef _MLOAD_MUTEX
152 
153 typedef struct __attribute__((packed))
154 {
155     MS_U16 u16WPoint;
156     MS_U16 u16RPoint;
157     MS_U16 u16FPoint;
158     MS_PHY PhyAddr;
159     MS_U16 u16MaxCmdCnt;
160     MS_BOOL bEnable;
161 }MS_MLoad_Info;
162 
163 MS_BOOL MDrv_XC_MLoad_Check_Done(void *pInstance);
164 void MDrv_XC_MLoad_Wait_HW_Done(void *pInstance);
165 void  MDrv_XC_MLoad_Init(void *pInstance, MS_PHY phyAddr);
166 void MDrv_XC_MLoad_Trigger(void *pInstance, MS_PHY startAddr, MS_U16 u16CmdCnt);
167 void MDrv_XC_MLoad_AddCmd(void *pInstance, MS_U32 u32Cmd);
168 MS_U32 MDrv_XC_MLoad_GetCmd(MS_PHY DstAddr); //NO_NEED
169 MS_U64 MDrv_XC_MLoad_GetCmd_64Bits(MS_PHY DstAddr);
170 MS_BOOL MDrv_XC_MLoad_BufferEmpty(void *pInstance);
171 MS_BOOL MDrv_XC_MLoad_KickOff(void *pInstance);
172 MS_BOOL MDrv_XC_MLoad_GetCaps(void *pInstance);
173 void MDrv_XC_MLoad_AddNull(void *pInstance);
174 void MDrv_XC_MLoad_Add_32Bits_Cmd(void *pInstance,MS_U32 u32Cmd, MS_U16 u16Mask);
175 void MDrv_XC_MLoad_Add_64Bits_Cmd(void *pInstance,MS_U64 u64Cmd, MS_U16 u16Mask);
176 MS_BOOL MDrv_XC_MLoad_WriteCommand(void *pInstance,MS_U32 u32Addr, MS_U16 u16Data, MS_U16 u16Mask);
177 MS_BOOL MApi_XC_MLoad_WriteCmd_NonXC(void *pInstance,MS_U32 u32Bank,MS_U32 u32Addr, MS_U16 u16Data, MS_U16 u16Mask);
178 MS_BOOL MDrv_XC_MLoad_WriteCommand_NonXC(void *pInstance,MS_U32 u32Bank,MS_U32 u32Addr, MS_U16 u16Data, MS_U16 u16Mask);
179 
180 
181 void MApi_XC_MLoad_Init(MS_PHY PhyAddr, MS_U32 u32BufByteLen);
182 void MApi_XC_MLoad_Cus_Init(EN_MLOAD_CLIENT_SELECT eMloadSelect, MS_PHY PhyAddr, MS_U32 u32BufByteLen);
183 void MApi_XC_MLoad_Enable(MS_BOOL bEnable);
184 void MApi_XC_MLoad_Cus_Enable(EN_MLOAD_CLIENT_SELECT eMloadSelect, MS_BOOL bEnable);
185 MLOAD_TYPE MApi_XC_MLoad_GetStatus(void);
186 MS_BOOL MApi_XC_MLoad_Fire(void *pInstance, MS_BOOL bImmeidate);
187 MS_BOOL MDrv_XC_MLoad_Fire(void *pInstance, MS_BOOL bImmediate);
188 MS_BOOL MApi_XC_MLoad_WriteCmd(void *pInstance, MS_U32 u32Addr, MS_U16 u16Data, MS_U16 u16Mask);
189 MS_BOOL MDrv_XC_MLoad_WriteCmd(void *pInstance, MS_U32 u32Addr, MS_U16 u16Data, MS_U16 u16Mask);
190 
191 void MApi_XC_MLG_Init(MS_PHY PhyAddr, MS_U32 u32BufByteLen);
192 void MApi_XC_MLG_Enable(MS_BOOL bEnable);
193 MS_BOOL MApi_XC_MLG_GetCaps(void);
194 MLG_TYPE MApi_XC_MLG_GetStatus(void);
195 void MApi_XC_MLG_Fire(MS_U8 *pR, MS_U8 *pG, MS_U8 *pB, MS_U16 u16Count, MS_U16 *pMaxGammaValue);
196 MLOAD_TYPE MDrv_XC_MLoad_GetStatus(void *pInstance);
197 void MDrv_XC_MLoad_Enable(void *pInstance,MS_BOOL bEnable);
198 MS_BOOL MDrv_XC_MLoad_set_IP_trig_p(void *pInstance, MS_U16 u16train, MS_U16 u16disp);
199 MS_BOOL MDrv_XC_MLoad_get_IP_trig_p(void *pInstance, MS_U16 *pu16Train, MS_U16 *pu16Disp);
200 void MDrv_XC_MLoad_set_trigger_sync(void *pInstance, MLoad_Trigger_Sync eTriggerSync);
201 
202 #undef INTERFACE
203 #endif
204 
205