xref: /utopia/UTPA2-700.0.x/mxlib/include/drvPWM_v2.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-2007 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 ///
97 /// @file   drvPWM_v2.h
98 /// @brief  MIU Driver Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DRV_PWM_V2_H_
103 #define _DRV_PWM_V2_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 
110 //-------------------------------------------------------------------------------------------------
111 // Defines
112 //-------------------------------------------------------------------------------------------------
113 // below for utopia20 structure
114 
115 typedef enum {
116     MDrv_CMD_PWM_Oen,
117     MDrv_CMD_PWM_Period,
118     MDrv_CMD_PWM_DutyCycle,
119     MDrv_CMD_PWM_UnitDiv,
120     MDrv_CMD_PWM_Div,
121     MDrv_CMD_PWM_Polarity,
122     MDrv_CMD_PWM_Vdben,
123     MDrv_CMD_PWM_ResetEn,
124     MDrv_CMD_PWM_Dben,
125     MDrv_CMD_PWM_Shift,
126     MDrv_CMD_PWM_Nvsync,
127 } ePwmIoctlOpt;
128 
129 
130 //////////////////////////////////////////////////////////////
131 
132 //-------------------------------------------------------------------------------------------------
133 // Macros
134 //-------------------------------------------------------------------------------------------------
135 
136 
137 //-------------------------------------------------------------------------------------------------
138 // Type and Structure Declaration
139 //-------------------------------------------------------------------------------------------------
140 
141 
142 typedef struct _PWM_OEN_PARAM
143 {
144     PWM_ChNum u8IndexPWM;
145     MS_BOOL bOenPWM;
146 }PWM_OEN_PARAM, *PPWM_OEN_PARAM;
147 
148 typedef struct _PWM_PERIOD_PARAM
149 {
150     PWM_ChNum u8IndexPWM;
151     MS_U32 u32PeriodPWM;
152 }PWM_PERIOD_PARAM, *PPWM_PERIOD_PARAM;
153 
154 typedef struct _PWM_DUTYCYCLE_PARAM
155 {
156     PWM_ChNum u8IndexPWM;
157     MS_U32 u32DutyPWM;
158 }PWM_DUTYCYCLE_PARAM, *PPWM_DUTYCYCLE_PARAM;
159 
160 typedef struct _PWM_UNITDIV_PARAM
161 {
162     MS_U16 u16UnitDivPWM;
163 }PWM_UNITDIV_PARAM, *PPWM_UNITDIV_PARAM;
164 
165 typedef struct _PWM_DIV_PARAM
166 {
167     PWM_ChNum u8IndexPWM;
168     MS_U16 u16DivPWM;
169 }PWM_DIV_PARAM, *PPWM_DIV_PARAM;
170 
171 typedef struct _PWM_POLARITY_PARAM
172 {
173     PWM_ChNum u8IndexPWM;
174     MS_BOOL bPolPWM;
175 }PWM_POLARITY_PARAM, *PPWM_POLARITY_PARAM;
176 
177 typedef struct _PWM_VDBEN_PARAM
178 {
179     PWM_ChNum u8IndexPWM;
180     MS_BOOL bVdbenPWM;
181 }PWM_VDBEN_PARAM, *PPWM_VDBEN_PARAM;
182 
183 typedef struct _PWM_RESETEN_PARAM
184 {
185     PWM_ChNum u8IndexPWM;
186     MS_BOOL bRstPWM;
187 }PWM_RESETEN_PARAM, *PPWM_RESETEN_PARAM;
188 
189 typedef struct _PWM_DBEN_PARAM
190 {
191     PWM_ChNum u8IndexPWM;
192     MS_BOOL bDbenPWM;
193 }PWM_DBEN_PARAM, *PPWM_DBEN_PARAM;
194 
195 typedef struct _PWM_SHIFT_PARAM
196 {
197     PWM_ChNum u8IndexPWM;
198     MS_U32 u32DutyPWM;
199 }PWM_SHITF_PARAM, *PPWM_SHIFT_PARAM;
200 
201 typedef struct _PWM_NVSYNC_PARAM
202 {
203     PWM_ChNum u8IndexPWM;
204     MS_BOOL bNvsPWM;
205 }PWM_NVSYNC_PARAM, *PPWM_NVSYNC_PARAM;
206 
207 //-------------------------------------------------------------------------------------------------
208 // Extern Global Variabls
209 //-------------------------------------------------------------------------------------------------
210 
211 //-------------------------------------------------------------------------------------------------
212 // Extern Functions
213 //-------------------------------------------------------------------------------------------------
214 
215 //////////////////////////////////////////////////////////////
216 
217 #ifdef __cplusplus
218 }
219 #endif
220 
221 #endif // _DRV_BDMA_V2_H_
222 
223