set the tbm_surface to the tbm_bo
[platform/core/uifw/libtbm.git] / src / tbm_bufmgr_int.h
1 /**************************************************************************
2
3 libtbm
4
5 Copyright 2012 Samsung Electronics co., Ltd. All Rights Reserved.
6
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>
9
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:
17
18 The above copyright notice and this permission notice (including the
19 next paragraph) shall be included in all copies or substantial portions
20 of the Software.
21
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.
29
30 **************************************************************************/
31
32 #ifndef _TBM_BUFMGR_INT_H_
33 #define _TBM_BUFMGR_INT_H_
34
35 #include <unistd.h>
36 #include <limits.h>
37 #include <stdlib.h>
38 #include <stdio.h>
39 #include <sys/ioctl.h>
40 #include <sys/types.h>
41 #include <sys/stat.h>
42 #include <fcntl.h>
43 #include <dlfcn.h>
44 #include <dirent.h>
45 #include <string.h>
46 #include <errno.h>
47 #include <pthread.h>
48 #include <tbm_bufmgr.h>
49 #include <tbm_surface.h>
50 #include <tbm_surface_internal.h>
51 #include <tbm_bufmgr_backend.h>
52 #include <tbm_surface_queue.h>
53
54 /* check condition */
55 #define TBM_RETURN_IF_FAIL(cond) {\
56     if (!(cond)) {\
57         TBM_LOG ("[%s] : '%s' failed.\n", __FUNCTION__, #cond);\
58         return;\
59     }\
60 }
61 #define TBM_RETURN_VAL_IF_FAIL(cond, val) {\
62     if (!(cond)) {\
63         TBM_LOG ("[%s] : '%s' failed.\n", __FUNCTION__, #cond);\
64         return val;\
65     }\
66 }
67
68 /* check flags */
69 #define RETURN_CHECK_FLAG(cond) {\
70     if ((cond)) {\
71         return;\
72     }\
73 }
74 #define RETURN_VAL_CHECK_FLAG(cond, val) {\
75     if ((cond)) {\
76         return val;\
77     }\
78 }
79
80
81 /* check validation */
82 #define TBM_BUFMGR_IS_VALID(mgr) (mgr)
83 #define TBM_BO_IS_VALID(bo) (bo && \
84                          TBM_BUFMGR_IS_VALID(bo->bufmgr) && \
85                          bo->item_link.next && \
86                          bo->item_link.next->prev == &bo->item_link)
87 #define TBM_SURFACE_IS_VALID(surf) (surf && \
88                          TBM_BUFMGR_IS_VALID(surf->bufmgr) && \
89                          surf->item_link.next && \
90                          surf->item_link.next->prev == &surf->item_link)
91
92 #define TBM_ALL_CTRL_BACKEND_VALID(flags) \
93         ((flags&TBM_CACHE_CTRL_BACKEND) &&\
94         (flags&TBM_LOCK_CTRL_BACKEND))
95 #define TBM_CACHE_CTRL_BACKEND_VALID(flags) \
96         (flags&TBM_CACHE_CTRL_BACKEND)
97 #define TBM_LOCK_CTRL_BACKEND_VALID(flags) \
98         (flags&TBM_LOCK_CTRL_BACKEND)
99
100 #define TBM_DEBUG(fmt, ...)   fprintf (stderr, "[TBM:DEBUG(%d)] " fmt, getpid(), ##__VA_ARGS__)
101 #define TBM_LOG(fmt, ...)  fprintf (stderr, "[TBM(%d):%s] " fmt, getpid(), __func__, ##__VA_ARGS__)
102
103 typedef union _tbm_bo_cache_state tbm_bo_cache_state;
104
105 struct list_head
106 {
107     struct list_head *prev;
108     struct list_head *next;
109 };
110
111 union _tbm_bo_cache_state
112 {
113     unsigned int val;
114     struct {
115         unsigned int cntFlush:16;    /*Flush all index for sync*/
116         unsigned int isCacheable:1;
117         unsigned int isCached:1;
118         unsigned int isDirtied:2;
119     } data;
120 };
121
122 /**
123  * @brief tbm_bo : buffer object of Tizen Buffer Manager
124  */
125 struct _tbm_bo
126 {
127     tbm_bufmgr bufmgr; /* tbm buffer manager */
128
129     int ref_cnt;       /* ref count of bo */
130
131     int flags;         /* TBM_BO_FLAGS :bo memory type */
132
133     unsigned int tgl_key; /*global key for tizen global lock */
134
135     /* for cache control */
136     unsigned int map_cnt; /* device map count */
137     tbm_bo_cache_state cache_state; /*cache state */
138
139     int lock_cnt; /* lock count of bo */
140
141     struct list_head user_data_list; /* list of the user_date in bo */
142
143     void *priv; /* bo private */
144
145     struct list_head item_link; /* link of bo */
146
147     tbm_bo_handle default_handle; /*default handle */
148
149         tbm_surface_h surface; /* tbm_surface */
150
151 };
152
153 /**
154  * @brief tbm_bufmgr : structure for tizen buffer manager
155  *
156  */
157 struct _tbm_bufmgr
158 {
159     pthread_mutex_t lock; /* mutex lock */
160
161     int ref_count; /*reference count */
162
163     int fd;  /* bufmgr fd */
164
165     int fd_flag; /* flag set 1 when bufmgr fd open in tbm_bufmgr_init*/
166
167     int lock_fd; /* fd of tizen global lock */
168
169     int lock_type; /* lock_type of bufmgr */
170
171     int use_map_cache; /* flag to use the map_cahce */
172
173     struct list_head bo_list; /* list of bos belonging to bufmgr */
174
175     struct list_head surf_list; /* list of surfaces belonging to bufmgr */
176
177     void *module_data;
178
179     tbm_bufmgr_backend backend; /* bufmgr backend */
180 };
181
182 /**
183  * @brief tbm_surface : structure for tizen buffer surface
184  *
185  */
186 struct _tbm_surface {
187     tbm_bufmgr bufmgr;  /* tbm buffer manager */
188
189     tbm_surface_info_s info;  /* tbm surface information */
190
191     int flags;
192
193     int num_bos;  /* the number of buffer objects */
194
195     tbm_bo bos[4];
196
197     int num_planes;  /* the number of buffer objects */
198
199     int planes_bo_idx[TBM_SURF_PLANE_MAX];
200
201     int refcnt;
202
203     struct list_head item_link; /* link of surface */
204 };
205
206 int tbm_bufmgr_get_drm_fd_x11(void);
207 int tbm_bufmgr_get_drm_fd_wayland(void);
208
209 int _tbm_bo_set_surface (tbm_bo bo, tbm_surface_h surface);
210
211 /* functions for mutex */
212 int          tbm_surface_internal_get_info (tbm_surface_h surface, int opt, tbm_surface_info_s *info, int map);
213 void         tbm_surface_internal_unmap (tbm_surface_h surface);
214 unsigned int tbm_surface_internal_get_width (tbm_surface_h surface);
215 unsigned int tbm_surface_internal_get_height (tbm_surface_h surface);
216 tbm_format   tbm_surface_internal_get_format (tbm_surface_h surface);
217 char         *_tbm_surface_internal_format_to_str(tbm_format format);
218
219
220 #endif  /* _TBM_BUFMGR_INT_H_ */