src/tbm_type_int.h

   1 /**************************************************************************
   2
   3 libtbm
   4
   5 Copyright 2012-2018 Samsung Electronics co., Ltd. All Rights Reserved.
   6
   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>
  10
  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:
  18
  19 The above copyright notice and this permission notice (including the
  20 next paragraph) shall be included in all copies or substantial portions
  21 of the Software.
  22
  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.
  30
  31 **************************************************************************/
  32
  33 #ifndef _TBM_TYPE_INT_H_
  34 #define _TBM_TYPE_INT_H_
  35
  36 #include <stdint.h>
  37
  38 /**
  39  * \file tbm_type_int.h
  40  * \brief Type definition used internally
  41  */
  42
  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
  46 #endif
  47
  48 /**
  49  * @brief Definition for the tizen buffer manager
  50  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  51  */
  52 typedef struct _tbm_bufmgr *tbm_bufmgr;
  53
  54 /**
  55  * @brief Definition for the tizen buffer object
  56  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  57  */
  58 typedef struct _tbm_bo *tbm_bo;
  59
  60 /**
  61  * @brief Definition for the key associated with the buffer object
  62  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  63  */
  64
  65 typedef uint32_t tbm_key;
  66 /**
  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
  69  */
  70 typedef int32_t tbm_fd;
  71
  72 /**
  73  * @brief Definition for native display (wl_display in tizen)
  74  * @since_tizen 5.0
  75  */
  76 typedef void tbm_native_display;
  77
  78
  79 /* TBM_DEVICE_TYPE */
  80
  81 /**
  82  * @brief Enumeration for tbm error type.
  83  * @since_tizen 2.4
  84  */
  85 typedef enum {
  86         TBM_ERROR_NONE = 0,                                             /**< Successful */
  87         TBM_BO_ERROR_GET_FD_FAILED = TBM_ERROR_BASE | 0x0101,     /**< failed to get fd failed */
  88         TBM_BO_ERROR_HEAP_ALLOC_FAILED = TBM_ERROR_BASE | 0x0102, /**< failed to allocate the heap memory */
  89         TBM_BO_ERROR_LOAD_MODULE_FAILED = TBM_ERROR_BASE | 0x0103,/**< failed to load module*/
  90         TBM_BO_ERROR_THREAD_INIT_FAILED = TBM_ERROR_BASE | 0x0104,/**< failed to initialize the pthread */
  91         TBM_BO_ERROR_BO_ALLOC_FAILED = TBM_ERROR_BASE | 0x0105,   /**< failed to allocate tbm_bo */
  92         TBM_BO_ERROR_INIT_STATE_FAILED = TBM_ERROR_BASE | 0x0106, /**< failed to initialize the state of tbm_bo */
  93         TBM_BO_ERROR_IMPORT_FAILED = TBM_ERROR_BASE | 0x0107,     /**< failed to import the handle of tbm_bo */
  94         TBM_BO_ERROR_IMPORT_FD_FAILED = TBM_ERROR_BASE | 0x0108,  /**< failed to import fd of tbm_bo */
  95         TBM_BO_ERROR_EXPORT_FAILED = TBM_ERROR_BASE | 0x0109,     /**< failed to export the handle of the tbm_bo */
  96         TBM_BO_ERROR_EXPORT_FD_FAILED = TBM_ERROR_BASE | 0x01010, /**< failed to export fd of tbm_bo */
  97         TBM_BO_ERROR_GET_HANDLE_FAILED = TBM_ERROR_BASE | 0x0111, /**< failed to get the tbm_bo_handle */
  98         TBM_BO_ERROR_LOCK_FAILED = TBM_ERROR_BASE | 0x0112,               /**< failed to lock the tbm_bo */
  99         TBM_BO_ERROR_MAP_FAILED = TBM_ERROR_BASE | 0x0113,                /**< failed to map the tbm_bo to get the tbm_bo_handle */
 100         TBM_BO_ERROR_UNMAP_FAILED = TBM_ERROR_BASE | 0x0114,      /**< failed to unmap the tbm_bo */
 101         TBM_BO_ERROR_SWAP_FAILED = TBM_ERROR_BASE | 0x0115,               /**< failed to swap the tbm_bos */
 102         TBM_BO_ERROR_DUP_FD_FAILED = TBM_ERROR_BASE | 0x0116,     /**< failed to duplicate fd */
 103 } tbm_error_e;
 104
 105 /**
 106  * @brief Enumeration of tbm buffer manager capability.
 107  * @since_tizen 2.4
 108  */
 109 enum TBM_BUFMGR_CAPABILITY {
 110         TBM_BUFMGR_CAPABILITY_NONE = 0,                                 /**< Not Support capability*/
 111         TBM_BUFMGR_CAPABILITY_SHARE_KEY = (1 << 0),             /**< Support sharing buffer by tbm key */
 112         TBM_BUFMGR_CAPABILITY_SHARE_FD = (1 << 1),              /**< Support sharing buffer by tbm fd */
 113         TBM_BUFMGR_CAPABILITY_TBM_SYNC = (1 << 2),              /**< Support tbm sync */
 114 };
 115
 116 /**
 117  * @brief Enumeration of buffer manager lock try for bo
 118  * @since_tizen 5.0
 119  */
 120 typedef enum {
 121         TBM_BUFMGR_BO_LOCK_TYPE_NEVER = 0,  /**< the bufmgr do not try to lock the bos when the tbm_bo_map is called. */
 122         TBM_BUFMGR_BO_LOCK_TYPE_ONCE,       /**< the bufmgr tries to lock the bos only once when the tbm_bo_map is called. */
 123         TBM_BUFMGR_BO_LOCK_TYPE_ALWAYS,     /**< the bufmgr always tries to lock the bos when the tbm_bo_map is called. */
 124 } tbm_bufmgr_bo_lock_type;
 125
 126 /**
 127  * @brief Definition for the device type to get the default handle
 128  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 129  */
 130 #define TBM_DEVICE_DEFAULT   0
 131 /**
 132  * @brief Definition for the device type to get the virtual memory
 133  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 134  */
 135 #define TBM_DEVICE_CPU       1
 136 /**
 137  * @brief Definition for the device type to get the 2D memory handle
 138  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 139  */
 140 #define TBM_DEVICE_2D        2
 141 /**
 142  * @brief Definition for the device type to get the 3D memory handle
 143  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 144  */
 145 #define TBM_DEVICE_3D        3
 146 /**
 147  * @brief Definition for the device type to get the multimedia handle
 148  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 149  */
 150 #define TBM_DEVICE_MM        4
 151
 152 /* TBM_OPTION */
 153
 154 /**
 155  * @brief Definition for the access option to read
 156  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 157  */
 158 #define TBM_OPTION_READ      (1 << 0)
 159 /**
 160  * @brief Definition for the access option to write
 161  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 162  */
 163 #define TBM_OPTION_WRITE     (1 << 1)
 164 /**
 165  * @brief Definition for the vendor specific option that depends on the backend
 166  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 167  */
 168 #define TBM_OPTION_VENDOR    (0xffff0000)
 169
 170 /**
 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
 173  */
 174 typedef union _tbm_bo_handle {
 175         void *ptr;
 176         int32_t s32;
 177         uint32_t u32;
 178         int64_t s64;
 179         uint64_t u64;
 180 } tbm_bo_handle;
 181
 182 /**
 183  * @brief Enumeration of bo memory type
 184  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 185  */
 186 enum TBM_BO_FLAGS {
 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_VENDOR = (0xffff0000), /**< vendor specific memory: it depends on the backend */
 192 };
 193
 194 /**
 195  * @brief Called when the user data is deleted in buffer object.
 196  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 197  * @param[in] user_data User_data to be passed to callback function
 198  * @pre The callback must be registered using tbm_bo_add_user_data().\n
 199  * tbm_bo_delete_user_data() must be called to invoke this callback.
 200  * @see tbm_bo_add_user_data()
 201  * @see tbm_bo_delete_user_data()
 202  */
 203 typedef void (*tbm_data_free) (void *user_data);
 204
 205 /**
 206  * @brief Enumeration of the trace log for debug
 207  * @since_tizen 5.0
 208  */
 209 typedef enum {
 210         TBM_BUFGMR_DEBUG_TRACE_NONE             = 0,
 211         TBM_BUFGMR_DEBUG_TRACE_BO               = (1 << 0),
 212         TBM_BUFGMR_DEBUG_TRACE_SURFACE_INTERNAL = (1 << 1),
 213         TBM_BUFGMR_DEBUG_TRACE_SURFACE          = (1 << 2),
 214         TBM_BUFGMR_DEBUG_TRACE_SURFACE_QUEUE    = (1 << 3),
 215 } tbm_bufmgr_debug_trace_mask;
 216
 217 #endif                                                  /* _TBM_TYPE_INT_H_ */