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 drvDDC2BI.h 98 /// @brief DDC2Bi interface 99 /// @author MStar Semiconductor Inc. 100 /////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 #ifndef _DRVDDC2BI_H_ 103 #define _DRVDDC2BI_H_ 104 105 #include "MsTypes.h" 106 107 //------------------------------------------------------------------------------------------------- 108 // Macro and Define 109 //------------------------------------------------------------------------------------------------- 110 111 #define MSIF_DDC_LIB_CODE {'D','D','C','_'} 112 #define MSIF_DDC_LIBVER {'0','1'} 113 #define MSIF_DDC_BUILDNUM {'0','2'} 114 #define MSIF_DDC_CHANGELIST {'0','0','3','1','6','8','6','6'} 115 #define DDC2BI_DRV_VERSION /* Character String for DRV/API version */ \ 116 MSIF_TAG, /* 'MSIF' */ \ 117 MSIF_CLASS, /* '00' */ \ 118 MSIF_CUS, /* 0x0000 */ \ 119 MSIF_MOD, /* 0x0000 */ \ 120 MSIF_CHIP, \ 121 MSIF_CPU, \ 122 MSIF_DDC_LIB_CODE, /* IP__ */ \ 123 MSIF_DDC_LIBVER, /* 0.0 ~ Z.Z */ \ 124 MSIF_DDC_BUILDNUM, /* 00 ~ 99 */ \ 125 MSIF_DDC_CHANGELIST, /* CL# */ \ 126 MSIF_OS 127 128 //---------------------------- 129 // Return value 130 //---------------------------- 131 typedef enum 132 { 133 E_DDC2BI_RET_FAIL = 0, 134 E_DDC2BI_RET_OK, 135 } E_DDC2BI_ReturnValue; 136 137 138 // DDC2Bi receive/transmit status bytes definitions 139 #define DDC2B_CLEAR 0 140 #define DDC2B_SRCADDRESS 1 141 #define DDC2B_COMMAND 2 142 #define DDC2B_RECBODY 3 143 #define DDC2B_WAITFORCK 4 144 #define DDC2B_COMPLETED 5 145 #define DDC2B_MSGON 6 146 #define DDC2B_OVER 7 147 148 // receive/transmit buffer syntax defines 149 #define LENGTH 0 150 #define COMMAND 1 151 #define DATA1 2 152 #define DATA2 3 153 #define CHKSUM 4 154 155 // DDC2Bi standard definitions 156 #define DDC2B_DEST_ADDRESS 0x6e 157 #define DDC2B_SRC_ADDRESS 0x51 158 #define DDC2Bi_CONTROL_STATUS_FLAG 0x80 159 160 // checksum start values 161 #define INITRxCK DDC2B_SRC_ADDRESS ^ DDC2B_DEST_ADDRESS 162 #define INITTxCK 0x50^DDC2B_DEST_ADDRESS 163 #define INITNMVTxCK 0x50^DDC2B_SRC_ADDRESS 164 165 //interrupt flag 166 #define TXBI 0x10 167 #define RCBI 0x08 168 //#define SlvBMI 0x20 169 170 171 #define DDC2B_SRC_ADDRESS_CUSTOMER 0x50 172 #define MAX_TXWAIT_DELAY 100 173 #define MaxBufLen 128 174 175 176 // This defination must be fine. 177 178 /* 179 Please measure the execution time of a loop without any statement for DDC_WAITING_LOOPSCOUNT. 180 ex: 181 for ( i = 0 ; i < DDC_WAITING_LOOPSCOUNT ; i++) asm(""); 182 183 The asm("") is used to prevent compiler doing optimization on that loop. 184 185 The total execution time of loops should be larger than 1/12M (70ns for DDC clk). 186 (Move this part into HAL later) 187 */ 188 #define DDC_WAITING_LOOPSCOUNT 3 // 46ns/loop in 172Mhz HK. 189 190 typedef MS_U8(*CALLBACK_AlignControl)(MS_U8 *pDDCBuffData); 191 192 193 //------------------------------------------------------------------------------------------------- 194 // Type and Structure 195 //------------------------------------------------------------------------------------------------- 196 197 198 //------------------------------------------------------------------------------------------------- 199 // Function and Variable 200 //------------------------------------------------------------------------------------------------- 201 /** 202 * DDC2BI Info 203 */ 204 typedef struct 205 { 206 MS_U8 Reserved; 207 }MS_DDC2BI_INFO; 208 209 /** 210 * DDC2BI Status 211 */ 212 typedef struct 213 { 214 MS_BOOL bIsInitialized; 215 MS_BOOL bIsRunning; 216 }MS_DDC2BI_Status; 217 218 E_DDC2BI_ReturnValue MDrv_DDC2BI_GetLibVer(const MSIF_Version **ppVersion); ///< Get version (without Mutex protect) 219 E_DDC2BI_ReturnValue MDrv_DDC2BI_GetInfo(MS_DDC2BI_INFO *pInfo); 220 E_DDC2BI_ReturnValue MDrv_DDC2BI_GetStatus(MS_DDC2BI_Status *pStatus); 221 E_DDC2BI_ReturnValue MDrv_DDC2BI_SetDbgLevel(MS_U16 u16DbgSwitch); 222 223 void MDrv_DDC2BI_Init(void); 224 MS_BOOL MDrv_DDC2BI_Exit(void); 225 void MDrv_DDC2BI_Set_StandardCallBack(CALLBACK_AlignControl align_control); ///< DDC2BI callback function for Standard 226 void MDrv_DDC2BI_Set_CustomerCallBack(CALLBACK_AlignControl align_control); ///< DDC2BI callback function for Customer 227 228 #endif // _DRVDDC2BI_H_ 229