1 /**************************************************************************
5 Copyright 2012 Samsung Electronics co., Ltd. All Rights Reserved.
7 Contact: SooChan Lim <sc1.lim@samsung.com>, Sangjin Lee <lsj119@samsung.com>
8 Boram Park <boram1288.park@samsung.com>, Changyeon Lee <cyeon.lee@samsung.com>
10 Permission is hereby granted, free of charge, to any person obtaining a
11 copy of this software and associated documentation files (the
12 "Software"), to deal in the Software without restriction, including
13 without limitation the rights to use, copy, modify, merge, publish,
14 distribute, sub license, and/or sell copies of the Software, and to
15 permit persons to whom the Software is furnished to do so, subject to
16 the following conditions:
18 The above copyright notice and this permission notice (including the
19 next paragraph) shall be included in all copies or substantial portions
22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
25 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
27 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
28 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30 **************************************************************************/
32 #ifndef _TBM_BUFMGR_INT_H_
33 #define _TBM_BUFMGR_INT_H_
41 #include <sys/ioctl.h>
42 #include <sys/types.h>
52 #include <tbm_bufmgr.h>
54 #include <tbm_surface.h>
55 #include <tbm_surface_internal.h>
56 #include <tbm_surface_queue.h>
58 #include <tbm_bufmgr_backend.h>
59 #include <tbm_backend.h>
60 #include <tbm_error.h>
61 #include <hal/hal-tbm.h>
63 extern tbm_bufmgr gBufMgr;
64 extern int b_dump_queue;
65 extern int trace_mask;
67 #define C(b, m) (((b) >> (m)) & 0xFF)
68 #define B(c, s) ((((unsigned int)(c)) & 0xff) << (s))
69 #define FOURCC(a, b, c, d) (B(d, 24) | B(c, 16) | B(b, 8) | B(a, 0))
70 #define FOURCC_STR(id) C(id, 0), C(id, 8), C(id, 16), C(id, 24)
71 #define FOURCC_ID(str) FOURCC(((char*)str)[0], ((char*)str)[1], ((char*)str)[2], ((char*)str)[3])
74 #define RETURN_CHECK_FLAG(cond) {\
79 #define RETURN_VAL_CHECK_FLAG(cond, val) {\
85 #define TBM_TRACE_BO(fmt, args...) \
87 if (trace_mask&TBM_BUFGMR_DEBUG_TRACE_BO) { \
89 clock_gettime(CLOCK_MONOTONIC, &ts); \
90 tbm_log_print(TBM_LOG_LEVEL_INFO, "[%5d.%06d][%d][%s %d](TRACE)"fmt, \
91 (int)ts.tv_sec, (int)ts.tv_nsec / 1000, \
92 (int)syscall(SYS_gettid), __FUNCTION__, __LINE__, ##args); \
96 #define TBM_TRACE_SURFACE_INTERNAL(fmt, args...) \
98 if (trace_mask&TBM_BUFGMR_DEBUG_TRACE_SURFACE_INTERNAL) { \
100 clock_gettime(CLOCK_MONOTONIC, &ts); \
101 tbm_log_print(TBM_LOG_LEVEL_INFO, "[%5d.%06d][%d][%s %d](TRACE)"fmt, \
102 (int)ts.tv_sec, (int)ts.tv_nsec / 1000, \
103 (int)syscall(SYS_gettid), __FUNCTION__, __LINE__, ##args); \
107 #define TBM_TRACE_SURFACE(fmt, args...) \
109 if (trace_mask&TBM_BUFGMR_DEBUG_TRACE_SURFACE) { \
110 struct timespec ts; \
111 clock_gettime(CLOCK_MONOTONIC, &ts); \
112 tbm_log_print(TBM_LOG_LEVEL_INFO, "[%5d.%06d][%d][%s %d](TRACE)"fmt, \
113 (int)ts.tv_sec, (int)ts.tv_nsec / 1000, \
114 (int)syscall(SYS_gettid), __FUNCTION__, __LINE__, ##args); \
118 #define TBM_TRACE_SURFACE_QUEUE(fmt, args...) \
120 if (trace_mask&TBM_BUFGMR_DEBUG_TRACE_SURFACE_QUEUE) { \
121 struct timespec ts; \
122 clock_gettime(CLOCK_MONOTONIC, &ts); \
123 tbm_log_print(TBM_LOG_LEVEL_INFO, "[%5d.%06d][%d][%s %d](TRACE)"fmt, \
124 (int)ts.tv_sec, (int)ts.tv_nsec / 1000, \
125 (int)syscall(SYS_gettid), __FUNCTION__, __LINE__, ##args); \
129 #define TBM_TRACE(fmt, args...) \
131 if (trace_mask&0x1) { \
132 struct timespec ts; \
133 clock_gettime(CLOCK_MONOTONIC, &ts); \
134 tbm_log_print(TBM_LOG_LEVEL_INFO, "[%5d.%06d][%d][%s %d](TRACE)"fmt, \
135 (int)ts.tv_sec, (int)ts.tv_nsec / 1000, \
136 (int)syscall(SYS_gettid), __FUNCTION__, __LINE__, ##args); \
141 /* check validation */
142 #define TBM_BUFMGR_IS_VALID(mgr) (mgr && mgr == gBufMgr)
143 #define TBM_BO_IS_VALID(bo) (bo && \
144 TBM_BUFMGR_IS_VALID(bo->bufmgr) && \
145 bo->item_link.next && \
146 bo->item_link.next->prev == &bo->item_link)
147 #define TBM_SURFACE_IS_VALID(surf) (surf && \
148 TBM_BUFMGR_IS_VALID(surf->bufmgr) && \
149 surf->item_link.next && \
150 surf->item_link.next->prev == &surf->item_link)
153 #define TBM_SNRPRINTF(p, len, count, fmt, ARG...) \
156 int rest = len - count; \
157 int s = snprintf(&p[count], rest, fmt, ##ARG); \
158 while (s >= rest) { \
160 p = realloc(p, len); \
161 rest = len - count; \
162 s = snprintf(&p[count], rest, fmt, ##ARG); \
169 struct list_head *prev;
170 struct list_head *next;
173 typedef enum _tbm_module_type {
174 TBM_MODULE_TYPE_NONE,
175 TBM_MODULE_TYPE_HAL_TBM,
176 TBM_MODULE_TYPE_TBM_BACKEND,
177 TBM_MODULE_TYPE_BUFMGR_BACKEND,
180 typedef struct _tbm_module {
181 tbm_module_type type;
183 void *module_data; /* backend module */
184 tbm_bufmgr_backend backend; /* bufmgr backend (will be DEPRECATED) */
186 tbm_backend_module *backend_module_data; /* backend module data */
187 tbm_backend_bufmgr_data *bufmgr_data; /* backend data of the backend module */
188 tbm_backend_bufmgr_func *bufmgr_func; /* backend functions for bufmgr */
189 tbm_backend_bo_func *bo_func; /* backend functions for bo */
191 int use_hal_tbm; /* use hal-api-tbm */
192 int auth_wl_socket_created; /* create wayland socket for authenticated drm_fd */
194 hal_tbm_backend *hal_backend; /* hal-api-tbm backend */
195 hal_tbm_bufmgr *hal_bufmgr; /* hal-api-tbm bufmgr */
199 * @brief tbm_bo : buffer object of Tizen Buffer Manager
202 unsigned int magic; /* tbm bo magic number */
203 tbm_bufmgr bufmgr; /* tbm buffer manager */
204 int ref_cnt; /* ref count of bo */
205 int flags; /* TBM_BO_FLAGS :bo memory type */
206 struct list_head user_data_list; /* list of the user_date in bo */
207 void *priv; /* bo private (will be DEPRECATED) */
208 struct list_head item_link; /* link of bo */
209 tbm_surface_h surface; /* tbm_surface */
210 int lock_cnt; /* lock count of bo */
211 unsigned int map_cnt; /* device map count */
213 tbm_backend_bo_data *bo_data; /* bo data of the backend module */
214 int get_from_hal_surface; /* bo_data has be detroyed by hal backend */
218 * @brief tbm_bufmgr : structure for tizen buffer manager
222 int ref_count; /* reference count */
223 int fd; /* bufmgr fd */
224 tbm_bufmgr_bo_lock_type bo_lock_type; /* lock_type of bufmgr */
225 int capabilities; /* capabilities of bufmgr */
226 int display_server; /* used by display server */
227 unsigned int bo_cnt; /* number of bos */
228 struct list_head bo_list; /* list of bos belonging to bufmgr */
229 struct list_head surf_list; /* list of surfaces belonging to bufmgr */
230 struct list_head surf_queue_list; /* list of surface queues belonging to bufmgr */
231 struct list_head debug_key_list; /* list of debug data key list belonging to bufmgr */
233 //TODO: tbm_module *module;
234 tbm_module *module; /* tbm module */
236 //TODO: replace this to data in tbm_module *module
237 void *module_data; /* backend module */
238 tbm_bufmgr_backend backend; /* bufmgr backend (will be DEPRECATED) */
240 tbm_backend_module *backend_module_data; /* backend module data */
241 tbm_backend_bufmgr_data *bufmgr_data; /* backend data of the backend module */
242 tbm_backend_bufmgr_func *bufmgr_func; /* backend functions for bufmgr */
243 tbm_backend_bo_func *bo_func; /* backend functions for bo */
245 int use_hal_tbm; /* use hal-api-tbm */
246 int auth_wl_socket_created; /* create wayland socket for authenticated drm_fd */
248 hal_tbm_backend *hal_backend; /* hal-api-tbm backend */
249 hal_tbm_bufmgr *hal_bufmgr; /* hal-api-tbm bufmgr */
253 * @brief tbm_surface : structure for tizen buffer surface
256 struct _tbm_surface {
257 unsigned int magic; /* tbm surface magic number */
259 tbm_bufmgr bufmgr; /* tbm buffer manager */
261 tbm_surface_info_s info; /* tbm surface information */
265 int num_bos; /* the number of buffer objects */
269 int num_planes; /* the number of buffer objects */
271 int planes_bo_idx[TBM_SURF_PLANE_MAX];
275 unsigned int debug_pid;
277 struct list_head item_link; /* link of surface */
279 struct list_head user_data_list; /* list of the user_data in surface */
281 struct list_head debug_data_list; /* list of debug data */
283 struct list_head destroy_funcs; /* list of destory callback function */
292 hal_tbm_surface *hal_surface; // hal_tbm_surface
298 tbm_data_free free_func;
300 /* link of user_data */
301 struct list_head item_link;
308 /* link of user_data */
309 struct list_head item_link;
310 } tbm_surface_debug_data;
312 typedef struct _tbm_surface_destroy_func_info {
313 tbm_surface_internal_destroy_handler destroy_func;
316 struct list_head item_link;
317 } tbm_surface_destroy_func_info;
319 tbm_bufmgr _tbm_bufmgr_get_bufmgr(void);
320 int _tbm_bo_set_surface(tbm_bo bo, tbm_surface_h surface);
321 int _tbm_surface_is_valid(tbm_surface_h surface);
322 void _tbm_bo_free(tbm_bo bo);
324 int tbm_surface_internal_get_info(tbm_surface_h surface, int opt,
325 tbm_surface_info_s *info, int map);
326 void tbm_surface_internal_unmap(tbm_surface_h surface);
327 unsigned int tbm_surface_internal_get_width(tbm_surface_h surface);
328 unsigned int tbm_surface_internal_get_height(tbm_surface_h surface);
329 tbm_format tbm_surface_internal_get_format(tbm_surface_h surface);
330 unsigned int _tbm_surface_internal_get_debug_pid(tbm_surface_h surface);
331 char *_tbm_surface_internal_format_to_str(tbm_format format);
332 char * _tbm_surface_internal_get_debug_data(tbm_surface_h surface, char *key);
334 tbm_user_data *user_data_lookup(struct list_head *user_data_list,
336 tbm_user_data *user_data_create(unsigned long key,
337 tbm_data_free data_free_func);
338 void user_data_delete(tbm_user_data *user_data);
340 int tbm_bufmgr_get_fd_limit(void);
341 tbm_bufmgr tbm_bufmgr_get(void);
343 void _tbm_set_last_result(tbm_error_e err);
345 /* functions for mutex */
346 void _tbm_bufmgr_mutex_lock(void);
347 void _tbm_bufmgr_mutex_unlock(void);
349 tbm_bo tbm_bo_alloc_with_format(tbm_bufmgr bufmgr, int format, int bo_idx, int width, int bpp, int height, tbm_bo_memory_type flags, tbm_error_e *error);
350 tbm_bo tbm_bo_alloc_with_bo_data(tbm_bufmgr bufmgr, tbm_backend_bo_data *bo_data, int flags);
352 /* tbm_module functions */
353 tbm_module *tbm_module_load(int fd);
354 void tbm_module_unload(tbm_module *module);
356 int tbm_module_bufmgr_get_capabilities(tbm_module *module, tbm_error_e *error);
357 tbm_error_e tbm_module_bufmgr_bind_native_display(tbm_module *module, void *native_display);
358 tbm_error_e tbm_module_bufmgr_get_supported_formats(tbm_module *module, uint32_t **formats, uint32_t *num);
359 tbm_error_e tbm_module_bufmgr_get_plane_data(tbm_module *module, int format, int plane_idx, uint32_t w, uint32_t h, uint32_t *size, uint32_t *offset, uint32_t *pitch, int *bo_idx);
360 tbm_backend_bo_data *tbm_module_bufmgr_bo_alloc(tbm_module *module, tbm_bo bo, int size, int flags, tbm_error_e *error);
361 tbm_backend_bo_data *tbm_module_bufmgr_bo_alloc_with_format(tbm_module *module, int format, int bo_idx, int width, int height, int bpp, tbm_bo_memory_type flags, tbm_error_e *error);
362 tbm_backend_bo_data *tbm_module_bufmgr_bo_import_fd(tbm_module *module, tbm_bo bo, tbm_fd fd, tbm_error_e *error);
363 #endif /* _TBM_BUFMGR_INT_H_ */