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
50 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
52 typedef struct _tbm_bufmgr *tbm_bufmgr;
55 * @brief Definition for the tizen buffer object
56 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
58 typedef struct _tbm_bo *tbm_bo;
61 * @brief Definition for the key associated with the buffer object
62 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
65 typedef uint32_t tbm_key;
67 * @brief Definition for the file descripter of the system buffer manager
68 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
70 typedef int32_t tbm_fd;
73 * @brief Definition for native display (wl_display in tizen)
76 typedef void tbm_native_display;
82 * @brief Enumeration for tbm error type.
86 /* TBM_ERROR_XXX. start from (TBM_ERROR_BASE | 0x0001) to (TBM_ERROR_BASE | 0x0099) */
87 TBM_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
88 TBM_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
89 TBM_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid function parameter */
90 TBM_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Function not implemented */
91 TBM_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */
93 /* TBM_BO_ERROR_XXX. start from (TBM_ERROR_BASE | 0x0101) to (TBM_ERROR_BASE | 0x0199) */
94 TBM_BO_ERROR_GET_FD_FAILED = TBM_ERROR_BASE | 0x0101, /**< failed to get fd in bo (DEPRECATED) */
95 TBM_BO_ERROR_HEAP_ALLOC_FAILED = TBM_ERROR_OUT_OF_MEMORY, /**< failed to allocate the heap memory in bo (DEPRECATED) */
96 TBM_BO_ERROR_LOAD_MODULE_FAILED = TBM_ERROR_BASE | 0x0103, /**< failed to load module (DEPRECATED) */
97 TBM_BO_ERROR_THREAD_INIT_FAILED = TBM_ERROR_BASE | 0x0104, /**< failed to initialize the pthread (DEPRECATED) */
98 TBM_BO_ERROR_BO_ALLOC_FAILED = TBM_ERROR_OUT_OF_MEMORY, /**< failed to allocate tbm_bo (DEPRECATED) */
99 TBM_BO_ERROR_INIT_STATE_FAILED = TBM_ERROR_BASE | 0x0106, /**< failed to initialize the state of tbm_bo (DEPRECATED) */
100 TBM_BO_ERROR_IMPORT_FAILED = TBM_ERROR_BASE | 0x0107, /**< failed to import the handle of tbm_bo (DEPRECATED) */
101 TBM_BO_ERROR_IMPORT_FD_FAILED = TBM_ERROR_BASE | 0x0108, /**< failed to import fd of tbm_bo (DEPRECATED) */
102 TBM_BO_ERROR_EXPORT_FAILED = TBM_ERROR_BASE | 0x0109, /**< failed to export the handle of the tbm_bo (DEPRECATED) */
103 TBM_BO_ERROR_EXPORT_FD_FAILED = TBM_ERROR_BASE | 0x0110, /**< failed to export fd of tbm_bo (DEPRECATED) */
104 TBM_BO_ERROR_GET_HANDLE_FAILED = TBM_ERROR_BASE | 0x0111, /**< failed to get the tbm_bo_handle (DEPRECATED) */
105 TBM_BO_ERROR_LOCK_FAILED = TBM_ERROR_BASE | 0x0112, /**< failed to lock the tbm_bo (DEPRECATED) */
106 TBM_BO_ERROR_MAP_FAILED = TBM_ERROR_BASE | 0x0113, /**< failed to map the tbm_bo to get the tbm_bo_handle (DEPRECATED) */
107 TBM_BO_ERROR_UNMAP_FAILED = TBM_ERROR_BASE | 0x0114, /**< failed to unmap the tbm_bo (DEPRECATED) */
108 TBM_BO_ERROR_SWAP_FAILED = TBM_ERROR_BASE | 0x0115, /**< failed to swap the tbm_bos (DEPRECATED) */
109 TBM_BO_ERROR_DUP_FD_FAILED = TBM_ERROR_BASE | 0x0116, /**< failed to duplicate fd (DEPRECATED) */
111 /* TBM_SURFACE_ERROR_XXX. start from (TBM_ERROR_BASE | 0x0201) to (TBM_ERROR_BASE | 0x0299)
112 * TBM_SURFACE_ERROR_XXX is defined in tbm_surface.h file because it is CAPI.
114 * TBM_SURFACE_ERROR_NONE = TIZEN_ERROR_NONE, // Successful
115 * TBM_SURFACE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, // Invalid parameter
116 * TBM_SURFACE_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, // Invalid Operation
120 /* TBM_SURFACE_QUEUE_ERROR_XXX. start from (TBM_ERROR_BASE | 0x0301) to (TBM_ERROR_BASE | 0x0399) */
121 TBM_SURFACE_QUEUE_ERROR_NONE = TBM_ERROR_NONE, /**< Successful */
122 TBM_SURFACE_QUEUE_ERROR_EMPTY = TBM_ERROR_BASE | 0x0301, /**< Empty queue */
123 TBM_SURFACE_QUEUE_ERROR_INVALID_QUEUE = TBM_ERROR_BASE | 0x0302, /**< Invalid queue */
124 TBM_SURFACE_QUEUE_ERROR_INVALID_SURFACE = TBM_ERROR_BASE | 0x0303, /**< Invalid surface */
125 TBM_SURFACE_QUEUE_ERROR_SURFACE_ALLOC_FAILED = TBM_ERROR_BASE | 0x0304, /**< Allocation of surface failed */
126 TBM_SURFACE_QUEUE_ERROR_ALREADY_EXIST = TBM_ERROR_BASE | 0x0305, /**< Already existed surface */
127 TBM_SURFACE_QUEUE_ERROR_UNKNOWN_SURFACE = TBM_ERROR_BASE | 0x0306, /**< Unknown surface */
128 TBM_SURFACE_QUEUE_ERROR_INVALID_SEQUENCE = TBM_ERROR_BASE | 0x0307, /**< Invalid sequence */
129 TBM_SURFACE_QUEUE_ERROR_TIMEOUT = TBM_ERROR_BASE | 0x0308, /**< Timeout */
132 typedef tbm_error_e tbm_surface_queue_error_e;
135 * @brief Enumeration of tbm buffer manager capability.
138 enum TBM_BUFMGR_CAPABILITY {
139 TBM_BUFMGR_CAPABILITY_NONE = 0, /**< Not Support capability*/
140 TBM_BUFMGR_CAPABILITY_SHARE_KEY = (1 << 0), /**< Support sharing buffer by tbm key */
141 TBM_BUFMGR_CAPABILITY_SHARE_FD = (1 << 1), /**< Support sharing buffer by tbm fd */
142 TBM_BUFMGR_CAPABILITY_TBM_SYNC = (1 << 2), /**< Support tbm sync */
143 TBM_BUFMGR_CAPABILITY_TILED_MEMORY = (1 << 3), /**< Support tiled memory */
147 * @brief Definition for the device type to access tbm_bo
148 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
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
161 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
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
172 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
174 typedef union _tbm_bo_handle {
183 * @brief Enumeration of bo memory type
184 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
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 Called when the user data is deleted in buffer object.
197 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
198 * @param[in] user_data User_data to be passed to callback function
199 * @pre The callback must be registered using tbm_bo_add_user_data().\n
200 * tbm_bo_delete_user_data() must be called to invoke this callback.
201 * @see tbm_bo_add_user_data()
202 * @see tbm_bo_delete_user_data()
204 typedef void (*tbm_data_free) (void *user_data);
207 * @brief Enumeration of tbm buffer manager capability.
210 typedef enum TBM_BUFMGR_CAPABILITY tbm_bufmgr_capability;
213 * @brief Enumeration of tbm bo memory type.
216 typedef enum TBM_BO_FLAGS tbm_bo_memory_type;
219 * @brief Enumeration of buffer manager lock try for bo
223 TBM_BUFMGR_BO_LOCK_TYPE_NEVER = 0, /**< the bufmgr do not try to lock the bos when the tbm_bo_map is called. */
224 TBM_BUFMGR_BO_LOCK_TYPE_ONCE, /**< the bufmgr tries to lock the bos only once when the tbm_bo_map is called. */
225 TBM_BUFMGR_BO_LOCK_TYPE_ALWAYS, /**< the bufmgr always tries to lock the bos when the tbm_bo_map is called. */
226 } tbm_bufmgr_bo_lock_type;
229 * @brief Enumeration of the trace log for debug
233 TBM_BUFGMR_DEBUG_TRACE_NONE = 0,
234 TBM_BUFGMR_DEBUG_TRACE_BO = (1 << 0),
235 TBM_BUFGMR_DEBUG_TRACE_SURFACE_INTERNAL = (1 << 1),
236 TBM_BUFGMR_DEBUG_TRACE_SURFACE = (1 << 2),
237 TBM_BUFGMR_DEBUG_TRACE_SURFACE_QUEUE = (1 << 3),
238 } tbm_bufmgr_debug_trace_mask;
240 /* type to string ***********************************************************/
241 struct tbm_type_name {
246 #define TBM_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
248 #define TBM_TYPE_NAME_FN(res) \
249 static inline const char * tbm_##res##_str(int type) \
252 for (i = 0; i < TBM_ARRAY_SIZE(tbm_##res##_names); i++) { \
253 if (tbm_##res##_names[i].type == type) \
254 return tbm_##res##_names[i].name; \
256 return "(invalid)"; \
259 static struct tbm_type_name tbm_error_names[] = {
260 { TBM_ERROR_NONE, "TBM_ERROR_NONE" },
261 { TBM_ERROR_OUT_OF_MEMORY, "TBM_ERROR_OUT_OF_MEMORY" },
262 { TBM_ERROR_INVALID_PARAMETER, "TBM_ERROR_INVALID_PARAMETER" },
263 { TBM_ERROR_INVALID_OPERATION, "TBM_ERROR_INVALID_OPERATION" },
264 { TBM_ERROR_NOT_SUPPORTED, "TBM_ERROR_NOT_SUPPORTED" },
265 { TBM_SURFACE_QUEUE_ERROR_EMPTY, "TBM_SURFACE_QUEUE_ERROR_EMPTY" },
266 { TBM_SURFACE_QUEUE_ERROR_INVALID_QUEUE, "TBM_SURFACE_QUEUE_ERROR_INVALID_QUEUE" },
267 { TBM_SURFACE_QUEUE_ERROR_INVALID_SURFACE, "TBM_SURFACE_QUEUE_ERROR_INVALID_SURFACE" },
268 { TBM_SURFACE_QUEUE_ERROR_SURFACE_ALLOC_FAILED, "TBM_SURFACE_QUEUE_ERROR_SURFACE_ALLOC_FAILED" },
269 { TBM_SURFACE_QUEUE_ERROR_ALREADY_EXIST, "TBM_SURFACE_QUEUE_ERROR_ALREADY_EXIST" },
270 { TBM_SURFACE_QUEUE_ERROR_UNKNOWN_SURFACE, "TBM_SURFACE_QUEUE_ERROR_UNKNOWN_SURFACE" },
272 TBM_TYPE_NAME_FN(error)
274 #endif /* _TBM_TYPE_COMMON_H_ */