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 95 /////////////////////////////////////////////////////////////////////////////////////////////////// 96 /// 97 /// @file drvMMIO.h 98 /// @brief MMIO SYS Driver Interface 99 /// @author MStar Semiconductor Inc. 100 /////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 #ifndef __DRV_MMIO_H__ 103 #define __DRV_MMIO_H__ 104 105 106 #ifdef __cplusplus 107 extern "C" 108 { 109 #endif 110 111 #include "MsTypes.h" 112 113 //------------------------------------------------------------------------------------------------- 114 // Driver Capability 115 //------------------------------------------------------------------------------------------------- 116 #define MSIF_MMIO_LIB_CODE {'M','M','I','O'} //Lib code 117 #define MSIF_MMIO_LIBVER {'0','1'} //LIB version 118 #define MSIF_MMIO_BUILDNUM {'0','2'} //Build Number 119 #define MSIF_MMIO_CHANGELIST {'0','0','4','0','9','9','0','8'} //P4 ChangeList Number 120 121 #define MMIO_DRV_VERSION /* Character String for DRV/API version */ \ 122 MSIF_TAG, /* 'MSIF' */ \ 123 MSIF_CLASS, /* '00' */ \ 124 MSIF_CUS, /* 0x0000 */ \ 125 MSIF_MOD, /* 0x0000 */ \ 126 MSIF_CHIP, \ 127 MSIF_CPU, \ 128 MSIF_MMIO_LIB_CODE, /* IP__ */ \ 129 MSIF_MMIO_LIBVER, /* 0.0 ~ Z.Z */ \ 130 MSIF_MMIO_BUILDNUM, /* 00 ~ 99 */ \ 131 MSIF_MMIO_CHANGELIST, /* CL# */ \ 132 MSIF_OS 133 134 //------------------------------------------------------------------------------------------------- 135 // Macro and Define 136 //------------------------------------------------------------------------------------------------- 137 // HW register space 138 #define DRV_MMIO_PM_BANK 0x0001 139 #define DRV_MMIO_NONPM_BANK 0x0002 140 #define DRV_MMIO_FLASH_BANK0 0x0003 141 #define DRV_MMIO_FRC_BANK 0x0004 142 #define DRV_MMIO_OTP_BANK 0x0010 143 #define DRV_MMIO_SPRAM_BANK 0x0011 144 #define DRV_MMIO_OTP_BANK2 0x0012 145 146 // Specific HW IP base 147 #define DRV_MMIO_SC_BANK 0x0100 148 #define DRV_MMIO_TSP_BANK 0x0101 149 #define DRV_MMIO_NDS_BANK 0x0102 150 #define DRV_MMIO_NSK_BANK 0x0103 151 #define DRV_MMIO_CAM_BANK 0x0104 152 #define DRV_MMIO_NGA_BANK 0x0105 153 154 155 //------------------------------------------------------------------------------------------------- 156 // Type and Structure 157 //------------------------------------------------------------------------------------------------- 158 159 160 //------------------------------------------------------------------------------------------------- 161 // Function and Variable 162 //------------------------------------------------------------------------------------------------- 163 164 /////////////////////////////////////////////////////////////////////////////////////////////////// 165 /// @file drvMMIO.h 166 /// @brief MMIO 167 /// @author MStar Semiconductor Inc. 168 /// @version 1.0 169 ///////////////////////////////////////////////////////////////////////////////////////////////////// 170 171 /*! \defgroup SYS SYS modules 172 * 173 * \defgroup MMIO MMIO interface (drvMMIO.h) 174 * \ingroup SYS 175 176 \brief 177 178 MMIO maps the RIU to userspace so that drivers are capable to access it directly. 179 180 <b> Diagram </b> 181 \image html mmio_1.png 182 183 <b> Code Flow </b> 184 -# Init(setup mapping) 185 -# Each driver get its own base 186 \image html mmio_2.png 187 188 * \defgroup MMIO_BASIC basic mmio interface 189 * \ingroup MMIO 190 */ 191 192 //------------------------------------------------------------------------------------------------- 193 /// Init MMIO driver 194 /// @ingroup MMIO_BASIC 195 //------------------------------------------------------------------------------------------------- 196 MS_BOOL MDrv_MMIO_Init(void); 197 //------------------------------------------------------------------------------------------------- 198 /// Get the virtual address of iomap for register 199 /// @ingroup MMIO_BASIC 200 //------------------------------------------------------------------------------------------------- 201 MS_BOOL MDrv_MMIO_GetBASE(MS_VIRT *ptrBaseaddr, MS_PHY *u32Basesize, MS_U32 u32Module); 202 //------------------------------------------------------------------------------------------------- 203 /// DeInit MMIO driver 204 /// @ingroup MMIO_BASIC 205 //------------------------------------------------------------------------------------------------- 206 MS_BOOL MDrv_MMIO_Close(void); 207 208 209 #ifdef __cplusplus 210 } 211 #endif 212 213 214 #endif // __DRV_MMIO_H__ 215