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 drvCMDQ_priv.h 98 /// @brief CMDQ Driver Interface 99 /// @author MStar Semiconductor,Inc. 100 /// 101 //////////////////////////////////////////////////////////////////////////////////////////////////// 102 103 104 105 #ifndef _DRVCMDQ_PRIV_H_ 106 #define _DRVCMDQ_PRIV_H_ 107 108 #ifdef __cplusplus 109 extern "C" 110 { 111 #endif 112 113 // driver version 114 #define CMDQ_VERSION 0x00000001 115 116 #include "MsTypes.h" 117 enum { 118 MDrv_CMD_CMDQ_GetLibVer, 119 MDrv_CMD_CMDQ_Printf_Crash_Command, 120 MDrv_CMD_CMDQ_Receive, 121 MDrv_CMD_CMDQ_Set_timer_ratio, 122 MDrv_CMD_CMDQ_SetDbgLevel, 123 } eCMDQIoctlOpt; 124 125 //ioctl function pointer type 126 typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_GETLIBVER)(const MSIF_Version **); 127 typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_PRINTFCRASHCOMMAND)(void); 128 typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_RECEIVE)(CH_Struct_Pointer); 129 typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_SETTIMERRATIO)(MS_U32, MS_U32); 130 typedef DRVCMDQ_RESULT (*IOCTL_CMDQ_SETDBGLEVEL)(DrvCMDQ_DbgLevel); 131 132 // INSTANCE Private(ioctl function pointer) 133 typedef struct _CMDQ_INSTANT_PRIVATE 134 { 135 IOCTL_CMDQ_GETLIBVER fpCMDQGetLibVer; 136 IOCTL_CMDQ_PRINTFCRASHCOMMAND fpCMDQPrintf_Crash_Command; 137 IOCTL_CMDQ_RECEIVE fpCMDQReceive; 138 IOCTL_CMDQ_SETTIMERRATIO fpCMDQSet_Timer_Ratio; 139 IOCTL_CMDQ_SETDBGLEVEL fpCMDQSetDbgLevel; 140 }CMDQ_INSTANT_PRIVATE; 141 142 ////////////////////////////////////// 143 // function parameter structure ////// 144 ////////////////////////////////////// 145 // for cmd MDrv_CMDQ_GetLibVer 146 typedef struct _CMDQ_GETLIBVER_PARAM 147 { 148 const MSIF_Version **ppVersion; 149 }CMDQ_GETLIBVER_PARAM, *PCMDQ_GETLIBVER_PARAM; 150 151 // for cmd MDrv_CMDQ_Receive 152 typedef struct _CMDQ_RECEIVE_PARAM 153 { 154 CH_Struct_Pointer New_IP_Head; 155 }CMDQ_RECEIVE_PARAM, *PCMDQ_RECEIVE_PARAM; 156 157 // for cmd MDrv_CMDQ_Set_timer_ratio 158 typedef struct _CMDQ_SETTIMERRATIO_PARAM 159 { 160 MS_U32 time; 161 MS_U32 ratio; 162 }CMDQ_SETTIMERRATIO_PARAM, *PCMDQ_SETTIMERRATIO_PARAM; 163 164 // for cmd MDrv_CMDQ_SetDbgLevel 165 typedef struct _CMDQ_SETDBGLEVEL_PARAM 166 { 167 DrvCMDQ_DbgLevel DbgLevel; 168 }CMDQ_SETDBGLEVEL_PARAM, *PCMDQ_SETDBGLEVEL_PARAM; 169 170 ////////////////////////////////////// 171 // function for utopia2.0 //////////// 172 ////////////////////////////////////// 173 void CMDQRegisterToUtopia(FUtopiaOpen ModuleType); 174 MS_U32 CMDQOpen(void** pInstance, void* pAttribute); 175 MS_U32 CMDQClose(void* pInstance); 176 MS_U32 CMDQIoctl(void* pInstance, MS_U32 u32Cmd, void *pArgs); 177 178 179 // Resource_Private 180 typedef struct _CMDQ_RESOURCE_PRIVATE 181 { 182 MS_U32 Dummy; 183 }CMDQ_RESOURCE_PRIVATE; 184 185 DRVCMDQ_RESULT MDrv_CMDQv2_Init(int hnd, MS_U32 miu); 186 DRVCMDQ_RESULT MDrv_CMDQv2_Start(int hnd, MS_BOOL bStart); 187 DRVCMDQ_RESULT MDrv_CMDQv2_Get_Memory_Size(int hnd, MS_PHY smalladdr, MS_PHY bigaddr, MS_U32 miu); 188 DRVCMDQ_RESULT MDrv_CMDQv2_Set_Buffer(int hnd, MS_PHY startaddr, MS_PHY endaddr); 189 DRVCMDQ_RESULT MDrv_CMDQv2_Reset(int hnd); 190 DRVCMDQ_RESULT MDrv_CMDQv2_Exit(int hnd); 191 DRVCMDQ_RESULT MDrv_CMDQv2_Stop(int hnd); 192 DRVCMDQ_RESULT MDrv_CMDQv2_Receive(int hnd, CH_Struct_Pointer iphead); 193 void MDrv_CMDQv2_Insert_Redundant_Null(int hnd, MS_U32 n); 194 void MDrv_CMDQv2_Transfer(int hnd, CAF_Struct_Pointer cmdarray, MS_SIZE size); 195 void MDrv_CMDQv2_Set_dummy_Address(int hnd, MS_U32 value); 196 void MDrv_CMDQv2_Set_MIU_SELECT(int hnd, MS_U32 miu); 197 DRVCMDQ_RESULT MDrv_CMDQv2_Set_timer_ratio(int hnd, MS_U32 time, MS_U32 ratio); 198 DRVCMDQ_RESULT MDrv_CMDQv2_Printf_Crash_Command(int hnd); 199 void MDrv_CMDQv2_Gen_WaitTrigger_Bus_Command(int hnd, CAF_Struct_Pointer cmd, EN_CMDQTriggerBus_ID id, MS_BOOL falledge); 200 MS_U32 MDrv_CMDQv2_GetWritePoint(int hnd); 201 MS_U32 MDrv_CMDQv2_SetPowerState(int hnd, EN_POWER_MODE u16PowerState); 202 MS_U32 MDrv_CMDQv2_Get_FreeCmdLine_Size(int hnd); 203 204 void MDrv_CMDQv2_Dbg_WriteDummy(int hnd, MS_U32 value); 205 MS_U32 MDrv_CMDQv2_Dbg_ReadDummy(int hnd); 206 void MDrv_CMDQv2_Dbg_Pause(int hnd); 207 void MDrv_CMDQv2_Dbg_Continue(int hnd); 208 209 void MDrv_CMDQv2_DumpContext(void); 210 MS_U32 MDrv_CMDQv2_GetConfig(int hnd,MS_PHY *SmallAddr, MS_PHY *BigAddr, MS_U32 *miu_select); 211 212 #ifdef __cplusplus 213 } 214 #endif 215 216 #endif // _DRVCMDQ_PRIV_H_ 217