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 #ifndef _HAL_PWM_H_ 80 #define _HAL_PWM_H_ 81 82 //////////////////////////////////////////////////////////////////////////////// 83 /// @file HALPWM.h 84 /// @author MStar Semiconductor Inc. 85 /// @brief Pulse Width Modulation hal 86 //////////////////////////////////////////////////////////////////////////////// 87 88 #define PWM_Num 6 89 #define MAX_3DPWM_NUM (4) 90 //////////////////////////////////////////////////////////////////////////////// 91 // Macro for utility 92 //////////////////////////////////////////////////////////////////////////////// 93 #define MST_MACRO_START do { 94 #define MST_MACRO_END } while (0) 95 96 #define UNUSED( var ) ((void)(var)) 97 98 //////////////////////////////////////////////////////////////////////////////// 99 // Macro for bitwise 100 //////////////////////////////////////////////////////////////////////////////// 101 #define _BITMASK(loc_msb, loc_lsb) ((1U << (loc_msb)) - (1U << (loc_lsb)) + (1U << (loc_msb))) 102 #define BITMASK(x) _BITMASK(1?x, 0?x) 103 #define BITFLAG(loc) (1U << (loc)) 104 105 #define BIT0 0x0001 106 #define BIT1 0x0002 107 #define BIT2 0x0004 108 #define BIT3 0x0008 109 #define BIT4 0x0010 110 #define BIT5 0x0020 111 #define BIT6 0x0040 112 #define BIT7 0x0080 113 #define BIT8 0x0100 114 #define BIT9 0x0200 115 #define BIT10 0x0400 116 #define BIT11 0x0800 117 #define BIT12 0x1000 118 #define BIT13 0x2000 119 #define BIT14 0x4000 120 #define BIT15 0x8000 121 122 #define SETBIT(REG, BIT) ((REG) |= (1UL << (BIT))) 123 #define CLRBIT(REG, BIT) ((REG) &= ~(1UL << (BIT))) 124 #define GETBIT(REG, BIT) (((REG) >> (BIT)) & 0x01UL) 125 #define COMPLEMENT(a) (~(a)) 126 127 typedef struct _PWM_3D_RegisterInfo 128 { 129 MS_U32 u32RegOffset; 130 MS_U8 u8NumBit; 131 } PWM_3D_RegisterInfo; 132 133 typedef struct _PWM_3D_RegisterOffset 134 { 135 PWM_3D_RegisterInfo regShift; 136 PWM_3D_RegisterInfo regDuty; 137 } PWM_3D_RegisterOffset; 138 139 //////////////////////////////////////////////////////////////////////////////////////// 140 // Extern function 141 //////////////////////////////////////////////////////////////////////////////// 142 void HAL_PWM_SetIOMapBase(MS_U32 u32Base, MS_U32 u32Base1); 143 void HAL_PWM_SetChipTopIOMapBase(MS_U32 u32Base); 144 MS_U32 HAL_PWM_GetIOMapBase(void); 145 MS_BOOL HAL_PWM_Init(void); 146 MS_BOOL HAL_PWM_Oen(PWM_ChNum index, MS_BOOL letch); 147 MS_BOOL HAL_PWM_UnitDiv(MS_U16 u16DivPWM); 148 void HAL_PWM_Period(PWM_ChNum index, MS_U32 u32PeriodPWM); 149 void HAL_PWM_DutyCycle(PWM_ChNum index, MS_U32 u32DutyPWM); 150 void HAL_PWM_Div(PWM_ChNum index, MS_U16 u16DivPWM); 151 void HAL_PWM_Polarity(PWM_ChNum index, MS_BOOL bPolPWM); 152 void HAL_PWM_VDBen(PWM_ChNum index, MS_BOOL bVdbenPWM); 153 void HAL_PWM_Vrest(PWM_ChNum index, MS_BOOL bRstPWM); 154 void HAL_PWM_DBen(PWM_ChNum index, MS_BOOL bdbenPWM); 155 void HAL_PWM_RstMux(PWM_ChNum index, MS_BOOL bMuxPWM); 156 void HAL_PWM_RstCnt(PWM_ChNum index, MS_U8 u8RstCntPWM); 157 void HAL_PWM_BypassUnit(PWM_ChNum index, MS_BOOL bBypassPWM); 158 MS_BOOL HAL_PWM01_CntMode(PWM_CntMode CntMode); 159 MS_BOOL HAL_PWM23_CntMode(PWM_CntMode CntMode); 160 MS_BOOL HAL_PWM67_CntMode(PWM_CntMode CntMode); 161 MS_BOOL HAL_PWM_Shift(PWM_ChNum index, MS_U32 u32ShiftPWM); 162 void HAL_PWM_IMPULSE_EN(PWM_ChNum index, MS_BOOL bdbenPWM); 163 void HAL_PWM_ODDEVEN_SYNC(PWM_ChNum index, MS_BOOL bdbenPWM); 164 void HAL_PWM_Nvsync(PWM_ChNum index, MS_BOOL bNvsPWM); 165 void HAL_PWM_Align(PWM_ChNum index, MS_BOOL bAliPWM); 166 MS_BOOL HAL_PWM_IsSupport3D(PWM_ChNum index); 167 void HAL_PWM_SetMultiDiff(MS_BOOL bEnable); 168 MS_BOOL HAL_PWM_Set3D_DiffWaveform(PWM_ChNum index, MS_U8 u8WaveformIndex, MS_U32 u32Shift, MS_U32 u32Duty); 169 void HAL_PM_PWM_Enable(void); 170 void HAL_PM_PWM_Period(MS_U16 u16PeriodPWM); 171 void HAL_PM_PWM_DutyCycle(MS_U16 u16DutyPWM); 172 void HAL_PM_PWM_Div(MS_U8 u8DivPWM); 173 void HAL_PM_PWM_Polarity(MS_BOOL bPolPWM); 174 void HAL_PM_PWM_DBen(MS_BOOL bdbenPWM); 175 MS_U32 HAL_PWM_GetPeriod(PWM_ChNum index); 176 MS_U32 HAL_PWM_GetDutyCycle(PWM_ChNum index); 177 MS_BOOL HAL_PWM_INV_3D_Flag(MS_BOOL bInvPWM); 178 #endif // _HAL_PWM_H_ 179 180