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 MsOSmm.h 98 /// @brief MsOS Memory management 99 /// @author MStar Semiconductor,Inc. 100 /// 101 //////////////////////////////////////////////////////////////////////////////////////////////////// 102 #ifndef _MSOSMM_H_ 103 #define _MSOSMM_H_ 104 105 106 107 108 #if defined (MSOS_TYPE_OPTEE) 109 #ifdef __cplusplus 110 extern "C" 111 { 112 #endif 113 114 #include "MsTypes.h" 115 116 117 118 #define MSOSMMERROR_CREATE_POOL -100 119 #define MSOSMMERROR_GET_MEM -101 120 #define MSOSMMERROR_GET_MEM_TIMEOUT -102 121 #define MSOSMMERROR_MAPVA -103 122 #define MSOSMMERROR_LOCATE_CHUNK -104 123 #define MSOSMMERROR_DONOT_SUPPORT -105 124 125 //enum for mapping virtual address type 126 enum MSOSMM_MAP_VA_TYPE_Param 127 { 128 MSOSMM_MAP_VA_NO_NEEDED_Param = 0, //we don't need to map VA 129 MSOSMM_VA_CACHE_WRITE_BACK_Param = 1, //we need to map VA with cache type "write back", which is normally used 130 MSOSMM_VA_CACHE_WRITE_THROUGH_Param = 2, //we need to map VA with cache type "write through", which is //mostly used by graphic system 131 MSOSMM_VA_CACHE_NONE_CACHE_Param = 3, //we don't need data cache 132 MSOSMM_VA_TYPE_MAX_Param = 0xFFFFFFFF//force enum size to be 4 byte alignment 133 }; 134 135 136 137 typedef struct _MSOS_MMPool_Chunk 138 { 139 MS_U32 pool_handle_id; //in: pool handle id, when pool init, returned by kernel 140 MS_U64 offset_in_pool; //in: offset in pool 141 MS_U64 length; //in: chunk length 142 }MSOS_MMPool_Chunk; 143 144 struct MSOS_MMPool_Unmap_Param 145 { 146 MS_U8* virt_addr; //in: the VA need to unmap 147 MS_U64 length; //in: unmap length 148 }; 149 150 struct MSOS_MMPool_Map_Param 151 { 152 MSOS_MMPool_Chunk chunk; 153 154 MS_U32 cache_type; //in: cache type of mapping, //0:noncache,1:cache,2:bufferable 155 MS_U8* virt_addr; //out: virtual address for user mode access 156 MS_S32 error_code; //out: reason about why map failed 157 }; 158 159 struct MSOS_MMPool_PutMem_Param 160 { 161 MSOS_MMPool_Chunk chunk; 162 }; 163 164 struct MSOS_MMPool_GetMem_Param 165 { 166 MSOS_MMPool_Chunk chunk; 167 168 MS_S32 error_code; //out: reason about why MApi_MSOS_MMPool_GetMem failed 169 }; 170 171 struct MSOS_MMPool_Init_Param 172 { 173 char *pool_name; //in: global identify name for pool to shared between multiple process 174 175 MS_U64 PoolStartPa; //in: pool location in pa 176 MS_U64 len; //in: 177 178 MS_U32 pool_handle_id; //out: generate pool id based on heap specified by heap_id 179 MS_U32 miu; //out: miu id this heap belongs, index from 0. 180 MS_U32 heap_type; //out: return heap type to application, //0: normal memory, 1:cma 181 MS_S32 error_code; //out: error code when pool init failed 182 MS_U64 heap_length; //out: heap leagth 183 MS_U64 heap_miu_start_offset; //out: heap start offset in miu 184 185 }; 186 187 188 enum MSOS_MMPool_event_Param 189 { 190 MSOS_MMPool_EVENT_CONFLICT_Param = 0, 191 MSOS_MMPool_EVENT_NO_WAIT_Param, 192 MSOS_MMPool_EVNET_NUM_Param 193 }; 194 195 struct MSOS_MMPool_Event_Param 196 { 197 enum MSOS_MMPool_event_Param event; 198 MS_U32 pool_handle_id; 199 }; 200 201 struct MSOS_MMPool_Notify_Param 202 { 203 MS_U32 pool_handle_id;//pool handle 204 void (*notify_callback)(MS_U32 pool_handle_id,MS_U64 start,MS_U64 length); 205 }; 206 207 struct MSOS_MMPool_Locate_Chunk_Param 208 { 209 MS_U32 pool_handle_id; //in: pool handle id, when pool init, returned by kernel 210 MS_U64 offset_in_pool; //in: offset in pool 211 212 213 MS_U64 PA;//out: PA value. 214 MS_S32 error_code; // out�� reason why failed. 215 216 MS_S32 miu;//out: in which miu. 217 MS_U32 heap_id; //out: heap id the pa in .After get this,with the help of MApi_MSOS_MMPool_HEAP_ATTR,can get more more info. 218 }; 219 220 MS_S32 __attribute__((weak)) MSOS_MMPool_Module_Init(void); 221 MS_S32 __attribute__((weak)) MSOS_MMPool_Module_DeInit(void); 222 223 MS_BOOL __attribute__((weak)) MSOS_MMPool_Init(struct MSOS_MMPool_Init_Param * Init_Param); 224 MS_BOOL __attribute__((weak)) MSOS_MMPool_Release(MS_U32 pool_handle_id); 225 226 MS_BOOL __attribute__((weak)) MSOS_MMPool_GetMem(struct MSOS_MMPool_GetMem_Param * get_param); 227 MS_BOOL __attribute__((weak)) MSOS_MMPool_GetMem_Timeout(struct MSOS_MMPool_GetMem_Param* get_param,MS_U32 timeout); 228 MS_BOOL __attribute__((weak)) MSOS_MMPool_PutMem(struct MSOS_MMPool_PutMem_Param * put_param); 229 230 MS_BOOL __attribute__((weak)) MSOS_MMPool_MapVA(struct MSOS_MMPool_Map_Param * map_param);//map va(same heap of msos). if want to have user mode va in kernel mode utopia, need map by it's .so. 231 void __attribute__((weak)) MSOS_MMPool_UnmapVA(struct MSOS_MMPool_Unmap_Param * unmap_param); 232 233 MS_BOOL __attribute__((weak)) MSOS_MMPool_Notify(struct MSOS_MMPool_Notify_Param *notify_param); 234 235 MS_BOOL __attribute__((weak)) MSOS_MMPool_Locate_Chunk(struct MSOS_MMPool_Locate_Chunk_Param * chunk_param); 236 237 #ifdef __cplusplus 238 } 239 #endif 240 #endif 241 #endif 242