1 /* 2 * Copyright 2015 Rockchip Electronics Co. LTD 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef __MPP_BUFFER_H__ 18 #define __MPP_BUFFER_H__ 19 20 #include "rk_type.h" 21 #include "mpp_err.h" 22 23 /* 24 * MppBuffer module has several functions: 25 * 26 * 1. buffer get / put / reference management / external commit / get info. 27 * this part is the basic user interface for MppBuffer. 28 * 29 * function: 30 * 31 * mpp_buffer_get 32 * mpp_buffer_put 33 * mpp_buffer_inc_ref 34 * mpp_buffer_commit 35 * mpp_buffer_info_get 36 * 37 * 2. user buffer working flow control abstraction. 38 * buffer should attach to certain group, and buffer mode control the buffer usage flow. 39 * this part is also a part of user interface. 40 * 41 * function: 42 * 43 * mpp_buffer_group_get 44 * mpp_buffer_group_normal_get 45 * mpp_buffer_group_limit_get 46 * mpp_buffer_group_put 47 * mpp_buffer_group_limit_config 48 * 49 * 3. buffer allocator management 50 * this part is for allocator on different os, it does not have user interface 51 * it will support normal buffer, Android ion buffer, Linux v4l2 vb2 buffer 52 * user can only use MppBufferType to choose. 53 * 54 */ 55 56 /* 57 * mpp buffer group support two work flow mode: 58 * 59 * normal flow: all buffer are generated by MPP 60 * under this mode, buffer pool is maintained internally 61 * 62 * typical call flow: 63 * 64 * mpp_buffer_group_get() return A 65 * mpp_buffer_get(A) return a ref +1 -> used 66 * mpp_buffer_inc_ref(a) ref +1 67 * mpp_buffer_put(a) ref -1 68 * mpp_buffer_put(a) ref -1 -> unused 69 * mpp_buffer_group_put(A) 70 * 71 * commit flow: all buffer are commited out of MPP 72 * under this mode, buffers is commit by external api. 73 * normally MPP only use it but not generate it. 74 * 75 * typical call flow: 76 * 77 * ==== external allocator ==== 78 * mpp_buffer_group_get() return A 79 * mpp_buffer_commit(A, x) 80 * mpp_buffer_commit(A, y) 81 * 82 * ======= internal user ====== 83 * mpp_buffer_get(A) return a 84 * mpp_buffer_get(A) return b 85 * mpp_buffer_put(a) 86 * mpp_buffer_put(b) 87 * 88 * ==== external allocator ==== 89 * mpp_buffer_group_put(A) 90 * 91 * NOTE: commit interface required group handle to record group information 92 */ 93 94 /* 95 * mpp buffer group has two buffer limit mode: normal and limit 96 * 97 * normal mode: allows any buffer size and always general new buffer is no unused buffer 98 * is available. 99 * This mode normally use with normal flow and is used for table / stream buffer 100 * 101 * limit mode : restrict the buffer's size and count in the buffer group. if try to calloc 102 * buffer with different size or extra count it will fail. 103 * This mode normally use with commit flow and is used for frame buffer 104 */ 105 106 /* 107 * NOTE: normal mode is recommanded to work with normal flow, working with limit mode is not. 108 * limit mode is recommanded to work with commit flow, working with normal mode is not. 109 */ 110 typedef enum { 111 MPP_BUFFER_INTERNAL, 112 MPP_BUFFER_EXTERNAL, 113 MPP_BUFFER_MODE_BUTT, 114 } MppBufferMode; 115 116 /* 117 * the mpp buffer has serval types: 118 * 119 * normal : normal malloc buffer for unit test or hardware simulation 120 * ion : use ion device under Android/Linux, MppBuffer will encapsulte ion file handle 121 * ext_dma : the DMABUF(DMA buffers) come from the application 122 * drm : use the drm device interface for memory management 123 */ 124 typedef enum { 125 MPP_BUFFER_TYPE_NORMAL, 126 MPP_BUFFER_TYPE_ION, 127 MPP_BUFFER_TYPE_EXT_DMA, 128 MPP_BUFFER_TYPE_DRM, 129 MPP_BUFFER_TYPE_DMA_HEAP, 130 MPP_BUFFER_TYPE_BUTT, 131 } MppBufferType; 132 133 #define MPP_BUFFER_TYPE_MASK 0x0000FFFF 134 135 /* 136 * MPP_BUFFER_FLAGS cooperate with MppBufferType 137 * 16 high bits of MppBufferType are used in flags 138 * 139 * eg: 140 * DRM CMA buffer : MPP_BUFFER_TYPE_DRM | MPP_BUFFER_FLAGS_CONTIG 141 * = 0x00010003 142 * DRM SECURE buffer: MPP_BUFFER_TYPE_DRM | MPP_BUFFER_FLAGS_SECURE 143 * = 0x00080003 144 * 145 * flags originate from drm_rockchip_gem_mem_type 146 */ 147 148 #define MPP_BUFFER_FLAGS_MASK 0x000f0000 //ROCKCHIP_BO_MASK << 16 149 #define MPP_BUFFER_FLAGS_CONTIG 0x00010000 //ROCKCHIP_BO_CONTIG << 16 150 #define MPP_BUFFER_FLAGS_CACHABLE 0x00020000 //ROCKCHIP_BO_CACHABLE << 16 151 #define MPP_BUFFER_FLAGS_WC 0x00040000 //ROCKCHIP_BO_WC << 16 152 #define MPP_BUFFER_FLAGS_SECURE 0x00080000 //ROCKCHIP_BO_SECURE << 16 153 154 /* 155 * MppBufferInfo variable's meaning is different in different MppBufferType 156 * 157 * Common 158 * index - the buffer index used to track buffer in buffer pool 159 * size - the buffer size 160 * 161 * MPP_BUFFER_TYPE_NORMAL 162 * 163 * ptr - virtual address of normal malloced buffer 164 * fd - unused and set to -1, the allocator would return its 165 * internal buffer counter number 166 * 167 * MPP_BUFFER_TYPE_ION 168 * 169 * ptr - virtual address of ion buffer in user space 170 * hnd - ion handle in user space 171 * fd - ion buffer file handle for map / unmap 172 * 173 */ 174 typedef struct MppBufferInfo_t { 175 MppBufferType type; 176 size_t size; 177 void *ptr; 178 void *hnd; 179 int fd; 180 int index; 181 } MppBufferInfo; 182 183 #define BUFFER_GROUP_SIZE_DEFAULT (SZ_1M*80) 184 185 /* 186 * mpp_buffer_import_with_tag(MppBufferGroup group, MppBufferInfo *info, MppBuffer *buffer) 187 * 188 * 1. group - specified the MppBuffer to be attached to. 189 * group can be NULL then this buffer will attached to default legecy group 190 * Default to NULL on mpp_buffer_import case 191 * 192 * 2. info - input information for the output MppBuffer 193 * info can NOT be NULL. It must contain at least one of ptr/fd. 194 * 195 * 3. buffer - generated MppBuffer from MppBufferInfo. 196 * buffer can be NULL then the buffer is commit to group with unused status. 197 * Otherwise generated buffer will be directly got and ref_count increased. 198 * Default to NULL on mpp_buffer_commit case 199 * 200 * mpp_buffer_commit usage: 201 * 202 * Add a external buffer info to group. This buffer will be on unused status. 203 * Typical usage is on Android. MediaPlayer gralloc Graphic buffer then commit these buffer 204 * to decoder's buffer group. Then decoder will recycle these buffer and return buffer reference 205 * to MediaPlayer for display. 206 * 207 * mpp_buffer_import usage: 208 * 209 * Transfer a external buffer info to MppBuffer but it is not expected to attached to certain 210 * buffer group. So the group is set to NULL. Then this buffer can be used for MppFrame/MppPacket. 211 * Typical usage is for image processing. Image processing normally will be a oneshot operation 212 * It does not need complicated group management. But in other hand mpp still need to know the 213 * imported buffer is leak or not and trace its usage inside mpp process. So we attach this kind 214 * of buffer to default misc buffer group for management. 215 */ 216 #define mpp_buffer_commit(group, info) \ 217 mpp_buffer_import_with_tag(group, info, NULL, MODULE_TAG, __FUNCTION__) 218 219 #define mpp_buffer_import(buffer, info) \ 220 mpp_buffer_import_with_tag(NULL, info, buffer, MODULE_TAG, __FUNCTION__) 221 222 #define mpp_buffer_get(group, buffer, size) \ 223 mpp_buffer_get_with_tag(group, buffer, size, MODULE_TAG, __FUNCTION__) 224 225 #define mpp_buffer_put(buffer) \ 226 mpp_buffer_put_with_caller(buffer, __FUNCTION__) 227 228 #define mpp_buffer_inc_ref(buffer) \ 229 mpp_buffer_inc_ref_with_caller(buffer, __FUNCTION__) 230 231 #define mpp_buffer_info_get(buffer, info) \ 232 mpp_buffer_info_get_with_caller(buffer, info, __FUNCTION__) 233 234 #define mpp_buffer_read(buffer, offset, data, size) \ 235 mpp_buffer_read_with_caller(buffer, offset, data, size, __FUNCTION__) 236 237 #define mpp_buffer_write(buffer, offset, data, size) \ 238 mpp_buffer_write_with_caller(buffer, offset, data, size, __FUNCTION__) 239 240 #define mpp_buffer_get_ptr(buffer) \ 241 mpp_buffer_get_ptr_with_caller(buffer, __FUNCTION__) 242 243 #define mpp_buffer_get_fd(buffer) \ 244 mpp_buffer_get_fd_with_caller(buffer, __FUNCTION__) 245 246 #define mpp_buffer_get_size(buffer) \ 247 mpp_buffer_get_size_with_caller(buffer, __FUNCTION__) 248 249 #define mpp_buffer_get_index(buffer) \ 250 mpp_buffer_get_index_with_caller(buffer, __FUNCTION__) 251 252 #define mpp_buffer_set_index(buffer, index) \ 253 mpp_buffer_set_index_with_caller(buffer, index, __FUNCTION__) 254 255 #define mpp_buffer_get_offset(buffer) \ 256 mpp_buffer_get_offset_with_caller(buffer, __FUNCTION__) 257 258 #define mpp_buffer_set_offset(buffer, offset) \ 259 mpp_buffer_set_offset_with_caller(buffer, offset, __FUNCTION__) 260 261 #define mpp_buffer_group_get_internal(group, type, ...) \ 262 mpp_buffer_group_get(group, type, MPP_BUFFER_INTERNAL, MODULE_TAG, __FUNCTION__) 263 264 #define mpp_buffer_group_get_external(group, type, ...) \ 265 mpp_buffer_group_get(group, type, MPP_BUFFER_EXTERNAL, MODULE_TAG, __FUNCTION__) 266 267 #ifdef __cplusplus 268 extern "C" { 269 #endif 270 271 /* 272 * MppBuffer interface 273 * these interface will change value of group and buffer so before calling functions 274 * parameter need to be checked. 275 * 276 * IMPORTANT: 277 * mpp_buffer_import_with_tag - compounded interface for commit and import 278 * 279 */ 280 MPP_RET mpp_buffer_import_with_tag(MppBufferGroup group, MppBufferInfo *info, MppBuffer *buffer, 281 const char *tag, const char *caller); 282 MPP_RET mpp_buffer_get_with_tag(MppBufferGroup group, MppBuffer *buffer, size_t size, 283 const char *tag, const char *caller); 284 MPP_RET mpp_buffer_put_with_caller(MppBuffer buffer, const char *caller); 285 MPP_RET mpp_buffer_inc_ref_with_caller(MppBuffer buffer, const char *caller); 286 287 MPP_RET mpp_buffer_info_get_with_caller(MppBuffer buffer, MppBufferInfo *info, const char *caller); 288 MPP_RET mpp_buffer_read_with_caller(MppBuffer buffer, size_t offset, void *data, size_t size, const char *caller); 289 MPP_RET mpp_buffer_write_with_caller(MppBuffer buffer, size_t offset, void *data, size_t size, const char *caller); 290 void *mpp_buffer_get_ptr_with_caller(MppBuffer buffer, const char *caller); 291 int mpp_buffer_get_fd_with_caller(MppBuffer buffer, const char *caller); 292 size_t mpp_buffer_get_size_with_caller(MppBuffer buffer, const char *caller); 293 int mpp_buffer_get_index_with_caller(MppBuffer buffer, const char *caller); 294 MPP_RET mpp_buffer_set_index_with_caller(MppBuffer buffer, int index, const char *caller); 295 size_t mpp_buffer_get_offset_with_caller(MppBuffer buffer, const char *caller); 296 MPP_RET mpp_buffer_set_offset_with_caller(MppBuffer buffer, size_t offset, const char *caller); 297 298 MPP_RET mpp_buffer_group_get(MppBufferGroup *group, MppBufferType type, MppBufferMode mode, 299 const char *tag, const char *caller); 300 MPP_RET mpp_buffer_group_put(MppBufferGroup group); 301 MPP_RET mpp_buffer_group_clear(MppBufferGroup group); 302 RK_S32 mpp_buffer_group_unused(MppBufferGroup group); 303 size_t mpp_buffer_group_usage(MppBufferGroup group); 304 MppBufferMode mpp_buffer_group_mode(MppBufferGroup group); 305 MppBufferType mpp_buffer_group_type(MppBufferGroup group); 306 307 /* 308 * size : 0 - no limit, other - max buffer size 309 * count : 0 - no limit, other - max buffer count 310 */ 311 MPP_RET mpp_buffer_group_limit_config(MppBufferGroup group, size_t size, RK_S32 count); 312 313 RK_U32 mpp_buffer_total_now(); 314 RK_U32 mpp_buffer_total_max(); 315 316 #ifdef __cplusplus 317 } 318 #endif 319 320 #endif /*__MPP_BUFFER_H__*/ 321