xref: /utopia/UTPA2-700.0.x/modules/bdma/drv/bdma/drvBDMA_private.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
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 #ifndef _DRVBDMA_PRIV_H_
95 #define _DRVBDMA_PRIV_H_
96 
97 ////////////////////////////////////////////////////////////////////////////////
98 /// @file drvBDMA.h
99 /// @author MStar Semiconductor Inc.
100 /// @brief Byte DMA control driver
101 ////////////////////////////////////////////////////////////////////////////////
102 
103 ////////////////////////////////////////////////////////////////////////////////
104 // Header Files
105 ////////////////////////////////////////////////////////////////////////////////
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 #include "MsTypes.h"
112 #include "drvBDMA.h"
113 
114 typedef MS_U32 (*IOCTL_BDMA_MEMCPY)(MS_PHY, MS_PHY, MS_U32);
115 typedef MS_U32 (*IOCTL_BDMA_SEARCH)(MS_PHY, MS_U32, MS_U32, MS_U32, BDMA_SrcDev);
116 typedef MS_U32 (*IOCTL_BDMA_CRC32)(MS_PHY, MS_U32, MS_U32, MS_U32, BDMA_SrcDev, MS_BOOL);
117 typedef MS_U32 (*IOCTL_BDMA_PATTERN_FILL)(MS_PHY, MS_U32, MS_U32, BDMA_DstDev);
118 typedef MS_U32 (*IOCTL_BDMA_FLASHCOPY2DRAM)(MS_PHY, MS_PHY, MS_U32);
119 #ifdef MOBF_ENABLE
120 typedef MS_U32 (*IOCTL_BDMA_MOBFSEARCH)(MS_PHY, MS_U32, BDMA_MOBF_PS*, BDMA_SrcDev);
121 #endif
122 typedef void (*IOCTL_BDMA_GETSTATUS)(BDMA_Status*);
123 typedef BDMA_Info* (*IOCTL_BDMA_GETINFO)(void);
124 typedef BDMA_Result (*IOCTL_BDMA_GETLIBVER)(const MSIF_Version **);
125 typedef MS_U32 (*IOCTL_BDMA_GETMINSIZE)(void);
126 typedef BDMA_Result (*IOCTL_BDMA_SETDBGLEVEL)(BDMA_DbgLv);
127 typedef void (*IOCTL_BDMA_SETSPIOFFSETFORMCU)(void);
128 typedef BDMA_Result (*IOCTL_BDMA_WAITFLASHDONE)(void);
129 typedef BDMA_Result (*IOCTL_BDMA_INIT)(MS_PHY);
130 typedef BDMA_Result (*IOCTL_BDMA_COPYHND)(MS_PHY, MS_PHY, MS_U32, BDMA_CpyType, MS_U8);
131 
132 typedef struct _BDMA_RESOURCE_PRIVATE
133 {
134     MS_U32 Dummy;
135 }BDMA_RESOURCE_PRIVATE;
136 
137 typedef struct _BDMA_INSTANT_PRIVATE
138 {
139     IOCTL_BDMA_MEMCPY           fpBDMAMemCpy;
140     IOCTL_BDMA_SEARCH           fpBDMASearch;
141     IOCTL_BDMA_CRC32            fpBDMACRC32;
142     IOCTL_BDMA_PATTERN_FILL     fpBDMAPatternFill;
143     IOCTL_BDMA_FLASHCOPY2DRAM   fpBDMAFlashCopy2Dram;
144 #ifdef MOBF_ENABLE
145     IOCTL_BDMA_MOBFSEARCH       fpBDMAMOBFSearch;
146 #endif
147     IOCTL_BDMA_GETSTATUS        fpBDMAGetStatus;
148     IOCTL_BDMA_GETINFO              fpBDMAGetInfo;
149     IOCTL_BDMA_GETLIBVER            fpBDMAGetLibVer;
150     IOCTL_BDMA_GETMINSIZE           fpBDMAGetMinSize;
151     IOCTL_BDMA_SETDBGLEVEL          fpBDMASetDbgLevel;
152     IOCTL_BDMA_SETSPIOFFSETFORMCU   fpBDMASetSPIOffsetForMCU;
153     IOCTL_BDMA_WAITFLASHDONE        fpBDMAWaitFlashDone;
154     IOCTL_BDMA_INIT                 fpBDMAInit;
155     IOCTL_BDMA_COPYHND              fpBDMACopyHnd;
156 }BDMA_INSTANT_PRIVATE;
157 
158 void BDMARegisterToUtopia(FUtopiaOpen ModuleType);
159 MS_U32 BDMAOpen(void** ppInstance, MS_U32 u32ModuleVersion, void* pAttribute);
160 MS_U32 BDMAClose(void* pInstance);
161 MS_U32 BDMAIoctl(void* pInstance, MS_U32 u32Cmd, void* pArgs);
162 MS_U32 BDMAStr(MS_U32 u32PowerState, void* pModule);
163 
164 BDMA_Result _MDrv_BDMA_MemCopy(MS_PHYADDR u32SrcAddr, MS_PHYADDR u32DstAddr, MS_U32 u32Len);
165 MS_U32 _MDrv_BDMA_Search(MS_PHYADDR u32Addr, MS_U32 u32Len, MS_U32 u32Pattern, MS_U32 u32ExcluBit, BDMA_SrcDev eDev);
166 MS_U32 _MDrv_BDMA_CRC32(MS_PHYADDR u32Addr, MS_U32 u32Len, MS_U32 u32Poly, MS_U32 u32Seed, BDMA_SrcDev eDev, MS_BOOL bReflect);
167 BDMA_Result _MDrv_BDMA_PatternFill(MS_PHYADDR u32Addr, MS_U32 u32Len, MS_U32 u32Pattern, BDMA_DstDev eDev);
168 BDMA_Result _MDrv_BDMA_FlashCopy2Dram(MS_PHYADDR u32FlashAddr, MS_PHYADDR u32DramAddr, MS_U32 u32Len);
169 #ifdef MOBF_ENABLE
170 MS_U32 _MDrv_BDMA_MOBFSearch(MS_PHYADDR u32Addr, MS_U32 u32Len, BDMA_MOBF_PS* pMobfPsCfg, BDMA_SrcDev eDev);
171 #endif
172 void _MDrv_BDMA_GetStatus(BDMA_Status *pStatus);
173 void _MDrv_BDMA_SetSPIOffsetForMCU(void);
174 BDMA_Result _MDrv_BDMA_WaitFlashDone(void);
175 BDMA_Result _MDrv_BDMA_Init(MS_PHY phy64Miu1Base);
176 BDMA_Result _MDrv_BDMA_CopyHnd (MS_PHY phy64SrcAddr, MS_PHY phy64DstAddr, MS_U32 u32Len, BDMA_CpyType eCpyType, MS_U8 u8OpCfg);
177 
178 #ifdef __cplusplus
179 }
180 #endif
181 #endif // _DRVBDMA_PRIV_H_
182