1 /**************************************************************************
5 Copyright 2012-2018 Samsung Electronics co., Ltd. All Rights Reserved.
7 Contact: SooChan Lim <sc1.lim@samsung.com>, Sangjin Lee <lsj119@samsung.com>
8 Inpyo Kang <mantiger@samsung.com>, Dongyeon Kim <dy5.kim@samsung.com>
9 Boram Park <boram1288.park@samsung.com>, Changyeon Lee <cyeon.lee@samsung.com>
11 Permission is hereby granted, free of charge, to any person obtaining a
12 copy of this software and associated documentation files (the
13 "Software"), to deal in the Software without restriction, including
14 without limitation the rights to use, copy, modify, merge, publish,
15 distribute, sub license, and/or sell copies of the Software, and to
16 permit persons to whom the Software is furnished to do so, subject to
17 the following conditions:
19 The above copyright notice and this permission notice (including the
20 next paragraph) shall be included in all copies or substantial portions
23 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
26 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
27 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
28 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
29 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 **************************************************************************/
33 #ifndef _TBM_TYPE_COMMON_H_
34 #define _TBM_TYPE_COMMON_H_
39 * \file tbm_type_common.h
40 * \brief Type definition used internally
43 /* tbm error base : this error base is same as TIZEN_ERROR_TBM in tizen_error.h */
44 #ifndef TBM_ERROR_BASE
45 #define TBM_ERROR_BASE -0x02830000
49 * @brief Definition for the tizen buffer manager
52 typedef struct _tbm_bufmgr *tbm_bufmgr;
55 * @brief Definition for the tizen buffer object
58 typedef struct _tbm_bo *tbm_bo;
61 * @brief Definition for the key associated with the buffer object
65 typedef uint32_t tbm_key;
67 * @brief Definition for the file descripter of the system buffer manager
70 typedef int32_t tbm_fd;
73 * @brief Definition for native display (wl_display in tizen)
76 typedef void tbm_native_display;
81 * @brief Enumeration for tbm error type.
85 /* TBM_ERROR_XXX. start from (TBM_ERROR_BASE | 0x0001) to (TBM_ERROR_BASE | 0x0099) */
86 TBM_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
87 TBM_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
88 TBM_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid function parameter */
89 TBM_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Function not implemented */
90 TBM_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */
92 /* TBM_BO_ERROR_XXX. start from (TBM_ERROR_BASE | 0x0101) to (TBM_ERROR_BASE | 0x0199) */
93 TBM_BO_ERROR_GET_FD_FAILED = TBM_ERROR_BASE | 0x0101, /**< failed to get fd in bo (DEPRECATED) */
94 TBM_BO_ERROR_HEAP_ALLOC_FAILED = TBM_ERROR_OUT_OF_MEMORY, /**< failed to allocate the heap memory in bo (DEPRECATED) */
95 TBM_BO_ERROR_LOAD_MODULE_FAILED = TBM_ERROR_BASE | 0x0103, /**< failed to load module (DEPRECATED) */
96 TBM_BO_ERROR_THREAD_INIT_FAILED = TBM_ERROR_BASE | 0x0104, /**< failed to initialize the pthread (DEPRECATED) */
97 TBM_BO_ERROR_BO_ALLOC_FAILED = TBM_ERROR_OUT_OF_MEMORY, /**< failed to allocate tbm_bo (DEPRECATED) */
98 TBM_BO_ERROR_INIT_STATE_FAILED = TBM_ERROR_BASE | 0x0106, /**< failed to initialize the state of tbm_bo (DEPRECATED) */
99 TBM_BO_ERROR_IMPORT_FAILED = TBM_ERROR_BASE | 0x0107, /**< failed to import the handle of tbm_bo (DEPRECATED) */
100 TBM_BO_ERROR_IMPORT_FD_FAILED = TBM_ERROR_BASE | 0x0108, /**< failed to import fd of tbm_bo (DEPRECATED) */
101 TBM_BO_ERROR_EXPORT_FAILED = TBM_ERROR_BASE | 0x0109, /**< failed to export the handle of the tbm_bo (DEPRECATED) */
102 TBM_BO_ERROR_EXPORT_FD_FAILED = TBM_ERROR_BASE | 0x0110, /**< failed to export fd of tbm_bo (DEPRECATED) */
103 TBM_BO_ERROR_GET_HANDLE_FAILED = TBM_ERROR_BASE | 0x0111, /**< failed to get the tbm_bo_handle (DEPRECATED) */
104 TBM_BO_ERROR_LOCK_FAILED = TBM_ERROR_BASE | 0x0112, /**< failed to lock the tbm_bo (DEPRECATED) */
105 TBM_BO_ERROR_MAP_FAILED = TBM_ERROR_BASE | 0x0113, /**< failed to map the tbm_bo to get the tbm_bo_handle (DEPRECATED) */
106 TBM_BO_ERROR_UNMAP_FAILED = TBM_ERROR_BASE | 0x0114, /**< failed to unmap the tbm_bo (DEPRECATED) */
107 TBM_BO_ERROR_SWAP_FAILED = TBM_ERROR_BASE | 0x0115, /**< failed to swap the tbm_bos (DEPRECATED) */
108 TBM_BO_ERROR_DUP_FD_FAILED = TBM_ERROR_BASE | 0x0116, /**< failed to duplicate fd (DEPRECATED) */
110 /* TBM_SURFACE_ERROR_XXX. start from (TBM_ERROR_BASE | 0x0201) to (TBM_ERROR_BASE | 0x0299)
111 * TBM_SURFACE_ERROR_XXX is defined in tbm_surface.h file because it is CAPI.
113 * TBM_SURFACE_ERROR_NONE = TIZEN_ERROR_NONE, // Successful
114 * TBM_SURFACE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, // Invalid parameter
115 * TBM_SURFACE_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, // Invalid Operation
119 /* TBM_SURFACE_QUEUE_ERROR_XXX. start from (TBM_ERROR_BASE | 0x0301) to (TBM_ERROR_BASE | 0x0399) */
120 TBM_SURFACE_QUEUE_ERROR_NONE = TBM_ERROR_NONE, /**< Successful */
121 TBM_SURFACE_QUEUE_ERROR_EMPTY = TBM_ERROR_BASE | 0x0301, /**< Empty queue */
122 TBM_SURFACE_QUEUE_ERROR_INVALID_QUEUE = TBM_ERROR_BASE | 0x0302, /**< Invalid queue */
123 TBM_SURFACE_QUEUE_ERROR_INVALID_SURFACE = TBM_ERROR_BASE | 0x0303, /**< Invalid surface */
124 TBM_SURFACE_QUEUE_ERROR_SURFACE_ALLOC_FAILED = TBM_ERROR_BASE | 0x0304, /**< Allocation of surface failed */
125 TBM_SURFACE_QUEUE_ERROR_ALREADY_EXIST = TBM_ERROR_BASE | 0x0305, /**< Already existed surface */
126 TBM_SURFACE_QUEUE_ERROR_UNKNOWN_SURFACE = TBM_ERROR_BASE | 0x0306, /**< Unknown surface */
127 TBM_SURFACE_QUEUE_ERROR_INVALID_SEQUENCE = TBM_ERROR_BASE | 0x0307, /**< Invalid sequence */
128 TBM_SURFACE_QUEUE_ERROR_TIMEOUT = TBM_ERROR_BASE | 0x0308, /**< Timeout */
131 typedef tbm_error_e tbm_surface_queue_error_e;
134 * @brief Enumeration of tbm buffer manager capability.
137 enum TBM_BUFMGR_CAPABILITY {
138 TBM_BUFMGR_CAPABILITY_NONE = 0, /**< Not Support capability*/
139 TBM_BUFMGR_CAPABILITY_SHARE_KEY = (1 << 0), /**< Support sharing buffer by tbm key */
140 TBM_BUFMGR_CAPABILITY_SHARE_FD = (1 << 1), /**< Support sharing buffer by tbm fd */
141 TBM_BUFMGR_CAPABILITY_TBM_SYNC = (1 << 2), /**< Support timeline sync */
142 TBM_BUFMGR_CAPABILITY_TILED_MEMORY = (1 << 3), /**< Support tiled memory */
143 TBM_BUFMGR_CAPABILITY_SHARE_SURFACE = (1 << 4), /**< Support sharing surface by buffer data */
147 * @brief Definition for the device type to access tbm_bo
151 TBM_DEVICE_DEFAULT = 0, /**< the device type to get the default handle */
152 TBM_DEVICE_CPU, /**< the device type to get the virtual memory */
153 TBM_DEVICE_2D, /**< the device type to get the 2D memory handle */
154 TBM_DEVICE_3D, /**< the device type to get the 3D memory handle */
155 TBM_DEVICE_MM, /**< the device type to get the the multimedia handle */
157 } tbm_bo_device_type;
160 * @brief Definition for the optoin to access tbm_bo
164 TBM_OPTION_NONE = (1 << 0), /**< the option is none */
165 TBM_OPTION_READ = (1 << 0), /**< the option to access to read the bo */
166 TBM_OPTION_WRITE = (1 << 1), /**< the option to access to write the bo */
167 TBM_OPTION_VENDOR = (0xffff0000), /**< the the vendor specific option that depends on the backend */
168 } tbm_bo_access_option;
171 * @brief tbm_bo_handle abstraction of the memory handle by TBM_DEVICE_TYPE
174 typedef union _tbm_bo_handle {
183 * @brief Enumeration of bo memory type
187 TBM_BO_DEFAULT = 0, /**< default memory: it depends on the backend */
188 TBM_BO_SCANOUT = (1 << 0), /**< scanout memory */
189 TBM_BO_NONCACHABLE = (1 << 1), /**< non-cachable memory */
190 TBM_BO_WC = (1 << 2), /**< write-combine memory */
191 TBM_BO_TILED = (1 << 3), /**< tiled memory */
192 TBM_BO_VENDOR = (0xffff0000), /**< vendor specific memory: it depends on the backend */
196 * @brief Definition for the TBM surface buffer data struct.
199 typedef struct _tbm_surface_buffer_data {
200 int *fds; /**< an array of dmabuf fds */
201 unsigned int num_fds; /**< the number of dmabuf fds */
202 int *meta_data; /**< an array of meta data */
203 unsigned int num_meta_data; /**< the number of meta data */
204 void *reserved1; /**< reserved data1 */
205 void *reserved2; /**< reserved data2 */
206 } tbm_surface_buffer_data;
209 * @brief Called when the user data is deleted in buffer object.
211 * @param[in] user_data User_data to be passed to callback function
212 * @pre The callback must be registered using tbm_bo_add_user_data().\n
213 * tbm_bo_delete_user_data() must be called to invoke this callback.
214 * @see tbm_bo_add_user_data()
215 * @see tbm_bo_delete_user_data()
217 typedef void (*tbm_data_free) (void *user_data);
220 * @brief Enumeration of tbm buffer manager capability.
223 typedef enum TBM_BUFMGR_CAPABILITY tbm_bufmgr_capability;
226 * @brief Enumeration of tbm bo memory type.
229 typedef enum TBM_BO_FLAGS tbm_bo_memory_type;
232 * @brief Enumeration of buffer manager lock try for bo
236 TBM_BUFMGR_BO_LOCK_TYPE_NEVER = 0, /**< the bufmgr do not try to lock the bos when the tbm_bo_map is called. */
237 TBM_BUFMGR_BO_LOCK_TYPE_ONCE, /**< the bufmgr tries to lock the bos only once when the tbm_bo_map is called. */
238 TBM_BUFMGR_BO_LOCK_TYPE_ALWAYS, /**< the bufmgr always tries to lock the bos when the tbm_bo_map is called. */
239 } tbm_bufmgr_bo_lock_type;
242 * @brief Enumeration of the trace log for debug
246 TBM_BUFGMR_DEBUG_TRACE_NONE = 0,
247 TBM_BUFGMR_DEBUG_TRACE_BO = (1 << 0),
248 TBM_BUFGMR_DEBUG_TRACE_SURFACE_INTERNAL = (1 << 1),
249 TBM_BUFGMR_DEBUG_TRACE_SURFACE = (1 << 2),
250 TBM_BUFGMR_DEBUG_TRACE_SURFACE_QUEUE = (1 << 3),
251 } tbm_bufmgr_debug_trace_mask;
253 /* type to string ***********************************************************/
254 struct tbm_type_name {
259 #define TBM_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
261 #define TBM_TYPE_NAME_FN(res) \
262 static inline const char * tbm_##res##_str(int type) \
265 for (i = 0; i < TBM_ARRAY_SIZE(tbm_##res##_names); i++) { \
266 if (tbm_##res##_names[i].type == type) \
267 return tbm_##res##_names[i].name; \
269 return "(invalid)"; \
272 static struct tbm_type_name tbm_error_names[] = {
273 { TBM_ERROR_NONE, "TBM_ERROR_NONE" },
274 { TBM_ERROR_OUT_OF_MEMORY, "TBM_ERROR_OUT_OF_MEMORY" },
275 { TBM_ERROR_INVALID_PARAMETER, "TBM_ERROR_INVALID_PARAMETER" },
276 { TBM_ERROR_INVALID_OPERATION, "TBM_ERROR_INVALID_OPERATION" },
277 { TBM_ERROR_NOT_SUPPORTED, "TBM_ERROR_NOT_SUPPORTED" },
278 { TBM_SURFACE_QUEUE_ERROR_EMPTY, "TBM_SURFACE_QUEUE_ERROR_EMPTY" },
279 { TBM_SURFACE_QUEUE_ERROR_INVALID_QUEUE, "TBM_SURFACE_QUEUE_ERROR_INVALID_QUEUE" },
280 { TBM_SURFACE_QUEUE_ERROR_INVALID_SURFACE, "TBM_SURFACE_QUEUE_ERROR_INVALID_SURFACE" },
281 { TBM_SURFACE_QUEUE_ERROR_SURFACE_ALLOC_FAILED, "TBM_SURFACE_QUEUE_ERROR_SURFACE_ALLOC_FAILED" },
282 { TBM_SURFACE_QUEUE_ERROR_ALREADY_EXIST, "TBM_SURFACE_QUEUE_ERROR_ALREADY_EXIST" },
283 { TBM_SURFACE_QUEUE_ERROR_UNKNOWN_SURFACE, "TBM_SURFACE_QUEUE_ERROR_UNKNOWN_SURFACE" },
285 TBM_TYPE_NAME_FN(error)
287 #endif /* _TBM_TYPE_COMMON_H_ */