xref: /utopia/UTPA2-700.0.x/modules/cmdq/hal/mustang/cmdq/halCMDQ.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) 2006-20012 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 ////////////////////////////////////////////////////////////////////////////////////////////////////
96 // file   halCMDQ.h
97 // @brief  CMDQ HAL
98 // @author MStar Semiconductor,Inc.
99 ////////////////////////////////////////////////////////////////////////////////////////////////////
100 #ifndef __HAL_CMDQ_H__
101 #define __HAL_CMDQ_H__
102 
103 #include "regCMDQ.h"
104 
105 // Trigger Bus Defination
106 #define HAL_GE_GE2CMDQ_TRI                  0xFFFF
107 #define HAL_BDMA_INT_BDMA_0                 0xFFFF
108 #define HAL_BDMA_INT_BDMA_1                 0xFFFF
109 #define HAL_GPU_GPU2CMDQ_TRIG               0xFFFF
110 #define HAL_GOPG0_GOP_CMDQ_INT_0            0xFFFF
111 #define HAL_GOPG1_GOP_CMDQ_INT_1            0xFFFF
112 #define HAL_GOPG2_GOP_CMDQ_INT_2            0xFFFF
113 #define HAL_GOPG3_GOP_CMDQ_INT_3            0xFFFF
114 #define HAL_SCALAR_SC2CMDQ_TRIG_0           0xFFFF
115 #define HAL_SCALAR_SC2CMDQ_TRIG_1           0xFFFF
116 #define HAL_SCALAR_SC2CMDQ_TRIG_2           0xFFFF
117 #define HAL_SCALAR_SC2CMDQ_TRIG_3           0xFFFF
118 #define HAL_AESDMA_CMDQDMA_FINISHED         0xFFFF
119 #define HAL_AESDMA_CMDQDMA_FINISHED_2       0xFFFF
120 #define HAL_VOP_DCM2GOP_VDE                 0xFFFF
121 #define HAL_VOP_DCS2GOP_VDE                 0xFFFF
122 #define HAL_XC_DIP_CMDQ_INT                 0xFFFF
123 
124 
125 #define BUS_SHIFT 4
126 
127 //--------------------------------------------------------------------------------------------------
128 //--------------------------------------------------------------------------------------------------
129 //  Macro of bit operations
130 //--------------------------------------------------------------------------------------------------
131 #define HAS_FLAG(flag, bit)        ((flag) & (bit))
132 #define SET_FLAG(flag, bit)        ((flag)|= (bit))
133 #define RESET_FLAG(flag, bit)      ((flag)&= (~(bit)))
134 #define SET_FLAG1(flag, bit)       ((flag)|  (bit))
135 #define RESET_FLAG1(flag, bit)     ((flag)&  (~(bit)))
136 ////////////////////////////////////////////////
137 // HAL API
138 ////////////////////////////////////////////////
139 void HAL_CMDQ_SetBank(MS_U32 u32BankAddr);
140 void HAL_CMDQ_Enable(void);
141 void HAL_CMDQ_Stop(void);
142 void HAL_CMDQ_Reset(void);
143 void HAL_CMDQ_Set_Miu_Length(MS_U32 value);
144 void HAL_CMDQ_Set_Miu_Request(MS_U32 value);
145 MS_BOOL HAL_CMDQ_Set_Mode(int ModeSel);
146 void HAL_CMDQ_Set_Start_Pointer(MS_U32 StartAddr);
147 void HAL_CMDQ_Set_End_Pointer(MS_U32 EndAddr);
148 void HAL_CMDQ_Set_Offset_Pointer(MS_U32 OffsetAddr);
149 void HAL_CMDQ_Set_Timer(MS_U32 time);
150 void HAL_CMDQ_Set_Ratio(MS_U32 ratio);
151 void HAL_CMDQ_Reset_Soft_Interrupt(void);
152 void HAL_CMDQ_Reset_Start_Pointer_bit(void);
153 void HAL_CMDQ_Read_Soft_Interrupt(void);
154 void HAL_CMDQ_Read_Dec_Done(void);
155 void HAL_CMDQ_Start(void);
156 MS_U32 HAL_CMDQ_Read_Dummy_Register(void);
157 void HAL_CMDQ_Write_Dummy_Register(MS_U32 DummyValue);
158 void HAL_CMDQ_Set_MIU_SELECT(MS_U32 miu_select);
159 MS_U32 HAL_CMDQ_Read_Start_Pointer(void);
160 MS_U32 HAL_CMDQ_Read_End_Pointer(void);
161 void HAL_CMDQ_Write_Dummy_Register_release_polling(int Write_bit);
162 MS_U32 HAL_CMDQ_Error_Command(MS_U32 select_bit);
163 void HAL_CMDQ_Write_Pointer(MS_U32 Write_value);
164 MS_U32 HAL_CMDQ_Read_Pointer(void);
165 MS_U32 HAL_CMDQ_Get_Write_Pointer(void);
166 
167 
168 
169 #endif // #ifndef _CMDQ_REG_MCU_H_
170