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 drvURDMA.h 98 /// @brief UART DMA Driver Interface 99 /// @author MStar Semiconductor Inc. 100 /////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 #ifndef __MDRV_URDMA_H__ 103 #define __MDRV_URDMA_H__ 104 105 #ifdef __cplusplus 106 extern "C" 107 { 108 #endif 109 110 #include "MsTypes.h" 111 112 //------------------------------------------------------------------------------------------------- 113 // Driver Capability 114 //------------------------------------------------------------------------------------------------- 115 116 //------------------------------------------------------------------------------------------------- 117 // Macro and Define 118 //------------------------------------------------------------------------------------------------- 119 120 // #define UART_TYPE_DEF 121 /// Version string. 122 #define URDMA_DRV_VERSION /* Character String for DRV/API version */ \ 123 MSIF_TAG, /* 'MSIF' */ \ 124 MSIF_CLASS, /* '00' */ \ 125 MSIF_CUS, /* 0x0000 */ \ 126 MSIF_MOD, /* 0x0000 */ \ 127 MSIF_CHIP, \ 128 MSIF_CPU, \ 129 {'U','D','M','A'}, /* IP__ */ \ 130 {'0','1'}, /* 0.0 ~ Z.Z */ \ 131 {'0','1'}, /* 00 ~ 99 */ \ 132 {'0','0','0','0','0','0','0','0'}, /* CL# */ \ 133 MSIF_OS 134 135 136 typedef MS_U32 DRVURDMA_RESULT; 137 138 /// @name DRVURDMA_RESULT 139 /// @ref DRVURDMA_RESULT 140 /// return value 141 /// @{ 142 #define DRVURDMA_PASS 0x00000000 143 #define DRVURDMA_TX_BUSY 0x00000001 144 #define DRVURDMA_RX_BUSY 0x00000002 145 #define DRVURDMA_INVALID_PARAM 0x00000003 146 #define DRVURDMA_MIU_ADDR_ERROR 0x00000004 147 #define DRVURDMA_FATAL_ERROR 0x00000005 148 /// }@ 149 150 //------------------------------------------------------------------------------------------------- 151 // Type and Structure 152 //------------------------------------------------------------------------------------------------- 153 typedef enum _URDMA_DbgLv 154 { 155 E_URDMA_DBGLV_NONE //no debug message 156 ,E_URDMA_DBGLV_ERR_ONLY //show error only 157 ,E_URDMA_DBGLV_INFO //show error & informaiton 158 ,E_URDMA_DBGLV_ALL //show error, information & funciton name 159 }URDMA_DbgLv; 160 161 typedef enum 162 { 163 E_URDMA_UART = 0, 164 E_URDMA_DMA, 165 } URDMA_Mode; 166 167 typedef enum 168 { 169 E_URDMA_CIRCULAR = 0, 170 E_URDMA_LINE, 171 } URDMA_OPmode; 172 173 //------------------------------------------------------------------------------------------------- 174 // Function and Variable 175 //------------------------------------------------------------------------------------------------- 176 DRVURDMA_RESULT MDrv_UrDMA_GetLibVer(const MSIF_Version **ppVersion); 177 void MDrv_UrDMA_SetDbgLevel(MS_U8 level); 178 DRVURDMA_RESULT MDrv_UrDMA_TxInit(MS_PHYADDR *tx_buf, MS_U16 tx_size); 179 DRVURDMA_RESULT MDrv_UrDMA_RxInit(MS_PHYADDR *rx_buf, MS_U16 rx_size); 180 DRVURDMA_RESULT MDrv_UrDMA_Polling_Tx_Done(void); 181 void MDrv_UrDMA_ISR(void); 182 void MDrv_UrDMA_SelMode(URDMA_Mode eMode); 183 void MDrv_UrDMA_Engine(MS_BOOL bEnable); 184 void MDrv_UrDMA_Init(void *dma_rx_cb, void *dma_tx_cb, URDMA_OPmode eOp_mode); 185 #ifdef MS_DEBUG 186 void MDrv_UrDMA_DumpREG(void); 187 #endif 188 189 #ifdef __cplusplus 190 } 191 #endif 192 193 #endif /* __MDRV_URDMA_H__ */ 194