xref: /utopia/UTPA2-700.0.x/modules/xc/hal/maxim/xc/include/mhal_dynamicscaling.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 // All rights reserved.
79 //
80 // Unless otherwise stipulated in writing, any and all information contained
81 // herein regardless in any format shall remain the sole proprietary of
82 // MStar Semiconductor Inc. and be kept in strict confidence
83 // (��MStar Confidential Information��) by the recipient.
84 // Any unauthorized act including without limitation unauthorized disclosure,
85 // copying, use, reproduction, sale, distribution, modification, disassembling,
86 // reverse engineering and compiling of the contents of MStar Confidential
87 // Information is unlawful and strictly prohibited. MStar hereby reserves the
88 // rights to any and all damages, losses, costs and expenses resulting therefrom.
89 //
90 ////////////////////////////////////////////////////////////////////////////////
91 #ifndef MHAL_DYNAMICSCALING_H
92 #define MHAL_DYNAMICSCALING_H
93 
94 #ifdef MHAL_DYNAMICSCALING_C
95 #define INTERFACE
96 #else
97 #define INTERFACE extern
98 #endif
99 
100 //-------------------------------------------------------------------------------------------------
101 //  Macro and Define
102 //-------------------------------------------------------------------------------------------------
103 #define DS_OP_CMD_LEN 4  //byte
104 #define MS_DS_NULL_CMD_32BITS    0xFFFF0000;         //Dummy cmd BKFF_FF=0x0000
105 #define MS_DS_NULL_CMD_64BITS    0x00000009FFFF0000; //Dummy cmd BKFF_7F=0x0000
106 //----------------------------------------------
107 //  BKFF_7F just for dummy ds cmd
108 //----------------------------------------------
109 #define REG_SC_BKFF_7F_L      _PK_L_(0xFF, 0x7F)
110 #define REG_SC_BKFF_7F_H      _PK_H_(0xFF, 0x7F)
111 
112 //-------------------------------------------------------------------------------------------------
113 //  Type and Structure
114 //-------------------------------------------------------------------------------------------------
115 
116 typedef enum
117 {
118     DS_IP,
119     DS_OP,
120 } ds_reg_ip_op_sel;
121 
122 typedef enum
123 {
124     DS_XC,
125     DS_MVOP,
126     DS_GOP,
127 } ds_reg_source_sel;
128 
129 //-------------------------------------------------------------------------------------------------
130 //  Function and Variable
131 //-------------------------------------------------------------------------------------------------
132 
133 
134 INTERFACE MS_BOOL MHAL_SC_Set_DynamicScaling(void *pInstance,MS_PHY u32MemBaseAddr, MS_U8 u8MIU_Select, MS_U8 u8IdxDepth, MS_BOOL bOP_On, MS_BOOL bIPS_On, MS_BOOL bIPM_On,SCALER_WIN eWindow);
135 INTERFACE void MHAL_SC_Set_DynamicScalingFlag(void *pInstance, MS_BOOL bEnable);
136 INTERFACE MS_BOOL MHAL_SC_Get_DynamicScaling_Status(void *pInstance);
137 INTERFACE MS_BOOL MHAL_SC_Enable_IPMTuneAfterDS(void *pInstance, MS_BOOL bEnable);
138 INTERFACE void MHal_SC_DynamicScaling_SWReset(void);
139 INTERFACE void Hal_SC_ResetSWDSCommand(void *pInstance,SCALER_WIN eWindow, MS_U8 u8DSIndex);
140 INTERFACE void Hal_SC_WriteSWDSCommand(void *pInstance,SCALER_WIN eWindow, MS_U32 u32CmdRegAddr, MS_U16 u16CmdRegValue,ds_reg_ip_op_sel IPOP_Sel,ds_reg_source_sel Source_Select,XC_DS_CMDCNT *pstXC_DS_CmdCnt);
141 INTERFACE void Hal_SC_WriteSWDSCommand_Mask(void *pInstance,SCALER_WIN eWindow, MS_U32 u32CmdRegAddr, MS_U16 u16CmdRegValue,ds_reg_ip_op_sel IPOP_Sel,ds_reg_source_sel Source_Select,XC_DS_CMDCNT *pstXC_DS_CmdCnt,MS_U16 u16Mask);
142 INTERFACE void Hal_SC_WriteSWDSCommand_NonXC(void *pInstance,SCALER_WIN eWindow,MS_U32 u32Bank,MS_U32 u32Addr, MS_U16 u16Data, MS_U16 u16Mask,ds_reg_ip_op_sel IPOP_Sel,XC_DS_CMDCNT *pstXC_DS_CmdCnt);
143 INTERFACE void Hal_SC_Add_NullCommand(void *pInstance,SCALER_WIN eWindow,ds_reg_ip_op_sel IPOP_Sel,XC_DS_CMDCNT *pstXC_DS_CmdCnt);
144 
145 #define Hal_SC_SetSeamlessZapping(args...) 0
146 #define Hal_SC_GetSeamlessZappingStatus(args...) 0
147 #define Hal_SC_PrepareSeamlessZapping(args...)
148 INTERFACE MS_BOOL MHal_XC_Get_DSForceIndexSupported(void *pInstance, SCALER_WIN eWindow);
149 INTERFACE void MHal_XC_Set_DSIndexSourceSelect(void *pInstance, E_XC_DS_INDEX_SOURCE eDSIdxSrc, SCALER_WIN eWindow);
150 INTERFACE void MHal_XC_Set_DSForceIndex(void *pInstance, MS_BOOL bEnable, MS_U8 u8Index, SCALER_WIN eWindow);
151 INTERFACE void Hal_XC_Enable_DS_64Bits_Command(void *pInstance,MS_BOOL bEn);
152 INTERFACE void Hal_XC_Enable_DS_64Bits_Sread_Mode(void *pInstance,MS_BOOL bEn);
153 INTERFACE void Hal_XC_Enable_DS_4_Baseaddress_Mode(void *pInstance,MS_BOOL bEn);
154 INTERFACE void Hal_XC_Set_DS_64Bits_MIU_Bus_Sel(void *pInstance);
155 INTERFACE void Hal_XC_Set_DS_BaseAddress(void *pInstance,MS_PHY u32Base);
156 INTERFACE void Hal_XC_Set_DS_IndexDepth(void *pInstance);
157 INTERFACE void Hal_XC_Set_DS_MIU_Sel(void *pInstance,MS_U16 u16DSOnOff,MS_U16 u16DS_MIU_Sel_bit1);
158 INTERFACE MS_U64 Hal_SC_GenSpreadModeCmd(void *pInstance, MS_U32 u32CmdRegAddr, MS_U16 u16CmdRegValue, MS_U16 u16Mask, ds_reg_source_sel eSourceSelect);
159 #undef INTERFACE
160 #endif //MHAL_DYNAMICSCALING_H
161 
162