xref: /utopia/UTPA2-700.0.x/modules/msos/hal/kano/msos/linux/halMPool.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 
2 //<MStar Software>
3 //******************************************************************************
4 // MStar Software
5 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
6 // All software, firmware and related documentation herein ("MStar Software") are
7 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
8 // law, including, but not limited to, copyright law and international treaties.
9 // Any use, modification, reproduction, retransmission, or republication of all
10 // or part of MStar Software is expressly prohibited, unless prior written
11 // permission has been granted by MStar.
12 //
13 // By accessing, browsing and/or using MStar Software, you acknowledge that you
14 // have read, understood, and agree, to be bound by below terms ("Terms") and to
15 // comply with all applicable laws and regulations:
16 //
17 // 1. MStar shall retain any and all right, ownership and interest to MStar
18 //    Software and any modification/derivatives thereof.
19 //    No right, ownership, or interest to MStar Software and any
20 //    modification/derivatives thereof is transferred to you under Terms.
21 //
22 // 2. You understand that MStar Software might include, incorporate or be
23 //    supplied together with third party`s software and the use of MStar
24 //    Software may require additional licenses from third parties.
25 //    Therefore, you hereby agree it is your sole responsibility to separately
26 //    obtain any and all third party right and license necessary for your use of
27 //    such third party`s software.
28 //
29 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
30 //    MStar`s confidential information and you agree to keep MStar`s
31 //    confidential information in strictest confidence and not disclose to any
32 //    third party.
33 //
34 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
35 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
36 //    without limitation, any warranties of merchantability, non-infringement of
37 //    intellectual property rights, fitness for a particular purpose, error free
38 //    and in conformity with any international standard.  You agree to waive any
39 //    claim against MStar for any loss, damage, cost or expense that you may
40 //    incur related to your use of MStar Software.
41 //    In no event shall MStar be liable for any direct, indirect, incidental or
42 //    consequential damages, including without limitation, lost of profit or
43 //    revenues, lost or damage of data, and unauthorized system use.
44 //    You agree that this Section 4 shall still apply without being affected
45 //    even if MStar Software has been modified by MStar in accordance with your
46 //    request or instruction for your use, except otherwise agreed by both
47 //    parties in writing.
48 //
49 // 5. If requested, MStar may from time to time provide technical supports or
50 //    services in relation with MStar Software to you for your use of
51 //    MStar Software in conjunction with your or your customer`s product
52 //    ("Services").
53 //    You understand and agree that, except otherwise agreed by both parties in
54 //    writing, Services are provided on an "AS IS" basis and the warranty
55 //    disclaimer set forth in Section 4 above shall apply.
56 //
57 // 6. Nothing contained herein shall be construed as by implication, estoppels
58 //    or otherwise:
59 //    (a) conferring any license or right to use MStar name, trademark, service
60 //        mark, symbol or any other identification;
61 //    (b) obligating MStar or any of its affiliates to furnish any person,
62 //        including without limitation, you and your customers, any assistance
63 //        of any kind whatsoever, or any information; or
64 //    (c) conferring any license or right under any intellectual property right.
65 //
66 // 7. These terms shall be governed by and construed in accordance with the laws
67 //    of Taiwan, R.O.C., excluding its conflict of law rules.
68 //    Any and all dispute arising out hereof or related hereto shall be finally
69 //    settled by arbitration referred to the Chinese Arbitration Association,
70 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
71 //    Rules of the Association by three (3) arbitrators appointed in accordance
72 //    with the said Rules.
73 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
74 //    be English.
75 //    The arbitration award shall be final and binding to both parties.
76 //
77 //******************************************************************************
78 //<MStar Software>
79 ////////////////////////////////////////////////////////////////////////////////
80 //
81 // Copyright (c) 2008-2009 MStar Semiconductor, Inc.
82 // All rights reserved.
83 //
84 // Unless otherwise stipulated in writing, any and all information contained
85 // herein regardless in any format shall remain the sole proprietary of
86 // MStar Semiconductor Inc. and be kept in strict confidence
87 // ("MStar Confidential Information") by the recipient.
88 // Any unauthorized act including without limitation unauthorized disclosure,
89 // copying, use, reproduction, sale, distribution, modification, disassembling,
90 // reverse engineering and compiling of the contents of MStar Confidential
91 // Information is unlawful and strictly prohibited. MStar hereby reserves the
92 // rights to any and all damages, losses, costs and expenses resulting therefrom.
93 //
94 ////////////////////////////////////////////////////////////////////////////////
95 
96 #ifndef _HAL_MPOOL_H_
97 #define _HAL_MPOOL_H_
98 
99 #include "MsCommon.h"
100 
101 //-------------------------------------------------------------------------------------------------
102 //  Macro and Define
103 //-------------------------------------------------------------------------------------------------
104 /* Use 'M' as magic number */
105 #define MALLOC_IOC_MAGIC                'M'
106 
107 // MALLOC_IOC_MPOOL_INFO
108 #define MALLOC_IOC_MPOOL_INFO           _IOWR(MALLOC_IOC_MAGIC, 0x00, DevMalloc_MPool_Info_t)
109 #define MALLOC_IOC_FLUSHDCACHE          _IOR(MALLOC_IOC_MAGIC, 0x01, DevMalloc_MPool_Info_t)
110 #define MALLOC_IOC_MPOOL_CACHE          _IOR(MALLOC_IOC_MAGIC, 0x03, unsigned int)
111 #define MALLOC_IOC_MPOOL_SET            _IOR(MALLOC_IOC_MAGIC, 0x04, DevMalloc_MPool_Info_t)
112 #define MALLOC_IOC_MPOOL_KERNELDETECT   _IOWR(MALLOC_IOC_MAGIC, 0x05, DevMalloc_MPool_Kernel_Info_t)
113 #define MALLOC_IOC_FLUSHDCACHE_PAVA     _IOR(MALLOC_IOC_MAGIC, 0x07, DevMalloc_MPool_Flush_Info_t)
114 #define MALLOC_IOC_FLUSHDCACHE_ALL      _IOR(MALLOC_IOC_MAGIC, 0x09, DevMalloc_MPool_Flush_Info_t)
115 #define MALLOC_IOC_SETWATCHPT           _IOW(MALLOC_IOC_MAGIC, 0x0A, DevMalloc_MPool_Watchpt_Info_t)
116 #define MALLOC_IOC_GETWATCHPT           _IOR(MALLOC_IOC_MAGIC, 0x0B, char*)
117 
118 #ifdef ENABLE_KERNEL_DLMALLOC
119 #define MALLOC_IOC_MPOOL_DLMALLOC_CREATE_POOL	_IOWR(MALLOC_IOC_MAGIC, 0x20, DevMalloc_MPool_Dlmalloc_Info_t)
120 #define MALLOC_IOC_MPOOL_DLMALLOC_DELETE_POOL	_IOWR(MALLOC_IOC_MAGIC, 0x21, DevMalloc_MPool_Dlmalloc_Delete_Info_t)
121 #define MALLOC_IOC_MPOOL_DLMALLOC_ALLOC_POOL_MEMORY	_IOWR(MALLOC_IOC_MAGIC, 0x22, DevMalloc_MPool_Dlmalloc_Alloc_Free_Info_t)
122 #define MALLOC_IOC_MPOOL_DLMALLOC_FREE_POOL_MEMORY	_IOWR(MALLOC_IOC_MAGIC, 0x23, DevMalloc_MPool_Dlmalloc_Alloc_Free_Info_t)
123 #define MALLOC_IOC_MPOOL_DLMALLOC_REALLOC_POOL_MEMORY	_IOWR(MALLOC_IOC_MAGIC, 0x24, DevMalloc_MPool_Dlmalloc_Alloc_Free_Info_t)
124 #endif
125 
126 #define _FUNC_NOT_USED()        do {} while ( 0 )
127 
128 #define MIU_INTERVAL 0x80000000UL
129 #define ENABLE_PARTIAL_MAPPING 1
130 #define DISABLE_PARTIAL_MAPPING 0
131 
132 //-------------------------------------------------------------------------------------------------
133 //  Local Variables
134 //-------------------------------------------------------------------------------------------------
135 //MS_U32 u32MpoolRegBase;
136 
137 //-------------------------------------------------------------------------------------------------
138 //  Type and Structure
139 //-------------------------------------------------------------------------------------------------
140 
141 #if defined(MSOS_TYPE_LINUX)
142 #ifdef ENABLE_KERNEL_DLMALLOC
143 typedef struct
144 {
145 	MS_U64 pool_bus_addr;	// pool start ba addr						, output
146 	MS_U64 bus_addr;		// buffer start ba addr						, input
147 	mspace MemoryPool;		// pool start va(user space)				, output
148 	void *user_va;			// buffer start va addr (user space)		, input
149 	size_t capacity;		// buffer size								, input
150 	int locked;
151 } DevMalloc_MPool_Dlmalloc_Info_t;
152 
153 typedef struct
154 {
155 	MS_U64 pool_bus_addr;	// pool start ba addr						, input
156 } DevMalloc_MPool_Dlmalloc_Delete_Info_t;
157 
158 typedef struct
159 {
160 	MS_U64 pool_bus_addr;	// pool start ba addr						, input
161 	MS_U64 alloc_addr;		// alloc return ba addr / re-alloc ori ba addr / free ba addr
162 	MS_U64 new_alloc_addr;	// re-alloc return ba addr
163 	size_t alloc_size;		// alloc or re-alloc size					, input
164 } DevMalloc_MPool_Dlmalloc_Alloc_Free_Info_t;
165 #endif
166 #endif
167 
168 typedef struct
169 {
170     MS_U64             u64Addr;
171     MS_U64             u64Size;
172     MS_U64             u64Interval;
173     MS_U8              u8MiuSel;
174 } DevMalloc_MPool_Info_t;
175 
176 typedef struct
177 {
178     MS_U64                u64lxAddr;
179     MS_U64                u64lxSize;
180     MS_U64                u64lx2Addr;
181     MS_U64                u64lx2Size;
182 }DevMalloc_MPool_Kernel_Info_t;
183 
184 
185 typedef struct
186 {
187     MS_VIRT                virtAddrVirt;
188     MS_U64                 u64AddrPhys;
189     MS_U64                 u64Size;
190 } DevMalloc_MPool_Flush_Info_t;
191 
192 
193 
194 
195 typedef struct{
196      unsigned int                ASID;
197      unsigned int                global;
198      MS_U64                      u64AddrVirt;
199      unsigned int                rwx;
200      unsigned int                mask;
201 } DevMalloc_MPool_Watchpt_Info_t;
202 
203 //-------------------------------------------------------------------------------------------------
204 //  Function and Variable
205 //-------------------------------------------------------------------------------------------------
206 MS_PHY HAL_MsOS_MPool_VA2PA(MS_VIRT addrVirt, MS_SIZE tVirt2PhysOff);
207 MS_VIRT  HAL_MsOS_MPool_PA2VA(MS_PHY u64Phys, MS_PHY u64MappedPhys, MS_U64 u64MappedSize, MS_SIZE tVirt2PhysOff, MS_BOOL bPartialMapping);
208 MS_BOOL HAL_MsOS_MPool_Dcache_Flush(int fd, MS_VIRT addrVirt, MS_SIZE tSize, MS_PHY u64Phys);
209 MS_BOOL HAL_MsOS_MPool_Dcache_Flush_All(int fd);
210 MS_PHY HAL_MsOS_MPool_PA2BA(MS_PHY u64PhyAddr);
211 MS_PHY HAL_MsOS_MPool_BA2PA(MS_PHY u64Addr);
212 #endif // _HAL_MPOOL_H_
213