xref: /utopia/UTPA2-700.0.x/modules/pws/hal/k6/pws/halPWS.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 #ifndef _HAL_PWS_H_
95 #define _HAL_PWS_H_
96 
97 ////////////////////////////////////////////////////////////////////////////////
98 /// @file HALPWS.h
99 /// @author MStar Semiconductor Inc.
100 /// @brief power saving hal
101 ////////////////////////////////////////////////////////////////////////////////
102 
103 //------------------------------------------------------------------------------
104 // Header Files
105 //------------------------------------------------------------------------------
106 #include "drvPWS.h"
107 
108 //------------------------------------------------------------------------------
109 // Define & data type
110 //------------------------------------------------------------------------------
111 #define U4_DEVICE_ID    0x001B
112 #define DEVICE_ID       U4_DEVICE_ID
113 typedef   struct   {
114     MS_U32        u32RegAddr;
115     MS_BOOL       bEnable;
116     MS_U8         u8BitPos;
117     E_PWS_IP_name eIpName;
118 }E_PWS_IP_MASK_TABLE_INFO;
119 
120 static const E_PWS_IP_MASK_TABLE_INFO pws_ip_mask_info_table[] =
121 {
122 
123     //========================================================
124     //        [ End of the table ]
125     //========================================================
126     { 0x00000000, FALSE, 0x00, E_PWS_IP_MAX},
127 };
128 
129 typedef   struct   {
130     MS_U32        u32RegAddr;
131     MS_U16        u16RegVal;
132     E_PWS_IP_name eIpName;
133 }E_PWS_IP_TABLE_INFO;
134 
135 static const E_PWS_IP_TABLE_INFO pws_ip_info_table[] =
136 {
137     //========================================================
138     //        [ End of the table ]
139     //========================================================
140     { 0x00000000, 0x0000, E_PWS_IP_MAX},
141 
142 };
143 
144 
145 //------------------------------------------------------------------------------
146 // Extern function
147 //------------------------------------------------------------------------------
148 void   HAL_PWS_SetIOMapBase(MS_U32 u32Base);
149 MS_U32 HAL_PWS_GetIOMapBase(void);
150 MS_U8  HAL_PWS_CheckChipID(void);
151 MS_U16 HAL_PWS_Read2Byte(MS_U32 u32RegAddr);
152 E_PWS_SouceInfo HAL_PWS_GetSourceInfo(void);
153 void HAL_PWS_Init(E_PWS_VIF_type eVifType);
154 E_PWS_Result HAL_PWS_HandleSource(E_PWS_Operation operation,E_PWS_SouceInfo source);
155 E_PWS_Result HAL_PWS_HandleIP(E_PWS_IpPowerCtrl IpPowerCtrl,const unsigned char *RegName);
156 E_PWS_Result HAL_PWS_RegisterCallback(MS_U8 index, E_PWS_CallbackCtrl cb_ctrl, unsigned char *RegName, P_PWS_Callback pfCallback);
157 E_PWS_Result HAL_PWS_CancelCallback(MS_U8 index);
158 
159 void HAL_PWS_MonitorPowerProc(void);
160 void HAL_PWS_Stop_VDMCU(void);
161 
162 E_PWS_Result HAL_PWS_IpPowerControl(E_PWS_IP_name eIpName, E_PWS_IpPowerCtrl pwr_type);
163 E_PWS_Result HAL_PWS_ScenePowerControl(E_PWS_SCENE_name eSceneName, E_PWS_IpPowerCtrl pwr_type);
164 #endif  //_HAL_PWS_H_
165