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) 2009-2010 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 drvSAR.h 98 /// @brief SAR Driver Interface 99 /// @author MStar Semiconductor Inc. 100 /////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 /*! \defgroup G_SAR SAR interface 103 * \ingroup G_PERIPHERAL 104 *! \defgroup G_SAR_INIT Initialization Task relative 105 * \ingroup G_SAR 106 *! \defgroup G_SAR_COMMON Common Task relative 107 * \ingroup G_SAR 108 *! \defgroup G_SAR_CONTROL Control relative 109 * \ingroup G_SAR 110 *! \defgroup G_SAR_OTHER other relative 111 * \ingroup G_SAR 112 *! \defgroup G_SAR_ToBeModified SAR api to be modified 113 * \ingroup G_SAR 114 *! \defgroup G_SAR_ToBeRemove SAR api to be removed 115 * \ingroup G_SAR 116 */ 117 118 #ifndef _DRV_CUS_SAR_H_ 119 #define _DRV_CUS_SAR_H_ 120 121 122 #ifdef __cplusplus 123 extern "C" 124 { 125 #endif 126 127 #include "MsTypes.h" 128 #include "MsDevice.h" 129 //------------------------------------------------------------------------------------------------- 130 // Driver Capability 131 //------------------------------------------------------------------------------------------------- 132 133 134 //------------------------------------------------------------------------------------------------- 135 // Macro and Define 136 //------------------------------------------------------------------------------------------------- 137 /// define SAR library version 138 #define MSIF_CUS_SAR_LIB_CODE {'C','S','A','R'} 139 #define MSIF_CUS_SAR_LIBVER {'0','3'} 140 #define MSIF_CUS_SAR_BUILDNUM {'0','9'} 141 #define MSIF_CUS_SAR_CHANGELIST {'0','0','4','3','3','2','5','1'} 142 143 #define CUS_SAR_DRV_VERSION /* Character String for DRV/API version */ \ 144 MSIF_TAG, /* 'MSIF' */ \ 145 MSIF_CLASS, /* '00' */ \ 146 MSIF_CUS, /* 0x0000 */ \ 147 MSIF_MOD, /* 0x0000 */ \ 148 MSIF_CHIP, \ 149 MSIF_CPU, \ 150 MSIF_CUS_SAR_LIB_CODE, /* IP__ */ \ 151 MSIF_CUS_SAR_LIBVER, /* 0.0 ~ Z.Z */ \ 152 MSIF_CUS_SAR_BUILDNUM, /* 00 ~ 99 */ \ 153 MSIF_CUS_SAR_CHANGELIST, /* CL# */ \ 154 MSIF_OS 155 156 /// SAR driver 157 #define CUS_SAR_VERSION_STRING_MAX 33 158 #define CUS_SAR_DUMMY_KEY 0xFF 159 #define CUS_SAR_DUMMY_STATUS 0x00 160 #define CUS_SAR_VERSION 0x00000001 161 162 //------------------------------------------------------------------------------------------------- 163 // Type and Structure 164 //------------------------------------------------------------------------------------------------- 165 166 //------------------------------------------------------------------------------------------------- 167 // Function and Variable 168 //------------------------------------------------------------------------------------------------- 169 //################################## 170 // 171 // Access SAR settings by using Mailbox 172 // sent commands to PM 173 // 174 //################################## 175 176 177 //------------------------------------------------------------------------------------------------- 178 /// Get SAR Keypad key code function. 179 /// @ingroup G_SAR_COMMON 180 /// @param pu8Key: key code pointer 181 /// @param pu8Repeat: key repeat pointer 182 /// @return E_SAR_KPD_OK: Success 183 /// @return E_SAR_KPD_FAIL or other values: Failure 184 //------------------------------------------------------------------------------------------------- 185 SAR_KpdResult MDrv_SAR_Kpd_GetKeyCode_Custom(MS_U8 *pu8Key, MS_U8 *pu8Repeat); 186 187 //------------------------------------------------------------------------------------------------- 188 /// Get SAR Multi-Keypad key code function with every SAR channel 189 /// @ingroup G_SAR_COMMON 190 /// @param SAR_KeyValue: key code struct pointer 191 /// @param u32Size: Struct Size 192 /// @return E_SAR_KPD_OK: Success 193 /// @return E_SAR_KPD_FAIL or other values: Failure 194 //------------------------------------------------------------------------------------------------- 195 SAR_KpdResult MDrv_SAR_Kpd_GetMultiKeyCode_Custom(SAR_KeyValue *sSarKey, MS_U32 u32Size, MS_U8 u8ReplyKey); 196 197 198 #ifdef __cplusplus 199 } 200 #endif 201 202 203 #endif // _DRV_SAR_H_ 204 205