xref: /utopia/UTPA2-700.0.x/mxlib/include/drvCMAPool.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) 2006-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   drvSYS_priv.h
98 /// @brief  System Control Interface
99 /// @author MStar Semiconductor,Inc.
100 ///
101 ////////////////////////////////////////////////////////////////////////////////////////////////////
102 #ifndef _DRVCMAPOOL_H_
103 #define _DRVCMAPOOL_H_
104 
105 #if defined (MSOS_TYPE_LINUX) || defined (MSOS_TYPE_OPTEE)
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 #include "MsTypes.h"
112 #include "UFO.h"
113 
114 #define CMA_FLAG_MAP_VMA    (1UL<<0)
115 #define CMA_FLAG_CACHED      (1UL<<1)
116 #define CMA_FLAG_VIRT_ADDR   (1UL<<2)
117 #define CMA_FLAG_MTLB_POOL  (1UL<<3)
118 
119 //Be notice 1UL<<4  CMA_FLAG_MAP_KERNEL only kernel utopia use,user utopia not use!
120 
121 
122 #define CMA_FLAG_KERNEL_MODE_USER_SPACE_MAP_CACHED (1UL<<5) //for cma kernel mode map use va use:whether cache or un-cache
123 
124 /**
125  * These are the only ids that should be used for Ion heap ids.
126  * The ids listed are the order in which allocation will be attempted
127  * if specified. Don't swap the order of heap ids unless you know what
128  * you are doing!
129  * Id's are spaced by purpose to allow new Id's to be inserted in-between (for
130  * possible fallbacks)
131  */
132 enum ion_heap_ids {
133     INVALID_HEAP_ID = -1,
134 
135     //system heap
136     ION_SYSTEM_HEAP_ID = 0,
137 
138     //system contig heap
139     ION_SYSTEM_CONTIG_HEAP_ID = 1,
140 
141     //carveout heap
142     ION_CARVEOUT_HEAP_ID = 2,
143 
144     //CHUNK heap
145     ION_CHUNK_HEAP_ID = 3,
146 
147     //dma heap
148     ION_DMA_HEAP_ID = 4,
149 
150     //CMA heap
151     //mstar id start with 15, and it is created with bootarg in module init dynamically
152     //don't add manually!!!!!!!
153     ION_CMA_HEAP_ID_START = 15,
154 
155     //mstar cma heap: mali type
156     ION_MALI_MIUO_HEAP_ID = 16,
157     ION_MALI_MIU1_HEAP_ID = 17,
158     ION_MALI_MIU2_HEAP_ID = 18,
159 
160     //mstar cma heap: vdec type
161     ION_VDEC_HEAP_ID = 19,
162 
163     //mstar cma heap: xc type
164 #if defined(CHIP_MONET) || defined(CHIP_MANHATTAN)
165         ION_XC_HEAP_ID = 20,
166 #else
167         ION_XC_HEAP_ID = 22,
168 #endif
169 
170     ION_HEAP_ID_RESERVED = 31 /** Bit reserved for ION_SECURE flag */
171 };
172 
173 //////////////////////////////////////
174 // function parameter structure //////
175 //////////////////////////////////////
176 #ifdef UFO_PUBLIC_HEADER_300
177 struct CMA_Pool_Alloc_Param
178 {
179     MS_U32 pool_handle_id; //in: pool handle id, when pool init, returned by kernel
180     MS_U32 offset_in_pool;  //in: offset in pool
181     MS_U32 length;               //in
182     MS_U32 flags;                 //in: if need virtual address, set VIRT_ADDR
183     MS_U32 virt_addr;          //out: if flags: VIRT_ADDR is setted
184 };
185 #else
186 struct CMA_Pool_Alloc_Param
187 {
188     MS_U32 pool_handle_id; //in: pool handle id, when pool init, returned by kernel
189     MS_U64 offset_in_pool;  //in: offset in pool
190     MS_SIZE length;               //in
191     MS_U32 flags;                 //in: if need virtual address, set VIRT_ADDR
192     MS_VIRT virt_addr;          //out: if flags: VIRT_ADDR is setted
193 };
194 #endif
195 
196 #ifdef UFO_PUBLIC_HEADER_300
197 struct CMA_Pool_Free_Param
198 {
199     MS_U32 pool_handle_id; //in: pool handle id, when pool init, returned by kernel
200     MS_U32 offset_in_pool;  //in: offset in pool
201     MS_U32 length;               //in
202 };
203 #else
204 struct CMA_Pool_Free_Param
205 {
206     MS_U32 pool_handle_id; //in: pool handle id, when pool init, returned by kernel
207     MS_U64 offset_in_pool;  //in: offset in pool
208     MS_SIZE length;               //in
209 };
210 #endif
211 
212 #ifdef UFO_PUBLIC_HEADER_300
213 struct CMA_Pool_Init_Param
214 {
215     MS_U32 heap_id;     //in: maybe shared with more than one pools which based on this heap
216 
217     MS_U32 mtlb_addrspace_offset;    //in: pool location in mtlb address space
218     MS_U32 mtlb_addrspace_len;       //in: pool length in mtlb address space
219     //if app need virtual address, set MAP_VMA flag
220     //if need mapping cached, set MAP_CACHE(when MAP_VMA is set), else noncache
221     //if access MTLB address space, set MTLB_POOL
222     MS_U32 flags;
223 
224 
225     MS_U32 pool_handle_id; //out: generate pool id based on heap specified by heap id
226     MS_U32 miu;  //out: heap base on
227     MS_U32 heap_miu_start_offset; //out: heap start offset in miu
228     MS_U32 heap_length; //out: heap leagth
229 };
230 #else
231 struct CMA_Pool_Init_Param
232 {
233     MS_U32 heap_id;     //in: maybe shared with more than one pools which based on this heap
234 
235     MS_U64 mtlb_addrspace_offset;    //in: pool location in mtlb address space
236     MS_U64 mtlb_addrspace_len;       //in: pool length in mtlb address space
237     //if app need virtual address, set MAP_VMA flag
238     //if need mapping cached, set MAP_CACHE(when MAP_VMA is set), else noncache
239     //if access MTLB address space, set MTLB_POOL
240     MS_VIRT flags;
241 
242 
243     MS_U32 pool_handle_id; //out: generate pool id based on heap specified by heap id
244     MS_U32 miu;  //out: heap base on
245     MS_U64 heap_miu_start_offset; //out: heap start offset in miu
246     MS_SIZE heap_length; //out: heap leagth
247 };
248 
249 struct PA_In_CMA_Pool_Param
250 {
251     MS_U64 PA;//in:   PA value
252     MS_S32 miu;//out:  in which miu
253 
254     MS_BOOL in_heap;//out:  whether in heap.If not, relative value can not get.
255     MS_S32 heap_id;     //out: heap id the pa in
256     MS_U64 heap_miu_start_offset; //out: heap start offset in miu
257     MS_U64 heap_length; //out: heap leagth
258     MS_U64 pa_offset_in_heap;    //out: pa location in heap
259     MS_S32 error_code; // error code when failed,not used yet
260 };
261 #endif
262 //////////////////////////////////////
263 // function for utopia2.0 ////////////
264 //////////////////////////////////////
265 MS_BOOL __attribute__((weak)) MApi_CMA_Pool_Init(struct CMA_Pool_Init_Param * Init_Param);
266 MS_BOOL __attribute__((weak)) MApi_CMA_Pool_Release(MS_U32 pool_handle_id);
267 MS_BOOL __attribute__((weak)) MApi_CMA_Pool_GetMem(struct CMA_Pool_Alloc_Param * alloc_param);
268 MS_BOOL __attribute__((weak)) MApi_CMA_Pool_PutMem(struct CMA_Pool_Free_Param * free_param);
269 
270 #ifdef __cplusplus
271 }
272 #endif
273 #endif
274 #endif
275