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 _HWREG_UTILITY_H_ 95 #define _HWREG_UTILITY_H_ 96 97 #include "hwreg_pq.h" 98 99 extern MS_U8 MApi_XC_ReadByte(MS_U32 u32Reg); 100 extern MS_U16 MApi_XC_Read2Byte(MS_U32 u32Reg); 101 extern MS_U32 MApi_XC_Read4Byte(MS_U32 u32Reg); 102 extern MS_U8 MApi_XC_ReadRegbit(MS_U32 u32Reg, MS_U8 u8Mask); 103 extern void MApi_XC_WriteRegBit(MS_U32 u32Reg, MS_BOOL bEnable, MS_U8 u8Mask); 104 extern void MApi_XC_WriteByte(MS_U32 u32Reg, MS_U8 u8Val); 105 extern void MApi_XC_Write2Byte(MS_U32 u32Reg, MS_U16 u16Val); 106 extern void MApi_XC_Write3Byte(MS_U32 u32Reg, MS_U32 u32Val); 107 extern void MApi_XC_Write4Byte(MS_U32 u32Reg, MS_U32 u32Val); 108 extern void MApi_XC_WriteByteMask(MS_U32 u32Reg, MS_U8 u8Val, MS_U8 u8Msk); 109 extern void MApi_XC_Write2ByteMask(MS_U32 u32Reg, MS_U16 u16val, MS_U16 u16Mask); 110 //============================================================= 111 // Just for Scaler 112 extern void MApi_XC_W2BYTE(MS_U32 u32Reg, MS_U16 u16Val); 113 extern MS_U16 MApi_XC_R2BYTE(MS_U32 u32Reg); 114 extern void MApi_XC_W4BYTE(MS_U32 u32Reg, MS_U32 u32Val); 115 extern MS_U32 MApi_XC_R4BYTE(MS_U32 u32Reg); 116 extern MS_U16 MApi_XC_R2BYTEMSK(MS_U32 u32Reg, MS_U16 u16mask); 117 extern void MApi_XC_W2BYTEMSK(MS_U32 u32Reg, MS_U16 u16Val, MS_U16 u16mask); 118 119 //============================================================= 120 //General ( Make sure u32Reg is not ODD 121 extern void MApi_XC_GW2BYTE(MS_U32 u32Reg, MS_U16 u16Val); 122 extern MS_U16 MApi_XC_GR2BYTE(MS_U32 u32Reg); 123 extern void MApi_XC_GW4BYTE(MS_U32 u32Reg, MS_U32 u32Val); 124 extern MS_U32 MApi_XC_GR4BYTE(MS_U32 u32Reg); 125 extern MS_U16 MApi_XC_GR2BYTEMSK(MS_U32 u32Reg, MS_U16 u16mask); 126 extern void MApi_XC_GW2BYTEMSK(MS_U32 u32Reg, MS_U16 u16Val, MS_U16 u16mask); 127 128 129 #if 0 130 //!! Do not include this header in driver or api level 131 132 //------------------------------------------------------------------------------------------------- 133 // Macro and Define 134 //------------------------------------------------------------------------------------------------- 135 extern MS_U32 PQ_RIU_BASE; // This should be inited before XC library starting. 136 137 #define _BITMASK(loc_msb, loc_lsb) ((1U << (loc_msb)) - (1U << (loc_lsb)) + (1U << (loc_msb))) 138 #define BITMASK(x) _BITMASK(1?x, 0?x) 139 #define HBMASK 0xFF00 140 #define LBMASK 0x00FF 141 142 #define RIU_MACRO_START do { 143 #define RIU_MACRO_END } while (0) 144 145 // Address bus of RIU is 16 bits. 146 #define RIU_READ_BYTE(addr) ( READ_BYTE( PQ_RIU_BASE + (addr) ) ) 147 #define RIU_READ_2BYTE(addr) ( READ_WORD( PQ_RIU_BASE + (addr) ) ) 148 #define RIU_WRITE_BYTE(addr, val) { WRITE_BYTE( PQ_RIU_BASE + (addr), val) } 149 #define RIU_WRITE_2BYTE(addr, val) { WRITE_WORD( PQ_RIU_BASE + (addr), val) } 150 151 152 //============================================================= 153 // Standard Form 154 155 #define MDrv_ReadByte( u32Reg ) RIU_READ_BYTE(((u32Reg) << 1) - ((u32Reg) & 1)) 156 157 #define MDrv_Read2Byte( u32Reg ) (RIU_READ_2BYTE((u32Reg)<<1)) 158 159 #define MDrv_Read4Byte( u32Reg ) ( (MS_U32)RIU_READ_2BYTE((u32Reg)<<1) | ((MS_U32)RIU_READ_2BYTE(((u32Reg)+2)<<1)<<16 ) ) 160 161 #define MDrv_ReadRegBit( u32Reg, u8Mask ) (RIU_READ_BYTE(((u32Reg)<<1) - ((u32Reg) & 1)) & (u8Mask)) 162 163 #define MDrv_WriteRegBit( u32Reg, bEnable, u8Mask ) \ 164 RIU_MACRO_START \ 165 RIU_WRITE_BYTE( (((u32Reg) <<1) - ((u32Reg) & 1)) , (bEnable) ? (RIU_READ_BYTE( (((u32Reg) <<1) - ((u32Reg) & 1)) ) | (u8Mask)) : \ 166 (RIU_READ_BYTE( (((u32Reg) <<1) - ((u32Reg) & 1)) ) & ~(u8Mask))); \ 167 RIU_MACRO_END 168 169 #define MDrv_WriteByte( u32Reg, u8Val ) \ 170 RIU_MACRO_START \ 171 RIU_WRITE_BYTE(((u32Reg) << 1) - ((u32Reg) & 1), u8Val); \ 172 RIU_MACRO_END 173 174 #define MDrv_Write2Byte( u32Reg, u16Val ) \ 175 RIU_MACRO_START \ 176 if ( ((u32Reg) & 0x01) ) \ 177 { \ 178 RIU_WRITE_BYTE(((u32Reg) << 1) - 1, (MS_U8)((u16Val))); \ 179 RIU_WRITE_BYTE(((u32Reg) + 1) << 1, (MS_U8)((u16Val) >> 8)); \ 180 } \ 181 else \ 182 { \ 183 RIU_WRITE_2BYTE( ((u32Reg)<<1) , u16Val); \ 184 } \ 185 RIU_MACRO_END 186 187 #define MDrv_Write3Byte( u32Reg, u32Val ) \ 188 RIU_MACRO_START \ 189 if ((u32Reg) & 0x01) \ 190 { \ 191 RIU_WRITE_BYTE((u32Reg << 1) - 1, u32Val); \ 192 RIU_WRITE_2BYTE( (u32Reg + 1)<<1 , ((u32Val) >> 8)); \ 193 } \ 194 else \ 195 { \ 196 RIU_WRITE_2BYTE( (u32Reg) << 1, u32Val); \ 197 RIU_WRITE_BYTE( (u32Reg + 2) << 1 , ((u32Val) >> 16)); \ 198 } \ 199 RIU_MACRO_END 200 201 #define MDrv_Write4Byte( u32Reg, u32Val ) \ 202 RIU_MACRO_START \ 203 if ((u32Reg) & 0x01) \ 204 { \ 205 RIU_WRITE_BYTE( ((u32Reg) << 1) - 1 , u32Val); \ 206 RIU_WRITE_2BYTE( ((u32Reg) + 1)<<1 , ( (u32Val) >> 8)); \ 207 RIU_WRITE_BYTE( (((u32Reg) + 3) << 1) , ((u32Val) >> 24)); \ 208 } \ 209 else \ 210 { \ 211 RIU_WRITE_2BYTE( (u32Reg) <<1 , u32Val); \ 212 RIU_WRITE_2BYTE( ((u32Reg) + 2)<<1 , ((u32Val) >> 16)); \ 213 } \ 214 RIU_MACRO_END 215 216 #define MDrv_WriteByteMask( u32Reg, u8Val, u8Msk ) \ 217 RIU_MACRO_START \ 218 RIU_WRITE_BYTE( (((u32Reg) <<1) - ((u32Reg) & 1)), (RIU_READ_BYTE((((u32Reg) <<1) - ((u32Reg) & 1))) & ~(u8Msk)) | ((u8Val) & (u8Msk))); \ 219 RIU_MACRO_END 220 221 222 223 224 //============================================================= 225 // Just for Scaler 226 #define SC_W2BYTE( u32Reg, u16Val)\ 227 ( { RIU_WRITE_2BYTE(REG_SCALER_BASE << 1, ((u32Reg) >> 8) & 0x00FF ) ; \ 228 RIU_WRITE_2BYTE( (REG_SCALER_BASE +((u32Reg) & 0xFF) ) << 1 , u16Val ) ; } ) 229 230 #define SC_R2BYTE( u32Reg ) \ 231 ( { RIU_WRITE_2BYTE(REG_SCALER_BASE << 1, ( (u32Reg) >> 8) & 0x00FF ) ; \ 232 RIU_READ_2BYTE( (REG_SCALER_BASE + ((u32Reg) & 0xFF) )<<1 ) ; } ) 233 234 #define SC_W4BYTE( u32Reg, u32Val)\ 235 ( { RIU_WRITE_2BYTE(REG_SCALER_BASE<<1, ((u32Reg) >> 8) & 0x00FF ) ; \ 236 RIU_WRITE_2BYTE( (REG_SCALER_BASE + ((u32Reg) & 0xFF) ) <<1, (MS_U16)((u32Val) & 0x0000FFFF) ) ; \ 237 RIU_WRITE_2BYTE( (REG_SCALER_BASE + ((u32Reg) & 0xFF) + 2 ) << 1, (MS_U16)(((u32Val) >> 16) & 0x0000FFFF) ); } ) 238 239 #define SC_R4BYTE( u32Reg )\ 240 ( { RIU_WRITE_2BYTE(REG_SCALER_BASE << 1, ((u32Reg) >> 8) & 0x00FF ) ; \ 241 RIU_READ_2BYTE( (REG_SCALER_BASE + ((u32Reg) & 0xFF) ) << 1 ) | (MS_U32)(RIU_READ_2BYTE( (REG_SCALER_BASE + ((u32Reg) & 0xFF) + 2 ) << 1 )) << 16; } ) 242 243 #define SC_R2BYTEMSK( u32Reg, u16mask)\ 244 ( { RIU_WRITE_2BYTE(REG_SCALER_BASE << 1, ((u32Reg) >> 8) & 0x00FF ) ; \ 245 RIU_READ_2BYTE( (REG_SCALER_BASE + ((u32Reg) & 0xFF) ) << 1) & (u16mask) ; } ) 246 247 #define SC_W2BYTEMSK( u32Reg, u16Val, u16Mask)\ 248 ( { RIU_WRITE_2BYTE(REG_SCALER_BASE << 1, ((u32Reg) >> 8) & 0x00FF ) ; \ 249 RIU_WRITE_2BYTE( (REG_SCALER_BASE + ((u32Reg) & 0xFF) ) << 1, (RIU_READ_2BYTE( (REG_SCALER_BASE + ((u32Reg) & 0xFF) ) << 1) & ~(u16Mask) ) | ((u16Val) & (u16Mask)) ) ; }) 250 251 //============================================================= 252 // Just for MOD 253 #define MOD_W2BYTE( u32Reg, u16Val)\ 254 ( { RIU_WRITE_2BYTE(REG_MOD_BASE << 1, ((u32Reg) >> 8) & 0x00FF ); \ 255 RIU_WRITE_2BYTE( (REG_MOD_BASE + ((u32Reg) & 0xFF) ) << 1, u16Val ); } ) 256 257 #define MOD_R2BYTE( u32Reg ) \ 258 ( { RIU_WRITE_2BYTE(REG_MOD_BASE << 1, ((u32Reg) >> 8) & 0x00FF ); \ 259 RIU_READ_2BYTE( (REG_MOD_BASE + ((u32Reg) & 0xFF) ) << 1) ; } ) 260 261 #define MOD_R2BYTEMSK( u32Reg, u16mask)\ 262 ( { RIU_WRITE_2BYTE(REG_MOD_BASE << 1, ((u32Reg) >> 8) & 0x00FF ); \ 263 RIU_READ_2BYTE( (REG_MOD_BASE + ((u32Reg) & 0xFF) ) << 1) & (u16mask); }) 264 265 #define MOD_W2BYTEMSK( u32Reg, u16Val, u16Mask)\ 266 ( { RIU_WRITE_2BYTE(REG_MOD_BASE << 1, ((u32Reg) >> 8) & 0x00FF ); \ 267 RIU_WRITE_2BYTE( (REG_MOD_BASE + ((u32Reg) & 0xFF) )<<1 , (RIU_READ_2BYTE( (REG_MOD_BASE + ((u32Reg) & 0xFF) ) << 1 ) & ~(u16Mask)) | ((u16Val) & (u16Mask)) ); } ) 268 269 270 //============================================================= 271 //General ( Make sure u32Reg is not ODD 272 #define W2BYTE( u32Reg, u16Val) RIU_WRITE_2BYTE( (u32Reg) << 1 , u16Val ) 273 274 275 #define R2BYTE( u32Reg ) RIU_READ_2BYTE( (u32Reg) << 1) 276 277 #define W4BYTE( u32Reg, u32Val)\ 278 ( { RIU_WRITE_2BYTE( (u32Reg) << 1, ((u32Val) & 0x0000FFFF) ); \ 279 RIU_WRITE_2BYTE( ( (u32Reg) + 2) << 1 , (((u32Val) >> 16) & 0x0000FFFF)) ; } ) 280 281 #define R4BYTE( u32Reg )\ 282 ( { RIU_READ_2BYTE( (u32Reg) << 1) | (MS_U32)(RIU_READ_2BYTE( ( (u32Reg) + 2 ) << 1) ) ; } ) 283 284 #define R2BYTEMSK( u32Reg, u16mask)\ 285 ( { RIU_READ_2BYTE( (u32Reg)<< 1) & (u16mask) ; } ) 286 287 #define W2BYTEMSK( u32Reg, u16Val, u16Mask)\ 288 ( { RIU_WRITE_2BYTE( (u32Reg)<< 1 , (RIU_READ_2BYTE((u32Reg) << 1) & ~(u16Mask)) | ((u16Val) & (u16Mask)) ) ; } ) 289 290 #endif 291 #endif 292 293