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-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 drvSEM_priv.h 98 /// @brief SEM Driver Interface 99 /// @author MStar Semiconductor,Inc. 100 /// 101 //////////////////////////////////////////////////////////////////////////////////////////////////// 102 103 104 105 #ifndef _DRVSEM_PRIV_H_ 106 #define _DRVSEM_PRIV_H_ 107 108 #ifdef __cplusplus 109 extern "C" 110 { 111 #endif 112 113 #include "MsTypes.h" 114 #include "drvSEM.h" 115 // driver version 116 #define SEM_VERSION 0x00000001 117 118 typedef enum { 119 MDrv_CMD_SEM_Get_Resource, 120 MDrv_CMD_SEM_Free_Resource, 121 MDrv_CMD_SEM_Reset_Resource, 122 MDrv_CMD_SEM_Get_ResourceID, 123 MDrv_CMD_SEM_Get_Num, 124 MDrv_CMD_SEM_GetLibVer, 125 MDrv_CMD_SEM_Lock, 126 MDrv_CMD_SEM_Unlock, 127 MDrv_CMD_SEM_Delete, 128 } eSEMIoctlOpt; 129 130 ////////////////////////////////////// 131 // function parameter structure ////// 132 ////////////////////////////////////// 133 // for cmd MDrv_SEM_Get_Resource 134 typedef struct _SEM_GETRESOURCE_PARAM 135 { 136 MS_U8 u8SemID; 137 MS_U16 u16ResId; 138 }SEM_GETRESOURCE_PARAM, *PSEM_GETRESOURCE_PARAM; 139 140 // for cmd MDrv_SEM_Free_Resource 141 typedef struct _SEM_FREERESOURCE_PARAM 142 { 143 MS_U8 u8SemID; 144 MS_U16 u16ResId; 145 }SEM_FREERESOURCE_PARAM, *PSEM_FREERESOURCE_PARAM; 146 147 // for cmd MDrv_SEM_Reset_Resource 148 typedef struct _SEM_RESETRESOURCE_PARAM 149 { 150 MS_U8 u8SemID; 151 }SEM_RESETRESOURCE_PARAM, *PSEM_RESETRESOURCE_PARAM; 152 153 // for cmd MDrv_SEM_Get_ResourceID 154 typedef struct _SEM_GETRESOURCEID_PARAM 155 { 156 MS_U8 u8SemID; 157 MS_U16* pu16ResId; 158 }SEM_GETRESOURCEID_PARAM, *PSEM_GETRESOURCEID_PARAM; 159 160 // for cmd MDrv_SEM_GetLibVer 161 typedef struct _SEM_GETLIBVER_PARAM 162 { 163 const MSIF_Version **ppVersion; 164 }SEM_GETLIBVER_PARAM, *PSEM_GETLIBVER_PARAM; 165 166 // for cmd MDrv_SEM_Lock 167 typedef struct _SEM_LOCK_PARAM 168 { 169 MS_U32 u32SemID; 170 MS_U32 u32WaitMs; 171 }SEM_LOCK_PARAM, *PSEM_LOCK_PARAM; 172 173 // for cmd MDrv_SEM_Unlock 174 typedef struct _SEM_UNLOCK_PARAM 175 { 176 MS_U32 u32SemID; 177 }SEM_UNLOCK_PARAM, *PSEM_UNLOCK_PARAM; 178 179 // for cmd MDrv_SEM_Delete 180 typedef struct _SEM_DELETE_PARAM 181 { 182 MS_U32 u32SemID; 183 }SEM_DELETE_PARAM, *PSEM_DELETE_PARAM; 184 185 //ioctl function pointer type 186 typedef MS_BOOL (*IOCTL_SEM_GETRESOURCE)(MS_U8, MS_U16); 187 typedef MS_BOOL (*IOCTL_SEM_FREERESOURCE)(MS_U8, MS_U16); 188 typedef MS_BOOL (*IOCTL_SEM_RESETRESOURCE)(MS_U8); 189 typedef MS_BOOL (*IOCTL_SEM_GETRESOURCEID)(MS_U8, MS_U16*); 190 typedef MS_U32 (*IOCTL_SEM_GETNUM)(void); 191 typedef MS_BOOL (*IOCTL_SEM_GETLIBVER)(const MSIF_Version **); 192 typedef MS_BOOL (*IOCTL_SEM_LOCK)(MS_U32, MS_U32); 193 typedef MS_BOOL (*IOCTL_SEM_UNLOCK)(MS_U32); 194 typedef MS_BOOL (*IOCTL_SEM_DELETE)(MS_U32); 195 196 // INSTANCE Private(ioctl function pointer) 197 typedef struct _SEM_INSTANT_PRIVATE 198 { 199 IOCTL_SEM_GETRESOURCE fpSEMGetResource; 200 IOCTL_SEM_FREERESOURCE fpSEMFreeResource; 201 IOCTL_SEM_RESETRESOURCE fpSEMResetResource; 202 IOCTL_SEM_GETRESOURCEID fpSEMGetResourceID; 203 IOCTL_SEM_GETNUM fpSEMGetNum; 204 IOCTL_SEM_GETLIBVER fpSEMGetLibVer; 205 IOCTL_SEM_LOCK fpSEMLock; 206 IOCTL_SEM_UNLOCK fpSEMUnlock; 207 IOCTL_SEM_DELETE fpSEMDelete; 208 }SEM_INSTANT_PRIVATE; 209 210 ////////////////////////////////////// 211 // function for utopia2.0 //////////// 212 ////////////////////////////////////// 213 void SEMRegisterToUtopia(void); 214 MS_U32 SEMOpen(void** pInstance, MS_U32 u32ModuleVersion, void* pAttribute); 215 MS_U32 SEMClose(void* pInstance); 216 MS_U32 SEMIoctl(void* pInstance, MS_U32 u32Cmd, void *pArgs); 217 218 MS_BOOL MDrv_SEM_Delete_U2K(eSemId SemId); 219 MS_BOOL MDrv_SEM_Unlock_U2K(eSemId SemId); 220 MS_BOOL MDrv_SEM_Lock_U2K(eSemId SemId, MS_U32 u32WaitMs); 221 MS_BOOL MDrv_SEM_Get_ResourceID_U2K(MS_U8 u8SemID, MS_U16* pu16ResId); 222 MS_BOOL MDrv_SEM_Reset_Resource_U2K(MS_U8 u8SemID); 223 MS_BOOL MDrv_SEM_Free_Resource_U2K(MS_U8 u8SemID, MS_U16 u16ResId); 224 MS_BOOL MDrv_SEM_Get_Resource_U2K(MS_U8 u8SemID, MS_U16 u16ResId); 225 226 227 // Resource_Private 228 typedef struct _SEM_RESOURCE_PRIVATE 229 { 230 MS_U32 Dummy; 231 }SEM_RESOURCE_PRIVATE; 232 233 #ifdef __cplusplus 234 } 235 #endif 236 237 #endif // _DRVSEM_PRIV_H_ 238